Skip to content

Describe Thesaurus

kendra_describe_thesaurus R Documentation

Gets information about an Amazon Kendra thesaurus

Description

Gets information about an Amazon Kendra thesaurus.

Usage

kendra_describe_thesaurus(Id, IndexId)

Arguments

Id

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

IndexId

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

Value

A list with the following syntax: 

list(
  Id = "string",
  IndexId = "string",
  Name = "string",
  Description = "string",
  Status = "CREATING"|"ACTIVE"|"DELETING"|"UPDATING"|"ACTIVE_BUT_UPDATE_FAILED"|"FAILED",
  ErrorMessage = "string",
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  UpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  RoleArn = "string",
  SourceS3Path = list(
    Bucket = "string",
    Key = "string"
  ),
  FileSizeBytes = 123,
  TermCount = 123,
  SynonymRuleCount = 123
)

Request syntax

svc$describe_thesaurus(
  Id = "string",
  IndexId = "string"
)