Skip to content

Create Thesaurus

kendra_create_thesaurus R Documentation

Creates a thesaurus for an index

Description

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

For an example of adding a thesaurus file to an index, see Adding custom synonyms to an index.

Usage

kendra_create_thesaurus(IndexId, Name, Description, RoleArn, Tags,
  SourceS3Path, ClientToken)

Arguments

IndexId

[required] The identifier of the index for the thesaurus.

Name

[required] A name for the thesaurus.

Description

A description for the thesaurus.

RoleArn

[required] The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the thesaurus file. For more information, see IAM access roles for Amazon Kendra.

Tags

A list of key-value pairs that identify or categorize the thesaurus. You can also use tags to help control access to the thesaurus. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

SourceS3Path

[required] The path to the thesaurus file in S3.

ClientToken

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

Value

A list with the following syntax: 

list(
  Id = "string"
)

Request syntax

svc$create_thesaurus(
  IndexId = "string",
  Name = "string",
  Description = "string",
  RoleArn = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  SourceS3Path = list(
    Bucket = "string",
    Key = "string"
  ),
  ClientToken = "string"
)