Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeFaq

Gets information about a FAQ.

Request Syntax


{
   "Id": "string",
   "IndexId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Id

The identifier of the FAQ you want to get information on.

Type: String

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

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

Required: Yes

IndexId

The identifier of the index for the FAQ.

Type: String

Length Constraints: Fixed length of 36.

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

Required: Yes

Response Syntax


{
   "CreatedAt": number,
   "Description": "string",
   "ErrorMessage": "string",
   "FileFormat": "string",
   "Id": "string",
   "IndexId": "string",
   "LanguageCode": "string",
   "Name": "string",
   "RoleArn": "string",
   "S3Path": { 
      "Bucket": "string",
      "Key": "string"
   },
   "Status": "string",
   "UpdatedAt": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreatedAt

The Unix timestamp when the FAQ was created.

Type: Timestamp

Description

The description of the FAQ that you provided when it was created.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: ^\P{C}*$

ErrorMessage

If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.

Type: String

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

Pattern: ^\P{C}*$

FileFormat

The file format used for the FAQ file.

Type: String

Valid Values: CSV | CSV_WITH_HEADER | JSON

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_-]*

IndexId

The identifier of the index for the FAQ.

Type: String

Length Constraints: Fixed length of 36.

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

LanguageCode

The code for a language. This shows a supported 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.

Type: String

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

Pattern: [a-zA-Z-]*

Name

The name that you gave the FAQ when it was created.

Type: String

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

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

RoleArn

The Amazon Resource Name (ARN) of the IAM role that provides access to the S3 bucket containing the FAQ file.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1284.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

S3Path

Information required to find a specific file in an Amazon S3 bucket.

Type: S3Path object

Status

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

Type: String

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

UpdatedAt

The Unix timestamp when the FAQ was last updated.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

HTTP Status Code: 400

InternalServerException

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

HTTP Status Code: 500

ResourceNotFoundException

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling. Please reduce the number of requests and try again.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

HTTP Status Code: 400