confirm_forgot_password ¶

def confirm_forgot_password(
    self,
    client_id: "capo_cognito_identity_provider.types.client_id_type.ClientIdType",
    username: "capo_cognito_identity_provider.types.username_type.UsernameType",
    confirmation_code: "capo_cognito_identity_provider.types.confirmation_code_type.ConfirmationCodeType",
    password: "capo_cognito_identity_provider.types.password_type.PasswordType",
    *,
    config_overrides: Optional[CognitoIdentityProviderClientConfig] = None,
    secret_hash: Optional[
        "capo_cognito_identity_provider.types.secret_hash_type.SecretHashType"
    ] = None,
    analytics_metadata: Optional[
        "capo_cognito_identity_provider.types.analytics_metadata_type.AnalyticsMetadataType"
    ] = None,
    user_context_data: Optional[
        "capo_cognito_identity_provider.types.user_context_data_type.UserContextDataType"
    ] = None,
    client_metadata: Optional[
        "capo_cognito_identity_provider.types.client_metadata_type.ClientMetadataType"
    ] = None,
) -> "capo_cognito_identity_provider.types.confirm_forgot_password_response.ConfirmForgotPasswordResponse":
    """<p>This public API operation accepts a confirmation code that Amazon Cognito sent to a user and accepts a new password for that user.</p> <note> <p>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 <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p> </note>

    Args:
        client_id: <p>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.</p>
        secret_hash: <p>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 <code>SecretHash</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash">Computing secret hash values</a>.</p>
        username: <p>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 <code>username</code> isn't an alias attribute in your user pool, this value must be the <code>sub</code> of a local user or the username of a user from a third-party IdP.</p>
        confirmation_code: <p>The confirmation code that your user pool delivered when your user requested to reset their password.</p>
        password: <p>The new password that your user wants to set.</p>
        analytics_metadata: <p>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.</p>
        user_context_data: <p>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.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in applications</a>.</p>
        client_metadata: <p>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 Lambda functions to user pool triggers.</p> <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute that provides the data that you assigned to the ClientMetadata parameter in your request. In your function code, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-working-with-lambda-triggers.html#lambda-triggers-by-event"> Connecting API actions to Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the <code>ClientMetadata</code> value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the <code>ClientMetadata</code> parameter serves no purpose.</p> </li> <li> <p>Validate the <code>ClientMetadata</code> value.</p> </li> <li> <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive information in this parameter.</p> </li> </ul> </note>

    Raises:
        capo_cognito_identity_provider.errors.code_mismatch_exception.CodeMismatchException: <p>This exception is thrown if the provided code doesn't match what the server was expecting.</p>
        capo_cognito_identity_provider.errors.expired_code_exception.ExpiredCodeException: <p>This exception is thrown if a code has expired.</p>
        capo_cognito_identity_provider.errors.forbidden_exception.ForbiddenException: <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
        capo_cognito_identity_provider.errors.internal_error_exception.InternalErrorException: <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
        capo_cognito_identity_provider.errors.invalid_lambda_response_exception.InvalidLambdaResponseException: <p>This exception is thrown when Amazon Cognito encounters an invalid Lambda response.</p>
        capo_cognito_identity_provider.errors.invalid_parameter_exception.InvalidParameterException: <p>This exception is thrown when the Amazon Cognito service encounters an invalid parameter.</p>
        capo_cognito_identity_provider.errors.invalid_password_exception.InvalidPasswordException: <p>This exception is thrown when Amazon Cognito encounters an invalid password.</p>
        capo_cognito_identity_provider.errors.limit_exceeded_exception.LimitExceededException: <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.</p>
        capo_cognito_identity_provider.errors.not_authorized_exception.NotAuthorizedException: <p>This exception is thrown when a user isn't authorized.</p>
        capo_cognito_identity_provider.errors.operation_not_enabled_exception.OperationNotEnabledException: <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</p>
        capo_cognito_identity_provider.errors.password_history_policy_violation_exception.PasswordHistoryPolicyViolationException: <p>The message returned when a user's new password matches a previous password and doesn't comply with the password-history policy.</p>
        capo_cognito_identity_provider.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when the Amazon Cognito service can't find the requested resource.</p>
        capo_cognito_identity_provider.errors.too_many_failed_attempts_exception.TooManyFailedAttemptsException: <p>This exception is thrown when the user has made too many failed attempts for a given action, such as sign-in.</p>
        capo_cognito_identity_provider.errors.too_many_requests_exception.TooManyRequestsException: <p>This exception is thrown when the user has made too many requests for a given operation.</p>
        capo_cognito_identity_provider.errors.unexpected_lambda_exception.UnexpectedLambdaException: <p>This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.</p>
        capo_cognito_identity_provider.errors.user_lambda_validation_exception.UserLambdaValidationException: <p>This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.</p>
        capo_cognito_identity_provider.errors.user_not_confirmed_exception.UserNotConfirmedException: <p>This exception is thrown when a user isn't confirmed successfully.</p>
        capo_cognito_identity_provider.errors.user_not_found_exception.UserNotFoundException: <p>This exception is thrown when a user isn't found.</p>
        capo_cognito_identity_provider.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cognito_identity_provider.types.confirm_forgot_password_request.ConfirmForgotPasswordRequest]",
    ) -> OperationResponse[
        "capo_cognito_identity_provider.types.confirm_forgot_password_response.ConfirmForgotPasswordResponse"
    ]:
        import capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.confirm_forgot_password

        output, http_response = (
            capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.confirm_forgot_password.confirm_forgot_password(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_cognito_identity_provider.types.confirm_forgot_password_request.ConfirmForgotPasswordRequest",
    ) -> dict[str, Any]:
        import capo_cognito_identity_provider.types.confirm_forgot_password_request

        return capo_cognito_identity_provider.types.confirm_forgot_password_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ConfirmForgotPassword", redact_input=_redact_input),
    )
    input_: capo_cognito_identity_provider.types.confirm_forgot_password_request.ConfirmForgotPasswordRequest = {
        "client_id": client_id,
        "username": username,
        "confirmation_code": confirmation_code,
        "password": password,
    }
    if secret_hash is not None:
        input_["secret_hash"] = secret_hash
    if analytics_metadata is not None:
        input_["analytics_metadata"] = analytics_metadata
    if user_context_data is not None:
        input_["user_context_data"] = user_context_data
    if client_metadata is not None:
        input_["client_metadata"] = client_metadata

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output