Skip to content

GetPluginResponse

Source code in docs_src/capo_qbusiness/types/get_plugin_response.py
class GetPluginResponse(TypedDict, closed=True):
    application_id: NotRequired["capo_qbusiness.types.application_id.ApplicationId"]
    """<p>The identifier of the application which contains the plugin.</p>"""
    plugin_id: NotRequired["capo_qbusiness.types.plugin_id.PluginId"]
    """<p>The identifier of the plugin.</p>"""
    display_name: NotRequired["capo_qbusiness.types.plugin_name.PluginName"]
    """<p>The name of the plugin.</p>"""
    type: NotRequired["capo_qbusiness.types.plugin_type.PluginType"]
    """<p>The type of the plugin.</p>"""
    server_url: NotRequired["capo_qbusiness.types.url.Url"]
    """<p>The source URL used for plugin configuration.</p>"""
    auth_configuration: NotRequired[
        "capo_qbusiness.types.plugin_auth_configuration.PluginAuthConfiguration"
    ]
    custom_plugin_configuration: NotRequired[
        "capo_qbusiness.types.custom_plugin_configuration.CustomPluginConfiguration"
    ]
    """<p>Configuration information required to create a custom plugin.</p>"""
    build_status: NotRequired[
        "capo_qbusiness.types.plugin_build_status.PluginBuildStatus"
    ]
    """<p>The current status of a plugin. A plugin is modified asynchronously.</p>"""
    plugin_arn: NotRequired["capo_qbusiness.types.plugin_arn.PluginArn"]
    """<p>The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.</p>"""
    state: NotRequired["capo_qbusiness.types.plugin_state.PluginState"]
    """<p>The current state of the plugin.</p>"""
    created_at: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The timestamp for when the plugin was created.</p>"""
    updated_at: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The timestamp for when the plugin was last updated.</p>"""

application_id instance-attribute

application_id: NotRequired[ApplicationId]

The identifier of the application which contains the plugin.

auth_configuration instance-attribute

auth_configuration: NotRequired[PluginAuthConfiguration]

build_status instance-attribute

build_status: NotRequired[PluginBuildStatus]

The current status of a plugin. A plugin is modified asynchronously.

created_at instance-attribute

created_at: NotRequired[Timestamp]

The timestamp for when the plugin was created.

custom_plugin_configuration instance-attribute

custom_plugin_configuration: NotRequired[CustomPluginConfiguration]

Configuration information required to create a custom plugin.

display_name instance-attribute

display_name: NotRequired[PluginName]

The name of the plugin.

plugin_arn instance-attribute

plugin_arn: NotRequired[PluginArn]

The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.

plugin_id instance-attribute

plugin_id: NotRequired[PluginId]

The identifier of the plugin.

server_url instance-attribute

server_url: NotRequired[Url]

The source URL used for plugin configuration.

state instance-attribute

state: NotRequired[PluginState]

The current state of the plugin.

type instance-attribute

type: NotRequired[PluginType]

The type of the plugin.

updated_at instance-attribute

updated_at: NotRequired[Timestamp]

The timestamp for when the plugin was last updated.