@aws-amplify/auth
Version:
Auth category of aws-amplify
14 lines (13 loc) • 609 B
TypeScript
import { SignInInput, SignInOutput } from '../types';
/**
* Signs a user in
*
* @param input - The SignInInput object
* @returns SignInOutput
* @throws service: {@link InitiateAuthException }, {@link RespondToAuthChallengeException }
* - Cognito service errors 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 signIn(input: SignInInput): Promise<SignInOutput>;