CreateFaqRequest

import type { CreateFaqRequest } from "https://aws-api.deno.dev/v0.4/services/kendra.ts?docs=full";

interface CreateFaqRequest {

ClientToken?: string | null;

Description?: string | null;

FileFormat?: FaqFileFormat | null;

IndexId: string;

LanguageCode?: string | null;

Name: string;

RoleArn: string;

S3Path: S3Path;

Tags?: Tag[] | null;

}

§Properties

ClientToken?: string | null

[src]

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

Description?: string | null

[src]

A description for the FAQ.

FileFormat?: FaqFileFormat | null

[src]

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.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

IndexId: string

[src]

The identifier of the index for the FAQ.

LanguageCode?: string | null

[src]

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 Adding documents in languages other than English.

Name: string

[src]

A name for the FAQ.

RoleArn: string

[src]

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

S3Path: S3Path

[src]

The path to the FAQ file in S3.

Tags?: Tag[] | null

[src]

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.