Skip to content

list_plugins

Operation

list_plugins

list_plugins(request: ListPluginsInput | ListPluginsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPluginsInputDict]) -> ListPluginsOutput

Lists configured Amazon Q Business plugins.

Parameters:

Name Type Description Default
request ListPluginsInput | ListPluginsInputDict | 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[ListPluginsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPluginsOutput

An instance of ListPluginsOutput.

list_plugins async

list_plugins(request: ListPluginsInput | ListPluginsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPluginsInputDict]) -> ListPluginsOutput

Lists configured Amazon Q Business plugins.

Parameters:

Name Type Description Default
request ListPluginsInput | ListPluginsInputDict | 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[ListPluginsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListPluginsOutput

An instance of ListPluginsOutput.

Input

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

ListPluginsInputDict

Bases: TypedDict

Dictionary form of ListPluginsInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the application the plugin is attached to.

max_results instance-attribute
max_results: int | None

The maximum number of documents to return.

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

ListPluginsInput dataclass

Bases: _SerdeShape

Dataclass for ListPluginsInput structure.

Attributes

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

The identifier of the application the plugin is attached to.

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

The maximum number of documents to return.

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

Bases: _SerdeShape

Dataclass for ListPluginsOutput structure.

Attributes

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

plugins class-attribute instance-attribute
plugins: list[Plugin] | None = ...

Information about a configured plugin.

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.