ConfirmForgotPassword

Information that supports analytics outcomes with Amazon Pinpoint, including the user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.

Type: AnalyticsMetadataType object

Required: No

The ID of the app client where the user wants to reset their password. This parameter is an identifier of the client application that users are resetting their password from, but this operation resets users' irrespective of the app clients they sign in to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+]+

Required: Yes

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Amazon Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Amazon Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Using Lambda triggers in the Amazon Cognito Developer Guide.

Type: String to string map

Key Length Constraints: Minimum length of 0. Maximum length of 131072.

Value Length Constraints: Minimum length of 0. Maximum length of 131072.

Required: No

The confirmation code that your user pool delivered when your user requested to reset their password.

Your user pool sends these codes in response to AdminResetUserPassword or ForgotPassword requests.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [\S]+

Required: Yes

The new password that your user wants to set.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [\S]+

Required: Yes

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. For more information about SecretHash, see Computing secret hash values.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+=/]+

Required: No

Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

For more information, see Collecting data for threat protection in applications.

Type: UserContextDataType object

Required: No

The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Required: Yes

This exception is thrown if the provided code doesn't match what the server was expecting.

HTTP Status Code: 400

This exception is thrown if a code has expired.

HTTP Status Code: 400

This exception is thrown when Amazon WAF doesn't allow your request based on a web ACL that's associated with your user pool.

HTTP Status Code: 400

This exception is thrown when Amazon Cognito encounters an internal error.

HTTP Status Code: 500

This exception is thrown when Amazon Cognito encounters an invalid Amazon Lambda response.

HTTP Status Code: 400

This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

HTTP Status Code: 400

This exception is thrown when Amazon Cognito encounters an invalid password.

HTTP Status Code: 400

This exception is thrown when a user exceeds the limit for a requested Amazon resource.

HTTP Status Code: 400

This exception is thrown when a user isn't authorized.

HTTP Status Code: 400

The message returned when a user's new password matches a previous password and doesn't comply with the password-history policy.

HTTP Status Code: 400

This exception is thrown when the Amazon Cognito service can't find the requested resource.

HTTP Status Code: 400

This exception is thrown when the user has made too many failed attempts for a given action, such as sign-in.

HTTP Status Code: 400

This exception is thrown when the user has made too many requests for a given operation.

HTTP Status Code: 400

This exception is thrown when Amazon Cognito encounters an unexpected exception with Amazon Lambda.

HTTP Status Code: 400

This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Amazon Lambda service.

HTTP Status Code: 400

This exception is thrown when a user isn't confirmed successfully.

HTTP Status Code: 400

This exception is thrown when a user isn't found.

HTTP Status Code: 400