UNPKG

@aws-amplify/auth

Version:

Auth category of aws-amplify

docs.amplify.aws

aws-amplify/amplify-js

14 lines (13 loc) • 737 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
import { AmplifyContext } from '@aws-amplify/core'; import { ConfirmUserAttributeInput } from '../types'; export declare function confirmUserAttribute(ctx: AmplifyContext, input: ConfirmUserAttributeInput): Promise<void>; /** * Confirms a user attribute with the confirmation code. * * @param input - The ConfirmUserAttributeInput object * @throws -{@link AuthValidationErrorCode } - * Thrown when `confirmationCode` is not defined. * @throws -{@link VerifyUserAttributeException } - Thrown due to an invalid confirmation code or attribute. * @throws AuthTokenConfigException - Thrown when the token provider config is invalid. */ export declare function confirmUserAttribute(input: ConfirmUserAttributeInput): Promise<void>;