Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class ListUsersRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.ListUsersRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<ListUsersRequest.Builder,ListUsersRequest>

@Generated("software.amazon.awssdk:codegen")
public class ListUsersRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<ListUsersRequest.Builder,ListUsersRequest>

Represents the request to list users.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListUsersRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
List<String>	attributesToGet()	An array of strings, where each string is the name of a user attribute to be returned for each user in the search results.
static ListUsersRequest.Builder	builder()
boolean	equals(Object obj)
String	filter()	A filter string of the form "AttributeName Filter-Type "AttributeValue"".
int	hashCode()
Integer	limit()	Maximum number of users to be returned.
String	paginationToken()	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.
static Class<? extends ListUsersRequest.Builder>	serializableBuilderClass()
ListUsersRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userPoolId()	The user pool ID for the user pool on which the search should be performed.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

userPoolId

public String userPoolId()

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

Returns:

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

attributesToGet

public List<String> attributesToGet()

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 empty, all attributes are returned.

Returns:

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 empty, all attributes are returned.

limit

public Integer limit()

Maximum number of users to be returned.

Returns:

Maximum number of users to be returned.

paginationToken

public String paginationToken()

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:

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.

filter

public String 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 Enabled in the Console) (case-sensitive)

• status (case-insensitive)

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:

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 Enabled in the Console) (case-sensitive)

• status (case-insensitive)

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.

toBuilder

public ListUsersRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListUsersRequest.Builder,ListUsersRequest>

Returns:

a builder for type T

builder

public static ListUsersRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListUsersRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object