Pipeline Description

Contains pipeline metadata including name, description, fields, and tags.

Data ProcessingETLWorkflowsData PipelineAutomation

Properties

Name Type Description
pipelineId string The unique identifier of the pipeline
name string
description string
pipelineState string
View JSON Schema on GitHub

JSON Schema

pipeline-description-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/amazon-data-pipeline/json-schema/pipeline-description-schema.json",
  "title": "Pipeline Description",
  "description": "Contains pipeline metadata including name, description, fields, and tags.",
  "type": "object",
  "properties": {
    "pipelineId": {
      "type": "string",
      "description": "The unique identifier of the pipeline"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "pipelineState": {
      "type": "string",
      "enum": [
        "SCHEDULED",
        "RUNNING",
        "SHUTTING_DOWN",
        "FINISHED",
        "FAILED",
        "INACTIVE"
      ]
    }
  }
}