@aws-amplify/auth
Version:
Auth category of aws-amplify
16 lines (15 loc) • 729 B
TypeScript
import { AmplifyContext } from '@aws-amplify/core';
import { ResetPasswordInput, ResetPasswordOutput } from '../types';
export declare function resetPassword(ctx: AmplifyContext, input: ResetPasswordInput): Promise<ResetPasswordOutput>;
/**
* Resets a user's password.
*
* @param input - The ResetPasswordInput object.
* @returns ResetPasswordOutput
* @throws -{@link ForgotPasswordException }
* Thrown due to an invalid confirmation code or password.
* @throws -{@link AuthValidationErrorCode }
* Thrown due to an empty username.
* @throws AuthTokenConfigException - Thrown when the token provider config is invalid.
**/
export declare function resetPassword(input: ResetPasswordInput): Promise<ResetPasswordOutput>;