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

Syntax

Reset-CGIPForgottenPassword
-Username <String>
-AnalyticsMetadata_AnalyticsEndpointId <String>
-ClientId <String>
-UserContextData_EncodedData <String>
-SecretHash <String>
-Force <SwitchParameter>

Description

Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. If a verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a verified email exists, InvalidParameterException is thrown. To use the confirmation code for resetting the password, call .

Parameters

-AnalyticsMetadata_AnalyticsEndpointId <String>
The endpoint ID.
Required?False
Position?Named
Accept pipeline input?False
-ClientId <String>
The ID of the client associated with the user pool.
Required?False
Position?Named
Accept pipeline input?True (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
-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 reset a forgotten password.
Required?False
Position?1
Accept pipeline input?True (ByValue, )

Inputs

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

Outputs

Amazon.CognitoIdentityProvider.Model.CodeDeliveryDetailsType
This cmdlet returns a CodeDeliveryDetailsType object. The service call response (type Amazon.CognitoIdentityProvider.Model.ForgotPasswordResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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