software.amazon.awssdk.services.cognitoidentityprovider.model

Class ConfirmSignUpRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.ConfirmSignUpRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ConfirmSignUpRequest.Builder,ConfirmSignUpRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ConfirmSignUpRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<ConfirmSignUpRequest.Builder,ConfirmSignUpRequest>

Represents the request to confirm registration of a user.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConfirmSignUpRequest.Builder

Method Summary

Modifier and Type	Method and Description
AnalyticsMetadataType	analyticsMetadata() The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.
static ConfirmSignUpRequest.Builder	builder()
String	clientId() The ID of the app client associated with the user pool.
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	confirmationCode() The confirmation code sent by a user's request to confirm registration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	forceAliasCreation() Boolean to be specified to force user confirmation irrespective of existing alias.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasClientMetadata() For responses, this returns true if the service returned a value for the ClientMetadata property.
int	hashCode()
List<SdkField<?>>	sdkFields()
String	secretHash() A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
static Class<? extends ConfirmSignUpRequest.Builder>	serializableBuilderClass()
ConfirmSignUpRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
UserContextDataType	userContextData() Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
String	username() The user name of the user whose registration you want to confirm.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

clientId

public final String clientId()

The ID of the app client associated with the user pool.

Returns:

The ID of the app client associated with the user pool.

secretHash

public final String secretHash()

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Returns:

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

username

public final String username()

The user name of the user whose registration you want to confirm.

Returns:

The user name of the user whose registration you want to confirm.

confirmationCode

public final String confirmationCode()

The confirmation code sent by a user's request to confirm registration.

Returns:

The confirmation code sent by a user's request to confirm registration.

forceAliasCreation

public final Boolean forceAliasCreation()

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

Returns:

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

analyticsMetadata

public final AnalyticsMetadataType analyticsMetadata()

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

Returns:

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

userContextData

public final UserContextDataType userContextData()

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Returns:

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

hasClientMetadata

public final boolean hasClientMetadata()

For responses, this returns true if the service returned a value for the ClientMetadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

clientMetadata

public final 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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation 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 ConfirmSignUp 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasClientMetadata() method.

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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation 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 ConfirmSignUp 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.

toBuilder

public ConfirmSignUpRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConfirmSignUpRequest.Builder,ConfirmSignUpRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static ConfirmSignUpRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ConfirmSignUpRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo