batch_disable_alarm

batch_disable_alarm(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.batch_disable_alarm(
    disableActionRequests=[
        {
            'requestId': 'string',
            'alarmModelName': 'string',
            'keyValue': 'string',
            'note': 'string'
        },
    ]
)

Parameters

disableActionRequests (list) --

[REQUIRED]

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

• (dict) --

  Information used to disable 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 disable the alarm.

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.

    • (dict) --

      Contains error messages associated with one of the following requests:

      • BatchAcknowledgeAlarm
      • BatchDisableAlarm
      • BatchEnableAlarm
      • BatchResetAlarm
      • BatchSnoozeAlarm
      • requestId (string) --

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

      • errorCode (string) --

        The error code.

      • errorMessage (string) --

        A message that describes the error.

Exceptions

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