com.amazonaws.services.cognitoidp.model

Class AdminListDevicesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.AdminListDevicesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AdminListDevicesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the request to list devices, as an administrator.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AdminListDevicesRequest()

Method Summary

Modifier and Type	Method and Description
AdminListDevicesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Integer	getLimit() The limit of the devices request.
String	getPaginationToken() This API operation returns a limited number of results.
String	getUsername() The username of the user that you want to query or modify.
String	getUserPoolId() The user pool ID.
int	hashCode()
void	setLimit(Integer limit) The limit of the devices request.
void	setPaginationToken(String paginationToken) This API operation returns a limited number of results.
void	setUsername(String username) The username of the user that you want to query or modify.
void	setUserPoolId(String userPoolId) The user pool ID.
String	toString() Returns a string representation of this object.
AdminListDevicesRequest	withLimit(Integer limit) The limit of the devices request.
AdminListDevicesRequest	withPaginationToken(String paginationToken) This API operation returns a limited number of results.
AdminListDevicesRequest	withUsername(String username) The username of the user that you want to query or modify.
AdminListDevicesRequest	withUserPoolId(String userPoolId) The user pool ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AdminListDevicesRequest

public AdminListDevicesRequest()

Method Detail

setUserPoolId

public void setUserPoolId(String userPoolId)

The user pool ID.

Parameters:

userPoolId - The user pool ID.

getUserPoolId

public String getUserPoolId()

The user pool ID.

Returns:

The user pool ID.

withUserPoolId

public AdminListDevicesRequest withUserPoolId(String userPoolId)

The user pool ID.

Parameters:

userPoolId - The user pool ID.

Returns:

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

setUsername

public void setUsername(String username)

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Parameters:

username - The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

getUsername

public String getUsername()

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Returns:

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

withUsername

public AdminListDevicesRequest withUsername(String username)

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Parameters:

username - The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Returns:

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

setLimit

public void setLimit(Integer limit)

The limit of the devices request.

Parameters:

limit - The limit of the devices request.

getLimit

public Integer getLimit()

The limit of the devices request.

Returns:

The limit of the devices request.

withLimit

public AdminListDevicesRequest withLimit(Integer limit)

The limit of the devices request.

Parameters:

limit - The limit of the devices request.

Returns:

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

setPaginationToken

public void setPaginationToken(String paginationToken)

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Parameters:

paginationToken - This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

getPaginationToken

public String getPaginationToken()

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Returns:

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

withPaginationToken

public AdminListDevicesRequest withPaginationToken(String paginationToken)

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Parameters:

paginationToken - This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AdminListDevicesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()