Struct aws_sdk_cognitoidentityprovider::operation::list_users::ListUsersOutput

#[non_exhaustive]
pub struct ListUsersOutput {
    pub users: Option<Vec<UserType>>,
    pub pagination_token: Option<String>,
    /* private fields */
}

The response from the request to list users.

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.

users: Option<Vec<UserType>>

A list of the user pool users, and their attributes, that match your query.

Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.

pagination_token: Option<String>

The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.

Implementations

impl ListUsersOutput

pub fn users(&self) -> &[UserType]

A list of the user pool users, and their attributes, that match your query.

Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .users.is_none().

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

The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.

impl ListUsersOutput

pub fn builder() -> ListUsersOutputBuilder

Creates a new builder-style object to manufacture ListUsersOutput.

Trait Implementations

impl Clone for ListUsersOutput

fn clone(&self) -> ListUsersOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListUsersOutput

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

Formats the value using the given formatter.

impl PartialEq for ListUsersOutput

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

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

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.

impl RequestId for ListUsersOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for ListUsersOutput