AWS Step Functions State Machine

Schema for an AWS Step Functions state machine resource

API CompositionServerless OrchestrationWorkflowState MachineAutomation

Properties

Name	Type	Description
stateMachineArn	string	Amazon Resource Name (ARN) identifying the state machine
name	string	State machine name
status	string	Current lifecycle status
definition	string	Amazon States Language JSON definition
roleArn	string	IAM role ARN granting Step Functions execution permissions
type	string	State machine execution model
creationDate	number	Unix epoch timestamp of creation
loggingConfiguration	object	CloudWatch Logs configuration
tracingConfiguration	object	AWS X-Ray tracing configuration
label	string	Human-readable label
revisionId	string	Current revision identifier
description	string	State machine description

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/api-evangelist/step-functions/blob/main/json-schema/step-functions-state-machine-schema.json",
  "title": "AWS Step Functions State Machine",
  "description": "Schema for an AWS Step Functions state machine resource",
  "type": "object",
  "required": ["stateMachineArn", "name", "definition", "roleArn"],
  "properties": {
    "stateMachineArn": {
      "type": "string",
      "pattern": "^arn:[a-z0-9-]+:states:[a-z0-9-]+:[0-9]{12}:stateMachine:.+$",
      "description": "Amazon Resource Name (ARN) identifying the state machine"
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "description": "State machine name"
    },
    "status": {
      "type": "string",
      "enum": ["ACTIVE", "DELETING"],
      "description": "Current lifecycle status"
    },
    "definition": {
      "type": "string",
      "description": "Amazon States Language JSON definition"
    },
    "roleArn": {
      "type": "string",
      "description": "IAM role ARN granting Step Functions execution permissions"
    },
    "type": {
      "type": "string",
      "enum": ["STANDARD", "EXPRESS"],
      "description": "State machine execution model"
    },
    "creationDate": {
      "type": "number",
      "description": "Unix epoch timestamp of creation"
    },
    "loggingConfiguration": {
      "type": "object",
      "description": "CloudWatch Logs configuration",
      "properties": {
        "level": {
          "type": "string",
          "enum": ["ALL", "ERROR", "FATAL", "OFF"]
        },
        "includeExecutionData": {
          "type": "boolean"
        }
      }
    },
    "tracingConfiguration": {
      "type": "object",
      "description": "AWS X-Ray tracing configuration",
      "properties": {
        "enabled": {
          "type": "boolean"
        }
      }
    },
    "label": {
      "type": "string",
      "description": "Human-readable label"
    },
    "revisionId": {
      "type": "string",
      "description": "Current revision identifier"
    },
    "description": {
      "type": "string",
      "maxLength": 256,
      "description": "State machine description"
    }
  }
}