@aws-amplify/auth/dist/esm/providers/cognito/apis/signIn.d.ts

Auth category of aws-amplify

import { AmplifyContext } from '@aws-amplify/core';
import { SignInInput, SignInOutput } from '../types';
export declare function signIn(ctx: AmplifyContext, input: SignInInput): Promise<SignInOutput>;
/**
 * 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>;