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.
Container for the parameters to the ForgotPassword operation.
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
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 .
public class ForgotPasswordRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The ForgotPasswordRequest type exposes the following members
Gets and sets the property AnalyticsMetadata.
The Amazon Pinpoint analytics metadata for collecting metrics for
Gets and sets the property ClientId.
The ID of the client associated with the user pool.
Gets and sets the property SecretHash.
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.
Gets and sets the property UserContextData.
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.
Gets and sets the property Username.
The user name of the user for whom you want to enter a code to reset a forgotten password.
Supported in: 1.3
Supported in: 4.5, 4.0, 3.5
Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms