@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.
Modifier and Type | Class and Description |
---|---|
static interface |
ConfirmSignUpRequest.Builder |
Modifier and Type | Method and Description |
---|---|
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)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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.
|
overrideConfiguration
copy
public String clientId()
The ID of the app client associated with the user pool.
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.
public String username()
The user name of the user whose registration you wish to confirm.
public String confirmationCode()
The confirmation code sent by a user's request to confirm registration.
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.
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.public ConfirmSignUpRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ConfirmSignUpRequest.Builder,ConfirmSignUpRequest>
toBuilder
in class CognitoIdentityProviderRequest
public static ConfirmSignUpRequest.Builder builder()
public static Class<? extends ConfirmSignUpRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.