Amazon SageMaker

Amazon SageMaker Sagemaker Pipeline API

The Sagemaker Pipeline API from Amazon SageMaker — 5 operation(s) for sagemaker pipeline.

GitHub OpenAPI
Business capability
Artificial Intelligence Management BC-610.60

Operations 5

POST /#CreatePipeline Create Pipeline #
POST /#DeletePipeline Delete Pipeline #
POST /#DescribePipeline Describe Pipeline #
POST /#ListPipelines List Pipelines #
POST /#UpdatePipeline Update Pipeline #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-sagemaker/openapi/amazon-sagemaker-pipeline-api-openapi.yml

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-sagemaker:amazon-sagemaker-pipeline-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

amazon-sagemaker-pipeline-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Amazon SageMaker Service Pipeline API
  version: '2017-07-24'
  description: Generated from AWS's published Smithy model for Amazon SageMaker Service. 5 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://api.sagemaker.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreatePipeline:
    post:
      operationId: CreatePipeline
      summary: Create Pipeline
      description: Creates a pipeline using a JSON pipeline definition.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreatePipelineResponse'
        '400':
          description: ConflictException; ResourceLimitExceeded; ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.CreatePipeline
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreatePipelineRequest'
      tags:
      - Pipeline
  /#DeletePipeline:
    post:
      operationId: DeletePipeline
      summary: Delete Pipeline
      description: Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop
        all running instances of the pipeline using the StopPipelineExecution API. When you delete a pipeline, all instances
        of the pipeline are deleted.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeletePipelineResponse'
        '400':
          description: ConflictException; ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DeletePipeline
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeletePipelineRequest'
      tags:
      - Pipeline
  /#DescribePipeline:
    post:
      operationId: DescribePipeline
      summary: Describe Pipeline
      description: Describes the details of a pipeline.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribePipelineResponse'
        '400':
          description: ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DescribePipeline
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribePipelineRequest'
      tags:
      - Pipeline
  /#ListPipelines:
    post:
      operationId: ListPipelines
      summary: List Pipelines
      description: Gets a list of pipelines.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListPipelinesResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListPipelines
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListPipelinesRequest'
      tags:
      - Pipeline
  /#UpdatePipeline:
    post:
      operationId: UpdatePipeline
      summary: Update Pipeline
      description: Updates a pipeline.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdatePipelineResponse'
        '400':
          description: ConflictException; ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.UpdatePipeline
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdatePipelineRequest'
      tags:
      - Pipeline
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: sagemaker
  schemas:
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreatePipelineRequest:
      type: object
      properties:
        PipelineName:
          type: string
          description: The name of the pipeline.
        PipelineDisplayName:
          type: string
          description: The display name of the pipeline.
        PipelineDefinition:
          type: string
          description: The JSON pipeline definition of the pipeline.
        PipelineDefinitionS3Location:
          $ref: '#/components/schemas/PipelineDefinitionS3Location'
        PipelineDescription:
          type: string
          description: A description of the pipeline.
        ClientRequestToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An
            idempotent operation completes no more than one time.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to apply to the created pipeline.
        ParallelismConfiguration:
          $ref: '#/components/schemas/ParallelismConfiguration'
      required:
      - PipelineName
      - ClientRequestToken
      - RoleArn
    CreatePipelineResponse:
      type: object
      properties:
        PipelineArn:
          type: string
          description: The Amazon Resource Name (ARN) of the created pipeline.
    DeletePipelineRequest:
      type: object
      properties:
        PipelineName:
          type: string
          description: The name of the pipeline to delete.
        ClientRequestToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An
            idempotent operation completes no more than one time.
      required:
      - PipelineName
      - ClientRequestToken
    DeletePipelineResponse:
      type: object
      properties:
        PipelineArn:
          type: string
          description: The Amazon Resource Name (ARN) of the pipeline to delete.
    DescribePipelineRequest:
      type: object
      properties:
        PipelineName:
          type: string
          description: The name or Amazon Resource Name (ARN) of the pipeline to describe.
        PipelineVersionId:
          type: integer
          description: The ID of the pipeline version to describe.
      required:
      - PipelineName
    DescribePipelineResponse:
      type: object
      properties:
        PipelineArn:
          type: string
          description: The Amazon Resource Name (ARN) of the pipeline.
        PipelineName:
          type: string
          description: The name of the pipeline.
        PipelineDisplayName:
          type: string
          description: The display name of the pipeline.
        PipelineDefinition:
          type: string
          description: The JSON pipeline definition.
        PipelineDescription:
          type: string
          description: The description of the pipeline.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) that the pipeline uses to execute.
        PipelineStatus:
          type: string
          enum:
          - Active
          - Deleting
          description: The status of the pipeline execution.
        CreationTime:
          type: string
          format: date-time
          description: The time when the pipeline was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The time when the pipeline was last modified.
        LastRunTime:
          type: string
          format: date-time
          description: The time when the pipeline was last run.
        CreatedBy:
          $ref: '#/components/schemas/UserContext'
        LastModifiedBy:
          $ref: '#/components/schemas/UserContext'
        ParallelismConfiguration:
          $ref: '#/components/schemas/ParallelismConfiguration'
        PipelineVersionDisplayName:
          type: string
          description: The display name of the pipeline version.
        PipelineVersionDescription:
          type: string
          description: The description of the pipeline version.
    IamIdentity:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM identity.
        PrincipalId:
          type: string
          description: The ID of the principal that assumes the IAM identity.
        SourceIdentity:
          type: string
          description: The person or application which assumes the IAM identity.
    ListPipelinesRequest:
      type: object
      properties:
        PipelineNamePrefix:
          type: string
          description: The prefix of the pipeline name.
        CreatedAfter:
          type: string
          format: date-time
          description: A filter that returns the pipelines that were created after a specified time.
        CreatedBefore:
          type: string
          format: date-time
          description: A filter that returns the pipelines that were created before a specified time.
        SortBy:
          type: string
          enum:
          - Name
          - CreationTime
          description: The field by which to sort results. The default is CreatedTime.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: The sort order for results.
        NextToken:
          type: string
          description: If the result of the previous ListPipelines request was truncated, the response includes a NextToken.
            To retrieve the next set of pipelines, use the token in the next request.
        MaxResults:
          type: integer
          description: The maximum number of pipelines to return in the response.
    ListPipelinesResponse:
      type: object
      properties:
        PipelineSummaries:
          type: array
          items:
            $ref: '#/components/schemas/PipelineSummary'
          description: Contains a sorted list of PipelineSummary objects matching the specified filters. Each PipelineSummary
            consists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime,
            and RoleArn. This list can be empty.
        NextToken:
          type: string
          description: If the result of the previous ListPipelines request was truncated, the response includes a NextToken.
            To retrieve the next set of pipelines, use the token in the next request.
    ParallelismConfiguration:
      type: object
      properties:
        MaxParallelExecutionSteps:
          type: integer
          description: The max number of steps that can be executed in parallel.
      required:
      - MaxParallelExecutionSteps
    PipelineDefinitionS3Location:
      type: object
      properties:
        Bucket:
          type: string
          description: Name of the S3 bucket.
        ObjectKey:
          type: string
          description: The object key (or key name) uniquely identifies the object in an S3 bucket.
        VersionId:
          type: string
          description: Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest
            version.
      required:
      - Bucket
      - ObjectKey
    PipelineSummary:
      type: object
      properties:
        PipelineArn:
          type: string
          description: The Amazon Resource Name (ARN) of the pipeline.
        PipelineName:
          type: string
          description: The name of the pipeline.
        PipelineDisplayName:
          type: string
          description: The display name of the pipeline.
        PipelineDescription:
          type: string
          description: The description of the pipeline.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) that the pipeline used to execute.
        CreationTime:
          type: string
          format: date-time
          description: The creation time of the pipeline.
        LastModifiedTime:
          type: string
          format: date-time
          description: The time that the pipeline was last modified.
        LastExecutionTime:
          type: string
          format: date-time
          description: The last time that a pipeline execution began.
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The tag key. Tag keys must be unique per resource.
        Value:
          type: string
          description: The tag value.
      required:
      - Key
      - Value
    UpdatePipelineRequest:
      type: object
      properties:
        PipelineName:
          type: string
          description: The name of the pipeline to update.
        PipelineDisplayName:
          type: string
          description: The display name of the pipeline.
        PipelineDefinition:
          type: string
          description: The JSON pipeline definition.
        PipelineDefinitionS3Location:
          $ref: '#/components/schemas/PipelineDefinitionS3Location'
        PipelineDescription:
          type: string
          description: The description of the pipeline.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) that the pipeline uses to execute.
        ParallelismConfiguration:
          $ref: '#/components/schemas/ParallelismConfiguration'
      required:
      - PipelineName
    UpdatePipelineResponse:
      type: object
      properties:
        PipelineArn:
          type: string
          description: The Amazon Resource Name (ARN) of the updated pipeline.
        PipelineVersionId:
          type: integer
          description: The ID of the pipeline version.
    UserContext:
      type: object
      properties:
        UserProfileArn:
          type: string
          description: The Amazon Resource Name (ARN) of the user's profile.
        UserProfileName:
          type: string
          description: The name of the user's profile.
        DomainId:
          type: string
          description: The domain associated with the user.
        IamIdentity:
          $ref: '#/components/schemas/IamIdentity'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/sagemaker/service/2017-07-24/sagemaker-2017-07-24.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)