com.amazonaws.services.cognitoidentity.model

Class ListIdentitiesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentity.model.ListIdentitiesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListIdentitiesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ListIdentities operation.

Lists the identities in a pool.

You must use AWS Developer credentials to call this API.

See Also:

AmazonCognitoIdentity.listIdentities(ListIdentitiesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListIdentitiesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ListIdentitiesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Boolean	getHideDisabled() An optional boolean parameter that allows you to hide disabled identities.
String	getIdentityPoolId() An identity pool ID in the format REGION:GUID.
Integer	getMaxResults() The maximum number of identities to return.
String	getNextToken() A pagination token.
int	hashCode()
Boolean	isHideDisabled() An optional boolean parameter that allows you to hide disabled identities.
void	setHideDisabled(Boolean hideDisabled) An optional boolean parameter that allows you to hide disabled identities.
void	setIdentityPoolId(String identityPoolId) An identity pool ID in the format REGION:GUID.
void	setMaxResults(Integer maxResults) The maximum number of identities to return.
void	setNextToken(String nextToken) A pagination token.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListIdentitiesRequest	withHideDisabled(Boolean hideDisabled) An optional boolean parameter that allows you to hide disabled identities.
ListIdentitiesRequest	withIdentityPoolId(String identityPoolId) An identity pool ID in the format REGION:GUID.
ListIdentitiesRequest	withMaxResults(Integer maxResults) The maximum number of identities to return.
ListIdentitiesRequest	withNextToken(String nextToken) A pagination token.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

ListIdentitiesRequest

public ListIdentitiesRequest()

Method Detail

getIdentityPoolId

public String getIdentityPoolId()

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Returns:

An identity pool ID in the format REGION:GUID.

setIdentityPoolId

public void setIdentityPoolId(String identityPoolId)

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityPoolId - An identity pool ID in the format REGION:GUID.

withIdentityPoolId

public ListIdentitiesRequest withIdentityPoolId(String identityPoolId)

An identity pool ID in the format REGION:GUID.

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

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityPoolId - An identity pool ID in the format REGION:GUID.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public Integer getMaxResults()

The maximum number of identities to return.

Constraints:
Range: 1 - 60

Returns:

The maximum number of identities to return.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of identities to return.

Constraints:
Range: 1 - 60

Parameters:

maxResults - The maximum number of identities to return.

withMaxResults

public ListIdentitiesRequest withMaxResults(Integer maxResults)

The maximum number of identities to return.

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

Constraints:
Range: 1 - 60

Parameters:

maxResults - The maximum number of identities to return.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

A pagination token.

Constraints:
Length: 1 -
Pattern: [\S]+

Returns:

A pagination token.

setNextToken

public void setNextToken(String nextToken)

A pagination token.

Constraints:
Length: 1 -
Pattern: [\S]+

Parameters:

nextToken - A pagination token.

withNextToken

public ListIdentitiesRequest withNextToken(String nextToken)

A pagination token.

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

Constraints:
Length: 1 -
Pattern: [\S]+

Parameters:

nextToken - A pagination token.

Returns:

A reference to this updated object so that method calls can be chained together.

isHideDisabled

public Boolean isHideDisabled()

An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

Returns:

An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

setHideDisabled

public void setHideDisabled(Boolean hideDisabled)

An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

Parameters:

hideDisabled - An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

withHideDisabled

public ListIdentitiesRequest withHideDisabled(Boolean hideDisabled)

An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

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

Parameters:

hideDisabled - An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

Returns:

A reference to this updated object so that method calls can be chained together.

getHideDisabled

public Boolean getHideDisabled()

An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

Returns:

An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public ListIdentitiesRequest 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 class AmazonWebServiceRequest

See Also:

Object.clone()