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

Copyright(c) 2013-2016 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.

This operation returns paginated results.

Synopsis

Creating a Request

listSSHPublicKeys :: ListSSHPublicKeys #

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, the UserName field is determined implicitly based on the AWS access key used to sign the request. The regex pattern for this parameter is 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 the Marker element in the response that you received to indicate where the next call should start.
  • lspkMaxItems - 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.

data ListSSHPublicKeys #

See: listSSHPublicKeys smart constructor.

Instances

Eq ListSSHPublicKeys # 
Data ListSSHPublicKeys # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListSSHPublicKeys -> c ListSSHPublicKeys #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListSSHPublicKeys #

toConstr :: ListSSHPublicKeys -> Constr #

dataTypeOf :: ListSSHPublicKeys -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListSSHPublicKeys) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListSSHPublicKeys) #

gmapT :: (forall b. Data b => b -> b) -> ListSSHPublicKeys -> ListSSHPublicKeys #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListSSHPublicKeys -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListSSHPublicKeys -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListSSHPublicKeys -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListSSHPublicKeys -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListSSHPublicKeys -> m ListSSHPublicKeys #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListSSHPublicKeys -> m ListSSHPublicKeys #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListSSHPublicKeys -> m ListSSHPublicKeys #

Read ListSSHPublicKeys # 
Show ListSSHPublicKeys # 
Generic ListSSHPublicKeys # 
Hashable ListSSHPublicKeys # 
NFData ListSSHPublicKeys # 

Methods

rnf :: ListSSHPublicKeys -> () #

AWSPager ListSSHPublicKeys # 
AWSRequest ListSSHPublicKeys # 
ToQuery ListSSHPublicKeys # 
ToPath ListSSHPublicKeys # 
ToHeaders ListSSHPublicKeys # 
type Rep ListSSHPublicKeys # 
type Rep ListSSHPublicKeys = D1 (MetaData "ListSSHPublicKeys" "Network.AWS.IAM.ListSSHPublicKeys" "amazonka-iam-1.4.5-1ijrgQyRuWgA7Tx0390Dx2" False) (C1 (MetaCons "ListSSHPublicKeys'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lspkUserName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lspkMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lspkMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))))
type Rs ListSSHPublicKeys # 

Request Lenses

lspkUserName :: Lens' ListSSHPublicKeys (Maybe Text) #

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. The regex pattern for this parameter is 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) #

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) #

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 #

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 - When IsTruncated is true , this element is present and contains the value to use for the Marker 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 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 - -- | The response status code.

data ListSSHPublicKeysResponse #

Contains the response to a successful ListSSHPublicKeys request.

See: listSSHPublicKeysResponse smart constructor.

Instances

Eq ListSSHPublicKeysResponse # 
Data ListSSHPublicKeysResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListSSHPublicKeysResponse -> c ListSSHPublicKeysResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListSSHPublicKeysResponse #

toConstr :: ListSSHPublicKeysResponse -> Constr #

dataTypeOf :: ListSSHPublicKeysResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListSSHPublicKeysResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListSSHPublicKeysResponse) #

gmapT :: (forall b. Data b => b -> b) -> ListSSHPublicKeysResponse -> ListSSHPublicKeysResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListSSHPublicKeysResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListSSHPublicKeysResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListSSHPublicKeysResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListSSHPublicKeysResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListSSHPublicKeysResponse -> m ListSSHPublicKeysResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListSSHPublicKeysResponse -> m ListSSHPublicKeysResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListSSHPublicKeysResponse -> m ListSSHPublicKeysResponse #

Read ListSSHPublicKeysResponse # 
Show ListSSHPublicKeysResponse # 
Generic ListSSHPublicKeysResponse # 
NFData ListSSHPublicKeysResponse # 
type Rep ListSSHPublicKeysResponse # 
type Rep ListSSHPublicKeysResponse = D1 (MetaData "ListSSHPublicKeysResponse" "Network.AWS.IAM.ListSSHPublicKeys" "amazonka-iam-1.4.5-1ijrgQyRuWgA7Tx0390Dx2" False) (C1 (MetaCons "ListSSHPublicKeysResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lspkrsSSHPublicKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [SSHPublicKeyMetadata]))) (S1 (MetaSel (Just Symbol "_lspkrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_lspkrsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_lspkrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

lspkrsSSHPublicKeys :: Lens' ListSSHPublicKeysResponse [SSHPublicKeyMetadata] #

A list of the SSH public keys assigned to IAM user.

lspkrsMarker :: Lens' ListSSHPublicKeysResponse (Maybe Text) #

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) #

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 #

  • - | The response status code.