Class: Aws::SWF::Types::StartChildWorkflowExecutionInitiatedEventAttributes

Inherits:

Struct

• Object
• Struct
• Aws::SWF::Types::StartChildWorkflowExecutionInitiatedEventAttributes

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-swf/types.rb

Overview

Provides the details of the ‘StartChildWorkflowExecutionInitiated` event.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #child_policy ⇒ String

  The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

• #control ⇒ String

  Data attached to the event that can be used by the decider in subsequent decision tasks.

• #decision_task_completed_event_id ⇒ Integer

  The ID of the ‘DecisionTaskCompleted` event corresponding to the decision task that resulted in the `StartChildWorkflowExecution` Decision to request this child workflow execution.

• #execution_start_to_close_timeout ⇒ String

  The maximum duration for the child workflow execution.

• #input ⇒ String

  The inputs provided to the child workflow execution.

• #lambda_role ⇒ String

  The IAM role to attach to the child workflow execution.

• #tag_list ⇒ Array<String>

  The list of tags to associated with the child workflow execution.

• #task_list ⇒ Types::TaskList

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

• #task_priority ⇒ String

  The priority assigned for the decision tasks for this workflow execution.

• #task_start_to_close_timeout ⇒ String

  The maximum duration allowed for the decision tasks for this workflow execution.

• #workflow_id ⇒ String

  The ‘workflowId` of the child workflow execution.

• #workflow_type ⇒ Types::WorkflowType

  The type of the child workflow execution.

Instance Attribute Details

#child_policy ⇒ String

The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

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.

Returns:

• (String)

# File 'lib/aws-sdk-swf/types.rb', line 5076

class StartChildWorkflowExecutionInitiatedEventAttributes < Struct.new(
  :workflow_id,
  :workflow_type,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :decision_task_completed_event_id,
  :child_policy,
  :task_start_to_close_timeout,
  :tag_list,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#control ⇒ String

Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn’t sent to the activity.

Returns:

• (String)

# File 'lib/aws-sdk-swf/types.rb', line 5076

class StartChildWorkflowExecutionInitiatedEventAttributes < Struct.new(
  :workflow_id,
  :workflow_type,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :decision_task_completed_event_id,
  :child_policy,
  :task_start_to_close_timeout,
  :tag_list,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#decision_task_completed_event_id ⇒ Integer

The ID of the ‘DecisionTaskCompleted` event corresponding to the decision task that resulted in the `StartChildWorkflowExecution` Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

Returns:

• (Integer)

# File 'lib/aws-sdk-swf/types.rb', line 5076

class StartChildWorkflowExecutionInitiatedEventAttributes < Struct.new(
  :workflow_id,
  :workflow_type,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :decision_task_completed_event_id,
  :child_policy,
  :task_start_to_close_timeout,
  :tag_list,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#execution_start_to_close_timeout ⇒ String

The maximum duration for the child workflow execution. If the workflow execution isn’t closed within this duration, it is timed out and force-terminated.

The duration is specified in seconds, an integer greater than or equal to ‘0`. You can use `NONE` to specify unlimited duration.

Returns:

• (String)

# File 'lib/aws-sdk-swf/types.rb', line 5076

class StartChildWorkflowExecutionInitiatedEventAttributes < Struct.new(
  :workflow_id,
  :workflow_type,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :decision_task_completed_event_id,
  :child_policy,
  :task_start_to_close_timeout,
  :tag_list,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#input ⇒ String

The inputs provided to the child workflow execution.

Returns:

• (String)

# File 'lib/aws-sdk-swf/types.rb', line 5076

class StartChildWorkflowExecutionInitiatedEventAttributes < Struct.new(
  :workflow_id,
  :workflow_type,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :decision_task_completed_event_id,
  :child_policy,
  :task_start_to_close_timeout,
  :tag_list,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#lambda_role ⇒ String

The IAM role to attach to the child workflow execution.

Returns:

• (String)

# File 'lib/aws-sdk-swf/types.rb', line 5076

class StartChildWorkflowExecutionInitiatedEventAttributes < Struct.new(
  :workflow_id,
  :workflow_type,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :decision_task_completed_event_id,
  :child_policy,
  :task_start_to_close_timeout,
  :tag_list,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#tag_list ⇒ Array<String>

The list of tags to associated with the child workflow execution.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-swf/types.rb', line 5076

class StartChildWorkflowExecutionInitiatedEventAttributes < Struct.new(
  :workflow_id,
  :workflow_type,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :decision_task_completed_event_id,
  :child_policy,
  :task_start_to_close_timeout,
  :tag_list,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#task_list ⇒ Types::TaskList

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

Returns:

• (Types::TaskList)

# File 'lib/aws-sdk-swf/types.rb', line 5076

class StartChildWorkflowExecutionInitiatedEventAttributes < Struct.new(
  :workflow_id,
  :workflow_type,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :decision_task_completed_event_id,
  :child_policy,
  :task_start_to_close_timeout,
  :tag_list,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#task_priority ⇒ String

The priority assigned for the decision tasks for this workflow execution. 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*.

[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html

Returns:

• (String)

# File 'lib/aws-sdk-swf/types.rb', line 5076

class StartChildWorkflowExecutionInitiatedEventAttributes < Struct.new(
  :workflow_id,
  :workflow_type,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :decision_task_completed_event_id,
  :child_policy,
  :task_start_to_close_timeout,
  :tag_list,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#task_start_to_close_timeout ⇒ String

The maximum duration allowed for the decision tasks for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to ‘0`. You can use `NONE` to specify unlimited duration.

Returns:

• (String)

# File 'lib/aws-sdk-swf/types.rb', line 5076

class StartChildWorkflowExecutionInitiatedEventAttributes < Struct.new(
  :workflow_id,
  :workflow_type,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :decision_task_completed_event_id,
  :child_policy,
  :task_start_to_close_timeout,
  :tag_list,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_id ⇒ String

The ‘workflowId` of the child workflow execution.

Returns:

• (String)

# File 'lib/aws-sdk-swf/types.rb', line 5076

class StartChildWorkflowExecutionInitiatedEventAttributes < Struct.new(
  :workflow_id,
  :workflow_type,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :decision_task_completed_event_id,
  :child_policy,
  :task_start_to_close_timeout,
  :tag_list,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_type ⇒ Types::WorkflowType

The type of the child workflow execution.

Returns:

• (Types::WorkflowType)

# File 'lib/aws-sdk-swf/types.rb', line 5076

class StartChildWorkflowExecutionInitiatedEventAttributes < Struct.new(
  :workflow_id,
  :workflow_type,
  :control,
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :decision_task_completed_event_id,
  :child_policy,
  :task_start_to_close_timeout,
  :tag_list,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end