Skip to content

list_plugin_actions

Operation

list_plugin_actions

list_plugin_actions(request: ListPluginActionsInput | ListPluginActionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPluginActionsInputDict]) -> ListPluginActionsOutput

Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.

Parameters:

Name Type Description Default
request ListPluginActionsInput | ListPluginActionsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListPluginActionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPluginActionsOutput

An instance of ListPluginActionsOutput.

list_plugin_actions async

list_plugin_actions(request: ListPluginActionsInput | ListPluginActionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPluginActionsInputDict]) -> ListPluginActionsOutput

Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.

Parameters:

Name Type Description Default
request ListPluginActionsInput | ListPluginActionsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListPluginActionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPluginActionsOutput

An instance of ListPluginActionsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListPluginActionsInputDict

Bases: TypedDict

Dictionary form of ListPluginActionsInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the Amazon Q Business application the plugin is attached to.

max_results instance-attribute
max_results: int | None

The maximum number of plugin actions to return.

next_token instance-attribute
next_token: str | 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 instance-attribute
plugin_id: Required[str]

The identifier of the Amazon Q Business plugin.

ListPluginActionsInput dataclass

Bases: _SerdeShape

Dataclass for ListPluginActionsInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

The identifier of the Amazon Q Business application the plugin is attached to.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of plugin actions to return.

next_token class-attribute instance-attribute
next_token: str | 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 = ...

The identifier of the Amazon Q Business plugin.

Output

ListPluginActionsOutput dataclass

Bases: _SerdeShape

Dataclass for ListPluginActionsOutput structure.

Attributes

items class-attribute instance-attribute
items: list[ActionSummary] | None = ...

An array of information on one or more plugin actions.

next_token class-attribute instance-attribute
next_token: str | 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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.