UNPKG

609 BTypeScriptView Raw
1import { SignInInput, SignInOutput } from '../types';
2/**
3 * Signs a user in
4 *
5 * @param input - The SignInInput object
6 * @returns SignInOutput
7 * @throws service: {@link InitiateAuthException }, {@link RespondToAuthChallengeException }
8 * - Cognito service errors thrown during the sign-in process.
9 * @throws validation: {@link AuthValidationErrorCode } - Validation errors thrown when either username or password
10 * are not defined.
11 * @throws AuthTokenConfigException - Thrown when the token provider config is invalid.
12 */
13export declare function signIn(input: SignInInput): Promise<SignInOutput>;