DescribeEventSubscriptions
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Filters.Filter.N
-
This parameter is not currently supported.
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 (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 Amazon DocumentDB event notification subscription that you want to describe.
Type: String
Required: No
Response Elements
The following elements are returned by the service.
- EventSubscriptionsList.EventSubscription.N
-
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.
- SubscriptionNotFound
-
The subscription name does not exist.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: