:doc:`ElastiCache <../../elasticache>` / Paginator / DescribeEvents

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



.. py:class:: ElastiCache.Paginator.DescribeEvents

  ::

    
    paginator = client.get_paginator('describe_events')

  
  

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

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

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeEvents>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          SourceIdentifier='string',
          SourceType='cache-cluster'|'cache-parameter-group'|'cache-security-group'|'cache-subnet-group'|'replication-group'|'serverless-cache'|'serverless-cache-snapshot'|'user'|'user-group',
          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 are returned. If not specified, all sources are included in the response.

      

    
    :type SourceType: string
    :param SourceType: 

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

      

    
    :type StartTime: datetime
    :param StartTime: 

      The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

       

      **Example:** 2017-03-30T07:03:49.555Z

      

    
    :type EndTime: datetime
    :param EndTime: 

      The end of the time interval for which to retrieve events, specified in ISO 8601 format.

       

      **Example:** 2017-03-30T07:03:49.555Z

      

    
    :type Duration: integer
    :param Duration: 

      The number of minutes worth of events to retrieve.

      

    
    :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': 'cache-cluster'|'cache-parameter-group'|'cache-security-group'|'cache-subnet-group'|'replication-group'|'serverless-cache'|'serverless-cache-snapshot'|'user'|'user-group',
                    'Message': 'string',
                    'Date': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Represents the output of a ``DescribeEvents`` operation.

        
        

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

          A list of events. Each element in the list contains detailed information about one event.

          
          

          - *(dict) --* 

            Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.

            
            

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

              The identifier for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.

              
            

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

              Specifies the origin of this event - a cluster, a parameter group, a security group, etc.

              
            

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

              The text of the event.

              
            

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

              The date and time when the event occurred.

              
        
      
        

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

          A token to resume pagination.

          
    