pub struct SearchUsersFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to SearchUsers
.
Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit
is returned in milliseconds.
Implementations§
source§impl SearchUsersFluentBuilder
impl SearchUsersFluentBuilder
sourcepub fn as_input(&self) -> &SearchUsersInputBuilder
pub fn as_input(&self) -> &SearchUsersInputBuilder
Access the SearchUsers as a reference.
sourcepub async fn send(
self
) -> Result<SearchUsersOutput, SdkError<SearchUsersError, HttpResponse>>
pub async fn send( self ) -> Result<SearchUsersOutput, SdkError<SearchUsersError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<SearchUsersOutput, SearchUsersError, Self>, SdkError<SearchUsersError>>
pub async fn customize( self ) -> Result<CustomizableOperation<SearchUsersOutput, SearchUsersError, Self>, SdkError<SearchUsersError>>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> SearchUsersPaginator
pub fn into_paginator(self) -> SearchUsersPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a Stream
.
sourcepub fn instance_id(self, input: impl Into<String>) -> Self
pub fn instance_id(self, input: impl Into<String>) -> Self
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
sourcepub fn set_instance_id(self, input: Option<String>) -> Self
pub fn set_instance_id(self, input: Option<String>) -> Self
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
sourcepub fn get_instance_id(&self) -> &Option<String>
pub fn get_instance_id(&self) -> &Option<String>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
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.
sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
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.
sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of results to return per page.
sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The maximum number of results to return per page.
sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The maximum number of results to return per page.
sourcepub fn search_filter(self, input: UserSearchFilter) -> Self
pub fn search_filter(self, input: UserSearchFilter) -> Self
Filters to be applied to search results.
sourcepub fn set_search_filter(self, input: Option<UserSearchFilter>) -> Self
pub fn set_search_filter(self, input: Option<UserSearchFilter>) -> Self
Filters to be applied to search results.
sourcepub fn get_search_filter(&self) -> &Option<UserSearchFilter>
pub fn get_search_filter(&self) -> &Option<UserSearchFilter>
Filters to be applied to search results.
sourcepub fn search_criteria(self, input: UserSearchCriteria) -> Self
pub fn search_criteria(self, input: UserSearchCriteria) -> Self
The search criteria to be used to return users.
The name
and description
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.
sourcepub fn set_search_criteria(self, input: Option<UserSearchCriteria>) -> Self
pub fn set_search_criteria(self, input: Option<UserSearchCriteria>) -> Self
The search criteria to be used to return users.
The name
and description
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.
sourcepub fn get_search_criteria(&self) -> &Option<UserSearchCriteria>
pub fn get_search_criteria(&self) -> &Option<UserSearchCriteria>
The search criteria to be used to return users.
The name
and description
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.
Trait Implementations§
source§impl Clone for SearchUsersFluentBuilder
impl Clone for SearchUsersFluentBuilder
source§fn clone(&self) -> SearchUsersFluentBuilder
fn clone(&self) -> SearchUsersFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more