:doc:`DatabaseMigrationService <../../dms>` / Paginator / DescribeEvents

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



.. py:class:: DatabaseMigrationService.Paginator.DescribeEvents

  ::

    
    paginator = client.get_paginator('describe_events')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          SourceIdentifier='string',
          SourceType='replication-instance',
          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 an event source.

      

    
    :type SourceType: string
    :param SourceType: 

      The type of DMS resource that generates events.

       

      Valid values: replication-instance | replication-task

      

    
    :type StartTime: datetime
    :param StartTime: 

      The start time for the events to be listed.

      

    
    :type EndTime: datetime
    :param EndTime: 

      The end time for the events to be listed.

      

    
    :type Duration: integer
    :param Duration: 

      The duration of the events to be listed.

      

    
    :type EventCategories: list
    :param EventCategories: 

      A list of event categories for the source type that you've chosen.

      

    
      - *(string) --* 

      
  
    :type Filters: list
    :param Filters: 

      Filters applied to events. The only valid filter is ``replication-instance-id``.

      

    
      - *(dict) --* 

        Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular ``Describe*`` call or similar operation. Filters are used as an optional parameter for certain API operations.

        

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

          The name of the filter as specified for a ``Describe*`` or similar operation.

          

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

          The filter value, which can specify one or more values used to narrow the returned results.

          

        
          - *(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': 'replication-instance',
                    'Message': 'string',
                    'EventCategories': [
                        'string',
                    ],
                    'Date': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

          The events described.

          
          

          - *(dict) --* 

            Describes an identifiable significant activity that affects a replication instance or task. This object can provide the message, the available event categories, the date and source of the event, and the DMS resource type.

            
            

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

              The identifier of an event source.

              
            

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

              The type of DMS resource that generates events.

               

              Valid values: replication-instance | endpoint | replication-task

              
            

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

              The event message.

              
            

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

              The event categories available for the specified source type.

              
              

              - *(string) --* 
          
            

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

              The date of the event.

              
        
      
        

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

          A token to resume pagination.

          
    