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 ConfirmForgotPassword operation against Amazon Cognito Identity Provider. This operation uses anonymous authentication and does not require credential parameters to be supplied.

Syntax

Confirm-CGIPForgotPassword
-ClientId <String>
-ConfirmationCode <String>
-Password <String>
-SecretHash <String>
-Username <String>
-Force <SwitchParameter>

Description

Allows a user to enter a confirmation code to reset a forgotten password.

Parameters

-ClientId <String>
The ID of the client associated with the user pool.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfirmationCode <String>
The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see ForgotPassword
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
-Password <String>
The password sent by a user's request to retrieve a forgotten password.
Required?False
Position?Named
Accept pipeline input?False
-SecretHash <String>
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
Required?False
Position?Named
Accept pipeline input?False
-Username <String>
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
Required?False
Position?Named
Accept pipeline input?False

Inputs

This cmdlet does not accept pipeline input.

Outputs

None
This cmdlet does not generate any output. The service response (type Amazon.CognitoIdentityProvider.Model.ConfirmForgotPasswordResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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