com.amazonaws.services.cognitoidentityprovider.model

Class DescribeUserPoolRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.DescribeUserPoolRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DescribeUserPoolRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Returns the configuration information and metadata of the specified user pool.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeUserPoolRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getUserPoolId() The user pool ID for the user pool you want to describe.
int	hashCode()
void	setUserPoolId(java.lang.String userPoolId) The user pool ID for the user pool you want to describe.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeUserPoolRequest	withUserPoolId(java.lang.String userPoolId) The user pool ID for the user pool you want to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeUserPoolRequest

public DescribeUserPoolRequest()

Method Detail

getUserPoolId

public java.lang.String getUserPoolId()

The user pool ID for the user pool you want to describe.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Returns:

The user pool ID for the user pool you want to describe.

setUserPoolId

public void setUserPoolId(java.lang.String userPoolId)

The user pool ID for the user pool you want to describe.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID for the user pool you want to describe.

withUserPoolId

public DescribeUserPoolRequest withUserPoolId(java.lang.String userPoolId)

The user pool ID for the user pool you want to describe.

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

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID for the user pool you want to describe.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object