DocDB / Client / add_source_identifier_to_subscription

add_source_identifier_to_subscription#

DocDB.Client.add_source_identifier_to_subscription(**kwargs)#

Adds a source identifier to an existing event notification subscription.

See also: AWS API Documentation

Request Syntax

response = client.add_source_identifier_to_subscription(
    SubscriptionName='string',
    SourceIdentifier='string'
)
Parameters:
  • SubscriptionName (string) –

    [REQUIRED]

    The name of the Amazon DocumentDB event notification subscription that you want to add a source identifier to.

  • SourceIdentifier (string) –

    [REQUIRED]

    The identifier of the event source to be added:

    • If the source type is an instance, a DBInstanceIdentifier must be provided.

    • If the source type is a security group, a DBSecurityGroupName must be provided.

    • If the source type is a parameter group, a DBParameterGroupName must be provided.

    • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

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