DescribeThesaurus - Amazon Kendra

DescribeThesaurus

Describes an existing Amazon Kendra thesaurus.

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 thesaurus to describe.

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 associated with the thesaurus to describe.

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", "FileSizeBytes": number, "Id": "string", "IndexId": "string", "Name": "string", "RoleArn": "string", "SourceS3Path": { "Bucket": "string", "Key": "string" }, "Status": "string", "SynonymRuleCount": number, "TermCount": number, "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 datetime that the thesaurus was created.

Type: Timestamp

Description

The thesaurus description.

Type: String

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

Pattern: ^\P{C}*$

ErrorMessage

When the Status field value is FAILED, the ErrorMessage field provides more information.

Type: String

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

Pattern: ^\P{C}*$

FileSizeBytes

The size of the thesaurus file in bytes.

Type: Long

Id

The identifier of the thesaurus.

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 associated with the thesaurus to describe.

Type: String

Length Constraints: Fixed length of 36.

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

Name

The thesaurus name.

Type: String

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

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

RoleArn

An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

Type: String

Length Constraints: Minimum length of 1. 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}

SourceS3Path

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

Type: S3Path object

Status

The current status of the thesaurus. When the value is ACTIVE, queries are able to use the thesaurus. If the Status field value is FAILED, the ErrorMessage field provides more information.

If the status is ACTIVE_BUT_UPDATE_FAILED, it means that Amazon Kendra could not ingest the new thesaurus file. The old thesaurus file is still active.

Type: String

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

SynonymRuleCount

The number of synonym rules in the thesaurus file.

Type: Long

TermCount

The number of unique terms in the thesaurus file. For example, the synonyms a,b,c and a=>d, the term count would be 4.

Type: Long

UpdatedAt

The Unix datetime that the thesaurus was last updated.

Type: Timestamp

Errors

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

AccessDeniedException

HTTP Status Code: 400

InternalServerException

HTTP Status Code: 500

ResourceNotFoundException

HTTP Status Code: 400

ThrottlingException

HTTP Status Code: 400

ValidationException

HTTP Status Code: 400

See Also

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