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

Class: Aws::CognitoIdentityProvider::Types::SetUserMFAPreferenceRequest

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

{
  sms_mfa_settings: {
    enabled: false,
    preferred_mfa: false,
  },
  software_token_mfa_settings: {
    enabled: false,
    preferred_mfa: false,
  },
  access_token: "TokenModelType", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#access_tokenString

The access token.

Returns:

  • (String)


5925
5926
5927
5928
5929
5930
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5925

class SetUserMFAPreferenceRequest < Struct.new(
  :sms_mfa_settings,
  :software_token_mfa_settings,
  :access_token)
  include Aws::Structure
end

#sms_mfa_settingsTypes::SMSMfaSettingsType

The SMS text message multi-factor authentication (MFA) settings.



5925
5926
5927
5928
5929
5930
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5925

class SetUserMFAPreferenceRequest < Struct.new(
  :sms_mfa_settings,
  :software_token_mfa_settings,
  :access_token)
  include Aws::Structure
end

#software_token_mfa_settingsTypes::SoftwareTokenMfaSettingsType

The time-based one-time password software token MFA settings.



5925
5926
5927
5928
5929
5930
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5925

class SetUserMFAPreferenceRequest < Struct.new(
  :sms_mfa_settings,
  :software_token_mfa_settings,
  :access_token)
  include Aws::Structure
end