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

Sets user pool multi-factor authentication (MFA) and passkey configuration. For more * information about user pool MFA, see Adding MFA. For more information about WebAuthn passkeys see Authentication flows.

* *

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers * require you to register an origination phone number before you can send SMS messages * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a * phone number with Amazon Pinpoint. * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must * receive SMS messages might not be able to sign up, activate their accounts, or sign * in.

*

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, * Amazon Simple Notification Service might place your account in the SMS sandbox. In * sandbox * mode * , you can send messages only to verified phone * numbers. After you test your app while in the sandbox environment, you can move out * of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito * Developer Guide.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CognitoIdentityProviderClient, SetUserPoolMfaConfigCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import * // const { CognitoIdentityProviderClient, SetUserPoolMfaConfigCommand } = 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 = { // SetUserPoolMfaConfigRequest * UserPoolId: "STRING_VALUE", // required * SmsMfaConfiguration: { // SmsMfaConfigType * SmsAuthenticationMessage: "STRING_VALUE", * SmsConfiguration: { // SmsConfigurationType * SnsCallerArn: "STRING_VALUE", // required * ExternalId: "STRING_VALUE", * SnsRegion: "STRING_VALUE", * }, * }, * SoftwareTokenMfaConfiguration: { // SoftwareTokenMfaConfigType * Enabled: true || false, * }, * EmailMfaConfiguration: { // EmailMfaConfigType * Message: "STRING_VALUE", * Subject: "STRING_VALUE", * }, * MfaConfiguration: "OFF" || "ON" || "OPTIONAL", * WebAuthnConfiguration: { // WebAuthnConfigurationType * RelyingPartyId: "STRING_VALUE", * UserVerification: "required" || "preferred", * FactorConfiguration: "SINGLE_FACTOR" || "MULTI_FACTOR_WITH_USER_VERIFICATION", * }, * }; * const command = new SetUserPoolMfaConfigCommand(input); * const response = await client.send(command); * // { // SetUserPoolMfaConfigResponse * // SmsMfaConfiguration: { // SmsMfaConfigType * // SmsAuthenticationMessage: "STRING_VALUE", * // SmsConfiguration: { // SmsConfigurationType * // SnsCallerArn: "STRING_VALUE", // required * // ExternalId: "STRING_VALUE", * // SnsRegion: "STRING_VALUE", * // }, * // }, * // SoftwareTokenMfaConfiguration: { // SoftwareTokenMfaConfigType * // Enabled: true || false, * // }, * // EmailMfaConfiguration: { // EmailMfaConfigType * // Message: "STRING_VALUE", * // Subject: "STRING_VALUE", * // }, * // MfaConfiguration: "OFF" || "ON" || "OPTIONAL", * // WebAuthnConfiguration: { // WebAuthnConfigurationType * // RelyingPartyId: "STRING_VALUE", * // UserVerification: "required" || "preferred", * // FactorConfiguration: "SINGLE_FACTOR" || "MULTI_FACTOR_WITH_USER_VERIFICATION", * // }, * // }; * * ``` * * @param SetUserPoolMfaConfigCommandInput - {@link SetUserPoolMfaConfigCommandInput} * @returns {@link SetUserPoolMfaConfigCommandOutput} * @see {@link SetUserPoolMfaConfigCommandInput} for command's `input` shape. * @see {@link SetUserPoolMfaConfigCommandOutput} 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 FeatureUnavailableInTierException} (client fault) *

This exception is thrown when a feature you attempted to configure isn't * available in your current feature plan.

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

This exception is returned when the role provided for SMS configuration doesn't have * permission to publish using Amazon SNS.

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

This exception is thrown when the trust relationship is not valid for the role * provided for SMS configuration. This can happen if you don't trust * cognito-idp.amazonaws.com or the external ID provided in the role does * not match what is provided in the SMS configuration for the user pool.

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

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

* * @throws {@link CognitoIdentityProviderServiceException} *

Base exception class for all service exceptions from CognitoIdentityProvider service.

* * * @public */ export declare class SetUserPoolMfaConfigCommand extends SetUserPoolMfaConfigCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: SetUserPoolMfaConfigRequest; output: SetUserPoolMfaConfigResponse; }; sdk: { input: SetUserPoolMfaConfigCommandInput; output: SetUserPoolMfaConfigCommandOutput; }; }; }