@aws-amplify/auth
Version:
Auth category of aws-amplify
13 lines (12 loc) • 711 B
TypeScript
import { SignInWithUserPasswordInput, SignInWithUserPasswordOutput } from '../types';
/**
* Signs a user in using USER_PASSWORD_AUTH AuthFlowType
*
* @param input - The SignInWithUserPasswordInput object
* @returns SignInWithUserPasswordOutput
* @throws service: {@link InitiateAuthException } - Cognito service error thrown during the sign-in process.
* @throws validation: {@link AuthValidationErrorCode } - Validation errors thrown when either username or password
* are not defined.
* @throws AuthTokenConfigException - Thrown when the token provider config is invalid.
*/
export declare function signInWithUserPassword(input: SignInWithUserPasswordInput): Promise<SignInWithUserPasswordOutput>;