software.amazon.awssdk.services.cognitoidentityprovider.model

Interface GetUserAttributeVerificationCodeRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<GetUserAttributeVerificationCodeRequest.Builder,GetUserAttributeVerificationCodeRequest>, SdkBuilder<GetUserAttributeVerificationCodeRequest.Builder,GetUserAttributeVerificationCodeRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetUserAttributeVerificationCodeRequest

public static interface GetUserAttributeVerificationCodeRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<GetUserAttributeVerificationCodeRequest.Builder,GetUserAttributeVerificationCodeRequest>

Method Summary

Modifier and Type	Method and Description
GetUserAttributeVerificationCodeRequest.Builder	accessToken(String accessToken) The access token returned by the server response to get the user attribute verification code.
GetUserAttributeVerificationCodeRequest.Builder	attributeName(String attributeName) The attribute name returned by the server response to get the user attribute verification code.
GetUserAttributeVerificationCodeRequest.Builder	clientMetadata(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.
GetUserAttributeVerificationCodeRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetUserAttributeVerificationCodeRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

accessToken

GetUserAttributeVerificationCodeRequest.Builder accessToken(String accessToken)

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

Parameters:

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

attributeName

GetUserAttributeVerificationCodeRequest.Builder attributeName(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.

clientMetadata

GetUserAttributeVerificationCodeRequest.Builder clientMetadata(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.

Returns:

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

overrideConfiguration

GetUserAttributeVerificationCodeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

GetUserAttributeVerificationCodeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.