com.amazonaws.services.cognitoidp.model

Class ListUsersResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.cognitoidp.model.ListUsersResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListUsersResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

The response from the request to list users.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListUsersResult()

Method Summary

Modifier and Type	Method and Description
ListUsersResult	clone()
boolean	equals(Object obj)
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.
List<UserType>	getUsers() A list of the user pool users, and their attributes, that match your query.
int	hashCode()
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	setUsers(Collection<UserType> users) A list of the user pool users, and their attributes, that match your query.
String	toString() Returns a string representation of this object.
ListUsersResult	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.
ListUsersResult	withUsers(Collection<UserType> users) A list of the user pool users, and their attributes, that match your query.
ListUsersResult	withUsers(UserType... users) A list of the user pool users, and their attributes, that match your query.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListUsersResult

public ListUsersResult()

Method Detail

getUsers

public List<UserType> getUsers()

A list of the user pool users, and their attributes, that match your query.

Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.

Returns:

A list of the user pool users, and their attributes, that match your query.

Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.

setUsers

public void setUsers(Collection<UserType> users)

A list of the user pool users, and their attributes, that match your query.

Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.

Parameters:

users - A list of the user pool users, and their attributes, that match your query.

Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.

withUsers

public ListUsersResult withUsers(UserType... users)

A list of the user pool users, and their attributes, that match your query.

Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.

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

Parameters:

users - A list of the user pool users, and their attributes, that match your query.

Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.

Returns:

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

withUsers

public ListUsersResult withUsers(Collection<UserType> users)

A list of the user pool users, and their attributes, that match your query.

Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.

Parameters:

users - A list of the user pool users, and their attributes, that match your query.

Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.

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 ListUsersResult 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.

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 ListUsersResult clone()

Overrides:

clone in class Object