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 |
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.
Synopsis
- createStateMachine :: Text -> Text -> Text -> CreateStateMachine
- data CreateStateMachine
- csmName :: Lens' CreateStateMachine Text
- csmDefinition :: Lens' CreateStateMachine Text
- csmRoleARN :: Lens' CreateStateMachine Text
- createStateMachineResponse :: Int -> Text -> UTCTime -> CreateStateMachineResponse
- data CreateStateMachineResponse
- csmrsResponseStatus :: Lens' CreateStateMachineResponse Int
- csmrsStateMachineARN :: Lens' CreateStateMachineResponse Text
- csmrsCreationDate :: Lens' CreateStateMachineResponse UTCTime
Creating a Request
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 Source #
See: createStateMachine
smart constructor.
Instances
Request Lenses
csmName :: Lens' CreateStateMachine Text Source #
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 Source #
The Amazon States Language definition of the state machine.
csmRoleARN :: Lens' CreateStateMachine Text Source #
The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
Destructuring the Response
createStateMachineResponse Source #
:: Int | |
-> Text | |
-> UTCTime | |
-> 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 Source #
See: createStateMachineResponse
smart constructor.
Instances
Response Lenses
csmrsResponseStatus :: Lens' CreateStateMachineResponse Int Source #
- - | The response status code.
csmrsStateMachineARN :: Lens' CreateStateMachineResponse Text Source #
The Amazon Resource Name (ARN) that identifies the created state machine.
csmrsCreationDate :: Lens' CreateStateMachineResponse UTCTime Source #
The date the state machine is created.