libZSservicesZSamazonka-transferZSamazonka-transfer
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Transfer.StartServer

Description

Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

No response is returned from this call.

Synopsis

Creating a Request

data StartServer Source #

See: newStartServer smart constructor.

Constructors

StartServer' 

Fields

  • serverId :: Text

    A system-assigned unique identifier for a server that you start.

Instances

Instances details
Eq StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Read StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Show StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Generic StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Associated Types

type Rep StartServer :: Type -> Type #

NFData StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Methods

rnf :: StartServer -> () #

Hashable StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

ToJSON StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

AWSRequest StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Associated Types

type AWSResponse StartServer #

ToHeaders StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Methods

toHeaders :: StartServer -> [Header] #

ToPath StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

ToQuery StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

type Rep StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

type Rep StartServer = D1 ('MetaData "StartServer" "Amazonka.Transfer.StartServer" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "StartServer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

newStartServer Source #

Create a value of StartServer 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:serverId:StartServer', startServer_serverId - A system-assigned unique identifier for a server that you start.

Request Lenses

startServer_serverId :: Lens' StartServer Text Source #

A system-assigned unique identifier for a server that you start.

Destructuring the Response

data StartServerResponse Source #

See: newStartServerResponse smart constructor.

Constructors

StartServerResponse' 

Instances

Instances details
Eq StartServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Read StartServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Show StartServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Generic StartServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Associated Types

type Rep StartServerResponse :: Type -> Type #

NFData StartServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Methods

rnf :: StartServerResponse -> () #

type Rep StartServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

type Rep StartServerResponse = D1 ('MetaData "StartServerResponse" "Amazonka.Transfer.StartServer" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "StartServerResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newStartServerResponse :: StartServerResponse Source #

Create a value of StartServerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.