Struct aws_sdk_workdocs::client::fluent_builders::DescribeUsers

source ·

pub struct DescribeUsers { /* private fields */ }

Expand description

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§

source §

impl DescribeUsers

source

pub async fn customize(
self
) -> Result<CustomizableOperation<DescribeUsers, AwsResponseRetryClassifier>, SdkError<DescribeUsersError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

source

pub async fn send(
self
) -> Result<DescribeUsersOutput, SdkError<DescribeUsersError>>

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.

source

pub fn into_paginator(self) -> DescribeUsersPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

source

pub fn authentication_token(self, input: impl Into<String>) -> Self

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

source

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.

source

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

The ID of the organization.

source

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

The ID of the organization.

source

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

The IDs of the users.

source

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

The IDs of the users.

source

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

A query to filter users by user name. Remember the following about the Userids and Query parameters:

If you don't use either parameter, the API returns a paginated list of all users on the site.
If you use both parameters, the API ignores the Query parameter.
The Userid parameter only returns user names that match a corresponding user ID.
The Query parameter runs a "prefix" search for users by the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on Ma J only returns Mateo Jackson.

source

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

A query to filter users by user name. Remember the following about the Userids and Query parameters:

If you don't use either parameter, the API returns a paginated list of all users on the site.
If you use both parameters, the API ignores the Query parameter.
The Userid parameter only returns user names that match a corresponding user ID.
The Query parameter runs a "prefix" search for users by the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on Ma J only returns Mateo Jackson.