com.amazonaws.services.cognitoidentityprovider.model

Class ConfirmSignUpRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.ConfirmSignUpRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ConfirmSignUpRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Confirms registration of a new user.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfirmSignUpRequest()

Method Summary

Modifier and Type	Method and Description
ConfirmSignUpRequest	addClientMetadataEntry(java.lang.String key, java.lang.String value) A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
ConfirmSignUpRequest	clearClientMetadataEntries() Removes all the entries added into ClientMetadata.
boolean	equals(java.lang.Object obj)
AnalyticsMetadataType	getAnalyticsMetadata() The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.
java.lang.String	getClientId() The ID of the app client associated with the user pool.
java.util.Map<java.lang.String,java.lang.String>	getClientMetadata() A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
java.lang.String	getConfirmationCode() The confirmation code sent by a user's request to confirm registration.
java.lang.Boolean	getForceAliasCreation() Boolean to be specified to force user confirmation irrespective of existing alias.
java.lang.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() Contextual data about your user session, such as the device fingerprint, IP address, or location.
java.lang.String	getUsername() The user name of the user whose registration you want to confirm.
int	hashCode()
java.lang.Boolean	isForceAliasCreation() Boolean to be specified to force user confirmation irrespective of existing alias.
void	setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.
void	setClientId(java.lang.String clientId) The ID of the app client associated with the user pool.
void	setClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata) A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
void	setConfirmationCode(java.lang.String confirmationCode) The confirmation code sent by a user's request to confirm registration.
void	setForceAliasCreation(java.lang.Boolean forceAliasCreation) Boolean to be specified to force user confirmation irrespective of existing alias.
void	setSecretHash(java.lang.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) Contextual data about your user session, such as the device fingerprint, IP address, or location.
void	setUsername(java.lang.String username) The user name of the user whose registration you want to confirm.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ConfirmSignUpRequest	withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.
ConfirmSignUpRequest	withClientId(java.lang.String clientId) The ID of the app client associated with the user pool.
ConfirmSignUpRequest	withClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata) A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
ConfirmSignUpRequest	withConfirmationCode(java.lang.String confirmationCode) The confirmation code sent by a user's request to confirm registration.
ConfirmSignUpRequest	withForceAliasCreation(java.lang.Boolean forceAliasCreation) Boolean to be specified to force user confirmation irrespective of existing alias.
ConfirmSignUpRequest	withSecretHash(java.lang.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) Contextual data about your user session, such as the device fingerprint, IP address, or location.
ConfirmSignUpRequest	withUsername(java.lang.String username) The user name of the user whose registration you want 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 java.lang.String getClientId()

The ID of the app client associated with the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

Returns:

The ID of the app client associated with the user pool.

setClientId

public void setClientId(java.lang.String clientId)

The ID of the app client associated with the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

Parameters:

clientId -

The ID of the app client associated with the user pool.

withClientId

public ConfirmSignUpRequest withClientId(java.lang.String clientId)

The ID of the app 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 app client associated with the user pool.

Returns:

A reference to this updated object so that method calls can be chained together.

getSecretHash

public java.lang.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(java.lang.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(java.lang.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 java.lang.String getUsername()

The user name of the user whose registration you want 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 want to confirm.

setUsername

public void setUsername(java.lang.String username)

The user name of the user whose registration you want 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 want to confirm.

withUsername

public ConfirmSignUpRequest withUsername(java.lang.String username)

The user name of the user whose registration you want 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 want to confirm.

Returns:

A reference to this updated object so that method calls can be chained together.

getConfirmationCode

public java.lang.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(java.lang.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(java.lang.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 java.lang.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 java.lang.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(java.lang.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(java.lang.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.

getAnalyticsMetadata

public AnalyticsMetadataType getAnalyticsMetadata()

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

Returns:

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

setAnalyticsMetadata

public void setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

Parameters:

analyticsMetadata -

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

withAnalyticsMetadata

public ConfirmSignUpRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

Returns a reference to this object so that method calls can be chained together.

Parameters:

analyticsMetadata -

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

Returns:

A reference to this updated object so that method calls can be chained together.

getUserContextData

public UserContextDataType getUserContextData()

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

Returns:

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

setUserContextData

public void setUserContextData(UserContextDataType userContextData)

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

Parameters:

userContextData -

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

withUserContextData

public ConfirmSignUpRequest withUserContextData(UserContextDataType userContextData)

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

Returns a reference to this object so that method calls can be chained together.

Parameters:

userContextData -

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

Returns:

A reference to this updated object so that method calls can be chained together.

getClientMetadata

public java.util.Map<java.lang.String,java.lang.String> getClientMetadata()

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

Returns:

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

setClientMetadata

public void setClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

Parameters:

clientMetadata -

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

withClientMetadata

public ConfirmSignUpRequest withClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

Returns a reference to this object so that method calls can be chained together.

Parameters:

clientMetadata -

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

Returns:

A reference to this updated object so that method calls can be chained together.

addClientMetadataEntry

public ConfirmSignUpRequest addClientMetadataEntry(java.lang.String key,
                                                   java.lang.String value)

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

The method adds a new key-value pair into ClientMetadata parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into ClientMetadata.

value - The corresponding value of the entry to be added into ClientMetadata.

Returns:

A reference to this updated object so that method calls can be chained together.

clearClientMetadataEntries

public ConfirmSignUpRequest clearClientMetadataEntries()

Removes all the entries added into ClientMetadata.

Returns a reference to this object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object