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

Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) * for a user, with a unique private key that Amazon Cognito generates and returns in the API * response. You can authorize an AssociateSoftwareToken request with either * the user's access token, or a session string from a challenge response that you received * from Amazon Cognito.

* *

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.

*
*

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CognitoIdentityProviderClient, AssociateSoftwareTokenCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import * // const { CognitoIdentityProviderClient, AssociateSoftwareTokenCommand } = 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 = { // AssociateSoftwareTokenRequest * AccessToken: "STRING_VALUE", * Session: "STRING_VALUE", * }; * const command = new AssociateSoftwareTokenCommand(input); * const response = await client.send(command); * // { // AssociateSoftwareTokenResponse * // SecretCode: "STRING_VALUE", * // Session: "STRING_VALUE", * // }; * * ``` * * @param AssociateSoftwareTokenCommandInput - {@link AssociateSoftwareTokenCommandInput} * @returns {@link AssociateSoftwareTokenCommandOutput} * @see {@link AssociateSoftwareTokenCommandInput} for command's `input` shape. * @see {@link AssociateSoftwareTokenCommandOutput} for command's `response` shape. * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape. * * @throws {@link ConcurrentModificationException} (client fault) *

This exception is thrown if two or more modifications are happening * concurrently.

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

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

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

This exception is thrown when the software token time-based one-time password (TOTP) * multi-factor authentication (MFA) isn't activated for the user pool.

* * @throws {@link CognitoIdentityProviderServiceException} *

Base exception class for all service exceptions from CognitoIdentityProvider service.

* * * @public */ export declare class AssociateSoftwareTokenCommand extends AssociateSoftwareTokenCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: AssociateSoftwareTokenRequest; output: AssociateSoftwareTokenResponse; }; sdk: { input: AssociateSoftwareTokenCommandInput; output: AssociateSoftwareTokenCommandOutput; }; }; }