Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465566486.4 KB

Gets information about an existing Amazon Kendra thesaurus.

post/#X-Amz-Target=AWSKendraFrontendService.DescribeThesaurus

Headers

X-Amz-Target'AWSKendraFrontendService.DescribeThesaurus' required

Request body

Idstring required

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

IndexIdstring required

The identifier of the index for the thesaurus.

Response

Success

Idstring

The identifier of the thesaurus.

IndexIdstring

The identifier of the index for the thesaurus.

Namestring

The thesaurus name.

Descriptionstring

The thesaurus description.

Status'CREATING' | 'ACTIVE' | 'DELETING' | 'UPDATING' | 'ACTIVE_BUT_UPDATE_FAILED' | 'FAILED'
<p>The current status of the thesaurus. When the value is <code>ACTIVE</code>, queries are able to use the thesaurus. If the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field provides more information. </p> <p>If the status is <code>ACTIVE_BUT_UPDATE_FAILED</code>, it means that Amazon Kendra could not ingest the new thesaurus file. The old thesaurus file is still active. </p>
ErrorMessagestring

When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field provides more information.

CreatedAtstring date-time

The Unix timestamp when the thesaurus was created.

UpdatedAtstring date-time

The Unix timestamp when the thesaurus was last updated.

RoleArnstring

An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in <code>SourceS3Path</code>.

FileSizeBytesinteger

The size of the thesaurus file in bytes.

TermCountinteger

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

SynonymRuleCountinteger

The number of synonym rules in the thesaurus file.