amazonka-iam-1.3.4: Amazon Identity and Access Management SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.IAM.ListVirtualMFADevices

Contents

Description

Lists the virtual MFA devices under the AWS account by assignment status. If you do not specify an assignment status, the action 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.

See: AWS API Reference for ListVirtualMFADevices.

This operation returns paginated results.

Synopsis

Creating a Request

listVirtualMFADevices :: ListVirtualMFADevices Source

Creates a value of ListVirtualMFADevices with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Request Lenses

lvmdAssignmentStatus :: Lens' ListVirtualMFADevices (Maybe AssignmentStatusType) Source

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

lvmdMarker :: Lens' ListVirtualMFADevices (Maybe Text) Source

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.

lvmdMaxItems :: Lens' ListVirtualMFADevices (Maybe Natural) Source

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.

This parameter is optional. If you do not include it, it 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.

Destructuring the Response

listVirtualMFADevicesResponse Source

Creates a value of ListVirtualMFADevicesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Response Lenses

lvmdrsMarker :: Lens' ListVirtualMFADevicesResponse (Maybe Text) Source

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

lvmdrsIsTruncated :: Lens' ListVirtualMFADevicesResponse (Maybe Bool) Source

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

lvmdrsVirtualMFADevices :: Lens' ListVirtualMFADevicesResponse [VirtualMFADevice] Source

The list of virtual MFA devices in the current account that match the AssignmentStatus value that was passed in the request.