AWS Tools for Windows PowerShell
Command Reference

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.

Synopsis

Calls the Amazon Cognito Identity Provider UpdateUserAttributes API operation. This operation uses anonymous authentication and does not require credential parameters to be supplied.

Syntax

Update-CGIPUserAttribute
-AccessToken <String>
-ClientMetadata <Hashtable>
-UserAttribute <AttributeType[]>
-Force <SwitchParameter>

Description

Allows a user to update a specific attribute (one at a time).

Parameters

-AccessToken <String>
The access token for the request to update user attributes.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ClientMetadata <Hashtable>
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 AWS Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the functions that are assigned to the custom message and pre mutation triggers. When Amazon Cognito invokes either of these functions, 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 AWS 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.Take the following limitations into consideration when you use the ClientMetadata parameter:
  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
  • Amazon Cognito does not validate the ClientMetadata value.
  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
Required?False
Position?Named
Accept pipeline input?False
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-UserAttribute <AttributeType[]>
An array of name-value pairs representing user attributes.For custom attributes, you must prepend the custom: prefix to the attribute name.
Required?False
Position?Named
Accept pipeline input?False
AliasesUserAttributes

Inputs

You can pipe a String object to this cmdlet for the AccessToken parameter.

Outputs

This cmdlet returns a collection of Amazon.CognitoIdentityProvider.Model.CodeDeliveryDetailsType objects. The service call response (type Amazon.CognitoIdentityProvider.Model.UpdateUserAttributesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z