Skip to content

list_subscriptions

Operation

list_subscriptions

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

Lists all Subscriptions within a Domain.

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

Lists all Subscriptions within a Domain.

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

domain_id instance-attribute
domain_id: Required[str]

The unique identifier of the parent Domain.

max_results instance-attribute
max_results: int | None

Maximum number of results to return.

next_token instance-attribute
next_token: str | None

Token for pagination.

ListSubscriptionsInput dataclass

Bases: _SerdeShape

Dataclass for ListSubscriptionsInput structure.

Attributes

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

The unique identifier of the parent Domain.

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

Maximum number of results to return.

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

Token for pagination.

Output

ListSubscriptionsOutput dataclass

Bases: _SerdeShape

Dataclass for ListSubscriptionsOutput structure.

Attributes

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

Token for the next page of results.

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 instance-attribute
subscriptions: list[SubscriptionDescription]

List of Subscriptions.