Amazon Data Pipeline · Arazzo Workflow

Amazon Data Pipeline Deactivate and Delete

Version 1.0.0

Stop a running pipeline and then permanently remove it and its run history.

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

Provider

amazon-data-pipeline

Workflows

deactivate-and-delete-pipeline
Deactivate a pipeline, then permanently delete it.
Chains deactivatePipeline into deletePipeline so the pipeline is quiesced before it is destroyed, avoiding deletion of a pipeline with tasks still in flight.
2 steps inputs: cancelActive, pipelineId outputs: deleted, pipelineId
1
deactivatePipeline
deactivatePipeline
Deactivate the running pipeline, optionally cancelling activities that are currently in progress.
2
deletePipeline
deletePipeline
Permanently delete the now-quiesced pipeline along with its definition and run history.

Source API Descriptions

Arazzo Workflow Specification

amazon-data-pipeline-deactivate-and-delete-workflow.yml Raw ↑
arazzo: 1.0.1
info:
  title: Amazon Data Pipeline Deactivate and Delete
  summary: Stop a running pipeline and then permanently remove it and its run history.
  description: >-
    The teardown flow for AWS Data Pipeline. The pipeline is first deactivated so
    no further tasks are scheduled (optionally cancelling activities already in
    progress), and only then is DeletePipeline called to permanently remove the
    pipeline, its definition, and its run history. 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: deactivate-and-delete-pipeline
  summary: Deactivate a pipeline, then permanently delete it.
  description: >-
    Chains deactivatePipeline into deletePipeline so the pipeline is quiesced
    before it is destroyed, avoiding deletion of a pipeline with tasks still in
    flight.
  inputs:
    type: object
    required:
    - pipelineId
    properties:
      pipelineId:
        type: string
        description: The id of the pipeline to deactivate and then delete.
      cancelActive:
        type: boolean
        description: Whether to cancel currently running activities during deactivation.
  steps:
  - stepId: deactivatePipeline
    description: >-
      Deactivate the running pipeline, optionally cancelling activities that are
      currently in progress.
    operationId: deactivatePipeline
    requestBody:
      contentType: application/json
      payload:
        pipelineId: $inputs.pipelineId
        cancelActive: $inputs.cancelActive
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      deactivated: $statusCode
  - stepId: deletePipeline
    description: >-
      Permanently delete the now-quiesced pipeline along with its definition and
      run history.
    operationId: deletePipeline
    requestBody:
      contentType: application/json
      payload:
        pipelineId: $inputs.pipelineId
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      deleted: $statusCode
  outputs:
    pipelineId: $inputs.pipelineId
    deleted: $steps.deletePipeline.outputs.deleted