com.amazonaws.services.cognitoidentityprovider.model

Class AdminUpdateDeviceStatusRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.AdminUpdateDeviceStatusRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

Updates the device status 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
AdminUpdateDeviceStatusRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDeviceKey() The device key.
java.lang.String	getDeviceRememberedStatus() The status indicating whether a device has been remembered or not.
java.lang.String	getUsername() The user name.
java.lang.String	getUserPoolId() The user pool ID.
int	hashCode()
void	setDeviceKey(java.lang.String deviceKey) The device key.
void	setDeviceRememberedStatus(DeviceRememberedStatusType deviceRememberedStatus) The status indicating whether a device has been remembered or not.
void	setDeviceRememberedStatus(java.lang.String deviceRememberedStatus) The status indicating whether a device has been remembered or not.
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.
AdminUpdateDeviceStatusRequest	withDeviceKey(java.lang.String deviceKey) The device key.
AdminUpdateDeviceStatusRequest	withDeviceRememberedStatus(DeviceRememberedStatusType deviceRememberedStatus) The status indicating whether a device has been remembered or not.
AdminUpdateDeviceStatusRequest	withDeviceRememberedStatus(java.lang.String deviceRememberedStatus) The status indicating whether a device has been remembered or not.
AdminUpdateDeviceStatusRequest	withUsername(java.lang.String username) The user name.
AdminUpdateDeviceStatusRequest	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

AdminUpdateDeviceStatusRequest

public AdminUpdateDeviceStatusRequest()

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

getDeviceKey

public java.lang.String getDeviceKey()

The device key.

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

Returns:

The device key.

setDeviceKey

public void setDeviceKey(java.lang.String deviceKey)

The device key.

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

Parameters:

deviceKey -

The device key.

withDeviceKey

public AdminUpdateDeviceStatusRequest withDeviceKey(java.lang.String deviceKey)

The device key.

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

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

Parameters:

deviceKey -

The device key.

Returns:

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

getDeviceRememberedStatus

public java.lang.String getDeviceRememberedStatus()

The status indicating whether a device has been remembered or not.

Constraints:
Allowed Values: remembered, not_remembered

Returns:

The status indicating whether a device has been remembered or not.

See Also:

DeviceRememberedStatusType

setDeviceRememberedStatus

public void setDeviceRememberedStatus(java.lang.String deviceRememberedStatus)

The status indicating whether a device has been remembered or not.

Constraints:
Allowed Values: remembered, not_remembered

Parameters:

deviceRememberedStatus -

The status indicating whether a device has been remembered or not.

See Also:

DeviceRememberedStatusType

withDeviceRememberedStatus

public AdminUpdateDeviceStatusRequest withDeviceRememberedStatus(java.lang.String deviceRememberedStatus)

The status indicating whether a device has been remembered or not.

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

Constraints:
Allowed Values: remembered, not_remembered

Parameters:

deviceRememberedStatus -

The status indicating whether a device has been remembered or not.

Returns:

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

See Also:

DeviceRememberedStatusType

setDeviceRememberedStatus

public void setDeviceRememberedStatus(DeviceRememberedStatusType deviceRememberedStatus)

The status indicating whether a device has been remembered or not.

Constraints:
Allowed Values: remembered, not_remembered

Parameters:

deviceRememberedStatus -

The status indicating whether a device has been remembered or not.

See Also:

DeviceRememberedStatusType

withDeviceRememberedStatus

public AdminUpdateDeviceStatusRequest withDeviceRememberedStatus(DeviceRememberedStatusType deviceRememberedStatus)

The status indicating whether a device has been remembered or not.

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

Constraints:
Allowed Values: remembered, not_remembered

Parameters:

deviceRememberedStatus -

The status indicating whether a device has been remembered or not.

Returns:

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

See Also:

DeviceRememberedStatusType

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