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 { ConfirmDeviceRequest, ConfirmDeviceResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ConfirmDeviceCommand}. */ export interface ConfirmDeviceCommandInput extends ConfirmDeviceRequest { } /** * @public * * The output of {@link ConfirmDeviceCommand}. */ export interface ConfirmDeviceCommandOutput extends ConfirmDeviceResponse, __MetadataBearer { } declare const ConfirmDeviceCommand_base: { new (input: ConfirmDeviceCommandInput): import("@smithy/core/client").CommandImpl; new (input: ConfirmDeviceCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Confirms a device that a user wants to remember. A remembered device is a "Remember me * on this device" option for user pools that perform authentication with the device key of * a trusted device in the back end, instead of a user-provided MFA code. For more * information about device authentication, see Working with user devices in your user pool.

*

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

* *

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, ConfirmDeviceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import * // const { CognitoIdentityProviderClient, ConfirmDeviceCommand } = 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 = { // ConfirmDeviceRequest * AccessToken: "STRING_VALUE", // required * DeviceKey: "STRING_VALUE", // required * DeviceSecretVerifierConfig: { // DeviceSecretVerifierConfigType * PasswordVerifier: "STRING_VALUE", * Salt: "STRING_VALUE", * }, * DeviceName: "STRING_VALUE", * }; * const command = new ConfirmDeviceCommand(input); * const response = await client.send(command); * // { // ConfirmDeviceResponse * // UserConfirmationNecessary: true || false, * // }; * * ``` * * @param ConfirmDeviceCommandInput - {@link ConfirmDeviceCommandInput} * @returns {@link ConfirmDeviceCommandOutput} * @see {@link ConfirmDeviceCommandInput} for command's `input` shape. * @see {@link ConfirmDeviceCommandOutput} for command's `response` shape. * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape. * * @throws {@link DeviceKeyExistsException} (client fault) *

This exception is thrown when a user attempts to confirm a device with a device key * that already exists.

* * @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 InvalidPasswordException} (client fault) *

This exception is thrown when Amazon Cognito encounters an invalid password.

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

This exception is thrown when the user pool configuration is not valid.

* * @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 PasswordResetRequiredException} (client fault) *

This exception is thrown when a password reset is required.

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

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

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

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

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

This exception is thrown when Amazon Cognito encounters a user name that already * exists in the user pool.

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

This exception is thrown when a user isn't confirmed successfully.

* * @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 ConfirmDeviceCommand extends ConfirmDeviceCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ConfirmDeviceRequest; output: ConfirmDeviceResponse; }; sdk: { input: ConfirmDeviceCommandInput; output: ConfirmDeviceCommandOutput; }; }; }