/ - Amazon Cognito Identity Provider

curl --location --request POST '/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "UserAttributes": [], "AccessToken": "string", "ClientMetadata": { "property1": "string", "property2": "string" } }'

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Represents the request to update user attributes.

UserAttributes

array[object (AttributeType) {2}]

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.

Name

string

required

The name of the attribute.

>= 1 characters<= 32 characters

Match pattern:

[\p{L}\p{M}\p{S}\p{N}\p{P}]+

Value

string <password>

optional

The value of the attribute.

<= 2048 characters

AccessToken

string <password>

required

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

Match pattern:

[A-Za-z0-9-_=.]+

ClientMetadata

object

optional

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.

Examples

Responses

🟢200Success

application/json

Body

Represents the response from the server for the request to update user attributes.

CodeDeliveryDetailsList

array[object (CodeDeliveryDetailsType) {3}]

optional

The code delivery details list from the server for the request to update user attributes.

Destination

string

optional

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

DeliveryMedium

enum<string>

optional

The method that Amazon Cognito used to send the code.

Allowed values:

SMSEMAIL

AttributeName

string

optional

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

>= 1 characters<= 32 characters

Match pattern:

[\p{L}\p{M}\p{S}\p{N}\p{P}]+

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482CodeMismatchException

🟠483ExpiredCodeException

🟠484NotAuthorizedException

🟠485UnexpectedLambdaException

🟠486UserLambdaValidationException

🟠487InvalidLambdaResponseException

🟠488TooManyRequestsException

🟠489AliasExistsException

🟠490InvalidSmsRoleAccessPolicyException

🟠491InvalidSmsRoleTrustRelationshipException

🟠492InvalidEmailRoleAccessPolicyException

🟠493CodeDeliveryFailureException

🟠494PasswordResetRequiredException

🟠495UserNotFoundException

🟠496UserNotConfirmedException

🟠497InternalErrorException

🟠498ForbiddenException