/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace CognitoIdentityProvider { namespace Model { /** *

Represents the request to confirm user registration.

See Also:

* AWS * API Reference

*/ class AdminConfirmSignUpRequest : public CognitoIdentityProviderRequest { public: AWS_COGNITOIDENTITYPROVIDER_API AdminConfirmSignUpRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "AdminConfirmSignUp"; } AWS_COGNITOIDENTITYPROVIDER_API Aws::String SerializePayload() const override; AWS_COGNITOIDENTITYPROVIDER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The user pool ID for which you want to confirm user registration.

*/ inline const Aws::String& GetUserPoolId() const{ return m_userPoolId; } /** *

The user pool ID for which you want to confirm user registration.

*/ inline bool UserPoolIdHasBeenSet() const { return m_userPoolIdHasBeenSet; } /** *

The user pool ID for which you want to confirm user registration.

*/ inline void SetUserPoolId(const Aws::String& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = value; } /** *

The user pool ID for which you want to confirm user registration.

*/ inline void SetUserPoolId(Aws::String&& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = std::move(value); } /** *

The user pool ID for which you want to confirm user registration.

*/ inline void SetUserPoolId(const char* value) { m_userPoolIdHasBeenSet = true; m_userPoolId.assign(value); } /** *

The user pool ID for which you want to confirm user registration.

*/ inline AdminConfirmSignUpRequest& WithUserPoolId(const Aws::String& value) { SetUserPoolId(value); return *this;} /** *

The user pool ID for which you want to confirm user registration.

*/ inline AdminConfirmSignUpRequest& WithUserPoolId(Aws::String&& value) { SetUserPoolId(std::move(value)); return *this;} /** *

The user pool ID for which you want to confirm user registration.

*/ inline AdminConfirmSignUpRequest& WithUserPoolId(const char* value) { SetUserPoolId(value); return *this;} /** *

The user name for which you want to confirm user registration.

*/ inline const Aws::String& GetUsername() const{ return m_username; } /** *

The user name for which you want to confirm user registration.

*/ inline bool UsernameHasBeenSet() const { return m_usernameHasBeenSet; } /** *

The user name for which you want to confirm user registration.

*/ inline void SetUsername(const Aws::String& value) { m_usernameHasBeenSet = true; m_username = value; } /** *

The user name for which you want to confirm user registration.

*/ inline void SetUsername(Aws::String&& value) { m_usernameHasBeenSet = true; m_username = std::move(value); } /** *

The user name for which you want to confirm user registration.

*/ inline void SetUsername(const char* value) { m_usernameHasBeenSet = true; m_username.assign(value); } /** *

The user name for which you want to confirm user registration.

*/ inline AdminConfirmSignUpRequest& WithUsername(const Aws::String& value) { SetUsername(value); return *this;} /** *

The user name for which you want to confirm user registration.

*/ inline AdminConfirmSignUpRequest& WithUsername(Aws::String&& value) { SetUsername(std::move(value)); return *this;} /** *

The user name for which you want to confirm user registration.

*/ inline AdminConfirmSignUpRequest& WithUsername(const char* value) { SetUsername(value); return *this;} /** *

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

If your user pool configuration * includes triggers, the AdminConfirmSignUp API action invokes the Lambda function * that is specified for the post confirmation trigger. When Amazon Cognito * invokes this function, it passes a JSON payload, which the function receives as * input. In this payload, the clientMetadata attribute provides the * data that you assigned to the ClientMetadata parameter in your * AdminConfirmSignUp 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.

*/ inline const Aws::Map& GetClientMetadata() const{ return m_clientMetadata; } /** *

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

If your user pool configuration * includes triggers, the AdminConfirmSignUp API action invokes the Lambda function * that is specified for the post confirmation trigger. When Amazon Cognito * invokes this function, it passes a JSON payload, which the function receives as * input. In this payload, the clientMetadata attribute provides the * data that you assigned to the ClientMetadata parameter in your * AdminConfirmSignUp 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.

*/ inline bool ClientMetadataHasBeenSet() const { return m_clientMetadataHasBeenSet; } /** *

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

If your user pool configuration * includes triggers, the AdminConfirmSignUp API action invokes the Lambda function * that is specified for the post confirmation trigger. When Amazon Cognito * invokes this function, it passes a JSON payload, which the function receives as * input. In this payload, the clientMetadata attribute provides the * data that you assigned to the ClientMetadata parameter in your * AdminConfirmSignUp 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.

*/ inline void SetClientMetadata(const Aws::Map& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata = value; } /** *

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

If your user pool configuration * includes triggers, the AdminConfirmSignUp API action invokes the Lambda function * that is specified for the post confirmation trigger. When Amazon Cognito * invokes this function, it passes a JSON payload, which the function receives as * input. In this payload, the clientMetadata attribute provides the * data that you assigned to the ClientMetadata parameter in your * AdminConfirmSignUp 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.

*/ inline void SetClientMetadata(Aws::Map&& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata = std::move(value); } /** *

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

If your user pool configuration * includes triggers, the AdminConfirmSignUp API action invokes the Lambda function * that is specified for the post confirmation trigger. When Amazon Cognito * invokes this function, it passes a JSON payload, which the function receives as * input. In this payload, the clientMetadata attribute provides the * data that you assigned to the ClientMetadata parameter in your * AdminConfirmSignUp 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.

*/ inline AdminConfirmSignUpRequest& WithClientMetadata(const Aws::Map& value) { SetClientMetadata(value); return *this;} /** *

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

If your user pool configuration * includes triggers, the AdminConfirmSignUp API action invokes the Lambda function * that is specified for the post confirmation trigger. When Amazon Cognito * invokes this function, it passes a JSON payload, which the function receives as * input. In this payload, the clientMetadata attribute provides the * data that you assigned to the ClientMetadata parameter in your * AdminConfirmSignUp 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.

*/ inline AdminConfirmSignUpRequest& WithClientMetadata(Aws::Map&& value) { SetClientMetadata(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.

If your user pool configuration * includes triggers, the AdminConfirmSignUp API action invokes the Lambda function * that is specified for the post confirmation trigger. When Amazon Cognito * invokes this function, it passes a JSON payload, which the function receives as * input. In this payload, the clientMetadata attribute provides the * data that you assigned to the ClientMetadata parameter in your * AdminConfirmSignUp 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.

*/ inline AdminConfirmSignUpRequest& AddClientMetadata(const Aws::String& key, const Aws::String& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(key, value); return *this; } /** *

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

If your user pool configuration * includes triggers, the AdminConfirmSignUp API action invokes the Lambda function * that is specified for the post confirmation trigger. When Amazon Cognito * invokes this function, it passes a JSON payload, which the function receives as * input. In this payload, the clientMetadata attribute provides the * data that you assigned to the ClientMetadata parameter in your * AdminConfirmSignUp 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.

*/ inline AdminConfirmSignUpRequest& AddClientMetadata(Aws::String&& key, const Aws::String& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(std::move(key), value); return *this; } /** *

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

If your user pool configuration * includes triggers, the AdminConfirmSignUp API action invokes the Lambda function * that is specified for the post confirmation trigger. When Amazon Cognito * invokes this function, it passes a JSON payload, which the function receives as * input. In this payload, the clientMetadata attribute provides the * data that you assigned to the ClientMetadata parameter in your * AdminConfirmSignUp 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.

*/ inline AdminConfirmSignUpRequest& AddClientMetadata(const Aws::String& key, Aws::String&& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(key, 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.

If your user pool configuration * includes triggers, the AdminConfirmSignUp API action invokes the Lambda function * that is specified for the post confirmation trigger. When Amazon Cognito * invokes this function, it passes a JSON payload, which the function receives as * input. In this payload, the clientMetadata attribute provides the * data that you assigned to the ClientMetadata parameter in your * AdminConfirmSignUp 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.

*/ inline AdminConfirmSignUpRequest& AddClientMetadata(Aws::String&& key, Aws::String&& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(std::move(key), 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.

If your user pool configuration * includes triggers, the AdminConfirmSignUp API action invokes the Lambda function * that is specified for the post confirmation trigger. When Amazon Cognito * invokes this function, it passes a JSON payload, which the function receives as * input. In this payload, the clientMetadata attribute provides the * data that you assigned to the ClientMetadata parameter in your * AdminConfirmSignUp 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.

*/ inline AdminConfirmSignUpRequest& AddClientMetadata(const char* key, Aws::String&& value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(key, 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.

If your user pool configuration * includes triggers, the AdminConfirmSignUp API action invokes the Lambda function * that is specified for the post confirmation trigger. When Amazon Cognito * invokes this function, it passes a JSON payload, which the function receives as * input. In this payload, the clientMetadata attribute provides the * data that you assigned to the ClientMetadata parameter in your * AdminConfirmSignUp 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.

*/ inline AdminConfirmSignUpRequest& AddClientMetadata(Aws::String&& key, const char* value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(std::move(key), value); return *this; } /** *

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

If your user pool configuration * includes triggers, the AdminConfirmSignUp API action invokes the Lambda function * that is specified for the post confirmation trigger. When Amazon Cognito * invokes this function, it passes a JSON payload, which the function receives as * input. In this payload, the clientMetadata attribute provides the * data that you assigned to the ClientMetadata parameter in your * AdminConfirmSignUp 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.

*/ inline AdminConfirmSignUpRequest& AddClientMetadata(const char* key, const char* value) { m_clientMetadataHasBeenSet = true; m_clientMetadata.emplace(key, value); return *this; } private: Aws::String m_userPoolId; bool m_userPoolIdHasBeenSet = false; Aws::String m_username; bool m_usernameHasBeenSet = false; Aws::Map m_clientMetadata; bool m_clientMetadataHasBeenSet = false; }; } // namespace Model } // namespace CognitoIdentityProvider } // namespace Aws