getUserAttributeVerificationCode method

Future<GetUserAttributeVerificationCodeResponse> getUserAttributeVerificationCode({ required String accessToken, required String attributeName, Map<String, String>? clientMetadata, })

Gets the user attribute verification code for the specified attribute name.

May throw ResourceNotFoundException. May throw InvalidParameterException. May throw TooManyRequestsException. May throw NotAuthorizedException. May throw UnexpectedLambdaException. May throw UserLambdaValidationException. May throw InvalidLambdaResponseException. May throw InvalidSmsRoleAccessPolicyException. May throw InvalidSmsRoleTrustRelationshipException. May throw InvalidEmailRoleAccessPolicyException. May throw CodeDeliveryFailureException. May throw LimitExceededException. May throw PasswordResetRequiredException. May throw UserNotFoundException. May throw UserNotConfirmedException. May throw InternalErrorException.

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

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

Parameter clientMetadata : 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.

• 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.

Implementation

Future<GetUserAttributeVerificationCodeResponse>
    getUserAttributeVerificationCode({
  required String accessToken,
  required String attributeName,
  Map<String, String>? clientMetadata,
}) async {
  ArgumentError.checkNotNull(accessToken, 'accessToken');
  ArgumentError.checkNotNull(attributeName, 'attributeName');
  _s.validateStringLength(
    'attributeName',
    attributeName,
    1,
    32,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target':
        'AWSCognitoIdentityProviderService.GetUserAttributeVerificationCode'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    signed: false,
    // TODO queryParams
    headers: headers,
    payload: {
      'AccessToken': accessToken,
      'AttributeName': attributeName,
      if (clientMetadata != null) 'ClientMetadata': clientMetadata,
    },
  );

  return GetUserAttributeVerificationCodeResponse.fromJson(jsonResponse.body);
}