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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass AdminSetUserSettingsRequest data as a 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:



1218
1219
1220
1221
1222
1223
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1218

class AdminSetUserSettingsRequest < Struct.new(
  :user_pool_id,
  :username,
  :mfa_options)
  include Aws::Structure
end

#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)


1218
1219
1220
1221
1222
1223
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1218

class AdminSetUserSettingsRequest < Struct.new(
  :user_pool_id,
  :username,
  :mfa_options)
  include Aws::Structure
end

#usernameString

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

Returns:

  • (String)


1218
1219
1220
1221
1222
1223
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1218

class AdminSetUserSettingsRequest < Struct.new(
  :user_pool_id,
  :username,
  :mfa_options)
  include Aws::Structure
end