ConfirmDeviceRequest (aws-android-sdk-cognitoidentityprovider 2.81.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentityprovider.model.ConfirmDeviceRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class ConfirmDeviceRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Confirms tracking of the device. This API call is the call that begins device tracking.

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

ConfirmDeviceRequest()

Constructors
Constructor and Description
`ConfirmDeviceRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
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 device you want to confirm.
`java.lang.String`	`getDeviceKey()` The device key.
`java.lang.String`	`getDeviceName()` The device name.
`DeviceSecretVerifierConfigType`	`getDeviceSecretVerifierConfig()` The configuration of the device secret verifier.
`int`	`hashCode()`
`void`	`setAccessToken(java.lang.String accessToken)` A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
`void`	`setDeviceKey(java.lang.String deviceKey)` The device key.
`void`	`setDeviceName(java.lang.String deviceName)` The device name.
`void`	`setDeviceSecretVerifierConfig(DeviceSecretVerifierConfigType deviceSecretVerifierConfig)` The configuration of the device secret verifier.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ConfirmDeviceRequest`	`withAccessToken(java.lang.String accessToken)` A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
`ConfirmDeviceRequest`	`withDeviceKey(java.lang.String deviceKey)` The device key.
`ConfirmDeviceRequest`	`withDeviceName(java.lang.String deviceName)` The device name.
`ConfirmDeviceRequest`	`withDeviceSecretVerifierConfig(DeviceSecretVerifierConfigType deviceSecretVerifierConfig)` The configuration of the device secret verifier.

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
  - ConfirmDeviceRequest
```
public ConfirmDeviceRequest()
```
- Method Detail
  - getAccessToken
```
public java.lang.String getAccessToken()
```
    A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
    
    Constraints:
    Pattern: [A-Za-z0-9-_=.]+
    
    Returns:
    
    A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
  - setAccessToken
```
public void setAccessToken(java.lang.String accessToken)
```
    A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
    
    Constraints:
    Pattern: [A-Za-z0-9-_=.]+
    
    Parameters:
    
    accessToken -
    A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
  - withAccessToken
```
public ConfirmDeviceRequest withAccessToken(java.lang.String accessToken)
```
    A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
    
    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 device you want to confirm.
    
    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 ConfirmDeviceRequest 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.
  - getDeviceSecretVerifierConfig
```
public DeviceSecretVerifierConfigType getDeviceSecretVerifierConfig()
```
    The configuration of the device secret verifier.
    
    Returns:
    
    The configuration of the device secret verifier.
  - setDeviceSecretVerifierConfig
```
public void setDeviceSecretVerifierConfig(DeviceSecretVerifierConfigType deviceSecretVerifierConfig)
```
    The configuration of the device secret verifier.
    
    Parameters:
    
    deviceSecretVerifierConfig -
    The configuration of the device secret verifier.
  - withDeviceSecretVerifierConfig
```
public ConfirmDeviceRequest withDeviceSecretVerifierConfig(DeviceSecretVerifierConfigType deviceSecretVerifierConfig)
```
    The configuration of the device secret verifier.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    deviceSecretVerifierConfig -
    The configuration of the device secret verifier.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDeviceName
```
public java.lang.String getDeviceName()
```
    The device name.
    
    Constraints:
    Length: 1 - 1024
    
    Returns:
    
    The device name.
  - setDeviceName
```
public void setDeviceName(java.lang.String deviceName)
```
    The device name.
    
    Constraints:
    Length: 1 - 1024
    
    Parameters:
    
    deviceName -
    The device name.
  - withDeviceName
```
public ConfirmDeviceRequest withDeviceName(java.lang.String deviceName)
```
    The device name.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 1024
    
    Parameters:
    
    deviceName -
    The device name.
    
    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

Class ConfirmDeviceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ConfirmDeviceRequest

Method Detail

getAccessToken

setAccessToken

withAccessToken

getDeviceKey

setDeviceKey

withDeviceKey

getDeviceSecretVerifierConfig

setDeviceSecretVerifierConfig

withDeviceSecretVerifierConfig

getDeviceName

setDeviceName

withDeviceName

toString

hashCode

equals