:doc:`RDS <../../rds>` / Paginator / DescribeEvents

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



.. py:class:: RDS.Paginator.DescribeEvents

  ::

    
    paginator = client.get_paginator('describe_events')

  
  

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

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

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rds-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'|'custom-engine-version'|'db-proxy'|'blue-green-deployment'|'db-shard-group'|'zero-etl',
          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 supplied, ``SourceType`` must also be provided.
       
      * If the source type is a DB instance, a ``DBInstanceIdentifier`` value must be supplied.
       
      * If the source type is a DB cluster, a ``DBClusterIdentifier`` value must be supplied.
       
      * If the source type is a DB parameter group, a ``DBParameterGroupName`` value must be supplied.
       
      * If the source type is a DB security group, a ``DBSecurityGroupName`` value must be supplied.
       
      * If the source type is a DB snapshot, a ``DBSnapshotIdentifier`` value must be supplied.
       
      * If the source type is a DB cluster snapshot, a ``DBClusterSnapshotIdentifier`` value must be supplied.
       
      * If the source type is an RDS Proxy, a ``DBProxyName`` value must be supplied.
       
      * Can't 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. 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 to retrieve events for.

       

      Default: 60

      

    
    :type EventCategories: list
    :param EventCategories: 

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

      

    
      - *(string) --* 

      
  
    :type Filters: list
    :param Filters: 

      This parameter isn't currently supported.

      

    
      - *(dict) --* 

        A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

         

        .. note::

          

          Currently, wildcards are not supported in filters.

          

         

        The following actions can be filtered:

         

        
        * ``DescribeDBClusterBacktracks``
         
        * ``DescribeDBClusterEndpoints``
         
        * ``DescribeDBClusters``
         
        * ``DescribeDBInstances``
         
        * ``DescribeDBRecommendations``
         
        * ``DescribeDBShardGroups``
         
        * ``DescribePendingMaintenanceActions``
        

        

      
        - **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'|'custom-engine-version'|'db-proxy'|'blue-green-deployment'|'db-shard-group'|'zero-etl',
                    'Message': 'string',
                    'EventCategories': [
                        'string',
                    ],
                    'Date': datetime(2015, 1, 1),
                    'SourceArn': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Contains the result of a successful invocation of the ``DescribeEvents`` action.

        
        

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

          A list of ``Event`` instances.

          
          

          - *(dict) --* 

            This data type is used as a response element in the `DescribeEvents <https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEvents.html>`__ action.

            
            

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

          
    