Amazon Step Functions · JSON Structure

Amazon Step Functions Map Run Item Counts Structure

Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.

Type: object Properties: 8 Required: 8
OrchestrationServerlessState MachineWorkflow

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

Properties

pending running succeeded failed timedOut aborted total resultsWritten

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-map-run-item-counts-structure.json",
  "name": "MapRunItemCounts",
  "description": "Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.",
  "properties": {
    "pending": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UnsignedLong"
        },
        {
          "description": "The total number of items to process in child workflow executions that haven't started running yet."
        }
      ]
    },
    "running": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UnsignedLong"
        },
        {
          "description": "The total number of items being processed in child workflow executions that are currently in-progress."
        }
      ]
    },
    "succeeded": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UnsignedLong"
        },
        {
          "description": "The total number of items processed in child workflow executions that have completed successfully."
        }
      ]
    },
    "failed": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UnsignedLong"
        },
        {
          "description": "The total number of items processed in child workflow executions that have failed."
        }
      ]
    },
    "timedOut": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UnsignedLong"
        },
        {
          "description": "The total number of items processed in child workflow executions that have timed out."
        }
      ]
    },
    "aborted": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UnsignedLong"
        },
        {
          "description": "The total number of items processed in child workflow executions that were either stopped by the user or by Step Functions, because the Map Run failed."
        }
      ]
    },
    "total": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UnsignedLong"
        },
        {
          "description": "The total number of items processed in all the child workflow executions started by a Map Run."
        }
      ]
    },
    "resultsWritten": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UnsignedLong"
        },
        {
          "description": "Returns the count of items whose results were written by <code>ResultWriter</code>. For more information, see <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html\">ResultWriter</a> in the <i>Step Functions Developer Guide</i>."
        }
      ]
    }
  },
  "required": [
    "pending",
    "running",
    "succeeded",
    "failed",
    "timedOut",
    "aborted",
    "total",
    "resultsWritten"
  ]
}