aws_sdk_wisdom/client/
search_quick_responses.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`SearchQuickResponses`](crate::operation::search_quick_responses::builders::SearchQuickResponsesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::search_quick_responses::builders::SearchQuickResponsesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`knowledge_base_id(impl Into<String>)`](crate::operation::search_quick_responses::builders::SearchQuickResponsesFluentBuilder::knowledge_base_id) / [`set_knowledge_base_id(Option<String>)`](crate::operation::search_quick_responses::builders::SearchQuickResponsesFluentBuilder::set_knowledge_base_id):<br>required: **true**<br><p>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p><br>
    ///   - [`search_expression(QuickResponseSearchExpression)`](crate::operation::search_quick_responses::builders::SearchQuickResponsesFluentBuilder::search_expression) / [`set_search_expression(Option<QuickResponseSearchExpression>)`](crate::operation::search_quick_responses::builders::SearchQuickResponsesFluentBuilder::set_search_expression):<br>required: **true**<br><p>The search expression for querying the quick response.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::search_quick_responses::builders::SearchQuickResponsesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_quick_responses::builders::SearchQuickResponsesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p><br>
    ///   - [`max_results(i32)`](crate::operation::search_quick_responses::builders::SearchQuickResponsesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_quick_responses::builders::SearchQuickResponsesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
    ///   - [`attributes(impl Into<String>, impl Into<String>)`](crate::operation::search_quick_responses::builders::SearchQuickResponsesFluentBuilder::attributes) / [`set_attributes(Option<HashMap::<String, String>>)`](crate::operation::search_quick_responses::builders::SearchQuickResponsesFluentBuilder::set_attributes):<br>required: **false**<br><p>The <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes">user-defined Amazon Connect contact attributes</a> to be resolved when search results are returned.</p><br>
    /// - On success, responds with [`SearchQuickResponsesOutput`](crate::operation::search_quick_responses::SearchQuickResponsesOutput) with field(s):
    ///   - [`results(Vec::<QuickResponseSearchResultData>)`](crate::operation::search_quick_responses::SearchQuickResponsesOutput::results): <p>The results of the quick response search.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::search_quick_responses::SearchQuickResponsesOutput::next_token): <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
    /// - On failure, responds with [`SdkError<SearchQuickResponsesError>`](crate::operation::search_quick_responses::SearchQuickResponsesError)
    pub fn search_quick_responses(&self) -> crate::operation::search_quick_responses::builders::SearchQuickResponsesFluentBuilder {
        crate::operation::search_quick_responses::builders::SearchQuickResponsesFluentBuilder::new(self.handle.clone())
    }
}