/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Represents the request to confirm registration of a user.See
* Also:
AWS
* API Reference
The ID of the app client associated with the user pool.
*/ inline const Aws::String& GetClientId() const{ return m_clientId; } /** *The ID of the app client associated with the user pool.
*/ inline bool ClientIdHasBeenSet() const { return m_clientIdHasBeenSet; } /** *The ID of the app client associated with the user pool.
*/ inline void SetClientId(const Aws::String& value) { m_clientIdHasBeenSet = true; m_clientId = value; } /** *The ID of the app client associated with the user pool.
*/ inline void SetClientId(Aws::String&& value) { m_clientIdHasBeenSet = true; m_clientId = std::move(value); } /** *The ID of the app client associated with the user pool.
*/ inline void SetClientId(const char* value) { m_clientIdHasBeenSet = true; m_clientId.assign(value); } /** *The ID of the app client associated with the user pool.
*/ inline ConfirmSignUpRequest& WithClientId(const Aws::String& value) { SetClientId(value); return *this;} /** *The ID of the app client associated with the user pool.
*/ inline ConfirmSignUpRequest& WithClientId(Aws::String&& value) { SetClientId(std::move(value)); return *this;} /** *The ID of the app client associated with the user pool.
*/ inline ConfirmSignUpRequest& WithClientId(const char* value) { SetClientId(value); return *this;} /** *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.
*/ inline const Aws::String& GetSecretHash() const{ return m_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.
*/ inline bool SecretHashHasBeenSet() const { return m_secretHashHasBeenSet; } /** *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.
*/ inline void SetSecretHash(const Aws::String& value) { m_secretHashHasBeenSet = true; m_secretHash = value; } /** *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.
*/ inline void SetSecretHash(Aws::String&& value) { m_secretHashHasBeenSet = true; m_secretHash = std::move(value); } /** *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.
*/ inline void SetSecretHash(const char* value) { m_secretHashHasBeenSet = true; m_secretHash.assign(value); } /** *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.
*/ inline ConfirmSignUpRequest& WithSecretHash(const Aws::String& value) { SetSecretHash(value); return *this;} /** *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.
*/ inline ConfirmSignUpRequest& WithSecretHash(Aws::String&& value) { SetSecretHash(std::move(value)); return *this;} /** *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.
*/ inline ConfirmSignUpRequest& WithSecretHash(const char* value) { SetSecretHash(value); return *this;} /** *The user name of the user whose registration you want to confirm.
*/ inline const Aws::String& GetUsername() const{ return m_username; } /** *The user name of the user whose registration you want to confirm.
*/ inline bool UsernameHasBeenSet() const { return m_usernameHasBeenSet; } /** *The user name of the user whose registration you want to confirm.
*/ inline void SetUsername(const Aws::String& value) { m_usernameHasBeenSet = true; m_username = value; } /** *The user name of the user whose registration you want to confirm.
*/ inline void SetUsername(Aws::String&& value) { m_usernameHasBeenSet = true; m_username = std::move(value); } /** *The user name of the user whose registration you want to confirm.
*/ inline void SetUsername(const char* value) { m_usernameHasBeenSet = true; m_username.assign(value); } /** *The user name of the user whose registration you want to confirm.
*/ inline ConfirmSignUpRequest& WithUsername(const Aws::String& value) { SetUsername(value); return *this;} /** *The user name of the user whose registration you want to confirm.
*/ inline ConfirmSignUpRequest& WithUsername(Aws::String&& value) { SetUsername(std::move(value)); return *this;} /** *The user name of the user whose registration you want to confirm.
*/ inline ConfirmSignUpRequest& WithUsername(const char* value) { SetUsername(value); return *this;} /** *The confirmation code sent by a user's request to confirm registration.
*/ inline const Aws::String& GetConfirmationCode() const{ return m_confirmationCode; } /** *The confirmation code sent by a user's request to confirm registration.
*/ inline bool ConfirmationCodeHasBeenSet() const { return m_confirmationCodeHasBeenSet; } /** *The confirmation code sent by a user's request to confirm registration.
*/ inline void SetConfirmationCode(const Aws::String& value) { m_confirmationCodeHasBeenSet = true; m_confirmationCode = value; } /** *The confirmation code sent by a user's request to confirm registration.
*/ inline void SetConfirmationCode(Aws::String&& value) { m_confirmationCodeHasBeenSet = true; m_confirmationCode = std::move(value); } /** *The confirmation code sent by a user's request to confirm registration.
*/ inline void SetConfirmationCode(const char* value) { m_confirmationCodeHasBeenSet = true; m_confirmationCode.assign(value); } /** *The confirmation code sent by a user's request to confirm registration.
*/ inline ConfirmSignUpRequest& WithConfirmationCode(const Aws::String& value) { SetConfirmationCode(value); return *this;} /** *The confirmation code sent by a user's request to confirm registration.
*/ inline ConfirmSignUpRequest& WithConfirmationCode(Aws::String&& value) { SetConfirmationCode(std::move(value)); return *this;} /** *The confirmation code sent by a user's request to confirm registration.
*/ inline ConfirmSignUpRequest& WithConfirmationCode(const char* value) { SetConfirmationCode(value); return *this;} /** *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.
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.
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.
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.
The Amazon Pinpoint analytics metadata for collecting metrics for
* ConfirmSignUp
calls.
The Amazon Pinpoint analytics metadata for collecting metrics for
* ConfirmSignUp
calls.
The Amazon Pinpoint analytics metadata for collecting metrics for
* ConfirmSignUp
calls.
The Amazon Pinpoint analytics metadata for collecting metrics for
* ConfirmSignUp
calls.
The Amazon Pinpoint analytics metadata for collecting metrics for
* ConfirmSignUp
calls.
The Amazon Pinpoint analytics metadata for collecting metrics for
* ConfirmSignUp
calls.
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.
*/ inline const UserContextDataType& GetUserContextData() const{ return m_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.
*/ inline bool UserContextDataHasBeenSet() const { return m_userContextDataHasBeenSet; } /** *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.
*/ inline void SetUserContextData(const UserContextDataType& value) { m_userContextDataHasBeenSet = true; m_userContextData = value; } /** *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.
*/ inline void SetUserContextData(UserContextDataType&& value) { m_userContextDataHasBeenSet = true; m_userContextData = std::move(value); } /** *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.
*/ inline ConfirmSignUpRequest& WithUserContextData(const UserContextDataType& value) { SetUserContextData(value); return *this;} /** *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.
*/ inline ConfirmSignUpRequest& WithUserContextData(UserContextDataType&& value) { SetUserContextData(std::move(value)); return *this;} /** *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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.