AWS SDK Version 3 for .NET
API 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.

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 ConfirmForgotPassword.

Note:

For PCL this operation is only available in asynchronous form. Please refer to ForgotPasswordAsync.

Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C#
public virtual ForgotPasswordResponse ForgotPassword(
         ForgotPasswordRequest request
)
Parameters
request
Type: Amazon.CognitoIdentityProvider.Model.ForgotPasswordRequest

Container for the necessary parameters to execute the ForgotPassword service method.

Return Value
The response from the ForgotPassword service method, as returned by CognitoIdentityProvider.

Exceptions

ExceptionCondition
CodeDeliveryFailureException This exception is thrown when a verification code fails to deliver successfully.
InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.
InvalidEmailRoleAccessPolicyException This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400.
InvalidLambdaResponseException This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
InvalidSmsRoleAccessPolicyException This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.
InvalidSmsRoleTrustRelationshipException This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
LimitExceededException This exception is thrown when a user exceeds the limit for a requested AWS resource.
NotAuthorizedException This exception is thrown when a user is not authorized.
ResourceNotFoundException This exception is thrown when the Amazon Cognito service cannot find the requested resource.
TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.
UnexpectedLambdaException This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
UserLambdaValidationException This exception is thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
UserNotConfirmedException This exception is thrown when a user is not confirmed successfully.
UserNotFoundException This exception is thrown when a user is not found.

Version Information

.NET Framework:
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

See Also