Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . cognito-idp ]



Set the user pool MFA configuration.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--user-pool-id <value>
[--sms-mfa-configuration <value>]
[--software-token-mfa-configuration <value>]
[--mfa-configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--user-pool-id (string)

The user pool ID.

--sms-mfa-configuration (structure)

The SMS text message MFA configuration.

Shorthand Syntax:


JSON Syntax:

  "SmsAuthenticationMessage": "string",
  "SmsConfiguration": {
    "SnsCallerArn": "string",
    "ExternalId": "string"

--software-token-mfa-configuration (structure)

The software token MFA configuration.

Shorthand Syntax:


JSON Syntax:

  "Enabled": true|false

--mfa-configuration (string)

The MFA configuration.

Possible values:

  • OFF
  • ON

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


SmsMfaConfiguration -> (structure)

The SMS text message MFA configuration.

SmsAuthenticationMessage -> (string)

The SMS authentication message.

SmsConfiguration -> (structure)

The SMS configuration.

SnsCallerArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller.

ExternalId -> (string)

The external ID.

SoftwareTokenMfaConfiguration -> (structure)

The software token MFA configuration.

Enabled -> (boolean)

Specifies whether software token MFA is enabled.

MfaConfiguration -> (string)

The MFA configuration.