StartChildWorkflowExecutionFailedEventAttributes

Provides the details of the StartChildWorkflowExecutionFailed event.

AutomationTask CoordinationWorkflow

Properties

Name Type Description
workflowType object
cause object
workflowId object
initiatedEventId object
decisionTaskCompletedEventId object
control object
View JSON Schema on GitHub

JSON Schema

amazon-swf-startchildworkflowexecutionfailedeventattributes-schema.json Raw ↑
{
  "type": "object",
  "required": [
    "workflowType",
    "cause",
    "workflowId",
    "initiatedEventId",
    "decisionTaskCompletedEventId"
  ],
  "properties": {
    "workflowType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowType"
        },
        {
          "description": "The workflow type provided in the <code>StartChildWorkflowExecution</code> <a>Decision</a> that failed."
        }
      ]
    },
    "cause": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StartChildWorkflowExecutionFailedCause"
        },
        {
          "description": "<p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p> <note> <p>When <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision fails because it lacks sufficient permissions. For details and example IAM policies, see <a href=\"https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\"> Using IAM to Manage Access to Amazon SWF Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p> </note>"
        }
      ]
    },
    "workflowId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowId"
        },
        {
          "description": "The <code>workflowId</code> of the child workflow execution."
        }
      ]
    },
    "initiatedEventId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EventId"
        },
        {
          "description": "<p>When the <code>cause</code> is <code>WORKFLOW_ALREADY_RUNNING</code>, <code>initiatedEventId</code> is the ID of the <code>StartChildWorkflowExecutionInitiated</code> event that corresponds to the <code>StartChildWorkflowExecution</code> <a>Decision</a> to start the workflow execution. You can use this information to diagnose problems by tracing back the chain of events leading up to this event.</p> <p>When the <code>cause</code> isn't <code>WORKFLOW_ALREADY_RUNNING</code>, <code>initiatedEventId</code> is set to <code>0</code> because the <code>StartChildWorkflowExecutionInitiated</code> event doesn't exist.</p>"
        }
      ]
    },
    "decisionTaskCompletedEventId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EventId"
        },
        {
          "description": "The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the <code>StartChildWorkflowExecution</code> <a>Decision</a> to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events."
        }
      ]
    },
    "control": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Data"
        },
        {
          "description": "The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the child workflow execution."
        }
      ]
    }
  },
  "description": "Provides the details of the <code>StartChildWorkflowExecutionFailed</code> event.",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "StartChildWorkflowExecutionFailedEventAttributes"
}