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.StartExecution

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a state machine execution.

Synopsis

Creating a Request

startExecution #

Arguments

:: Text	`seStateMachineARN`
-> StartExecution

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

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

seInput - The string that contains the JSON input data for the execution, for example: "input": "{"first_name" : "test"}"
seName - The name of the execution. 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 . Important: An execution can't use the name of another execution for 90 days. When you make multiple StartExecution calls with the same name, the new execution doesn't run and the following rules apply: * When the original execution is open and the execution input from the new call is different , the ExecutionAlreadyExists message is returned. * When the original execution is open and the execution input from the new call is identical , the Success message is returned. * When the original execution is closed, the ExecutionAlreadyExists message is returned regardless of input. A name must not contain: * whitespace * brackets { } [ ] * wildcard characters ? * * special characters " # % ^ | ~ ` $ & , ; : / * control characters (U+0000-001F , U+007F-009F )
seStateMachineARN - The Amazon Resource Name (ARN) of the state machine to execute.

data StartExecution #

See: startExecution smart constructor.

Instances

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

Request Lenses

seInput :: Lens' StartExecution (Maybe Text) #

The string that contains the JSON input data for the execution, for example: "input": "{"first_name" : "test"}"

seName :: Lens' StartExecution (Maybe Text) #

The name of the execution. 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 . Important: An execution can't use the name of another execution for 90 days. When you make multiple StartExecution calls with the same name, the new execution doesn't run and the following rules apply: * When the original execution is open and the execution input from the new call is different , the ExecutionAlreadyExists message is returned. * When the original execution is open and the execution input from the new call is identical , the Success message is returned. * When the original execution is closed, the ExecutionAlreadyExists message is returned regardless of input. A name must not contain: * whitespace * brackets { } [ ] * wildcard characters ? * * special characters " # % ^ | ~ ` $ & , ; : / * control characters (U+0000-001F , U+007F-009F )

seStateMachineARN :: Lens' StartExecution Text #

The Amazon Resource Name (ARN) of the state machine to execute.

Destructuring the Response

startExecutionResponse #

Arguments

:: Int	`srsResponseStatus`
-> Text	`srsExecutionARN`
-> UTCTime	`srsStartDate`
-> StartExecutionResponse

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

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

srsResponseStatus - -- | The response status code.
srsExecutionARN - The Amazon Resource Name (ARN) that identifies the execution.
srsStartDate - The date the execution is started.

data StartExecutionResponse #

See: startExecutionResponse smart constructor.

Instances

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

Response Lenses

srsResponseStatus :: Lens' StartExecutionResponse Int #

- | The response status code.

srsExecutionARN :: Lens' StartExecutionResponse Text #

The Amazon Resource Name (ARN) that identifies the execution.

srsStartDate :: Lens' StartExecutionResponse UTCTime #

The date the execution is started.