This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.

See also: AWS API Documentation

Request Syntax

response = client.admin_set_user_settings(
            'DeliveryMedium': 'SMS'|'EMAIL',
            'AttributeName': 'string'
  • UserPoolId (string) --


    The ID of the user pool that contains the user whose options you're setting.

  • Username (string) --


    The user name of the user whose options you're setting.

  • MFAOptions (list) --


    You can use this parameter only to set an SMS configuration that uses SMS for delivery.

    • (dict) --
      This data type is no longer supported. Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations.
      • DeliveryMedium (string) --

        The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

      • AttributeName (string) --

        The attribute name of the MFA option type. The only valid value is phone_number .

Return type



Response Syntax


Response Structure

  • (dict) --

    Represents the response from the server to set user settings as an administrator.


  • CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException
  • CognitoIdentityProvider.Client.exceptions.InvalidParameterException
  • CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
  • CognitoIdentityProvider.Client.exceptions.UserNotFoundException
  • CognitoIdentityProvider.Client.exceptions.InternalErrorException