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 an execution of the workflow type in the specified domain using the provided
workflowId and input data.
This action returns the newly started workflow execution.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified
domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate
keys.
tagList.member.0: The key is swf:tagList.member.0.
tagList.member.1: The key is swf:tagList.member.1.
tagList.member.2: The key is swf:tagList.member.2.
tagList.member.3: The key is swf:tagList.member.3.
tagList.member.4: The key is swf:tagList.member.4.
taskList: String constraint. The key is swf:taskList.name.
workflowType.name: String constraint. The key is swf:workflowType.name.
workflowType.version: String constraint. The key is swf:workflowType.version.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter
values fall outside the specified constraints, the action fails. The associated event
attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details
and example IAM policies, see Using
IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 BeginStartWorkflowExecution and EndStartWorkflowExecution.
Namespace: Amazon.SimpleWorkflow
Assembly: AWSSDK.SimpleWorkflow.dll
Version: 3.x.y.z
public abstract Task<StartWorkflowExecutionResponse> StartWorkflowExecutionAsync( StartWorkflowExecutionRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the StartWorkflowExecution service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| DefaultUndefinedException | The StartWorkflowExecution API action was called without the required parameters set. Some workflow execution parameters, such as the decision taskList, must be set to start the execution. However, these parameters might have been set as defaults when the workflow type was registered. In this case, you can omit these parameters from the StartWorkflowExecution call and Amazon SWF uses the values defined in the workflow type. If these parameters aren't set and no default parameters were defined in the workflow type, this error is displayed. |
| LimitExceededException | Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS. |
| OperationNotPermittedException | Returned when the caller doesn't have sufficient permissions to invoke the action. |
| TypeDeprecatedException | Returned when the specified activity or workflow type was already deprecated. |
| UnknownResourceException | Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. |
| WorkflowExecutionAlreadyStartedException | Returned by StartWorkflowExecution when an open execution with the same workflowId is already running in the specified domain. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5