BatchSnoozeAlarm - 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.

BatchSnoozeAlarm

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

POST /alarms/snooze HTTP/1.1 Content-type: application/json { "snoozeActionRequests": [ { "alarmModelName": "string", "keyValue": "string", "note": "string", "requestId": "string", "snoozeDuration": number } ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

snoozeActionRequests

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

Type: Array of SnoozeAlarmActionRequest 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

See Also

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