Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class ConfirmSignUpRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

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

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<ConfirmSignUpRequest.Builder,ConfirmSignUpRequest>

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

Represents the request to confirm registration of a user.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConfirmSignUpRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static ConfirmSignUpRequest.Builder	builder()
String	clientId()	The ID of the 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.
int	hashCode()
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()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	username()	The user name of the user whose registration you wish to confirm.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

clientId

public String clientId()

The ID of the client associated with the user pool.

Returns:

The ID of the 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.

toBuilder

public ConfirmSignUpRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ConfirmSignUpRequest.Builder,ConfirmSignUpRequest>

Returns:

a builder for type T

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

Overrides:

toString in class Object