You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::AdminSetUserSettingsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AdminSetUserSettingsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  mfa_options: [ # required
    {
      delivery_medium: "SMS", # accepts SMS, EMAIL
      attribute_name: "AttributeNameType",
    },
  ],
}

Represents the request to set user settings as an administrator.

Instance Attribute Summary collapse

Instance Attribute Details

#mfa_optionsArray<Types::MFAOptionType>

Specifies the options for MFA (e.g., email or phone number).

Returns:

#user_pool_idString

The user pool ID for the user pool where you want to set the user\'s settings, such as MFA options.

Returns:

  • (String)

    The user pool ID for the user pool where you want to set the user\'s settings, such as MFA options.

#usernameString

The user name of the user for whom you wish to set user settings.

Returns:

  • (String)

    The user name of the user for whom you wish to set user settings.