list_subscriptions¶
Operation¶
async
¶
list_subscriptions(input: ListSubscriptionsInput, plugins: list[Plugin] | None = None) -> ListSubscriptionsOutput
Lists all subscriptions created in an Amazon Q Business application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListSubscriptionsInput
|
An instance of |
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 |
Input¶
dataclass
¶
Dataclass for ListSubscriptionsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application linked to the subscription.
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of Amazon Q Business subscriptions to return.
class-attribute
instance-attribute
¶
next_token: str | None = None
If the maxResults response was incomplete because there is more data
to retrieve, Amazon Q Business returns a pagination token in the
response. You can use this pagination token to retrieve the next set of
Amazon Q Business subscriptions.
Output¶
dataclass
¶
Dataclass for ListSubscriptionsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
next_token: str | None = None
If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of subscriptions.
class-attribute
instance-attribute
¶
subscriptions: list[Subscription] | None = None
An array of summary information on the subscriptions configured for an Amazon Q Business application.