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.
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:
Resource
element with the domain name to limit the action
to only specified domains.Action
element to allow or
deny permission to call this action.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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Namespace: Amazon.SimpleWorkflow.Model
Assembly: AWSSDK.dll
Version: (assembly version)
public class StartWorkflowExecutionRequest : AmazonSimpleWorkflowRequest IRequestEvents
The StartWorkflowExecutionRequest type exposes the following members
Name | Description | |
---|---|---|
StartWorkflowExecutionRequest() |
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:
|
|
Domain | System.String |
Gets and sets the property Domain.
The name of the domain in which the workflow execution is created. |
|
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 will cause 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. |
|
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 |
|
LambdaRole | System.String |
Gets and sets the property LambdaRole.
The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions. |
|
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
The specified string must not start or end with whitespace. It must not contain a
|
|
TaskPriority | System.String |
Gets and sets the property TaskPriority.
The task priority to use for this workflow execution. This will override any default
priority that was assigned when the workflow type was registered. If not set, then
the default task priority for the workflow type will be used. Valid values are integers
that range from Java's For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow 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 The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration. |
|
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
The specified string must not start or end with whitespace. It must not contain a
|
|
WorkflowType | Amazon.SimpleWorkflow.Model.WorkflowType |
Gets and sets the property WorkflowType.
The type of the workflow to start. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8