TaskScheduledEventDetails

Contains details about a task scheduled during an execution.

OrchestrationServerlessState MachineWorkflow

Properties

Name Type Description
resourceType object
resource object
region object
parameters object
timeoutInSeconds object
heartbeatInSeconds object
taskCredentials object
View JSON Schema on GitHub

JSON Schema

amazon-step-functions-task-scheduled-event-details-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-step-functions/refs/heads/main/json-schema/amazon-step-functions-task-scheduled-event-details-schema.json",
  "title": "TaskScheduledEventDetails",
  "description": "Contains details about a task scheduled during an execution.",
  "type": "object",
  "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"
  ]
}