WorkflowStepMetadata

Runtime details and status for the workflow step.

Amazon Web ServicesAutomationContainer ImagesEC2Image BuildingVirtual Machine Images

Properties

Name Type Description
stepExecutionId object
name object
description object
action object
status object
rollbackStatus object
message object
inputs object
outputs object
startTime object
endTime object
View JSON Schema on GitHub

JSON Schema

ec2-image-builder-workflow-step-metadata-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-ec2-image-builder/refs/heads/main/json-schema/ec2-image-builder-workflow-step-metadata-schema.json",
  "title": "WorkflowStepMetadata",
  "description": "Runtime details and status for the workflow step.",
  "type": "object",
  "properties": {
    "stepExecutionId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepExecutionId"
        },
        {
          "description": "A unique identifier for the workflow step, assigned at runtime."
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepName"
        },
        {
          "description": "The name of the workflow step."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepDescription"
        },
        {
          "description": "Description of the workflow step."
        }
      ]
    },
    "action": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepAction"
        },
        {
          "description": "The step action name."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepExecutionStatus"
        },
        {
          "description": "Runtime status for the workflow step."
        }
      ]
    },
    "rollbackStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepExecutionRollbackStatus"
        },
        {
          "description": "Reports on the rollback status of the step, if applicable."
        }
      ]
    },
    "message": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepMessage"
        },
        {
          "description": "Detailed output message that the workflow step provides at runtime."
        }
      ]
    },
    "inputs": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepInputs"
        },
        {
          "description": "Input parameters that Image Builder provides for the workflow step."
        }
      ]
    },
    "outputs": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepOutputs"
        },
        {
          "description": "The file names that the workflow step created as output for this runtime instance of the workflow."
        }
      ]
    },
    "startTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DateTime"
        },
        {
          "description": "The timestamp when the workflow step started."
        }
      ]
    },
    "endTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DateTime"
        },
        {
          "description": "The timestamp when the workflow step finished."
        }
      ]
    }
  }
}