ConfirmSignUpRequest (AWS SDK for Android - Amazon Cognito Identity Provider 2.6.15 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentityprovider.model.ConfirmSignUpRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class ConfirmSignUpRequest
extends AmazonWebServiceRequest
implements Serializable
```
Confirms registration of a user and handles the existing alias from a previous user.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ConfirmSignUpRequest()

Constructors
Constructor and Description
`ConfirmSignUpRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`AnalyticsMetadataType`	`getAnalyticsMetadata()` The pinpoint installation id.
`String`	`getClientId()` The ID of the client associated with the user pool.
`String`	`getConfirmationCode()` The confirmation code sent by a user's request to confirm registration.
`Boolean`	`getForceAliasCreation()` Boolean to be specified to force user confirmation irrespective of existing alias.
`String`	`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.
`UserContextDataType`	`getUserContextData()` Base64 encoded string for user context data collected for risk evaluation
`String`	`getUsername()` The user name of the user whose registration you wish to confirm.
`int`	`hashCode()`
`Boolean`	`isForceAliasCreation()` Boolean to be specified to force user confirmation irrespective of existing alias.
`void`	`setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The pinpoint installation id.
`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`	`setUserContextData(UserContextDataType userContextData)` Base64 encoded string for user context data collected for risk evaluation
`void`	`setUsername(String username)` The user name of the user whose registration you wish to confirm.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ConfirmSignUpRequest`	`withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The pinpoint installation id.
`ConfirmSignUpRequest`	`withClientId(String clientId)` The ID of the client associated with the user pool.
`ConfirmSignUpRequest`	`withConfirmationCode(String confirmationCode)` The confirmation code sent by a user's request to confirm registration.
`ConfirmSignUpRequest`	`withForceAliasCreation(Boolean forceAliasCreation)` Boolean to be specified to force user confirmation irrespective of existing alias.
`ConfirmSignUpRequest`	`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.
`ConfirmSignUpRequest`	`withUserContextData(UserContextDataType userContextData)` Base64 encoded string for user context data collected for risk evaluation
`ConfirmSignUpRequest`	`withUsername(String username)` The user name of the user whose registration you wish to confirm.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConfirmSignUpRequest
```
public ConfirmSignUpRequest()
```
- Method Detail
  - getClientId
```
public String getClientId()
```
    The ID of the client associated with the user pool.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Returns:
    
    The ID of the client associated with the user pool.
  - setClientId
```
public void setClientId(String clientId)
```
    The ID of the client associated with the user pool.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The ID of the client associated with the user pool.
  - withClientId
```
public ConfirmSignUpRequest withClientId(String clientId)
```
    The ID of the client associated with the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The ID of the client associated with the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSecretHash
```
public String 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.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=/]+
    
    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.
  - setSecretHash
```
public 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.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=/]+
    
    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.
  - withSecretHash
```
public ConfirmSignUpRequest 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+=/]+
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getUsername
```
public String getUsername()
```
    The user name of the user whose registration you wish to confirm.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Returns:
    
    The user name of the user whose registration you wish to confirm.
  - setUsername
```
public void setUsername(String username)
```
    The user name of the user whose registration you wish to confirm.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    username -
    The user name of the user whose registration you wish to confirm.
  - withUsername
```
public ConfirmSignUpRequest withUsername(String username)
```
    The user name of the user whose registration you wish to confirm.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    username -
    The user name of the user whose registration you wish to confirm.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getConfirmationCode
```
public String getConfirmationCode()
```
    The confirmation code sent by a user's request to confirm registration.
    
    Constraints:
    Length: 1 - 2048
    Pattern: [\S]+
    
    Returns:
    
    The confirmation code sent by a user's request to confirm registration.
  - setConfirmationCode
```
public void setConfirmationCode(String confirmationCode)
```
    The confirmation code sent by a user's request to confirm registration.
    
    Constraints:
    Length: 1 - 2048
    Pattern: [\S]+
    
    Parameters:
    
    confirmationCode -
    The confirmation code sent by a user's request to confirm registration.
  - withConfirmationCode
```
public ConfirmSignUpRequest withConfirmationCode(String confirmationCode)
```
    The confirmation code sent by a user's request to confirm registration.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2048
    Pattern: [\S]+
    
    Parameters:
    
    confirmationCode -
    The confirmation code sent by a user's request to confirm registration.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isForceAliasCreation
```
public Boolean 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.
  - getForceAliasCreation
```
public Boolean 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.
  - setForceAliasCreation
```
public void setForceAliasCreation(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.
    
    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.
  - withForceAliasCreation
```
public ConfirmSignUpRequest withForceAliasCreation(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 a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserContextData
```
public UserContextDataType getUserContextData()
```
    Base64 encoded string for user context data collected for risk evaluation
    
    Returns:
    
    Base64 encoded string for user context data collected for risk evaluation
  - setUserContextData
```
public void setUserContextData(UserContextDataType userContextData)
```
    Base64 encoded string for user context data collected for risk evaluation
    
    Parameters:
    
    userContextData -
    Base64 encoded string for user context data collected for risk evaluation
  - withUserContextData
```
public ConfirmSignUpRequest withUserContextData(UserContextDataType userContextData)
```
    Base64 encoded string for user context data collected for risk evaluation
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    userContextData -
    Base64 encoded string for user context data collected for risk evaluation
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAnalyticsMetadata
```
public AnalyticsMetadataType getAnalyticsMetadata()
```
    The pinpoint installation id.
    
    Returns:
    
    The pinpoint installation id.
  - setAnalyticsMetadata
```
public void setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
```
    The pinpoint installation id.
    
    Parameters:
    
    analyticsMetadata -
    The pinpoint installation id.
  - withAnalyticsMetadata
```
public ConfirmSignUpRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
```
    The pinpoint installation id.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    analyticsMetadata -
    The pinpoint installation id.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class ConfirmSignUpRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ConfirmSignUpRequest

Method Detail

getClientId

setClientId

withClientId

getSecretHash

setSecretHash

withSecretHash

getUsername

setUsername

withUsername

getConfirmationCode

setConfirmationCode

withConfirmationCode

isForceAliasCreation

getForceAliasCreation

setForceAliasCreation

withForceAliasCreation

getUserContextData

setUserContextData

withUserContextData

getAnalyticsMetadata

setAnalyticsMetadata

withAnalyticsMetadata

toString

hashCode

equals