GetWorkflowResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-codecatalyst/json-schema/amazon-codecatalyst-get-workflow-response-schema.json",
  "title": "GetWorkflowResponse",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-codecatalyst-operations-api-openapi.yml#/components/schemas/GetWorkflowResponse",
  "type": "object",
  "properties": {
    "spaceName": {
      "type": "string",
      "description": "The name of the space."
    },
    "projectName": {
      "type": "string",
      "description": "The name of the project in the space."
    },
    "id": {
      "type": "string",
      "description": "The ID of the workflow."
    },
    "name": {
      "type": "string",
      "description": "The name of the workflow."
    },
    "sourceRepositoryName": {
      "type": "string",
      "description": "The name of the source repository where the workflow YAML is stored."
    },
    "sourceBranchName": {
      "type": "string",
      "description": "The name of the branch that contains the workflow YAML."
    },
    "definition": {
      "$ref": "#/$defs/WorkflowDefinition"
    },
    "createdTime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339"
    },
    "lastUpdatedTime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339"
    },
    "runMode": {
      "type": "string",
      "description": "The behavior to use when multiple workflows occur at the same time. For more information, see https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html in the Amazon CodeCatalyst User Guide."
    },
    "status": {
      "type": "string",
      "description": "The status of the workflow."
    }
  },
  "required": [
    "spaceName",
    "projectName",
    "id",
    "name",
    "definition",
    "createdTime",
    "lastUpdatedTime",
    "runMode",
    "status"
  ],
  "$defs": {
    "WorkflowDefinition": {
      "type": "object",
      "properties": {
        "path": {
          "type": "string",
          "description": "The path to the workflow definition file stored in the source repository for the project, including the file name."
        }
      },
      "required": [
        "path"
      ]
    }
  }
}