:doc:`IoTEventsData <../../iotevents-data>` / Client / batch_snooze_alarm

******************
batch_snooze_alarm
******************



.. py:method:: IoTEventsData.Client.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 <https://docs.aws.amazon.com/goto/WebAPI/iotevents-data-2018-10-23/BatchSnoozeAlarm>`_  


  **Request Syntax**
  ::

    response = client.batch_snooze_alarm(
        snoozeActionRequests=[
            {
                'requestId': 'string',
                'alarmModelName': 'string',
                'keyValue': 'string',
                'note': 'string',
                'snoozeDuration': 123
            },
        ]
    )
    
  :type snoozeActionRequests: list
  :param snoozeActionRequests: **[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 <https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-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.

        

      
    

  
  :rtype: 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 <https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchAcknowledgeAlarm.html>`__
           
          * `BatchDisableAlarm <https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchDisableAlarm.html>`__
           
          * `BatchEnableAlarm <https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchEnableAlarm.html>`__
           
          * `BatchResetAlarm <https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchResetAlarm.html>`__
           
          * `BatchSnoozeAlarm <https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchSnoozeAlarm.html>`__
          

          
          

          - **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**
  
  *   :py:class:`IoTEventsData.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoTEventsData.Client.exceptions.InternalFailureException`

  
  *   :py:class:`IoTEventsData.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`IoTEventsData.Client.exceptions.ThrottlingException`

  