DescribeThesaurusResponse

import type { DescribeThesaurusResponse } from "https://aws-api.deno.dev/v0.4/services/kendra.ts?docs=full";

interface DescribeThesaurusResponse {

CreatedAt?: Date | number | null;

Description?: string | null;

ErrorMessage?: string | null;

FileSizeBytes?: number | null;

Id?: string | null;

IndexId?: string | null;

Name?: string | null;

RoleArn?: string | null;

SourceS3Path?: S3Path | null;

Status?: ThesaurusStatus | null;

SynonymRuleCount?: number | null;

TermCount?: number | null;

UpdatedAt?: Date | number | null;

}

§Properties

CreatedAt?: Date | number | null

[src]

The Unix datetime that the thesaurus was created.

Description?: string | null

[src]

The thesaurus description.

ErrorMessage?: string | null

[src]

When the Status field value is FAILED, the ErrorMessage field provides more information.

FileSizeBytes?: number | null

[src]

The size of the thesaurus file in bytes.

Id?: string | null

[src]

The identifier of the thesaurus.

IndexId?: string | null

[src]

The identifier of the index for the thesaurus.

Name?: string | null

[src]

The thesaurus name.

RoleArn?: string | null

[src]

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

SourceS3Path?: S3Path | null

[src]

Status?: ThesaurusStatus | null

[src]

The current status of the thesaurus. When the value is ACTIVE, queries are able to use the thesaurus. If the Status field value is FAILED, the ErrorMessage field provides more information.

If the status is ACTIVE_BUT_UPDATE_FAILED, it means that Amazon Kendra could not ingest the new thesaurus file. The old thesaurus file is still active.

SynonymRuleCount?: number | null

[src]

The number of synonym rules in the thesaurus file.

TermCount?: number | null

[src]

The number of unique terms in the thesaurus file. For example, the synonyms a,b,c and a=>d, the term count would be 4.

UpdatedAt?: Date | number | null

[src]

The Unix datetime that the thesaurus was last updated.