/AWS1/CL_SWF=>STARTWORKFLOWEXECUTION()
¶
About StartWorkflowExecution¶
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 isswf:tagList.member.0
. -
tagList.member.1
: The key isswf:tagList.member.1
. -
tagList.member.2
: The key isswf:tagList.member.2
. -
tagList.member.3
: The key isswf:tagList.member.3
. -
tagList.member.4
: The key isswf:tagList.member.4
. -
taskList
: String constraint. The key isswf:taskList.name
. -
workflowType.name
: String constraint. The key isswf:workflowType.name
. -
workflowType.version
: String constraint. The key isswf: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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_DOMAIN
TYPE /AWS1/SWFDOMAINNAME
/AWS1/SWFDOMAINNAME
¶
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 stringarn
.
IV_WORKFLOWID
TYPE /AWS1/SWFWORKFLOWID
/AWS1/SWFWORKFLOWID
¶
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 stringarn
.
IO_WORKFLOWTYPE
TYPE REF TO /AWS1/CL_SWFWORKFLOWTYPE
/AWS1/CL_SWFWORKFLOWTYPE
¶
The type of the workflow to start.
Optional arguments:¶
IO_TASKLIST
TYPE REF TO /AWS1/CL_SWFTASKLIST
/AWS1/CL_SWFTASKLIST
¶
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 stringarn
.
IV_TASKPRIORITY
TYPE /AWS1/SWFTASKPRIORITY
/AWS1/SWFTASKPRIORITY
¶
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) toInteger.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.
IV_INPUT
TYPE /AWS1/SWFDATA
/AWS1/SWFDATA
¶
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 theWorkflowExecutionStarted
history event.
IV_EXECSTARTTOCLOSETIMEOUT
TYPE /AWS1/SWFDURINSECONDSOPTIONAL
/AWS1/SWFDURINSECONDSOPTIONAL
¶
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.
IT_TAGLIST
TYPE /AWS1/CL_SWFTAGLIST_W=>TT_TAGLIST
TT_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.
IV_TASKSTARTTOCLOSETIMEOUT
TYPE /AWS1/SWFDURINSECONDSOPTIONAL
/AWS1/SWFDURINSECONDSOPTIONAL
¶
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 useNONE
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.
IV_CHILDPOLICY
TYPE /AWS1/SWFCHILDPOLICY
/AWS1/SWFCHILDPOLICY
¶
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 aWorkflowExecutionCancelRequested
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.
IV_LAMBDAROLE
TYPE /AWS1/SWFARN
/AWS1/SWFARN
¶
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.