pub struct DescribeUsersFluentBuilder { /* 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 DescribeUsersFluentBuilder
impl DescribeUsersFluentBuilder
Sourcepub fn as_input(&self) -> &DescribeUsersInputBuilder
pub fn as_input(&self) -> &DescribeUsersInputBuilder
Access the DescribeUsers as a reference.
Sourcepub async fn send(
self,
) -> Result<DescribeUsersOutput, SdkError<DescribeUsersError, HttpResponse>>
pub async fn send( self, ) -> Result<DescribeUsersOutput, SdkError<DescribeUsersError, HttpResponse>>
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.
Sourcepub fn customize(
self,
) -> CustomizableOperation<DescribeUsersOutput, DescribeUsersError, Self>
pub fn customize( self, ) -> CustomizableOperation<DescribeUsersOutput, DescribeUsersError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn into_paginator(self) -> DescribeUsersPaginator
pub fn into_paginator(self) -> DescribeUsersPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
Sourcepub fn authentication_token(self, input: impl Into<String>) -> Self
pub fn authentication_token(self, input: impl Into<String>) -> Self
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
Sourcepub fn set_authentication_token(self, input: Option<String>) -> Self
pub fn set_authentication_token(self, input: Option<String>) -> Self
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
Sourcepub fn get_authentication_token(&self) -> &Option<String>
pub fn get_authentication_token(&self) -> &Option<String>
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
Sourcepub fn organization_id(self, input: impl Into<String>) -> Self
pub fn organization_id(self, input: impl Into<String>) -> Self
The ID of the organization.
Sourcepub fn set_organization_id(self, input: Option<String>) -> Self
pub fn set_organization_id(self, input: Option<String>) -> Self
The ID of the organization.
Sourcepub fn get_organization_id(&self) -> &Option<String>
pub fn get_organization_id(&self) -> &Option<String>
The ID of the organization.
Sourcepub fn set_user_ids(self, input: Option<String>) -> Self
pub fn set_user_ids(self, input: Option<String>) -> Self
The IDs of the users.
Sourcepub fn get_user_ids(&self) -> &Option<String>
pub fn get_user_ids(&self) -> &Option<String>
The IDs of the users.
Sourcepub fn query(self, input: impl Into<String>) -> Self
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 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 set_query(self, input: Option<String>) -> Self
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 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 get_query(&self) -> &Option<String>
pub fn get_query(&self) -> &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.
Sourcepub fn include(self, input: UserFilterType) -> Self
pub fn include(self, input: UserFilterType) -> Self
The state of the users. Specify "ALL" to include inactive users.
Sourcepub fn set_include(self, input: Option<UserFilterType>) -> Self
pub fn set_include(self, input: Option<UserFilterType>) -> Self
The state of the users. Specify "ALL" to include inactive users.
Sourcepub fn get_include(&self) -> &Option<UserFilterType>
pub fn get_include(&self) -> &Option<UserFilterType>
The state of the users. Specify "ALL" to include inactive users.
Sourcepub fn sort(self, input: UserSortType) -> Self
pub fn sort(self, input: UserSortType) -> Self
The sorting criteria.
Sourcepub fn set_sort(self, input: Option<UserSortType>) -> Self
pub fn set_sort(self, input: Option<UserSortType>) -> Self
The sorting criteria.
Sourcepub fn get_sort(&self) -> &Option<UserSortType>
pub fn get_sort(&self) -> &Option<UserSortType>
The sorting criteria.
Sourcepub fn marker(self, input: impl Into<String>) -> Self
pub fn marker(self, input: impl Into<String>) -> Self
The marker for the next set of results. (You received this marker from a previous call.)
Sourcepub fn set_marker(self, input: Option<String>) -> Self
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.)
Sourcepub fn get_marker(&self) -> &Option<String>
pub fn get_marker(&self) -> &Option<String>
The marker for the next set of results. (You received this marker from a previous call.)
Sourcepub fn fields(self, input: impl Into<String>) -> Self
pub fn fields(self, input: impl Into<String>) -> Self
A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.
Sourcepub fn set_fields(self, input: Option<String>) -> Self
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.
Sourcepub fn get_fields(&self) -> &Option<String>
pub fn get_fields(&self) -> &Option<String>
A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.
Trait Implementations§
Source§impl Clone for DescribeUsersFluentBuilder
impl Clone for DescribeUsersFluentBuilder
Source§fn clone(&self) -> DescribeUsersFluentBuilder
fn clone(&self) -> DescribeUsersFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for DescribeUsersFluentBuilder
impl !RefUnwindSafe for DescribeUsersFluentBuilder
impl Send for DescribeUsersFluentBuilder
impl Sync for DescribeUsersFluentBuilder
impl Unpin for DescribeUsersFluentBuilder
impl !UnwindSafe for DescribeUsersFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);