aws_sdk_connect/operation/search_users/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::search_users::_search_users_output::SearchUsersOutputBuilder;
3
4pub use crate::operation::search_users::_search_users_input::SearchUsersInputBuilder;
5
6impl crate::operation::search_users::builders::SearchUsersInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::search_users::SearchUsersOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::search_users::SearchUsersError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.search_users();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `SearchUsers`.
24///
25/// <p>Searches users in an Amazon Connect instance, with optional filtering.</p><note>
26/// <p><code>AfterContactWorkTimeLimit</code> is returned in milliseconds.</p>
27/// </note>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct SearchUsersFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::search_users::builders::SearchUsersInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::search_users::SearchUsersOutput,
37        crate::operation::search_users::SearchUsersError,
38    > for SearchUsersFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::search_users::SearchUsersOutput,
46            crate::operation::search_users::SearchUsersError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl SearchUsersFluentBuilder {
53    /// Creates a new `SearchUsersFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the SearchUsers as a reference.
62    pub fn as_input(&self) -> &crate::operation::search_users::builders::SearchUsersInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::search_users::SearchUsersOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::search_users::SearchUsersError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::search_users::SearchUsers::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::search_users::SearchUsers::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::search_users::SearchUsersOutput,
99        crate::operation::search_users::SearchUsersError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// Create a paginator for this request
114    ///
115    /// Paginators are used by calling [`send().await`](crate::operation::search_users::paginator::SearchUsersPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
116    pub fn into_paginator(self) -> crate::operation::search_users::paginator::SearchUsersPaginator {
117        crate::operation::search_users::paginator::SearchUsersPaginator::new(self.handle, self.inner)
118    }
119    /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
120    pub fn instance_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
121        self.inner = self.inner.instance_id(input.into());
122        self
123    }
124    /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
125    pub fn set_instance_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
126        self.inner = self.inner.set_instance_id(input);
127        self
128    }
129    /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
130    pub fn get_instance_id(&self) -> &::std::option::Option<::std::string::String> {
131        self.inner.get_instance_id()
132    }
133    /// <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>
134    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
135        self.inner = self.inner.next_token(input.into());
136        self
137    }
138    /// <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>
139    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
140        self.inner = self.inner.set_next_token(input);
141        self
142    }
143    /// <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>
144    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
145        self.inner.get_next_token()
146    }
147    /// <p>The maximum number of results to return per page.</p>
148    pub fn max_results(mut self, input: i32) -> Self {
149        self.inner = self.inner.max_results(input);
150        self
151    }
152    /// <p>The maximum number of results to return per page.</p>
153    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
154        self.inner = self.inner.set_max_results(input);
155        self
156    }
157    /// <p>The maximum number of results to return per page.</p>
158    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
159        self.inner.get_max_results()
160    }
161    /// <p>Filters to be applied to search results.</p>
162    pub fn search_filter(mut self, input: crate::types::UserSearchFilter) -> Self {
163        self.inner = self.inner.search_filter(input);
164        self
165    }
166    /// <p>Filters to be applied to search results.</p>
167    pub fn set_search_filter(mut self, input: ::std::option::Option<crate::types::UserSearchFilter>) -> Self {
168        self.inner = self.inner.set_search_filter(input);
169        self
170    }
171    /// <p>Filters to be applied to search results.</p>
172    pub fn get_search_filter(&self) -> &::std::option::Option<crate::types::UserSearchFilter> {
173        self.inner.get_search_filter()
174    }
175    /// <p>The search criteria to be used to return users.</p><note>
176    /// <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>
177    /// </note>
178    pub fn search_criteria(mut self, input: crate::types::UserSearchCriteria) -> Self {
179        self.inner = self.inner.search_criteria(input);
180        self
181    }
182    /// <p>The search criteria to be used to return users.</p><note>
183    /// <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>
184    /// </note>
185    pub fn set_search_criteria(mut self, input: ::std::option::Option<crate::types::UserSearchCriteria>) -> Self {
186        self.inner = self.inner.set_search_criteria(input);
187        self
188    }
189    /// <p>The search criteria to be used to return users.</p><note>
190    /// <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>
191    /// </note>
192    pub fn get_search_criteria(&self) -> &::std::option::Option<crate::types::UserSearchCriteria> {
193        self.inner.get_search_criteria()
194    }
195}
aws_sdk_connect/operation/search_users/builders.rs

aws_sdk_connect/operation/search_users/
builders.rs
