Amazon SageMaker Sagemaker Job API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Job 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:
  /#CreateJob:
    post:
      operationId: CreateJob
      summary: Create Job
      description: 'Creates a model customization job in Amazon SageMaker. A job runs a workload based on the job category
        and configuration you provide. You specify the job category, a schema-versioned configuration document, and an IAM
        role that grants Amazon SageMaker permission to access resources on your behalf. Use the AgentRFT category to fine-tune
        a model using multi-turn reinforcement learning with reward signals. Use the AgentRFTEvaluation category to evaluate
        a fine-tuned or base model by running multi-turn rollouts against a held-out prompt dataset and computing metrics
        such as pass@k and mean reward. Before creating a job, call ListJobSchemaVersions and DescribeJobSchemaVersion to
        retrieve the configuration schema for your job category. The JobConfigDocument must conform to the schema specified
        by JobConfigSchemaVersion. The following operations are related to CreateJob: DescribeJob ListJobs StopJob DeleteJob
        ListJobSchemaVersions DescribeJobSchemaVersion'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateJobResponse'
        '400':
          description: ResourceInUse; ResourceLimitExceeded; ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceInUse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.CreateJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateJobRequest'
      tags:
      - Job
  /#DeleteJob:
    post:
      operationId: DeleteJob
      summary: Delete Job
      description: 'Deletes a job. This operation is idempotent. If the job is currently running, you must stop it before
        deleting it by calling StopJob. The following operations are related to DeleteJob: CreateJob StopJob DescribeJob'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteJobResponse'
        '400':
          description: ResourceInUse; ResourceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceInUse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DeleteJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteJobRequest'
      tags:
      - Job
  /#DescribeJob:
    post:
      operationId: DescribeJob
      summary: Describe Job
      description: 'Returns detailed information about a job, including its current status, secondary status, configuration,
        and timestamps. Use SecondaryStatus for granular progress tracking and SecondaryStatusTransitions to see the full
        history of status changes with timestamps. The following operations are related to DescribeJob: CreateJob ListJobs
        StopJob DeleteJob'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeJobResponse'
        '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.DescribeJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeJobRequest'
      tags:
      - Job
  /#ListJobs:
    post:
      operationId: ListJobs
      summary: List Jobs
      description: 'Lists jobs in a specified category. You can filter results by creation time, last modified time, name,
        and status. Results are sorted by the field you specify in SortBy. Use pagination to retrieve large result sets efficiently.
        The following operations are related to ListJobs: CreateJob DescribeJob'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListJobsResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListJobs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListJobsRequest'
      tags:
      - Job
  /#StopJob:
    post:
      operationId: StopJob
      summary: Stop Job
      description: 'Stops a running job. When you call StopJob, Amazon SageMaker sets the job status to Stopping. After the
        job stops, the status changes to Stopped. Partial results may be available in the output location if the job was in
        progress. To delete a stopped job, call DeleteJob. The following operations are related to StopJob: CreateJob DescribeJob
        DeleteJob'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopJobResponse'
        '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.StopJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopJobRequest'
      tags:
      - Job
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:
    CreateJobRequest:
      type: object
      properties:
        JobName:
          type: string
          description: The name of the job. The name must be unique within your account and Amazon Web Services Region.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the job. The
            role must have the necessary permissions to access the resources required by the job configuration.
        JobCategory:
          type: string
          enum:
          - AgentRFT
          - AgentRFTEvaluation
          description: The category of the job. The category determines the type of workload that the job runs.
        JobConfigSchemaVersion:
          type: string
          description: The version of the configuration schema to use for the job configuration document. Use ListJobSchemaVersions
            to get available schema versions for a job category.
        JobConfigDocument:
          type: string
          description: The JSON configuration document for the job. The document must conform to the schema specified by JobConfigSchemaVersion.
            Use DescribeJobSchemaVersion to retrieve the schema for validation.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: An array of key-value pairs to apply to the job as tags. For more information, see Tagging Amazon Web
            Services Resources.
      required:
      - JobName
      - RoleArn
      - JobCategory
      - JobConfigSchemaVersion
      - JobConfigDocument
    CreateJobResponse:
      type: object
      properties:
        JobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the job.
      required:
      - JobArn
    DeleteJobRequest:
      type: object
      properties:
        JobName:
          type: string
          description: The name of the job to delete.
        JobCategory:
          type: string
          enum:
          - AgentRFT
          - AgentRFTEvaluation
          description: The category of the job to delete.
      required:
      - JobName
      - JobCategory
    DeleteJobResponse:
      type: object
      properties: {}
    DescribeJobRequest:
      type: object
      properties:
        JobName:
          type: string
          description: The name of the job to describe.
        JobCategory:
          type: string
          enum:
          - AgentRFT
          - AgentRFTEvaluation
          description: The category of the job.
      required:
      - JobName
      - JobCategory
    DescribeJobResponse:
      type: object
      properties:
        JobName:
          type: string
          description: The name of the job.
        JobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the job.
        RoleArn:
          type: string
          description: The ARN of the IAM role associated with the job.
        JobCategory:
          type: string
          enum:
          - AgentRFT
          - AgentRFTEvaluation
          description: The category of the job.
        JobConfigSchemaVersion:
          type: string
          description: The schema version used for the job configuration document.
        JobConfigDocument:
          type: string
          description: The JSON configuration document for the job.
        CreationTime:
          type: string
          format: date-time
          description: The date and time that the job was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The date and time that the job was last modified.
        EndTime:
          type: string
          format: date-time
          description: The date and time that the job ended.
        JobStatus:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Stopping
          - Stopped
          - Deleting
          - DeleteFailed
          description: The current status of the job.
        SecondaryStatus:
          type: string
          enum:
          - Starting
          - Downloading
          - Training
          - Uploading
          - Stopping
          - Stopped
          - MaxRuntimeExceeded
          - Interrupted
          - Failed
          - Completed
          - Restarting
          - Pending
          - Evaluating
          - Deleting
          - DeleteFailed
          description: The detailed secondary status of the job, providing more granular information about the job's progress.
            Secondary statuses may change between releases.
        SecondaryStatusTransitions:
          type: array
          items:
            $ref: '#/components/schemas/JobSecondaryStatusTransition'
          description: A list of secondary status transitions for the job, with timestamps and optional status messages.
        FailureReason:
          type: string
          description: If the job failed, the reason it failed.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags associated with the job.
      required:
      - JobName
      - JobArn
      - RoleArn
      - JobCategory
      - JobConfigSchemaVersion
      - CreationTime
      - LastModifiedTime
      - JobStatus
      - SecondaryStatus
      - SecondaryStatusTransitions
    JobSecondaryStatusTransition:
      type: object
      properties:
        Status:
          type: string
          enum:
          - Starting
          - Downloading
          - Training
          - Uploading
          - Stopping
          - Stopped
          - MaxRuntimeExceeded
          - Interrupted
          - Failed
          - Completed
          - Restarting
          - Pending
          - Evaluating
          - Deleting
          - DeleteFailed
          description: The secondary status of the job at this transition point.
        StartTime:
          type: string
          format: date-time
          description: The date and time that the status transition started.
        EndTime:
          type: string
          format: date-time
          description: The date and time that the status transition ended.
        StatusMessage:
          type: string
          description: A detailed message about the status transition.
      required:
      - Status
      - StartTime
    JobSummary:
      type: object
      properties:
        JobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the job.
        JobName:
          type: string
          description: The name of the job.
        JobCategory:
          type: string
          enum:
          - AgentRFT
          - AgentRFTEvaluation
          description: The category of the job.
        JobStatus:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Stopping
          - Stopped
          - Deleting
          - DeleteFailed
          description: The current status of the job.
        JobSecondaryStatus:
          type: string
          enum:
          - Starting
          - Downloading
          - Training
          - Uploading
          - Stopping
          - Stopped
          - MaxRuntimeExceeded
          - Interrupted
          - Failed
          - Completed
          - Restarting
          - Pending
          - Evaluating
          - Deleting
          - DeleteFailed
          description: The secondary status of the job, providing more granular information about the job's progress. Secondary
            statuses may change between releases.
        CreationTime:
          type: string
          format: date-time
          description: The date and time that the job was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The date and time that the job was last modified.
        EndTime:
          type: string
          format: date-time
          description: The date and time that the job ended.
      required:
      - JobArn
      - JobName
      - JobCategory
      - JobStatus
      - JobSecondaryStatus
      - CreationTime
      - LastModifiedTime
    ListJobsRequest:
      type: object
      properties:
        JobCategory:
          type: string
          enum:
          - AgentRFT
          - AgentRFTEvaluation
          description: The category of jobs to list.
        NextToken:
          type: string
          description: If the previous response was truncated, this token retrieves the next set of results.
        MaxResults:
          type: integer
          description: The maximum number of jobs to return in the response. The default value is 50.
        CreationTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only jobs created after the specified time.
        CreationTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only jobs created before the specified time.
        LastModifiedTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only jobs modified after the specified time.
        LastModifiedTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only jobs modified before the specified time.
        NameContains:
          type: string
          description: A string in the job name to filter results. Only jobs whose name contains the specified string are
            returned.
        SortBy:
          type: string
          enum:
          - Name
          - CreationTime
          - Status
          description: The field to sort results by.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: The sort order for results. Valid values are Ascending and Descending.
        StatusEquals:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Stopping
          - Stopped
          - Deleting
          - DeleteFailed
          description: A filter that returns only jobs with the specified status.
      required:
      - JobCategory
    ListJobsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: If the response is truncated, this token retrieves the next set of results.
        JobSummaries:
          type: array
          items:
            $ref: '#/components/schemas/JobSummary'
          description: An array of JobSummary objects that provide summary information about the jobs.
      required:
      - JobSummaries
    ResourceInUse:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
    StopJobRequest:
      type: object
      properties:
        JobName:
          type: string
          description: The name of the job to stop.
        JobCategory:
          type: string
          enum:
          - AgentRFT
          - AgentRFTEvaluation
          description: The category of the job to stop.
      required:
      - JobName
      - JobCategory
    StopJobResponse:
      type: object
      properties: {}
    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
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)