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

Set the user's multi-factor authentication (MFA) method preference, including which * MFA factors are activated and if any are preferred. Only one factor can be set as * preferred. The preferred MFA factor will be used to authenticate a user if multiple * factors are activated. If multiple options are activated and no preference is set, a * challenge to choose an MFA option will be returned during sign-in. If an MFA type is * activated for a user, the user will be prompted for MFA during all sign-in attempts * unless device tracking is turned on and the device has been trusted. If you want MFA to * be applied selectively based on the assessed risk level of sign-in attempts, deactivate * MFA for users and turn on Adaptive Authentication for the 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, SetUserMFAPreferenceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import * // const { CognitoIdentityProviderClient, SetUserMFAPreferenceCommand } = 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 = { // SetUserMFAPreferenceRequest * SMSMfaSettings: { // SMSMfaSettingsType * Enabled: true || false, * PreferredMfa: true || false, * }, * SoftwareTokenMfaSettings: { // SoftwareTokenMfaSettingsType * Enabled: true || false, * PreferredMfa: true || false, * }, * EmailMfaSettings: { // EmailMfaSettingsType * Enabled: true || false, * PreferredMfa: true || false, * }, * WebAuthnMfaSettings: { // WebAuthnMfaSettingsType * Enabled: true || false, * }, * AccessToken: "STRING_VALUE", // required * }; * const command = new SetUserMFAPreferenceCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param SetUserMFAPreferenceCommandInput - {@link SetUserMFAPreferenceCommandInput} * @returns {@link SetUserMFAPreferenceCommandOutput} * @see {@link SetUserMFAPreferenceCommandInput} for command's `input` shape. * @see {@link SetUserMFAPreferenceCommandOutput} for command's `response` shape. * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape. * * @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 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 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 SetUserMFAPreferenceCommand extends SetUserMFAPreferenceCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: SetUserMFAPreferenceRequest; output: {}; }; sdk: { input: SetUserMFAPreferenceCommandInput; output: SetUserMFAPreferenceCommandOutput; }; }; }