Amazonka.IAM.UploadSSHPublicKey

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.

Creating a Request

data UploadSSHPublicKey

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

ToHeaders UploadSSHPublicKey

Defined in Amazonka.IAM.UploadSSHPublicKey

Methods

toHeaders :: UploadSSHPublicKey -> [Header]

ToPath UploadSSHPublicKey

Defined in Amazonka.IAM.UploadSSHPublicKey

Methods

toPath :: UploadSSHPublicKey -> ByteString

ToQuery UploadSSHPublicKey

Defined in Amazonka.IAM.UploadSSHPublicKey

Methods

toQuery :: UploadSSHPublicKey -> QueryString

AWSRequest UploadSSHPublicKey

Defined in Amazonka.IAM.UploadSSHPublicKey

Associated Types

type AWSResponse UploadSSHPublicKey

Methods

request :: (Service -> Service) -> UploadSSHPublicKey -> Request UploadSSHPublicKey

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UploadSSHPublicKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UploadSSHPublicKey)))

Generic UploadSSHPublicKey

Defined in Amazonka.IAM.UploadSSHPublicKey

Associated Types

type Rep UploadSSHPublicKey :: Type -> Type

Methods

from :: UploadSSHPublicKey -> Rep UploadSSHPublicKey x

to :: Rep UploadSSHPublicKey x -> UploadSSHPublicKey

Read UploadSSHPublicKey

Defined in Amazonka.IAM.UploadSSHPublicKey

Methods

readsPrec :: Int -> ReadS UploadSSHPublicKey

readList :: ReadS [UploadSSHPublicKey]

readPrec :: ReadPrec UploadSSHPublicKey

readListPrec :: ReadPrec [UploadSSHPublicKey]

Show UploadSSHPublicKey

Defined in Amazonka.IAM.UploadSSHPublicKey

Methods

showsPrec :: Int -> UploadSSHPublicKey -> ShowS

show :: UploadSSHPublicKey -> String

showList :: [UploadSSHPublicKey] -> ShowS

NFData UploadSSHPublicKey

Defined in Amazonka.IAM.UploadSSHPublicKey

Methods

rnf :: UploadSSHPublicKey -> ()

Eq UploadSSHPublicKey

Defined in Amazonka.IAM.UploadSSHPublicKey

Methods

(==) :: UploadSSHPublicKey -> UploadSSHPublicKey -> Bool

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

Hashable UploadSSHPublicKey

Defined in Amazonka.IAM.UploadSSHPublicKey

Methods

hashWithSalt :: Int -> UploadSSHPublicKey -> Int

hash :: UploadSSHPublicKey -> Int

type AWSResponse UploadSSHPublicKey

Defined in Amazonka.IAM.UploadSSHPublicKey

type AWSResponse UploadSSHPublicKey = UploadSSHPublicKeyResponse

type Rep UploadSSHPublicKey

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

Arguments

:: Text

UploadSSHPublicKey

-> Text

UploadSSHPublicKey

-> UploadSSHPublicKey

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

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

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

Contains the response to a successful UploadSSHPublicKey request.

See: newUploadSSHPublicKeyResponse smart constructor.

Constructors

UploadSSHPublicKeyResponse'

Fields

• sSHPublicKey :: Maybe SSHPublicKey

  Contains information about the SSH public key.

• httpStatus :: Int

  The response's http status code.

Instances

Generic UploadSSHPublicKeyResponse

Defined in Amazonka.IAM.UploadSSHPublicKey

Associated Types

type Rep UploadSSHPublicKeyResponse :: Type -> Type

Methods

from :: UploadSSHPublicKeyResponse -> Rep UploadSSHPublicKeyResponse x

to :: Rep UploadSSHPublicKeyResponse x -> UploadSSHPublicKeyResponse

Read UploadSSHPublicKeyResponse

Defined in Amazonka.IAM.UploadSSHPublicKey

Methods

readsPrec :: Int -> ReadS UploadSSHPublicKeyResponse

readList :: ReadS [UploadSSHPublicKeyResponse]

readPrec :: ReadPrec UploadSSHPublicKeyResponse

readListPrec :: ReadPrec [UploadSSHPublicKeyResponse]

Show UploadSSHPublicKeyResponse

Defined in Amazonka.IAM.UploadSSHPublicKey

Methods

showsPrec :: Int -> UploadSSHPublicKeyResponse -> ShowS

show :: UploadSSHPublicKeyResponse -> String

showList :: [UploadSSHPublicKeyResponse] -> ShowS

NFData UploadSSHPublicKeyResponse

Defined in Amazonka.IAM.UploadSSHPublicKey

Methods

rnf :: UploadSSHPublicKeyResponse -> ()

Eq UploadSSHPublicKeyResponse

Defined in Amazonka.IAM.UploadSSHPublicKey

Methods

(==) :: UploadSSHPublicKeyResponse -> UploadSSHPublicKeyResponse -> Bool

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

type Rep UploadSSHPublicKeyResponse

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

Arguments

:: Int

$sel:httpStatus:UploadSSHPublicKeyResponse'

-> UploadSSHPublicKeyResponse

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

uploadSSHPublicKeyResponse_sSHPublicKey :: Lens' UploadSSHPublicKeyResponse (Maybe SSHPublicKey)

Contains information about the SSH public key.

uploadSSHPublicKeyResponse_httpStatus :: Lens' UploadSSHPublicKeyResponse Int

The response's http status code.