Network.AWS.IAM.ListSSHPublicKeys

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.

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. 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 the Marker 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, 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.

data ListSSHPublicKeys

See: listSSHPublicKeys smart constructor.

Instances

Eq ListSSHPublicKeys

Defined in Network.AWS.IAM.ListSSHPublicKeys

Methods

(==) :: ListSSHPublicKeys -> ListSSHPublicKeys -> Bool

(/=) :: ListSSHPublicKeys -> ListSSHPublicKeys -> Bool

Data ListSSHPublicKeys

Defined in Network.AWS.IAM.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

Defined in Network.AWS.IAM.ListSSHPublicKeys

Methods

readsPrec :: Int -> ReadS ListSSHPublicKeys

readList :: ReadS [ListSSHPublicKeys]

readPrec :: ReadPrec ListSSHPublicKeys

readListPrec :: ReadPrec [ListSSHPublicKeys]

Show ListSSHPublicKeys

Defined in Network.AWS.IAM.ListSSHPublicKeys

Methods

showsPrec :: Int -> ListSSHPublicKeys -> ShowS

show :: ListSSHPublicKeys -> String

showList :: [ListSSHPublicKeys] -> ShowS

Generic ListSSHPublicKeys

Defined in Network.AWS.IAM.ListSSHPublicKeys

Associated Types

type Rep ListSSHPublicKeys :: Type -> Type

Methods

from :: ListSSHPublicKeys -> Rep ListSSHPublicKeys x

to :: Rep ListSSHPublicKeys x -> ListSSHPublicKeys

Hashable ListSSHPublicKeys

Defined in Network.AWS.IAM.ListSSHPublicKeys

Methods

hashWithSalt :: Int -> ListSSHPublicKeys -> Int

hash :: ListSSHPublicKeys -> Int

AWSPager ListSSHPublicKeys

Defined in Network.AWS.IAM.ListSSHPublicKeys

Methods

page :: ListSSHPublicKeys -> Rs ListSSHPublicKeys -> Maybe ListSSHPublicKeys

AWSRequest ListSSHPublicKeys

Defined in Network.AWS.IAM.ListSSHPublicKeys

Associated Types

type Rs ListSSHPublicKeys :: Type

Methods

request :: ListSSHPublicKeys -> Request ListSSHPublicKeys

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListSSHPublicKeys -> ClientResponse -> m (Response ListSSHPublicKeys)

ToHeaders ListSSHPublicKeys

Defined in Network.AWS.IAM.ListSSHPublicKeys

Methods

toHeaders :: ListSSHPublicKeys -> [Header]

ToPath ListSSHPublicKeys

Defined in Network.AWS.IAM.ListSSHPublicKeys

Methods

toPath :: ListSSHPublicKeys -> ByteString

ToQuery ListSSHPublicKeys

Defined in Network.AWS.IAM.ListSSHPublicKeys

Methods

toQuery :: ListSSHPublicKeys -> QueryString

NFData ListSSHPublicKeys

Defined in Network.AWS.IAM.ListSSHPublicKeys

Methods

rnf :: ListSSHPublicKeys -> ()

type Rep ListSSHPublicKeys

Defined in Network.AWS.IAM.ListSSHPublicKeys

type Rep ListSSHPublicKeys = D1 (MetaData "ListSSHPublicKeys" "Network.AWS.IAM.ListSSHPublicKeys" "amazonka-iam-1.6.1-BDjAp2BAcQu3GSS4Bsr6zu" False) (C1 (MetaCons "ListSSHPublicKeys'" PrefixI True) (S1 (MetaSel (Just "_lspkUserName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lspkMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lspkMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))))

type Rs ListSSHPublicKeys

Defined in Network.AWS.IAM.ListSSHPublicKeys

type Rs ListSSHPublicKeys = ListSSHPublicKeysResponse

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

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)

(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

Arguments

:: Int

lspkrsResponseStatus

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

Defined in Network.AWS.IAM.ListSSHPublicKeys

Methods

(==) :: ListSSHPublicKeysResponse -> ListSSHPublicKeysResponse -> Bool

(/=) :: ListSSHPublicKeysResponse -> ListSSHPublicKeysResponse -> Bool

Data ListSSHPublicKeysResponse

Defined in Network.AWS.IAM.ListSSHPublicKeys

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

Defined in Network.AWS.IAM.ListSSHPublicKeys

Methods

readsPrec :: Int -> ReadS ListSSHPublicKeysResponse

readList :: ReadS [ListSSHPublicKeysResponse]

readPrec :: ReadPrec ListSSHPublicKeysResponse

readListPrec :: ReadPrec [ListSSHPublicKeysResponse]

Show ListSSHPublicKeysResponse

Defined in Network.AWS.IAM.ListSSHPublicKeys

Methods

showsPrec :: Int -> ListSSHPublicKeysResponse -> ShowS

show :: ListSSHPublicKeysResponse -> String

showList :: [ListSSHPublicKeysResponse] -> ShowS

Generic ListSSHPublicKeysResponse

Defined in Network.AWS.IAM.ListSSHPublicKeys

Associated Types

type Rep ListSSHPublicKeysResponse :: Type -> Type

Methods

from :: ListSSHPublicKeysResponse -> Rep ListSSHPublicKeysResponse x

to :: Rep ListSSHPublicKeysResponse x -> ListSSHPublicKeysResponse

NFData ListSSHPublicKeysResponse

Defined in Network.AWS.IAM.ListSSHPublicKeys

Methods

rnf :: ListSSHPublicKeysResponse -> ()

type Rep ListSSHPublicKeysResponse

Defined in Network.AWS.IAM.ListSSHPublicKeys

type Rep ListSSHPublicKeysResponse = D1 (MetaData "ListSSHPublicKeysResponse" "Network.AWS.IAM.ListSSHPublicKeys" "amazonka-iam-1.6.1-BDjAp2BAcQu3GSS4Bsr6zu" False) (C1 (MetaCons "ListSSHPublicKeysResponse'" PrefixI True) ((S1 (MetaSel (Just "_lspkrsSSHPublicKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [SSHPublicKeyMetadata])) :*: S1 (MetaSel (Just "_lspkrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_lspkrsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_lspkrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (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.