GetUserPoolMfaConfig - Amazon Cognito User Pools
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Gets the user pool multi-factor authentication (MFA) configuration.

Request Syntax

{ "UserPoolId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


The user pool ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+_[0-9a-zA-Z]+

Required: Yes

Response Syntax

{ "MfaConfiguration": "string", "SmsMfaConfiguration": { "SmsAuthenticationMessage": "string", "SmsConfiguration": { "ExternalId": "string", "SnsCallerArn": "string", "SnsRegion": "string" } }, "SoftwareTokenMfaConfiguration": { "Enabled": boolean } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The multi-factor authentication (MFA) configuration. Valid values include:

  • OFF MFA won't be used for any users.

  • ON MFA is required for all users to sign in.

  • OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

Type: String

Valid Values: OFF | ON | OPTIONAL


The SMS text message multi-factor authentication (MFA) configuration.

Type: SmsMfaConfigType object


The software token multi-factor authentication (MFA) configuration.

Type: SoftwareTokenMfaConfigType object


For information about the errors that are common to all actions, see Common Errors.


This exception is thrown when Amazon Cognito encounters an internal error.

HTTP Status Code: 500


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

HTTP Status Code: 400


This exception is thrown when a user isn't authorized.

HTTP Status Code: 400


This exception is thrown when the Amazon Cognito service can't find the requested resource.

HTTP Status Code: 400


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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: