DocDB / Paginator / DescribeEventSubscriptions

DescribeEventSubscriptions#

class DocDB.Paginator.DescribeEventSubscriptions#
paginator = client.get_paginator('describe_event_subscriptions')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from DocDB.Client.describe_event_subscriptions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SubscriptionName='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • SubscriptionName (string) – The name of the Amazon DocumentDB event notification subscription that you want to describe.

  • Filters (list) –

    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) –

  • PaginationConfig (dict) –

    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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    Represents the output of DescribeEventSubscriptions.

    • EventSubscriptionsList (list) –

      A list of event subscriptions.

      • (dict) –

        Detailed information about an event to which you have subscribed.

        • CustomerAwsId (string) –

          The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

        • CustSubscriptionId (string) –

          The Amazon DocumentDB event notification subscription ID.

        • SnsTopicArn (string) –

          The topic ARN of the Amazon DocumentDB event notification subscription.

        • Status (string) –

          The status of the Amazon DocumentDB event notification subscription.

          Constraints:

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

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

        • SubscriptionCreationTime (string) –

          The time at which the Amazon DocumentDB event notification subscription was created.

        • SourceType (string) –

          The source type for the Amazon DocumentDB event notification subscription.

        • SourceIdsList (list) –

          A list of source IDs for the Amazon DocumentDB event notification subscription.

          • (string) –

        • EventCategoriesList (list) –

          A list of event categories for the Amazon DocumentDB event notification subscription.

          • (string) –

        • Enabled (boolean) –

          A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.

        • EventSubscriptionArn (string) –

          The Amazon Resource Name (ARN) for the event subscription.

    • NextToken (string) –

      A token to resume pagination.