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 |
Returns information about the SSH public keys associated with the specified IAM user. If there are none, the operation returns an empty list.
The SSH public keys returned by this operation are used only for authenticating the IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide .
Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems
and Marker
parameters.
This operation returns paginated results.
- listSSHPublicKeys :: ListSSHPublicKeys
- data ListSSHPublicKeys
- lspkUserName :: Lens' ListSSHPublicKeys (Maybe Text)
- lspkMarker :: Lens' ListSSHPublicKeys (Maybe Text)
- lspkMaxItems :: Lens' ListSSHPublicKeys (Maybe Natural)
- listSSHPublicKeysResponse :: Int -> ListSSHPublicKeysResponse
- data ListSSHPublicKeysResponse
- lspkrsSSHPublicKeys :: Lens' ListSSHPublicKeysResponse [SSHPublicKeyMetadata]
- lspkrsMarker :: Lens' ListSSHPublicKeysResponse (Maybe Text)
- lspkrsIsTruncated :: Lens' ListSSHPublicKeysResponse (Maybe Bool)
- lspkrsResponseStatus :: Lens' ListSSHPublicKeysResponse Int
Creating a Request
listSSHPublicKeys :: ListSSHPublicKeys Source #
Creates a value of ListSSHPublicKeys
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lspkUserName
- The name of the IAM user to list SSH public keys for. If none is specified, theUserName
field is determined implicitly based on the AWS access key used to sign the request. 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: _+=,.@-lspkMarker
- 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.lspkMaxItems
- (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 ListSSHPublicKeys Source #
See: listSSHPublicKeys
smart constructor.
Request Lenses
lspkUserName :: Lens' ListSSHPublicKeys (Maybe Text) Source #
The name of the IAM user to list SSH public keys for. If none is specified, the UserName
field is determined implicitly based on the AWS access key used to sign the request. 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: _+=,.@-
lspkMarker :: Lens' ListSSHPublicKeys (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.
lspkMaxItems :: Lens' ListSSHPublicKeys (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
listSSHPublicKeysResponse Source #
Creates a value of ListSSHPublicKeysResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lspkrsSSHPublicKeys
- A list of the SSH public keys assigned to IAM user.lspkrsMarker
- WhenIsTruncated
istrue
, this element is present and contains the value to use for theMarker
parameter in a subsequent pagination request.lspkrsIsTruncated
- 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.lspkrsResponseStatus
- -- | The response status code.
data ListSSHPublicKeysResponse Source #
Contains the response to a successful ListSSHPublicKeys
request.
See: listSSHPublicKeysResponse
smart constructor.
Response Lenses
lspkrsSSHPublicKeys :: Lens' ListSSHPublicKeysResponse [SSHPublicKeyMetadata] Source #
A list of the SSH public keys assigned to IAM user.
lspkrsMarker :: Lens' ListSSHPublicKeysResponse (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.
lspkrsIsTruncated :: Lens' ListSSHPublicKeysResponse (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.
lspkrsResponseStatus :: Lens' ListSSHPublicKeysResponse Int Source #
- - | The response status code.