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

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class GetUserAttributeVerificationCodeRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAttribute request.

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.

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetUserAttributeVerificationCodeRequest()

Constructors
Constructor and Description
`GetUserAttributeVerificationCodeRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetUserAttributeVerificationCodeRequest`	`addClientMetadataEntry(java.lang.String key, java.lang.String value)` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`GetUserAttributeVerificationCodeRequest`	`clearClientMetadataEntries()` Removes all the entries added into ClientMetadata.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getAccessToken()` A non-expired access token for the user whose attribute verification code you want to generate.
`java.lang.String`	`getAttributeName()` The attribute name returned by the server response to get the user attribute verification code.
`java.util.Map<java.lang.String,java.lang.String>`	`getClientMetadata()` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`int`	`hashCode()`
`void`	`setAccessToken(java.lang.String accessToken)` A non-expired access token for the user whose attribute verification code you want to generate.
`void`	`setAttributeName(java.lang.String attributeName)` The attribute name returned by the server response to get the user attribute verification code.
`void`	`setClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GetUserAttributeVerificationCodeRequest`	`withAccessToken(java.lang.String accessToken)` A non-expired access token for the user whose attribute verification code you want to generate.
`GetUserAttributeVerificationCodeRequest`	`withAttributeName(java.lang.String attributeName)` The attribute name returned by the server response to get the user attribute verification code.
`GetUserAttributeVerificationCodeRequest`	`withClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

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
  - GetUserAttributeVerificationCodeRequest
```
public GetUserAttributeVerificationCodeRequest()
```
- Method Detail
  - getAccessToken
```
public java.lang.String getAccessToken()
```
    A non-expired access token for the user whose attribute verification code you want to generate.
    
    Constraints:
    Pattern: [A-Za-z0-9-_=.]+
    
    Returns:
    
    A non-expired access token for the user whose attribute verification code you want to generate.
  - setAccessToken
```
public void setAccessToken(java.lang.String accessToken)
```
    A non-expired access token for the user whose attribute verification code you want to generate.
    
    Constraints:
    Pattern: [A-Za-z0-9-_=.]+
    
    Parameters:
    
    accessToken -
    A non-expired access token for the user whose attribute verification code you want to generate.
  - withAccessToken
```
public GetUserAttributeVerificationCodeRequest withAccessToken(java.lang.String accessToken)
```
    A non-expired access token for the user whose attribute verification code you want to generate.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: [A-Za-z0-9-_=.]+
    
    Parameters:
    
    accessToken -
    A non-expired access token for the user whose attribute verification code you want to generate.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAttributeName
```
public java.lang.String getAttributeName()
```
    The attribute name returned by the server response to get the user attribute verification code.
    
    Constraints:
    Length: 1 - 32
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Returns:
    
    The attribute name returned by the server response to get the user attribute verification code.
  - setAttributeName
```
public void setAttributeName(java.lang.String attributeName)
```
    The attribute name returned by the server response to get the user attribute verification code.
    
    Constraints:
    Length: 1 - 32
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    attributeName -
    The attribute name returned by the server response to get the user attribute verification code.
  - withAttributeName
```
public GetUserAttributeVerificationCodeRequest withAttributeName(java.lang.String attributeName)
```
    The attribute name returned by the server response to get the user attribute verification code.
    
    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 returned by the server response to get the user attribute verification code.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientMetadata
```
public java.util.Map<java.lang.String,java.lang.String> getClientMetadata()
```
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Returns:
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
  - setClientMetadata
```
public void setClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)
```
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Parameters:
    clientMetadata -
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
  - withClientMetadata
```
public GetUserAttributeVerificationCodeRequest withClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)
```
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    clientMetadata -
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addClientMetadataEntry
```
public GetUserAttributeVerificationCodeRequest addClientMetadataEntry(java.lang.String key,
                                                                      java.lang.String value)
```
    A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    
    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    The method adds a new key-value pair into ClientMetadata parameter, and returns a reference to this object so that method calls can be chained together.
    Parameters:
    
    key - The key of the entry to be added into ClientMetadata.
    
    value - The corresponding value of the entry to be added into ClientMetadata.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearClientMetadataEntries
```
public GetUserAttributeVerificationCodeRequest clearClientMetadataEntries()
```
    Removes all the entries added into ClientMetadata.
    Returns a reference to this 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 GetUserAttributeVerificationCodeRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GetUserAttributeVerificationCodeRequest

Method Detail

getAccessToken

setAccessToken

withAccessToken

getAttributeName

setAttributeName

withAttributeName

getClientMetadata

setClientMetadata

withClientMetadata

addClientMetadataEntry

clearClientMetadataEntries

toString

hashCode

equals