:doc:`DatabaseMigrationService <../../dms>` / Client / describe_events

***************
describe_events
***************



.. py:method:: DatabaseMigrationService.Client.describe_events(**kwargs)

  

  Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on DMS events, see `Working with Events and Notifications <https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html>`__ in the *Database Migration Service User Guide.*

  

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


  **Request Syntax**
  ::

    response = client.describe_events(
        SourceIdentifier='string',
        SourceType='replication-instance',
        StartTime=datetime(2015, 1, 1),
        EndTime=datetime(2015, 1, 1),
        Duration=123,
        EventCategories=[
            'string',
        ],
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        MaxRecords=123,
        Marker='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 MaxRecords: integer
  :param MaxRecords: 

    The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

     

    Default: 100

     

    Constraints: Minimum 20, maximum 100.

    

  
  :type Marker: string
  :param Marker: 

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ``MaxRecords``.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Marker': 'string',
          'Events': [
              {
                  'SourceIdentifier': 'string',
                  'SourceType': 'replication-instance',
                  'Message': 'string',
                  'EventCategories': [
                      'string',
                  ],
                  'Date': datetime(2015, 1, 1)
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Marker** *(string) --* 

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ``MaxRecords``.

        
      

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

            
      
    
  