AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . kendra ]

describe-thesaurus

Description

Gets information about an Amazon Kendra thesaurus.

See also: AWS API Documentation

Synopsis

  describe-thesaurus
--id <value>
--index-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--id (string)

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

--index-id (string)

The identifier of the index for the thesaurus.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Id -> (string)

The identifier of the thesaurus.

IndexId -> (string)

The identifier of the index for the thesaurus.

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 timestamp when the thesaurus was created.

UpdatedAt -> (timestamp)

The Unix timestamp when the thesaurus was last updated.

RoleArn -> (string)

An 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.