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

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class VerifyUserAttributeRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Verifies the specified user attributes in the user pool.

If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see UserAttributeUpdateSettingsType.

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

VerifyUserAttributeRequest()

Constructors
Constructor and Description
`VerifyUserAttributeRequest()`

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 user attributes you want to verify.
`java.lang.String`	`getAttributeName()` The attribute name in the request to verify user attributes.
`java.lang.String`	`getCode()` The verification code in the request to verify user attributes.
`int`	`hashCode()`
`void`	`setAccessToken(java.lang.String accessToken)` A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.
`void`	`setAttributeName(java.lang.String attributeName)` The attribute name in the request to verify user attributes.
`void`	`setCode(java.lang.String code)` The verification code in the request to verify user attributes.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`VerifyUserAttributeRequest`	`withAccessToken(java.lang.String accessToken)` A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.
`VerifyUserAttributeRequest`	`withAttributeName(java.lang.String attributeName)` The attribute name in the request to verify user attributes.
`VerifyUserAttributeRequest`	`withCode(java.lang.String code)` The verification code in the request to verify user attributes.

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
  - VerifyUserAttributeRequest
```
public VerifyUserAttributeRequest()
```
- Method Detail
  - getAccessToken
```
public java.lang.String getAccessToken()
```
    A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.
    
    Constraints:
    Pattern: [A-Za-z0-9-_=.]+
    
    Returns:
    
    A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.
  - setAccessToken
```
public void setAccessToken(java.lang.String accessToken)
```
    A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.
    
    Constraints:
    Pattern: [A-Za-z0-9-_=.]+
    
    Parameters:
    
    accessToken -
    A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.
  - withAccessToken
```
public VerifyUserAttributeRequest withAccessToken(java.lang.String accessToken)
```
    A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.
    
    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 user attributes you want to verify.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAttributeName
```
public java.lang.String getAttributeName()
```
    The attribute name in the request to verify user attributes.
    
    Constraints:
    Length: 1 - 32
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Returns:
    
    The attribute name in the request to verify user attributes.
  - setAttributeName
```
public void setAttributeName(java.lang.String attributeName)
```
    The attribute name in the request to verify user attributes.
    
    Constraints:
    Length: 1 - 32
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    attributeName -
    The attribute name in the request to verify user attributes.
  - withAttributeName
```
public VerifyUserAttributeRequest withAttributeName(java.lang.String attributeName)
```
    The attribute name in the request to verify user attributes.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 32
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    attributeName -
    The attribute name in the request to verify user attributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCode
```
public java.lang.String getCode()
```
    The verification code in the request to verify user attributes.
    
    Constraints:
    Length: 1 - 2048
    Pattern: [\S]+
    
    Returns:
    
    The verification code in the request to verify user attributes.
  - setCode
```
public void setCode(java.lang.String code)
```
    The verification code in the request to verify user attributes.
    
    Constraints:
    Length: 1 - 2048
    Pattern: [\S]+
    
    Parameters:
    
    code -
    The verification code in the request to verify user attributes.
  - withCode
```
public VerifyUserAttributeRequest withCode(java.lang.String code)
```
    The verification code in the request to verify user attributes.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2048
    Pattern: [\S]+
    
    Parameters:
    
    code -
    The verification code in the request to verify user attributes.
    
    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 VerifyUserAttributeRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

VerifyUserAttributeRequest

Method Detail

getAccessToken

setAccessToken

withAccessToken

getAttributeName

setAttributeName

withAttributeName

getCode

setCode

withCode

toString

hashCode

equals