@aws-amplify/auth
Version:
Auth category of aws-amplify
13 lines (12 loc) • 702 B
TypeScript
import { AmplifyContext } from '@aws-amplify/core';
import { UpdatePasswordInput } from '../types';
export declare function updatePassword(ctx: AmplifyContext, input: UpdatePasswordInput): Promise<void>;
/**
* Updates user's password while authenticated.
*
* @param input - The UpdatePasswordInput object.
* @throws - {@link ChangePasswordException} - Cognito service errors thrown when updating a password.
* @throws - {@link AuthValidationErrorCode} - Validation errors thrown when oldPassword or newPassword are empty.
* @throws AuthTokenConfigException - Thrown when the token provider config is invalid.
*/
export declare function updatePassword(input: UpdatePasswordInput): Promise<void>;