com.amazonaws.services.cognitoidentityprovider.model

Class ListUserPoolClientsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.ListUserPoolClientsRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

Lists the clients that have been created for 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
ListUserPoolClientsRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Integer	getMaxResults() The maximum number of results you want the request to return when listing the user pool clients.
java.lang.String	getNextToken() 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.
java.lang.String	getUserPoolId() The user pool ID for the user pool where you want to list user pool clients.
int	hashCode()
void	setMaxResults(java.lang.Integer maxResults) The maximum number of results you want the request to return when listing the user pool clients.
void	setNextToken(java.lang.String nextToken) 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	setUserPoolId(java.lang.String userPoolId) The user pool ID for the user pool where you want to list user pool clients.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ListUserPoolClientsRequest	withMaxResults(java.lang.Integer maxResults) The maximum number of results you want the request to return when listing the user pool clients.
ListUserPoolClientsRequest	withNextToken(java.lang.String nextToken) 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.
ListUserPoolClientsRequest	withUserPoolId(java.lang.String userPoolId) The user pool ID for the user pool where you want to list user pool clients.

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

ListUserPoolClientsRequest

public ListUserPoolClientsRequest()

Method Detail

getUserPoolId

public java.lang.String getUserPoolId()

The user pool ID for the user pool where you want to list user pool clients.

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

Returns:

The user pool ID for the user pool where you want to list user pool clients.

setUserPoolId

public void setUserPoolId(java.lang.String userPoolId)

The user pool ID for the user pool where you want to list user pool clients.

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

Parameters:

userPoolId -

The user pool ID for the user pool where you want to list user pool clients.

withUserPoolId

public ListUserPoolClientsRequest withUserPoolId(java.lang.String userPoolId)

The user pool ID for the user pool where you want to list user pool clients.

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 where you want to list user pool clients.

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 results you want the request to return when listing the user pool clients.

Constraints:
Range: 1 - 60

Returns:

The maximum number of results you want the request to return when listing the user pool clients.

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

The maximum number of results you want the request to return when listing the user pool clients.

Constraints:
Range: 1 - 60

Parameters:

maxResults -

The maximum number of results you want the request to return when listing the user pool clients.

withMaxResults

public ListUserPoolClientsRequest withMaxResults(java.lang.Integer maxResults)

The maximum number of results you want the request to return when listing the user pool clients.

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

Constraints:
Range: 1 - 60

Parameters:

maxResults -

The maximum number of results you want the request to return when listing the user pool clients.

Returns:

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

getNextToken

public java.lang.String getNextToken()

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.

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

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.

setNextToken

public void setNextToken(java.lang.String nextToken)

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.

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

Parameters:

nextToken -

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.

withNextToken

public ListUserPoolClientsRequest withNextToken(java.lang.String nextToken)

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 a reference to this object so that method calls can be chained together.

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

Parameters:

nextToken -

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:

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