You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SWF::Types::StartChildWorkflowExecutionDecisionAttributes

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb

Overview

Note:

When making an API call, you may pass StartChildWorkflowExecutionDecisionAttributes data as a 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 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.

Instance Attribute Summary collapse

Instance Attribute Details

#child_policyString

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.

Returns:

  • (String)


5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5340

class StartChildWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_type,
  :workflow_id,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :lambda_role)
  include Aws::Structure
end

#controlString

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.

Returns:

  • (String)


5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5340

class StartChildWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_type,
  :workflow_id,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :lambda_role)
  include Aws::Structure
end

#execution_start_to_close_timeoutString

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.

Returns:

  • (String)


5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5340

class StartChildWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_type,
  :workflow_id,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :lambda_role)
  include Aws::Structure
end

#inputString

The input to be provided to the workflow execution.

Returns:

  • (String)


5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5340

class StartChildWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_type,
  :workflow_id,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :lambda_role)
  include Aws::Structure
end

#lambda_roleString

The IAM role attached to the child workflow execution.

Returns:

  • (String)


5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5340

class StartChildWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_type,
  :workflow_id,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :lambda_role)
  include Aws::Structure
end

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

Returns:

  • (Array<String>)


5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5340

class StartChildWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_type,
  :workflow_id,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :lambda_role)
  include Aws::Structure
end

#task_listTypes::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 contain the literal string arn.

Returns:



5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5340

class StartChildWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_type,
  :workflow_id,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :lambda_role)
  include Aws::Structure
end

#task_priorityString

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.

Returns:

  • (String)


5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5340

class StartChildWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_type,
  :workflow_id,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :lambda_role)
  include Aws::Structure
end

#task_start_to_close_timeoutString

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.

Returns:

  • (String)


5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5340

class StartChildWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_type,
  :workflow_id,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :lambda_role)
  include Aws::Structure
end

#workflow_idString

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.

Returns:

  • (String)


5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5340

class StartChildWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_type,
  :workflow_id,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :lambda_role)
  include Aws::Structure
end

#workflow_typeTypes::WorkflowType

The type of the workflow execution to be started.

Returns:



5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5340

class StartChildWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_type,
  :workflow_id,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :lambda_role)
  include Aws::Structure
end