Table Of Contents

Feedback

User Guide

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

[ aws . cognito-idp ]

admin-set-user-settings

Description

This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the AdminSetUserMFAPreference action instead.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  admin-set-user-settings
--user-pool-id <value>
--username <value>
--mfa-options <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--user-pool-id (string)

The ID of the user pool that contains the user that you are setting options for.

--username (string)

The user name of the user that you are setting options for.

--mfa-options (list)

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

Shorthand Syntax:

DeliveryMedium=string,AttributeName=string ...

JSON Syntax:

[
  {
    "DeliveryMedium": "SMS"|"EMAIL",
    "AttributeName": "string"
  }
  ...
]

--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.

Examples

To set user settings

This example sets the MFA delivery preference for username diego@example.com to EMAIL.

Command:

aws cognito-idp admin-set-user-settings --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --mfa-options DeliveryMedium=EMAIL

Output