Skip to content
AWS for Query.Farm

aws.kendra.describe_query_suggestions_config

Example SQL Queries

SELECT * FROM
aws.kendra.describe_query_suggestions_config
WHERE
"index_id" = 'VALUE';

Description

Gets information on the settings of query suggestions for an index.

This is used to check the current settings applied to query suggestions.

DescribeQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Table Definition

Column NameColumn Data Type
index_id Required Input Column

The identifier of the index with query suggestions that you want to get information on.

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
attribute_suggestions_config

Configuration information for the document fields/attributes that you want to base query suggestions on.

STRUCT(
    "suggestable_config_list" STRUCT(
        "attribute_name" VARCHAR,
        "suggestable" BOOLEAN
    )[],
    "attribute_suggestions_mode" VARCHAR
)
Show child fields
attribute_suggestions_config.attribute_suggestions_mode

The mode is set to either ACTIVE or INACTIVE. If the Mode for query history is set to ENABLED when calling UpdateQuerySuggestionsConfig and AttributeSuggestionsMode to use fields/attributes is set to ACTIVE, and you haven't set your SuggestionTypes preference to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the query history.

attribute_suggestions_config.suggestable_config_list[]
Show child fields
attribute_suggestions_config.suggestable_config_list[].attribute_name

The name of the document field/attribute.

attribute_suggestions_config.suggestable_config_list[].suggestable

TRUE means the document field/attribute is suggestible, so the contents within the field can be used for query suggestions.

include_queries_without_user_information

TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.

BOOLEAN
last_clear_time

The Unix timestamp when query suggestions for an index was last cleared.

After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions. 

TIMESTAMP_S
last_suggestions_build_time

The Unix timestamp when query suggestions for an index was last updated.

Amazon Kendra automatically updates suggestions every 24 hours, after you change a setting or after you apply a block list.

TIMESTAMP_S
minimum_number_of_querying_users

The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

BIGINT
minimum_query_count

The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.

BIGINT
mode

Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.

VARCHAR
query_log_look_back_window_in_days

How recent your queries are in your query log time window (in days).

BIGINT
status

Whether the status of query suggestions settings is currently ACTIVE or UPDATING.

Active means the current settings apply and Updating means your changed settings are in the process of applying.

VARCHAR
total_suggestions_count

The current total count of query suggestions for an index.

This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.

If the count is much lower than you expected, it could be because Amazon Kendra needs more queries in the query history to learn from or your current query suggestions settings are too strict.

BIGINT