AWS SDK for .NET Documentation
StartWorkflowExecutionRequest Class
AmazonAmazon.SimpleWorkflow.ModelStartWorkflowExecutionRequest Did this page help you?   Yes   No    Tell us about it...
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:

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Declaration Syntax
C#
public class StartWorkflowExecutionRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
StartWorkflowExecutionRequest()()()()
Initializes a new instance of the StartWorkflowExecutionRequest class

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 will be terminated.
  • REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will continue to run.
Note:
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 will be returned.

Constraints:

Allowed Values
TERMINATE, REQUEST_CANCEL, ABANDON


Domain
The name of the domain in which the workflow execution is created.

Constraints:

Length
1 - 256


Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExecutionStartToCloseTimeout
The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type. The duration is specified in seconds. The valid values are integers 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.
Note:
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.

Constraints:

Length
0 - 8


GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
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.

Constraints:

Length
0 - 32768


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.

Constraints:

Length
0 - 5


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.
Note:
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 will be returned.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string "arn".

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 valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
Note:
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 will be returned.

Constraints:

Length
0 - 8


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithChildPolicy(String) Obsolete.
Sets the ChildPolicy property

WithDomain(String) Obsolete.
Sets the Domain property

WithExecutionStartToCloseTimeout(String) Obsolete.
Sets the ExecutionStartToCloseTimeout property

WithInput(String) Obsolete.
Sets the Input property

WithTagList(array<String>[]()[][]) Obsolete.
Adds elements to the TagList collection

WithTagList(IEnumerable<(Of <<'(String>)>>)) Obsolete.
Adds elements to the TagList collection

WithTaskList(TaskList) Obsolete.
Sets the TaskList property

WithTaskStartToCloseTimeout(String) Obsolete.
Sets the TaskStartToCloseTimeout property

WithWorkflowId(String) Obsolete.
Sets the WorkflowId property

WithWorkflowType(WorkflowType) Obsolete.
Sets the WorkflowType 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. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string "arn".

Constraints:

Length
1 - 256


WorkflowType
The type of the workflow to start.

Inheritance Hierarchy
Object
AmazonWebServiceRequest
 StartWorkflowExecutionRequest
See Also

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)