add_source_identifier_to_subscription

add_source_identifier_to_subscription(**kwargs)

Adds a source identifier to an existing RDS 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 RDS event notification subscription you want to add a source identifier to.

• SourceIdentifier (string) --

  [REQUIRED]

  The identifier of the event source to be added.

  Constraints:

  • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
  • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
  • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
  • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
  • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
  • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
  • If the source type is an RDS Proxy, a DBProxyName value must be supplied.

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

    Contains the results of a successful invocation of the DescribeEventSubscriptions action.

    • CustomerAwsId (string) --

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

    • CustSubscriptionId (string) --

      The RDS event notification subscription Id.

    • SnsTopicArn (string) --

      The topic ARN of the RDS event notification subscription.

    • Status (string) --

      The status of the RDS 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 RDS 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 RDS event notification subscription was created.

    • SourceType (string) --

      The source type for the RDS event notification subscription.

    • SourceIdsList (list) --

      A list of source IDs for the RDS event notification subscription.

      • (string) --

    • EventCategoriesList (list) --

      A list of event categories for the RDS event notification subscription.

      • (string) --

    • Enabled (boolean) --

      A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

    • EventSubscriptionArn (string) --

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

Exceptions

• RDS.Client.exceptions.SubscriptionNotFoundFault
• RDS.Client.exceptions.SourceNotFoundFault

Examples

This example add a source identifier to an event notification subscription.

response = client.add_source_identifier_to_subscription(
    SourceIdentifier='mymysqlinstance',
    SubscriptionName='mymysqleventsubscription',
)

print(response)

Expected Output:

{
    'EventSubscription': {
    },
    'ResponseMetadata': {
        '...': '...',
    },
}