CognitoIdentityProvider / Client / verify_user_attribute

verify_user_attribute#

CognitoIdentityProvider.Client.verify_user_attribute(**kwargs)#

Verifies the specified user attributes in the user pool.

If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see UserAttributeUpdateSettingsType.

See also: AWS API Documentation

Request Syntax

response = client.verify_user_attribute(
    AccessToken='string',
    AttributeName='string',
    Code='string'
)
Parameters:

  • AccessToken (string) –

    [REQUIRED]

    A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.

  • AttributeName (string) –

    [REQUIRED]

    The attribute name in the request to verify user attributes.

  • Code (string) –

    [REQUIRED]

    The verification code in the request to verify user attributes.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    A container representing the response from the server from the request to verify user attributes.

Exceptions

  • CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException

  • CognitoIdentityProvider.Client.exceptions.InvalidParameterException

  • CognitoIdentityProvider.Client.exceptions.CodeMismatchException

  • CognitoIdentityProvider.Client.exceptions.ExpiredCodeException

  • CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

  • CognitoIdentityProvider.Client.exceptions.TooManyRequestsException

  • CognitoIdentityProvider.Client.exceptions.LimitExceededException

  • CognitoIdentityProvider.Client.exceptions.PasswordResetRequiredException

  • CognitoIdentityProvider.Client.exceptions.UserNotFoundException

  • CognitoIdentityProvider.Client.exceptions.UserNotConfirmedException

  • CognitoIdentityProvider.Client.exceptions.InternalErrorException

  • CognitoIdentityProvider.Client.exceptions.AliasExistsException

  • CognitoIdentityProvider.Client.exceptions.ForbiddenException