WorkflowExecutionTerminatedEventAttributes

Provides the details of the WorkflowExecutionTerminated event.

AutomationTask CoordinationWorkflow

Properties

Name Type Description
reason object
details object
childPolicy object
cause object
View JSON Schema on GitHub

JSON Schema

amazon-swf-workflowexecutionterminatedeventattributes-schema.json Raw ↑
{
  "type": "object",
  "required": [
    "childPolicy"
  ],
  "properties": {
    "reason": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TerminateReason"
        },
        {
          "description": "The reason provided for the termination."
        }
      ]
    },
    "details": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Data"
        },
        {
          "description": "The details provided for the termination."
        }
      ]
    },
    "childPolicy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChildPolicy"
        },
        {
          "description": "<p>The policy used for the child workflow executions of this workflow execution.</p> <p>The supported child policies are:</p> <ul> <li> <p> <code>TERMINATE</code> \u2013 The child executions are terminated.</p> </li> <li> <p> <code>REQUEST_CANCEL</code> \u2013 A request to cancel is attempted for each child execution by recording a <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.</p> </li> <li> <p> <code>ABANDON</code> \u2013 No action is taken. The child executions continue to run.</p> </li> </ul>"
        }
      ]
    },
    "cause": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowExecutionTerminatedCause"
        },
        {
          "description": "If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions."
        }
      ]
    }
  },
  "description": "Provides the details of the <code>WorkflowExecutionTerminated</code> event.",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WorkflowExecutionTerminatedEventAttributes"
}