amazonka-iam-1.3.5: Amazon Identity and Access Management SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.IAM.ListSSHPublicKeys

Contents

Description

Returns information about the SSH public keys associated with the specified IAM user. If there are none, the action returns an empty list.

The SSH public keys returned by this action 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.

See: AWS API Reference for ListSSHPublicKeys.

Synopsis

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:

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.

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

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.

This parameter is optional. If you do not include it, 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:

Response Lenses

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.