Amazon Bedrock Model Customization API

openapi: 3.1.0
info:
  title: Amazon Bedrock Converse Model Customization API
  description: The Amazon Bedrock management API provides operations for managing foundation models, custom models, model customization jobs, provisioned throughput, and other Bedrock resources.
  version: '2023-04-20'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/support/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://bedrock.{region}.amazonaws.com
  description: Amazon Bedrock Management API
  variables:
    region:
      default: us-east-1
      description: The AWS region
      enum:
      - us-east-1
      - us-west-2
      - eu-west-1
      - ap-southeast-1
tags:
- name: Model Customization
  description: Operations for creating and managing model customization jobs.
paths:
  /model-customization-jobs:
    post:
      operationId: CreateModelCustomizationJob
      summary: Amazon Bedrock Create a model customization job
      description: Creates a fine-tuning job to customize a foundation model. You provide training data, a base model, and output configuration to produce a custom model tailored to your use case.
      tags:
      - Model Customization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateModelCustomizationJobRequest'
      responses:
        '201':
          description: Job created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateModelCustomizationJobResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '409':
          description: Resource already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
    get:
      operationId: ListModelCustomizationJobs
      summary: Amazon Bedrock List model customization jobs
      description: Returns a list of model customization jobs that you have submitted.
      tags:
      - Model Customization
      parameters:
      - name: maxResults
        in: query
        description: Maximum number of results to return.
        schema:
          type: integer
          minimum: 1
          maximum: 100
      - name: nextToken
        in: query
        description: Token for pagination.
        schema:
          type: string
      - name: statusEquals
        in: query
        description: Filter by job status.
        schema:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Stopping
          - Stopped
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListModelCustomizationJobsResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
  /model-customization-jobs/{jobIdentifier}:
    get:
      operationId: GetModelCustomizationJob
      summary: Amazon Bedrock Get model customization job details
      description: Retrieves the properties associated with a model customization job, including the status, creation time, and training metrics.
      tags:
      - Model Customization
      parameters:
      - name: jobIdentifier
        in: path
        required: true
        description: The identifier of the customization job.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetModelCustomizationJobResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
components:
  schemas:
    ConflictException:
      type: object
      properties:
        message:
          type: string
    GetModelCustomizationJobResponse:
      type: object
      properties:
        jobArn:
          type: string
        jobName:
          type: string
        status:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Stopping
          - Stopped
        baseModelArn:
          type: string
        customModelName:
          type: string
        customModelArn:
          type: string
        creationTime:
          type: string
          format: date-time
        lastModifiedTime:
          type: string
          format: date-time
    CreateModelCustomizationJobRequest:
      type: object
      required:
      - jobName
      - customModelName
      - roleArn
      - baseModelIdentifier
      - trainingDataConfig
      - outputDataConfig
      properties:
        jobName:
          type: string
          description: A name for the customization job.
        customModelName:
          type: string
          description: A name for the resulting custom model.
        roleArn:
          type: string
          description: The ARN of the IAM role for the job.
        baseModelIdentifier:
          type: string
          description: The identifier of the base model to customize.
        customizationType:
          type: string
          enum:
          - FINE_TUNING
          - CONTINUED_PRE_TRAINING
          description: The customization type.
        trainingDataConfig:
          type: object
          properties:
            s3Uri:
              type: string
              description: The S3 URI of the training data.
        outputDataConfig:
          type: object
          properties:
            s3Uri:
              type: string
              description: The S3 URI for output data.
        hyperParameters:
          type: object
          additionalProperties:
            type: string
          description: Hyperparameters for the customization job.
    CreateModelCustomizationJobResponse:
      type: object
      properties:
        jobArn:
          type: string
          description: The ARN of the customization job.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ValidationException:
      type: object
      properties:
        message:
          type: string
    ListModelCustomizationJobsResponse:
      type: object
      properties:
        modelCustomizationJobSummaries:
          type: array
          items:
            type: object
            properties:
              jobArn:
                type: string
              jobName:
                type: string
              status:
                type: string
              baseModelArn:
                type: string
              creationTime:
                type: string
                format: date-time
        nextToken:
          type: string