Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465566486.4 KB

Gets information about an FAQ list.

post/#X-Amz-Target=AWSKendraFrontendService.DescribeFaq

Headers

X-Amz-Target'AWSKendraFrontendService.DescribeFaq' required

Request body

Idstring required

The identifier of the FAQ you want to get information on.

IndexIdstring required

The identifier of the index for the FAQ.

Response

Success

Idstring

The identifier of the FAQ.

IndexIdstring

The identifier of the index for the FAQ.

Namestring

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

Descriptionstring

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

CreatedAtstring date-time

The Unix timestamp when the FAQ was created.

UpdatedAtstring date-time

The Unix timestamp when the FAQ was last updated.

Status'CREATING' | 'UPDATING' | 'ACTIVE' | 'DELETING' | 'FAILED'

The status of the FAQ. It is ready to use when the status is <code>ACTIVE</code>.

RoleArnstring

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

ErrorMessagestring

If the <code>Status</code> field is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason why the FAQ failed.

FileFormat'CSV' | 'CSV_WITH_HEADER' | 'JSON'

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

LanguageCodestring

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 <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding documents in languages other than English</a>.