Amazonka.Transfer.ImportHostKey

Adds a host key to the server that's specified by the ServerId parameter.

Creating a Request

data ImportHostKey

See: newImportHostKey smart constructor.

Constructors

ImportHostKey'

Fields

• description :: Maybe Text

  The text description that identifies this host key.

• tags :: Maybe (NonEmpty Tag)

  Key-value pairs that can be used to group and search for host keys.

• serverId :: Text

  The identifier of the server that contains the host key that you are importing.

• hostKeyBody :: Sensitive Text

  The public key portion of an SSH key pair.

  Transfer Family accepts RSA, ECDSA, and ED25519 keys.

Instances

ToJSON ImportHostKey

Defined in Amazonka.Transfer.ImportHostKey

Methods

toJSON :: ImportHostKey -> Value

toEncoding :: ImportHostKey -> Encoding

toJSONList :: [ImportHostKey] -> Value

toEncodingList :: [ImportHostKey] -> Encoding

ToHeaders ImportHostKey

Defined in Amazonka.Transfer.ImportHostKey

Methods

toHeaders :: ImportHostKey -> [Header]

ToPath ImportHostKey

Defined in Amazonka.Transfer.ImportHostKey

Methods

toPath :: ImportHostKey -> ByteString

ToQuery ImportHostKey

Defined in Amazonka.Transfer.ImportHostKey

Methods

toQuery :: ImportHostKey -> QueryString

AWSRequest ImportHostKey

Defined in Amazonka.Transfer.ImportHostKey

Associated Types

type AWSResponse ImportHostKey

Methods

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

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

Generic ImportHostKey

Defined in Amazonka.Transfer.ImportHostKey

Associated Types

type Rep ImportHostKey :: Type -> Type

Methods

from :: ImportHostKey -> Rep ImportHostKey x

to :: Rep ImportHostKey x -> ImportHostKey

Show ImportHostKey

Defined in Amazonka.Transfer.ImportHostKey

Methods

showsPrec :: Int -> ImportHostKey -> ShowS

show :: ImportHostKey -> String

showList :: [ImportHostKey] -> ShowS

NFData ImportHostKey

Defined in Amazonka.Transfer.ImportHostKey

Methods

rnf :: ImportHostKey -> ()

Eq ImportHostKey

Defined in Amazonka.Transfer.ImportHostKey

Methods

(==) :: ImportHostKey -> ImportHostKey -> Bool

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

Hashable ImportHostKey

Defined in Amazonka.Transfer.ImportHostKey

Methods

hashWithSalt :: Int -> ImportHostKey -> Int

hash :: ImportHostKey -> Int

type AWSResponse ImportHostKey

Defined in Amazonka.Transfer.ImportHostKey

type AWSResponse ImportHostKey = ImportHostKeyResponse

type Rep ImportHostKey

Defined in Amazonka.Transfer.ImportHostKey

type Rep ImportHostKey = D1 ('MetaData "ImportHostKey" "Amazonka.Transfer.ImportHostKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ImportHostKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))) :*: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "hostKeyBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))

newImportHostKey

Arguments

:: Text

ImportHostKey

-> Text

$sel:hostKeyBody:ImportHostKey'

-> ImportHostKey

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

ImportHostKey, importHostKey_description - The text description that identifies this host key.

ImportHostKey, importHostKey_tags - Key-value pairs that can be used to group and search for host keys.

ImportHostKey, importHostKey_serverId - The identifier of the server that contains the host key that you are importing.

$sel:hostKeyBody:ImportHostKey', importHostKey_hostKeyBody - The public key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

Request Lenses

importHostKey_description :: Lens' ImportHostKey (Maybe Text)

The text description that identifies this host key.

importHostKey_tags :: Lens' ImportHostKey (Maybe (NonEmpty Tag))

Key-value pairs that can be used to group and search for host keys.

importHostKey_serverId :: Lens' ImportHostKey Text

The identifier of the server that contains the host key that you are importing.

importHostKey_hostKeyBody :: Lens' ImportHostKey Text

The public key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

Destructuring the Response

data ImportHostKeyResponse

See: newImportHostKeyResponse smart constructor.

Constructors

ImportHostKeyResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• serverId :: Text

  Returns the server identifier that contains the imported key.

• hostKeyId :: Text

  Returns the host key identifier for the imported key.

Instances

Generic ImportHostKeyResponse

Defined in Amazonka.Transfer.ImportHostKey

Associated Types

type Rep ImportHostKeyResponse :: Type -> Type

Methods

from :: ImportHostKeyResponse -> Rep ImportHostKeyResponse x

to :: Rep ImportHostKeyResponse x -> ImportHostKeyResponse

Read ImportHostKeyResponse

Defined in Amazonka.Transfer.ImportHostKey

Methods

readsPrec :: Int -> ReadS ImportHostKeyResponse

readList :: ReadS [ImportHostKeyResponse]

readPrec :: ReadPrec ImportHostKeyResponse

readListPrec :: ReadPrec [ImportHostKeyResponse]

Show ImportHostKeyResponse

Defined in Amazonka.Transfer.ImportHostKey

Methods

showsPrec :: Int -> ImportHostKeyResponse -> ShowS

show :: ImportHostKeyResponse -> String

showList :: [ImportHostKeyResponse] -> ShowS

NFData ImportHostKeyResponse

Defined in Amazonka.Transfer.ImportHostKey

Methods

rnf :: ImportHostKeyResponse -> ()

Eq ImportHostKeyResponse

Defined in Amazonka.Transfer.ImportHostKey

Methods

(==) :: ImportHostKeyResponse -> ImportHostKeyResponse -> Bool

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

type Rep ImportHostKeyResponse

Defined in Amazonka.Transfer.ImportHostKey

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

newImportHostKeyResponse

Arguments

:: Int

$sel:httpStatus:ImportHostKeyResponse'

-> Text

ImportHostKey

-> Text

ImportHostKeyResponse

-> ImportHostKeyResponse

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

ImportHostKey, importHostKeyResponse_serverId - Returns the server identifier that contains the imported key.

ImportHostKeyResponse, importHostKeyResponse_hostKeyId - Returns the host key identifier for the imported key.

Response Lenses

importHostKeyResponse_httpStatus :: Lens' ImportHostKeyResponse Int

The response's http status code.

importHostKeyResponse_serverId :: Lens' ImportHostKeyResponse Text

Returns the server identifier that contains the imported key.

importHostKeyResponse_hostKeyId :: Lens' ImportHostKeyResponse Text

Returns the host key identifier for the imported key.