1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeThesaurus`](crate::operation::describe_thesaurus::builders::DescribeThesaurusFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`id(impl Into<String>)`](crate::operation::describe_thesaurus::builders::DescribeThesaurusFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::describe_thesaurus::builders::DescribeThesaurusFluentBuilder::set_id):<br>required: **true**<br><p>The identifier of the thesaurus you want to get information on.</p><br>
    ///   - [`index_id(impl Into<String>)`](crate::operation::describe_thesaurus::builders::DescribeThesaurusFluentBuilder::index_id) / [`set_index_id(Option<String>)`](crate::operation::describe_thesaurus::builders::DescribeThesaurusFluentBuilder::set_index_id):<br>required: **true**<br><p>The identifier of the index for the thesaurus.</p><br>
    /// - On success, responds with [`DescribeThesaurusOutput`](crate::operation::describe_thesaurus::DescribeThesaurusOutput) with field(s):
    ///   - [`id(Option<String>)`](crate::operation::describe_thesaurus::DescribeThesaurusOutput::id): <p>The identifier of the thesaurus.</p>
    ///   - [`index_id(Option<String>)`](crate::operation::describe_thesaurus::DescribeThesaurusOutput::index_id): <p>The identifier of the index for the thesaurus.</p>
    ///   - [`name(Option<String>)`](crate::operation::describe_thesaurus::DescribeThesaurusOutput::name): <p>The thesaurus name.</p>
    ///   - [`description(Option<String>)`](crate::operation::describe_thesaurus::DescribeThesaurusOutput::description): <p>The thesaurus description.</p>
    ///   - [`status(Option<ThesaurusStatus>)`](crate::operation::describe_thesaurus::DescribeThesaurusOutput::status): <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(Option<String>)`](crate::operation::describe_thesaurus::DescribeThesaurusOutput::error_message): <p>When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field provides more information.</p>
    ///   - [`created_at(Option<DateTime>)`](crate::operation::describe_thesaurus::DescribeThesaurusOutput::created_at): <p>The Unix timestamp when the thesaurus was created.</p>
    ///   - [`updated_at(Option<DateTime>)`](crate::operation::describe_thesaurus::DescribeThesaurusOutput::updated_at): <p>The Unix timestamp when the thesaurus was last updated.</p>
    ///   - [`role_arn(Option<String>)`](crate::operation::describe_thesaurus::DescribeThesaurusOutput::role_arn): <p>An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in <code>SourceS3Path</code>.</p>
    ///   - [`source_s3_path(Option<S3Path>)`](crate::operation::describe_thesaurus::DescribeThesaurusOutput::source_s3_path): <p>Information required to find a specific file in an Amazon S3 bucket.</p>
    ///   - [`file_size_bytes(Option<i64>)`](crate::operation::describe_thesaurus::DescribeThesaurusOutput::file_size_bytes): <p>The size of the thesaurus file in bytes.</p>
    ///   - [`term_count(Option<i64>)`](crate::operation::describe_thesaurus::DescribeThesaurusOutput::term_count): <p>The number of unique terms in the thesaurus file. For example, the synonyms <code>a,b,c</code> and <code>a=&gt;d</code>, the term count would be 4.</p>
    ///   - [`synonym_rule_count(Option<i64>)`](crate::operation::describe_thesaurus::DescribeThesaurusOutput::synonym_rule_count): <p>The number of synonym rules in the thesaurus file.</p>
    /// - On failure, responds with [`SdkError<DescribeThesaurusError>`](crate::operation::describe_thesaurus::DescribeThesaurusError)
    pub fn describe_thesaurus(&self) -> crate::operation::describe_thesaurus::builders::DescribeThesaurusFluentBuilder {
        crate::operation::describe_thesaurus::builders::DescribeThesaurusFluentBuilder::new(self.handle.clone())
    }
}