Skip to content

Qbusiness  >  Operations  >  update_plugin

update_plugin

Operation

update_plugin async

update_plugin(input: UpdatePluginInput, plugins: list[Plugin] | None = None) -> UpdatePluginOutput

Updates an Amazon Q Business plugin.

Parameters:

Name Type Description Default
input UpdatePluginInput

An instance of UpdatePluginInput.

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
UpdatePluginOutput

An instance of UpdatePluginOutput.

Input

UpdatePluginInput dataclass

Dataclass for UpdatePluginInput structure.

Attributes

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

The identifier of the application the plugin is attached to.

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

The authentication configuration the plugin is using.

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

The configuration for a custom plugin.

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

The name of 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 status of the plugin.

Output

UpdatePluginOutput dataclass

Dataclass for UpdatePluginOutput structure.