DescribeEventSubscriptions
Lists all the event subscriptions for a customer account. The description of a
subscription includes SubscriptionName, SNSTopicARN,
CustomerID, SourceType, SourceID,
CreationTime, and Status.
If you specify SubscriptionName, this action lists the description for that
subscription.
Request Syntax
{
"Filters": [
{
"Name": "string",
"Values": [ "string" ]
}
],
"Marker": "string",
"MaxRecords": number,
"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.
- Filters
-
Filters applied to event subscriptions.
Valid filter names: event-subscription-arn | event-subscription-id
Type: Array of Filter objects
Required: No
- Marker
-
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.Type: String
Required: No
- MaxRecords
-
The maximum number of records to include in the response. If more records exist than the specified
MaxRecordsvalue, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
Type: Integer
Required: No
- SubscriptionName
-
The name of the AWS DMS event subscription to be described.
Type: String
Required: No
Response Syntax
{
"EventSubscriptionsList": [
{
"CustomerAwsId": "string",
"CustSubscriptionId": "string",
"Enabled": boolean,
"EventCategoriesList": [ "string" ],
"SnsTopicArn": "string",
"SourceIdsList": [ "string" ],
"SourceType": "string",
"Status": "string",
"SubscriptionCreationTime": "string"
}
],
"Marker": "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.
- EventSubscriptionsList
-
A list of event subscriptions.
Type: Array of EventSubscription objects
- Marker
-
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFoundFault
-
The resource could not be found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
