class Aws::CognitoIdentityProvider::Types::ListUsersRequest

Represents the request to list users.

@note When making an API call, you may pass ListUsersRequest

data as a hash:

    {
      user_pool_id: "UserPoolIdType", # required
      attributes_to_get: ["AttributeNameType"],
      limit: 1,
      pagination_token: "SearchPaginationTokenType",
      filter: "UserFilterType",
    }

@!attribute [rw] user_pool_id

The user pool ID for the user pool on which the search should be
performed.
@return [String]

@!attribute [rw] attributes_to_get

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.
@return [Array<String>]

@!attribute [rw] limit

Maximum number of users to be returned.
@return [Integer]

@!attribute [rw] pagination_token

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.
@return [String]

@!attribute [rw] filter

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][1] and [Examples of Using the ListUsers API][2] in the *Amazon
Cognito Developer Guide*.

[1]: https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-using-listusers-api
[2]: https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-listusers-api-examples
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUsersRequest AWS API Documentation

Constants

SENSITIVE