Struct aws_sdk_workdocs::client::fluent_builders::DescribeUsers

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

Fluent builder constructing a request to DescribeUsers.

Describes the specified users. You can describe all users or filter the results (for example, by status or organization).

By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.

Implementations

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

pub async fn send(
    self
) -> Result<DescribeUsersOutput, SdkError<DescribeUsersError>> where
    R::Policy: SmithyRetryPolicy<DescribeUsersInputOperationOutputAlias, DescribeUsersOutput, DescribeUsersError, DescribeUsersInputOperationRetryAlias>, 

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 authentication_token(self, inp: impl Into<String>) -> Self

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

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

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

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

The ID of the organization.

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

The ID of the organization.

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

The IDs of the users.

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

The IDs of the users.

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

A query to filter users by user name.

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

A query to filter users by user name.

pub fn include(self, inp: UserFilterType) -> Self

The state of the users. Specify "ALL" to include inactive users.

pub fn set_include(self, input: Option<UserFilterType>) -> Self

The state of the users. Specify "ALL" to include inactive users.

pub fn order(self, inp: OrderType) -> Self

The order for the results.

pub fn set_order(self, input: Option<OrderType>) -> Self

The order for the results.

pub fn sort(self, inp: UserSortType) -> Self

The sorting criteria.

pub fn set_sort(self, input: Option<UserSortType>) -> Self

The sorting criteria.

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

The marker for the next set of results. (You received this marker from a previous call.)

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

The marker for the next set of results. (You received this marker from a previous call.)

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

The maximum number of items to return.

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

The maximum number of items to return.

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

A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

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

A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

Trait Implementations

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

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

Formats the value using the given formatter.