Amazon Step Functions · JSON Structure

Amazon Step Functions Task Scheduled Event Details Structure

Contains details about a task scheduled during an execution.

Type: object Properties: 7 Required: 4
OrchestrationServerlessState MachineWorkflow

TaskScheduledEventDetails is a JSON Structure definition published by Amazon Step Functions, describing 7 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

resourceType resource region parameters timeoutInSeconds heartbeatInSeconds taskCredentials

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-step-functions/refs/heads/main/json-structure/amazon-step-functions-task-scheduled-event-details-structure.json",
  "name": "TaskScheduledEventDetails",
  "description": "Contains details about a task scheduled during an execution.",
  "properties": {
    "resourceType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The service name of the resource in a task state."
        }
      ]
    },
    "resource": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The action of the resource called by a task state."
        }
      ]
    },
    "region": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The region of the scheduled task"
        }
      ]
    },
    "parameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConnectorParameters"
        },
        {
          "description": "The JSON data passed to the resource referenced in a task state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding."
        }
      ]
    },
    "timeoutInSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeoutInSeconds"
        },
        {
          "description": "The maximum allowed duration of the task."
        }
      ]
    },
    "heartbeatInSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeoutInSeconds"
        },
        {
          "description": "The maximum allowed duration between two heartbeats for the task."
        }
      ]
    },
    "taskCredentials": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TaskCredentials"
        },
        {
          "description": "The credentials that Step Functions uses for the task."
        }
      ]
    }
  },
  "required": [
    "resourceType",
    "resource",
    "region",
    "parameters"
  ]
}