create_plugin¶
Operation¶
create_plugin
¶
create_plugin(request: CreatePluginInput | CreatePluginInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreatePluginInputDict]) -> CreatePluginOutput
Creates an Amazon Q Business plugin.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreatePluginInput | CreatePluginInputDict | 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[CreatePluginInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreatePluginOutput
|
An instance of |
create_plugin
async
¶
create_plugin(request: CreatePluginInput | CreatePluginInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreatePluginInputDict]) -> CreatePluginOutput
Creates an Amazon Q Business plugin.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreatePluginInput | CreatePluginInputDict | 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[CreatePluginInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreatePluginOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
CreatePluginInputDict
¶
Bases: TypedDict
Dictionary form of CreatePluginInput.
Attributes¶
application_id
instance-attribute
¶
The identifier of the application that will contain the plugin.
auth_configuration
instance-attribute
¶
auth_configuration: Required[PluginAuthConfiguration | PluginAuthConfigurationDict]
Authentication configuration information for an Amazon Q Business plugin.
client_token
instance-attribute
¶
client_token: str | None
A token that you provide to identify the request to create your Amazon Q Business plugin.
This field is autopopulated if not provided.
custom_plugin_configuration
instance-attribute
¶
custom_plugin_configuration: CustomPluginConfiguration | CustomPluginConfigurationDict | None
Contains configuration for a custom plugin.
server_url
instance-attribute
¶
server_url: str | None
The source URL used for plugin configuration.
tags
instance-attribute
¶
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: _ . : / = + - @.
CreatePluginInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreatePluginInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = ...
The identifier of the application that will contain the plugin.
auth_configuration
class-attribute
instance-attribute
¶
auth_configuration: PluginAuthConfiguration | None = ...
Authentication configuration information for an Amazon Q Business plugin.
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A token that you provide to identify the request to create your Amazon Q Business plugin.
This field is autopopulated if not provided.
custom_plugin_configuration
class-attribute
instance-attribute
¶
custom_plugin_configuration: CustomPluginConfiguration | None = ...
Contains configuration for a custom plugin.
display_name
class-attribute
instance-attribute
¶
display_name: str | None = ...
A the name for your plugin.
server_url
class-attribute
instance-attribute
¶
server_url: str | None = ...
The source URL used for plugin configuration.
tags
class-attribute
instance-attribute
¶
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: _ . : / = + - @.
Output¶
CreatePluginOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreatePluginOutput structure.
Attributes¶
build_status
class-attribute
instance-attribute
¶
build_status: str | None = ...
The current status of a plugin. A plugin is modified asynchronously.
plugin_arn
class-attribute
instance-attribute
¶
plugin_arn: str | None = ...
The Amazon Resource Name (ARN) of a plugin.
plugin_id
class-attribute
instance-attribute
¶
plugin_id: str | None = ...
The identifier of the plugin created.
response_metadata
class-attribute
instance-attribute
¶
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.