Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Transfer.StartServer

Contents

Creating a Request
Request Lenses
Destructuring the Response

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

data StartServer = StartServer' {
- serverId :: Text
}
newStartServer :: Text -> StartServer
startServer_serverId :: Lens' StartServer Text
data StartServerResponse = StartServerResponse' {
}
newStartServerResponse :: StartServerResponse

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 Methods (==) :: StartServer -> StartServer -> Bool # (/=) :: StartServer -> StartServer -> Bool #
Read StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods readsPrec :: Int -> ReadS StartServer # readList :: ReadS [StartServer] # readPrec :: ReadPrec StartServer # readListPrec :: ReadPrec [StartServer] #
Show StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods showsPrec :: Int -> StartServer -> ShowS # show :: StartServer -> String # showList :: [StartServer] -> ShowS #
Generic StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Associated Types type Rep StartServer :: Type -> Type # Methods from :: StartServer -> Rep StartServer x # to :: Rep StartServer x -> StartServer #
NFData StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods rnf :: StartServer -> () #
Hashable StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods hashWithSalt :: Int -> StartServer -> Int # hash :: StartServer -> Int #
ToJSON StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods toJSON :: StartServer -> Value # toEncoding :: StartServer -> Encoding # toJSONList :: [StartServer] -> Value # toEncodingList :: [StartServer] -> Encoding #
AWSRequest StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Associated Types type AWSResponse StartServer # Methods request :: StartServer -> Request StartServer # response :: MonadResource m => Logger -> Service -> Proxy StartServer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (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 Methods toPath :: StartServer -> ByteString #
ToQuery StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods toQuery :: StartServer -> QueryString #
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 type AWSResponse StartServer = StartServerResponse

newStartServer Source #

Arguments

:: Text	`$sel:serverId: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:

$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 Methods (==) :: StartServerResponse -> StartServerResponse -> Bool # (/=) :: StartServerResponse -> StartServerResponse -> Bool #
Read StartServerResponse Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods readsPrec :: Int -> ReadS StartServerResponse # readList :: ReadS [StartServerResponse] # readPrec :: ReadPrec StartServerResponse # readListPrec :: ReadPrec [StartServerResponse] #
Show StartServerResponse Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods showsPrec :: Int -> StartServerResponse -> ShowS # show :: StartServerResponse -> String # showList :: [StartServerResponse] -> ShowS #
Generic StartServerResponse Source #
Instance details Defined in Amazonka.Transfer.StartServer Associated Types type Rep StartServerResponse :: Type -> Type # Methods from :: StartServerResponse -> Rep StartServerResponse x # to :: Rep StartServerResponse x -> StartServerResponse #
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.