com.amazonaws.services.cognitoidentityprovider.model

Class GetUserAttributeVerificationCodeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.GetUserAttributeVerificationCodeRequest

All Implemented Interfaces:

Serializable, Cloneable

public class GetUserAttributeVerificationCodeRequest
extends AmazonWebServiceRequest
implements Serializable

Gets the user attribute verification code for the specified attribute name.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetUserAttributeVerificationCodeRequest()

Method Summary

Modifier and Type	Method and Description
GetUserAttributeVerificationCodeRequest	addClientMetadataEntry(String key, 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(Object obj)
String	getAccessToken() The access token returned by the server response to get the user attribute verification code.
String	getAttributeName() The attribute name returned by the server response to get the user attribute verification code.
Map<String,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(String accessToken) The access token returned by the server response to get the user attribute verification code.
void	setAttributeName(String attributeName) The attribute name returned by the server response to get the user attribute verification code.
void	setClientMetadata(Map<String,String> clientMetadata) A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetUserAttributeVerificationCodeRequest	withAccessToken(String accessToken) The access token returned by the server response to get the user attribute verification code.
GetUserAttributeVerificationCodeRequest	withAttributeName(String attributeName) The attribute name returned by the server response to get the user attribute verification code.
GetUserAttributeVerificationCodeRequest	withClientMetadata(Map<String,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 String getAccessToken()

The access token returned by the server response to get the user attribute verification code.

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

Returns:

The access token returned by the server response to get the user attribute verification code.

setAccessToken

public void setAccessToken(String accessToken)

The access token returned by the server response to get the user attribute verification code.

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

Parameters:

accessToken -

The access token returned by the server response to get the user attribute verification code.

withAccessToken

public GetUserAttributeVerificationCodeRequest withAccessToken(String accessToken)

The access token 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:
Pattern: [A-Za-z0-9-_=.]+

Parameters:

accessToken -

The access token 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.

getAttributeName

public 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(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(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 Map<String,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 AWS 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 AWS 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.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

• Amazon Cognito does not validate the ClientMetadata value.

• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it 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 AWS 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 AWS 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.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

• Amazon Cognito does not validate the ClientMetadata value.

• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

setClientMetadata

public void setClientMetadata(Map<String,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 AWS 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 AWS 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.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

• Amazon Cognito does not validate the ClientMetadata value.

• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it 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 AWS 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 AWS 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.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

• Amazon Cognito does not validate the ClientMetadata value.

• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

withClientMetadata

public GetUserAttributeVerificationCodeRequest withClientMetadata(Map<String,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 AWS 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 AWS 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.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

• Amazon Cognito does not validate the ClientMetadata value.

• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it 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 AWS 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 AWS 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.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

• Amazon Cognito does not validate the ClientMetadata value.

• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

Returns:

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

addClientMetadataEntry

public GetUserAttributeVerificationCodeRequest addClientMetadataEntry(String key,
                                                                      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 AWS 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 AWS 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.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

• Amazon Cognito does not validate the ClientMetadata value.

• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it 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 String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object