amazonka-iam-2.0: Amazon Identity and Access Management SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IAM.UploadSSHPublicKey

Description

Uploads an SSH public key and associates it with the specified IAM user.

The SSH public key uploaded by this operation can be 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 UploadSSHPublicKey Source #

See: newUploadSSHPublicKey smart constructor.

Constructors

UploadSSHPublicKey' 

Fields

  • userName :: Text

    The name of the IAM user to associate the SSH public key with.

    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: _+=,.@-

  • sSHPublicKeyBody :: Text

    The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long.

    The regex pattern used to validate this parameter is a string of characters consisting of the following:

    • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
    • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
    • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

Instances

Instances details
ToHeaders UploadSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

ToPath UploadSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

ToQuery UploadSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

AWSRequest UploadSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

Associated Types

type AWSResponse UploadSSHPublicKey #

Generic UploadSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

Associated Types

type Rep UploadSSHPublicKey :: Type -> Type #

Read UploadSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

Show UploadSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

NFData UploadSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

Methods

rnf :: UploadSSHPublicKey -> () #

Eq UploadSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

Hashable UploadSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

type AWSResponse UploadSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

type Rep UploadSSHPublicKey Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

type Rep UploadSSHPublicKey = D1 ('MetaData "UploadSSHPublicKey" "Amazonka.IAM.UploadSSHPublicKey" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "UploadSSHPublicKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sSHPublicKeyBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUploadSSHPublicKey Source #

Create a value of UploadSSHPublicKey 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:

UploadSSHPublicKey, uploadSSHPublicKey_userName - The name of the IAM user to associate the SSH public key with.

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: _+=,.@-

UploadSSHPublicKey, uploadSSHPublicKey_sSHPublicKeyBody - The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

Request Lenses

uploadSSHPublicKey_userName :: Lens' UploadSSHPublicKey Text Source #

The name of the IAM user to associate the SSH public key with.

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: _+=,.@-

uploadSSHPublicKey_sSHPublicKeyBody :: Lens' UploadSSHPublicKey Text Source #

The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

Destructuring the Response

data UploadSSHPublicKeyResponse Source #

Contains the response to a successful UploadSSHPublicKey request.

See: newUploadSSHPublicKeyResponse smart constructor.

Constructors

UploadSSHPublicKeyResponse' 

Fields

Instances

Instances details
Generic UploadSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

Associated Types

type Rep UploadSSHPublicKeyResponse :: Type -> Type #

Read UploadSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

Show UploadSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

NFData UploadSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

Eq UploadSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

type Rep UploadSSHPublicKeyResponse Source # 
Instance details

Defined in Amazonka.IAM.UploadSSHPublicKey

type Rep UploadSSHPublicKeyResponse = D1 ('MetaData "UploadSSHPublicKeyResponse" "Amazonka.IAM.UploadSSHPublicKey" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "UploadSSHPublicKeyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sSHPublicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SSHPublicKey)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUploadSSHPublicKeyResponse Source #

Create a value of UploadSSHPublicKeyResponse 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:UploadSSHPublicKeyResponse', uploadSSHPublicKeyResponse_sSHPublicKey - Contains information about the SSH public key.

$sel:httpStatus:UploadSSHPublicKeyResponse', uploadSSHPublicKeyResponse_httpStatus - The response's http status code.

Response Lenses