list_plugins¶
Operation¶
list_plugins
async
¶
list_plugins(input: ListPluginsInput, plugins: list[Plugin] | None = None) -> ListPluginsOutput
Lists configured Amazon Q Business plugins.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListPluginsInput
|
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 |
|---|---|
ListPluginsOutput
|
An instance of |
Input¶
ListPluginsInput
dataclass
¶
Dataclass for ListPluginsInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the application the plugin is attached to.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of documents to return.
next_token
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
plugins.
Output¶
ListPluginsOutput
dataclass
¶
Dataclass for ListPluginsOutput structure.
Attributes¶
next_token
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
plugins.