Connecthealth  >  Operations  >  list_subscriptions

list_subscriptions

Operation

list_subscriptions async

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.

Input

ListSubscriptionsInput dataclass

Dataclass for ListSubscriptionsInput structure.

Attributes

domain_id class-attribute instance-attribute

domain_id: str | None = None

The unique identifier of the parent Domain.

max_results class-attribute instance-attribute

max_results: int | None = None

Maximum number of results to return.

next_token class-attribute instance-attribute

next_token: str | None = None

Token for pagination.

Output

ListSubscriptionsOutput dataclass

Dataclass for ListSubscriptionsOutput structure.

Attributes

next_token class-attribute instance-attribute

next_token: str | None = None

Token for the next page of results.

subscriptions instance-attribute

subscriptions: list[SubscriptionDescription]

List of Subscriptions.