Skip to content
AWS for Query.Farm

aws.kendra.describe_thesaurus

Example SQL Queries

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

Description

Gets information about an Amazon Kendra thesaurus.

Table Definition

Column NameColumn Data Type
id Required Input Column

The identifier of the thesaurus.

VARCHAR
index_id Required Input Column

The identifier of the index for the thesaurus.

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 the thesaurus was created.

TIMESTAMP_S
description

The thesaurus description.

VARCHAR
error_message

When the Status field value is FAILED, the ErrorMessage field provides more information. 

VARCHAR
file_size_bytes

The size of the thesaurus file in bytes.

BIGINT
name

The thesaurus name.

VARCHAR
role_arn

An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path. 

VARCHAR
source_s3_path

Information required to find a specific file in an Amazon S3 bucket.

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 thesaurus. When the value is ACTIVE, queries are able to use the thesaurus. If the Status field value is FAILED, the ErrorMessage field provides more information.

If the status is ACTIVE_BUT_UPDATE_FAILED, it means that Amazon Kendra could not ingest the new thesaurus file. The old thesaurus file is still active. 

VARCHAR
synonym_rule_count

The number of synonym rules in the thesaurus file.

BIGINT
term_count

The number of unique terms in the thesaurus file. For example, the synonyms a,b,c and a=>d, the term count would be 4. 

BIGINT
updated_at

The Unix timestamp when the thesaurus was last updated.

TIMESTAMP_S