/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CognitoIdp::GetUserAttributeVerificationCode

NAME

Paws::CognitoIdp::GetUserAttributeVerificationCode - Arguments for method GetUserAttributeVerificationCode on Paws::CognitoIdp

DESCRIPTION

This class represents the parameters used for calling the method GetUserAttributeVerificationCode on the Amazon Cognito Identity Provider service. Use the attributes of this class as arguments to method GetUserAttributeVerificationCode.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetUserAttributeVerificationCode.

SYNOPSIS

my $cognito-idp = Paws->service('CognitoIdp');
my $GetUserAttributeVerificationCodeResponse =
  $cognito -idp->GetUserAttributeVerificationCode(
  AccessToken    => 'MyTokenModelType',
  AttributeName  => 'MyAttributeNameType',
  ClientMetadata => { 'MyStringType' => 'MyStringType', },    # OPTIONAL
  );

# Results:
my $CodeDeliveryDetails =
  $GetUserAttributeVerificationCodeResponse->CodeDeliveryDetails;

# Returns a Paws::CognitoIdp::GetUserAttributeVerificationCodeResponse object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp/GetUserAttributeVerificationCode

ATTRIBUTES

REQUIRED AccessToken => Str

The access token returned by the server response to get the user attribute verification code.

REQUIRED AttributeName => Str

The attribute name returned by the server response to get the user attribute verification code.

ClientMetadata => Paws::CognitoIdp::ClientMetadataType

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 (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) 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.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetUserAttributeVerificationCode in Paws::CognitoIdp

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues