1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`SearchUsers`](crate::operation::search_users::builders::SearchUsersFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::search_users::builders::SearchUsersFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`instance_id(impl Into<String>)`](crate::operation::search_users::builders::SearchUsersFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::search_users::builders::SearchUsersFluentBuilder::set_instance_id): <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
    ///   - [`next_token(impl Into<String>)`](crate::operation::search_users::builders::SearchUsersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_users::builders::SearchUsersFluentBuilder::set_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>
    ///   - [`max_results(i32)`](crate::operation::search_users::builders::SearchUsersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_users::builders::SearchUsersFluentBuilder::set_max_results): <p>The maximum number of results to return per page.</p>
    ///   - [`search_filter(UserSearchFilter)`](crate::operation::search_users::builders::SearchUsersFluentBuilder::search_filter) / [`set_search_filter(Option<UserSearchFilter>)`](crate::operation::search_users::builders::SearchUsersFluentBuilder::set_search_filter): <p>Filters to be applied to search results.</p>
    ///   - [`search_criteria(UserSearchCriteria)`](crate::operation::search_users::builders::SearchUsersFluentBuilder::search_criteria) / [`set_search_criteria(Option<UserSearchCriteria>)`](crate::operation::search_users::builders::SearchUsersFluentBuilder::set_search_criteria): <p>The search criteria to be used to return users.</p> <note>   <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. </p>  </note>
    /// - On success, responds with [`SearchUsersOutput`](crate::operation::search_users::SearchUsersOutput) with field(s):
    ///   - [`users(Option<Vec<UserSearchSummary>>)`](crate::operation::search_users::SearchUsersOutput::users): <p>Information about the users.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::search_users::SearchUsersOutput::next_token): <p>If there are additional results, this is the token for the next set of results.</p>
    ///   - [`approximate_total_count(Option<i64>)`](crate::operation::search_users::SearchUsersOutput::approximate_total_count): <p>The total number of users who matched your search query.</p>
    /// - On failure, responds with [`SdkError<SearchUsersError>`](crate::operation::search_users::SearchUsersError)
    pub fn search_users(
        &self,
    ) -> crate::operation::search_users::builders::SearchUsersFluentBuilder {
        crate::operation::search_users::builders::SearchUsersFluentBuilder::new(self.handle.clone())
    }
}