Skip to content

update_plugin

Operation

update_plugin

update_plugin(request: UpdatePluginInput | UpdatePluginInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdatePluginInputDict]) -> UpdatePluginOutput

Updates an Amazon Q Business plugin.

Parameters:

Name Type Description Default
request UpdatePluginInput | UpdatePluginInputDict | 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[UpdatePluginInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdatePluginOutput

An instance of UpdatePluginOutput.

update_plugin async

update_plugin(request: UpdatePluginInput | UpdatePluginInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdatePluginInputDict]) -> UpdatePluginOutput

Updates an Amazon Q Business plugin.

Parameters:

Name Type Description Default
request UpdatePluginInput | UpdatePluginInputDict | 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[UpdatePluginInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdatePluginOutput

An instance of UpdatePluginOutput.

Input

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

UpdatePluginInputDict

Bases: TypedDict

Dictionary form of UpdatePluginInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the application the plugin is attached to.

auth_configuration instance-attribute

The authentication configuration the plugin is using.

custom_plugin_configuration instance-attribute
custom_plugin_configuration: CustomPluginConfiguration | CustomPluginConfigurationDict | None

The configuration for a custom plugin.

display_name instance-attribute
display_name: str | None

The name of the plugin.

plugin_id instance-attribute
plugin_id: Required[str]

The identifier of the plugin.

server_url instance-attribute
server_url: str | None

The source URL used for plugin configuration.

state instance-attribute
state: str | None

The status of the plugin.

UpdatePluginInput dataclass

Bases: _SerdeShape

Dataclass for UpdatePluginInput structure.

Attributes

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

The identifier of the application the plugin is attached to.

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

The authentication configuration the plugin is using.

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

The configuration for a custom plugin.

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

The name of the plugin.

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

The identifier of the plugin.

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

Output

UpdatePluginOutput dataclass

Bases: _SerdeShape

Dataclass for UpdatePluginOutput structure.

Attributes

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.