[ aws . kendra ]

update-thesaurus

Description

Updates a thesaurus for an index.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-thesaurus
--id <value>
[--name <value>]
--index-id <value>
[--description <value>]
[--role-arn <value>]
[--source-s3-path <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--id (string)

The identifier of the thesaurus you want to update.

--name (string)

A new name for the thesaurus.

--index-id (string)

The identifier of the index for the thesaurus.

--description (string)

A new description for the thesaurus.

--role-arn (string)

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

--source-s3-path (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.

Shorthand Syntax:

Bucket=string,Key=string

JSON Syntax:

{
  "Bucket": "string",
  "Key": "string"
}

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

None