# AWS IoT Events Data
<a name="API_Operations_AWS_IoT_Events_Data"></a>

The following actions are supported by AWS IoT Events Data:
+  [BatchAcknowledgeAlarm](API_iotevents-data_BatchAcknowledgeAlarm.md) 
+  [BatchDeleteDetector](API_iotevents-data_BatchDeleteDetector.md) 
+  [BatchDisableAlarm](API_iotevents-data_BatchDisableAlarm.md) 
+  [BatchEnableAlarm](API_iotevents-data_BatchEnableAlarm.md) 
+  [BatchPutMessage](API_iotevents-data_BatchPutMessage.md) 
+  [BatchResetAlarm](API_iotevents-data_BatchResetAlarm.md) 
+  [BatchSnoozeAlarm](API_iotevents-data_BatchSnoozeAlarm.md) 
+  [BatchUpdateDetector](API_iotevents-data_BatchUpdateDetector.md) 
+  [DescribeAlarm](API_iotevents-data_DescribeAlarm.md) 
+  [DescribeDetector](API_iotevents-data_DescribeDetector.md) 
+  [ListAlarms](API_iotevents-data_ListAlarms.md) 
+  [ListDetectors](API_iotevents-data_ListDetectors.md) 

# BatchAcknowledgeAlarm
<a name="API_iotevents-data_BatchAcknowledgeAlarm"></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). 

Acknowledges one or more alarms. The alarms change to the `ACKNOWLEDGED` state after you acknowledge them.

## Request Syntax
<a name="API_iotevents-data_BatchAcknowledgeAlarm_RequestSyntax"></a>

```
POST /alarms/acknowledge HTTP/1.1
Content-type: application/json

{
   "acknowledgeActionRequests": [ 
      { 
         "alarmModelName": "string",
         "keyValue": "string",
         "note": "string",
         "requestId": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_iotevents-data_BatchAcknowledgeAlarm_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_iotevents-data_BatchAcknowledgeAlarm_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [acknowledgeActionRequests](#API_iotevents-data_BatchAcknowledgeAlarm_RequestSyntax) **   <a name="iotevents-iotevents-data_BatchAcknowledgeAlarm-request-acknowledgeActionRequests"></a>
The list of acknowledge action requests. You can specify up to 10 requests per operation.  
Type: Array of [AcknowledgeAlarmActionRequest](API_iotevents-data_AcknowledgeAlarmActionRequest.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## Response Syntax
<a name="API_iotevents-data_BatchAcknowledgeAlarm_ResponseSyntax"></a>

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

{
   "errorEntries": [ 
      { 
         "errorCode": "string",
         "errorMessage": "string",
         "requestId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_iotevents-data_BatchAcknowledgeAlarm_ResponseElements"></a>

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

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

 ** [errorEntries](#API_iotevents-data_BatchAcknowledgeAlarm_ResponseSyntax) **   <a name="iotevents-iotevents-data_BatchAcknowledgeAlarm-response-errorEntries"></a>
A list of errors associated with the request, or `null` if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.  
Type: Array of [BatchAlarmActionErrorEntry](API_iotevents-data_BatchAlarmActionErrorEntry.md) objects

## Errors
<a name="API_iotevents-data_BatchAcknowledgeAlarm_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

 ** 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_iotevents-data_BatchAcknowledgeAlarm_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-data-2018-10-23/BatchAcknowledgeAlarm) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-data-2018-10-23/BatchAcknowledgeAlarm) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-data-2018-10-23/BatchAcknowledgeAlarm) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-data-2018-10-23/BatchAcknowledgeAlarm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-data-2018-10-23/BatchAcknowledgeAlarm) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-data-2018-10-23/BatchAcknowledgeAlarm) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-data-2018-10-23/BatchAcknowledgeAlarm) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-data-2018-10-23/BatchAcknowledgeAlarm) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-data-2018-10-23/BatchAcknowledgeAlarm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-data-2018-10-23/BatchAcknowledgeAlarm) 

# BatchDeleteDetector
<a name="API_iotevents-data_BatchDeleteDetector"></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). 

Deletes one or more detectors that were created. When a detector is deleted, its state will be cleared and the detector will be removed from the list of detectors. The deleted detector will no longer appear if referenced in the [ListDetectors](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_ListDetectors.html) API call.

## Request Syntax
<a name="API_iotevents-data_BatchDeleteDetector_RequestSyntax"></a>

```
POST /detectors/delete HTTP/1.1
Content-type: application/json

{
   "detectors": [ 
      { 
         "detectorModelName": "string",
         "keyValue": "string",
         "messageId": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_iotevents-data_BatchDeleteDetector_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_iotevents-data_BatchDeleteDetector_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [detectors](#API_iotevents-data_BatchDeleteDetector_RequestSyntax) **   <a name="iotevents-iotevents-data_BatchDeleteDetector-request-detectors"></a>
The list of one or more detectors to be deleted.  
Type: Array of [DeleteDetectorRequest](API_iotevents-data_DeleteDetectorRequest.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## Response Syntax
<a name="API_iotevents-data_BatchDeleteDetector_ResponseSyntax"></a>

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

{
   "batchDeleteDetectorErrorEntries": [ 
      { 
         "errorCode": "string",
         "errorMessage": "string",
         "messageId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_iotevents-data_BatchDeleteDetector_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.

 ** [batchDeleteDetectorErrorEntries](#API_iotevents-data_BatchDeleteDetector_ResponseSyntax) **   <a name="iotevents-iotevents-data_BatchDeleteDetector-response-batchDeleteDetectorErrorEntries"></a>
A list of errors associated with the request, or an empty array (`[]`) if there are no errors. Each error entry contains a `messageId` that helps you identify the entry that failed.  
Type: Array of [BatchDeleteDetectorErrorEntry](API_iotevents-data_BatchDeleteDetectorErrorEntry.md) objects

## Errors
<a name="API_iotevents-data_BatchDeleteDetector_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

 ** 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_iotevents-data_BatchDeleteDetector_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-data-2018-10-23/BatchDeleteDetector) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-data-2018-10-23/BatchDeleteDetector) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-data-2018-10-23/BatchDeleteDetector) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-data-2018-10-23/BatchDeleteDetector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-data-2018-10-23/BatchDeleteDetector) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-data-2018-10-23/BatchDeleteDetector) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-data-2018-10-23/BatchDeleteDetector) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-data-2018-10-23/BatchDeleteDetector) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-data-2018-10-23/BatchDeleteDetector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-data-2018-10-23/BatchDeleteDetector) 

# BatchDisableAlarm
<a name="API_iotevents-data_BatchDisableAlarm"></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). 

Disables one or more alarms. The alarms change to the `DISABLED` state after you disable them.

## Request Syntax
<a name="API_iotevents-data_BatchDisableAlarm_RequestSyntax"></a>

```
POST /alarms/disable HTTP/1.1
Content-type: application/json

{
   "disableActionRequests": [ 
      { 
         "alarmModelName": "string",
         "keyValue": "string",
         "note": "string",
         "requestId": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_iotevents-data_BatchDisableAlarm_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_iotevents-data_BatchDisableAlarm_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [disableActionRequests](#API_iotevents-data_BatchDisableAlarm_RequestSyntax) **   <a name="iotevents-iotevents-data_BatchDisableAlarm-request-disableActionRequests"></a>
The list of disable action requests. You can specify up to 10 requests per operation.  
Type: Array of [DisableAlarmActionRequest](API_iotevents-data_DisableAlarmActionRequest.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## Response Syntax
<a name="API_iotevents-data_BatchDisableAlarm_ResponseSyntax"></a>

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

{
   "errorEntries": [ 
      { 
         "errorCode": "string",
         "errorMessage": "string",
         "requestId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_iotevents-data_BatchDisableAlarm_ResponseElements"></a>

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

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

 ** [errorEntries](#API_iotevents-data_BatchDisableAlarm_ResponseSyntax) **   <a name="iotevents-iotevents-data_BatchDisableAlarm-response-errorEntries"></a>
A list of errors associated with the request, or `null` if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.  
Type: Array of [BatchAlarmActionErrorEntry](API_iotevents-data_BatchAlarmActionErrorEntry.md) objects

## Errors
<a name="API_iotevents-data_BatchDisableAlarm_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

 ** 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_iotevents-data_BatchDisableAlarm_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-data-2018-10-23/BatchDisableAlarm) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-data-2018-10-23/BatchDisableAlarm) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-data-2018-10-23/BatchDisableAlarm) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-data-2018-10-23/BatchDisableAlarm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-data-2018-10-23/BatchDisableAlarm) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-data-2018-10-23/BatchDisableAlarm) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-data-2018-10-23/BatchDisableAlarm) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-data-2018-10-23/BatchDisableAlarm) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-data-2018-10-23/BatchDisableAlarm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-data-2018-10-23/BatchDisableAlarm) 

# BatchEnableAlarm
<a name="API_iotevents-data_BatchEnableAlarm"></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). 

Enables one or more alarms. The alarms change to the `NORMAL` state after you enable them.

## Request Syntax
<a name="API_iotevents-data_BatchEnableAlarm_RequestSyntax"></a>

```
POST /alarms/enable HTTP/1.1
Content-type: application/json

{
   "enableActionRequests": [ 
      { 
         "alarmModelName": "string",
         "keyValue": "string",
         "note": "string",
         "requestId": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_iotevents-data_BatchEnableAlarm_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_iotevents-data_BatchEnableAlarm_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [enableActionRequests](#API_iotevents-data_BatchEnableAlarm_RequestSyntax) **   <a name="iotevents-iotevents-data_BatchEnableAlarm-request-enableActionRequests"></a>
The list of enable action requests. You can specify up to 10 requests per operation.  
Type: Array of [EnableAlarmActionRequest](API_iotevents-data_EnableAlarmActionRequest.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## Response Syntax
<a name="API_iotevents-data_BatchEnableAlarm_ResponseSyntax"></a>

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

{
   "errorEntries": [ 
      { 
         "errorCode": "string",
         "errorMessage": "string",
         "requestId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_iotevents-data_BatchEnableAlarm_ResponseElements"></a>

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

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

 ** [errorEntries](#API_iotevents-data_BatchEnableAlarm_ResponseSyntax) **   <a name="iotevents-iotevents-data_BatchEnableAlarm-response-errorEntries"></a>
A list of errors associated with the request, or `null` if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.  
Type: Array of [BatchAlarmActionErrorEntry](API_iotevents-data_BatchAlarmActionErrorEntry.md) objects

## Errors
<a name="API_iotevents-data_BatchEnableAlarm_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

 ** 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_iotevents-data_BatchEnableAlarm_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-data-2018-10-23/BatchEnableAlarm) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-data-2018-10-23/BatchEnableAlarm) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-data-2018-10-23/BatchEnableAlarm) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-data-2018-10-23/BatchEnableAlarm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-data-2018-10-23/BatchEnableAlarm) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-data-2018-10-23/BatchEnableAlarm) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-data-2018-10-23/BatchEnableAlarm) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-data-2018-10-23/BatchEnableAlarm) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-data-2018-10-23/BatchEnableAlarm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-data-2018-10-23/BatchEnableAlarm) 

# BatchPutMessage
<a name="API_iotevents-data_BatchPutMessage"></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). 

Sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify (`"inputName"`) and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response.

The following limits apply: 
+ Maximum messages per batch: 10
+ Maximum message payload per batch: 1024 Bytes (1 KiB)

## Request Syntax
<a name="API_iotevents-data_BatchPutMessage_RequestSyntax"></a>

```
POST /inputs/messages HTTP/1.1
Content-type: application/json

{
   "messages": [ 
      { 
         "inputName": "string",
         "messageId": "string",
         "payload": blob,
         "timestamp": { 
            "timeInMillis": number
         }
      }
   ]
}
```

## URI Request Parameters
<a name="API_iotevents-data_BatchPutMessage_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_iotevents-data_BatchPutMessage_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [messages](#API_iotevents-data_BatchPutMessage_RequestSyntax) **   <a name="iotevents-iotevents-data_BatchPutMessage-request-messages"></a>
The list of messages to send. Each message has the following format: `'{ "messageId": "string", "inputName": "string", "payload": "string"}'`   
Type: Array of [Message](API_iotevents-data_Message.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## Response Syntax
<a name="API_iotevents-data_BatchPutMessage_ResponseSyntax"></a>

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

{
   "BatchPutMessageErrorEntries": [ 
      { 
         "errorCode": "string",
         "errorMessage": "string",
         "messageId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_iotevents-data_BatchPutMessage_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.

 ** [BatchPutMessageErrorEntries](#API_iotevents-data_BatchPutMessage_ResponseSyntax) **   <a name="iotevents-iotevents-data_BatchPutMessage-response-BatchPutMessageErrorEntries"></a>
A list of any errors encountered when sending the messages.  
Type: Array of [BatchPutMessageErrorEntry](API_iotevents-data_BatchPutMessageErrorEntry.md) objects

## Errors
<a name="API_iotevents-data_BatchPutMessage_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

 ** 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_iotevents-data_BatchPutMessage_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-data-2018-10-23/BatchPutMessage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-data-2018-10-23/BatchPutMessage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-data-2018-10-23/BatchPutMessage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-data-2018-10-23/BatchPutMessage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-data-2018-10-23/BatchPutMessage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-data-2018-10-23/BatchPutMessage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-data-2018-10-23/BatchPutMessage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-data-2018-10-23/BatchPutMessage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-data-2018-10-23/BatchPutMessage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-data-2018-10-23/BatchPutMessage) 

# BatchResetAlarm
<a name="API_iotevents-data_BatchResetAlarm"></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). 

Resets one or more alarms. The alarms return to the `NORMAL` state after you reset them.

## Request Syntax
<a name="API_iotevents-data_BatchResetAlarm_RequestSyntax"></a>

```
POST /alarms/reset HTTP/1.1
Content-type: application/json

{
   "resetActionRequests": [ 
      { 
         "alarmModelName": "string",
         "keyValue": "string",
         "note": "string",
         "requestId": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_iotevents-data_BatchResetAlarm_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_iotevents-data_BatchResetAlarm_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [resetActionRequests](#API_iotevents-data_BatchResetAlarm_RequestSyntax) **   <a name="iotevents-iotevents-data_BatchResetAlarm-request-resetActionRequests"></a>
The list of reset action requests. You can specify up to 10 requests per operation.  
Type: Array of [ResetAlarmActionRequest](API_iotevents-data_ResetAlarmActionRequest.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## Response Syntax
<a name="API_iotevents-data_BatchResetAlarm_ResponseSyntax"></a>

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

{
   "errorEntries": [ 
      { 
         "errorCode": "string",
         "errorMessage": "string",
         "requestId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_iotevents-data_BatchResetAlarm_ResponseElements"></a>

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

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

 ** [errorEntries](#API_iotevents-data_BatchResetAlarm_ResponseSyntax) **   <a name="iotevents-iotevents-data_BatchResetAlarm-response-errorEntries"></a>
A list of errors associated with the request, or `null` if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.  
Type: Array of [BatchAlarmActionErrorEntry](API_iotevents-data_BatchAlarmActionErrorEntry.md) objects

## Errors
<a name="API_iotevents-data_BatchResetAlarm_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

 ** 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_iotevents-data_BatchResetAlarm_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-data-2018-10-23/BatchResetAlarm) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-data-2018-10-23/BatchResetAlarm) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-data-2018-10-23/BatchResetAlarm) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-data-2018-10-23/BatchResetAlarm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-data-2018-10-23/BatchResetAlarm) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-data-2018-10-23/BatchResetAlarm) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-data-2018-10-23/BatchResetAlarm) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-data-2018-10-23/BatchResetAlarm) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-data-2018-10-23/BatchResetAlarm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-data-2018-10-23/BatchResetAlarm) 

# BatchSnoozeAlarm
<a name="API_iotevents-data_BatchSnoozeAlarm"></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). 

Changes one or more alarms to the snooze mode. The alarms change to the `SNOOZE_DISABLED` state after you set them to the snooze mode.

## Request Syntax
<a name="API_iotevents-data_BatchSnoozeAlarm_RequestSyntax"></a>

```
POST /alarms/snooze HTTP/1.1
Content-type: application/json

{
   "snoozeActionRequests": [ 
      { 
         "alarmModelName": "string",
         "keyValue": "string",
         "note": "string",
         "requestId": "string",
         "snoozeDuration": number
      }
   ]
}
```

## URI Request Parameters
<a name="API_iotevents-data_BatchSnoozeAlarm_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_iotevents-data_BatchSnoozeAlarm_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [snoozeActionRequests](#API_iotevents-data_BatchSnoozeAlarm_RequestSyntax) **   <a name="iotevents-iotevents-data_BatchSnoozeAlarm-request-snoozeActionRequests"></a>
The list of snooze action requests. You can specify up to 10 requests per operation.  
Type: Array of [SnoozeAlarmActionRequest](API_iotevents-data_SnoozeAlarmActionRequest.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## Response Syntax
<a name="API_iotevents-data_BatchSnoozeAlarm_ResponseSyntax"></a>

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

{
   "errorEntries": [ 
      { 
         "errorCode": "string",
         "errorMessage": "string",
         "requestId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_iotevents-data_BatchSnoozeAlarm_ResponseElements"></a>

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

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

 ** [errorEntries](#API_iotevents-data_BatchSnoozeAlarm_ResponseSyntax) **   <a name="iotevents-iotevents-data_BatchSnoozeAlarm-response-errorEntries"></a>
A list of errors associated with the request, or `null` if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.  
Type: Array of [BatchAlarmActionErrorEntry](API_iotevents-data_BatchAlarmActionErrorEntry.md) objects

## Errors
<a name="API_iotevents-data_BatchSnoozeAlarm_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

 ** 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_iotevents-data_BatchSnoozeAlarm_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-data-2018-10-23/BatchSnoozeAlarm) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-data-2018-10-23/BatchSnoozeAlarm) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-data-2018-10-23/BatchSnoozeAlarm) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-data-2018-10-23/BatchSnoozeAlarm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-data-2018-10-23/BatchSnoozeAlarm) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-data-2018-10-23/BatchSnoozeAlarm) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-data-2018-10-23/BatchSnoozeAlarm) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-data-2018-10-23/BatchSnoozeAlarm) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-data-2018-10-23/BatchSnoozeAlarm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-data-2018-10-23/BatchSnoozeAlarm) 

# BatchUpdateDetector
<a name="API_iotevents-data_BatchUpdateDetector"></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). 

Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.

## Request Syntax
<a name="API_iotevents-data_BatchUpdateDetector_RequestSyntax"></a>

```
POST /detectors HTTP/1.1
Content-type: application/json

{
   "detectors": [ 
      { 
         "detectorModelName": "string",
         "keyValue": "string",
         "messageId": "string",
         "state": { 
            "stateName": "string",
            "timers": [ 
               { 
                  "name": "string",
                  "seconds": number
               }
            ],
            "variables": [ 
               { 
                  "name": "string",
                  "value": "string"
               }
            ]
         }
      }
   ]
}
```

## URI Request Parameters
<a name="API_iotevents-data_BatchUpdateDetector_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_iotevents-data_BatchUpdateDetector_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [detectors](#API_iotevents-data_BatchUpdateDetector_RequestSyntax) **   <a name="iotevents-iotevents-data_BatchUpdateDetector-request-detectors"></a>
The list of detectors (instances) to update, along with the values to update.  
Type: Array of [UpdateDetectorRequest](API_iotevents-data_UpdateDetectorRequest.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## Response Syntax
<a name="API_iotevents-data_BatchUpdateDetector_ResponseSyntax"></a>

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

{
   "batchUpdateDetectorErrorEntries": [ 
      { 
         "errorCode": "string",
         "errorMessage": "string",
         "messageId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_iotevents-data_BatchUpdateDetector_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.

 ** [batchUpdateDetectorErrorEntries](#API_iotevents-data_BatchUpdateDetector_ResponseSyntax) **   <a name="iotevents-iotevents-data_BatchUpdateDetector-response-batchUpdateDetectorErrorEntries"></a>
A list of those detector updates that resulted in errors. (If an error is listed here, the specific update did not occur.)  
Type: Array of [BatchUpdateDetectorErrorEntry](API_iotevents-data_BatchUpdateDetectorErrorEntry.md) objects

## Errors
<a name="API_iotevents-data_BatchUpdateDetector_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

 ** 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_iotevents-data_BatchUpdateDetector_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-data-2018-10-23/BatchUpdateDetector) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-data-2018-10-23/BatchUpdateDetector) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-data-2018-10-23/BatchUpdateDetector) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-data-2018-10-23/BatchUpdateDetector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-data-2018-10-23/BatchUpdateDetector) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-data-2018-10-23/BatchUpdateDetector) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-data-2018-10-23/BatchUpdateDetector) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-data-2018-10-23/BatchUpdateDetector) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-data-2018-10-23/BatchUpdateDetector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-data-2018-10-23/BatchUpdateDetector) 

# DescribeAlarm
<a name="API_iotevents-data_DescribeAlarm"></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 information about an alarm.

## Request Syntax
<a name="API_iotevents-data_DescribeAlarm_RequestSyntax"></a>

```
GET /alarms/alarmModelName/keyValues/?keyValue=keyValue HTTP/1.1
```

## URI Request Parameters
<a name="API_iotevents-data_DescribeAlarm_RequestParameters"></a>

The request uses the following URI parameters.

 ** [alarmModelName](#API_iotevents-data_DescribeAlarm_RequestSyntax) **   <a name="iotevents-iotevents-data_DescribeAlarm-request-uri-alarmModelName"></a>
The name of the alarm model.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [keyValue](#API_iotevents-data_DescribeAlarm_RequestSyntax) **   <a name="iotevents-iotevents-data_DescribeAlarm-request-uri-keyValue"></a>
The value of the key used as a filter to select only the alarms associated with the [key](https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key).  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9\-_:]+$` 

## Request Body
<a name="API_iotevents-data_DescribeAlarm_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_iotevents-data_DescribeAlarm_ResponseSyntax"></a>

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

{
   "alarm": { 
      "alarmModelName": "string",
      "alarmModelVersion": "string",
      "alarmState": { 
         "customerAction": { 
            "acknowledgeActionConfiguration": { 
               "note": "string"
            },
            "actionName": "string",
            "disableActionConfiguration": { 
               "note": "string"
            },
            "enableActionConfiguration": { 
               "note": "string"
            },
            "resetActionConfiguration": { 
               "note": "string"
            },
            "snoozeActionConfiguration": { 
               "note": "string",
               "snoozeDuration": number
            }
         },
         "ruleEvaluation": { 
            "simpleRuleEvaluation": { 
               "inputPropertyValue": "string",
               "operator": "string",
               "thresholdValue": "string"
            }
         },
         "stateName": "string",
         "systemEvent": { 
            "eventType": "string",
            "stateChangeConfiguration": { 
               "triggerType": "string"
            }
         }
      },
      "creationTime": number,
      "keyValue": "string",
      "lastUpdateTime": number,
      "severity": number
   }
}
```

## Response Elements
<a name="API_iotevents-data_DescribeAlarm_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.

 ** [alarm](#API_iotevents-data_DescribeAlarm_ResponseSyntax) **   <a name="iotevents-iotevents-data_DescribeAlarm-response-alarm"></a>
Contains information about an alarm.  
Type: [Alarm](API_iotevents-data_Alarm.md) object

## Errors
<a name="API_iotevents-data_DescribeAlarm_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_iotevents-data_DescribeAlarm_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-data-2018-10-23/DescribeAlarm) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-data-2018-10-23/DescribeAlarm) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-data-2018-10-23/DescribeAlarm) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-data-2018-10-23/DescribeAlarm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-data-2018-10-23/DescribeAlarm) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-data-2018-10-23/DescribeAlarm) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-data-2018-10-23/DescribeAlarm) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-data-2018-10-23/DescribeAlarm) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-data-2018-10-23/DescribeAlarm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-data-2018-10-23/DescribeAlarm) 

# DescribeDetector
<a name="API_iotevents-data_DescribeDetector"></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). 

Returns information about the specified detector (instance).

## Request Syntax
<a name="API_iotevents-data_DescribeDetector_RequestSyntax"></a>

```
GET /detectors/detectorModelName/keyValues/?keyValue=keyValue HTTP/1.1
```

## URI Request Parameters
<a name="API_iotevents-data_DescribeDetector_RequestParameters"></a>

The request uses the following URI parameters.

 ** [detectorModelName](#API_iotevents-data_DescribeDetector_RequestSyntax) **   <a name="iotevents-iotevents-data_DescribeDetector-request-uri-detectorModelName"></a>
The name of the detector model whose detectors (instances) you want information about.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [keyValue](#API_iotevents-data_DescribeDetector_RequestSyntax) **   <a name="iotevents-iotevents-data_DescribeDetector-request-uri-keyValue"></a>
A filter used to limit results to detectors (instances) created because of the given key ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9\-_:]+$` 

## Request Body
<a name="API_iotevents-data_DescribeDetector_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_iotevents-data_DescribeDetector_ResponseSyntax"></a>

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

{
   "detector": { 
      "creationTime": number,
      "detectorModelName": "string",
      "detectorModelVersion": "string",
      "keyValue": "string",
      "lastUpdateTime": number,
      "state": { 
         "stateName": "string",
         "timers": [ 
            { 
               "name": "string",
               "timestamp": number
            }
         ],
         "variables": [ 
            { 
               "name": "string",
               "value": "string"
            }
         ]
      }
   }
}
```

## Response Elements
<a name="API_iotevents-data_DescribeDetector_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.

 ** [detector](#API_iotevents-data_DescribeDetector_ResponseSyntax) **   <a name="iotevents-iotevents-data_DescribeDetector-response-detector"></a>
Information about the detector (instance).  
Type: [Detector](API_iotevents-data_Detector.md) object

## Errors
<a name="API_iotevents-data_DescribeDetector_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_iotevents-data_DescribeDetector_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-data-2018-10-23/DescribeDetector) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-data-2018-10-23/DescribeDetector) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-data-2018-10-23/DescribeDetector) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-data-2018-10-23/DescribeDetector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-data-2018-10-23/DescribeDetector) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-data-2018-10-23/DescribeDetector) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-data-2018-10-23/DescribeDetector) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-data-2018-10-23/DescribeDetector) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-data-2018-10-23/DescribeDetector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-data-2018-10-23/DescribeDetector) 

# ListAlarms
<a name="API_iotevents-data_ListAlarms"></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). 

Lists one or more alarms. The operation returns only the metadata associated with each alarm.

## Request Syntax
<a name="API_iotevents-data_ListAlarms_RequestSyntax"></a>

```
GET /alarms/alarmModelName?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_iotevents-data_ListAlarms_RequestParameters"></a>

The request uses the following URI parameters.

 ** [alarmModelName](#API_iotevents-data_ListAlarms_RequestSyntax) **   <a name="iotevents-iotevents-data_ListAlarms-request-uri-alarmModelName"></a>
The name of the alarm model.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [maxResults](#API_iotevents-data_ListAlarms_RequestSyntax) **   <a name="iotevents-iotevents-data_ListAlarms-request-uri-maxResults"></a>
The maximum number of results to be returned per request.  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_iotevents-data_ListAlarms_RequestSyntax) **   <a name="iotevents-iotevents-data_ListAlarms-request-uri-nextToken"></a>
The token that you can use to return the next set of results.

## Request Body
<a name="API_iotevents-data_ListAlarms_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_iotevents-data_ListAlarms_ResponseSyntax"></a>

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

{
   "alarmSummaries": [ 
      { 
         "alarmModelName": "string",
         "alarmModelVersion": "string",
         "creationTime": number,
         "keyValue": "string",
         "lastUpdateTime": number,
         "stateName": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_iotevents-data_ListAlarms_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.

 ** [alarmSummaries](#API_iotevents-data_ListAlarms_ResponseSyntax) **   <a name="iotevents-iotevents-data_ListAlarms-response-alarmSummaries"></a>
A list that summarizes each alarm.  
Type: Array of [AlarmSummary](API_iotevents-data_AlarmSummary.md) objects

 ** [nextToken](#API_iotevents-data_ListAlarms_ResponseSyntax) **   <a name="iotevents-iotevents-data_ListAlarms-response-nextToken"></a>
The token that you can use to return the next set of results, or `null` if there are no more results.  
Type: String

## Errors
<a name="API_iotevents-data_ListAlarms_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_iotevents-data_ListAlarms_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-data-2018-10-23/ListAlarms) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-data-2018-10-23/ListAlarms) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-data-2018-10-23/ListAlarms) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-data-2018-10-23/ListAlarms) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-data-2018-10-23/ListAlarms) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-data-2018-10-23/ListAlarms) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-data-2018-10-23/ListAlarms) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-data-2018-10-23/ListAlarms) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-data-2018-10-23/ListAlarms) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-data-2018-10-23/ListAlarms) 

# ListDetectors
<a name="API_iotevents-data_ListDetectors"></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). 

Lists detectors (the instances of a detector model).

## Request Syntax
<a name="API_iotevents-data_ListDetectors_RequestSyntax"></a>

```
GET /detectors/detectorModelName?maxResults=maxResults&nextToken=nextToken&stateName=stateName HTTP/1.1
```

## URI Request Parameters
<a name="API_iotevents-data_ListDetectors_RequestParameters"></a>

The request uses the following URI parameters.

 ** [detectorModelName](#API_iotevents-data_ListDetectors_RequestSyntax) **   <a name="iotevents-iotevents-data_ListDetectors-request-uri-detectorModelName"></a>
The name of the detector model whose detectors (instances) are listed.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [maxResults](#API_iotevents-data_ListDetectors_RequestSyntax) **   <a name="iotevents-iotevents-data_ListDetectors-request-uri-maxResults"></a>
The maximum number of results to be returned per request.  
Valid Range: Minimum value of 1. Maximum value of 250.

 ** [nextToken](#API_iotevents-data_ListDetectors_RequestSyntax) **   <a name="iotevents-iotevents-data_ListDetectors-request-uri-nextToken"></a>
The token that you can use to return the next set of results.

 ** [stateName](#API_iotevents-data_ListDetectors_RequestSyntax) **   <a name="iotevents-iotevents-data_ListDetectors-request-uri-stateName"></a>
A filter that limits results to those detectors (instances) in the given state.  
Length Constraints: Minimum length of 1. Maximum length of 128.

## Request Body
<a name="API_iotevents-data_ListDetectors_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_iotevents-data_ListDetectors_ResponseSyntax"></a>

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

{
   "detectorSummaries": [ 
      { 
         "creationTime": number,
         "detectorModelName": "string",
         "detectorModelVersion": "string",
         "keyValue": "string",
         "lastUpdateTime": number,
         "state": { 
            "stateName": "string"
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_iotevents-data_ListDetectors_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.

 ** [detectorSummaries](#API_iotevents-data_ListDetectors_ResponseSyntax) **   <a name="iotevents-iotevents-data_ListDetectors-response-detectorSummaries"></a>
A list of summary information about the detectors (instances).  
Type: Array of [DetectorSummary](API_iotevents-data_DetectorSummary.md) objects

 ** [nextToken](#API_iotevents-data_ListDetectors_ResponseSyntax) **   <a name="iotevents-iotevents-data_ListDetectors-response-nextToken"></a>
The token that you can use to return the next set of results, or `null` if there are no more results.  
Type: String

## Errors
<a name="API_iotevents-data_ListDetectors_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_iotevents-data_ListDetectors_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-data-2018-10-23/ListDetectors) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-data-2018-10-23/ListDetectors) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-data-2018-10-23/ListDetectors) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-data-2018-10-23/ListDetectors) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-data-2018-10-23/ListDetectors) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-data-2018-10-23/ListDetectors) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-data-2018-10-23/ListDetectors) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-data-2018-10-23/ListDetectors) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-data-2018-10-23/ListDetectors) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-data-2018-10-23/ListDetectors)