GetFaqResult

data class GetFaqResult(val arn: String, val createdAt: String, val description: String, val errorMessage: String, val faqId: String, val fileFormat: String, val id: String, val indexId: String, val languageCode: String, val name: String, val roleArn: String, val s3Paths: List<GetFaqS3Path>, val status: String, val tags: Map<String, String>, val updatedAt: String)

A collection of values returned by getFaq.

Constructors

Link copied to clipboard
constructor(arn: String, createdAt: String, description: String, errorMessage: String, faqId: String, fileFormat: String, id: String, indexId: String, languageCode: String, name: String, roleArn: String, s3Paths: List<GetFaqS3Path>, status: String, tags: Map<String, String>, updatedAt: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String

ARN of the FAQ.

Link copied to clipboard

Unix datetime that the faq was created.

Link copied to clipboard

Description of the FAQ.

Link copied to clipboard

When the status field value is FAILED, this contains a message that explains why.

Link copied to clipboard
Link copied to clipboard

File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.

Link copied to clipboard
val id: String

The provider-assigned unique ID for this managed resource.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

Name of the FAQ.

Link copied to clipboard

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

Link copied to clipboard

S3 location of the FAQ input data. Detailed below.

Link copied to clipboard

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

Link copied to clipboard

Metadata that helps organize the FAQs you create.

Link copied to clipboard

Date and time that the FAQ was last updated.