Struct DescribeUsersInput

#[non_exhaustive]
pub struct DescribeUsersInput {
    pub authentication_token: Option<String>,
    pub organization_id: Option<String>,
    pub user_ids: Option<String>,
    pub query: Option<String>,
    pub include: Option<UserFilterType>,
    pub order: Option<OrderType>,
    pub sort: Option<UserSortType>,
    pub marker: Option<String>,
    pub limit: Option<i32>,
    pub fields: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

authentication_token: Option<String>

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

organization_id: Option<String>

The ID of the organization.

user_ids: Option<String>

The IDs of the users.

query: Option<String>

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.

include: Option<UserFilterType>

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

order: Option<OrderType>

The order for the results.

sort: Option<UserSortType>

The sorting criteria.

marker: Option<String>

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

limit: Option<i32>

The maximum number of items to return.

fields: Option<String>

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

Implementations

impl DescribeUsersInput

pub fn authentication_token(&self) -> Option<&str>

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

pub fn organization_id(&self) -> Option<&str>

The ID of the organization.

pub fn user_ids(&self) -> Option<&str>

The IDs of the users.

pub fn query(&self) -> Option<&str>

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.

pub fn include(&self) -> Option<&UserFilterType>

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

pub fn order(&self) -> Option<&OrderType>

The order for the results.

pub fn sort(&self) -> Option<&UserSortType>

The sorting criteria.

pub fn marker(&self) -> Option<&str>

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

pub fn limit(&self) -> Option<i32>

The maximum number of items to return.

pub fn fields(&self) -> Option<&str>

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

impl DescribeUsersInput

pub fn builder() -> DescribeUsersInputBuilder

Creates a new builder-style object to manufacture DescribeUsersInput.

Trait Implementations

impl Clone for DescribeUsersInput

fn clone(&self) -> DescribeUsersInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeUsersInput

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

Formats the value using the given formatter.

impl PartialEq for DescribeUsersInput

fn eq(&self, other: &DescribeUsersInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DescribeUsersInput