com.amazonaws.services.cognitoidentityprovider.model

Class ListUsersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.ListUsersRequest

All Implemented Interfaces:

Serializable, Cloneable

public class ListUsersRequest
extends AmazonWebServiceRequest
implements Serializable

Lists the users in the Amazon Cognito user pool.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListUsersRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getAttributesToGet() An array of strings, where each string is the name of a user attribute to be returned for each user in the search results.
String	getFilter() A filter string of the form "AttributeName Filter-Type "AttributeValue"".
Integer	getLimit() Maximum number of users to be returned.
String	getPaginationToken() 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.
String	getUserPoolId() The user pool ID for the user pool on which the search should be performed.
int	hashCode()
void	setAttributesToGet(Collection<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.
void	setFilter(String filter) A filter string of the form "AttributeName Filter-Type "AttributeValue"".
void	setLimit(Integer limit) Maximum number of users to be returned.
void	setPaginationToken(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.
void	setUserPoolId(String userPoolId) The user pool ID for the user pool on which the search should be performed.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListUsersRequest	withAttributesToGet(Collection<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.
ListUsersRequest	withAttributesToGet(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.
ListUsersRequest	withFilter(String filter) A filter string of the form "AttributeName Filter-Type "AttributeValue"".
ListUsersRequest	withLimit(Integer limit) Maximum number of users to be returned.
ListUsersRequest	withPaginationToken(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.
ListUsersRequest	withUserPoolId(String userPoolId) The user pool ID for the user pool on which the search should be performed.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListUsersRequest

public ListUsersRequest()

Method Detail

getUserPoolId

public String getUserPoolId()

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

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Returns:

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

setUserPoolId

public void setUserPoolId(String userPoolId)

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

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

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

withUserPoolId

public ListUsersRequest withUserPoolId(String userPoolId)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getAttributesToGet

public List<String> getAttributesToGet()

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:

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.

setAttributesToGet

public void setAttributesToGet(Collection<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 null, all attributes are returned.

Parameters:

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

withAttributesToGet

public ListUsersRequest withAttributesToGet(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 null, all attributes are returned.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

withAttributesToGet

public ListUsersRequest withAttributesToGet(Collection<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 null, all attributes are returned.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getLimit

public Integer getLimit()

Maximum number of users to be returned.

Constraints:
Range: 0 - 60

Returns:

Maximum number of users to be returned.

setLimit

public void setLimit(Integer limit)

Maximum number of users to be returned.

Constraints:
Range: 0 - 60

Parameters:

limit -

Maximum number of users to be returned.

withLimit

public ListUsersRequest withLimit(Integer limit)

Maximum number of users to be returned.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 0 - 60

Parameters:

limit -

Maximum number of users to be returned.

Returns:

A reference to this updated object so that method calls can be chained together.

getPaginationToken

public String getPaginationToken()

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.

Constraints:
Length: 1 -
Pattern: [\S]+

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.

setPaginationToken

public void setPaginationToken(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.

Constraints:
Length: 1 -
Pattern: [\S]+

Parameters:

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.

withPaginationToken

public ListUsersRequest withPaginationToken(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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 -
Pattern: [\S]+

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getFilter

public String getFilter()

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.

Constraints:
Length: - 256

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

setFilter

public void setFilter(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 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.

Constraints:
Length: - 256

Parameters:

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

withFilter

public ListUsersRequest withFilter(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 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 a reference to this object so that method calls can be chained together.

Constraints:
Length: - 256

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object