StateExitedEventDetails

Contains details about an exit from a state during an execution.

OrchestrationServerlessState MachineWorkflow

Properties

Name Type Description
name object
output object
outputDetails object
View JSON Schema on GitHub

JSON Schema

amazon-step-functions-state-exited-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-state-exited-event-details-schema.json",
  "title": "StateExitedEventDetails",
  "description": "Contains details about an exit from a state during an execution.",
  "type": "object",
  "properties": {
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "<p>The name of the state.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>"
        }
      ]
    },
    "output": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SensitiveData"
        },
        {
          "description": "The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding."
        }
      ]
    },
    "outputDetails": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HistoryEventExecutionDataDetails"
        },
        {
          "description": "Contains details about the output of an execution history event."
        }
      ]
    }
  },
  "required": [
    "name"
  ]
}