You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SWF::Types::StartChildWorkflowExecutionDecisionAttributes
- Inherits:
-
Struct
- Object
- Struct
- Aws::SWF::Types::StartChildWorkflowExecutionDecisionAttributes
- Defined in:
- (unknown)
Overview
When passing StartChildWorkflowExecutionDecisionAttributes as input to an Aws::Client method, you can use a vanilla Hash:
{
workflow_type: { # required
name: "Name", # required
version: "Version", # required
},
workflow_id: "WorkflowId", # required
control: "Data",
input: "Data",
execution_start_to_close_timeout: "DurationInSecondsOptional",
task_list: {
name: "Name", # required
},
task_priority: "TaskPriority",
task_start_to_close_timeout: "DurationInSecondsOptional",
child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON
tag_list: ["Tag"],
lambda_role: "Arn",
}
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 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.
Returned by:
Instance Attribute Summary collapse
-
#child_policy ⇒ String
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.
-
#control ⇒ String
The data attached to the event that can be used by the decider in subsequent workflow tasks.
-
#execution_start_to_close_timeout ⇒ String
The total duration for this workflow execution.
-
#input ⇒ String
The input to be provided to the workflow execution.
-
#lambda_role ⇒ String
The IAM role attached to the child workflow execution.
-
#tag_list ⇒ Array<String>
The list of tags to associate with the child workflow execution.
-
#task_list ⇒ Types::TaskList
The name of the task list to be used for decision tasks of the child workflow execution.
-
#task_priority ⇒ String
A task priority that, if set, specifies the priority for a decision task of this workflow execution.
-
#task_start_to_close_timeout ⇒ String
Specifies the maximum duration of decision tasks for this workflow execution.
-
#workflow_id ⇒ String
The
workflowId
of the workflow execution. -
#workflow_type ⇒ Types::WorkflowType
The type of the workflow execution to be started.
Instance Attribute Details
#child_policy ⇒ String
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 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.
Possible values:
- TERMINATE
- REQUEST_CANCEL
- ABANDON
#control ⇒ String
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.
#execution_start_to_close_timeout ⇒ String
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.
#input ⇒ String
The input to be provided to the workflow execution.
#lambda_role ⇒ String
The IAM role attached to the child workflow execution.
#tag_list ⇒ Array<String>
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.
#task_list ⇒ Types::TaskList
The name of the task list to be used for decision tasks of the child workflow execution.
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
.
#task_priority ⇒ String
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.
#task_start_to_close_timeout ⇒ String
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.
#workflow_id ⇒ String
The workflowId
of the workflow execution.
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
.
#workflow_type ⇒ Types::WorkflowType
The type of the workflow execution to be started.