/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Represents the request to reset a user's password as an
* administrator.See Also:
AWS
* API Reference
The user pool ID for the user pool where you want to reset the user's * password.
*/ inline const Aws::String& GetUserPoolId() const{ return m_userPoolId; } /** *The user pool ID for the user pool where you want to reset the user's * password.
*/ inline bool UserPoolIdHasBeenSet() const { return m_userPoolIdHasBeenSet; } /** *The user pool ID for the user pool where you want to reset the user's * password.
*/ inline void SetUserPoolId(const Aws::String& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = value; } /** *The user pool ID for the user pool where you want to reset the user's * password.
*/ inline void SetUserPoolId(Aws::String&& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = std::move(value); } /** *The user pool ID for the user pool where you want to reset the user's * password.
*/ inline void SetUserPoolId(const char* value) { m_userPoolIdHasBeenSet = true; m_userPoolId.assign(value); } /** *The user pool ID for the user pool where you want to reset the user's * password.
*/ inline AdminResetUserPasswordRequest& WithUserPoolId(const Aws::String& value) { SetUserPoolId(value); return *this;} /** *The user pool ID for the user pool where you want to reset the user's * password.
*/ inline AdminResetUserPasswordRequest& WithUserPoolId(Aws::String&& value) { SetUserPoolId(std::move(value)); return *this;} /** *The user pool ID for the user pool where you want to reset the user's * password.
*/ inline AdminResetUserPasswordRequest& WithUserPoolId(const char* value) { SetUserPoolId(value); return *this;} /** *The user name of the user whose password you want to reset.
*/ inline const Aws::String& GetUsername() const{ return m_username; } /** *The user name of the user whose password you want to reset.
*/ inline bool UsernameHasBeenSet() const { return m_usernameHasBeenSet; } /** *The user name of the user whose password you want to reset.
*/ inline void SetUsername(const Aws::String& value) { m_usernameHasBeenSet = true; m_username = value; } /** *The user name of the user whose password you want to reset.
*/ inline void SetUsername(Aws::String&& value) { m_usernameHasBeenSet = true; m_username = std::move(value); } /** *The user name of the user whose password you want to reset.
*/ inline void SetUsername(const char* value) { m_usernameHasBeenSet = true; m_username.assign(value); } /** *The user name of the user whose password you want to reset.
*/ inline AdminResetUserPasswordRequest& WithUsername(const Aws::String& value) { SetUsername(value); return *this;} /** *The user name of the user whose password you want to reset.
*/ inline AdminResetUserPasswordRequest& WithUsername(Aws::String&& value) { SetUsername(std::move(value)); return *this;} /** *The user name of the user whose password you want to reset.
*/ inline AdminResetUserPasswordRequest& 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.
You create custom workflows by
* assigning Lambda functions to user pool triggers. When you use the
* AdminResetUserPassword API action, Amazon Cognito invokes the function that is
* assigned to the custom message 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
* AdminResetUserPassword 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
* AdminResetUserPassword API action, Amazon Cognito invokes the function that is
* assigned to the custom message 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
* AdminResetUserPassword 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
* AdminResetUserPassword API action, Amazon Cognito invokes the function that is
* assigned to the custom message 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
* AdminResetUserPassword 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
* AdminResetUserPassword API action, Amazon Cognito invokes the function that is
* assigned to the custom message 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
* AdminResetUserPassword 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
* AdminResetUserPassword API action, Amazon Cognito invokes the function that is
* assigned to the custom message 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
* AdminResetUserPassword 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
* AdminResetUserPassword API action, Amazon Cognito invokes the function that is
* assigned to the custom message 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
* AdminResetUserPassword 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
* AdminResetUserPassword API action, Amazon Cognito invokes the function that is
* assigned to the custom message 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
* AdminResetUserPassword 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
* AdminResetUserPassword API action, Amazon Cognito invokes the function that is
* assigned to the custom message 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
* AdminResetUserPassword 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
* AdminResetUserPassword API action, Amazon Cognito invokes the function that is
* assigned to the custom message 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
* AdminResetUserPassword 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
* AdminResetUserPassword API action, Amazon Cognito invokes the function that is
* assigned to the custom message 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
* AdminResetUserPassword 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
* AdminResetUserPassword API action, Amazon Cognito invokes the function that is
* assigned to the custom message 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
* AdminResetUserPassword 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
* AdminResetUserPassword API action, Amazon Cognito invokes the function that is
* assigned to the custom message 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
* AdminResetUserPassword 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
* AdminResetUserPassword API action, Amazon Cognito invokes the function that is
* assigned to the custom message 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
* AdminResetUserPassword 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.