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 SetUserSettings API operation. This operation uses anonymous authentication and does not require credential parameters to be supplied.

Syntax

Set-CGIPUserSetting
-AccessToken <String>
-MFAOption <MFAOptionType[]>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed.

Parameters

-AccessToken <String>
The access token for the set user settings request.
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
-MFAOption <MFAOptionType[]>
Specifies the options for MFA (e.g., email or phone number).
Required?False
Position?Named
Accept pipeline input?False
AliasesMFAOptions
-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

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.SetUserSettingsResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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