StartWorkflowExecutionRequest Class

Container for the parameters to the StartWorkflowExecution operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleWorkflow.AmazonSimpleWorkflowRequest
      Amazon.SimpleWorkflow.Model.StartWorkflowExecutionRequest

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

Syntax

public class StartWorkflowExecutionRequest : AmazonSimpleWorkflowRequest
         IAmazonWebServiceRequest

The StartWorkflowExecutionRequest type exposes the following members

Constructors

	Name	Description
	StartWorkflowExecutionRequest()

Properties

Name	Type	Description
ChildPolicy	Amazon.SimpleWorkflow.ChildPolicy	Gets and sets the property ChildPolicy. If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType. The supported child policies are: `TERMINATE` – The child executions are terminated. `REQUEST_CANCEL` – A request to cancel is attempted for each child execution by recording a `WorkflowExecutionCancelRequested` event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. `ABANDON` – No action is taken. The child executions continue to run. A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
Domain	System.String	Gets and sets the property Domain. The name of the domain in which the workflow execution is created. The specified string must not contain a `:` (colon), `/` (slash), `\|` (vertical bar), or any control characters (`\u0000-\u001f` \| `\u007f-\u009f`). Also, it must not be the literal string `arn`.
ExecutionStartToCloseTimeout	System.String	Gets and sets the property ExecutionStartToCloseTimeout. The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type. The duration is specified in seconds; an integer greater than or equal to `0`. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run. An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.
Input	System.String	Gets and sets the property Input. The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This `input` is made available to the new workflow execution in the `WorkflowExecutionStarted` history event.
LambdaRole	System.String	Gets and sets the property LambdaRole. The IAM role to attach to this workflow execution. Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a `ScheduleLambdaFunctionFailed` history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
TagList	System.Collections.Generic.List<System.String>	Gets and sets the property TagList. The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
TaskList	Amazon.SimpleWorkflow.Model.TaskList	Gets and sets the property TaskList. The task list to use for the decision tasks generated for this workflow execution. This overrides the `defaultTaskList` specified when registering the workflow type. A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned. The specified string must not contain a `:` (colon), `/` (slash), `\|` (vertical bar), or any control characters (`\u0000-\u001f` \| `\u007f-\u009f`). Also, it must not be the literal string `arn`.
TaskPriority	System.String	Gets and sets the property TaskPriority. The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java's `Integer.MIN_VALUE` (-2147483648) to `Integer.MAX_VALUE` (2147483647). Higher numbers indicate higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
TaskStartToCloseTimeout	System.String	Gets and sets the property TaskStartToCloseTimeout. Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the `defaultTaskStartToCloseTimout` specified when registering the workflow type using RegisterWorkflowType. The duration is specified in seconds, an integer greater than or equal to `0`. You can use `NONE` to specify unlimited duration. A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.
WorkflowId	System.String	Gets and sets the property WorkflowId. The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same `workflowId` at the same time within the same domain. The specified string must not contain a `:` (colon), `/` (slash), `\|` (vertical bar), or any control characters (`\u0000-\u001f` \| `\u007f-\u009f`). Also, it must not be the literal string `arn`.
WorkflowType	Amazon.SimpleWorkflow.Model.WorkflowType	Gets and sets the property WorkflowType. The type of the workflow to start.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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