Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

BatchDisableAlarm

Important

End of support notice: On May 20,2026, Amazon will end support for Amazon IoT Events. After May 20,2026, you will no longer be able to access the Amazon IoT Events console or Amazon IoT Events resources. For more information, see Amazon IoT Events end of support.

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

Request Syntax


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

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

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

disableActionRequests

The list of disable action requests. You can specify up to 10 requests per operation.

Type: Array of DisableAlarmActionRequest objects

Array Members: Minimum number of 1 item.

Required: Yes

Response Syntax


HTTP/1.1 202
Content-type: application/json

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

Response Elements

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

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 objects

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

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The request could not be completed due to throttling.

HTTP Status Code: 429