amazonka-transfer-2.0: Amazon Transfer Family 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.Transfer.UpdateHostKey

Description

Updates the description for the host key that's specified by the ServerId and HostKeyId parameters.

Synopsis

Creating a Request

data UpdateHostKey Source #

See: newUpdateHostKey smart constructor.

Constructors

UpdateHostKey' 

Fields

  • serverId :: Text

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

  • hostKeyId :: Text

    The identifier of the host key that you are updating.

  • description :: Text

    An updated description for the host key.

Instances

Instances details
ToJSON UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Methods

toJSON :: UpdateHostKey -> Value #

toEncoding :: UpdateHostKey -> Encoding #

toJSONList :: [UpdateHostKey] -> Value #

toEncodingList :: [UpdateHostKey] -> Encoding #

ToHeaders UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Methods

toHeaders :: UpdateHostKey -> [Header] #

ToPath UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Methods

toPath :: UpdateHostKey -> ByteString #

ToQuery UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Methods

toQuery :: UpdateHostKey -> QueryString #

AWSRequest UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Associated Types

type AWSResponse UpdateHostKey #

Methods

request :: (Service -> Service) -> UpdateHostKey -> Request UpdateHostKey #

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

Generic UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Associated Types

type Rep UpdateHostKey :: Type -> Type #

Methods

from :: UpdateHostKey -> Rep UpdateHostKey x #

to :: Rep UpdateHostKey x -> UpdateHostKey #

Read UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Methods

readsPrec :: Int -> ReadS UpdateHostKey #

readList :: ReadS [UpdateHostKey] #

readPrec :: ReadPrec UpdateHostKey #

readListPrec :: ReadPrec [UpdateHostKey] #

Show UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Methods

showsPrec :: Int -> UpdateHostKey -> ShowS #

show :: UpdateHostKey -> String #

showList :: [UpdateHostKey] -> ShowS #

NFData UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Methods

rnf :: UpdateHostKey -> () #

Eq UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Methods

(==) :: UpdateHostKey -> UpdateHostKey -> Bool #

(/=) :: UpdateHostKey -> UpdateHostKey -> Bool #

Hashable UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Methods

hashWithSalt :: Int -> UpdateHostKey -> Int #

hash :: UpdateHostKey -> Int #

type AWSResponse UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

type AWSResponse UpdateHostKey = UpdateHostKeyResponse
type Rep UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

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

newUpdateHostKey Source #

Arguments

:: Text

UpdateHostKey

-> Text

UpdateHostKey

-> Text

UpdateHostKey

-> UpdateHostKey 

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

UpdateHostKey, updateHostKey_serverId - The identifier of the server that contains the host key that you are updating.

UpdateHostKey, updateHostKey_hostKeyId - The identifier of the host key that you are updating.

UpdateHostKey, updateHostKey_description - An updated description for the host key.

Request Lenses

updateHostKey_serverId :: Lens' UpdateHostKey Text Source #

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

updateHostKey_hostKeyId :: Lens' UpdateHostKey Text Source #

The identifier of the host key that you are updating.

updateHostKey_description :: Lens' UpdateHostKey Text Source #

An updated description for the host key.

Destructuring the Response

data UpdateHostKeyResponse Source #

See: newUpdateHostKeyResponse smart constructor.

Constructors

UpdateHostKeyResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • serverId :: Text

    Returns the server identifier for the server that contains the updated host key.

  • hostKeyId :: Text

    Returns the host key identifier for the updated host key.

Instances

Instances details
Generic UpdateHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Associated Types

type Rep UpdateHostKeyResponse :: Type -> Type #

Methods

from :: UpdateHostKeyResponse -> Rep UpdateHostKeyResponse x #

to :: Rep UpdateHostKeyResponse x -> UpdateHostKeyResponse #

Read UpdateHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Methods

readsPrec :: Int -> ReadS UpdateHostKeyResponse #

readList :: ReadS [UpdateHostKeyResponse] #

readPrec :: ReadPrec UpdateHostKeyResponse #

readListPrec :: ReadPrec [UpdateHostKeyResponse] #

Show UpdateHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Methods

showsPrec :: Int -> UpdateHostKeyResponse -> ShowS #

show :: UpdateHostKeyResponse -> String #

showList :: [UpdateHostKeyResponse] -> ShowS #

NFData UpdateHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Methods

rnf :: UpdateHostKeyResponse -> () #

Eq UpdateHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Methods

(==) :: UpdateHostKeyResponse -> UpdateHostKeyResponse -> Bool #

(/=) :: UpdateHostKeyResponse -> UpdateHostKeyResponse -> Bool #

type Rep UpdateHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

type Rep UpdateHostKeyResponse = D1 ('MetaData "UpdateHostKeyResponse" "Amazonka.Transfer.UpdateHostKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "UpdateHostKeyResponse'" '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))))

newUpdateHostKeyResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateHostKeyResponse'

-> Text

UpdateHostKey

-> Text

UpdateHostKey

-> UpdateHostKeyResponse 

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

UpdateHostKey, updateHostKeyResponse_serverId - Returns the server identifier for the server that contains the updated host key.

UpdateHostKey, updateHostKeyResponse_hostKeyId - Returns the host key identifier for the updated host key.

Response Lenses

updateHostKeyResponse_httpStatus :: Lens' UpdateHostKeyResponse Int Source #

The response's http status code.

updateHostKeyResponse_serverId :: Lens' UpdateHostKeyResponse Text Source #

Returns the server identifier for the server that contains the updated host key.

updateHostKeyResponse_hostKeyId :: Lens' UpdateHostKeyResponse Text Source #

Returns the host key identifier for the updated host key.