create_plugin¶
Operation¶
async
¶
create_plugin(input: CreatePluginInput, plugins: list[Plugin] | None = None) -> CreatePluginOutput
Creates an Amazon Q Business plugin.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreatePluginInput
|
An instance of |
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 |
|---|---|
CreatePluginOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreatePluginInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the application that will contain the plugin.
class-attribute
instance-attribute
¶
auth_configuration: PluginAuthConfiguration | None = None
Authentication configuration information for an Amazon Q Business plugin.
class-attribute
instance-attribute
¶
client_token: str | None = None
A token that you provide to identify the request to create your Amazon Q Business plugin.
class-attribute
instance-attribute
¶
custom_plugin_configuration: CustomPluginConfiguration | None = None
Contains configuration for a custom plugin.
class-attribute
instance-attribute
¶
display_name: str | None = None
A the name for your plugin.
class-attribute
instance-attribute
¶
server_url: str | None = None
The source URL used for plugin configuration.
class-attribute
instance-attribute
¶
tags: list[Tag] | None = None
A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
class-attribute
instance-attribute
¶
type: PluginType | None = None
The type of plugin you want to create.
Output¶
dataclass
¶
Dataclass for CreatePluginOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
build_status: PluginBuildStatus | None = None
The current status of a plugin. A plugin is modified asynchronously.
class-attribute
instance-attribute
¶
plugin_arn: str | None = None
The Amazon Resource Name (ARN) of a plugin.
class-attribute
instance-attribute
¶
plugin_id: str | None = None
The identifier of the plugin created.