aws_sdk_kendra/client/

create_query_suggestions_block_list.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateQuerySuggestionsBlockList`](crate::operation::create_query_suggestions_block_list::builders::CreateQuerySuggestionsBlockListFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`index_id(impl Into<String>)`](crate::operation::create_query_suggestions_block_list::builders::CreateQuerySuggestionsBlockListFluentBuilder::index_id) / [`set_index_id(Option<String>)`](crate::operation::create_query_suggestions_block_list::builders::CreateQuerySuggestionsBlockListFluentBuilder::set_index_id):<br>required: **true**<br><p>The identifier of the index you want to create a query suggestions block list for.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::create_query_suggestions_block_list::builders::CreateQuerySuggestionsBlockListFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_query_suggestions_block_list::builders::CreateQuerySuggestionsBlockListFluentBuilder::set_name):<br>required: **true**<br><p>A name for the block list.</p> <p>For example, the name 'offensive-words', which includes all offensive words that could appear in user queries and need to be blocked from suggestions.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::create_query_suggestions_block_list::builders::CreateQuerySuggestionsBlockListFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_query_suggestions_block_list::builders::CreateQuerySuggestionsBlockListFluentBuilder::set_description):<br>required: **false**<br><p>A description for the block list.</p> <p>For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."</p><br>
    ///   - [`source_s3_path(S3Path)`](crate::operation::create_query_suggestions_block_list::builders::CreateQuerySuggestionsBlockListFluentBuilder::source_s3_path) / [`set_source_s3_path(Option<S3Path>)`](crate::operation::create_query_suggestions_block_list::builders::CreateQuerySuggestionsBlockListFluentBuilder::set_source_s3_path):<br>required: **true**<br><p>The 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><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::create_query_suggestions_block_list::builders::CreateQuerySuggestionsBlockListFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_query_suggestions_block_list::builders::CreateQuerySuggestionsBlockListFluentBuilder::set_client_token):<br>required: **false**<br><p>A token that you provide to identify the request to create a query suggestions block list.</p><br>
    ///   - [`role_arn(impl Into<String>)`](crate::operation::create_query_suggestions_block_list::builders::CreateQuerySuggestionsBlockListFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::create_query_suggestions_block_list::builders::CreateQuerySuggestionsBlockListFluentBuilder::set_role_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the block list text file. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM access roles for Amazon Kendra</a>.</p><br>
    ///   - [`tags(Tag)`](crate::operation::create_query_suggestions_block_list::builders::CreateQuerySuggestionsBlockListFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_query_suggestions_block_list::builders::CreateQuerySuggestionsBlockListFluentBuilder::set_tags):<br>required: **false**<br><p>A list of key-value pairs that identify or categorize the block list. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</p><br>
    /// - On success, responds with [`CreateQuerySuggestionsBlockListOutput`](crate::operation::create_query_suggestions_block_list::CreateQuerySuggestionsBlockListOutput) with field(s):
    ///   - [`id(Option<String>)`](crate::operation::create_query_suggestions_block_list::CreateQuerySuggestionsBlockListOutput::id): <p>The identifier of the block list.</p>
    /// - On failure, responds with [`SdkError<CreateQuerySuggestionsBlockListError>`](crate::operation::create_query_suggestions_block_list::CreateQuerySuggestionsBlockListError)
    pub fn create_query_suggestions_block_list(
        &self,
    ) -> crate::operation::create_query_suggestions_block_list::builders::CreateQuerySuggestionsBlockListFluentBuilder {
        crate::operation::create_query_suggestions_block_list::builders::CreateQuerySuggestionsBlockListFluentBuilder::new(self.handle.clone())
    }
}