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

Class: Aws::CognitoIdentityProvider::Types::SetUserSettingsRequest

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 SetUserSettingsRequest data as a hash:

{
  access_token: "TokenModelType", # required
  mfa_options: [ # required
    {
      delivery_medium: "SMS", # accepts SMS, EMAIL
      attribute_name: "AttributeNameType",
    },
  ],
}

Represents the request to set user settings.

Instance Attribute Summary collapse

Instance Attribute Details

#access_tokenString

The access token for the set user settings request.

Returns:

  • (String)


7636
7637
7638
7639
7640
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7636

class SetUserSettingsRequest < Struct.new(
  :access_token,
  :mfa_options)
  include Aws::Structure
end

#mfa_optionsArray<Types::MFAOptionType>

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

Returns:



7636
7637
7638
7639
7640
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7636

class SetUserSettingsRequest < Struct.new(
  :access_token,
  :mfa_options)
  include Aws::Structure
end