Qbusiness  >  Operations  >  get_plugin

get_plugin

Operation

get_plugin async

get_plugin(input: GetPluginInput, plugins: list[Plugin] | None = None) -> GetPluginOutput

Gets information about an existing Amazon Q Business plugin.

Parameters:

Name	Type	Description	Default
input	GetPluginInput	An instance of GetPluginInput.	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
GetPluginOutput	An instance of GetPluginOutput.

Input

GetPluginInput dataclass

Dataclass for GetPluginInput structure.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

The identifier of the application which contains the plugin.

plugin_id class-attribute instance-attribute

plugin_id: str | None = None

The identifier of the plugin.

Output

GetPluginOutput dataclass

Dataclass for GetPluginOutput structure.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

The identifier of the application which contains the plugin.

auth_configuration class-attribute instance-attribute

auth_configuration: PluginAuthConfiguration | None = None

Authentication configuration information for an Amazon Q Business plugin.

build_status class-attribute instance-attribute

build_status: PluginBuildStatus | None = None

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

created_at class-attribute instance-attribute

created_at: datetime | None = None

The timestamp for when the plugin was created.

custom_plugin_configuration class-attribute instance-attribute

custom_plugin_configuration: CustomPluginConfiguration | None = None

Configuration information required to create a custom plugin.

display_name class-attribute instance-attribute

display_name: str | None = None

The name of the plugin.

plugin_arn class-attribute instance-attribute

plugin_arn: str | None = 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 = None

The identifier of the plugin.

server_url class-attribute instance-attribute

server_url: str | None = None

The source URL used for plugin configuration.

state class-attribute instance-attribute

state: PluginState | None = None

The current state of the plugin.

type class-attribute instance-attribute

type: PluginType | None = None

The type of the plugin.

updated_at class-attribute instance-attribute

updated_at: datetime | None = None

The timestamp for when the plugin was last updated.