Skip to content
AWS for Query.Farm

aws.qbusiness.get_plugin

Example SQL Queries

SELECT * FROM
aws.qbusiness.get_plugin
WHERE
"application_id" = 'VALUE'
AND "plugin_id" = 'VALUE';

Description

Gets information about an existing Amazon Q Business plugin.

Table Definition

Column NameColumn Data Type
application_id Required Input Column

The identifier of the application which contains the plugin.

VARCHAR
plugin_id Required Input Column

The identifier of the plugin.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
auth_configuration

Authentication configuration information for an Amazon Q Business plugin.

STRUCT(
    "basic_auth_configuration" STRUCT(
        "secret_arn" VARCHAR,
        "role_arn" VARCHAR
    ),
    "o_auth2_client_credential_configuration" STRUCT(
        "secret_arn" VARCHAR,
        "role_arn" VARCHAR
    ),
    "no_auth_configuration" BOOLEAN
)
Show child fields
auth_configuration.basic_auth_configuration

Information about the basic authentication credentials used to configure a plugin.

Show child fields
auth_configuration.basic_auth_configuration.role_arn

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

auth_configuration.basic_auth_configuration.secret_arn

The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..

auth_configuration.no_auth_configuration

Information about invoking a custom plugin without any authentication.

auth_configuration.o_auth2_client_credential_configuration

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

Show child fields
auth_configuration.o_auth2_client_credential_configuration.role_arn

The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.

auth_configuration.o_auth2_client_credential_configuration.secret_arn

The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

build_status

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

VARCHAR
created_at

The timestamp for when the plugin was created.

TIMESTAMP_S
custom_plugin_configuration

Configuration information required to create a custom plugin.

STRUCT(
    "description" VARCHAR,
    "api_schema_type" VARCHAR,
    "api_schema" STRUCT(
        "payload" VARCHAR,
        "s3" STRUCT(
            "bucket" VARCHAR,
            "key" VARCHAR
        )
    )
)
Show child fields
custom_plugin_configuration.api_schema

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.

Show child fields
custom_plugin_configuration.api_schema.payload

The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.

custom_plugin_configuration.api_schema.s3

Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.

Show child fields
custom_plugin_configuration.api_schema.s3.bucket

The name of the S3 bucket that contains the file.

custom_plugin_configuration.api_schema.s3.key

The name of the file.

custom_plugin_configuration.api_schema_type

The type of OpenAPI schema to use.

custom_plugin_configuration.description

A description for your custom plugin configuration.

display_name

The name of the plugin.

VARCHAR
plugin_arn

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

VARCHAR
server_url

The source URL used for plugin configuration.

VARCHAR
state

The current state of the plugin.

VARCHAR
type

The type of the plugin.

VARCHAR
updated_at

The timestamp for when the plugin was last updated.

TIMESTAMP_S