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
27
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeQuerySuggestionsBlockList`](crate::operation::describe_query_suggestions_block_list::builders::DescribeQuerySuggestionsBlockListFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`index_id(impl Into<String>)`](crate::operation::describe_query_suggestions_block_list::builders::DescribeQuerySuggestionsBlockListFluentBuilder::index_id) / [`set_index_id(Option<String>)`](crate::operation::describe_query_suggestions_block_list::builders::DescribeQuerySuggestionsBlockListFluentBuilder::set_index_id):<br>required: **true**<br><p>The identifier of the index for the block list.</p><br>
    ///   - [`id(impl Into<String>)`](crate::operation::describe_query_suggestions_block_list::builders::DescribeQuerySuggestionsBlockListFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::describe_query_suggestions_block_list::builders::DescribeQuerySuggestionsBlockListFluentBuilder::set_id):<br>required: **true**<br><p>The identifier of the block list you want to get information on.</p><br>
    /// - On success, responds with [`DescribeQuerySuggestionsBlockListOutput`](crate::operation::describe_query_suggestions_block_list::DescribeQuerySuggestionsBlockListOutput) with field(s):
    ///   - [`index_id(Option<String>)`](crate::operation::describe_query_suggestions_block_list::DescribeQuerySuggestionsBlockListOutput::index_id): <p>The identifier of the index for the block list.</p>
    ///   - [`id(Option<String>)`](crate::operation::describe_query_suggestions_block_list::DescribeQuerySuggestionsBlockListOutput::id): <p>The identifier of the block list.</p>
    ///   - [`name(Option<String>)`](crate::operation::describe_query_suggestions_block_list::DescribeQuerySuggestionsBlockListOutput::name): <p>The name of the block list.</p>
    ///   - [`description(Option<String>)`](crate::operation::describe_query_suggestions_block_list::DescribeQuerySuggestionsBlockListOutput::description): <p>The description for the block list.</p>
    ///   - [`status(Option<QuerySuggestionsBlockListStatus>)`](crate::operation::describe_query_suggestions_block_list::DescribeQuerySuggestionsBlockListOutput::status): <p>The current status of the block list. When the value is <code>ACTIVE</code>, the block list is ready for use.</p>
    ///   - [`error_message(Option<String>)`](crate::operation::describe_query_suggestions_block_list::DescribeQuerySuggestionsBlockListOutput::error_message): <p>The error message containing details if there are issues processing the block list.</p>
    ///   - [`created_at(Option<DateTime>)`](crate::operation::describe_query_suggestions_block_list::DescribeQuerySuggestionsBlockListOutput::created_at): <p>The Unix timestamp when a block list for query suggestions was created.</p>
    ///   - [`updated_at(Option<DateTime>)`](crate::operation::describe_query_suggestions_block_list::DescribeQuerySuggestionsBlockListOutput::updated_at): <p>The Unix timestamp when a block list for query suggestions was last updated.</p>
    ///   - [`source_s3_path(Option<S3Path>)`](crate::operation::describe_query_suggestions_block_list::DescribeQuerySuggestionsBlockListOutput::source_s3_path): <p>Shows the current S3 path to your block list text file in your S3 bucket.</p> <p>Each block word or phrase should be on a separate line in a text file.</p> <p>For information on the current quota limits for block lists, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas for Amazon Kendra</a>.</p>
    ///   - [`item_count(Option<i32>)`](crate::operation::describe_query_suggestions_block_list::DescribeQuerySuggestionsBlockListOutput::item_count): <p>The current number of valid, non-empty words or phrases in the block list text file.</p>
    ///   - [`file_size_bytes(Option<i64>)`](crate::operation::describe_query_suggestions_block_list::DescribeQuerySuggestionsBlockListOutput::file_size_bytes): <p>The current size of the block list text file in S3.</p>
    ///   - [`role_arn(Option<String>)`](crate::operation::describe_query_suggestions_block_list::DescribeQuerySuggestionsBlockListOutput::role_arn): <p>The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.</p> <p>The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.</p>
    /// - On failure, responds with [`SdkError<DescribeQuerySuggestionsBlockListError>`](crate::operation::describe_query_suggestions_block_list::DescribeQuerySuggestionsBlockListError)
    pub fn describe_query_suggestions_block_list(
        &self,
    ) -> crate::operation::describe_query_suggestions_block_list::builders::DescribeQuerySuggestionsBlockListFluentBuilder {
        crate::operation::describe_query_suggestions_block_list::builders::DescribeQuerySuggestionsBlockListFluentBuilder::new(self.handle.clone())
    }
}