Struct aws_sdk_alexaforbusiness::client::fluent_builders::SearchUsers

pub struct SearchUsers<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to SearchUsers.

Searches users and lists the ones that meet a set of filter and sort criteria.

Implementations

impl<C, M, R> SearchUsers<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<SearchUsersOutput, SdkError<SearchUsersError>> where
    R::Policy: SmithyRetryPolicy<SearchUsersInputOperationOutputAlias, SearchUsersOutput, SearchUsersError, SearchUsersInputOperationRetryAlias>, 

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.

pub fn next_token(self, inp: impl Into<String>) -> Self

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.

pub fn set_next_token(self, input: Option<String>) -> Self

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.

pub fn max_results(self, inp: i32) -> Self

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.

pub fn filters(self, inp: impl Into<Filter>) -> Self

Appends an item to Filters.

To override the contents of this collection use set_filters.

The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self

The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

pub fn sort_criteria(self, inp: impl Into<Sort>) -> Self

Appends an item to SortCriteria.

To override the contents of this collection use set_sort_criteria.

The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

pub fn set_sort_criteria(self, input: Option<Vec<Sort>>) -> Self

The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for SearchUsers<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.