DocDB / Client / delete_event_subscription

delete_event_subscription#

DocDB.Client.delete_event_subscription(**kwargs)#

Deletes an Amazon DocumentDB event notification subscription.

See also: AWS API Documentation

Request Syntax

response = client.delete_event_subscription(
    SubscriptionName='string'
)
Parameters:

SubscriptionName (string) –

[REQUIRED]

The name of the Amazon DocumentDB event notification subscription that you want to delete.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • EventSubscription (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

  • DocDB.Client.exceptions.SubscriptionNotFoundFault

  • DocDB.Client.exceptions.InvalidEventSubscriptionStateFault