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

Syntax

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

Description

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

Parameters

-AnalyticsMetadata_AnalyticsEndpointId <String>
The endpoint ID.
Required?False
Position?Named
Accept pipeline input?False
-ClientId <String>
The app client ID of the app 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
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
-PassThru <SwitchParameter>
Returns the value passed to the Username parameter. By default, this cmdlet does not generate any output.
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
-UserContextData_EncodedData <String>
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
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?1
Accept pipeline input?True (ByValue, )

Inputs

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

Outputs

None or System.String
When you use the PassThru parameter, this cmdlet outputs the value supplied to the Username parameter. Otherwise, this cmdlet does not return 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