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 MFA devices for an IAM user. If the request includes a IAM user name, then this operation lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request for this operation.
You can paginate the results using the MaxItems
and Marker
parameters.
This operation returns paginated results.
Synopsis
- data ListMFADevices = ListMFADevices' {}
- newListMFADevices :: ListMFADevices
- listMFADevices_userName :: Lens' ListMFADevices (Maybe Text)
- listMFADevices_marker :: Lens' ListMFADevices (Maybe Text)
- listMFADevices_maxItems :: Lens' ListMFADevices (Maybe Natural)
- data ListMFADevicesResponse = ListMFADevicesResponse' {
- marker :: Maybe Text
- isTruncated :: Maybe Bool
- httpStatus :: Int
- mfaDevices :: [MFADevice]
- newListMFADevicesResponse :: Int -> ListMFADevicesResponse
- listMFADevicesResponse_marker :: Lens' ListMFADevicesResponse (Maybe Text)
- listMFADevicesResponse_isTruncated :: Lens' ListMFADevicesResponse (Maybe Bool)
- listMFADevicesResponse_httpStatus :: Lens' ListMFADevicesResponse Int
- listMFADevicesResponse_mfaDevices :: Lens' ListMFADevicesResponse [MFADevice]
Creating a Request
data ListMFADevices Source #
See: newListMFADevices
smart constructor.
ListMFADevices' | |
|
Instances
newListMFADevices :: ListMFADevices Source #
Create a value of ListMFADevices
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:userName:ListMFADevices'
, listMFADevices_userName
- The name of the user whose MFA devices you want to list.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
$sel:marker:ListMFADevices'
, listMFADevices_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:ListMFADevices'
, listMFADevices_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
listMFADevices_userName :: Lens' ListMFADevices (Maybe Text) Source #
The name of the user whose MFA devices you want to list.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
listMFADevices_marker :: Lens' ListMFADevices (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.
listMFADevices_maxItems :: Lens' ListMFADevices (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 ListMFADevicesResponse Source #
Contains the response to a successful ListMFADevices request.
See: newListMFADevicesResponse
smart constructor.
ListMFADevicesResponse' | |
|
Instances
newListMFADevicesResponse Source #
Create a value of ListMFADevicesResponse
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:ListMFADevices'
, listMFADevicesResponse_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:ListMFADevicesResponse'
, listMFADevicesResponse_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:ListMFADevicesResponse'
, listMFADevicesResponse_httpStatus
- The response's http status code.
$sel:mfaDevices:ListMFADevicesResponse'
, listMFADevicesResponse_mfaDevices
- A list of MFA devices.
Response Lenses
listMFADevicesResponse_marker :: Lens' ListMFADevicesResponse (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.
listMFADevicesResponse_isTruncated :: Lens' ListMFADevicesResponse (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.
listMFADevicesResponse_httpStatus :: Lens' ListMFADevicesResponse Int Source #
The response's http status code.
listMFADevicesResponse_mfaDevices :: Lens' ListMFADevicesResponse [MFADevice] Source #
A list of MFA devices.