:doc:`MediaLive <../../medialive>` / Paginator / ListMultiplexAlerts

*******************
ListMultiplexAlerts
*******************



.. py:class:: MediaLive.Paginator.ListMultiplexAlerts

  ::

    
    paginator = client.get_paginator('list_multiplex_alerts')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`MediaLive.Client.list_multiplex_alerts`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/medialive-2017-10-14/ListMultiplexAlerts>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          MultiplexId='string',
          StateFilter='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type MultiplexId: string
    :param MultiplexId: **[REQUIRED]** The unique ID of the multiplex

    
    :type StateFilter: string
    :param StateFilter: Specifies the set of alerts to return based on their state. SET - Return only alerts with SET state. CLEARED - Return only alerts with CLEARED state. ALL - Return all alerts.

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'Alerts': [
                {
                    'AlertType': 'string',
                    'ClearedTimestamp': datetime(2015, 1, 1),
                    'Id': 'string',
                    'Message': 'string',
                    'PipelineId': 'string',
                    'SetTimestamp': datetime(2015, 1, 1),
                    'State': 'SET'|'CLEARED'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* List of alerts
        

        - **Alerts** *(list) --* The alerts found for this multiplex
          

          - *(dict) --* An alert on a multiplex
            

            - **AlertType** *(string) --* The type of the alert
            

            - **ClearedTimestamp** *(datetime) --* The time when the alert was cleared
            

            - **Id** *(string) --* The unique ID for this alert instance
            

            - **Message** *(string) --* The user facing alert message which can have more context
            

            - **PipelineId** *(string) --* The ID of the pipeline this alert is associated with
            

            - **SetTimestamp** *(datetime) --* The time when the alert was set
            

            - **State** *(string) --* The state of the alert
        
      
    