[ aws . kendra ]

list-thesauri

Description

Lists the Amazon Kendra thesauri associated with an index.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-thesauri
--index-id <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--index-id (string)

The identifier of the index associated with the thesaurus to list.

--next-token (string)

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of thesauri (ThesaurusSummaryItems ).

--max-results (integer)

The maximum number of thesauri to return.

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

NextToken -> (string)

If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of thesauri.

ThesaurusSummaryItems -> (list)

An array of summary information for a thesaurus or multiple thesauri.

(structure)

An array of summary information for a thesaurus or multiple thesauri.

Id -> (string)

The identifier of the thesaurus.

Name -> (string)

The name of the thesaurus.

Status -> (string)

The status of the thesaurus.

CreatedAt -> (timestamp)

The Unix datetime that the thesaurus was created.

UpdatedAt -> (timestamp)

The Unix datetime that the thesaurus was last updated.