Amazon Data Pipeline Pipelines API

Operations for managing data pipelines

GitHub OpenAPI

Operations 4

POST /#CreatePipeline Create Pipeline #
POST /#DeletePipeline Delete Pipeline #
POST /#DescribePipelines Describe Pipelines #
POST /#ListPipelines List Pipelines #

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-pipelines-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.

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

OpenAPI Specification

amazon-data-pipeline-pipelines-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Data Pipeline Pipelines API
  version: '2012-10-29'
  description: Generated from AWS's published Smithy model for AWS Data Pipeline. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://datapipeline.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreatePipeline:
    post:
      operationId: CreatePipeline
      summary: Create Pipeline
      description: 'Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline. POST / HTTP/1.1 Content-Type:
        application/x-amz-json-1.1 X-Amz-Target: DataPipeline.CreatePipeline Content-Length: 91 Host: datapipeline.us-east-1.amazonaws.com
        X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"name": "myPipeline", "uniqueId": "123456789",
        "description": "This is my first pipeline"} HTTP/1.1 200 x-amzn-RequestId: b16911ce-0774-11e2-af6f-6bc7a6be60d9 Content-Type:
        application/x-amz-json-1.1 Content-Length: 40 Date: Mon, 12 Nov 2012 17:50:53 GMT {"pipelineId": "df-06372391ZG65EXAMPLE"}'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreatePipelineOutput'
        '500':
          description: InternalServiceError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceError'
        '400':
          description: InvalidRequestException
          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.CreatePipeline
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreatePipelineInput'
      tags:
      - Pipelines
  /#DeletePipeline:
    post:
      operationId: DeletePipeline
      summary: Delete Pipeline
      description: 'Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel
        instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot
        be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it,
        call SetStatus with the status set to PAUSE on individual components. Components that are paused by SetStatus can
        be resumed. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.DeletePipeline Content-Length:
        50 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams
        {"pipelineId": "df-06372391ZG65EXAMPLE"} x-amzn-RequestId: b7a88c81-0754-11e2-af6f-6bc7a6be60d9 Content-Type: application/x-amz-json-1.1
        Content-Length: 0 Date: Mon, 12 Nov 2012 17:50:53 GMT Unexpected response: 200, OK, undefined'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '500':
          description: InternalServiceError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceError'
        '400':
          description: InvalidRequestException; 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.DeletePipeline
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeletePipelineInput'
      tags:
      - Pipelines
  /#DescribePipelines:
    post:
      operationId: DescribePipelines
      summary: Describe Pipelines
      description: 'Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline,
        the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials,
        you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account,
        you can retrieve metadata about only those pipelines for which you have read permissions. To retrieve the full pipeline
        definition instead of metadata about the pipeline, call GetPipelineDefinition. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1
        X-Amz-Target: DataPipeline.DescribePipelines Content-Length: 70 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date:
        Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"pipelineIds": ["df-08785951KAKJEXAMPLE"] } x-amzn-RequestId:
        02870eb7-0736-11e2-af6f-6bc7a6be60d9 Content-Type: application/x-amz-json-1.1 Content-Length: 767 Date: Mon, 12 Nov
        2012 17:50:53 GMT {"pipelineDescriptionList": [ {"description": "This is my first pipeline", "fields": [ {"key": "@pipelineState",
        "stringValue": "SCHEDULED"}, {"key": "description", "stringValue": "This is my first pipeline"}, {"key": "name", '
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribePipelinesOutput'
        '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.DescribePipelines
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribePipelinesInput'
      tags:
      - Pipelines
  /#ListPipelines:
    post:
      operationId: ListPipelines
      summary: List Pipelines
      description: 'Lists the pipeline identifiers for all active pipelines that you have permission to access. POST / HTTP/1.1
        Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.ListPipelines Content-Length: 14 Host: datapipeline.us-east-1.amazonaws.com
        X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {} Status: x-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9
        Content-Type: application/x-amz-json-1.1 Content-Length: 39 Date: Mon, 12 Nov 2012 17:50:53 GMT {"PipelineIdList":
        [ {"id": "df-08785951KAKJEXAMPLE", "name": "MyPipeline"}, {"id": "df-08662578ISYEXAMPLE", "name": "MySecondPipeline"}
        ] }'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListPipelinesOutput'
        '500':
          description: InternalServiceError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServiceError'
        '400':
          description: InvalidRequestException
          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.ListPipelines
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListPipelinesInput'
      tags:
      - Pipelines
components:
  securitySchemes:
    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
  schemas:
    CreatePipelineInput:
      type: object
      properties:
        name:
          type: string
          description: The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS
            account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.
        uniqueId:
          type: string
          description: A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data
            Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use
            this parameter to ensure idempotency during repeated calls to CreatePipeline. For example, if the first call to
            CreatePipeline does not succeed, you can pass in the same unique identifier and pipeline name combination on a
            subsequent call to CreatePipeline. CreatePipeline ensures that if a pipeline already exists with the same name
            and unique identifier, a new pipeline is not created. I
        description:
          type: string
          description: The description for the pipeline.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines.
            For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
      required:
      - name
      - uniqueId
    CreatePipelineOutput:
      type: object
      properties:
        pipelineId:
          type: string
          description: The ID that AWS Data Pipeline assigns the newly created pipeline. For example, df-06372391ZG65EXAMPLE.
      required:
      - pipelineId
    DeletePipelineInput:
      type: object
      properties:
        pipelineId:
          type: string
          description: The ID of the pipeline.
      required:
      - pipelineId
    DescribePipelinesInput:
      type: object
      properties:
        pipelineIds:
          type: array
          items:
            type: string
          description: The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain
            pipeline IDs, call ListPipelines.
      required:
      - pipelineIds
    DescribePipelinesOutput:
      type: object
      properties:
        pipelineDescriptionList:
          type: array
          items:
            $ref: '#/components/schemas/PipelineDescription'
          description: An array of descriptions for the specified pipelines.
      required:
      - pipelineDescriptionList
    Field:
      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
    InternalServiceError:
      type: object
      properties:
        message:
          type: string
          description: Description of the error message.
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error message.
    ListPipelinesInput:
      type: object
      properties:
        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 ListPipelines with the marker value from the previous call
            to retrieve the next set of results.
    ListPipelinesOutput:
      type: object
      properties:
        pipelineIdList:
          type: array
          items:
            $ref: '#/components/schemas/PipelineIdName'
          description: The pipeline identifiers. If you require additional information about the pipelines, you can use these
            identifiers to call DescribePipelines and GetPipelineDefinition.
        marker:
          type: string
          description: The starting point for the next page of results. To view the next page of results, call ListPipelinesOutput
            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 that can be obtained by a subsequent call.
      required:
      - pipelineIdList
    PipelineDescription:
      type: object
      properties:
        pipelineId:
          type: string
          description: The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.
        name:
          type: string
          description: The name of the pipeline.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/Field'
          description: 'A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.'
        description:
          type: string
          description: Description of the pipeline.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to associated with a pipeline. Tags let you control access to pipelines. For more information,
            see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
      required:
      - pipelineId
      - name
      - fields
    PipelineIdName:
      type: object
      properties:
        id:
          type: string
          description: The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.
        name:
          type: string
          description: The name of the pipeline.
    Tag:
      type: object
      properties:
        key:
          type: string
          description: The key name of a tag defined by a user. For more information, see Controlling User Access to Pipelines
            in the AWS Data Pipeline Developer Guide.
        value:
          type: string
          description: The optional value portion of a tag defined by a user. For more information, see Controlling User Access
            to Pipelines in the AWS Data Pipeline Developer Guide.
      required:
      - key
      - value
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/data-pipeline/service/2012-10-29/data-pipeline-2012-10-29.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)