import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient"; import type { ConfirmSignUpRequest, ConfirmSignUpResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ConfirmSignUpCommand}. */ export interface ConfirmSignUpCommandInput extends ConfirmSignUpRequest { } /** * @public * * The output of {@link ConfirmSignUpCommand}. */ export interface ConfirmSignUpCommandOutput extends ConfirmSignUpResponse, __MetadataBearer { } declare const ConfirmSignUpCommand_base: { new (input: ConfirmSignUpCommandInput): import("@smithy/core/client").CommandImpl; new (input: ConfirmSignUpCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Confirms the account of a new user. This public API operation submits a code that * Amazon Cognito sent to your user when they signed up in your user pool. After your user enters * their code, they confirm ownership of the email address or phone number that they * provided, and their user account becomes active. Depending on your user pool * configuration, your users will receive their confirmation code in an email or SMS * message.

*

Local users who signed up in your user pool are the only type of user who can confirm * sign-up with a code. Users who federate through an external identity provider (IdP) have * already been confirmed by their IdP.

* *

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you can't use IAM credentials to authorize requests, and you can't * grant IAM permissions in policies. For more information about authorization models in * Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CognitoIdentityProviderClient, ConfirmSignUpCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import * // const { CognitoIdentityProviderClient, ConfirmSignUpCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import * // import type { CognitoIdentityProviderClientConfig } from "@aws-sdk/client-cognito-identity-provider"; * const config = {}; // type is CognitoIdentityProviderClientConfig * const client = new CognitoIdentityProviderClient(config); * const input = { // ConfirmSignUpRequest * ClientId: "STRING_VALUE", // required * SecretHash: "STRING_VALUE", * Username: "STRING_VALUE", // required * ConfirmationCode: "STRING_VALUE", // required * ForceAliasCreation: true || false, * AnalyticsMetadata: { // AnalyticsMetadataType * AnalyticsEndpointId: "STRING_VALUE", * }, * UserContextData: { // UserContextDataType * IpAddress: "STRING_VALUE", * EncodedData: "STRING_VALUE", * }, * ClientMetadata: { // ClientMetadataType * "": "STRING_VALUE", * }, * Session: "STRING_VALUE", * }; * const command = new ConfirmSignUpCommand(input); * const response = await client.send(command); * // { // ConfirmSignUpResponse * // Session: "STRING_VALUE", * // }; * * ``` * * @param ConfirmSignUpCommandInput - {@link ConfirmSignUpCommandInput} * @returns {@link ConfirmSignUpCommandOutput} * @see {@link ConfirmSignUpCommandInput} for command's `input` shape. * @see {@link ConfirmSignUpCommandOutput} for command's `response` shape. * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape. * * @throws {@link AliasExistsException} (client fault) *

This exception is thrown when a user tries to confirm the account with an email * address or phone number that has already been supplied as an alias for a different user * profile. This exception indicates that an account with this email address or phone * already exists in a user pool that you've configured to use email address or phone * number as a sign-in alias.

* * @throws {@link CodeMismatchException} (client fault) *

This exception is thrown if the provided code doesn't match what the server was * expecting.

* * @throws {@link ExpiredCodeException} (client fault) *

This exception is thrown if a code has expired.

* * @throws {@link ForbiddenException} (client fault) *

This exception is thrown when WAF doesn't allow your request based on a web * ACL that's associated with your user pool.

* * @throws {@link InternalErrorException} (server fault) *

This exception is thrown when Amazon Cognito encounters an internal error.

* * @throws {@link InvalidLambdaResponseException} (client fault) *

This exception is thrown when Amazon Cognito encounters an invalid Lambda response.

* * @throws {@link InvalidParameterException} (client fault) *

This exception is thrown when the Amazon Cognito service encounters an invalid * parameter.

* * @throws {@link LimitExceededException} (client fault) *

This exception is thrown when a user exceeds the limit for a requested Amazon Web Services * resource.

* * @throws {@link NotAuthorizedException} (client fault) *

This exception is thrown when a user isn't authorized.

* * @throws {@link OperationNotEnabledException} (client fault) *

This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.

* * @throws {@link ResourceNotFoundException} (client fault) *

This exception is thrown when the Amazon Cognito service can't find the requested * resource.

* * @throws {@link TooManyFailedAttemptsException} (client fault) *

This exception is thrown when the user has made too many failed attempts for a given * action, such as sign-in.

* * @throws {@link TooManyRequestsException} (client fault) *

This exception is thrown when the user has made too many requests for a given * operation.

* * @throws {@link UnexpectedLambdaException} (client fault) *

This exception is thrown when Amazon Cognito encounters an unexpected exception with * Lambda.

* * @throws {@link UserLambdaValidationException} (client fault) *

This exception is thrown when the Amazon Cognito service encounters a user validation exception * with the Lambda service.

* * @throws {@link UserNotFoundException} (client fault) *

This exception is thrown when a user isn't found.

* * @throws {@link CognitoIdentityProviderServiceException} *

Base exception class for all service exceptions from CognitoIdentityProvider service.

* * * @public */ export declare class ConfirmSignUpCommand extends ConfirmSignUpCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ConfirmSignUpRequest; output: ConfirmSignUpResponse; }; sdk: { input: ConfirmSignUpCommandInput; output: ConfirmSignUpCommandOutput; }; }; }