Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTEvents.DescribeDetectorModelAnalysis

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves runtime information about a detector model analysis.

After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.

Creating a Request

data DescribeDetectorModelAnalysis Source #

See: newDescribeDetectorModelAnalysis smart constructor.

Constructors

DescribeDetectorModelAnalysis'
Fields analysisId :: Text The ID of the analysis result that you want to retrieve.

Instances

Instances details

Eq DescribeDetectorModelAnalysis Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis Methods (==) :: DescribeDetectorModelAnalysis -> DescribeDetectorModelAnalysis -> Bool # (/=) :: DescribeDetectorModelAnalysis -> DescribeDetectorModelAnalysis -> Bool #
Read DescribeDetectorModelAnalysis Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis Methods readsPrec :: Int -> ReadS DescribeDetectorModelAnalysis # readList :: ReadS [DescribeDetectorModelAnalysis] # readPrec :: ReadPrec DescribeDetectorModelAnalysis # readListPrec :: ReadPrec [DescribeDetectorModelAnalysis] #
Show DescribeDetectorModelAnalysis Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis Methods showsPrec :: Int -> DescribeDetectorModelAnalysis -> ShowS # show :: DescribeDetectorModelAnalysis -> String # showList :: [DescribeDetectorModelAnalysis] -> ShowS #
Generic DescribeDetectorModelAnalysis Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis Associated Types type Rep DescribeDetectorModelAnalysis :: Type -> Type # Methods from :: DescribeDetectorModelAnalysis -> Rep DescribeDetectorModelAnalysis x # to :: Rep DescribeDetectorModelAnalysis x -> DescribeDetectorModelAnalysis #
NFData DescribeDetectorModelAnalysis Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis Methods rnf :: DescribeDetectorModelAnalysis -> () #
Hashable DescribeDetectorModelAnalysis Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis Methods hashWithSalt :: Int -> DescribeDetectorModelAnalysis -> Int # hash :: DescribeDetectorModelAnalysis -> Int #
AWSRequest DescribeDetectorModelAnalysis Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis Associated Types type AWSResponse DescribeDetectorModelAnalysis # Methods request :: DescribeDetectorModelAnalysis -> Request DescribeDetectorModelAnalysis # response :: MonadResource m => Logger -> Service -> Proxy DescribeDetectorModelAnalysis -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDetectorModelAnalysis))) #
ToHeaders DescribeDetectorModelAnalysis Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis Methods toHeaders :: DescribeDetectorModelAnalysis -> [Header] #
ToPath DescribeDetectorModelAnalysis Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis Methods toPath :: DescribeDetectorModelAnalysis -> ByteString #
ToQuery DescribeDetectorModelAnalysis Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis Methods toQuery :: DescribeDetectorModelAnalysis -> QueryString #
type Rep DescribeDetectorModelAnalysis Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis type Rep DescribeDetectorModelAnalysis = D1 ('MetaData "DescribeDetectorModelAnalysis" "Amazonka.IoTEvents.DescribeDetectorModelAnalysis" "libZSservicesZSamazonka-ioteventsZSamazonka-iotevents" 'False) (C1 ('MetaCons "DescribeDetectorModelAnalysis'" 'PrefixI 'True) (S1 ('MetaSel ('Just "analysisId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeDetectorModelAnalysis Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis type AWSResponse DescribeDetectorModelAnalysis = DescribeDetectorModelAnalysisResponse

newDescribeDetectorModelAnalysis Source #

Arguments

:: Text	`$sel:analysisId:DescribeDetectorModelAnalysis'`
-> DescribeDetectorModelAnalysis

Create a value of DescribeDetectorModelAnalysis 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:analysisId:DescribeDetectorModelAnalysis', describeDetectorModelAnalysis_analysisId - The ID of the analysis result that you want to retrieve.

Request Lenses

describeDetectorModelAnalysis_analysisId :: Lens' DescribeDetectorModelAnalysis Text Source #

The ID of the analysis result that you want to retrieve.

Destructuring the Response

data DescribeDetectorModelAnalysisResponse Source #

See: newDescribeDetectorModelAnalysisResponse smart constructor.

Constructors

DescribeDetectorModelAnalysisResponse'

Fields

status :: Maybe AnalysisStatus
The status of the analysis activity. The status can be one of the following values:
- RUNNING - AWS IoT Events is analyzing your detector model. This process can take several minutes to complete.
- COMPLETE - AWS IoT Events finished analyzing your detector model.
- FAILED - AWS IoT Events couldn't analyze your detector model. Try again later.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeDetectorModelAnalysisResponse Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis Methods (==) :: DescribeDetectorModelAnalysisResponse -> DescribeDetectorModelAnalysisResponse -> Bool # (/=) :: DescribeDetectorModelAnalysisResponse -> DescribeDetectorModelAnalysisResponse -> Bool #
Read DescribeDetectorModelAnalysisResponse Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis Methods readsPrec :: Int -> ReadS DescribeDetectorModelAnalysisResponse # readList :: ReadS [DescribeDetectorModelAnalysisResponse] # readPrec :: ReadPrec DescribeDetectorModelAnalysisResponse # readListPrec :: ReadPrec [DescribeDetectorModelAnalysisResponse] #
Show DescribeDetectorModelAnalysisResponse Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis Methods showsPrec :: Int -> DescribeDetectorModelAnalysisResponse -> ShowS # show :: DescribeDetectorModelAnalysisResponse -> String # showList :: [DescribeDetectorModelAnalysisResponse] -> ShowS #
Generic DescribeDetectorModelAnalysisResponse Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis Associated Types type Rep DescribeDetectorModelAnalysisResponse :: Type -> Type # Methods from :: DescribeDetectorModelAnalysisResponse -> Rep DescribeDetectorModelAnalysisResponse x # to :: Rep DescribeDetectorModelAnalysisResponse x -> DescribeDetectorModelAnalysisResponse #
NFData DescribeDetectorModelAnalysisResponse Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis Methods rnf :: DescribeDetectorModelAnalysisResponse -> () #
type Rep DescribeDetectorModelAnalysisResponse Source #
Instance details Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis type Rep DescribeDetectorModelAnalysisResponse = D1 ('MetaData "DescribeDetectorModelAnalysisResponse" "Amazonka.IoTEvents.DescribeDetectorModelAnalysis" "libZSservicesZSamazonka-ioteventsZSamazonka-iotevents" 'False) (C1 ('MetaCons "DescribeDetectorModelAnalysisResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnalysisStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeDetectorModelAnalysisResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeDetectorModelAnalysisResponse'`
-> DescribeDetectorModelAnalysisResponse

Create a value of DescribeDetectorModelAnalysisResponse 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:status:DescribeDetectorModelAnalysisResponse', describeDetectorModelAnalysisResponse_status - The status of the analysis activity. The status can be one of the following values:

RUNNING - AWS IoT Events is analyzing your detector model. This process can take several minutes to complete.
COMPLETE - AWS IoT Events finished analyzing your detector model.
FAILED - AWS IoT Events couldn't analyze your detector model. Try again later.

$sel:httpStatus:DescribeDetectorModelAnalysisResponse', describeDetectorModelAnalysisResponse_httpStatus - The response's http status code.

Response Lenses

describeDetectorModelAnalysisResponse_status :: Lens' DescribeDetectorModelAnalysisResponse (Maybe AnalysisStatus) Source #

The status of the analysis activity. The status can be one of the following values:

RUNNING - AWS IoT Events is analyzing your detector model. This process can take several minutes to complete.
COMPLETE - AWS IoT Events finished analyzing your detector model.
FAILED - AWS IoT Events couldn't analyze your detector model. Try again later.

describeDetectorModelAnalysisResponse_httpStatus :: Lens' DescribeDetectorModelAnalysisResponse Int Source #

The response's http status code.