list_plugin_actions¶
Operation¶
list_plugin_actions
async
¶
list_plugin_actions(input: ListPluginActionsInput, plugins: list[Plugin] | None = None) -> ListPluginActionsOutput
Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListPluginActionsInput
|
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 |
|---|---|
ListPluginActionsOutput
|
An instance of |
Input¶
ListPluginActionsInput
dataclass
¶
Dataclass for ListPluginActionsInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application the plugin is attached to.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of plugin actions to return.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = None
If the number of plugin actions returned exceeds maxResults, Amazon Q
Business returns a next token as a pagination token to retrieve the next
set of plugin actions.
plugin_id
class-attribute
instance-attribute
¶
plugin_id: str | None = None
The identifier of the Amazon Q Business plugin.
Output¶
ListPluginActionsOutput
dataclass
¶
Dataclass for ListPluginActionsOutput structure.
Attributes¶
items
class-attribute
instance-attribute
¶
items: list[ActionSummary] | None = None
An array of information on one or more plugin actions.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = None
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugin actions.