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

Invokes the DeleteUserAttributes operation against Amazon Cognito Identity Provider. This operation uses anonymous authentication and does not require credential parameters to be supplied.

Syntax

Remove-CGIPUserAttribute
-AccessToken <String>
-UserAttributeName <String[]>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Deletes the attributes for a user.

Parameters

-AccessToken <String>
The access token used in the request to delete user attributes.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-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
-PassThru <SwitchParameter>
Returns the value passed to the AccessToken parameter. By default, this cmdlet does not generate any output.
Required?False
Position?Named
Accept pipeline input?False
-UserAttributeName <String[]>
An array of strings representing the user attribute names you wish to delete.For custom attributes, you must prepend the custom: prefix to the attribute name.
Required?False
Position?Named
Accept pipeline input?False

Inputs

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

Outputs

None or System.String
When you use the PassThru parameter, this cmdlet outputs the value supplied to the AccessToken parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.CognitoIdentityProvider.Model.DeleteUserAttributesResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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