Amazon SageMaker Sagemaker Pipeline Execution API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Pipeline Execution 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:
  /#DescribePipelineExecution:
    post:
      operationId: DescribePipelineExecution
      summary: Describe Pipeline Execution
      description: Describes the details of a pipeline execution.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribePipelineExecutionResponse'
        '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.DescribePipelineExecution
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribePipelineExecutionRequest'
      tags:
      - Pipeline Execution
  /#ListPipelineExecutions:
    post:
      operationId: ListPipelineExecutions
      summary: List Pipeline Executions
      description: Gets a list of the pipeline executions.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListPipelineExecutionsResponse'
        '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.ListPipelineExecutions
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListPipelineExecutionsRequest'
      tags:
      - Pipeline Execution
  /#StartPipelineExecution:
    post:
      operationId: StartPipelineExecution
      summary: Start Pipeline Execution
      description: Starts a pipeline execution.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartPipelineExecutionResponse'
        '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.StartPipelineExecution
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartPipelineExecutionRequest'
      tags:
      - Pipeline Execution
  /#StopPipelineExecution:
    post:
      operationId: StopPipelineExecution
      summary: Stop Pipeline Execution
      description: Stops a pipeline execution. Callback Step A pipeline execution won't stop while a callback step is running.
        When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends
        an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a "Status" field
        which is set to "Stopping". You should add logic to your Amazon SQS message consumer to take any needed action (for
        example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure.
        Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution. Lambda Step A pipeline
        execution can't be stopped while a lambda step is running because the Lambda function invoked by the lambda step can't
        be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the
        Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function
        finishes, the pipeline execution status is Stopped. If the timeout is hit the pipeline execution status is Failed.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopPipelineExecutionResponse'
        '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.StopPipelineExecution
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopPipelineExecutionRequest'
      tags:
      - Pipeline Execution
  /#UpdatePipelineExecution:
    post:
      operationId: UpdatePipelineExecution
      summary: Update Pipeline Execution
      description: Updates a pipeline execution.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdatePipelineExecutionResponse'
        '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.UpdatePipelineExecution
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdatePipelineExecutionRequest'
      tags:
      - Pipeline Execution
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
    DescribePipelineExecutionRequest:
      type: object
      properties:
        PipelineExecutionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the pipeline execution.
      required:
      - PipelineExecutionArn
    DescribePipelineExecutionResponse:
      type: object
      properties:
        PipelineArn:
          type: string
          description: The Amazon Resource Name (ARN) of the pipeline.
        PipelineExecutionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the pipeline execution.
        PipelineExecutionDisplayName:
          type: string
          description: The display name of the pipeline execution.
        PipelineExecutionStatus:
          type: string
          enum:
          - Executing
          - Stopping
          - Stopped
          - Failed
          - Succeeded
          - CompletedWithFailures
          description: The status of the pipeline execution.
        PipelineExecutionDescription:
          type: string
          description: The description of the pipeline execution.
        PipelineExperimentConfig:
          $ref: '#/components/schemas/PipelineExperimentConfig'
        FailureReason:
          type: string
          description: If the execution failed, a message describing why.
        CreationTime:
          type: string
          format: date-time
          description: The time when the pipeline execution was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The time when the pipeline execution was modified last.
        CreatedBy:
          $ref: '#/components/schemas/UserContext'
        LastModifiedBy:
          $ref: '#/components/schemas/UserContext'
        ParallelismConfiguration:
          $ref: '#/components/schemas/ParallelismConfiguration'
        SelectiveExecutionConfig:
          $ref: '#/components/schemas/SelectiveExecutionConfig'
        PipelineVersionId:
          type: integer
          description: The ID of the pipeline version.
        MLflowConfig:
          $ref: '#/components/schemas/MLflowConfiguration'
    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.
    ListPipelineExecutionsRequest:
      type: object
      properties:
        PipelineName:
          type: string
          description: The name or Amazon Resource Name (ARN) of the pipeline.
        CreatedAfter:
          type: string
          format: date-time
          description: A filter that returns the pipeline executions that were created after a specified time.
        CreatedBefore:
          type: string
          format: date-time
          description: A filter that returns the pipeline executions that were created before a specified time.
        SortBy:
          type: string
          enum:
          - CreationTime
          - PipelineExecutionArn
          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 ListPipelineExecutions request was truncated, the response includes a
            NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
        MaxResults:
          type: integer
          description: The maximum number of pipeline executions to return in the response.
      required:
      - PipelineName
    ListPipelineExecutionsResponse:
      type: object
      properties:
        PipelineExecutionSummaries:
          type: array
          items:
            $ref: '#/components/schemas/PipelineExecutionSummary'
          description: Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run
            summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This
            list can be empty.
        NextToken:
          type: string
          description: If the result of the previous ListPipelineExecutions request was truncated, the response includes a
            NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
    MLflowConfiguration:
      type: object
      properties:
        MlflowResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of MLflow configuration resource.
        MlflowExperimentName:
          type: string
          description: The name of the MLflow configuration.
    ParallelismConfiguration:
      type: object
      properties:
        MaxParallelExecutionSteps:
          type: integer
          description: The max number of steps that can be executed in parallel.
      required:
      - MaxParallelExecutionSteps
    Parameter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the parameter to assign a value to. This parameter name must match a named parameter in
            the pipeline definition.
        Value:
          type: string
          description: The literal value for the parameter.
      required:
      - Name
      - Value
    PipelineExecutionSummary:
      type: object
      properties:
        PipelineExecutionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the pipeline execution.
        StartTime:
          type: string
          format: date-time
          description: The start time of the pipeline execution.
        PipelineExecutionStatus:
          type: string
          enum:
          - Executing
          - Stopping
          - Stopped
          - Failed
          - Succeeded
          - CompletedWithFailures
          description: The status of the pipeline execution.
        PipelineExecutionDescription:
          type: string
          description: The description of the pipeline execution.
        PipelineExecutionDisplayName:
          type: string
          description: The display name of the pipeline execution.
        PipelineExecutionFailureReason:
          type: string
          description: A message generated by SageMaker Pipelines describing why the pipeline execution failed.
    PipelineExperimentConfig:
      type: object
      properties:
        ExperimentName:
          type: string
          description: The name of the experiment.
        TrialName:
          type: string
          description: The name of the trial.
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
    SelectedStep:
      type: object
      properties:
        StepName:
          type: string
          description: The name of the pipeline step.
      required:
      - StepName
    SelectiveExecutionConfig:
      type: object
      properties:
        SourcePipelineExecutionArn:
          type: string
          description: The ARN from a reference execution of the current pipeline. Used to copy input collaterals needed for
            the selected steps to run. The execution status of the pipeline can be either Failed or Success. This field is
            required if the steps you specify for SelectedSteps depend on output collaterals from any non-specified pipeline
            steps. For more information, see Selective Execution for Pipeline Steps.
        SelectedSteps:
          type: array
          items:
            $ref: '#/components/schemas/SelectedStep'
          description: A list of pipeline steps to run. All step(s) in all path(s) between two selected steps should be included.
      required:
      - SelectedSteps
    StartPipelineExecutionRequest:
      type: object
      properties:
        PipelineName:
          type: string
          description: The name or Amazon Resource Name (ARN) of the pipeline.
        PipelineExecutionDisplayName:
          type: string
          description: The display name of the pipeline execution.
        PipelineParameters:
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
          description: Contains a list of pipeline parameters. This list can be empty.
        PipelineExecutionDescription:
          type: string
          description: The description of the pipeline execution.
        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 once.
        ParallelismConfiguration:
          $ref: '#/components/schemas/ParallelismConfiguration'
        SelectiveExecutionConfig:
          $ref: '#/components/schemas/SelectiveExecutionConfig'
        PipelineVersionId:
          type: integer
          description: The ID of the pipeline version to start execution from.
        MlflowExperimentName:
          type: string
          description: The MLflow experiment name of the pipeline execution.
      required:
      - PipelineName
      - ClientRequestToken
    StartPipelineExecutionResponse:
      type: object
      properties:
        PipelineExecutionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the pipeline execution.
    StopPipelineExecutionRequest:
      type: object
      properties:
        PipelineExecutionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the pipeline execution.
        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 once.
      required:
      - PipelineExecutionArn
      - ClientRequestToken
    StopPipelineExecutionResponse:
      type: object
      properties:
        PipelineExecutionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the pipeline execution.
    UpdatePipelineExecutionRequest:
      type: object
      properties:
        PipelineExecutionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the pipeline execution.
        PipelineExecutionDescription:
          type: string
          description: The description of the pipeline execution.
        PipelineExecutionDisplayName:
          type: string
          description: The display name of the pipeline execution.
        ParallelismConfiguration:
          $ref: '#/components/schemas/ParallelismConfiguration'
      required:
      - PipelineExecutionArn
    UpdatePipelineExecutionResponse:
      type: object
      properties:
        PipelineExecutionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the updated pipeline execution.
    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)