Amazonka.IoTEvents.DescribeDetectorModelAnalysis

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

See: newDescribeDetectorModelAnalysis smart constructor.

Constructors

DescribeDetectorModelAnalysis'

Fields

• analysisId :: Text

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

Instances

ToHeaders DescribeDetectorModelAnalysis

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

Methods

toHeaders :: DescribeDetectorModelAnalysis -> [Header]

ToPath DescribeDetectorModelAnalysis

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

Methods

toPath :: DescribeDetectorModelAnalysis -> ByteString

ToQuery DescribeDetectorModelAnalysis

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

Methods

toQuery :: DescribeDetectorModelAnalysis -> QueryString

AWSRequest DescribeDetectorModelAnalysis

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

Associated Types

type AWSResponse DescribeDetectorModelAnalysis

Methods

request :: (Service -> Service) -> DescribeDetectorModelAnalysis -> Request DescribeDetectorModelAnalysis

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDetectorModelAnalysis -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDetectorModelAnalysis)))

Generic DescribeDetectorModelAnalysis

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

Associated Types

type Rep DescribeDetectorModelAnalysis :: Type -> Type

Methods

from :: DescribeDetectorModelAnalysis -> Rep DescribeDetectorModelAnalysis x

to :: Rep DescribeDetectorModelAnalysis x -> DescribeDetectorModelAnalysis

Read DescribeDetectorModelAnalysis

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

Methods

readsPrec :: Int -> ReadS DescribeDetectorModelAnalysis

readList :: ReadS [DescribeDetectorModelAnalysis]

readPrec :: ReadPrec DescribeDetectorModelAnalysis

readListPrec :: ReadPrec [DescribeDetectorModelAnalysis]

Show DescribeDetectorModelAnalysis

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

Methods

showsPrec :: Int -> DescribeDetectorModelAnalysis -> ShowS

show :: DescribeDetectorModelAnalysis -> String

showList :: [DescribeDetectorModelAnalysis] -> ShowS

NFData DescribeDetectorModelAnalysis

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

Methods

rnf :: DescribeDetectorModelAnalysis -> ()

Eq DescribeDetectorModelAnalysis

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

Methods

(==) :: DescribeDetectorModelAnalysis -> DescribeDetectorModelAnalysis -> Bool

(/=) :: DescribeDetectorModelAnalysis -> DescribeDetectorModelAnalysis -> Bool

Hashable DescribeDetectorModelAnalysis

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

Methods

hashWithSalt :: Int -> DescribeDetectorModelAnalysis -> Int

hash :: DescribeDetectorModelAnalysis -> Int

type AWSResponse DescribeDetectorModelAnalysis

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

type AWSResponse DescribeDetectorModelAnalysis = DescribeDetectorModelAnalysisResponse

type Rep DescribeDetectorModelAnalysis

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

type Rep DescribeDetectorModelAnalysis = D1 ('MetaData "DescribeDetectorModelAnalysis" "Amazonka.IoTEvents.DescribeDetectorModelAnalysis" "amazonka-iotevents-2.0-6xKaLx5KciSK3LEs0FyRYn" 'False) (C1 ('MetaCons "DescribeDetectorModelAnalysis'" 'PrefixI 'True) (S1 ('MetaSel ('Just "analysisId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeDetectorModelAnalysis

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

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

Destructuring the Response

data DescribeDetectorModelAnalysisResponse

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

Generic DescribeDetectorModelAnalysisResponse

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

Associated Types

type Rep DescribeDetectorModelAnalysisResponse :: Type -> Type

Methods

from :: DescribeDetectorModelAnalysisResponse -> Rep DescribeDetectorModelAnalysisResponse x

to :: Rep DescribeDetectorModelAnalysisResponse x -> DescribeDetectorModelAnalysisResponse

Read DescribeDetectorModelAnalysisResponse

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

Methods

readsPrec :: Int -> ReadS DescribeDetectorModelAnalysisResponse

readList :: ReadS [DescribeDetectorModelAnalysisResponse]

readPrec :: ReadPrec DescribeDetectorModelAnalysisResponse

readListPrec :: ReadPrec [DescribeDetectorModelAnalysisResponse]

Show DescribeDetectorModelAnalysisResponse

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

Methods

showsPrec :: Int -> DescribeDetectorModelAnalysisResponse -> ShowS

show :: DescribeDetectorModelAnalysisResponse -> String

showList :: [DescribeDetectorModelAnalysisResponse] -> ShowS

NFData DescribeDetectorModelAnalysisResponse

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

Methods

rnf :: DescribeDetectorModelAnalysisResponse -> ()

Eq DescribeDetectorModelAnalysisResponse

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

Methods

(==) :: DescribeDetectorModelAnalysisResponse -> DescribeDetectorModelAnalysisResponse -> Bool

(/=) :: DescribeDetectorModelAnalysisResponse -> DescribeDetectorModelAnalysisResponse -> Bool

type Rep DescribeDetectorModelAnalysisResponse

Defined in Amazonka.IoTEvents.DescribeDetectorModelAnalysis

type Rep DescribeDetectorModelAnalysisResponse = D1 ('MetaData "DescribeDetectorModelAnalysisResponse" "Amazonka.IoTEvents.DescribeDetectorModelAnalysis" "amazonka-iotevents-2.0-6xKaLx5KciSK3LEs0FyRYn" '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

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:

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)

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

The response's http status code.