Amazon SageMaker

Amazon SageMaker Training Jobs API

Operations for managing SageMaker training jobs.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.aws.amazon.com/sagemaker/latest/APIReference/Welcome.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/amazon-sagemaker/refs/heads/main/openapi/amazon-sagemaker-training-jobs-api-openapi.yml

Code Examples

💻
CodeExamples
https://github.com/aws/amazon-sagemaker-examples

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-sagemaker/refs/heads/main/json-schema/amazon-sagemaker-notebook-instance-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-sagemaker/refs/heads/main/json-schema/amazon-sagemaker-training-job-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-sagemaker/refs/heads/main/json-schema/amazon-sagemaker-model-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-sagemaker/refs/heads/main/json-schema/amazon-sagemaker-endpoint-schema.json

Other Resources

🔗
SDKs
https://pypi.org/project/sagemaker/
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/amazon-sagemaker/refs/heads/main/graphql/amazon-sagemaker-graphql.md

OpenAPI Specification

amazon-sagemaker-training-jobs-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Amazon SageMaker Endpoints Training Jobs API
  description: Amazon SageMaker is a fully managed machine learning platform that enables developers and data scientists to build, train, and deploy machine learning models at scale. This API provides programmatic access to SageMaker resources including notebook instances, training jobs, models, and endpoints.
  version: 2017-07-24
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/sagemaker/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://api.sagemaker.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
      description: The AWS region.
tags:
- name: Training Jobs
  description: Operations for managing SageMaker training jobs.
paths:
  /#CreateTrainingJob:
    post:
      operationId: CreateTrainingJob
      summary: Amazon SageMaker Create a Training Job
      description: Starts a model training job. SageMaker provides the algorithm and compute resources, and you provide the input data and training parameters.
      tags:
      - Training Jobs
      parameters:
      - $ref: '#/components/parameters/XAmzTarget'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              required:
              - TrainingJobName
              - AlgorithmSpecification
              - RoleArn
              - OutputDataConfig
              - ResourceConfig
              - StoppingCondition
              properties:
                TrainingJobName:
                  type: string
                AlgorithmSpecification:
                  type: object
                  properties:
                    TrainingImage:
                      type: string
                    TrainingInputMode:
                      type: string
                      enum:
                      - Pipe
                      - File
                    AlgorithmName:
                      type: string
                RoleArn:
                  type: string
                InputDataConfig:
                  type: array
                  items:
                    type: object
                    properties:
                      ChannelName:
                        type: string
                      DataSource:
                        type: object
                        properties:
                          S3DataSource:
                            type: object
                            properties:
                              S3DataType:
                                type: string
                              S3Uri:
                                type: string
                              S3DataDistributionType:
                                type: string
                OutputDataConfig:
                  type: object
                  properties:
                    S3OutputPath:
                      type: string
                    KmsKeyId:
                      type: string
                ResourceConfig:
                  type: object
                  properties:
                    InstanceType:
                      type: string
                    InstanceCount:
                      type: integer
                    VolumeSizeInGB:
                      type: integer
                StoppingCondition:
                  type: object
                  properties:
                    MaxRuntimeInSeconds:
                      type: integer
                    MaxWaitTimeInSeconds:
                      type: integer
                HyperParameters:
                  type: object
                  additionalProperties:
                    type: string
                Tags:
                  type: array
                  items:
                    $ref: '#/components/schemas/Tag'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  TrainingJobArn:
                    type: string
              examples:
                CreateTrainingJob200Example:
                  summary: Default CreateTrainingJob 200 response
                  x-microcks-default: true
                  value:
                    Status: Success
                    RequestId: abc12345-def6-7890-ghij-klmnopqrstuv
                    RoleArn: arn:aws:iam::123456789012:role/SageMakerRole
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /#DescribeTrainingJob:
    post:
      operationId: DescribeTrainingJob
      summary: Amazon SageMaker Describe a Training Job
      description: Returns information about a training job.
      tags:
      - Training Jobs
      parameters:
      - $ref: '#/components/parameters/XAmzTarget'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              required:
              - TrainingJobName
              properties:
                TrainingJobName:
                  type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrainingJob'
              examples:
                DescribeTrainingJob200Example:
                  summary: Default DescribeTrainingJob 200 response
                  x-microcks-default: true
                  value:
                    Status: Success
                    RequestId: abc12345-def6-7890-ghij-klmnopqrstuv
                    RoleArn: arn:aws:iam::123456789012:role/SageMakerRole
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /#ListTrainingJobs:
    post:
      operationId: ListTrainingJobs
      summary: Amazon SageMaker List Training Jobs
      description: Lists training jobs.
      tags:
      - Training Jobs
      parameters:
      - $ref: '#/components/parameters/XAmzTarget'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              properties:
                MaxResults:
                  type: integer
                NextToken:
                  type: string
                SortBy:
                  type: string
                  enum:
                  - Name
                  - CreationTime
                  - Status
                SortOrder:
                  type: string
                  enum:
                  - Ascending
                  - Descending
                StatusEquals:
                  type: string
                  enum:
                  - InProgress
                  - Completed
                  - Failed
                  - Stopping
                  - Stopped
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  TrainingJobSummaries:
                    type: array
                    items:
                      $ref: '#/components/schemas/TrainingJob'
                  NextToken:
                    type: string
              examples:
                ListTrainingJobs200Example:
                  summary: Default ListTrainingJobs 200 response
                  x-microcks-default: true
                  value:
                    Status: Success
                    RequestId: abc12345-def6-7890-ghij-klmnopqrstuv
                    RoleArn: arn:aws:iam::123456789012:role/SageMakerRole
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    TrainingJob:
      type: object
      properties:
        TrainingJobName:
          type: string
          description: The name of the training job.
        TrainingJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the training job.
        TrainingJobStatus:
          type: string
          description: The status of the training job.
          enum:
          - InProgress
          - Completed
          - Failed
          - Stopping
          - Stopped
        SecondaryStatus:
          type: string
          description: Provides detailed information about the state of the training job.
        AlgorithmSpecification:
          type: object
          properties:
            TrainingImage:
              type: string
            TrainingInputMode:
              type: string
            AlgorithmName:
              type: string
        RoleArn:
          type: string
          description: The ARN of the IAM role.
        InputDataConfig:
          type: array
          items:
            type: object
            properties:
              ChannelName:
                type: string
              DataSource:
                type: object
        OutputDataConfig:
          type: object
          properties:
            S3OutputPath:
              type: string
            KmsKeyId:
              type: string
        ResourceConfig:
          type: object
          properties:
            InstanceType:
              type: string
            InstanceCount:
              type: integer
            VolumeSizeInGB:
              type: integer
        StoppingCondition:
          type: object
          properties:
            MaxRuntimeInSeconds:
              type: integer
            MaxWaitTimeInSeconds:
              type: integer
        HyperParameters:
          type: object
          additionalProperties:
            type: string
        ModelArtifacts:
          type: object
          properties:
            S3ModelArtifacts:
              type: string
        TrainingStartTime:
          type: string
          format: date-time
        TrainingEndTime:
          type: string
          format: date-time
        CreationTime:
          type: string
          format: date-time
        LastModifiedTime:
          type: string
          format: date-time
        BillableTimeInSeconds:
          type: integer
        FailureReason:
          type: string
    Tag:
      type: object
      properties:
        Key:
          type: string
        Value:
          type: string
  parameters:
    XAmzTarget:
      name: X-Amz-Target
      in: header
      required: true
      schema:
        type: string
        example: SageMaker.CreateNotebookInstance
      description: The target action for the request, in the format SageMaker.<operation>.