AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the UpdateUserAttributes operation.
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
.
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.
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 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.
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public class UpdateUserAttributesRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The UpdateUserAttributesRequest type exposes the following members
Name | Description | |
---|---|---|
UpdateUserAttributesRequest() |
Name | Type | Description | |
---|---|---|---|
AccessToken | System.String |
Gets and sets the property AccessToken. A valid access token that Amazon Cognito issued to the user whose user attributes you want to update. |
|
ClientMetadata | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property ClientMetadata. 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 For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
|
|
UserAttributes | System.Collections.Generic.List<Amazon.CognitoIdentityProvider.Model.AttributeType> |
Gets and sets the property UserAttributes. An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the 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. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5