AWS SDK Version 3 for .NET
API Reference

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:

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to StartWorkflowExecutionAsync.

Namespace: Amazon.SimpleWorkflow
Assembly: AWSSDK.SimpleWorkflow.dll
Version: 3.x.y.z

Syntax

C#
public virtual StartWorkflowExecutionResponse StartWorkflowExecution(
         StartWorkflowExecutionRequest request
)
Parameters
request
Type: Amazon.SimpleWorkflow.Model.StartWorkflowExecutionRequest

Container for the necessary parameters to execute the StartWorkflowExecution service method.

Return Value
The response from the StartWorkflowExecution service method, as returned by SimpleWorkflow.

Exceptions

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

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also