com.amazonaws.services.cognitoidentityprovider.model

Class AdminListDevicesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.AdminListDevicesRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

Lists devices, as an administrator.

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Integer	getLimit() The limit of the devices request.
java.lang.String	getPaginationToken() The pagination token.
java.lang.String	getUsername() The user name.
java.lang.String	getUserPoolId() The user pool ID.
int	hashCode()
void	setLimit(java.lang.Integer limit) The limit of the devices request.
void	setPaginationToken(java.lang.String paginationToken) The pagination token.
void	setUsername(java.lang.String username) The user name.
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.
AdminListDevicesRequest	withLimit(java.lang.Integer limit) The limit of the devices request.
AdminListDevicesRequest	withPaginationToken(java.lang.String paginationToken) The pagination token.
AdminListDevicesRequest	withUsername(java.lang.String username) The user name.
AdminListDevicesRequest	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

AdminListDevicesRequest

public AdminListDevicesRequest()

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

getUsername

public java.lang.String getUsername()

The user name.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Returns:

The user name.

setUsername

public void setUsername(java.lang.String username)

The user name.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

The user name.

withUsername

public AdminListDevicesRequest withUsername(java.lang.String username)

The user name.

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

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

The user name.

Returns:

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

getLimit

public java.lang.Integer getLimit()

The limit of the devices request.

Constraints:
Range: 0 - 60

Returns:

The limit of the devices request.

setLimit

public void setLimit(java.lang.Integer limit)

The limit of the devices request.

Constraints:
Range: 0 - 60

Parameters:

limit -

The limit of the devices request.

withLimit

public AdminListDevicesRequest withLimit(java.lang.Integer limit)

The limit of the devices request.

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

Constraints:
Range: 0 - 60

Parameters:

limit -

The limit of the devices request.

Returns:

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

getPaginationToken

public java.lang.String getPaginationToken()

The pagination token.

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

Returns:

The pagination token.

setPaginationToken

public void setPaginationToken(java.lang.String paginationToken)

The pagination token.

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

Parameters:

paginationToken -

The pagination token.

withPaginationToken

public AdminListDevicesRequest withPaginationToken(java.lang.String paginationToken)

The pagination token.

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

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

Parameters:

paginationToken -

The 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