com.amazonaws.services.cognitoidentityprovider.model

Class ForgetDeviceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.ForgetDeviceRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

Forgets the specified device.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ForgetDeviceRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAccessToken() A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.
java.lang.String	getDeviceKey() The device key.
int	hashCode()
void	setAccessToken(java.lang.String accessToken) A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.
void	setDeviceKey(java.lang.String deviceKey) The device key.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ForgetDeviceRequest	withAccessToken(java.lang.String accessToken) A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.
ForgetDeviceRequest	withDeviceKey(java.lang.String deviceKey) The device key.

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

ForgetDeviceRequest

public ForgetDeviceRequest()

Method Detail

getAccessToken

public java.lang.String getAccessToken()

A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Returns:

A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.

setAccessToken

public void setAccessToken(java.lang.String accessToken)

A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Parameters:

accessToken -

A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.

withAccessToken

public ForgetDeviceRequest withAccessToken(java.lang.String accessToken)

A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.

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

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Parameters:

accessToken -

A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.

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

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