CognitoIdentityProvider / Client / update_user_attributes

update_user_attributes#

CognitoIdentityProvider.Client.update_user_attributes(**kwargs)#

With this operation, your users can update one or more of their attributes with their own credentials. You authorize this API request with the user’s access token. To delete an attribute from your user, submit the attribute in your API request with a blank value. Custom attribute values in this request must include the custom: prefix.

Authorize this action with a signed-in user’s access token. It must include the scope aws.cognito.signin.user.admin.

Note

Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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

Request Syntax

response = client.update_user_attributes(
    UserAttributes=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    AccessToken='string',
    ClientMetadata={
        'string': 'string'
    }
)

Parameters:

UserAttributes (list) –
[REQUIRED]

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.
- (dict) –
  
  The name and value of a user attribute.
  
  This data type is a request parameter of AdminUpdateUserAttributes and UpdateUserAttributes.
  - Name (string) – [REQUIRED]
    
    The name of the attribute.
  - Value (string) –
    
    The value of the attribute.
AccessToken (string) –
[REQUIRED]

A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.
ClientMetadata (dict) –
A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes 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 UpdateUserAttributes 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, note 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 send sensitive information in this parameter.
- (string) –
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'CodeDeliveryDetailsList': [
        {
            'Destination': 'string',
            'DeliveryMedium': 'SMS'|'EMAIL',
            'AttributeName': 'string'
        },
    ]
}

Response Structure

(dict) –

Represents the response from the server for the request to update user attributes.
- CodeDeliveryDetailsList (list) –
  
  The code delivery details list from the server for the request to update user attributes.
  - (dict) –
    
    The delivery details for an email or SMS message that Amazon Cognito sent for authentication or verification.
    
    This data type is a response parameter of operations that send a code for user profile confirmation, verification, or management, for example ForgotPassword and SignUp.
    - 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.CodeMismatchException
CognitoIdentityProvider.Client.exceptions.ExpiredCodeException
CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
CognitoIdentityProvider.Client.exceptions.UnexpectedLambdaException
CognitoIdentityProvider.Client.exceptions.UserLambdaValidationException
CognitoIdentityProvider.Client.exceptions.InvalidLambdaResponseException
CognitoIdentityProvider.Client.exceptions.TooManyRequestsException
CognitoIdentityProvider.Client.exceptions.AliasExistsException
CognitoIdentityProvider.Client.exceptions.InvalidSmsRoleAccessPolicyException
CognitoIdentityProvider.Client.exceptions.InvalidSmsRoleTrustRelationshipException
CognitoIdentityProvider.Client.exceptions.InvalidEmailRoleAccessPolicyException
CognitoIdentityProvider.Client.exceptions.CodeDeliveryFailureException
CognitoIdentityProvider.Client.exceptions.PasswordResetRequiredException
CognitoIdentityProvider.Client.exceptions.UserNotFoundException
CognitoIdentityProvider.Client.exceptions.UserNotConfirmedException
CognitoIdentityProvider.Client.exceptions.InternalErrorException
CognitoIdentityProvider.Client.exceptions.ForbiddenException