Interface ListUsersRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CognitoIdentityProviderRequest.Builder
,CopyableBuilder<ListUsersRequest.Builder,
,ListUsersRequest> SdkBuilder<ListUsersRequest.Builder,
,ListUsersRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListUsersRequest
-
Method Summary
Modifier and TypeMethodDescriptionattributesToGet
(String... attributesToGet) A JSON array of user attribute names, for examplegiven_name
, that you want Amazon Cognito to include in the response for each user.attributesToGet
(Collection<String> attributesToGet) A JSON array of user attribute names, for examplegiven_name
, that you want Amazon Cognito to include in the response for each user.A filter string of the form "AttributeName Filter-Type "AttributeValue"".Maximum number of users to be returned.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.paginationToken
(String paginationToken) This API operation returns a limited number of results.userPoolId
(String userPoolId) The user pool ID for the user pool on which the search should be performed.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
-
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 anAttributesToGet
parameter, Amazon Cognito returns all attributes for each user.Use
AttributesToGet
with required attributes in your user pool, or in conjunction withFilter
. 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 anAttributesToGet
parameter returns results.- Parameters:
attributesToGet
- A JSON array of user attribute names, for examplegiven_name
, that you want Amazon Cognito to include in the response for each user. When you don't provide anAttributesToGet
parameter, Amazon Cognito returns all attributes for each user.Use
AttributesToGet
with required attributes in your user pool, or in conjunction withFilter
. 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 anAttributesToGet
parameter returns results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 anAttributesToGet
parameter, Amazon Cognito returns all attributes for each user.Use
AttributesToGet
with required attributes in your user pool, or in conjunction withFilter
. 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 anAttributesToGet
parameter returns results.- Parameters:
attributesToGet
- A JSON array of user attribute names, for examplegiven_name
, that you want Amazon Cognito to include in the response for each user. When you don't provide anAttributesToGet
parameter, Amazon Cognito returns all attributes for each user.Use
AttributesToGet
with required attributes in your user pool, or in conjunction withFilter
. 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 anAttributesToGet
parameter returns results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 thelist-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 one attribute. For an advanced search, use a client-side filter with the
--query
parameter of thelist-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.
-
-
overrideConfiguration
ListUsersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListUsersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-