cognitoidentityprovider_admin_update_user_attributes: Updates the specified user's attributes

In paws.security.identity: 'Amazon Web Services' Security, Identity, & Compliance Services

Updates the specified user's attributes

Description

Updates the specified user's attributes. To delete an attribute from your user, submit the attribute in your API request with a blank value.

See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_admin_update_user_attributes/ for full documentation.

Usage

cognitoidentityprovider_admin_update_user_attributes(
  UserPoolId,
  Username,
  UserAttributes,
  ClientMetadata = NULL
)

Arguments

UserPoolId	[required] The ID of the user pool where you want to update user attributes.
Username	[required] The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
UserAttributes	[required] An array of name-value pairs representing user attributes. For custom attributes, you must prepend the ⁠custom:⁠ prefix to the attribute name. If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito 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. To skip the verification message and update the value of an attribute that requires verification in the same API request, include the email_verified or phone_number_verified attribute, with a value of true. If you set the email_verified or phone_number_verified value for an email or phone_number attribute that requires verification to true, Amazon Cognito doesn’t send a verification message to your user.
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 Lambda functions to user pool triggers. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute that provides the data that you assigned to the ClientMetadata parameter in your request. In your function code, you can process the clientMetadata value to enhance your workflow for your specific needs. To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see Connecting API actions to Lambda triggers in the Amazon Cognito Developer Guide. 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.

paws.security.identity documentation built on May 31, 2026, 9:07 a.m.