| 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 |
Network.AWS.IAM.ListAccessKeys
Description
Returns information about the access key IDs associated with the specified IAM user. If there are none, the operation returns an empty list.
Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.
If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this operation works for access keys under the AWS account, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users.
This operation returns paginated results.
Synopsis
- listAccessKeys :: ListAccessKeys
- data ListAccessKeys
- lakUserName :: Lens' ListAccessKeys (Maybe Text)
- lakMarker :: Lens' ListAccessKeys (Maybe Text)
- lakMaxItems :: Lens' ListAccessKeys (Maybe Natural)
- listAccessKeysResponse :: Int -> ListAccessKeysResponse
- data ListAccessKeysResponse
- lakrsMarker :: Lens' ListAccessKeysResponse (Maybe Text)
- lakrsIsTruncated :: Lens' ListAccessKeysResponse (Maybe Bool)
- lakrsResponseStatus :: Lens' ListAccessKeysResponse Int
- lakrsAccessKeyMetadata :: Lens' ListAccessKeysResponse [AccessKeyMetadata]
Creating a Request
listAccessKeys :: ListAccessKeys Source #
Creates a value of ListAccessKeys with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lakUserName- The name of the user. This parameter allows (per 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: _+=,.@-lakMarker- 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 theMarkerelement in the response that you received to indicate where the next call should start.lakMaxItems- (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, theIsTruncatedresponse 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, theIsTruncatedresponse element returnstrueandMarkercontains a value to include in the subsequent call that tells the service where to continue from.
data ListAccessKeys Source #
See: listAccessKeys smart constructor.
Instances
Request Lenses
lakUserName :: Lens' ListAccessKeys (Maybe Text) Source #
The name of the user. This parameter allows (per 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: _+=,.@-
lakMarker :: Lens' ListAccessKeys (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.
lakMaxItems :: Lens' ListAccessKeys (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
listAccessKeysResponse Source #
Arguments
| :: Int | |
| -> ListAccessKeysResponse |
Creates a value of ListAccessKeysResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lakrsMarker- WhenIsTruncatedistrue, this element is present and contains the value to use for theMarkerparameter in a subsequent pagination request.lakrsIsTruncated- A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using theMarkerrequest parameter to retrieve more items. Note that IAM might return fewer than theMaxItemsnumber of results even when there are more results available. We recommend that you checkIsTruncatedafter every call to ensure that you receive all of your results.lakrsResponseStatus- -- | The response status code.lakrsAccessKeyMetadata- A list of objects containing metadata about the access keys.
data ListAccessKeysResponse Source #
Contains the response to a successful ListAccessKeys request.
See: listAccessKeysResponse smart constructor.
Instances
Response Lenses
lakrsMarker :: Lens' ListAccessKeysResponse (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.
lakrsIsTruncated :: Lens' ListAccessKeysResponse (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.
lakrsResponseStatus :: Lens' ListAccessKeysResponse Int Source #
- - | The response status code.
lakrsAccessKeyMetadata :: Lens' ListAccessKeysResponse [AccessKeyMetadata] Source #
A list of objects containing metadata about the access keys.