MapRunItemCounts

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

OrchestrationServerlessState MachineWorkflow

Properties

Name Type Description
pending object
running object
succeeded object
failed object
timedOut object
aborted object
total object
resultsWritten object
View JSON Schema on GitHub

JSON Schema

amazon-step-functions-map-run-item-counts-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-map-run-item-counts-schema.json",
  "title": "MapRunItemCounts",
  "description": "Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.",
  "type": "object",
  "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"
  ]
}