Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . dms ]



Modifies an existing DMS event notification subscription.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--subscription-name <value>
[--sns-topic-arn <value>]
[--source-type <value>]
[--event-categories <value>]
[--enabled | --no-enabled]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--subscription-name (string)

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

--sns-topic-arn (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.

--source-type (string)

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

Valid values: replication-instance | replication-task

--event-categories (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" "string" ...

--enabled | --no-enabled (boolean)

A Boolean value; set to true to activate the subscription.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.



To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To modify an event subscription

The following modify-event-subscription example changes the source type of an event subscription.

aws dms modify-event-subscription \
    --subscription-name "my-dms-events" \
    --source-type replication-task


    "EventSubscription": {
        "CustomerAwsId": "123456789012",
        "CustSubscriptionId": "my-dms-events",
        "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:my-sns-topic",
        "Status": "modifying",
        "SubscriptionCreationTime": "2020-05-29 17:04:40.262",
        "SourceType": "replication-task",
        "Enabled": true

For more information, see Working with Events and Notifications in the AWS Database Migration Service User Guide.


EventSubscription -> (structure)

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.


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.


EventCategoriesList -> (list)

A lists of event categories.


Enabled -> (boolean)

Boolean value that indicates if the event subscription is enabled.