AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Provides the details of the StartChildWorkflowExecutionInitiated event.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#child_policyString

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.

    Possible values:

    • TERMINATE
    • REQUEST_CANCEL
    • ABANDON

Returns:

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

#controlString

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)

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

#decision_task_completed_event_idInteger

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)

    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_timeoutString

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)

    The maximum duration for the child workflow execution.

#inputString

The inputs provided to the child workflow execution.

Returns:

  • (String)

    The inputs provided to the child workflow execution.

#lambda_roleString

The IAM role to attach to the child workflow execution.

Returns:

  • (String)

    The IAM role to attach to the child workflow execution.

#tag_listArray<String>

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

Returns:

  • (Array<String>)

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

#task_listTypes::TaskList

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

Returns:

  • (Types::TaskList)

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

#task_priorityString

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.

Returns:

  • (String)

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

#task_start_to_close_timeoutString

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)

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

#workflow_idString

The workflowId of the child workflow execution.

Returns:

  • (String)

    The workflowId of the child workflow execution.

#workflow_typeTypes::WorkflowType

The type of the child workflow execution.

Returns: