Class ConfirmSignUpRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the request to confirm registration of a user.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The ID of the client associated with the user pool.The confirmation code sent by a user's request to confirm registration.Boolean to be specified to force user confirmation irrespective of existing alias.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.The user name of the user whose registration you wish to confirm.int
hashCode()
Boolean to be specified to force user confirmation irrespective of existing alias.void
setClientId
(String clientId) The ID of the client associated with the user pool.void
setConfirmationCode
(String confirmationCode) The confirmation code sent by a user's request to confirm registration.void
setForceAliasCreation
(Boolean forceAliasCreation) Boolean to be specified to force user confirmation irrespective of existing alias.void
setSecretHash
(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.void
setUsername
(String username) The user name of the user whose registration you wish to confirm.toString()
Returns a string representation of this object; useful for testing and debugging.withClientId
(String clientId) The ID of the client associated with the user pool.withConfirmationCode
(String confirmationCode) The confirmation code sent by a user's request to confirm registration.withForceAliasCreation
(Boolean forceAliasCreation) Boolean to be specified to force user confirmation irrespective of existing alias.withSecretHash
(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.withUsername
(String username) The user name of the user whose registration you wish to confirm.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
ConfirmSignUpRequest
public ConfirmSignUpRequest()
-
-
Method Details
-
setClientId
The ID of the client associated with the user pool.
- Parameters:
clientId
- The ID of the client associated with the user pool.
-
getClientId
The ID of the client associated with the user pool.
- Returns:
- The ID of the client associated with the user pool.
-
withClientId
The ID of the client associated with the user pool.
- Parameters:
clientId
- The ID of the client associated with the user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSecretHash
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.
- Parameters:
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.
-
getSecretHash
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.
-
withSecretHash
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setUsername
The user name of the user whose registration you wish to confirm.
- Parameters:
username
- The user name of the user whose registration you wish to confirm.
-
getUsername
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.
-
withUsername
The user name of the user whose registration you wish to confirm.
- Parameters:
username
- The user name of the user whose registration you wish to confirm.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setConfirmationCode
The confirmation code sent by a user's request to confirm registration.
- Parameters:
confirmationCode
- The confirmation code sent by a user's request to confirm registration.
-
getConfirmationCode
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.
-
withConfirmationCode
The confirmation code sent by a user's request to confirm registration.
- Parameters:
confirmationCode
- The confirmation code sent by a user's request to confirm registration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setForceAliasCreation
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.
- Parameters:
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.
-
getForceAliasCreation
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.
-
withForceAliasCreation
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
isForceAliasCreation
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.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-