Struct rusoto_cognito_idp::ListUsersRequest
source · [−]pub struct ListUsersRequest {
pub attributes_to_get: Option<Vec<String>>,
pub filter: Option<String>,
pub limit: Option<i64>,
pub pagination_token: Option<String>,
pub user_pool_id: String,
}
Expand description
Represents the request to list users.
Fields
attributes_to_get: Option<Vec<String>>
An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
filter: Option<String>
A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash (\) character. For example, "family_name
= \"Reddy\"".
-
AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
-
Filter-Type: For an exact match, use =, for example, "
given_name
= \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "given_name
^= \"Jon\"". -
AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty, ListUsers
returns all users in the user pool.
You can only search for the following standard attributes:
-
username
(case-sensitive) -
email
-
phone_number
-
name
-
given_name
-
family_name
-
preferred_username
-
cognito:user_status
(called Status in the Console) (case-insensitive) -
status (called Enabled in the Console) (case-sensitive)
-
sub
Custom attributes are not searchable.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
limit: Option<i64>
Maximum number of users to be returned.
pagination_token: Option<String>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
user_pool_id: String
The user pool ID for the user pool on which the search should be performed.
Trait Implementations
sourceimpl Clone for ListUsersRequest
impl Clone for ListUsersRequest
sourcefn clone(&self) -> ListUsersRequest
fn clone(&self) -> ListUsersRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ListUsersRequest
impl Debug for ListUsersRequest
sourceimpl Default for ListUsersRequest
impl Default for ListUsersRequest
sourcefn default() -> ListUsersRequest
fn default() -> ListUsersRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<ListUsersRequest> for ListUsersRequest
impl PartialEq<ListUsersRequest> for ListUsersRequest
sourcefn eq(&self, other: &ListUsersRequest) -> bool
fn eq(&self, other: &ListUsersRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ListUsersRequest) -> bool
fn ne(&self, other: &ListUsersRequest) -> bool
This method tests for !=
.
sourceimpl Serialize for ListUsersRequest
impl Serialize for ListUsersRequest
impl StructuralPartialEq for ListUsersRequest
Auto Trait Implementations
impl RefUnwindSafe for ListUsersRequest
impl Send for ListUsersRequest
impl Sync for ListUsersRequest
impl Unpin for ListUsersRequest
impl UnwindSafe for ListUsersRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more