Skip to content
AWS for Query.Farm

aws.qconnect.get_quick_response

Example SQL Queries

SELECT * FROM
aws.qconnect.get_quick_response
WHERE
"knowledge_base_id" = 'VALUE'
AND "quick_response_id" = 'VALUE';

Description

Retrieves the quick response.

Table Definition

Column NameColumn Data Type
knowledge_base_id Required Input Column

The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.

VARCHAR
quick_response_id Required Input Column

The identifier of the quick response.

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.

quick_response

The quick response.

STRUCT(
    "channels" VARCHAR[],
    "content_type" VARCHAR,
    "contents" STRUCT(
        "markdown" STRUCT(
            "content" VARCHAR
        ),
        "plain_text" STRUCT(
            "content" VARCHAR
        )
    ),
    "created_time" TIMESTAMP_S,
    "description" VARCHAR,
    "grouping_configuration" STRUCT(
        "criteria" VARCHAR,
        "values" VARCHAR[]
    ),
    "is_active" BOOLEAN,
    "knowledge_base_arn" VARCHAR,
    "knowledge_base_id" VARCHAR,
    "language" VARCHAR,
    "last_modified_by" VARCHAR,
    "last_modified_time" TIMESTAMP_S,
    "name" VARCHAR,
    "quick_response_arn" VARCHAR,
    "quick_response_id" VARCHAR,
    "shortcut_key" VARCHAR,
    "status" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR)
)
Show child fields
quick_response.channels[]
quick_response.content_type

The media type of the quick response content.

  • Use application/x.quickresponse;format=plain for quick response written in plain text.

  • Use application/x.quickresponse;format=markdown for quick response written in richtext.

quick_response.contents

The contents of the quick response.

Show child fields
quick_response.contents.markdown

The container quick response content.

Show child fields
quick_response.contents.markdown.content

The content of the quick response.

quick_response.contents.plain_text

The container quick response content.

Show child fields
quick_response.contents.plain_text.content

The content of the quick response.

quick_response.created_time

The timestamp when the quick response was created.

quick_response.description

The description of the quick response.

quick_response.grouping_configuration

The configuration information of the user groups that the quick response is accessible to.

Show child fields
quick_response.grouping_configuration.criteria

The criteria used for grouping Amazon Q in Connect users.

The following is the list of supported criteria values.

quick_response.grouping_configuration.values[]
quick_response.is_active

Whether the quick response is active.

quick_response.knowledge_base_arn

The Amazon Resource Name (ARN) of the knowledge base.

quick_response.knowledge_base_id

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

quick_response.language

The language code value for the language in which the quick response is written.

quick_response.last_modified_by

The Amazon Resource Name (ARN) of the user who last updated the quick response data.

quick_response.last_modified_time

The timestamp when the quick response data was last modified.

quick_response.name

The name of the quick response.

quick_response.quick_response_arn

The Amazon Resource Name (ARN) of the quick response.

quick_response.quick_response_id

The identifier of the quick response.

quick_response.shortcut_key

The shortcut key of the quick response. The value should be unique across the knowledge base.

quick_response.status

The status of the quick response data.

quick_response.tags

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