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

**************************
DescribeEventSubscriptions
**************************



.. py:class:: DatabaseMigrationService.Paginator.DescribeEventSubscriptions

  ::

    
    paginator = client.get_paginator('describe_event_subscriptions')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          SubscriptionName='string',
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type SubscriptionName: string
    :param SubscriptionName: 

      The name of the DMS event subscription to be described.

      

    
    :type Filters: list
    :param Filters: 

      Filters applied to event subscriptions.

       

      Valid filter names: ``event-subscription-arn`` | ``event-subscription-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**

      
      ::

        {
            'EventSubscriptionsList': [
                {
                    'CustomerAwsId': 'string',
                    'CustSubscriptionId': 'string',
                    'SnsTopicArn': 'string',
                    'Status': 'string',
                    'SubscriptionCreationTime': 'string',
                    'SourceType': 'string',
                    'SourceIdsList': [
                        'string',
                    ],
                    'EventCategoriesList': [
                        'string',
                    ],
                    'Enabled': True|False
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **EventSubscriptionsList** *(list) --* 

          A list of event subscriptions.

          
          

          - *(dict) --* 

            Describes an event notification subscription created by the ``CreateEventSubscription`` operation.

            
            

            - **CustomerAwsId** *(string) --* 

              The Amazon Web Services customer account associated with the DMS event notification subscription.

              
            

            - **CustSubscriptionId** *(string) --* 

              The DMS event notification subscription Id.

              
            

            - **SnsTopicArn** *(string) --* 

              The topic ARN of the DMS event notification subscription.

              
            

            - **Status** *(string) --* 

              The status of the DMS event notification subscription.

               

              Constraints:

               

              Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

               

              The status "no-permission" indicates that DMS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

              
            

            - **SubscriptionCreationTime** *(string) --* 

              The time the DMS event notification subscription was created.

              
            

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

              The type of DMS resource that generates events.

               

              Valid values: replication-instance | replication-server | security-group | replication-task

              
            

            - **SourceIdsList** *(list) --* 

              A list of source Ids for the event subscription.

              
              

              - *(string) --* 
          
            

            - **EventCategoriesList** *(list) --* 

              A lists of event categories.

              
              

              - *(string) --* 
          
            

            - **Enabled** *(boolean) --* 

              Boolean value that indicates if the event subscription is enabled.

              
        
      
        

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

          A token to resume pagination.

          
    