| « PreviousNext » | |
  | Did this page help you? Yes | No | Tell us about it... |
StartChildWorkflowExecutionDecisionAttributes
Description
Provides details of the StartChildWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF in much the same way as for the regular API:
- Use a
Resourceelement with the domain name to limit the decision to only specified domains. - Use an
Actionelement to allow or deny permission to specify this decision. - Constrain the following parameters by using a
Conditionelement with the appropriate keys.tagList.member.N: TBDtaskList: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.
Contents
- 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 will be terminated.
- REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a
WorkflowExecutionCancelRequestedevent 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 the workflow execution being started must be specified either as a default registered for its workflow type or through this field. If neither this field is set nor a default child policy was specified at registration time then a fault will be returned.
Type: String
Valid Values:
TERMINATE | REQUEST_CANCEL | ABANDONRequired: No
- control
Optional data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the child workflow execution.
Type: String
Length constraints: Minimum length of 0. Maximum length of 32768.
Required: No
- executionStartToCloseTimeout
The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The valid values are integers greater than or equal to
0. An integer value can be used to specify the duration in seconds whileNONEcan be used to specify unlimited duration.Note
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 will be returned.
Type: String
Length constraints: Minimum length of 0. Maximum length of 8.
Required: No
- input
The input to be provided to the workflow execution.
Type: String
Length constraints: Minimum length of 0. Maximum length of 32768.
Required: No
- 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.
Type: array of Strings
Length constraints: Minimum of 0 item(s) in the list. Maximum of 5 item(s) in the list.
Required: No
- taskList
The name of the task list to be used for decision tasks of the child workflow execution.
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".Type: TaskList object
Required: No
- taskStartToCloseTimeout
Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the
defaultTaskStartToCloseTimoutspecified 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 whileNONEcan 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.
Type: String
Length constraints: Minimum length of 0. Maximum length of 8.
Required: No
- workflowId
The
workflowIdof the workflow execution. This field is required.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".Type: String
Length constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
- workflowType
The type of the workflow execution to be started. This field is required.
Type: WorkflowType object
Required: Yes
