| 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.StepFunctions.StartExecution
Description
Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.
A qualified state machine ARN refers to a Distributed Map state
defined within a state machine. For example, the qualified state machine
ARN
arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel
refers to a Distributed Map state with a label mapStateLabel in the
state machine named stateMachineName.
StartExecution is idempotent for STANDARD workflows. For a
STANDARD workflow, if StartExecution is called with the same name
and input as a running execution, the call will succeed and return the
same response as the original request. If the execution is closed or if
the input is different, it will return a 400 ExecutionAlreadyExists
error. Names can be reused after 90 days.
StartExecution is not idempotent for EXPRESS workflows.
Synopsis
- data StartExecution = StartExecution' {}
- newStartExecution :: Text -> StartExecution
- startExecution_input :: Lens' StartExecution (Maybe Text)
- startExecution_name :: Lens' StartExecution (Maybe Text)
- startExecution_traceHeader :: Lens' StartExecution (Maybe Text)
- startExecution_stateMachineArn :: Lens' StartExecution Text
- data StartExecutionResponse = StartExecutionResponse' {
- httpStatus :: Int
- executionArn :: Text
- startDate :: POSIX
- newStartExecutionResponse :: Int -> Text -> UTCTime -> StartExecutionResponse
- startExecutionResponse_httpStatus :: Lens' StartExecutionResponse Int
- startExecutionResponse_executionArn :: Lens' StartExecutionResponse Text
- startExecutionResponse_startDate :: Lens' StartExecutionResponse UTCTime
Creating a Request
data StartExecution Source #
See: newStartExecution smart constructor.
Constructors
| StartExecution' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> StartExecution |
Create a value of StartExecution 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:
StartExecution, startExecution_input - The string that contains the JSON input data for the execution, for
example:
"input": "{\"first_name\" : \"test\"}"If you don't include any JSON input data, you still must include the
two braces, for example: "input": "{}"
Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
StartExecution, startExecution_name - The name of the execution. This name must be unique for your Amazon Web
Services account, region, and state machine for 90 days. For more
information, see
Limits Related to State Machine Executions
in the Step Functions Developer Guide.
A name must not contain:
- white space
- brackets
< > { } [ ] - wildcard characters
? * - special characters
" # % \ ^ | ~ ` $ & , ; : / - control characters (
U+0000-001F,U+007F-009F)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
$sel:traceHeader:StartExecution', startExecution_traceHeader - Passes the X-Ray trace header. The trace header can also be passed in
the request payload.
StartExecution, startExecution_stateMachineArn - The Amazon Resource Name (ARN) of the state machine to execute.
Request Lenses
startExecution_input :: Lens' StartExecution (Maybe Text) Source #
The string that contains the JSON input data for the execution, for example:
"input": "{\"first_name\" : \"test\"}"If you don't include any JSON input data, you still must include the
two braces, for example: "input": "{}"
Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
startExecution_name :: Lens' StartExecution (Maybe Text) Source #
The name of the execution. This name must be unique for your Amazon Web Services account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the Step Functions Developer Guide.
A name must not contain:
- white space
- brackets
< > { } [ ] - wildcard characters
? * - special characters
" # % \ ^ | ~ ` $ & , ; : / - control characters (
U+0000-001F,U+007F-009F)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
startExecution_traceHeader :: Lens' StartExecution (Maybe Text) Source #
Passes the X-Ray trace header. The trace header can also be passed in the request payload.
startExecution_stateMachineArn :: Lens' StartExecution Text Source #
The Amazon Resource Name (ARN) of the state machine to execute.
Destructuring the Response
data StartExecutionResponse Source #
See: newStartExecutionResponse smart constructor.
Constructors
| StartExecutionResponse' | |
Fields
| |
Instances
newStartExecutionResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> UTCTime | |
| -> StartExecutionResponse |
Create a value of StartExecutionResponse 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:
$sel:httpStatus:StartExecutionResponse', startExecutionResponse_httpStatus - The response's http status code.
StartExecutionResponse, startExecutionResponse_executionArn - The Amazon Resource Name (ARN) that identifies the execution.
StartExecutionResponse, startExecutionResponse_startDate - The date the execution is started.
Response Lenses
startExecutionResponse_httpStatus :: Lens' StartExecutionResponse Int Source #
The response's http status code.
startExecutionResponse_executionArn :: Lens' StartExecutionResponse Text Source #
The Amazon Resource Name (ARN) that identifies the execution.
startExecutionResponse_startDate :: Lens' StartExecutionResponse UTCTime Source #
The date the execution is started.