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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iam/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
}

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_code_1String

An authentication code emitted by the device.

The format for this parameter is a string of 6 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.

Returns:

  • (String)


2326
2327
2328
2329
2330
2331
2332
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2326

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

#authentication_code_2String

A subsequent authentication code emitted by the device.

The format for this parameter is a string of 6 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.

Returns:

  • (String)


2326
2327
2328
2329
2330
2331
2332
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2326

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

#serial_numberString

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: =,.@:/-

Returns:

  • (String)


2326
2327
2328
2329
2330
2331
2332
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2326

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

#user_nameString

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: =,.@-

Returns:

  • (String)


2326
2327
2328
2329
2330
2331
2332
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2326

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