listVirtualMFADevices method

Future<ListVirtualMFADevicesResponse> listVirtualMFADevices({ AssignmentStatusType? assignmentStatus, String? marker, int? maxItems, })

Lists the virtual MFA devices defined in the AWS account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any.

You can paginate the results using the MaxItems and Marker parameters.

Parameter assignmentStatus : 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.,

Parameter marker : 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.

Parameter maxItems : 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.

Implementation

Future<ListVirtualMFADevicesResponse> listVirtualMFADevices({
  AssignmentStatusType? assignmentStatus,
  String? marker,
  int? maxItems,
}) async {
  _s.validateStringLength(
    'marker',
    marker,
    1,
    320,
  );
  _s.validateNumRange(
    'maxItems',
    maxItems,
    1,
    1000,
  );
  final $request = <String, dynamic>{};
  assignmentStatus
      ?.also((arg) => $request['AssignmentStatus'] = arg.toValue());
  marker?.also((arg) => $request['Marker'] = arg);
  maxItems?.also((arg) => $request['MaxItems'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'ListVirtualMFADevices',
    version: '2010-05-08',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['ListVirtualMFADevicesRequest'],
    shapes: shapes,
    resultWrapper: 'ListVirtualMFADevicesResult',
  );
  return ListVirtualMFADevicesResponse.fromXml($result);
}