Skip to content

get_plugin

Operation

get_plugin

get_plugin(request: GetPluginInput | GetPluginInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPluginInputDict]) -> GetPluginOutput

Gets information about an existing Amazon Q Business plugin.

Parameters:

Name Type Description Default
request GetPluginInput | GetPluginInputDict | 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[GetPluginInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPluginOutput

An instance of GetPluginOutput.

get_plugin async

get_plugin(request: GetPluginInput | GetPluginInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPluginInputDict]) -> GetPluginOutput

Gets information about an existing Amazon Q Business plugin.

Parameters:

Name Type Description Default
request GetPluginInput | GetPluginInputDict | 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[GetPluginInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPluginOutput

An instance of GetPluginOutput.

Input

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

GetPluginInputDict

Bases: TypedDict

Dictionary form of GetPluginInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the application which contains the plugin.

plugin_id instance-attribute
plugin_id: Required[str]

The identifier of the plugin.

GetPluginInput dataclass

Bases: _SerdeShape

Dataclass for GetPluginInput structure.

Attributes

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

The identifier of the application which contains the plugin.

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

The identifier of the plugin.

Output

GetPluginOutput dataclass

Bases: _SerdeShape

Dataclass for GetPluginOutput structure.

Attributes

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

The identifier of the application which contains the plugin.

auth_configuration class-attribute instance-attribute
auth_configuration: PluginAuthConfiguration | None = ...

Authentication configuration information for an Amazon Q Business plugin.

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

The current status of a plugin. A plugin is modified asynchronously.

created_at class-attribute instance-attribute
created_at: datetime | None = ...

The timestamp for when the plugin was created.

custom_plugin_configuration class-attribute instance-attribute
custom_plugin_configuration: CustomPluginConfiguration | None = ...

Configuration information required to create a custom plugin.

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

The name of the plugin.

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

The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.

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

The identifier of the 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.

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

The source URL used for plugin configuration.

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

The current state of the plugin.

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

The type of the plugin.

updated_at class-attribute instance-attribute
updated_at: datetime | None = ...

The timestamp for when the plugin was last updated.