Skip to content
AWS for Query.Farm

aws.kendra.describe_experience

Example SQL Queries

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

Description

Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Table Definition

Column NameColumn Data Type
id Required Input Column

Shows the identifier of your Amazon Kendra experience.

VARCHAR
index_id Required Input Column

Shows the identifier of the index for your Amazon Kendra experience.

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
configuration

Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

STRUCT(
    "content_source_configuration" STRUCT(
        "data_source_ids" VARCHAR[],
        "faq_ids" VARCHAR[],
        "direct_put_content" BOOLEAN
    ),
    "user_identity_configuration" STRUCT(
        "identity_attribute_name" VARCHAR
    )
)
Show child fields
configuration.content_source_configuration

The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument API. This is the content you want to use for your Amazon Kendra experience.

Show child fields
configuration.content_source_configuration.data_source_ids[]
configuration.content_source_configuration.direct_put_content

TRUE to use documents you indexed directly using the BatchPutDocument API.

configuration.content_source_configuration.faq_ids[]
configuration.user_identity_configuration

The IAM Identity Center field name that contains the identifiers of your users, such as their emails.

Show child fields
configuration.user_identity_configuration.identity_attribute_name

The IAM Identity Center field name that contains the identifiers of your users, such as their emails. This is used for user context filtering and for granting access to your Amazon Kendra experience. You must set up IAM Identity Center with Amazon Kendra. You must include your users and groups in your Access Control List when you ingest documents into your index. For more information, see Getting started with an IAM Identity Center identity source.

created_at

The Unix timestamp when your Amazon Kendra experience was created.

TIMESTAMP_S
description

Shows the description for your Amazon Kendra experience.

VARCHAR
endpoints

Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

STRUCT(
    "endpoint_type" VARCHAR,
    "endpoint" VARCHAR
)[]
Show child fields
endpoints[]
Show child fields
endpoints[].endpoint

The endpoint of your Amazon Kendra experience.

endpoints[].endpoint_type

The type of endpoint for your Amazon Kendra experience. The type currently available is HOME, which is a unique and fully hosted URL to the home page of your Amazon Kendra experience.

error_message

The reason your Amazon Kendra experience could not properly process.

VARCHAR
name

Shows the name of your Amazon Kendra experience.

VARCHAR
role_arn

Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information.

VARCHAR
status

The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.

VARCHAR
updated_at

The Unix timestamp when your Amazon Kendra experience was last updated.

TIMESTAMP_S