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

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

Network.AWS.IAM.GetSSHPublicKey

Contents

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 .

Synopsis

Creating a Request

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 # 
Data 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 # 
Show GetSSHPublicKey # 
Generic GetSSHPublicKey # 
Hashable GetSSHPublicKey # 
NFData GetSSHPublicKey # 

Methods

rnf :: GetSSHPublicKey -> () #

AWSRequest GetSSHPublicKey # 
ToHeaders GetSSHPublicKey # 
ToPath GetSSHPublicKey # 
ToQuery GetSSHPublicKey # 
type Rep GetSSHPublicKey # 
type Rep GetSSHPublicKey = D1 * (MetaData "GetSSHPublicKey" "Network.AWS.IAM.GetSSHPublicKey" "amazonka-iam-1.6.0-1EzdHSXYgBWIEzsCXYmity" False) (C1 * (MetaCons "GetSSHPublicKey'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gspkUserName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_gspkSSHPublicKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_gspkEncoding") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * EncodingType)))))
type Rs GetSSHPublicKey # 

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 #

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:

data GetSSHPublicKeyResponse #

Contains the response to a successful GetSSHPublicKey request.

See: getSSHPublicKeyResponse smart constructor.

Instances

Eq GetSSHPublicKeyResponse # 
Data GetSSHPublicKeyResponse # 

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 # 
Show GetSSHPublicKeyResponse # 
Generic GetSSHPublicKeyResponse # 
NFData GetSSHPublicKeyResponse # 

Methods

rnf :: GetSSHPublicKeyResponse -> () #

type Rep GetSSHPublicKeyResponse # 
type Rep GetSSHPublicKeyResponse = D1 * (MetaData "GetSSHPublicKeyResponse" "Network.AWS.IAM.GetSSHPublicKey" "amazonka-iam-1.6.0-1EzdHSXYgBWIEzsCXYmity" False) (C1 * (MetaCons "GetSSHPublicKeyResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gspkrsSSHPublicKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe SSHPublicKey))) (S1 * (MetaSel (Just Symbol "_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.