DescribeDetectorModelAnalysis - Amazon IoT Events
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribeDetectorModelAnalysis

Retrieves runtime information about a detector model analysis.

Note

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

Request Syntax

GET /analysis/detector-models/analysisId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

analysisId

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "status": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

status

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

  • RUNNING - Amazon IoT Events is analyzing your detector model. This process can take several minutes to complete.

  • COMPLETE - Amazon IoT Events finished analyzing your detector model.

  • FAILED - Amazon IoT Events couldn't analyze your detector model. Try again later.

Type: String

Valid Values: RUNNING | COMPLETE | FAILED

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidRequestException

The request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The request could not be completed due to throttling.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: