public static interface ListUsersRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<ListUsersRequest.Builder,ListUsersRequest>
| Modifier and Type | Method and Description |
|---|---|
ListUsersRequest.Builder |
attributesToGet(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.Builder |
attributesToGet(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.Builder |
filter(String filter)
A filter string of the form "AttributeName Filter-Type "AttributeValue"".
|
ListUsersRequest.Builder |
limit(Integer limit)
Maximum number of users to be returned.
|
ListUsersRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
ListUsersRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
ListUsersRequest.Builder |
paginationToken(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.Builder |
userPoolId(String userPoolId)
The user pool ID for the user pool on which the search should be performed.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildListUsersRequest.Builder userPoolId(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.ListUsersRequest.Builder attributesToGet(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.
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.ListUsersRequest.Builder attributesToGet(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.
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.ListUsersRequest.Builder limit(Integer limit)
Maximum number of users to be returned.
limit - Maximum number of users to be returned.ListUsersRequest.Builder paginationToken(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.
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.Builder filter(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.
ListUsersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderListUsersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.