Amazonka.Transfer.StartServer

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.

Creating a Request

data StartServer

See: newStartServer smart constructor.

Constructors

StartServer'

Fields

• serverId :: Text

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

Instances

ToJSON StartServer

Defined in Amazonka.Transfer.StartServer

Methods

toJSON :: StartServer -> Value

toEncoding :: StartServer -> Encoding

toJSONList :: [StartServer] -> Value

toEncodingList :: [StartServer] -> Encoding

ToHeaders StartServer

Defined in Amazonka.Transfer.StartServer

Methods

toHeaders :: StartServer -> [Header]

ToPath StartServer

Defined in Amazonka.Transfer.StartServer

Methods

toPath :: StartServer -> ByteString

ToQuery StartServer

Defined in Amazonka.Transfer.StartServer

Methods

toQuery :: StartServer -> QueryString

AWSRequest StartServer

Defined in Amazonka.Transfer.StartServer

Associated Types

type AWSResponse StartServer

Methods

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

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

Generic StartServer

Defined in Amazonka.Transfer.StartServer

Associated Types

type Rep StartServer :: Type -> Type

Methods

from :: StartServer -> Rep StartServer x

to :: Rep StartServer x -> StartServer

Read StartServer

Defined in Amazonka.Transfer.StartServer

Methods

readsPrec :: Int -> ReadS StartServer

readList :: ReadS [StartServer]

readPrec :: ReadPrec StartServer

readListPrec :: ReadPrec [StartServer]

Show StartServer

Defined in Amazonka.Transfer.StartServer

Methods

showsPrec :: Int -> StartServer -> ShowS

show :: StartServer -> String

showList :: [StartServer] -> ShowS

NFData StartServer

Defined in Amazonka.Transfer.StartServer

Methods

rnf :: StartServer -> ()

Eq StartServer

Defined in Amazonka.Transfer.StartServer

Methods

(==) :: StartServer -> StartServer -> Bool

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

Hashable StartServer

Defined in Amazonka.Transfer.StartServer

Methods

hashWithSalt :: Int -> StartServer -> Int

hash :: StartServer -> Int

type AWSResponse StartServer

Defined in Amazonka.Transfer.StartServer

type AWSResponse StartServer = StartServerResponse

type Rep StartServer

Defined in Amazonka.Transfer.StartServer

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

newStartServer

Arguments

:: Text

StartServer

-> StartServer

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:

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

Request Lenses

startServer_serverId :: Lens' StartServer Text

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

Destructuring the Response

data StartServerResponse

See: newStartServerResponse smart constructor.

Constructors

StartServerResponse'

Instances

Generic StartServerResponse

Defined in Amazonka.Transfer.StartServer

Associated Types

type Rep StartServerResponse :: Type -> Type

Methods

from :: StartServerResponse -> Rep StartServerResponse x

to :: Rep StartServerResponse x -> StartServerResponse

Read StartServerResponse

Defined in Amazonka.Transfer.StartServer

Methods

readsPrec :: Int -> ReadS StartServerResponse

readList :: ReadS [StartServerResponse]

readPrec :: ReadPrec StartServerResponse

readListPrec :: ReadPrec [StartServerResponse]

Show StartServerResponse

Defined in Amazonka.Transfer.StartServer

Methods

showsPrec :: Int -> StartServerResponse -> ShowS

show :: StartServerResponse -> String

showList :: [StartServerResponse] -> ShowS

NFData StartServerResponse

Defined in Amazonka.Transfer.StartServer

Methods

rnf :: StartServerResponse -> ()

Eq StartServerResponse

Defined in Amazonka.Transfer.StartServer

Methods

(==) :: StartServerResponse -> StartServerResponse -> Bool

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

type Rep StartServerResponse

Defined in Amazonka.Transfer.StartServer

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

newStartServerResponse :: StartServerResponse

Create a value of StartServerResponse with all optional fields omitted.

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