Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
This operation returns paginated results.
Synopsis
- listVirtualMFADevices :: ListVirtualMFADevices
- data ListVirtualMFADevices
- lvmdAssignmentStatus :: Lens' ListVirtualMFADevices (Maybe AssignmentStatusType)
- lvmdMarker :: Lens' ListVirtualMFADevices (Maybe Text)
- lvmdMaxItems :: Lens' ListVirtualMFADevices (Maybe Natural)
- listVirtualMFADevicesResponse :: Int -> ListVirtualMFADevicesResponse
- data ListVirtualMFADevicesResponse
- lvmdrsMarker :: Lens' ListVirtualMFADevicesResponse (Maybe Text)
- lvmdrsIsTruncated :: Lens' ListVirtualMFADevicesResponse (Maybe Bool)
- lvmdrsResponseStatus :: Lens' ListVirtualMFADevicesResponse Int
- lvmdrsVirtualMFADevices :: Lens' ListVirtualMFADevicesResponse [VirtualMFADevice]
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:
lvmdAssignmentStatus
- The status (Unassigned
orAssigned
) of the devices to list. If you do not specify anAssignmentStatus
, the operation defaults toAny
which lists both assigned and unassigned virtual MFA devices.lvmdMarker
- 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 theMarker
element in the response that you received to indicate where the next call should start.lvmdMaxItems
- (Optional) 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, theIsTruncated
response element istrue
. If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, theIsTruncated
response element returnstrue
andMarker
contains a value to include in the subsequent call that tells the service where to continue from.
data ListVirtualMFADevices Source #
See: listVirtualMFADevices
smart constructor.
Instances
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 operation 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 #
(Optional) 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, 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:
lvmdrsMarker
- WhenIsTruncated
istrue
, this element is present and contains the value to use for theMarker
parameter in a subsequent pagination request.lvmdrsIsTruncated
- A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using theMarker
request parameter to retrieve more items. Note that IAM might return fewer than theMaxItems
number of results even when there are more results available. We recommend that you checkIsTruncated
after every call to ensure that you receive all of your results.lvmdrsResponseStatus
- -- | The response status code.lvmdrsVirtualMFADevices
- The list of virtual MFA devices in the current account that match theAssignmentStatus
value that was passed in the request.
data ListVirtualMFADevicesResponse Source #
Contains the response to a successful ListVirtualMFADevices
request.
See: listVirtualMFADevicesResponse
smart constructor.
Instances
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.
lvmdrsResponseStatus :: Lens' ListVirtualMFADevicesResponse Int Source #
- - | The response status code.
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.