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

Sets the user's multi-factor authentication (MFA) preference, including which MFA * options 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.

* *

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must * grant yourself the corresponding IAM permission in a policy.

*

* Learn more *

* *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CognitoIdentityProviderClient, AdminSetUserMFAPreferenceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import * // const { CognitoIdentityProviderClient, AdminSetUserMFAPreferenceCommand } = 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 = { // AdminSetUserMFAPreferenceRequest * 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, * }, * Username: "STRING_VALUE", // required * UserPoolId: "STRING_VALUE", // required * }; * const command = new AdminSetUserMFAPreferenceCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param AdminSetUserMFAPreferenceCommandInput - {@link AdminSetUserMFAPreferenceCommandInput} * @returns {@link AdminSetUserMFAPreferenceCommandOutput} * @see {@link AdminSetUserMFAPreferenceCommandInput} for command's `input` shape. * @see {@link AdminSetUserMFAPreferenceCommandOutput} for command's `response` shape. * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape. * * @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 AdminSetUserMFAPreferenceCommand extends AdminSetUserMFAPreferenceCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: AdminSetUserMFAPreferenceRequest; output: {}; }; sdk: { input: AdminSetUserMFAPreferenceCommandInput; output: AdminSetUserMFAPreferenceCommandOutput; }; }; }