Skip to content

CreatePluginRequest

Source code in docs_src/capo_qbusiness/types/create_plugin_request.py
class CreatePluginRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The identifier of the application that will contain the plugin.</p>"""
    display_name: "capo_qbusiness.types.plugin_name.PluginName"
    """<p>A the name for your plugin.</p>"""
    type: "capo_qbusiness.types.plugin_type.PluginType"
    """<p>The type of plugin you want to create.</p>"""
    auth_configuration: (
        "capo_qbusiness.types.plugin_auth_configuration.PluginAuthConfiguration"
    )
    server_url: NotRequired["capo_qbusiness.types.url.Url"]
    """<p>The source URL used for plugin configuration.</p>"""
    custom_plugin_configuration: NotRequired[
        "capo_qbusiness.types.custom_plugin_configuration.CustomPluginConfiguration"
    ]
    """<p>Contains configuration for a custom plugin.</p>"""
    tags: NotRequired["capo_qbusiness.types.tags.Tags"]
    """<p>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: _ . : / = + - @.</p>"""
    client_token: NotRequired["capo_qbusiness.types.client_token.ClientToken"]
    """<p>A token that you provide to identify the request to create your Amazon Q Business plugin.</p>"""

application_id instance-attribute

application_id: ApplicationId

The identifier of the application that will contain the plugin.

auth_configuration instance-attribute

auth_configuration: PluginAuthConfiguration

client_token instance-attribute

client_token: NotRequired[ClientToken]

A token that you provide to identify the request to create your Amazon Q Business plugin.

custom_plugin_configuration instance-attribute

custom_plugin_configuration: NotRequired[CustomPluginConfiguration]

Contains configuration for a custom plugin.

display_name instance-attribute

display_name: PluginName

A the name for your plugin.

server_url instance-attribute

server_url: NotRequired[Url]

The source URL used for plugin configuration.

tags instance-attribute

tags: NotRequired[Tags]

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: _ . : / = + - @.

type instance-attribute

type: PluginType

The type of plugin you want to create.