Amazon Data Pipeline Pipeline Runs API

openapi: 3.1.0
info:
  title: AWS Data Pipeline Pipeline Objects Pipeline Runs API
  description: The AWS Data Pipeline API provides a web service for processing and moving data between different AWS compute and storage services as well as on-premises data sources at specified intervals. Supports creating pipeline definitions, scheduling data transformations, configuring retry and failure handling, and monitoring pipeline execution.
  version: '2012-10-29'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
servers:
- url: https://datapipeline.amazonaws.com
  description: AWS Data Pipeline API
security:
- awsSignatureV4: []
tags:
- name: Pipeline Runs
  description: Operations for managing pipeline execution and task runs
paths:
  /?Action=ActivatePipeline:
    post:
      operationId: activatePipeline
      summary: Activate Pipeline
      description: Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails.
      tags:
      - Pipeline Runs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivatePipelineRequest'
            examples:
              default:
                x-microcks-default: true
                value:
                  pipelineId: df-0937003B3GENERIC4EXAMPLE
                  parameterValues:
                  - id: myVariable
                    stringValue: myValue
                  startTimestamp: '2024-01-15T00:00:00Z'
      responses:
        '200':
          description: Pipeline activated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivatePipelineOutput'
              examples:
                default:
                  x-microcks-default: true
                  value: {}
  /?Action=DeactivatePipeline:
    post:
      operationId: deactivatePipeline
      summary: Deactivate Pipeline
      description: Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes.
      tags:
      - Pipeline Runs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeactivatePipelineRequest'
            examples:
              default:
                x-microcks-default: true
                value:
                  pipelineId: df-0937003B3GENERIC4EXAMPLE
                  cancelActive: true
      responses:
        '200':
          description: Pipeline deactivation initiated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeactivatePipelineOutput'
              examples:
                default:
                  x-microcks-default: true
                  value: {}
  /?Action=QueryObjects:
    post:
      operationId: queryObjects
      summary: Query Objects
      description: Queries the specified pipeline for the names of objects that match the specified set of conditions.
      tags:
      - Pipeline Runs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryObjectsRequest'
            examples:
              default:
                x-microcks-default: true
                value:
                  pipelineId: df-0937003B3GENERIC4EXAMPLE
                  sphere: INSTANCE
                  query:
                    selectors:
                    - fieldName: '@status'
                      operator:
                        type: EQ
                        values:
                        - RUNNING
      responses:
        '200':
          description: Query results returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryObjectsOutput'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    ids:
                    - '@SomeActivity_2024-01-15T00:00:00'
                    hasMoreResults: false
  /?Action=DescribeObjects:
    post:
      operationId: describeObjects
      summary: Describe Objects
      description: Gets the object definitions for a set of objects associated with the pipeline.
      tags:
      - Pipeline Runs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeObjectsRequest'
            examples:
              default:
                x-microcks-default: true
                value:
                  pipelineId: df-0937003B3GENERIC4EXAMPLE
                  objectIds:
                  - '@SomeActivity_2024-01-15T00:00:00'
      responses:
        '200':
          description: Object descriptions returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeObjectsOutput'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    pipelineObjects:
                    - id: '@SomeActivity_2024-01-15T00:00:00'
                      name: SomeActivity
                      fields:
                      - key: '@status'
                        stringValue: RUNNING
                    hasMoreResults: false
components:
  schemas:
    ActivatePipelineRequest:
      description: Request body for activating a pipeline.
      type: object
      required:
      - pipelineId
      properties:
        pipelineId:
          type: string
        parameterValues:
          type: array
          items:
            type: object
        startTimestamp:
          type: string
          format: date-time
    DescribeObjectsRequest:
      description: Request body for describing pipeline objects.
      type: object
      required:
      - pipelineId
      - objectIds
      properties:
        pipelineId:
          type: string
        objectIds:
          type: array
          items:
            type: string
        evaluateExpressions:
          type: boolean
        marker:
          type: string
    QueryObjectsOutput:
      description: Response containing matching pipeline object IDs.
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
        marker:
          type: string
        hasMoreResults:
          type: boolean
    Field:
      description: A key-value pair that defines a pipeline object or parameter property.
      type: object
      required:
      - key
      properties:
        key:
          type: string
          description: The field key
        stringValue:
          type: string
          description: The string value of the field
        refValue:
          type: string
          description: A reference to another pipeline object
    QueryObjectsRequest:
      description: Request body for querying pipeline objects.
      type: object
      required:
      - pipelineId
      - sphere
      properties:
        pipelineId:
          type: string
        sphere:
          type: string
          description: Indicates whether the query applies to components or instances
          enum:
          - COMPONENT
          - INSTANCE
          - ATTEMPT
        query:
          type: object
        marker:
          type: string
        limit:
          type: integer
    DeactivatePipelineOutput:
      description: Response after deactivating a pipeline.
      type: object
    DeactivatePipelineRequest:
      description: Request body for deactivating a pipeline.
      type: object
      required:
      - pipelineId
      properties:
        pipelineId:
          type: string
        cancelActive:
          type: boolean
          description: Whether to cancel currently running activities
    DescribeObjectsOutput:
      description: Response containing pipeline object definitions.
      type: object
      properties:
        pipelineObjects:
          type: array
          items:
            $ref: '#/components/schemas/PipelineObject'
        marker:
          type: string
        hasMoreResults:
          type: boolean
    PipelineObject:
      description: A pipeline component that defines an activity, resource, schedule, or precondition.
      type: object
      required:
      - id
      - name
      - fields
      properties:
        id:
          type: string
          description: The identifier of the pipeline object
        name:
          type: string
          description: The name of the pipeline object
        fields:
          type: array
          description: Key-value pairs defining the object configuration
          items:
            $ref: '#/components/schemas/Field'
    ActivatePipelineOutput:
      description: Response after activating a pipeline.
      type: object
  securitySchemes:
    awsSignatureV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 authentication