Skip to content

/AWS1/CL_SWFSTRTCHILDWORKFLO02

Provides the details of the StartChildWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision'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.N – The key is "swf:tagList.N" where N is the tag number from 0 to 4, inclusive.

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

CONSTRUCTOR

IMPORTING

Required arguments:

io_workflowtype TYPE REF TO /AWS1/CL_SWFWORKFLOWTYPE /AWS1/CL_SWFWORKFLOWTYPE

The type of the workflow execution to be started.

iv_workflowid TYPE /AWS1/SWFWORKFLOWID /AWS1/SWFWORKFLOWID

The workflowId of the workflow execution.

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.

Optional arguments:

iv_control TYPE /AWS1/SWFDATA /AWS1/SWFDATA

The data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the child workflow execution.

iv_input TYPE /AWS1/SWFDATA /AWS1/SWFDATA

The input to be provided to the workflow execution.

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. You can use NONE to specify unlimited duration.

An execution 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 execution start-to-close timeout was specified at registration time then a fault is returned.

io_tasklist TYPE REF TO /AWS1/CL_SWFTASKLIST /AWS1/CL_SWFTASKLIST

The name of the task list to be used for decision tasks of the child workflow execution.

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 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 be the literal string arn.

iv_taskpriority TYPE /AWS1/SWFTASKPRIORITY /AWS1/SWFTASKPRIORITY

A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. 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.

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

iv_childpolicy TYPE /AWS1/SWFCHILDPOLICY /AWS1/SWFCHILDPOLICY

If set, specifies the policy to use for the child workflow executions if the workflow execution being started 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.

it_taglist TYPE /AWS1/CL_SWFTAGLIST_W=>TT_TAGLIST TT_TAGLIST

The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

iv_lambdarole TYPE /AWS1/SWFARN /AWS1/SWFARN

The IAM role attached to the child workflow execution.

Queryable Attributes

workflowType

The type of the workflow execution to be started.

Accessible with the following methods

Method Description
GET_WORKFLOWTYPE() Getter for WORKFLOWTYPE

workflowId

The workflowId of the workflow execution.

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.

Accessible with the following methods

Method Description
GET_WORKFLOWID() Getter for WORKFLOWID, with configurable default
ASK_WORKFLOWID() Getter for WORKFLOWID w/ exceptions if field has no value
HAS_WORKFLOWID() Determine if WORKFLOWID has a value

control

The data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the child workflow execution.

Accessible with the following methods

Method Description
GET_CONTROL() Getter for CONTROL, with configurable default
ASK_CONTROL() Getter for CONTROL w/ exceptions if field has no value
HAS_CONTROL() Determine if CONTROL has a value

input

The input to be provided to the workflow execution.

Accessible with the following methods

Method Description
GET_INPUT() Getter for INPUT, with configurable default
ASK_INPUT() Getter for INPUT w/ exceptions if field has no value
HAS_INPUT() Determine if INPUT has a value

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. You can use NONE to specify unlimited duration.

An execution 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 execution start-to-close timeout was specified at registration time then a fault is returned.

Accessible with the following methods

Method Description
GET_EXECSTARTTOCLOSETIMEOUT() Getter for EXECUTIONSTARTTOCLOSETIMEOUT, with configurable d
ASK_EXECSTARTTOCLOSETIMEOUT() Getter for EXECUTIONSTARTTOCLOSETIMEOUT w/ exceptions if fie
HAS_EXECSTARTTOCLOSETIMEOUT() Determine if EXECUTIONSTARTTOCLOSETIMEOUT has a value

taskList

The name of the task list to be used for decision tasks of the child workflow execution.

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 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 be the literal string arn.

Accessible with the following methods

Method Description
GET_TASKLIST() Getter for TASKLIST

taskPriority

A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. 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.

Accessible with the following methods

Method Description
GET_TASKPRIORITY() Getter for TASKPRIORITY, with configurable default
ASK_TASKPRIORITY() Getter for TASKPRIORITY w/ exceptions if field has no value
HAS_TASKPRIORITY() Determine if TASKPRIORITY has a value

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.

Accessible with the following methods

Method Description
GET_TASKSTARTTOCLOSETIMEOUT() Getter for TASKSTARTTOCLOSETIMEOUT, with configurable defaul
ASK_TASKSTARTTOCLOSETIMEOUT() Getter for TASKSTARTTOCLOSETIMEOUT w/ exceptions if field ha
HAS_TASKSTARTTOCLOSETIMEOUT() Determine if TASKSTARTTOCLOSETIMEOUT has a value

childPolicy

If set, specifies the policy to use for the child workflow executions if the workflow execution being started 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.

Accessible with the following methods

Method Description
GET_CHILDPOLICY() Getter for CHILDPOLICY, with configurable default
ASK_CHILDPOLICY() Getter for CHILDPOLICY w/ exceptions if field has no value
HAS_CHILDPOLICY() Determine if CHILDPOLICY has a value

tagList

The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

Accessible with the following methods

Method Description
GET_TAGLIST() Getter for TAGLIST, with configurable default
ASK_TAGLIST() Getter for TAGLIST w/ exceptions if field has no value
HAS_TAGLIST() Determine if TAGLIST has a value

lambdaRole

The IAM role attached to the child workflow execution.

Accessible with the following methods

Method Description
GET_LAMBDAROLE() Getter for LAMBDAROLE, with configurable default
ASK_LAMBDAROLE() Getter for LAMBDAROLE w/ exceptions if field has no value
HAS_LAMBDAROLE() Determine if LAMBDAROLE has a value