You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::ListUsersRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListUsersRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

Represents the request to list users.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attributes_to_get ⇒ Array<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.

Returns:

  • (Array<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.

#filter ⇒ 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.

Returns:

  • (String) —

    A filter string of the form \"AttributeName Filter-Type \"AttributeValue\"\".

#limit ⇒ Integer

Maximum number of users to be returned.

Returns:

  • (Integer) —

    Maximum number of users to be returned.

#pagination_token ⇒ 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.

Returns:

  • (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.

Returns:

  • (String) —

    The user pool ID for the user pool on which the search should be performed.