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[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the SetUserMFAPreference action instead.

Parameters

-AccessToken <String>
The access token for the set user settings request.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
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?True (ByPropertyName)
-MFAOption <MFAOptionType[]>
You can use this parameter only to set an SMS configuration that uses SMS for delivery.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMFAOptions
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the AccessToken parameter. The -PassThru parameter is deprecated, use -Select '^AccessToken' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentityProvider.Model.SetUserSettingsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Inputs

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

Outputs

This cmdlet does not generate 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