/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Represents the request to get user attribute verification.See
* Also:
AWS
* API Reference
The access token returned by the server response to get the user attribute * verification code.
*/ inline const Aws::String& GetAccessToken() const{ return m_accessToken; } /** *The access token returned by the server response to get the user attribute * verification code.
*/ inline bool AccessTokenHasBeenSet() const { return m_accessTokenHasBeenSet; } /** *The access token returned by the server response to get the user attribute * verification code.
*/ inline void SetAccessToken(const Aws::String& value) { m_accessTokenHasBeenSet = true; m_accessToken = value; } /** *The access token returned by the server response to get the user attribute * verification code.
*/ inline void SetAccessToken(Aws::String&& value) { m_accessTokenHasBeenSet = true; m_accessToken = std::move(value); } /** *The access token returned by the server response to get the user attribute * verification code.
*/ inline void SetAccessToken(const char* value) { m_accessTokenHasBeenSet = true; m_accessToken.assign(value); } /** *The access token returned by the server response to get the user attribute * verification code.
*/ inline GetUserAttributeVerificationCodeRequest& WithAccessToken(const Aws::String& value) { SetAccessToken(value); return *this;} /** *The access token returned by the server response to get the user attribute * verification code.
*/ inline GetUserAttributeVerificationCodeRequest& WithAccessToken(Aws::String&& value) { SetAccessToken(std::move(value)); return *this;} /** *The access token returned by the server response to get the user attribute * verification code.
*/ inline GetUserAttributeVerificationCodeRequest& WithAccessToken(const char* value) { SetAccessToken(value); return *this;} /** *The attribute name returned by the server response to get the user attribute * verification code.
*/ inline const Aws::String& GetAttributeName() const{ return m_attributeName; } /** *The attribute name returned by the server response to get the user attribute * verification code.
*/ inline bool AttributeNameHasBeenSet() const { return m_attributeNameHasBeenSet; } /** *The attribute name returned by the server response to get the user attribute * verification code.
*/ inline void SetAttributeName(const Aws::String& value) { m_attributeNameHasBeenSet = true; m_attributeName = value; } /** *The attribute name returned by the server response to get the user attribute * verification code.
*/ inline void SetAttributeName(Aws::String&& value) { m_attributeNameHasBeenSet = true; m_attributeName = std::move(value); } /** *The attribute name returned by the server response to get the user attribute * verification code.
*/ inline void SetAttributeName(const char* value) { m_attributeNameHasBeenSet = true; m_attributeName.assign(value); } /** *The attribute name returned by the server response to get the user attribute * verification code.
*/ inline GetUserAttributeVerificationCodeRequest& WithAttributeName(const Aws::String& value) { SetAttributeName(value); return *this;} /** *The attribute name returned by the server response to get the user attribute * verification code.
*/ inline GetUserAttributeVerificationCodeRequest& WithAttributeName(Aws::String&& value) { SetAttributeName(std::move(value)); return *this;} /** *The attribute name returned by the server response to get the user attribute * verification code.
*/ inline GetUserAttributeVerificationCodeRequest& WithAttributeName(const char* value) { SetAttributeName(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 AWS Lambda functions to user pool triggers. When you use the
* GetUserAttributeVerificationCode 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
* GetUserAttributeVerificationCode request. In your function code in AWS 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.
Take the following limitations into consideration when * you use the ClientMetadata parameter:
Amazon Cognito does not * store the ClientMetadata value. This data is available only to AWS Lambda * triggers that are assigned to a user pool to support custom workflows. If your * user pool configuration does not include triggers, the ClientMetadata parameter * serves no purpose.
Amazon Cognito does not validate the * ClientMetadata value.
Amazon Cognito does not encrypt the the * ClientMetadata value, so don't use it 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 AWS Lambda functions to user pool triggers. When you use the
* GetUserAttributeVerificationCode 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
* GetUserAttributeVerificationCode request. In your function code in AWS 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.
Take the following limitations into consideration when * you use the ClientMetadata parameter:
Amazon Cognito does not * store the ClientMetadata value. This data is available only to AWS Lambda * triggers that are assigned to a user pool to support custom workflows. If your * user pool configuration does not include triggers, the ClientMetadata parameter * serves no purpose.
Amazon Cognito does not validate the * ClientMetadata value.
Amazon Cognito does not encrypt the the * ClientMetadata value, so don't use it 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 AWS Lambda functions to user pool triggers. When you use the
* GetUserAttributeVerificationCode 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
* GetUserAttributeVerificationCode request. In your function code in AWS 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.
Take the following limitations into consideration when * you use the ClientMetadata parameter:
Amazon Cognito does not * store the ClientMetadata value. This data is available only to AWS Lambda * triggers that are assigned to a user pool to support custom workflows. If your * user pool configuration does not include triggers, the ClientMetadata parameter * serves no purpose.
Amazon Cognito does not validate the * ClientMetadata value.
Amazon Cognito does not encrypt the the * ClientMetadata value, so don't use it 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 AWS Lambda functions to user pool triggers. When you use the
* GetUserAttributeVerificationCode 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
* GetUserAttributeVerificationCode request. In your function code in AWS 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.
Take the following limitations into consideration when * you use the ClientMetadata parameter:
Amazon Cognito does not * store the ClientMetadata value. This data is available only to AWS Lambda * triggers that are assigned to a user pool to support custom workflows. If your * user pool configuration does not include triggers, the ClientMetadata parameter * serves no purpose.
Amazon Cognito does not validate the * ClientMetadata value.
Amazon Cognito does not encrypt the the * ClientMetadata value, so don't use it 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 AWS Lambda functions to user pool triggers. When you use the
* GetUserAttributeVerificationCode 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
* GetUserAttributeVerificationCode request. In your function code in AWS 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.
Take the following limitations into consideration when * you use the ClientMetadata parameter:
Amazon Cognito does not * store the ClientMetadata value. This data is available only to AWS Lambda * triggers that are assigned to a user pool to support custom workflows. If your * user pool configuration does not include triggers, the ClientMetadata parameter * serves no purpose.
Amazon Cognito does not validate the * ClientMetadata value.
Amazon Cognito does not encrypt the the * ClientMetadata value, so don't use it 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 AWS Lambda functions to user pool triggers. When you use the
* GetUserAttributeVerificationCode 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
* GetUserAttributeVerificationCode request. In your function code in AWS 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.
Take the following limitations into consideration when * you use the ClientMetadata parameter:
Amazon Cognito does not * store the ClientMetadata value. This data is available only to AWS Lambda * triggers that are assigned to a user pool to support custom workflows. If your * user pool configuration does not include triggers, the ClientMetadata parameter * serves no purpose.
Amazon Cognito does not validate the * ClientMetadata value.
Amazon Cognito does not encrypt the the * ClientMetadata value, so don't use it 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 AWS Lambda functions to user pool triggers. When you use the
* GetUserAttributeVerificationCode 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
* GetUserAttributeVerificationCode request. In your function code in AWS 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.
Take the following limitations into consideration when * you use the ClientMetadata parameter:
Amazon Cognito does not * store the ClientMetadata value. This data is available only to AWS Lambda * triggers that are assigned to a user pool to support custom workflows. If your * user pool configuration does not include triggers, the ClientMetadata parameter * serves no purpose.
Amazon Cognito does not validate the * ClientMetadata value.
Amazon Cognito does not encrypt the the * ClientMetadata value, so don't use it 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 AWS Lambda functions to user pool triggers. When you use the
* GetUserAttributeVerificationCode 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
* GetUserAttributeVerificationCode request. In your function code in AWS 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.
Take the following limitations into consideration when * you use the ClientMetadata parameter:
Amazon Cognito does not * store the ClientMetadata value. This data is available only to AWS Lambda * triggers that are assigned to a user pool to support custom workflows. If your * user pool configuration does not include triggers, the ClientMetadata parameter * serves no purpose.
Amazon Cognito does not validate the * ClientMetadata value.
Amazon Cognito does not encrypt the the * ClientMetadata value, so don't use it 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 AWS Lambda functions to user pool triggers. When you use the
* GetUserAttributeVerificationCode 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
* GetUserAttributeVerificationCode request. In your function code in AWS 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.
Take the following limitations into consideration when * you use the ClientMetadata parameter:
Amazon Cognito does not * store the ClientMetadata value. This data is available only to AWS Lambda * triggers that are assigned to a user pool to support custom workflows. If your * user pool configuration does not include triggers, the ClientMetadata parameter * serves no purpose.
Amazon Cognito does not validate the * ClientMetadata value.
Amazon Cognito does not encrypt the the * ClientMetadata value, so don't use it 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 AWS Lambda functions to user pool triggers. When you use the
* GetUserAttributeVerificationCode 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
* GetUserAttributeVerificationCode request. In your function code in AWS 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.
Take the following limitations into consideration when * you use the ClientMetadata parameter:
Amazon Cognito does not * store the ClientMetadata value. This data is available only to AWS Lambda * triggers that are assigned to a user pool to support custom workflows. If your * user pool configuration does not include triggers, the ClientMetadata parameter * serves no purpose.
Amazon Cognito does not validate the * ClientMetadata value.
Amazon Cognito does not encrypt the the * ClientMetadata value, so don't use it 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 AWS Lambda functions to user pool triggers. When you use the
* GetUserAttributeVerificationCode 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
* GetUserAttributeVerificationCode request. In your function code in AWS 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.
Take the following limitations into consideration when * you use the ClientMetadata parameter:
Amazon Cognito does not * store the ClientMetadata value. This data is available only to AWS Lambda * triggers that are assigned to a user pool to support custom workflows. If your * user pool configuration does not include triggers, the ClientMetadata parameter * serves no purpose.
Amazon Cognito does not validate the * ClientMetadata value.
Amazon Cognito does not encrypt the the * ClientMetadata value, so don't use it 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 AWS Lambda functions to user pool triggers. When you use the
* GetUserAttributeVerificationCode 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
* GetUserAttributeVerificationCode request. In your function code in AWS 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.
Take the following limitations into consideration when * you use the ClientMetadata parameter:
Amazon Cognito does not * store the ClientMetadata value. This data is available only to AWS Lambda * triggers that are assigned to a user pool to support custom workflows. If your * user pool configuration does not include triggers, the ClientMetadata parameter * serves no purpose.
Amazon Cognito does not validate the * ClientMetadata value.
Amazon Cognito does not encrypt the the * ClientMetadata value, so don't use it 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 AWS Lambda functions to user pool triggers. When you use the
* GetUserAttributeVerificationCode 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
* GetUserAttributeVerificationCode request. In your function code in AWS 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.
Take the following limitations into consideration when * you use the ClientMetadata parameter:
Amazon Cognito does not * store the ClientMetadata value. This data is available only to AWS Lambda * triggers that are assigned to a user pool to support custom workflows. If your * user pool configuration does not include triggers, the ClientMetadata parameter * serves no purpose.
Amazon Cognito does not validate the * ClientMetadata value.
Amazon Cognito does not encrypt the the * ClientMetadata value, so don't use it to provide sensitive information.
*