class Aws::CognitoIdentityProvider::Types::GetUserAttributeVerificationCodeRequest
Represents the request to get user attribute verification.
@note When making an API call, you may pass GetUserAttributeVerificationCodeRequest
data as a hash: { access_token: "TokenModelType", # required attribute_name: "AttributeNameType", # required client_metadata: { "StringType" => "StringType", }, }
@!attribute [rw] access_token
The access token returned by the server response to get the user attribute verification code. @return [String]
@!attribute [rw] attribute_name
The attribute name returned by the server response to get the user attribute verification code. @return [String]
@!attribute [rw] client_metadata
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 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 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][1] in the *Amazon Cognito Developer Guide*. <note markdown="1"> 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 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. </note> [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html @return [Hash<String,String>]
@see docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUserAttributeVerificationCodeRequest AWS API Documentation
Constants
- SENSITIVE