AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Starts a state machine execution.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
The following qualified state machine ARN refers to a Distributed Map state
with a label mapStateLabel in a state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state,
the request fails with ValidationException.
The following qualified state machine ARN refers to an alias named PROD.
arn:
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
The following unqualified state machine ARN refers to a state machine named myStateMachine.
arn:
If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution.
To start executions of a state machine version,
call StartExecution and provide the version ARN or the ARN of an alias
that points to the version.
StartExecution is idempotent for STANDARD workflows. For a STANDARD
workflow, if you call StartExecution with the same name and input as a running
execution, the call succeeds and return the same response as the original request.
If the execution is closed or if the input is different, it returns a 400 ExecutionAlreadyExists
error. You can reuse names after 90 days.
StartExecution isn't idempotent for EXPRESS workflows.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginStartExecution and EndStartExecution.
Namespace: Amazon.StepFunctions
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z
public abstract Task<StartExecutionResponse> StartExecutionAsync( StartExecutionRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the StartExecution service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| ExecutionAlreadyExistsException | The execution has the same name as another execution (but a different input). Executions with the same name and input are considered idempotent. |
| ExecutionLimitExceededException | The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started. |
| InvalidArnException | The provided Amazon Resource Name (ARN) is not valid. |
| InvalidExecutionInputException | The provided JSON input data is not valid. |
| InvalidNameException | The provided name is not valid. |
| KmsAccessDeniedException | Either your KMS key policy or API caller does not have the required permissions. |
| KmsInvalidStateException | The KMS key is not in valid state, for example: Disabled or Deleted. |
| KmsThrottlingException | Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller. |
| StateMachineDeletingException | The specified state machine is being deleted. |
| StateMachineDoesNotExistException | The specified state machine does not exist. |
| ValidationException | The input does not satisfy the constraints specified by an Amazon Web Services service. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer