:doc:`DocDB <../../docdb>` / Paginator / DescribeEvents

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



.. py:class:: DocDB.Paginator.DescribeEvents

  ::

    
    paginator = client.get_paginator('describe_events')

  
  

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

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

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEvents>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          SourceIdentifier='string',
          SourceType='db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'|'db-cluster'|'db-cluster-snapshot',
          StartTime=datetime(2015, 1, 1),
          EndTime=datetime(2015, 1, 1),
          Duration=123,
          EventCategories=[
              'string',
          ],
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          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, then all sources are included in the response.

       

      Constraints:

       

      
      * If ``SourceIdentifier`` is provided, ``SourceType`` must also be provided.
       
      * If the source type is ``DBInstance``, a ``DBInstanceIdentifier`` must be provided.
       
      * If the source type is ``DBSecurityGroup``, a ``DBSecurityGroupName`` must be provided.
       
      * If the source type is ``DBParameterGroup``, a ``DBParameterGroupName`` must be provided.
       
      * If the source type is ``DBSnapshot``, a ``DBSnapshotIdentifier`` must be provided.
       
      * Cannot end with a hyphen or contain two consecutive hyphens.
      

      

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

       

      Example: 2009-07-08T18:00Z

      

    
    :type Duration: integer
    :param Duration: 

      The number of minutes to retrieve events for.

       

      Default: 60

      

    
    :type EventCategories: list
    :param EventCategories: 

      A list of event categories that trigger notifications for an event notification subscription.

      

    
      - *(string) --* 

      
  
    :type Filters: list
    :param Filters: 

      This parameter is not currently supported.

      

    
      - *(dict) --* 

        A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

         

        Wildcards are not supported in filters.

        

      
        - **Name** *(string) --* **[REQUIRED]** 

          The name of the filter. Filter names are case sensitive.

          

        
        - **Values** *(list) --* **[REQUIRED]** 

          One or more filter values. Filter values are case sensitive.

          

        
          - *(string) --* 

          
      
      
  
    :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': 'db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'|'db-cluster'|'db-cluster-snapshot',
                    'Message': 'string',
                    'EventCategories': [
                        'string',
                    ],
                    'Date': datetime(2015, 1, 1),
                    'SourceArn': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Represents the output of  DescribeEvents.

        
        

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

          Detailed information about one or more events.

          
          

          - *(dict) --* 

            Detailed information about an event.

            
            

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

              Provides the identifier for the source of the event.

              
            

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

              Specifies the source type for this event.

              
            

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

              Provides the text of this event.

              
            

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

              Specifies the category for the event.

              
              

              - *(string) --* 
          
            

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

              Specifies the date and time of the event.

              
            

            - **SourceArn** *(string) --* 

              The Amazon Resource Name (ARN) for the event.

              
        
      
        

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

          A token to resume pagination.

          
    