com.amazonaws.services.cognitoidp.model

Class ListUsersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.ListUsersRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListUsersRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the request to list users.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListUsersRequest()

Method Summary

Modifier and Type	Method and Description
ListUsersRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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.
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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListUsersRequest

public ListUsersRequest()

Method Detail

setUserPoolId

public void setUserPoolId(String userPoolId)

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

Parameters:

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

getUserPoolId

public String getUserPoolId()

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.

withUserPoolId

public ListUsersRequest withUserPoolId(String userPoolId)

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

Parameters:

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

Returns:

Returns a reference to this 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.

NOTE: This method appends the values to the existing list (if any). Use setAttributesToGet(java.util.Collection) or withAttributesToGet(java.util.Collection) if you want to override the existing values.

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:

Returns a reference to this 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.

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:

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

setLimit

public void setLimit(Integer limit)

Maximum number of users to be returned.

Parameters:

limit - Maximum number of users to be returned.

getLimit

public Integer getLimit()

Maximum number of users to be returned.

Returns:

Maximum number of users to be returned.

withLimit

public ListUsersRequest withLimit(Integer limit)

Maximum number of users to be returned.

Parameters:

limit - Maximum number of users to be returned.

Returns:

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

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.

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.

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.

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.

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.

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:

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

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 aren't searchable.

You can also list users with a client-side filter. The server-side filter matches no more than 1 attribute. For an advanced search, use a client-side filter with the --query parameter of the list-users action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result.

For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface User Guide.

For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.

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 aren't searchable.

You can also list users with a client-side filter. The server-side filter matches no more than 1 attribute. For an advanced search, use a client-side filter with the --query parameter of the list-users action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result.

For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface User Guide.

For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.

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 aren't searchable.

You can also list users with a client-side filter. The server-side filter matches no more than 1 attribute. For an advanced search, use a client-side filter with the --query parameter of the list-users action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result.

For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface User Guide.

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 Status in the Console) (case-insensitive)

• status (called Enabled in the Console) (case-sensitive)

• sub

Custom attributes aren't searchable.

You can also list users with a client-side filter. The server-side filter matches no more than 1 attribute. For an advanced search, use a client-side filter with the --query parameter of the list-users action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result.

For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface User Guide.

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 aren't searchable.

You can also list users with a client-side filter. The server-side filter matches no more than 1 attribute. For an advanced search, use a client-side filter with the --query parameter of the list-users action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result.

For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface User Guide.

For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.

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 aren't searchable.

You can also list users with a client-side filter. The server-side filter matches no more than 1 attribute. For an advanced search, use a client-side filter with the --query parameter of the list-users action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result.

For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface User Guide.

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:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListUsersRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()