@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ListUsersRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the request to list users.
NOOP| Constructor and Description |
|---|
ListUsersRequest() |
| 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()
A JSON array of user attribute names, for example
given_name, that you want Amazon Cognito to
include in the response for each user. |
String |
getFilter()
A filter string of the form "AttributeName Filter-Type "AttributeValue"".
|
Integer |
getLimit()
Maximum number of users to be returned.
|
String |
getPaginationToken()
This API operation returns a limited number of results.
|
String |
getUserPoolId()
The user pool ID for the user pool on which the search should be performed.
|
int |
hashCode() |
void |
setAttributesToGet(Collection<String> attributesToGet)
A JSON array of user attribute names, for example
given_name, that you want Amazon Cognito to
include in the response for each user. |
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)
This API operation returns a limited number of results.
|
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)
A JSON array of user attribute names, for example
given_name, that you want Amazon Cognito to
include in the response for each user. |
ListUsersRequest |
withAttributesToGet(String... attributesToGet)
A JSON array of user attribute names, for example
given_name, that you want Amazon Cognito to
include in the response for each user. |
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)
This API operation returns a limited number of results.
|
ListUsersRequest |
withUserPoolId(String userPoolId)
The user pool ID for the user pool on which the search should be performed.
|
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, withSdkRequestTimeoutpublic void setUserPoolId(String userPoolId)
The user pool ID for the user pool on which the search should be performed.
userPoolId - The user pool ID for the user pool on which the search should be performed.public String getUserPoolId()
The user pool ID for the user pool on which the search should be performed.
public ListUsersRequest withUserPoolId(String userPoolId)
The user pool ID for the user pool on which the search should be performed.
userPoolId - The user pool ID for the user pool on which the search should be performed.public List<String> getAttributesToGet()
A JSON array of user attribute names, for example given_name, that you want Amazon Cognito to
include in the response for each user. When you don't provide an AttributesToGet parameter, Amazon
Cognito returns all attributes for each user.
Use AttributesToGet with required attributes in your user pool, or in conjunction with
Filter. Amazon Cognito returns an error if not all users in the results have set a value for the
attribute you request. Attributes that you can't filter on, including custom attributes, must have a value set in
every user profile before an AttributesToGet parameter returns results.
given_name, that you want Amazon Cognito
to include in the response for each user. When you don't provide an AttributesToGet
parameter, Amazon Cognito returns all attributes for each user.
Use AttributesToGet with required attributes in your user pool, or in conjunction with
Filter. Amazon Cognito returns an error if not all users in the results have set a value for
the attribute you request. Attributes that you can't filter on, including custom attributes, must have a
value set in every user profile before an AttributesToGet parameter returns results.
public void setAttributesToGet(Collection<String> attributesToGet)
A JSON array of user attribute names, for example given_name, that you want Amazon Cognito to
include in the response for each user. When you don't provide an AttributesToGet parameter, Amazon
Cognito returns all attributes for each user.
Use AttributesToGet with required attributes in your user pool, or in conjunction with
Filter. Amazon Cognito returns an error if not all users in the results have set a value for the
attribute you request. Attributes that you can't filter on, including custom attributes, must have a value set in
every user profile before an AttributesToGet parameter returns results.
attributesToGet - A JSON array of user attribute names, for example given_name, that you want Amazon Cognito to
include in the response for each user. When you don't provide an AttributesToGet parameter,
Amazon Cognito returns all attributes for each user.
Use AttributesToGet with required attributes in your user pool, or in conjunction with
Filter. Amazon Cognito returns an error if not all users in the results have set a value for
the attribute you request. Attributes that you can't filter on, including custom attributes, must have a
value set in every user profile before an AttributesToGet parameter returns results.
public ListUsersRequest withAttributesToGet(String... attributesToGet)
A JSON array of user attribute names, for example given_name, that you want Amazon Cognito to
include in the response for each user. When you don't provide an AttributesToGet parameter, Amazon
Cognito returns all attributes for each user.
Use AttributesToGet with required attributes in your user pool, or in conjunction with
Filter. Amazon Cognito returns an error if not all users in the results have set a value for the
attribute you request. Attributes that you can't filter on, including custom attributes, must have a value set in
every user profile before an AttributesToGet parameter returns results.
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.
attributesToGet - A JSON array of user attribute names, for example given_name, that you want Amazon Cognito to
include in the response for each user. When you don't provide an AttributesToGet parameter,
Amazon Cognito returns all attributes for each user.
Use AttributesToGet with required attributes in your user pool, or in conjunction with
Filter. Amazon Cognito returns an error if not all users in the results have set a value for
the attribute you request. Attributes that you can't filter on, including custom attributes, must have a
value set in every user profile before an AttributesToGet parameter returns results.
public ListUsersRequest withAttributesToGet(Collection<String> attributesToGet)
A JSON array of user attribute names, for example given_name, that you want Amazon Cognito to
include in the response for each user. When you don't provide an AttributesToGet parameter, Amazon
Cognito returns all attributes for each user.
Use AttributesToGet with required attributes in your user pool, or in conjunction with
Filter. Amazon Cognito returns an error if not all users in the results have set a value for the
attribute you request. Attributes that you can't filter on, including custom attributes, must have a value set in
every user profile before an AttributesToGet parameter returns results.
attributesToGet - A JSON array of user attribute names, for example given_name, that you want Amazon Cognito to
include in the response for each user. When you don't provide an AttributesToGet parameter,
Amazon Cognito returns all attributes for each user.
Use AttributesToGet with required attributes in your user pool, or in conjunction with
Filter. Amazon Cognito returns an error if not all users in the results have set a value for
the attribute you request. Attributes that you can't filter on, including custom attributes, must have a
value set in every user profile before an AttributesToGet parameter returns results.
public void setLimit(Integer limit)
Maximum number of users to be returned.
limit - Maximum number of users to be returned.public Integer getLimit()
Maximum number of users to be returned.
public ListUsersRequest withLimit(Integer limit)
Maximum number of users to be returned.
limit - Maximum number of users to be returned.public void setPaginationToken(String paginationToken)
This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.
paginationToken - This API operation returns a limited number of results. The pagination token is an identifier that you can
present in an additional API request with the same parameters. When you include the pagination token,
Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new
pagination token. By use of this token, you can paginate through the full list of items.public String getPaginationToken()
This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.
public ListUsersRequest withPaginationToken(String paginationToken)
This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.
paginationToken - This API operation returns a limited number of results. The pagination token is an identifier that you can
present in an additional API request with the same parameters. When you include the pagination token,
Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new
pagination token. By use of this token, you can paginate through the full list of items.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 one 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.
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 one
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.
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 one 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.
\) 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 one
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.
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 one 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.
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 one
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.
public String toString()
toString in class ObjectObject.toString()public ListUsersRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()