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.

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

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginConfirmForgotPassword and EndConfirmForgotPassword.

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

Syntax

C#
public abstract Task<ConfirmForgotPasswordResponse> ConfirmForgotPasswordAsync(
         ConfirmForgotPasswordRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CognitoIdentityProvider.Model.ConfirmForgotPasswordRequest

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

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the ConfirmForgotPassword service method, as returned by CognitoIdentityProvider.

Exceptions

ExceptionCondition
CodeMismatchException This exception is thrown if the provided code doesn't match what the server was expecting.
ExpiredCodeException This exception is thrown if a code has expired.
ForbiddenException This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.
InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.
InvalidLambdaResponseException This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
InvalidPasswordException This exception is thrown when Amazon Cognito encounters an invalid password.
LimitExceededException This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
NotAuthorizedException This exception is thrown when a user isn't authorized.
ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyFailedAttemptsException This exception is thrown when the user has made too many failed attempts for a given action, such as sign-in.
TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.
UnexpectedLambdaException This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
UserLambdaValidationException This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
UserNotConfirmedException This exception is thrown when a user isn't confirmed successfully.
UserNotFoundException This exception is thrown when a user isn't found.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also