Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Transfer.StopServer

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server.

Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.

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

No response is returned from this call.

Synopsis

data StopServer = StopServer' {
- serverId :: Text
}
newStopServer :: Text -> StopServer
stopServer_serverId :: Lens' StopServer Text
data StopServerResponse = StopServerResponse' {
}
newStopServerResponse :: StopServerResponse

Creating a Request

data StopServer Source #

See: newStopServer smart constructor.

Constructors

StopServer'
Fields serverId :: Text A system-assigned unique identifier for a server that you stopped.

Instances

Instances details

ToJSON StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods toJSON :: StopServer -> Value # toEncoding :: StopServer -> Encoding # toJSONList :: [StopServer] -> Value # toEncodingList :: [StopServer] -> Encoding #
ToHeaders StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods toHeaders :: StopServer -> [Header] #
ToPath StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods toPath :: StopServer -> ByteString #
ToQuery StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods toQuery :: StopServer -> QueryString #
AWSRequest StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Associated Types type AWSResponse StopServer # Methods request :: (Service -> Service) -> StopServer -> Request StopServer # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopServer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopServer))) #
Generic StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Associated Types type Rep StopServer :: Type -> Type # Methods from :: StopServer -> Rep StopServer x # to :: Rep StopServer x -> StopServer #
Read StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods readsPrec :: Int -> ReadS StopServer # readList :: ReadS [StopServer] # readPrec :: ReadPrec StopServer # readListPrec :: ReadPrec [StopServer] #
Show StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods showsPrec :: Int -> StopServer -> ShowS # show :: StopServer -> String # showList :: [StopServer] -> ShowS #
NFData StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods rnf :: StopServer -> () #
Eq StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods (==) :: StopServer -> StopServer -> Bool # (/=) :: StopServer -> StopServer -> Bool #
Hashable StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods hashWithSalt :: Int -> StopServer -> Int # hash :: StopServer -> Int #
type AWSResponse StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer type AWSResponse StopServer = StopServerResponse
type Rep StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer type Rep StopServer = D1 ('MetaData "StopServer" "Amazonka.Transfer.StopServer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "StopServer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopServer Source #

Arguments

:: Text	`StopServer`
-> StopServer

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

StopServer, stopServer_serverId - A system-assigned unique identifier for a server that you stopped.

Request Lenses

stopServer_serverId :: Lens' StopServer Text Source #

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

Destructuring the Response

data StopServerResponse Source #

See: newStopServerResponse smart constructor.

Constructors

StopServerResponse'

Instances

Instances details

Generic StopServerResponse Source #
Instance details Defined in Amazonka.Transfer.StopServer Associated Types type Rep StopServerResponse :: Type -> Type # Methods from :: StopServerResponse -> Rep StopServerResponse x # to :: Rep StopServerResponse x -> StopServerResponse #
Read StopServerResponse Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods readsPrec :: Int -> ReadS StopServerResponse # readList :: ReadS [StopServerResponse] # readPrec :: ReadPrec StopServerResponse # readListPrec :: ReadPrec [StopServerResponse] #
Show StopServerResponse Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods showsPrec :: Int -> StopServerResponse -> ShowS # show :: StopServerResponse -> String # showList :: [StopServerResponse] -> ShowS #
NFData StopServerResponse Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods rnf :: StopServerResponse -> () #
Eq StopServerResponse Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods (==) :: StopServerResponse -> StopServerResponse -> Bool # (/=) :: StopServerResponse -> StopServerResponse -> Bool #
type Rep StopServerResponse Source #
Instance details Defined in Amazonka.Transfer.StopServer type Rep StopServerResponse = D1 ('MetaData "StopServerResponse" "Amazonka.Transfer.StopServer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "StopServerResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newStopServerResponse :: StopServerResponse Source #

Create a value of StopServerResponse with all optional fields omitted.

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