com.amazonaws.services.cognitoidp.model

Class ConfirmSignUpRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.ConfirmSignUpRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ConfirmSignUpRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the request to confirm registration of a user.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ConfirmSignUpRequest()

Method Summary

Modifier and Type	Method and Description
ConfirmSignUpRequest	addClientMetadataEntry(String key, String value) Add a single ClientMetadata entry
ConfirmSignUpRequest	clearClientMetadataEntries() Removes all the entries added into ClientMetadata.
ConfirmSignUpRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AnalyticsMetadataType	getAnalyticsMetadata() The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.
String	getClientId() The ID of the app client associated with the user pool.
Map<String,String>	getClientMetadata() A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
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() Contextual data about your user session, such as the device fingerprint, IP address, or location.
String	getUsername() The username of the user that you want to query or modify.
int	hashCode()
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(String clientId) The ID of the app client associated with the user pool.
void	setClientMetadata(Map<String,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(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) Contextual data about your user session, such as the device fingerprint, IP address, or location.
void	setUsername(String username) The username of the user that you want to query or modify.
String	toString() Returns a string representation of this object.
ConfirmSignUpRequest	withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.
ConfirmSignUpRequest	withClientId(String clientId) The ID of the app client associated with the user pool.
ConfirmSignUpRequest	withClientMetadata(Map<String,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(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) Contextual data about your user session, such as the device fingerprint, IP address, or location.
ConfirmSignUpRequest	withUsername(String username) The username of the user that you want to query or modify.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfirmSignUpRequest

public ConfirmSignUpRequest()

Method Detail

setClientId

public void setClientId(String clientId)

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

Parameters:

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

getClientId

public String getClientId()

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

Returns:

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

withClientId

public ConfirmSignUpRequest withClientId(String clientId)

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

Parameters:

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

Returns:

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

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.

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

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.

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

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.

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

public void setUsername(String username)

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Parameters:

username - The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

getUsername

public String getUsername()

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Returns:

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

withUsername

public ConfirmSignUpRequest withUsername(String username)

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Parameters:

username - The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Returns:

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

setConfirmationCode

public void setConfirmationCode(String confirmationCode)

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

public String 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

public ConfirmSignUpRequest withConfirmationCode(String confirmationCode)

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

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.

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.

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.

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

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.

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.

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.

withAnalyticsMetadata

public ConfirmSignUpRequest withAnalyticsMetadata(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.

Returns:

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

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.

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.

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.

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:

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

getClientMetadata

public Map<String,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(Map<String,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(Map<String,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.

Returns:

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

addClientMetadataEntry

public ConfirmSignUpRequest addClientMetadataEntry(String key,
                                                   String value)

Add a single ClientMetadata entry

See Also:

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

clearClientMetadataEntries

public ConfirmSignUpRequest clearClientMetadataEntries()

Removes all the entries added into ClientMetadata.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ConfirmSignUpRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()