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

Amazonka.IAM.GetSSHPublicKey

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 CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.

Synopsis

Creating a Request

data GetSSHPublicKey Source #

See: newGetSSHPublicKey smart constructor.

Constructors

GetSSHPublicKey' 

Fields

  • userName :: Text

    The name of the IAM user associated with the SSH public key.

    This parameter allows (through 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: _+=,.@-

  • sSHPublicKeyId :: Text

    The unique identifier for the SSH public key.

    This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

  • encoding :: 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.

Instances

Instances details
Eq GetSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

Read GetSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

Show GetSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

Generic GetSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

Associated Types

type Rep GetSSHPublicKey :: Type -> Type #

NFData GetSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

Methods

rnf :: GetSSHPublicKey -> () #

Hashable GetSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

AWSRequest GetSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

Associated Types

type AWSResponse GetSSHPublicKey #

ToHeaders GetSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

ToPath GetSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

ToQuery GetSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

type Rep GetSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

type Rep GetSSHPublicKey = D1 ('MetaData "GetSSHPublicKey" "Amazonka.IAM.GetSSHPublicKey" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "GetSSHPublicKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "sSHPublicKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "encoding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EncodingType))))
type AWSResponse GetSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

newGetSSHPublicKey Source #

Create a value of GetSSHPublicKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:userName:GetSSHPublicKey', getSSHPublicKey_userName - The name of the IAM user associated with the SSH public key.

This parameter allows (through 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: _+=,.@-

$sel:sSHPublicKeyId:GetSSHPublicKey', getSSHPublicKey_sSHPublicKeyId - The unique identifier for the SSH public key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

$sel:encoding:GetSSHPublicKey', getSSHPublicKey_encoding - 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.

Request Lenses

getSSHPublicKey_userName :: Lens' GetSSHPublicKey Text Source #

The name of the IAM user associated with the SSH public key.

This parameter allows (through 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: _+=,.@-

getSSHPublicKey_sSHPublicKeyId :: Lens' GetSSHPublicKey Text Source #

The unique identifier for the SSH public key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

getSSHPublicKey_encoding :: Lens' GetSSHPublicKey EncodingType Source #

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

data GetSSHPublicKeyResponse Source #

Contains the response to a successful GetSSHPublicKey request.

See: newGetSSHPublicKeyResponse smart constructor.

Constructors

GetSSHPublicKeyResponse' 

Fields

Instances

Instances details
Eq GetSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

Read GetSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

Show GetSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

Generic GetSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

Associated Types

type Rep GetSSHPublicKeyResponse :: Type -> Type #

NFData GetSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

Methods

rnf :: GetSSHPublicKeyResponse -> () #

type Rep GetSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.GetSSHPublicKey

type Rep GetSSHPublicKeyResponse = D1 ('MetaData "GetSSHPublicKeyResponse" "Amazonka.IAM.GetSSHPublicKey" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "GetSSHPublicKeyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sSHPublicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SSHPublicKey)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetSSHPublicKeyResponse Source #

Create a value of GetSSHPublicKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sSHPublicKey:GetSSHPublicKeyResponse', getSSHPublicKeyResponse_sSHPublicKey - A structure containing details about the SSH public key.

$sel:httpStatus:GetSSHPublicKeyResponse', getSSHPublicKeyResponse_httpStatus - The response's http status code.

Response Lenses

getSSHPublicKeyResponse_sSHPublicKey :: Lens' GetSSHPublicKeyResponse (Maybe SSHPublicKey) Source #

A structure containing details about the SSH public key.