#[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)§
This struct is marked as non-exhaustive
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 theGivenName
,SurName
, orUserName
fields included in a CreateUser API call. For example, querying onMa
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 onMa 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§
source§impl DescribeUsersInput
impl DescribeUsersInput
sourcepub fn authentication_token(&self) -> Option<&str>
pub fn authentication_token(&self) -> Option<&str>
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
sourcepub fn organization_id(&self) -> Option<&str>
pub fn organization_id(&self) -> Option<&str>
The ID of the organization.
sourcepub fn query(&self) -> Option<&str>
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 theGivenName
,SurName
, orUserName
fields included in a CreateUser API call. For example, querying onMa
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 onMa J
only returns Mateo Jackson.
sourcepub fn include(&self) -> Option<&UserFilterType>
pub fn include(&self) -> Option<&UserFilterType>
The state of the users. Specify "ALL" to include inactive users.
sourcepub fn sort(&self) -> Option<&UserSortType>
pub fn sort(&self) -> Option<&UserSortType>
The sorting criteria.
source§impl DescribeUsersInput
impl DescribeUsersInput
sourcepub fn builder() -> DescribeUsersInputBuilder
pub fn builder() -> DescribeUsersInputBuilder
Creates a new builder-style object to manufacture DescribeUsersInput
.
Trait Implementations§
source§impl Clone for DescribeUsersInput
impl Clone for DescribeUsersInput
source§fn clone(&self) -> DescribeUsersInput
fn clone(&self) -> DescribeUsersInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for DescribeUsersInput
impl Debug for DescribeUsersInput
source§impl PartialEq for DescribeUsersInput
impl PartialEq for DescribeUsersInput
source§fn eq(&self, other: &DescribeUsersInput) -> bool
fn eq(&self, other: &DescribeUsersInput) -> bool
self
and other
values to be equal, and is used
by ==
.