RDS / Paginator / DescribeEventSubscriptions
DescribeEventSubscriptions#
- class RDS.Paginator.DescribeEventSubscriptions#
paginator = client.get_paginator('describe_event_subscriptions')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
RDS.Client.describe_event_subscriptions()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( SubscriptionName='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
SubscriptionName (string) – The name of the RDS event notification subscription you want to describe.
Filters (list) –
This parameter isn’t currently supported.
(dict) –
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribePendingMaintenanceActions
Name (string) – [REQUIRED]
The name of the filter. Filter names are case-sensitive.
Values (list) – [REQUIRED]
One or more filter values. Filter values are case-sensitive.
(string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'EventSubscriptionsList': [ { 'CustomerAwsId': 'string', 'CustSubscriptionId': 'string', 'SnsTopicArn': 'string', 'Status': 'string', 'SubscriptionCreationTime': 'string', 'SourceType': 'string', 'SourceIdsList': [ 'string', ], 'EventCategoriesList': [ 'string', ], 'Enabled': True|False, 'EventSubscriptionArn': 'string' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
Data returned by the DescribeEventSubscriptions action.
EventSubscriptionsList (list) –
A list of EventSubscriptions data types.
(dict) –
Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.CustomerAwsId (string) –
The Amazon Web Services customer account associated with the RDS event notification subscription.
CustSubscriptionId (string) –
The RDS event notification subscription Id.
SnsTopicArn (string) –
The topic ARN of the RDS event notification subscription.
Status (string) –
The status of the RDS 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 RDS 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 RDS event notification subscription was created.
SourceType (string) –
The source type for the RDS event notification subscription.
SourceIdsList (list) –
A list of source IDs for the RDS event notification subscription.
(string) –
EventCategoriesList (list) –
A list of event categories for the RDS event notification subscription.
(string) –
Enabled (boolean) –
A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
EventSubscriptionArn (string) –
The Amazon Resource Name (ARN) for the event subscription.
NextToken (string) –
A token to resume pagination.