Amazon Data Pipeline

Amazon Data Pipeline Runs API

Operations for managing pipeline execution and task runs

Documentation GitHub OpenAPI

Operations 5

POST /?Action=ActivatePipeline Activate Pipeline #

POST /?Action=DeactivatePipeline Deactivate Pipeline #

POST /?Action=QueryObjects Query Objects #

POST /?Action=DescribeObjects Describe Objects #

POST /#DescribeObjects Describe Objects #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-data-pipeline:amazon-data-pipeline-pipeline-runs-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon Data Pipeline Pipeline Runs API
  version: '2012-10-29'
  description: 'Operations tagged Pipeline Runs across 2 of this provider''s published API definitions: amazon-data-pipeline-openapi.yml, amazon-data-pipeline-pipeline-runs-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://datapipeline.amazonaws.com
  description: AWS Data Pipeline API
- url: https://datapipeline.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
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: {}
      security:
      - awsSignatureV4: []
    servers:
    - url: https://datapipeline.amazonaws.com
      description: AWS Data Pipeline API
  /?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: {}
      security:
      - awsSignatureV4: []
    servers:
    - url: https://datapipeline.amazonaws.com
      description: AWS Data Pipeline API
  /?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
      security:
      - awsSignatureV4: []
    servers:
    - url: https://datapipeline.amazonaws.com
      description: AWS Data Pipeline API
  /?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
      security:
      - awsSignatureV4: []
    servers:
    - url: https://datapipeline.amazonaws.com
      description: AWS Data Pipeline API
  /#DescribeObjects:
    post:
      operationId: DescribeObjects
      summary: Describe Objects
      description: 'Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.DescribeObjects Content-Length: 98 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"pipelineId": "df-06372391ZG65EXAMPLE", "objectIds": ["Schedule"], "evaluateExpressions": true} x-amzn-RequestId: 4c18ea5d-0777-11e2-8a14-21bb8a1f50ef Content-Type: application/x-amz-json-1.1 Content-Length: 1488 Date: Mon, 12 Nov 2012 17:50:53 GMT {"hasMoreResults": false, "pipelineObjects": [ {"fields": [ {"key": "startDateTime", "stringValue": "2012-12-12T00:00:00"}, {"key": "parent", "refValue": "Default"}, {"key": "@sphere", "stringValue": "COMPONENT"}, {"key": "type", "stringValue": "Schedule"}, {"key": "period", "stringValue": "1 hour"}, {"key": "endDateTime", "stringValue": "2012-12-21T18:00:00"}, {"key": "@version", "stringValue": "1"}, {"key": "@status", "stringValue": "PENDING"}, {"key": "@pipelineId", "stringValue": "df-06372391ZG65EXAMPLE"} ], "id": "Schedule", "name": "Sch'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeObjectsOutput_2'
        '500':
          description: InternalServiceError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceError'
        '400':
          description: InvalidRequestException; PipelineDeletedException; PipelineNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DataPipeline.DescribeObjects
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeObjectsInput'
      tags:
      - Pipeline Runs
      security:
      - sigv4: []
    servers:
    - url: https://datapipeline.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    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
    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
    ActivatePipelineOutput:
      description: Response after activating a pipeline.
      type: object
    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'
    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
    QueryObjectsOutput:
      description: Response containing matching pipeline object IDs.
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
        marker:
          type: string
        hasMoreResults:
          type: boolean
    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
    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
    DescribeObjectsOutput:
      description: Response containing pipeline object definitions.
      type: object
      properties:
        pipelineObjects:
          type: array
          items:
            $ref: '#/components/schemas/PipelineObject'
        marker:
          type: string
        hasMoreResults:
          type: boolean
    DescribeObjectsInput:
      type: object
      properties:
        pipelineId:
          type: string
          description: The ID of the pipeline that contains the object definitions.
        objectIds:
          type: array
          items:
            type: string
          description: The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.
        evaluateExpressions:
          type: boolean
          description: Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
        marker:
          type: string
          description: The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call DescribeObjects with the marker value from the previous call to retrieve the next set of results.
      required:
      - pipelineId
      - objectIds
    Field_2:
      type: object
      properties:
        key:
          type: string
          description: The field identifier.
        stringValue:
          type: string
          description: The field value, expressed as a String.
        refValue:
          type: string
          description: The field value, expressed as the identifier of another object.
      required:
      - key
    PipelineObject_2:
      type: object
      properties:
        id:
          type: string
          description: The ID of the object.
        name:
          type: string
          description: The name of the object.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/Field_2'
          description: Key-value pairs that define the properties of the object.
      required:
      - id
      - name
      - fields
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error message.
    InternalServiceError:
      type: object
      properties:
        message:
          type: string
          description: Description of the error message.
    DescribeObjectsOutput_2:
      type: object
      properties:
        pipelineObjects:
          type: array
          items:
            $ref: '#/components/schemas/PipelineObject_2'
          description: An array of object definitions.
        marker:
          type: string
          description: The starting point for the next page of results. To view the next page of results, call DescribeObjects again with this marker value. If the value is null, there are no more results.
        hasMoreResults:
          type: boolean
          description: Indicates whether there are more results to return.
      required:
      - pipelineObjects
  securitySchemes:
    awsSignatureV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 authentication
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: datapipeline
x-refined-from:
- amazon-data-pipeline-openapi.yml
- amazon-data-pipeline-pipeline-runs-api-openapi.yml

Amazon Data Pipeline Runs API

Operations 5

Documentation

Specifications

Schemas & Data

Other Resources