Skip to content

RDS  >  Operations  >  describe_event_subscriptions

describe_event_subscriptions

Operation

describe_event_subscriptions async

describe_event_subscriptions(request: DescribeEventSubscriptionsInput | DescribeEventSubscriptionsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeEventSubscriptionsOutput
describe_event_subscriptions(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeEventSubscriptionsInputDict]) -> DescribeEventSubscriptionsOutput

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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeEventSubscriptionsOutput

An instance of DescribeEventSubscriptionsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeEventSubscriptionsInput dataclass

Bases: _SerdeShape

Attributes
filters class-attribute instance-attribute
filters: list[Filter] | None = ...

This parameter isn't currently supported.

marker class-attribute instance-attribute
marker: str | None = ...

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

max_records class-attribute instance-attribute
max_records: int | None = ...

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

subscription_name class-attribute instance-attribute
subscription_name: str | None = ...

The name of the RDS event notification subscription you want to describe.

Dictionaries

DescribeEventSubscriptionsInputDict

Bases: TypedDict

Dictionary form of DescribeEventSubscriptionsInput.

Attributes
filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

This parameter isn't currently supported.

marker instance-attribute
marker: str | None

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

max_records instance-attribute
max_records: int | None

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

subscription_name instance-attribute
subscription_name: str | None

The name of the RDS event notification subscription you want to describe.

Output

DescribeEventSubscriptionsOutput dataclass

Bases: _SerdeShape

Data returned by the DescribeEventSubscriptions action.

Attributes

event_subscriptions_list class-attribute instance-attribute
event_subscriptions_list: list[EventSubscription] | None = ...

A list of EventSubscriptions data types.

marker class-attribute instance-attribute
marker: str | None = ...

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.