StartSyncExecutionOutput

StartSyncExecutionOutput schema from Amazon Step Functions API

OrchestrationServerlessState MachineWorkflow

Properties

Name Type Description
executionArn object
stateMachineArn object
name object
startDate object
stopDate object
status object
error object
cause object
input object
inputDetails object
output object
outputDetails object
traceHeader object
billingDetails object
View JSON Schema on GitHub

JSON Schema

amazon-step-functions-start-sync-execution-output-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-start-sync-execution-output-schema.json",
  "title": "StartSyncExecutionOutput",
  "description": "StartSyncExecutionOutput schema from Amazon Step Functions API",
  "type": "object",
  "properties": {
    "executionArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The Amazon Resource Name (ARN) that identifies the execution."
        }
      ]
    },
    "stateMachineArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The Amazon Resource Name (ARN) that identifies the state machine."
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The name of the execution."
        }
      ]
    },
    "startDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date the execution is started."
        }
      ]
    },
    "stopDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "If the execution has already ended, the date the execution stopped."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SyncExecutionStatus"
        },
        {
          "description": "The current status of the execution."
        }
      ]
    },
    "error": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SensitiveError"
        },
        {
          "description": "The error code of the failure."
        }
      ]
    },
    "cause": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SensitiveCause"
        },
        {
          "description": "A more detailed explanation of the cause of the failure."
        }
      ]
    },
    "input": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SensitiveData"
        },
        {
          "description": "The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding."
        }
      ]
    },
    "inputDetails": {
      "$ref": "#/components/schemas/CloudWatchEventsExecutionDataDetails"
    },
    "output": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SensitiveData"
        },
        {
          "description": "<p>The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p> <note> <p>This field is set only if the execution succeeds. If the execution fails, this field is null.</p> </note>"
        }
      ]
    },
    "outputDetails": {
      "$ref": "#/components/schemas/CloudWatchEventsExecutionDataDetails"
    },
    "traceHeader": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TraceHeader"
        },
        {
          "description": "The X-Ray trace header that was passed to the execution."
        }
      ]
    },
    "billingDetails": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BillingDetails"
        },
        {
          "description": "An object that describes workflow billing details, including billed duration and memory use."
        }
      ]
    }
  },
  "required": [
    "executionArn",
    "startDate",
    "stopDate",
    "status"
  ]
}