FaqSummary - Amazon Kendra API Reference

FaqSummary

Summary information for frequently asked questions and answers included in an index.

Contents

CreatedAt

The Unix timestamp when the FAQ was created.

Type: Timestamp

Required: No

FileFormat

The file type used to create the FAQ.

Type: String

Valid Values: CSV | CSV_WITH_HEADER | JSON

Required: No

Id

The identifier of the FAQ.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: No

LanguageCode

The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 10.

Pattern: [a-zA-Z-]*

Required: No

Name

The name that you assigned the FAQ when you created or updated the FAQ.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: No

Status

The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.

Type: String

Valid Values: CREATING | UPDATING | ACTIVE | DELETING | FAILED

Required: No

UpdatedAt

The Unix timestamp when the FAQ was last updated.

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: