describe_detector_model_analysis

IoTEvents.Client.describe_detector_model_analysis(**kwargs)

Retrieves runtime information about a detector model analysis.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.describe_detector_model_analysis(
    analysisId='string'
)

Parameters

analysisId (string) --

[REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'status': 'RUNNING'|'COMPLETE'|'FAILED'
}

Response Structure

• (dict) --
  • status (string) --

    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.

Exceptions

• IoTEvents.Client.exceptions.InvalidRequestException
• IoTEvents.Client.exceptions.ResourceNotFoundException
• IoTEvents.Client.exceptions.ThrottlingException
• IoTEvents.Client.exceptions.InternalFailureException
• IoTEvents.Client.exceptions.ServiceUnavailableException