RequestCancelExternalWorkflowExecutionFailedEventAttributes

Provides the details of the RequestCancelExternalWorkflowExecutionFailed event.

AutomationTask CoordinationWorkflow

Properties

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

JSON Schema

amazon-swf-requestcancelexternalworkflowexecutionfailedeventattributes-schema.json Raw ↑
{
  "type": "object",
  "required": [
    "workflowId",
    "cause",
    "initiatedEventId",
    "decisionTaskCompletedEventId"
  ],
  "properties": {
    "workflowId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowId"
        },
        {
          "description": "The <code>workflowId</code> of the external workflow to which the cancel request was to be delivered."
        }
      ]
    },
    "runId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowRunIdOptional"
        },
        {
          "description": "The <code>runId</code> of the external workflow execution."
        }
      ]
    },
    "cause": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RequestCancelExternalWorkflowExecutionFailedCause"
        },
        {
          "description": "<p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p> <note> <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision failed because it lacked 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>"
        }
      ]
    },
    "initiatedEventId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EventId"
        },
        {
          "description": "The ID of the <code>RequestCancelExternalWorkflowExecutionInitiated</code> event corresponding to the <code>RequestCancelExternalWorkflowExecution</code> decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event."
        }
      ]
    },
    "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>RequestCancelExternalWorkflowExecution</code> decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event."
        }
      ]
    },
    "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 workflow execution."
        }
      ]
    }
  },
  "description": "Provides the details of the <code>RequestCancelExternalWorkflowExecutionFailed</code> event.",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "RequestCancelExternalWorkflowExecutionFailedEventAttributes"
}