list_applications¶
Operation¶
async
¶
list_applications(input: ListApplicationsInput, plugins: list[Plugin] | None = None) -> ListApplicationsOutput
Lists Amazon Q Business applications.
Note
Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListApplicationsInput
|
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 |
|---|---|
ListApplicationsOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListApplicationsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of Amazon Q Business applications 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 applications.
Output¶
dataclass
¶
Dataclass for ListApplicationsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
applications: list[Application] | None = None
An array of summary information on the configuration of one or more Amazon Q Business applications.
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 applications.