#[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
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§

source§

impl DescribeUsersInput

source

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

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

source

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

The ID of the organization.

source

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

The IDs of the users.

source

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.

source

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

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

source

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

The order for the results.

source

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

The sorting criteria.

source

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

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

source

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

The maximum number of items to return.

source

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

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

source§

impl DescribeUsersInput

source

pub fn builder() -> DescribeUsersInputBuilder

Creates a new builder-style object to manufacture DescribeUsersInput.

Trait Implementations§

source§

impl Clone for DescribeUsersInput

source§

fn clone(&self) -> DescribeUsersInput

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for DescribeUsersInput

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for DescribeUsersInput

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for DescribeUsersInput

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more