Class ListUsersRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the request to list users.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The attributes to get from the request to list users.getLimit()
The limit of the request to list users.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.The user pool ID for which you want to list users.The user status.int
hashCode()
void
setAttributesToGet
(Collection<String> attributesToGet) The attributes to get from the request to list users.void
The limit of the request to list users.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 which you want to list users.void
setUserStatus
(UserStatusType userStatus) The user status.void
setUserStatus
(String userStatus) The user status.toString()
Returns a string representation of this object; useful for testing and debugging.withAttributesToGet
(String... attributesToGet) The attributes to get from the request to list users.withAttributesToGet
(Collection<String> attributesToGet) The attributes to get from the request to list users.The limit of the request to list users.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.withUserPoolId
(String userPoolId) The user pool ID for which you want to list users.withUserStatus
(UserStatusType userStatus) The user status.withUserStatus
(String userStatus) The user status.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
ListUsersRequest
public ListUsersRequest()
-
-
Method Details
-
setUserPoolId
The user pool ID for which you want to list users.
- Parameters:
userPoolId
- The user pool ID for which you want to list users.
-
getUserPoolId
The user pool ID for which you want to list users.
- Returns:
- The user pool ID for which you want to list users.
-
withUserPoolId
The user pool ID for which you want to list users.
- Parameters:
userPoolId
- The user pool ID for which you want to list users.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getAttributesToGet
The attributes to get from the request to list users.
- Returns:
- The attributes to get from the request to list users.
-
setAttributesToGet
The attributes to get from the request to list users.
- Parameters:
attributesToGet
- The attributes to get from the request to list users.
-
withAttributesToGet
The attributes to get from the request to list users.
NOTE: This method appends the values to the existing list (if any). Use
setAttributesToGet(java.util.Collection)
orwithAttributesToGet(java.util.Collection)
if you want to override the existing values.- Parameters:
attributesToGet
- The attributes to get from the request to list users.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withAttributesToGet
The attributes to get from the request to list users.
- Parameters:
attributesToGet
- The attributes to get from the request to list users.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLimit
The limit of the request to list users.
- Parameters:
limit
- The limit of the request to list users.
-
getLimit
The limit of the request to list users.
- Returns:
- The limit of the request to list users.
-
withLimit
The limit of the request to list users.
- Parameters:
limit
- The limit of the request to list users.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPaginationToken
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
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
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.
-
setUserStatus
The user status. Can be one of the following:
- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- Parameters:
userStatus
- The user status. Can be one of the following:- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- See Also:
-
getUserStatus
The user status. Can be one of the following:
- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- Returns:
- The user status. Can be one of the following:
- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- See Also:
-
withUserStatus
The user status. Can be one of the following:
- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- Parameters:
userStatus
- The user status. Can be one of the following:- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setUserStatus
The user status. Can be one of the following:
- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- Parameters:
userStatus
- The user status. Can be one of the following:- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- See Also:
-
withUserStatus
The user status. Can be one of the following:
- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- Parameters:
userStatus
- The user status. Can be one of the following:- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-