Skip to content

list_subscriptions

Operation

list_subscriptions

list_subscriptions(request: ListSubscriptionsInput | ListSubscriptionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListSubscriptionsInputDict]) -> ListSubscriptionsOutput

Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.

This action is throttled at 30 transactions per second (TPS).

Parameters:

Name Type Description Default
request ListSubscriptionsInput | ListSubscriptionsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListSubscriptionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListSubscriptionsOutput

An instance of ListSubscriptionsOutput.

list_subscriptions async

list_subscriptions(request: ListSubscriptionsInput | ListSubscriptionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListSubscriptionsInputDict]) -> ListSubscriptionsOutput

Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.

This action is throttled at 30 transactions per second (TPS).

Parameters:

Name Type Description Default
request ListSubscriptionsInput | ListSubscriptionsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListSubscriptionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListSubscriptionsOutput

An instance of ListSubscriptionsOutput.

Input

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

ListSubscriptionsInputDict

Bases: TypedDict

Dictionary form of ListSubscriptionsInput.

Attributes

next_token instance-attribute
next_token: str | None

Token returned by the previous ListSubscriptions request.

ListSubscriptionsInput dataclass

Bases: _SerdeShape

Input for ListSubscriptions action.

Attributes

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

Token returned by the previous ListSubscriptions request.

Output

ListSubscriptionsOutput dataclass

Bases: _SerdeShape

Response for ListSubscriptions action

Attributes

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

Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.

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.

subscriptions class-attribute instance-attribute
subscriptions: list[Subscription] | None = ...

A list of subscriptions.