Copyright | (c) 2013-2021 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 |
Lists the virtual MFA devices defined in the Amazon Web Services 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
.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a virtual MFA device, see ListVirtualMFADevices.
You can paginate the results using the MaxItems
and Marker
parameters.
This operation returns paginated results.
Synopsis
- data ListVirtualMFADevices = ListVirtualMFADevices' {}
- newListVirtualMFADevices :: ListVirtualMFADevices
- listVirtualMFADevices_assignmentStatus :: Lens' ListVirtualMFADevices (Maybe AssignmentStatusType)
- listVirtualMFADevices_marker :: Lens' ListVirtualMFADevices (Maybe Text)
- listVirtualMFADevices_maxItems :: Lens' ListVirtualMFADevices (Maybe Natural)
- data ListVirtualMFADevicesResponse = ListVirtualMFADevicesResponse' {}
- newListVirtualMFADevicesResponse :: Int -> ListVirtualMFADevicesResponse
- listVirtualMFADevicesResponse_marker :: Lens' ListVirtualMFADevicesResponse (Maybe Text)
- listVirtualMFADevicesResponse_isTruncated :: Lens' ListVirtualMFADevicesResponse (Maybe Bool)
- listVirtualMFADevicesResponse_httpStatus :: Lens' ListVirtualMFADevicesResponse Int
- listVirtualMFADevicesResponse_virtualMFADevices :: Lens' ListVirtualMFADevicesResponse [VirtualMFADevice]
Creating a Request
data ListVirtualMFADevices Source #
See: newListVirtualMFADevices
smart constructor.
ListVirtualMFADevices' | |
|
Instances
newListVirtualMFADevices :: ListVirtualMFADevices Source #
Create a value of ListVirtualMFADevices
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assignmentStatus:ListVirtualMFADevices'
, listVirtualMFADevices_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.,
$sel:marker:ListVirtualMFADevices'
, listVirtualMFADevices_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.
$sel:maxItems:ListVirtualMFADevices'
, listVirtualMFADevices_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.
Request Lenses
listVirtualMFADevices_assignmentStatus :: 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.,
listVirtualMFADevices_marker :: 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.
listVirtualMFADevices_maxItems :: 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
.
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.
Destructuring the Response
data ListVirtualMFADevicesResponse Source #
Contains the response to a successful ListVirtualMFADevices request.
See: newListVirtualMFADevicesResponse
smart constructor.
ListVirtualMFADevicesResponse' | |
|
Instances
newListVirtualMFADevicesResponse Source #
Create a value of ListVirtualMFADevicesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:ListVirtualMFADevices'
, listVirtualMFADevicesResponse_marker
- When IsTruncated
is true
, this element is present and contains the
value to use for the Marker
parameter in a subsequent pagination
request.
$sel:isTruncated:ListVirtualMFADevicesResponse'
, listVirtualMFADevicesResponse_isTruncated
- 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 your
results.
$sel:httpStatus:ListVirtualMFADevicesResponse'
, listVirtualMFADevicesResponse_httpStatus
- The response's http status code.
$sel:virtualMFADevices:ListVirtualMFADevicesResponse'
, listVirtualMFADevicesResponse_virtualMFADevices
- The list of virtual MFA devices in the current account that match the
AssignmentStatus
value that was passed in the request.
Response Lenses
listVirtualMFADevicesResponse_marker :: 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.
listVirtualMFADevicesResponse_isTruncated :: 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 your
results.
listVirtualMFADevicesResponse_httpStatus :: Lens' ListVirtualMFADevicesResponse Int Source #
The response's http status code.
listVirtualMFADevicesResponse_virtualMFADevices :: 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.