com.amazonaws.services.cognitoidp.model

Class GetUserAttributeVerificationCodeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.GetUserAttributeVerificationCodeRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetUserAttributeVerificationCodeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the request to get user attribute verification.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetUserAttributeVerificationCodeRequest()

Method Summary

Modifier and Type	Method and Description
GetUserAttributeVerificationCodeRequest	addClientMetadataEntry(String key, String value) Add a single ClientMetadata entry
GetUserAttributeVerificationCodeRequest	clearClientMetadataEntries() Removes all the entries added into ClientMetadata.
GetUserAttributeVerificationCodeRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAccessToken() A non-expired access token for the user whose attribute verification code you want to generate.
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) A non-expired access token for the user whose attribute verification code you want to generate.
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.
GetUserAttributeVerificationCodeRequest	withAccessToken(String accessToken) A non-expired access token for the user whose attribute verification code you want to generate.
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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetUserAttributeVerificationCodeRequest

public GetUserAttributeVerificationCodeRequest()

Method Detail

setAccessToken

public void setAccessToken(String accessToken)

A non-expired access token for the user whose attribute verification code you want to generate.

Parameters:

accessToken - A non-expired access token for the user whose attribute verification code you want to generate.

getAccessToken

public String getAccessToken()

A non-expired access token for the user whose attribute verification code you want to generate.

Returns:

A non-expired access token for the user whose attribute verification code you want to generate.

withAccessToken

public GetUserAttributeVerificationCodeRequest withAccessToken(String accessToken)

A non-expired access token for the user whose attribute verification code you want to generate.

Parameters:

accessToken - A non-expired access token for the user whose attribute verification code you want to generate.

Returns:

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

setAttributeName

public void setAttributeName(String attributeName)

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

Parameters:

attributeName - The attribute name returned by the server response to get the user attribute verification code.

getAttributeName

public String getAttributeName()

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

Returns:

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.

Parameters:

attributeName - The attribute name returned by the server response to get the user attribute verification code.

Returns:

Returns a reference to this 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 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(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 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(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 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.

Returns:

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

addClientMetadataEntry

public GetUserAttributeVerificationCodeRequest addClientMetadataEntry(String key,
                                                                      String value)

Add a single ClientMetadata entry

See Also:

withClientMetadata(java.util.Map<java.lang.String, java.lang.String>)

clearClientMetadataEntries

public GetUserAttributeVerificationCodeRequest clearClientMetadataEntries()

Removes all the entries added into ClientMetadata.

Returns:

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetUserAttributeVerificationCodeRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()