[ aws . kendra ]

describe-thesaurus

Description

Describes an existing Amazon Kendra thesaurus.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-thesaurus
--id <value>
--index-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--id (string)

The identifier of the thesaurus to describe.

--index-id (string)

The identifier of the index associated with the thesaurus to describe.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Id -> (string)

The identifier of the thesaurus.

IndexId -> (string)

The identifier of the index associated with the thesaurus to describe.

Name -> (string)

The thesaurus name.

Description -> (string)

The thesaurus description.

Status -> (string)

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.

ErrorMessage -> (string)

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

CreatedAt -> (timestamp)

The Unix datetime that the thesaurus was created.

UpdatedAt -> (timestamp)

The Unix datetime that the thesaurus was last updated.

RoleArn -> (string)

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

SourceS3Path -> (structure)

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

Bucket -> (string)

The name of the S3 bucket that contains the file.

Key -> (string)

The name of the file.

FileSizeBytes -> (long)

The size of the thesaurus file in bytes.

TermCount -> (long)

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.

SynonymRuleCount -> (long)

The number of synonym rules in the thesaurus file.