com.amazonaws.services.cognitoidentityprovider.model

Class ListIdentityProvidersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.ListIdentityProvidersRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

Lists information about all IdPs for a 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
ListIdentityProvidersRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Integer	getMaxResults() The maximum number of IdPs to return.
java.lang.String	getNextToken() A pagination token.
java.lang.String	getUserPoolId() The user pool ID.
int	hashCode()
void	setMaxResults(java.lang.Integer maxResults) The maximum number of IdPs to return.
void	setNextToken(java.lang.String nextToken) A pagination token.
void	setUserPoolId(java.lang.String userPoolId) The user pool ID.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ListIdentityProvidersRequest	withMaxResults(java.lang.Integer maxResults) The maximum number of IdPs to return.
ListIdentityProvidersRequest	withNextToken(java.lang.String nextToken) A pagination token.
ListIdentityProvidersRequest	withUserPoolId(java.lang.String userPoolId) The user pool ID.

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

ListIdentityProvidersRequest

public ListIdentityProvidersRequest()

Method Detail

getUserPoolId

public java.lang.String getUserPoolId()

The user pool ID.

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

Returns:

The user pool ID.

setUserPoolId

public void setUserPoolId(java.lang.String userPoolId)

The user pool ID.

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

Parameters:

userPoolId -

The user pool ID.

withUserPoolId

public ListIdentityProvidersRequest withUserPoolId(java.lang.String userPoolId)

The user pool ID.

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.

Returns:

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

getMaxResults

public java.lang.Integer getMaxResults()

The maximum number of IdPs to return.

Constraints:
Range: 0 - 60

Returns:

The maximum number of IdPs to return.

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

The maximum number of IdPs to return.

Constraints:
Range: 0 - 60

Parameters:

maxResults -

The maximum number of IdPs to return.

withMaxResults

public ListIdentityProvidersRequest withMaxResults(java.lang.Integer maxResults)

The maximum number of IdPs to return.

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

Constraints:
Range: 0 - 60

Parameters:

maxResults -

The maximum number of IdPs to return.

Returns:

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

getNextToken

public java.lang.String getNextToken()

A pagination token.

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

Returns:

A pagination token.

setNextToken

public void setNextToken(java.lang.String nextToken)

A pagination token.

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

Parameters:

nextToken -

A pagination token.

withNextToken

public ListIdentityProvidersRequest withNextToken(java.lang.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.

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