Amazon Data Pipeline · Arazzo Workflow

Amazon Data Pipeline List and Describe

Version 1.0.0

List all accessible pipelines and pull full metadata for the first page of them.

1 workflow 1 source API 1 provider
View Spec View on GitHub Data ProcessingETLWorkflowsData PipelineAutomationArazzoWorkflows

Provider

amazon-data-pipeline

Workflows

list-and-describe-pipelines
Enumerate accessible pipelines, then describe the first one returned.
Chains listPipelines into describePipelines so a caller can move from a bare list of identifiers to full metadata in one pass.
2 steps inputs: marker outputs: firstPipelineId, hasMoreResults, pipelineDescriptionList
1
listPipelines
listPipelines
List the identifiers and names of every active pipeline the caller has permission to access.
2
describeFirst
describePipelines
Retrieve full metadata for the first pipeline identifier returned by the list call.

Source API Descriptions

Arazzo Workflow Specification

amazon-data-pipeline-list-and-describe-workflow.yml Raw ↑
arazzo: 1.0.1
info:
  title: Amazon Data Pipeline List and Describe
  summary: List all accessible pipelines and pull full metadata for the first page of them.
  description: >-
    A discovery flow for AWS Data Pipeline. ListPipelines returns the
    identifiers of every pipeline the caller can access, and DescribePipelines
    then retrieves the full metadata (name, description, state, fields) for the
    returned identifier. Every step spells out its request inline so the flow
    can be read and executed without opening the underlying OpenAPI description.
  version: 1.0.0
sourceDescriptions:
- name: dataPipelineApi
  url: ../openapi/amazon-data-pipeline-openapi.yml
  type: openapi
workflows:
- workflowId: list-and-describe-pipelines
  summary: Enumerate accessible pipelines, then describe the first one returned.
  description: >-
    Chains listPipelines into describePipelines so a caller can move from a bare
    list of identifiers to full metadata in one pass.
  inputs:
    type: object
    properties:
      marker:
        type: string
        description: An optional pagination marker returned by a previous ListPipelines call.
  steps:
  - stepId: listPipelines
    description: >-
      List the identifiers and names of every active pipeline the caller has
      permission to access.
    operationId: listPipelines
    requestBody:
      contentType: application/json
      payload:
        marker: $inputs.marker
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      firstPipelineId: $response.body#/pipelineIdList/0/id
      marker: $response.body#/marker
      hasMoreResults: $response.body#/hasMoreResults
  - stepId: describeFirst
    description: >-
      Retrieve full metadata for the first pipeline identifier returned by the
      list call.
    operationId: describePipelines
    requestBody:
      contentType: application/json
      payload:
        pipelineIds:
        - $steps.listPipelines.outputs.firstPipelineId
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      pipelineDescriptionList: $response.body#/pipelineDescriptionList
      pipelineState: $response.body#/pipelineDescriptionList/0/pipelineState
  outputs:
    firstPipelineId: $steps.listPipelines.outputs.firstPipelineId
    hasMoreResults: $steps.listPipelines.outputs.hasMoreResults
    pipelineDescriptionList: $steps.describeFirst.outputs.pipelineDescriptionList