batch_snooze_alarm

batch_snooze_alarm(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.batch_snooze_alarm(
    snoozeActionRequests=[
        {
            'requestId': 'string',
            'alarmModelName': 'string',
            'keyValue': 'string',
            'note': 'string',
            'snoozeDuration': 123
        },
    ]
)
Parameters
snoozeActionRequests (list) --

[REQUIRED]

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

  • (dict) --

    Information needed to snooze the alarm.

    • requestId (string) -- [REQUIRED]

      The request ID. Each ID must be unique within each batch.

    • alarmModelName (string) -- [REQUIRED]

      The name of the alarm model.

    • keyValue (string) --

      The value of the key used as a filter to select only the alarms associated with the key.

    • note (string) --

      The note that you can leave when you snooze the alarm.

    • snoozeDuration (integer) -- [REQUIRED]

      The snooze time in seconds. The alarm automatically changes to the NORMAL state after this duration.

Return type
dict
Returns
Response Syntax
{
    'errorEntries': [
        {
            'requestId': 'string',
            'errorCode': 'ResourceNotFoundException'|'InvalidRequestException'|'InternalFailureException'|'ServiceUnavailableException'|'ThrottlingException',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • errorEntries (list) --

      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.

Exceptions

  • IoTEventsData.Client.exceptions.InvalidRequestException
  • IoTEventsData.Client.exceptions.InternalFailureException
  • IoTEventsData.Client.exceptions.ServiceUnavailableException
  • IoTEventsData.Client.exceptions.ThrottlingException