DatabaseMigrationService / Client / modify_event_subscription

modify_event_subscription#

DatabaseMigrationService.Client.modify_event_subscription(**kwargs)#

Modifies an existing DMS event notification subscription.

See also: AWS API Documentation

Request Syntax

response = client.modify_event_subscription(
    SubscriptionName='string',
    SnsTopicArn='string',
    SourceType='string',
    EventCategories=[
        'string',
    ],
    Enabled=True|False
)
Parameters:

  • SubscriptionName (string) –

    [REQUIRED]

    The name of the DMS event notification subscription to be modified.

  • SnsTopicArn (string) – The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

  • SourceType (string) –

    The type of DMS resource that generates the events you want to subscribe to.

    Valid values: replication-instance | replication-task

  • EventCategories (list) –

    A list of event categories for a source type that you want to subscribe to. Use the DescribeEventCategories action to see a list of event categories.

    • (string) –

  • Enabled (boolean) – A Boolean value; set to true to activate the subscription.

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

Response Structure

  • (dict) –

    • EventSubscription (dict) –

      The modified event subscription.

      • CustomerAwsId (string) –

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

      • CustSubscriptionId (string) –

        The DMS event notification subscription Id.

      • SnsTopicArn (string) –

        The topic ARN of the DMS event notification subscription.

      • Status (string) –

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

      • SourceType (string) –

        The type of DMS resource that generates events.

        Valid values: replication-instance | replication-server | security-group | replication-task

      • SourceIdsList (list) –

        A list of source Ids for the event subscription.

        • (string) –

      • EventCategoriesList (list) –

        A lists of event categories.

        • (string) –

      • Enabled (boolean) –

        Boolean value that indicates if the event subscription is enabled.

Exceptions