ModifyEventSubscription
Modifies an existing AWS DMS event notification subscription.
Request Syntax
{
"Enabled": boolean
,
"EventCategories": [ "string
" ],
"SnsTopicArn": "string
",
"SourceType": "string
",
"SubscriptionName": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Enabled
-
A Boolean value; set to true to activate the subscription.
Type: Boolean
Required: No
- EventCategories
-
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.Type: Array of strings
Required: No
- SnsTopicArn
-
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.
Type: String
Required: No
- SourceType
-
The type of AWS DMS resource that generates the events you want to subscribe to.
Valid values: replication-instance | replication-task
Type: String
Required: No
- SubscriptionName
-
The name of the AWS DMS event notification subscription to be modified.
Type: String
Required: Yes
Response Syntax
{
"EventSubscription": {
"CustomerAwsId": "string",
"CustSubscriptionId": "string",
"Enabled": boolean,
"EventCategoriesList": [ "string" ],
"SnsTopicArn": "string",
"SourceIdsList": [ "string" ],
"SourceType": "string",
"Status": "string",
"SubscriptionCreationTime": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- EventSubscription
-
The modified event subscription.
Type: EventSubscription object
Errors
For information about the errors that are common to all actions, see Common Errors.
- KMSAccessDeniedFault
-
The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to.
HTTP Status Code: 400
- KMSDisabledFault
-
The specified KMS key isn't enabled.
HTTP Status Code: 400
- KMSInvalidStateFault
-
The state of the specified AWS KMS resource isn't valid for this request.
HTTP Status Code: 400
- KMSNotFoundFault
-
The specified AWS KMS entity or resource can't be found.
HTTP Status Code: 400
- KMSThrottlingFault
-
This request triggered AWS KMS request throttling.
HTTP Status Code: 400
- ResourceNotFoundFault
-
The resource could not be found.
HTTP Status Code: 400
- ResourceQuotaExceededFault
-
The quota for this resource quota has been exceeded.
HTTP Status Code: 400
- SNSInvalidTopicFault
-
The SNS topic is invalid.
HTTP Status Code: 400
- SNSNoAuthorizationFault
-
You are not authorized for the SNS subscription.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: