:doc:`Redshift <../../redshift>` / Paginator / DescribeEvents

**************
DescribeEvents
**************



.. py:class:: Redshift.Paginator.DescribeEvents

  ::

    
    paginator = client.get_paginator('describe_events')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Redshift.Client.describe_events`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeEvents>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          SourceIdentifier='string',
          SourceType='cluster'|'cluster-parameter-group'|'cluster-security-group'|'cluster-snapshot'|'scheduled-action',
          StartTime=datetime(2015, 1, 1),
          EndTime=datetime(2015, 1, 1),
          Duration=123,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type SourceIdentifier: string
    :param SourceIdentifier: 

      The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

       

      Constraints:

       

      If *SourceIdentifier* is supplied, *SourceType* must also be provided.

       

      
      * Specify a cluster identifier when *SourceType* is ``cluster``.
       
      * Specify a cluster security group name when *SourceType* is ``cluster-security-group``.
       
      * Specify a cluster parameter group name when *SourceType* is ``cluster-parameter-group``.
       
      * Specify a cluster snapshot identifier when *SourceType* is ``cluster-snapshot``.
      

      

    
    :type SourceType: string
    :param SourceType: 

      The event source to retrieve events for. If no value is specified, all events are returned.

       

      Constraints:

       

      If *SourceType* is supplied, *SourceIdentifier* must also be provided.

       

      
      * Specify ``cluster`` when *SourceIdentifier* is a cluster identifier.
       
      * Specify ``cluster-security-group`` when *SourceIdentifier* is a cluster security group name.
       
      * Specify ``cluster-parameter-group`` when *SourceIdentifier* is a cluster parameter group name.
       
      * Specify ``cluster-snapshot`` when *SourceIdentifier* is a cluster snapshot identifier.
      

      

    
    :type StartTime: datetime
    :param StartTime: 

      The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the `ISO8601 Wikipedia page. <http://en.wikipedia.org/wiki/ISO_8601>`__

       

      Example: ``2009-07-08T18:00Z``

      

    
    :type EndTime: datetime
    :param EndTime: 

      The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the `ISO8601 Wikipedia page. <http://en.wikipedia.org/wiki/ISO_8601>`__

       

      Example: ``2009-07-08T18:00Z``

      

    
    :type Duration: integer
    :param Duration: 

      The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

       

      Default: ``60``

      

    
    :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**

      
      ::

        {
            'Events': [
                {
                    'SourceIdentifier': 'string',
                    'SourceType': 'cluster'|'cluster-parameter-group'|'cluster-security-group'|'cluster-snapshot'|'scheduled-action',
                    'Message': 'string',
                    'EventCategories': [
                        'string',
                    ],
                    'Severity': 'string',
                    'Date': datetime(2015, 1, 1),
                    'EventId': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Events** *(list) --* 

          A list of ``Event`` instances.

          
          

          - *(dict) --* 

            Describes an event.

            
            

            - **SourceIdentifier** *(string) --* 

              The identifier for the source of the event.

              
            

            - **SourceType** *(string) --* 

              The source type for this event.

              
            

            - **Message** *(string) --* 

              The text of this event.

              
            

            - **EventCategories** *(list) --* 

              A list of the event categories.

               

              Values: Configuration, Management, Monitoring, Security, Pending

              
              

              - *(string) --* 
          
            

            - **Severity** *(string) --* 

              The severity of the event.

               

              Values: ERROR, INFO

              
            

            - **Date** *(datetime) --* 

              The date and time of the event.

              
            

            - **EventId** *(string) --* 

              The identifier of the event.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    