Class: Aws::IAM::Types::EnableMFADeviceRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iam/types.rb

Overview

Note:

When making an API call, you may pass EnableMFADeviceRequest data as a hash:

{
  user_name: "existingUserNameType", # required
  serial_number: "serialNumberType", # required
  authentication_code_1: "authenticationCodeType", # required
  authentication_code_2: "authenticationCodeType", # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_code_1 ⇒ String

An authentication code emitted by the device.

The format for this parameter is a string of six digits.

Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can [resync the device].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html

Returns:

  • (String) 


2451
2452
2453
2454
2455
2456
2457
 
# File 'lib/aws-sdk-iam/types.rb', line 2451

class EnableMFADeviceRequest < Struct.new(
  :user_name,
  :serial_number,
  :authentication_code_1,
  :authentication_code_2)
  include Aws::Structure
end

#authentication_code_2 ⇒ String

A subsequent authentication code emitted by the device.

The format for this parameter is a string of six digits.

Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can [resync the device].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html

Returns:

  • (String) 


2451
2452
2453
2454
2455
2456
2457
 
# File 'lib/aws-sdk-iam/types.rb', line 2451

class EnableMFADeviceRequest < Struct.new(
  :user_name,
  :serial_number,
  :authentication_code_1,
  :authentication_code_2)
  include Aws::Structure
end

#serial_number ⇒ String

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

This parameter allows (per its [regex pattern]) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-

[1]: wikipedia.org/wiki/regex

Returns:

  • (String) 


2451
2452
2453
2454
2455
2456
2457
 
# File 'lib/aws-sdk-iam/types.rb', line 2451

class EnableMFADeviceRequest < Struct.new(
  :user_name,
  :serial_number,
  :authentication_code_1,
  :authentication_code_2)
  include Aws::Structure
end

#user_name ⇒ String

The name of the IAM user for whom you want to enable the MFA device.

This parameter allows (per its [regex pattern]) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

[1]: wikipedia.org/wiki/regex

Returns:

  • (String) 


2451
2452
2453
2454
2455
2456
2457
 
# File 'lib/aws-sdk-iam/types.rb', line 2451

class EnableMFADeviceRequest < Struct.new(
  :user_name,
  :serial_number,
  :authentication_code_1,
  :authentication_code_2)
  include Aws::Structure
end