Amazon SageMaker Sagemaker Training Session API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Training Session 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:
  /#CreateTrainingSession:
    post:
      operationId: CreateTrainingSession
      summary: Create Training Session
      description: 'Creates a training session in Amazon SageMaker. A training session provisions compute resources for fine-tuning
        a foundation model using Low-Rank Adaptation (LoRA). After the session is created, you can submit training operations
        and sample inference requests through the Amazon SageMaker Training Session Runtime API. The following operations
        are related to CreateTrainingSession: DescribeTrainingSession ListTrainingSessions StopTrainingSession DeleteTrainingSession'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateTrainingSessionResponse'
        '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.CreateTrainingSession
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateTrainingSessionRequest'
      tags:
      - Training Session
  /#DeleteTrainingSession:
    post:
      operationId: DeleteTrainingSession
      summary: Delete Training Session
      description: 'Deletes a training session. You must stop a running session before deleting it. Use the StopTrainingSession
        operation to stop the session first. The following operations are related to DeleteTrainingSession: CreateTrainingSession
        DescribeTrainingSession StopTrainingSession'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteTrainingSessionResponse'
        '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.DeleteTrainingSession
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteTrainingSessionRequest'
      tags:
      - Training Session
  /#DescribeTrainingSession:
    post:
      operationId: DescribeTrainingSession
      summary: Describe Training Session
      description: 'Retrieves detailed information about a training session, including its current status, model configuration,
        Low-Rank Adaptation (LoRA) parameters, and timestamps. The following operations are related to DescribeTrainingSession:
        CreateTrainingSession ListTrainingSessions StopTrainingSession DeleteTrainingSession'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeTrainingSessionResponse'
        '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.DescribeTrainingSession
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeTrainingSessionRequest'
      tags:
      - Training Session
  /#ListTrainingSessions:
    post:
      operationId: ListTrainingSessions
      summary: List Training Sessions
      description: 'Lists training sessions in your account. You can filter results by creation time, name, and status. The
        operation paginates results. To retrieve additional results, use the NextToken parameter. The following operations
        are related to ListTrainingSessions: CreateTrainingSession DescribeTrainingSession'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListTrainingSessionsResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListTrainingSessions
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListTrainingSessionsRequest'
      tags:
      - Training Session
  /#StopTrainingSession:
    post:
      operationId: StopTrainingSession
      summary: Stop Training Session
      description: 'Stops a running training session and sets the session status to Stopping. After the session stops, the
        status changes to Stopped. To delete a stopped session, use the DeleteTrainingSession operation. The following operations
        are related to StopTrainingSession: CreateTrainingSession DescribeTrainingSession DeleteTrainingSession'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopTrainingSessionResponse'
        '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.StopTrainingSession
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopTrainingSessionRequest'
      tags:
      - Training Session
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:
    BillableTokenUsage:
      type: object
      properties:
        PrefillTokenCount:
          type: integer
          description: The number of prefill tokens consumed.
        SampleTokenCount:
          type: integer
          description: The number of sample tokens consumed.
        TrainingTokenCount:
          type: integer
          description: The number of training tokens consumed.
    CreateTrainingSessionRequest:
      type: object
      properties:
        TrainingSessionName:
          type: string
          description: The name of the training session.
        ModelPackageGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model package group where checkpoints and fine-tuned model artifacts
            are published.
        LoraConfig:
          $ref: '#/components/schemas/LoraConfig'
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to access resources on
            your behalf. The role must have permissions to access the output S3 path and model package group.
        VpcConfig:
          $ref: '#/components/schemas/VpcConfig'
        ModelConfig:
          $ref: '#/components/schemas/TrainingSessionModelConfig'
        OutputConfig:
          $ref: '#/components/schemas/TrainingSessionOutputConfig'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: An array of key-value pairs to apply to the training session as tags. For more information, see Tagging
            Amazon Web Services Resources.
      required:
      - TrainingSessionName
      - LoraConfig
      - RoleArn
      - ModelConfig
      - OutputConfig
    CreateTrainingSessionResponse:
      type: object
      properties:
        TrainingSessionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the training session.
      required:
      - TrainingSessionArn
    DeleteTrainingSessionRequest:
      type: object
      properties:
        TrainingSessionName:
          type: string
          description: The name of the training session to delete.
      required:
      - TrainingSessionName
    DeleteTrainingSessionResponse:
      type: object
      properties: {}
    DescribeTrainingSessionRequest:
      type: object
      properties:
        TrainingSessionName:
          type: string
          description: The name of the training session to describe.
      required:
      - TrainingSessionName
    DescribeTrainingSessionResponse:
      type: object
      properties:
        TrainingSessionDetail:
          $ref: '#/components/schemas/TrainingSessionDetail'
      required:
      - TrainingSessionDetail
    ListTrainingSessionsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: If the response was truncated, use the token returned in the previous response to retrieve the next
            page of results.
        MaxResults:
          type: integer
          description: The maximum number of training sessions to return in the response.
        CreationTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only training sessions created after the specified time.
        CreationTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only training sessions created before the specified time.
        NameContains:
          type: string
          description: A string in the training session name to filter results. Only sessions whose name contains the specified
            string are returned.
        StatusEquals:
          type: string
          enum:
          - Created
          - Blocked
          - Running
          - Failed
          - Scheduled
          - Stopping
          - Stopped
          - Expired
          - Deleting
          - DeletionFailed
          description: A filter that returns only training sessions with the specified status.
    ListTrainingSessionsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: If the response is truncated, this token retrieves the next set of results.
        TrainingSessionSummaries:
          type: array
          items:
            $ref: '#/components/schemas/TrainingSessionSummary'
          description: An array of TrainingSessionSummary objects that provide summary information about the training sessions.
    LoraConfig:
      type: object
      properties:
        Rank:
          type: integer
          description: The rank of the Low-Rank Adaptation (LoRA) adapter matrices.
        Alpha:
          type: integer
          description: The Low-Rank Adaptation (LoRA) scaling factor.
      required:
      - Rank
      - Alpha
    ResourceInUse:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
    StopTrainingSessionRequest:
      type: object
      properties:
        TrainingSessionName:
          type: string
          description: The name of the training session to stop.
      required:
      - TrainingSessionName
    StopTrainingSessionResponse:
      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
    TrainingSessionDetail:
      type: object
      properties:
        TrainingSessionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the training session.
        TrainingSessionName:
          type: string
          description: The name of the training session.
        TrainingSessionStatus:
          type: string
          enum:
          - Created
          - Blocked
          - Running
          - Failed
          - Scheduled
          - Stopping
          - Stopped
          - Expired
          - Deleting
          - DeletionFailed
          description: The current status of the training session.
        ModelPackageGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model package group where checkpoints are published.
        CreationTime:
          type: string
          format: date-time
          description: The date and time that the training session was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The date and time that the training session was last modified.
        EndTime:
          type: string
          format: date-time
          description: The date and time that the training session ended.
        ErrorDetails:
          type: string
          description: If the training session failed or is blocked, detailed error information.
        LastReceivedSequenceNumber:
          type: integer
          description: The sequence number of the last training operation received by the session.
        BillableTokenUsage:
          $ref: '#/components/schemas/BillableTokenUsage'
        VpcConfig:
          $ref: '#/components/schemas/VpcConfig'
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role associated with the training session.
        LoraConfig:
          $ref: '#/components/schemas/LoraConfig'
        ModelConfig:
          $ref: '#/components/schemas/TrainingSessionModelConfig'
        OutputConfig:
          $ref: '#/components/schemas/TrainingSessionOutputConfig'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags associated with the training session.
      required:
      - TrainingSessionArn
      - TrainingSessionName
      - TrainingSessionStatus
      - CreationTime
    TrainingSessionModelConfig:
      type: object
      properties:
        BaseModelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the base foundation model from SageMaker Hub.
        AcceptEula:
          type: boolean
          description: Specifies whether you accept the end-user license agreement (EULA) for gated models.
      required:
      - BaseModelArn
    TrainingSessionOutputConfig:
      type: object
      properties:
        S3Location:
          $ref: '#/components/schemas/TrainingSessionS3Location'
      required:
      - S3Location
    TrainingSessionS3Location:
      type: object
      properties:
        Path:
          type: string
          description: The Amazon S3 path where training session outputs are stored.
        KmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the KMS key used to encrypt output data. If not specified, the default
            Amazon S3 encryption is used.
      required:
      - Path
    TrainingSessionSummary:
      type: object
      properties:
        TrainingSessionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the training session.
        TrainingSessionStatus:
          type: string
          enum:
          - Created
          - Blocked
          - Running
          - Failed
          - Scheduled
          - Stopping
          - Stopped
          - Expired
          - Deleting
          - DeletionFailed
          description: The current status of the training session.
        CreationTime:
          type: string
          format: date-time
          description: The date and time that the training session was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The date and time that the training session was last modified.
      required:
      - TrainingSessionArn
      - TrainingSessionStatus
      - CreationTime
    VpcConfig:
      type: object
      properties:
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is
            specified in the Subnets field.
        Subnets:
          type: array
          items:
            type: string
          description: The ID of the subnets in the VPC to which you want to connect your training job or model. For information
            about the availability of specific instance types, see Supported Instance Types and Availability Zones.
      required:
      - SecurityGroupIds
      - Subnets
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)