com.amazonaws.services.cognitoidentity.model

Class DescribeIdentityPoolRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentity.model.DescribeIdentityPoolRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeIdentityPoolRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeIdentityPool operation.

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

You must use AWS Developer credentials to call this API.

See Also:

AmazonCognitoIdentity.describeIdentityPool(DescribeIdentityPoolRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeIdentityPoolRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeIdentityPoolRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getIdentityPoolId() An identity pool ID in the format REGION:GUID.
int	hashCode()
void	setIdentityPoolId(String identityPoolId) An identity pool ID in the format REGION:GUID.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeIdentityPoolRequest	withIdentityPoolId(String identityPoolId) An identity pool ID in the format REGION:GUID.

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

DescribeIdentityPoolRequest

public DescribeIdentityPoolRequest()

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

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 DescribeIdentityPoolRequest 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()