# DescribeDetectorModelAnalysis
<a name="API_DescribeDetectorModelAnalysis"></a>

**Important**  
End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). 

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.

## Request Syntax
<a name="API_DescribeDetectorModelAnalysis_RequestSyntax"></a>

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

## URI Request Parameters
<a name="API_DescribeDetectorModelAnalysis_RequestParameters"></a>

The request uses the following URI parameters.

 ** [analysisId](#API_DescribeDetectorModelAnalysis_RequestSyntax) **   <a name="iotevents-DescribeDetectorModelAnalysis-request-uri-analysisId"></a>
The ID of the analysis result that you want to retrieve.  
Required: Yes

## Request Body
<a name="API_DescribeDetectorModelAnalysis_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeDetectorModelAnalysis_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "status": "string"
}
```

## Response Elements
<a name="API_DescribeDetectorModelAnalysis_ResponseElements"></a>

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](#API_DescribeDetectorModelAnalysis_ResponseSyntax) **   <a name="iotevents-DescribeDetectorModelAnalysis-response-status"></a>
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.
Type: String  
Valid Values: `RUNNING | COMPLETE | FAILED` 

## Errors
<a name="API_DescribeDetectorModelAnalysis_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalFailureException **   
An internal failure occurred.    
 ** message **   
The message for the exception.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request was invalid.    
 ** message **   
The message for the exception.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource was not found.    
 ** message **   
The message for the exception.
HTTP Status Code: 404

 ** ServiceUnavailableException **   
The service is currently unavailable.    
 ** message **   
The message for the exception.
HTTP Status Code: 503

 ** ThrottlingException **   
The request could not be completed due to throttling.    
 ** message **   
The message for the exception.
HTTP Status Code: 429

## See Also
<a name="API_DescribeDetectorModelAnalysis_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/DescribeDetectorModelAnalysis) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/DescribeDetectorModelAnalysis) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/DescribeDetectorModelAnalysis) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/DescribeDetectorModelAnalysis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/DescribeDetectorModelAnalysis) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/DescribeDetectorModelAnalysis) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/DescribeDetectorModelAnalysis) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/DescribeDetectorModelAnalysis) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/DescribeDetectorModelAnalysis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/DescribeDetectorModelAnalysis)