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.
String	confirmationCode() The confirmation code sent by a user's request to confirm registration.
boolean	equals(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)
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 wish 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 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 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 String username()

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

Returns:

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

confirmationCode

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

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo