TerminateWorkflowExecutionInput

{
  "type": "object",
  "required": [
    "domain",
    "workflowId"
  ],
  "title": "TerminateWorkflowExecutionInput",
  "properties": {
    "domain": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DomainName"
        },
        {
          "description": "The domain of the workflow execution to terminate."
        }
      ]
    },
    "workflowId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowId"
        },
        {
          "description": "The workflowId of the workflow execution to terminate."
        }
      ]
    },
    "runId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowRunIdOptional"
        },
        {
          "description": "The runId of the workflow execution to terminate."
        }
      ]
    },
    "reason": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TerminateReason"
        },
        {
          "description": " A descriptive reason for terminating the workflow execution."
        }
      ]
    },
    "details": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Data"
        },
        {
          "description": " Details for terminating the workflow execution."
        }
      ]
    },
    "childPolicy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChildPolicy"
        },
        {
          "description": "<p>If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the 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> <note> <p>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.</p> </note>"
        }
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}