Get Faq Result
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.
Properties
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
File format used by the input files for the FAQ. Valid Values are CSV
, CSV_WITH_HEADER
, JSON
.
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
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.