Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.StepFunctions.CreateStateMachine

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language.

Creating a Request

createStateMachine #

Arguments

:: Text	`csmName`
-> Text	`csmDefinition`
-> Text	`csmRoleARN`
-> CreateStateMachine

Creates a value of CreateStateMachine with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

csmName - The name of the state machine. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide . A name must not contain: * whitespace * brackets { } [ ] * wildcard characters ? * * special characters " # % ^ | ~ ` $ & , ; : / * control characters (U+0000-001F , U+007F-009F )
csmDefinition - The Amazon States Language definition of the state machine.
csmRoleARN - The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

data CreateStateMachine #

See: createStateMachine smart constructor.

Instances

Eq CreateStateMachine #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Methods (==) :: CreateStateMachine -> CreateStateMachine -> Bool # (/=) :: CreateStateMachine -> CreateStateMachine -> Bool #
Data CreateStateMachine #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateStateMachine -> c CreateStateMachine # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateStateMachine # toConstr :: CreateStateMachine -> Constr # dataTypeOf :: CreateStateMachine -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateStateMachine) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateStateMachine) # gmapT :: (forall b. Data b => b -> b) -> CreateStateMachine -> CreateStateMachine # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateStateMachine -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateStateMachine -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateStateMachine -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateStateMachine -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateStateMachine -> m CreateStateMachine # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStateMachine -> m CreateStateMachine # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStateMachine -> m CreateStateMachine #
Read CreateStateMachine #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Methods readsPrec :: Int -> ReadS CreateStateMachine # readList :: ReadS [CreateStateMachine] # readPrec :: ReadPrec CreateStateMachine # readListPrec :: ReadPrec [CreateStateMachine] #
Show CreateStateMachine #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Methods showsPrec :: Int -> CreateStateMachine -> ShowS # show :: CreateStateMachine -> String # showList :: [CreateStateMachine] -> ShowS #
Generic CreateStateMachine #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Associated Types type Rep CreateStateMachine :: * -> * # Methods from :: CreateStateMachine -> Rep CreateStateMachine x # to :: Rep CreateStateMachine x -> CreateStateMachine #
Hashable CreateStateMachine #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Methods hashWithSalt :: Int -> CreateStateMachine -> Int # hash :: CreateStateMachine -> Int #
ToJSON CreateStateMachine #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Methods toJSON :: CreateStateMachine -> Value # toEncoding :: CreateStateMachine -> Encoding # toJSONList :: [CreateStateMachine] -> Value # toEncodingList :: [CreateStateMachine] -> Encoding #
AWSRequest CreateStateMachine #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Associated Types type Rs CreateStateMachine :: * # Methods request :: CreateStateMachine -> Request CreateStateMachine # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreateStateMachine -> ClientResponse -> m (Response CreateStateMachine) #
ToHeaders CreateStateMachine #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Methods toHeaders :: CreateStateMachine -> [Header] #
ToPath CreateStateMachine #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Methods toPath :: CreateStateMachine -> ByteString #
ToQuery CreateStateMachine #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Methods toQuery :: CreateStateMachine -> QueryString #
NFData CreateStateMachine #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Methods rnf :: CreateStateMachine -> () #
type Rep CreateStateMachine #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine type Rep CreateStateMachine = D1 (MetaData "CreateStateMachine" "Network.AWS.StepFunctions.CreateStateMachine" "amazonka-stepfunctions-1.6.0-KxCz3NVPydyBSIOsnqAvPV" False) (C1 (MetaCons "CreateStateMachine'" PrefixI True) (S1 (MetaSel (Just "_csmName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_csmDefinition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_csmRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs CreateStateMachine #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine type Rs CreateStateMachine = CreateStateMachineResponse

Request Lenses

csmName :: Lens' CreateStateMachine Text #

The name of the state machine. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide . A name must not contain: * whitespace * brackets { } [ ] * wildcard characters ? * * special characters " # % ^ | ~ ` $ & , ; : / * control characters (U+0000-001F , U+007F-009F )

csmDefinition :: Lens' CreateStateMachine Text #

The Amazon States Language definition of the state machine.

csmRoleARN :: Lens' CreateStateMachine Text #

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

Destructuring the Response

createStateMachineResponse #

Arguments

:: Int	`csmrsResponseStatus`
-> Text	`csmrsStateMachineARN`
-> UTCTime	`csmrsCreationDate`
-> CreateStateMachineResponse

Creates a value of CreateStateMachineResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

csmrsResponseStatus - -- | The response status code.
csmrsStateMachineARN - The Amazon Resource Name (ARN) that identifies the created state machine.
csmrsCreationDate - The date the state machine is created.

data CreateStateMachineResponse #

See: createStateMachineResponse smart constructor.

Instances

Eq CreateStateMachineResponse #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Methods (==) :: CreateStateMachineResponse -> CreateStateMachineResponse -> Bool # (/=) :: CreateStateMachineResponse -> CreateStateMachineResponse -> Bool #
Data CreateStateMachineResponse #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateStateMachineResponse -> c CreateStateMachineResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateStateMachineResponse # toConstr :: CreateStateMachineResponse -> Constr # dataTypeOf :: CreateStateMachineResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateStateMachineResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateStateMachineResponse) # gmapT :: (forall b. Data b => b -> b) -> CreateStateMachineResponse -> CreateStateMachineResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateStateMachineResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateStateMachineResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateStateMachineResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateStateMachineResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateStateMachineResponse -> m CreateStateMachineResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStateMachineResponse -> m CreateStateMachineResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStateMachineResponse -> m CreateStateMachineResponse #
Read CreateStateMachineResponse #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Methods readsPrec :: Int -> ReadS CreateStateMachineResponse # readList :: ReadS [CreateStateMachineResponse] # readPrec :: ReadPrec CreateStateMachineResponse # readListPrec :: ReadPrec [CreateStateMachineResponse] #
Show CreateStateMachineResponse #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Methods showsPrec :: Int -> CreateStateMachineResponse -> ShowS # show :: CreateStateMachineResponse -> String # showList :: [CreateStateMachineResponse] -> ShowS #
Generic CreateStateMachineResponse #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Associated Types type Rep CreateStateMachineResponse :: * -> * # Methods from :: CreateStateMachineResponse -> Rep CreateStateMachineResponse x # to :: Rep CreateStateMachineResponse x -> CreateStateMachineResponse #
NFData CreateStateMachineResponse #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine Methods rnf :: CreateStateMachineResponse -> () #
type Rep CreateStateMachineResponse #
Instance details Defined in Network.AWS.StepFunctions.CreateStateMachine type Rep CreateStateMachineResponse = D1 (MetaData "CreateStateMachineResponse" "Network.AWS.StepFunctions.CreateStateMachine" "amazonka-stepfunctions-1.6.0-KxCz3NVPydyBSIOsnqAvPV" False) (C1 (MetaCons "CreateStateMachineResponse'" PrefixI True) (S1 (MetaSel (Just "_csmrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :: (S1 (MetaSel (Just "_csmrsStateMachineARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_csmrsCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 POSIX))))

Response Lenses

csmrsResponseStatus :: Lens' CreateStateMachineResponse Int #

- | The response status code.

csmrsStateMachineARN :: Lens' CreateStateMachineResponse Text #

The Amazon Resource Name (ARN) that identifies the created state machine.

csmrsCreationDate :: Lens' CreateStateMachineResponse UTCTime #

The date the state machine is created.