Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoTEvents.Types.AnalysisResult

Description

Documentation

data AnalysisResult Source #

Contains the result of the analysis.

See: newAnalysisResult smart constructor.

Constructors

AnalysisResult'

Fields

level :: Maybe AnalysisResultLevel
The severity level of the analysis result. Based on the severity level, analysis results fall into three general categories:
- INFO - An information result tells you about a significant field in your detector model. This type of result usually doesn't require immediate action.
- WARNING - A warning result draws special attention to fields that might cause issues for your detector model. We recommend that you review warnings and take necessary actions before you use your detector model in production environments. Otherwise, the detector model might not work as expected.
- ERROR - An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.
locations :: Maybe [AnalysisResultLocation]
Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
message :: Maybe Text
Contains additional information about the analysis result.
type' :: Maybe Text
The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result:
- supported-actions - You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region.
- service-limits - Resources or API operations can't exceed service quotas (also known as limits). Update your detector model or request a quota increase.
- structure - The detector model must follow a structure that AWS IoT Events supports.
- expression-syntax - Your expression must follow the required syntax.
- data-type - Data types referenced in the detector model must be compatible.
- referenced-data - You must define the data referenced in your detector model before you can use the data.
- referenced-resource - Resources that the detector model uses must be available.
For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.

Instances

Instances details

FromJSON AnalysisResult Source #
Instance details Defined in Amazonka.IoTEvents.Types.AnalysisResult Methods parseJSON :: Value -> Parser AnalysisResult # parseJSONList :: Value -> Parser [AnalysisResult] #
Generic AnalysisResult Source #
Instance details Defined in Amazonka.IoTEvents.Types.AnalysisResult Associated Types type Rep AnalysisResult :: Type -> Type # Methods from :: AnalysisResult -> Rep AnalysisResult x # to :: Rep AnalysisResult x -> AnalysisResult #
Read AnalysisResult Source #
Instance details Defined in Amazonka.IoTEvents.Types.AnalysisResult Methods readsPrec :: Int -> ReadS AnalysisResult # readList :: ReadS [AnalysisResult] # readPrec :: ReadPrec AnalysisResult # readListPrec :: ReadPrec [AnalysisResult] #
Show AnalysisResult Source #
Instance details Defined in Amazonka.IoTEvents.Types.AnalysisResult Methods showsPrec :: Int -> AnalysisResult -> ShowS # show :: AnalysisResult -> String # showList :: [AnalysisResult] -> ShowS #
NFData AnalysisResult Source #
Instance details Defined in Amazonka.IoTEvents.Types.AnalysisResult Methods rnf :: AnalysisResult -> () #
Eq AnalysisResult Source #
Instance details Defined in Amazonka.IoTEvents.Types.AnalysisResult Methods (==) :: AnalysisResult -> AnalysisResult -> Bool # (/=) :: AnalysisResult -> AnalysisResult -> Bool #
Hashable AnalysisResult Source #
Instance details Defined in Amazonka.IoTEvents.Types.AnalysisResult Methods hashWithSalt :: Int -> AnalysisResult -> Int # hash :: AnalysisResult -> Int #
type Rep AnalysisResult Source #
Instance details Defined in Amazonka.IoTEvents.Types.AnalysisResult type Rep AnalysisResult = D1 ('MetaData "AnalysisResult" "Amazonka.IoTEvents.Types.AnalysisResult" "amazonka-iotevents-2.0-6xKaLx5KciSK3LEs0FyRYn" 'False) (C1 ('MetaCons "AnalysisResult'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "level") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnalysisResultLevel)) :: S1 ('MetaSel ('Just "locations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AnalysisResultLocation]))) :: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newAnalysisResult :: AnalysisResult Source #

Create a value of AnalysisResult with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:level:AnalysisResult', analysisResult_level - The severity level of the analysis result. Based on the severity level, analysis results fall into three general categories:

INFO - An information result tells you about a significant field in your detector model. This type of result usually doesn't require immediate action.
WARNING - A warning result draws special attention to fields that might cause issues for your detector model. We recommend that you review warnings and take necessary actions before you use your detector model in production environments. Otherwise, the detector model might not work as expected.
ERROR - An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.

$sel:locations:AnalysisResult', analysisResult_locations - Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.

$sel:message:AnalysisResult', analysisResult_message - Contains additional information about the analysis result.

$sel:type':AnalysisResult', analysisResult_type - The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result:

supported-actions - You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region.
service-limits - Resources or API operations can't exceed service quotas (also known as limits). Update your detector model or request a quota increase.
structure - The detector model must follow a structure that AWS IoT Events supports.
expression-syntax - Your expression must follow the required syntax.
data-type - Data types referenced in the detector model must be compatible.
referenced-data - You must define the data referenced in your detector model before you can use the data.
referenced-resource - Resources that the detector model uses must be available.

For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.

analysisResult_level :: Lens' AnalysisResult (Maybe AnalysisResultLevel) Source #

The severity level of the analysis result. Based on the severity level, analysis results fall into three general categories:

INFO - An information result tells you about a significant field in your detector model. This type of result usually doesn't require immediate action.
WARNING - A warning result draws special attention to fields that might cause issues for your detector model. We recommend that you review warnings and take necessary actions before you use your detector model in production environments. Otherwise, the detector model might not work as expected.
ERROR - An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.

analysisResult_locations :: Lens' AnalysisResult (Maybe [AnalysisResultLocation]) Source #

Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.

analysisResult_message :: Lens' AnalysisResult (Maybe Text) Source #

Contains additional information about the analysis result.

analysisResult_type :: Lens' AnalysisResult (Maybe Text) Source #

The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result:

supported-actions - You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region.
service-limits - Resources or API operations can't exceed service quotas (also known as limits). Update your detector model or request a quota increase.
structure - The detector model must follow a structure that AWS IoT Events supports.
expression-syntax - Your expression must follow the required syntax.
data-type - Data types referenced in the detector model must be compatible.
referenced-data - You must define the data referenced in your detector model before you can use the data.
referenced-resource - Resources that the detector model uses must be available.

For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.