Skip to content
AWS for Query.Farm

aws.kendra.describe_faq

Example SQL Queries

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

Description

Gets information about an FAQ list.

Table Definition

Column NameColumn Data Type
id Required Input Column

The identifier of the FAQ.

VARCHAR
index_id Required Input Column

The identifier of the index for the FAQ.

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 FAQ was created.

TIMESTAMP_S
description

The description of the FAQ that you provided when it was created.

VARCHAR
error_message

If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.

VARCHAR
file_format

The file format used by the input files for the FAQ.

VARCHAR
language_code

The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

VARCHAR
name

The name that you gave the FAQ when it was created.

VARCHAR
role_arn

The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

VARCHAR
s3_path

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

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

The name of the S3 bucket that contains the file.

s3_path.key

The name of the file.

status

The status of the FAQ. It is ready to use when the status is ACTIVE.

VARCHAR
updated_at

The Unix timestamp when the FAQ was last updated.

TIMESTAMP_S