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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the specified SSH public key, including metadata about the key.

The SSH public key retrieved by this operation is used only for authenticating the associated 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 .

Creating a Request

getSSHPublicKey #

Arguments

:: Text	`gspkUserName`
-> Text	`gspkSSHPublicKeyId`
-> EncodingType	`gspkEncoding`
-> GetSSHPublicKey

Creates a value of GetSSHPublicKey with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gspkUserName - The name of the IAM user associated with the SSH public key. 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: _+=,.@-
gspkSSHPublicKeyId - The unique identifier for the SSH public key. This parameter allows (per its regex pattern ) a string of characters that can consist of any upper or lowercased letter or digit.
gspkEncoding - Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH . To retrieve the public key in PEM format, use PEM .

data GetSSHPublicKey #

See: getSSHPublicKey smart constructor.

Instances

Eq GetSSHPublicKey #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey Methods (==) :: GetSSHPublicKey -> GetSSHPublicKey -> Bool # (/=) :: GetSSHPublicKey -> GetSSHPublicKey -> Bool #
Data GetSSHPublicKey #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetSSHPublicKey -> c GetSSHPublicKey # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetSSHPublicKey # toConstr :: GetSSHPublicKey -> Constr # dataTypeOf :: GetSSHPublicKey -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetSSHPublicKey) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetSSHPublicKey) # gmapT :: (forall b. Data b => b -> b) -> GetSSHPublicKey -> GetSSHPublicKey # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetSSHPublicKey -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetSSHPublicKey -> r # gmapQ :: (forall d. Data d => d -> u) -> GetSSHPublicKey -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetSSHPublicKey -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetSSHPublicKey -> m GetSSHPublicKey # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetSSHPublicKey -> m GetSSHPublicKey # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetSSHPublicKey -> m GetSSHPublicKey #
Read GetSSHPublicKey #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey Methods readsPrec :: Int -> ReadS GetSSHPublicKey # readList :: ReadS [GetSSHPublicKey] # readPrec :: ReadPrec GetSSHPublicKey # readListPrec :: ReadPrec [GetSSHPublicKey] #
Show GetSSHPublicKey #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey Methods showsPrec :: Int -> GetSSHPublicKey -> ShowS # show :: GetSSHPublicKey -> String # showList :: [GetSSHPublicKey] -> ShowS #
Generic GetSSHPublicKey #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey Associated Types type Rep GetSSHPublicKey :: * -> * # Methods from :: GetSSHPublicKey -> Rep GetSSHPublicKey x # to :: Rep GetSSHPublicKey x -> GetSSHPublicKey #
Hashable GetSSHPublicKey #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey Methods hashWithSalt :: Int -> GetSSHPublicKey -> Int # hash :: GetSSHPublicKey -> Int #
AWSRequest GetSSHPublicKey #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey Associated Types type Rs GetSSHPublicKey :: * # Methods request :: GetSSHPublicKey -> Request GetSSHPublicKey # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetSSHPublicKey -> ClientResponse -> m (Response GetSSHPublicKey) #
ToHeaders GetSSHPublicKey #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey Methods toHeaders :: GetSSHPublicKey -> [Header] #
ToPath GetSSHPublicKey #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey Methods toPath :: GetSSHPublicKey -> ByteString #
ToQuery GetSSHPublicKey #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey Methods toQuery :: GetSSHPublicKey -> QueryString #
NFData GetSSHPublicKey #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey Methods rnf :: GetSSHPublicKey -> () #
type Rep GetSSHPublicKey #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey type Rep GetSSHPublicKey = D1 (MetaData "GetSSHPublicKey" "Network.AWS.IAM.GetSSHPublicKey" "amazonka-iam-1.6.0-KLHg33OPBsA2oss7MTCyZq" False) (C1 (MetaCons "GetSSHPublicKey'" PrefixI True) (S1 (MetaSel (Just "_gspkUserName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_gspkSSHPublicKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_gspkEncoding") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 EncodingType))))
type Rs GetSSHPublicKey #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey type Rs GetSSHPublicKey = GetSSHPublicKeyResponse

Request Lenses

gspkUserName :: Lens' GetSSHPublicKey Text #

The name of the IAM user associated with the SSH public key. 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: _+=,.@-

gspkSSHPublicKeyId :: Lens' GetSSHPublicKey Text #

The unique identifier for the SSH public key. This parameter allows (per its regex pattern ) a string of characters that can consist of any upper or lowercased letter or digit.

gspkEncoding :: Lens' GetSSHPublicKey EncodingType #

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH . To retrieve the public key in PEM format, use PEM .

Destructuring the Response

getSSHPublicKeyResponse #

Arguments

:: Int	`gspkrsResponseStatus`
-> GetSSHPublicKeyResponse

Creates a value of GetSSHPublicKeyResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gspkrsSSHPublicKey - A structure containing details about the SSH public key.
gspkrsResponseStatus - -- | The response status code.

data GetSSHPublicKeyResponse #

Contains the response to a successful GetSSHPublicKey request.

See: getSSHPublicKeyResponse smart constructor.

Instances

Eq GetSSHPublicKeyResponse #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey Methods (==) :: GetSSHPublicKeyResponse -> GetSSHPublicKeyResponse -> Bool # (/=) :: GetSSHPublicKeyResponse -> GetSSHPublicKeyResponse -> Bool #
Data GetSSHPublicKeyResponse #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetSSHPublicKeyResponse -> c GetSSHPublicKeyResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetSSHPublicKeyResponse # toConstr :: GetSSHPublicKeyResponse -> Constr # dataTypeOf :: GetSSHPublicKeyResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetSSHPublicKeyResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetSSHPublicKeyResponse) # gmapT :: (forall b. Data b => b -> b) -> GetSSHPublicKeyResponse -> GetSSHPublicKeyResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetSSHPublicKeyResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetSSHPublicKeyResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> GetSSHPublicKeyResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetSSHPublicKeyResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetSSHPublicKeyResponse -> m GetSSHPublicKeyResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetSSHPublicKeyResponse -> m GetSSHPublicKeyResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetSSHPublicKeyResponse -> m GetSSHPublicKeyResponse #
Read GetSSHPublicKeyResponse #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey Methods readsPrec :: Int -> ReadS GetSSHPublicKeyResponse # readList :: ReadS [GetSSHPublicKeyResponse] # readPrec :: ReadPrec GetSSHPublicKeyResponse # readListPrec :: ReadPrec [GetSSHPublicKeyResponse] #
Show GetSSHPublicKeyResponse #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey Methods showsPrec :: Int -> GetSSHPublicKeyResponse -> ShowS # show :: GetSSHPublicKeyResponse -> String # showList :: [GetSSHPublicKeyResponse] -> ShowS #
Generic GetSSHPublicKeyResponse #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey Associated Types type Rep GetSSHPublicKeyResponse :: * -> * # Methods from :: GetSSHPublicKeyResponse -> Rep GetSSHPublicKeyResponse x # to :: Rep GetSSHPublicKeyResponse x -> GetSSHPublicKeyResponse #
NFData GetSSHPublicKeyResponse #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey Methods rnf :: GetSSHPublicKeyResponse -> () #
type Rep GetSSHPublicKeyResponse #
Instance details Defined in Network.AWS.IAM.GetSSHPublicKey type Rep GetSSHPublicKeyResponse = D1 (MetaData "GetSSHPublicKeyResponse" "Network.AWS.IAM.GetSSHPublicKey" "amazonka-iam-1.6.0-KLHg33OPBsA2oss7MTCyZq" False) (C1 (MetaCons "GetSSHPublicKeyResponse'" PrefixI True) (S1 (MetaSel (Just "_gspkrsSSHPublicKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SSHPublicKey)) :*: S1 (MetaSel (Just "_gspkrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

gspkrsSSHPublicKey :: Lens' GetSSHPublicKeyResponse (Maybe SSHPublicKey) #

A structure containing details about the SSH public key.

gspkrsResponseStatus :: Lens' GetSSHPublicKeyResponse Int #

- | The response status code.