Class: Aws::IAM::Types::DeactivateMFADeviceRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#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 (through 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)


1795
1796
1797
1798
1799
1800
# File 'lib/aws-sdk-iam/types.rb', line 1795

class DeactivateMFADeviceRequest < Struct.new(
  :user_name,
  :serial_number)
  SENSITIVE = []
  include Aws::Structure
end

#user_nameString

The name of the user whose MFA device you want to deactivate.

This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an [AssumeRoot] session to omit the user name.

This parameter allows (through 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]: docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoot.html [2]: wikipedia.org/wiki/regex

Returns:

  • (String)


1795
1796
1797
1798
1799
1800
# File 'lib/aws-sdk-iam/types.rb', line 1795

class DeactivateMFADeviceRequest < Struct.new(
  :user_name,
  :serial_number)
  SENSITIVE = []
  include Aws::Structure
end