Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465566486.4 KB

Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.

Adding FAQs to an index is an asynchronous operation.

For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.

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

Headers

X-Amz-Target'AWSKendraFrontendService.CreateFaq' required

Request body

IndexIdstring required

The identifier of the index for the FAQ.

Namestring required

A name for the FAQ.

Descriptionstring

A description for the FAQ.

RoleArnstring required

The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM access roles for Amazon Kendra</a>.

FileFormat'CSV' | 'CSV_WITH_HEADER' | 'JSON'
<p>The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.</p> <p>The format must match the format of the file stored in the S3 bucket identified in the <code>S3Path</code> parameter.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html">Adding questions and answers</a>.</p>
ClientTokenstring

A token that you provide to identify the request to create a FAQ. Multiple calls to the <code>CreateFaqRequest</code> API with the same client token will create only one FAQ.

LanguageCodestring

The code for a language. This allows you to support a 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>.

Response

Success

Idstring

The identifier of the FAQ.