Skip to content
AWS for Query.Farm

aws.qconnect.search_quick_responses

Example SQL Queries

SELECT * FROM
aws.qconnect.search_quick_responses
WHERE
"knowledge_base_id" = 'VALUE'
AND "search_expression" = 'VALUE';

Description

Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.

Table Definition

Column NameColumn Data Type
knowledge_base_id Required Input Column

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

VARCHAR
search_expression Required Input Column

The search expression for querying the quick response.

STRUCT(
    "filters" STRUCT(
        "include_no_existence" BOOLEAN,
        "name" VARCHAR,
        "operator" VARCHAR,
        "values" VARCHAR[]
    )[],
    "order_on_field" STRUCT(
        "name" VARCHAR,
        "order" VARCHAR
    ),
    "queries" STRUCT(
        "allow_fuzziness" BOOLEAN,
        "name" VARCHAR,
        "operator" VARCHAR,
        "priority" VARCHAR,
        "values" VARCHAR[]
    )[]
)
Show child fields
search_expression.filters[]
Show child fields
search_expression.filters[].include_no_existence

Whether to treat null value as a match for the attribute field.

search_expression.filters[].name

The name of the attribute field to filter the quick responses by.

search_expression.filters[].operator

The operator to use for filtering.

search_expression.filters[].values[]
search_expression.order_on_field

The quick response attribute fields on which the query results are ordered.

Show child fields
search_expression.order_on_field.name

The name of the attribute to order the quick response query results by.

search_expression.order_on_field.order

The order at which the quick responses are sorted by.

search_expression.queries[]
Show child fields
search_expression.queries[].allow_fuzziness

Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.

search_expression.queries[].name

The name of the attribute to query the quick responses by.

search_expression.queries[].operator

The operator to use for matching attribute field values in the query.

search_expression.queries[].priority

The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.

search_expression.queries[].values[]
attributes Input Column

The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

MAP(VARCHAR, 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.

attributes_interpolated

The user defined contact attributes that are resolved when the search result is returned.

VARCHAR[]
Show child fields
attributes_interpolated[]
attributes_not_interpolated

The user defined contact attributes that are not resolved when the search result is returned.

VARCHAR[]
Show child fields
attributes_not_interpolated[]
channels

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

VARCHAR[]
Show child fields
channels[]
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.

VARCHAR
contents

The contents of the quick response.

STRUCT(
    "markdown" STRUCT(
        "content" VARCHAR
    ),
    "plain_text" STRUCT(
        "content" VARCHAR
    )
)
Show child fields
contents.markdown

The container quick response content.

Show child fields
contents.markdown.content

The content of the quick response.

contents.plain_text

The container quick response content.

Show child fields
contents.plain_text.content

The content of the quick response.

created_time

The timestamp when the quick response was created.

TIMESTAMP_S
description

The description of the quick response.

VARCHAR
grouping_configuration

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

STRUCT(
    "criteria" VARCHAR,
    "values" VARCHAR[]
)
Show child fields
grouping_configuration.criteria

The criteria used for grouping Amazon Q in Connect users.

The following is the list of supported criteria values.

grouping_configuration.values[]
is_active

Whether the quick response is active.

BOOLEAN
knowledge_base_arn

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

VARCHAR
language

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

VARCHAR
last_modified_by

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

VARCHAR
last_modified_time

The timestamp when the quick response search result data was last modified.

TIMESTAMP_S
name

The name of the quick response.

VARCHAR
quick_response_arn

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

VARCHAR
quick_response_id

The identifier of the quick response.

VARCHAR
shortcut_key

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

VARCHAR
status

The resource status of the quick response.

VARCHAR
tags

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

MAP(VARCHAR, VARCHAR)