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.Types.State

Description

Synopsis

newtype State where
- State' {
  - fromState :: Text
  }
- pattern State_OFFLINE :: State
- pattern State_ONLINE :: State
- pattern State_STARTING :: State
- pattern State_START_FAILED :: State
- pattern State_STOPPING :: State
- pattern State_STOP_FAILED :: State

Documentation

newtype State Source #

Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file operations. There are six possible states: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, and STOP_FAILED.

OFFLINE indicates that the server exists, but that it is not available for file operations. ONLINE indicates that the server is available to perform file operations. STARTING indicates that the server's was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for the server to be completely operational. Both START_FAILED and STOP_FAILED are error conditions.

Constructors

State'
Fields fromState :: Text

Bundled Patterns

pattern State_OFFLINE :: State
pattern State_ONLINE :: State
pattern State_STARTING :: State
pattern State_START_FAILED :: State
pattern State_STOPPING :: State
pattern State_STOP_FAILED :: State

Instances

Instances details

FromJSON State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods parseJSON :: Value -> Parser State # parseJSONList :: Value -> Parser [State] #
FromJSONKey State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods fromJSONKey :: FromJSONKeyFunction State # fromJSONKeyList :: FromJSONKeyFunction [State] #
ToJSON State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods toJSON :: State -> Value # toEncoding :: State -> Encoding # toJSONList :: [State] -> Value # toEncodingList :: [State] -> Encoding #
ToJSONKey State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods toJSONKey :: ToJSONKeyFunction State # toJSONKeyList :: ToJSONKeyFunction [State] #
ToByteString State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods toBS :: State -> ByteString #
ToHeader State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods toHeader :: HeaderName -> State -> [Header] #
ToLog State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods build :: State -> ByteStringBuilder #
ToQuery State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods toQuery :: State -> QueryString #
FromText State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods fromText :: Text -> Either String State #
ToText State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods toText :: State -> Text #
FromXML State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods parseXML :: [Node] -> Either String State #
ToXML State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods toXML :: State -> XML #
Generic State Source #
Instance details Defined in Amazonka.Transfer.Types.State Associated Types type Rep State :: Type -> Type # Methods from :: State -> Rep State x # to :: Rep State x -> State #
Read State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods readsPrec :: Int -> ReadS State # readList :: ReadS [State] # readPrec :: ReadPrec State # readListPrec :: ReadPrec [State] #
Show State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods showsPrec :: Int -> State -> ShowS # show :: State -> String # showList :: [State] -> ShowS #
NFData State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods rnf :: State -> () #
Eq State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods (==) :: State -> State -> Bool # (/=) :: State -> State -> Bool #
Ord State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods compare :: State -> State -> Ordering # (<) :: State -> State -> Bool # (<=) :: State -> State -> Bool # (>) :: State -> State -> Bool # (>=) :: State -> State -> Bool # max :: State -> State -> State # min :: State -> State -> State #
Hashable State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods hashWithSalt :: Int -> State -> Int # hash :: State -> Int #
type Rep State Source #
Instance details Defined in Amazonka.Transfer.Types.State type Rep State = D1 ('MetaData "State" "Amazonka.Transfer.Types.State" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "State'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))