Skip to content
AWS for Query.Farm

aws.qconnect.get_assistant

Example SQL Queries

SELECT * FROM
aws.qconnect.get_assistant
WHERE
"assistant_id" = 'VALUE';

Description

Retrieves information about an assistant.

Table Definition

Column NameColumn Data Type
assistant_id Required Input Column

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

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.

assistant

Information about the assistant.

STRUCT(
    "assistant_arn" VARCHAR,
    "assistant_id" VARCHAR,
    "capability_configuration" STRUCT(
        "type" VARCHAR
    ),
    "description" VARCHAR,
    "integration_configuration" STRUCT(
        "topic_integration_arn" VARCHAR
    ),
    "name" VARCHAR,
    "server_side_encryption_configuration" STRUCT(
        "kms_key_id" VARCHAR
    ),
    "status" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "type" VARCHAR
)
Show child fields
assistant.assistant_arn

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

assistant.assistant_id

The identifier of the Amazon Q in Connect assistant.

assistant.capability_configuration

The configuration information for the Amazon Q in Connect assistant capability.

Show child fields
assistant.capability_configuration.type

The type of Amazon Q in Connect assistant capability.

assistant.description

The description.

assistant.integration_configuration

The configuration information for the Amazon Q in Connect assistant integration.

Show child fields
assistant.integration_configuration.topic_integration_arn

The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.

assistant.name

The name.

assistant.server_side_encryption_configuration

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

Show child fields
assistant.server_side_encryption_configuration.kms_key_id

The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).

assistant.status

The status of the assistant.

assistant.tags

The tags used to organize, track, or control access for this resource.

assistant.type

The type of assistant.