StartSyncExecutionInput

StartSyncExecutionInput schema from Amazon Step Functions API

OrchestrationServerlessState MachineWorkflow

Properties

Name Type Description
stateMachineArn object
name object
input object
traceHeader object
View JSON Schema on GitHub

JSON Schema

amazon-step-functions-start-sync-execution-input-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-input-schema.json",
  "title": "StartSyncExecutionInput",
  "description": "StartSyncExecutionInput schema from Amazon Step Functions API",
  "type": "object",
  "properties": {
    "stateMachineArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the state machine to execute."
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The name of the execution."
        }
      ]
    },
    "input": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SensitiveData"
        },
        {
          "description": "<p>The string that contains the JSON input data for the execution, for example:</p> <p> <code>\"input\": \"{\\\"first_name\\\" : \\\"test\\\"}\"</code> </p> <note> <p>If you don't include any JSON input data, you still must include the two braces, for example: <code>\"input\": \"{}\"</code> </p> </note> <p>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>"
        }
      ]
    },
    "traceHeader": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TraceHeader"
        },
        {
          "description": "Passes the X-Ray trace header. The trace header can also be passed in the request payload."
        }
      ]
    }
  },
  "required": [
    "stateMachineArn"
  ]
}