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

Class: Aws::IAM::Types::ListVirtualMFADevicesRequest

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

{
  assignment_status: "Assigned", # accepts Assigned, Unassigned, Any
  marker: "markerType",
  max_items: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#assignment_statusString

The status (Unassigned or Assigned) of the devices to list. If you do not specify an AssignmentStatus, the operation defaults to Any, which lists both assigned and unassigned virtual MFA devices.,

Returns:

  • (String)


7125
7126
7127
7128
7129
7130
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 7125

class ListVirtualMFADevicesRequest < Struct.new(
  :assignment_status,
  :marker,
  :max_items)
  include Aws::Structure
end

#markerString

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

Returns:

  • (String)


7125
7126
7127
7128
7129
7130
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 7125

class ListVirtualMFADevicesRequest < Struct.new(
  :assignment_status,
  :marker,
  :max_items)
  include Aws::Structure
end

#max_itemsInteger

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Returns:

  • (Integer)


7125
7126
7127
7128
7129
7130
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 7125

class ListVirtualMFADevicesRequest < Struct.new(
  :assignment_status,
  :marker,
  :max_items)
  include Aws::Structure
end