Skip to content
AWS for Query.Farm

aws.kendra.describe_query_suggestions_block_list

Example SQL Queries

SELECT * FROM
aws.kendra.describe_query_suggestions_block_list
WHERE
"index_id" = 'VALUE'
AND "id" = 'VALUE';

Description

Gets information about a block list used for query suggestions for an index.

This is used to check the current settings that are applied to a block list.

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

Table Definition

Column NameColumn Data Type
id Required Input Column

The identifier of the block list.

VARCHAR
index_id Required Input Column

The identifier of the index for the block list.

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
created_at

The Unix timestamp when a block list for query suggestions was created.

TIMESTAMP_S
description

The description for the block list.

VARCHAR
error_message

The error message containing details if there are issues processing the block list.

VARCHAR
file_size_bytes

The current size of the block list text file in S3.

BIGINT
item_count

The current number of valid, non-empty words or phrases in the block list text file.

BIGINT
name

The name of the block list.

VARCHAR
role_arn

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.

The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

VARCHAR
source_s3_path

Shows the current S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

STRUCT(
    "bucket" VARCHAR,
    "key" VARCHAR
)
Show child fields
source_s3_path.bucket

The name of the S3 bucket that contains the file.

source_s3_path.key

The name of the file.

status

The current status of the block list. When the value is ACTIVE, the block list is ready for use.

VARCHAR
updated_at

The Unix timestamp when a block list for query suggestions was last updated.

TIMESTAMP_S