get_user_attribute_verification_code

get_user_attribute_verification_code(**kwargs)

Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAttribute request.

Note

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.get_user_attribute_verification_code(
    AccessToken='string',
    AttributeName='string',
    ClientMetadata={
        'string': 'string'
    }
)

Parameters

• AccessToken (string) --

  [REQUIRED]

  A non-expired access token for the user whose attribute verification code you want to generate.

• AttributeName (string) --

  [REQUIRED]

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

• ClientMetadata (dict) --

  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 in the Amazon Cognito Developer Guide .

  Note

  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.
  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

{
    'CodeDeliveryDetails': {
        'Destination': 'string',
        'DeliveryMedium': 'SMS'|'EMAIL',
        'AttributeName': 'string'
    }
}

Response Structure

• (dict) --

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

  • CodeDeliveryDetails (dict) --

    The code delivery details returned by the server in response to the request to get the user attribute verification code.

    • Destination (string) --

      The email address or phone number destination where Amazon Cognito sent the code.

    • DeliveryMedium (string) --

      The method that Amazon Cognito used to send the code.

    • AttributeName (string) --

      The name of the attribute that Amazon Cognito verifies with the code.

Exceptions

• CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException
• CognitoIdentityProvider.Client.exceptions.InvalidParameterException
• CognitoIdentityProvider.Client.exceptions.TooManyRequestsException
• CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
• CognitoIdentityProvider.Client.exceptions.UnexpectedLambdaException
• CognitoIdentityProvider.Client.exceptions.UserLambdaValidationException
• CognitoIdentityProvider.Client.exceptions.InvalidLambdaResponseException
• CognitoIdentityProvider.Client.exceptions.InvalidSmsRoleAccessPolicyException
• CognitoIdentityProvider.Client.exceptions.InvalidSmsRoleTrustRelationshipException
• CognitoIdentityProvider.Client.exceptions.InvalidEmailRoleAccessPolicyException
• CognitoIdentityProvider.Client.exceptions.CodeDeliveryFailureException
• CognitoIdentityProvider.Client.exceptions.LimitExceededException
• CognitoIdentityProvider.Client.exceptions.PasswordResetRequiredException
• CognitoIdentityProvider.Client.exceptions.UserNotFoundException
• CognitoIdentityProvider.Client.exceptions.UserNotConfirmedException
• CognitoIdentityProvider.Client.exceptions.InternalErrorException
• CognitoIdentityProvider.Client.exceptions.ForbiddenException