ActivityTaskScheduledEventAttributes

Provides the details of the ActivityTaskScheduled event.

AutomationTask CoordinationWorkflow

Properties

Name Type Description
activityType object
activityId object
input object
control object
scheduleToStartTimeout object
scheduleToCloseTimeout object
startToCloseTimeout object
taskList object
taskPriority object
decisionTaskCompletedEventId object
heartbeatTimeout object
View JSON Schema on GitHub

JSON Schema

amazon-swf-activitytaskscheduledeventattributes-schema.json Raw ↑
{
  "type": "object",
  "required": [
    "activityType",
    "activityId",
    "taskList",
    "decisionTaskCompletedEventId"
  ],
  "properties": {
    "activityType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ActivityType"
        },
        {
          "description": "The type of the activity task."
        }
      ]
    },
    "activityId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ActivityId"
        },
        {
          "description": "The unique ID of the activity task."
        }
      ]
    },
    "input": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Data"
        },
        {
          "description": "The input provided to the activity task."
        }
      ]
    },
    "control": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Data"
        },
        {
          "description": "Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity."
        }
      ]
    },
    "scheduleToStartTimeout": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DurationInSecondsOptional"
        },
        {
          "description": "The maximum amount of time the activity task can wait to be assigned to a worker."
        }
      ]
    },
    "scheduleToCloseTimeout": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DurationInSecondsOptional"
        },
        {
          "description": "The maximum amount of time for this activity task."
        }
      ]
    },
    "startToCloseTimeout": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DurationInSecondsOptional"
        },
        {
          "description": "The maximum amount of time a worker may take to process the activity task."
        }
      ]
    },
    "taskList": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TaskList"
        },
        {
          "description": "The task list in which the activity task has been scheduled."
        }
      ]
    },
    "taskPriority": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TaskPriority"
        },
        {
          "description": "<p> The priority to assign to the scheduled activity task. If set, this overrides any default priority value that was assigned when the activity type was registered.</p> <p>Valid values are integers that range from Java's <code>Integer.MIN_VALUE</code> (-2147483648) to <code>Integer.MAX_VALUE</code> (2147483647). Higher numbers indicate higher priority.</p> <p>For more information about setting task priority, see <a href=\"https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html\">Setting Task Priority</a> in the <i>Amazon SWF Developer Guide</i>.</p>"
        }
      ]
    },
    "decisionTaskCompletedEventId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EventId"
        },
        {
          "description": "The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event."
        }
      ]
    },
    "heartbeatTimeout": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DurationInSecondsOptional"
        },
        {
          "description": "The maximum time before which the worker processing this task must report progress by calling <a>RecordActivityTaskHeartbeat</a>. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it is ignored."
        }
      ]
    }
  },
  "description": "Provides the details of the <code>ActivityTaskScheduled</code> event.",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ActivityTaskScheduledEventAttributes"
}