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

Given a user pool ID, returns configuration for sign-in with WebAuthn authenticators * and for multi-factor authentication (MFA). This operation describes the * following:

* * *

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, GetUserPoolMfaConfigCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import * // const { CognitoIdentityProviderClient, GetUserPoolMfaConfigCommand } = 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 = { // GetUserPoolMfaConfigRequest * UserPoolId: "STRING_VALUE", // required * }; * const command = new GetUserPoolMfaConfigCommand(input); * const response = await client.send(command); * // { // GetUserPoolMfaConfigResponse * // 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 GetUserPoolMfaConfigCommandInput - {@link GetUserPoolMfaConfigCommandInput} * @returns {@link GetUserPoolMfaConfigCommandOutput} * @see {@link GetUserPoolMfaConfigCommandInput} for command's `input` shape. * @see {@link GetUserPoolMfaConfigCommandOutput} 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 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 GetUserPoolMfaConfigCommand extends GetUserPoolMfaConfigCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetUserPoolMfaConfigRequest; output: GetUserPoolMfaConfigResponse; }; sdk: { input: GetUserPoolMfaConfigCommandInput; output: GetUserPoolMfaConfigCommandOutput; }; }; }