Skip to content
AWS for Query.Farm

aws.kendra.list_faqs

Example SQL Queries

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

Description

Gets a list of FAQ lists associated with an index.

Table Definition

Column NameColumn Data Type
index_id Required Input Column

The index that contains the FAQ lists.

VARCHAR
max_results Input Column

The maximum number of FAQs to return in the response. If there are fewer results in the list, this response contains only the actual results.

BIGINT
next_token Input Column

If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of FAQs.

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
faq_summary_items

information about the FAQs associated with the specified index.

STRUCT(
    "id" VARCHAR,
    "name" VARCHAR,
    "status" VARCHAR,
    "created_at" TIMESTAMP_S,
    "updated_at" TIMESTAMP_S,
    "file_format" VARCHAR,
    "language_code" VARCHAR
)[]
Show child fields
faq_summary_items[]
Show child fields
faq_summary_items[].created_at

The Unix timestamp when the FAQ was created.

faq_summary_items[].file_format

The file type used to create the FAQ.

faq_summary_items[].id

The identifier of the FAQ.

faq_summary_items[].language_code

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

faq_summary_items[].name

The name that you assigned the FAQ when you created or updated the FAQ.

faq_summary_items[].status

The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.

faq_summary_items[].updated_at

The Unix timestamp when the FAQ was last updated.