Amazonka.Transfer.ImportSshPublicKey

Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.

The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

Creating a Request

data ImportSshPublicKey

See: newImportSshPublicKey smart constructor.

Constructors

ImportSshPublicKey'

Fields

• serverId :: Text

  A system-assigned unique identifier for a server.

• sshPublicKeyBody :: Text

  The public key portion of an SSH key pair.

  Transfer Family accepts RSA, ECDSA, and ED25519 keys.

• userName :: Text

  The name of the user account that is assigned to one or more servers.

Instances

ToJSON ImportSshPublicKey

Defined in Amazonka.Transfer.ImportSshPublicKey

Methods

toJSON :: ImportSshPublicKey -> Value

toEncoding :: ImportSshPublicKey -> Encoding

toJSONList :: [ImportSshPublicKey] -> Value

toEncodingList :: [ImportSshPublicKey] -> Encoding

ToHeaders ImportSshPublicKey

Defined in Amazonka.Transfer.ImportSshPublicKey

Methods

toHeaders :: ImportSshPublicKey -> [Header]

ToPath ImportSshPublicKey

Defined in Amazonka.Transfer.ImportSshPublicKey

Methods

toPath :: ImportSshPublicKey -> ByteString

ToQuery ImportSshPublicKey

Defined in Amazonka.Transfer.ImportSshPublicKey

Methods

toQuery :: ImportSshPublicKey -> QueryString

AWSRequest ImportSshPublicKey

Defined in Amazonka.Transfer.ImportSshPublicKey

Associated Types

type AWSResponse ImportSshPublicKey

Methods

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

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

Generic ImportSshPublicKey

Defined in Amazonka.Transfer.ImportSshPublicKey

Associated Types

type Rep ImportSshPublicKey :: Type -> Type

Methods

from :: ImportSshPublicKey -> Rep ImportSshPublicKey x

to :: Rep ImportSshPublicKey x -> ImportSshPublicKey

Read ImportSshPublicKey

Defined in Amazonka.Transfer.ImportSshPublicKey

Methods

readsPrec :: Int -> ReadS ImportSshPublicKey

readList :: ReadS [ImportSshPublicKey]

readPrec :: ReadPrec ImportSshPublicKey

readListPrec :: ReadPrec [ImportSshPublicKey]

Show ImportSshPublicKey

Defined in Amazonka.Transfer.ImportSshPublicKey

Methods

showsPrec :: Int -> ImportSshPublicKey -> ShowS

show :: ImportSshPublicKey -> String

showList :: [ImportSshPublicKey] -> ShowS

NFData ImportSshPublicKey

Defined in Amazonka.Transfer.ImportSshPublicKey

Methods

rnf :: ImportSshPublicKey -> ()

Eq ImportSshPublicKey

Defined in Amazonka.Transfer.ImportSshPublicKey

Methods

(==) :: ImportSshPublicKey -> ImportSshPublicKey -> Bool

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

Hashable ImportSshPublicKey

Defined in Amazonka.Transfer.ImportSshPublicKey

Methods

hashWithSalt :: Int -> ImportSshPublicKey -> Int

hash :: ImportSshPublicKey -> Int

type AWSResponse ImportSshPublicKey

Defined in Amazonka.Transfer.ImportSshPublicKey

type AWSResponse ImportSshPublicKey = ImportSshPublicKeyResponse

type Rep ImportSshPublicKey

Defined in Amazonka.Transfer.ImportSshPublicKey

type Rep ImportSshPublicKey = D1 ('MetaData "ImportSshPublicKey" "Amazonka.Transfer.ImportSshPublicKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ImportSshPublicKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "sshPublicKeyBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newImportSshPublicKey

Arguments

:: Text

ImportSshPublicKey

-> Text

ImportSshPublicKey

-> Text

ImportSshPublicKey

-> ImportSshPublicKey

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

ImportSshPublicKey, importSshPublicKey_serverId - A system-assigned unique identifier for a server.

ImportSshPublicKey, importSshPublicKey_sshPublicKeyBody - The public key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

ImportSshPublicKey, importSshPublicKey_userName - The name of the user account that is assigned to one or more servers.

Request Lenses

importSshPublicKey_serverId :: Lens' ImportSshPublicKey Text

A system-assigned unique identifier for a server.

importSshPublicKey_sshPublicKeyBody :: Lens' ImportSshPublicKey Text

The public key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

importSshPublicKey_userName :: Lens' ImportSshPublicKey Text

The name of the user account that is assigned to one or more servers.

Destructuring the Response

data ImportSshPublicKeyResponse

Identifies the user, the server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.

See: newImportSshPublicKeyResponse smart constructor.

Constructors

ImportSshPublicKeyResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• serverId :: Text

  A system-assigned unique identifier for a server.

• sshPublicKeyId :: Text

  The name given to a public key by the system that was imported.

• userName :: Text

  A user name assigned to the ServerID value that you specified.

Instances

Generic ImportSshPublicKeyResponse

Defined in Amazonka.Transfer.ImportSshPublicKey

Associated Types

type Rep ImportSshPublicKeyResponse :: Type -> Type

Methods

from :: ImportSshPublicKeyResponse -> Rep ImportSshPublicKeyResponse x

to :: Rep ImportSshPublicKeyResponse x -> ImportSshPublicKeyResponse

Read ImportSshPublicKeyResponse

Defined in Amazonka.Transfer.ImportSshPublicKey

Methods

readsPrec :: Int -> ReadS ImportSshPublicKeyResponse

readList :: ReadS [ImportSshPublicKeyResponse]

readPrec :: ReadPrec ImportSshPublicKeyResponse

readListPrec :: ReadPrec [ImportSshPublicKeyResponse]

Show ImportSshPublicKeyResponse

Defined in Amazonka.Transfer.ImportSshPublicKey

Methods

showsPrec :: Int -> ImportSshPublicKeyResponse -> ShowS

show :: ImportSshPublicKeyResponse -> String

showList :: [ImportSshPublicKeyResponse] -> ShowS

NFData ImportSshPublicKeyResponse

Defined in Amazonka.Transfer.ImportSshPublicKey

Methods

rnf :: ImportSshPublicKeyResponse -> ()

Eq ImportSshPublicKeyResponse

Defined in Amazonka.Transfer.ImportSshPublicKey

Methods

(==) :: ImportSshPublicKeyResponse -> ImportSshPublicKeyResponse -> Bool

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

type Rep ImportSshPublicKeyResponse

Defined in Amazonka.Transfer.ImportSshPublicKey

type Rep ImportSshPublicKeyResponse = D1 ('MetaData "ImportSshPublicKeyResponse" "Amazonka.Transfer.ImportSshPublicKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ImportSshPublicKeyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "sshPublicKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newImportSshPublicKeyResponse

Arguments

:: Int

$sel:httpStatus:ImportSshPublicKeyResponse'

-> Text

ImportSshPublicKey

-> Text

ImportSshPublicKeyResponse

-> Text

ImportSshPublicKey

-> ImportSshPublicKeyResponse

Create a value of ImportSshPublicKeyResponse 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:httpStatus:ImportSshPublicKeyResponse', importSshPublicKeyResponse_httpStatus - The response's http status code.

ImportSshPublicKey, importSshPublicKeyResponse_serverId - A system-assigned unique identifier for a server.

ImportSshPublicKeyResponse, importSshPublicKeyResponse_sshPublicKeyId - The name given to a public key by the system that was imported.

ImportSshPublicKey, importSshPublicKeyResponse_userName - A user name assigned to the ServerID value that you specified.

Response Lenses

importSshPublicKeyResponse_httpStatus :: Lens' ImportSshPublicKeyResponse Int

The response's http status code.

importSshPublicKeyResponse_serverId :: Lens' ImportSshPublicKeyResponse Text

A system-assigned unique identifier for a server.

importSshPublicKeyResponse_sshPublicKeyId :: Lens' ImportSshPublicKeyResponse Text

The name given to a public key by the system that was imported.

importSshPublicKeyResponse_userName :: Lens' ImportSshPublicKeyResponse Text

A user name assigned to the ServerID value that you specified.