[ aws . kendra ]

create-thesaurus

Description

Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--index-id (string)

The unique identifier of the index for the new thesaurus.

--name (string)

The name for the new thesaurus.

--description (string)

The description for the new thesaurus.

--role-arn (string)

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

--tags (list)

A list of key-value pairs that identify the thesaurus. You can use the tags to identify and organize your resources and to control access to resources.

(structure)

A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Key -> (string)

The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, or data source.

Value -> (string)

The value associated with the tag. The value may be an empty string but it can’t be null.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--source-s3-path (structure)

The thesaurus file Amazon S3 source path.

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"
}

--client-token (string)

A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus operation with the same client token will create only one index.

--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 unique identifier of the thesaurus.