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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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
}

See Also:

Constant Summary collapse

SENSITIVE = 
[:access_token]

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String

A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.

Returns:

  • (String) 


8398
8399
8400
8401
8402
8403
8404
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8398

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

#sms_mfa_settings ⇒ Types::SMSMfaSettingsType

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

Returns:



8398
8399
8400
8401
8402
8403
8404
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8398

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

#software_token_mfa_settings ⇒ Types::SoftwareTokenMfaSettingsType

The time-based one-time password (TOTP) software token MFA settings.

Returns:



8398
8399
8400
8401
8402
8403
8404
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8398

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