ConnectHealth > Operations > list_subscriptions

list_subscriptions¶

Operation¶

list_subscriptions(input: ListSubscriptionsInput, plugins: list[Plugin] | None = None) -> ListSubscriptionsOutput

Lists all Subscriptions within a Domain.

Parameters:

Name	Type	Description	Default
`input`	`ListSubscriptionsInput`	An instance of `ListSubscriptionsInput`.	required
`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
`ListSubscriptionsOutput`	An instance of `ListSubscriptionsOutput`.

Dataclass for ListSubscriptionsInput structure.

domain_id: str | None = None

The unique identifier of the parent Domain.

max_results: int | None = None

Maximum number of results to return.

next_token: str | None = None

Token for pagination.

Dataclass for ListSubscriptionsOutput structure.

next_token: str | None = None

Token for the next page of results.

subscriptions: list[SubscriptionDescription]

List of Subscriptions.