DocDB / Client / describe_event_subscriptions

describe_event_subscriptions#

DocDB.Client.describe_event_subscriptions(**kwargs)#

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

See also: AWS API Documentation

Request Syntax

response = client.describe_event_subscriptions(
    SubscriptionName='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='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) –

  • MaxRecords (integer) –

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    Represents the output of DescribeEventSubscriptions.

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

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

Exceptions