cognitoidentityprovider_update_user_attributes: Updates the currently signed-in user's attributes

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

Updates the currently signed-in user's attributes

Description

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

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

Usage

cognitoidentityprovider_update_user_attributes(
  UserAttributes,
  AccessToken,
  ClientMetadata = NULL
)

Arguments

UserAttributes	[required] An array of name-value pairs representing user attributes. For custom attributes, you must add a ⁠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.
AccessToken	[required] A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.
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.