Skip to content

DescribeThesaurusResponse

Source code in docs_src/capo_kendra/types/describe_thesaurus_response.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
class DescribeThesaurusResponse(TypedDict, closed=True):
    id: NotRequired["capo_kendra.types.thesaurus_id.ThesaurusId"]
    """<p>The identifier of the thesaurus.</p>"""
    index_id: NotRequired["capo_kendra.types.index_id.IndexId"]
    """<p>The identifier of the index for the thesaurus.</p>"""
    name: NotRequired["capo_kendra.types.thesaurus_name.ThesaurusName"]
    """<p>The thesaurus name.</p>"""
    description: NotRequired["capo_kendra.types.description.Description"]
    """<p>The thesaurus description.</p>"""
    status: NotRequired["capo_kendra.types.thesaurus_status.ThesaurusStatus"]
    """<p>The current status of the thesaurus. When the value is <code>ACTIVE</code>, queries are able to use the thesaurus. If the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field provides more information. </p> <p>If the status is <code>ACTIVE_BUT_UPDATE_FAILED</code>, it means that Amazon Kendra could not ingest the new thesaurus file. The old thesaurus file is still active. </p>"""
    error_message: NotRequired["capo_kendra.types.error_message.ErrorMessage"]
    """<p>When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field provides more information. </p>"""
    created_at: NotRequired["capo_kendra.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the thesaurus was created.</p>"""
    updated_at: NotRequired["capo_kendra.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the thesaurus was last updated.</p>"""
    role_arn: NotRequired["capo_kendra.types.role_arn.RoleArn"]
    """<p>An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in <code>SourceS3Path</code>. </p>"""
    source_s3_path: NotRequired["capo_kendra.types.s3_path.S3Path"]
    file_size_bytes: NotRequired["capo_kendra.types.long.Long"]
    """<p>The size of the thesaurus file in bytes.</p>"""
    term_count: NotRequired["capo_kendra.types.long.Long"]
    """<p>The number of unique terms in the thesaurus file. For example, the synonyms <code>a,b,c</code> and <code>a=>d</code>, the term count would be 4. </p>"""
    synonym_rule_count: NotRequired["capo_kendra.types.long.Long"]
    """<p>The number of synonym rules in the thesaurus file.</p>"""

created_at instance-attribute 

created_at: NotRequired[Timestamp]

The Unix timestamp when the thesaurus was created.

description instance-attribute 

description: NotRequired[Description]

The thesaurus description.

error_message instance-attribute 

error_message: NotRequired[ErrorMessage]

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

file_size_bytes instance-attribute 

file_size_bytes: NotRequired[Long]

The size of the thesaurus file in bytes.

id instance-attribute 

id: NotRequired[ThesaurusId]

The identifier of the thesaurus.

index_id instance-attribute 

index_id: NotRequired[IndexId]

The identifier of the index for the thesaurus.

name instance-attribute 

name: NotRequired[ThesaurusName]

The thesaurus name.

role_arn instance-attribute 

role_arn: NotRequired[RoleArn]

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

source_s3_path instance-attribute 

source_s3_path: NotRequired[S3Path]

status instance-attribute 

status: NotRequired[ThesaurusStatus]

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.

synonym_rule_count instance-attribute 

synonym_rule_count: NotRequired[Long]

The number of synonym rules in the thesaurus file.

term_count instance-attribute 

term_count: NotRequired[Long]

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.

updated_at instance-attribute 

updated_at: NotRequired[Timestamp]

The Unix timestamp when the thesaurus was last updated.