Amazon SageMaker Sagemaker Ai Benchmark Job API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Ai Benchmark 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:
  /#CreateAIBenchmarkJob:
    post:
      operationId: CreateAIBenchmarkJob
      summary: Create AIBenchmark Job
      description: Creates a benchmark job that runs performance benchmarks against inference infrastructure using a predefined
        AI workload configuration. The benchmark job measures metrics such as latency, throughput, and cost for your generative
        AI inference endpoints.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateAIBenchmarkJobResponse'
        '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.CreateAIBenchmarkJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateAIBenchmarkJobRequest'
      tags:
      - Ai Benchmark Job
  /#DeleteAIBenchmarkJob:
    post:
      operationId: DeleteAIBenchmarkJob
      summary: Delete AIBenchmark Job
      description: Deletes the specified AI benchmark job.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteAIBenchmarkJobResponse'
        '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.DeleteAIBenchmarkJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteAIBenchmarkJobRequest'
      tags:
      - Ai Benchmark Job
  /#DescribeAIBenchmarkJob:
    post:
      operationId: DescribeAIBenchmarkJob
      summary: Describe AIBenchmark Job
      description: Returns details of an AI benchmark job, including its status, configuration, target endpoint, and timing
        information.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeAIBenchmarkJobResponse'
        '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.DescribeAIBenchmarkJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeAIBenchmarkJobRequest'
      tags:
      - Ai Benchmark Job
  /#ListAIBenchmarkJobs:
    post:
      operationId: ListAIBenchmarkJobs
      summary: List AIBenchmark Jobs
      description: Returns a list of AI benchmark jobs in your account. You can filter the results by name, status, and creation
        time, and sort the results. The response is paginated.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListAIBenchmarkJobsResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListAIBenchmarkJobs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListAIBenchmarkJobsRequest'
      tags:
      - Ai Benchmark Job
  /#StopAIBenchmarkJob:
    post:
      operationId: StopAIBenchmarkJob
      summary: Stop AIBenchmark Job
      description: Stops a running AI benchmark job.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopAIBenchmarkJobResponse'
        '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.StopAIBenchmarkJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopAIBenchmarkJobRequest'
      tags:
      - Ai Benchmark 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:
    AIBenchmarkEndpoint:
      type: object
      properties:
        Identifier:
          type: string
          description: The name or Amazon Resource Name (ARN) of the SageMaker endpoint to benchmark.
        TargetContainerHostname:
          type: string
          description: The hostname of the specific container to target within a multi-container endpoint.
        InferenceComponents:
          type: array
          items:
            $ref: '#/components/schemas/AIBenchmarkInferenceComponent'
          description: The list of inference components to benchmark on the endpoint.
      required:
      - Identifier
    AIBenchmarkInferenceComponent:
      type: object
      properties:
        Identifier:
          type: string
          description: The name or Amazon Resource Name (ARN) of the inference component.
      required:
      - Identifier
    AIBenchmarkJobSummary:
      type: object
      properties:
        AIBenchmarkJobName:
          type: string
          description: The name of the benchmark job.
        AIBenchmarkJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the benchmark job.
        AIBenchmarkJobStatus:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Stopping
          - Stopped
          description: The status of the benchmark job.
        CreationTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the benchmark job was created.
        EndTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the benchmark job completed.
        AIWorkloadConfigName:
          type: string
          description: The name of the AI workload configuration used by the benchmark job.
      required:
      - AIBenchmarkJobName
      - AIBenchmarkJobArn
      - AIBenchmarkJobStatus
      - CreationTime
    AIBenchmarkNetworkConfig:
      type: object
      properties:
        VpcConfig:
          $ref: '#/components/schemas/VpcConfig'
    AIBenchmarkOutputConfig:
      type: object
      properties:
        S3OutputLocation:
          type: string
          description: The Amazon S3 URI where benchmark results are stored.
        MlflowConfig:
          $ref: '#/components/schemas/AIMlflowConfig'
      required:
      - S3OutputLocation
    AIBenchmarkOutputResult:
      type: object
      properties:
        S3OutputLocation:
          type: string
          description: The Amazon S3 URI where benchmark results are stored.
        CloudWatchLogs:
          type: array
          items:
            $ref: '#/components/schemas/AICloudWatchLogs'
          description: The CloudWatch log information for the benchmark job.
        MlflowConfig:
          $ref: '#/components/schemas/AIMlflowConfig'
      required:
      - S3OutputLocation
    AIBenchmarkTarget:
      type: object
      properties:
        Endpoint:
          $ref: '#/components/schemas/AIBenchmarkEndpoint'
      description: Exactly one member is set.
    AICloudWatchLogs:
      type: object
      properties:
        LogGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the CloudWatch log group.
        LogStreamName:
          type: string
          description: The name of the CloudWatch log stream.
    AIMlflowConfig:
      type: object
      properties:
        MlflowResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the SageMaker managed MLflow resource.
        MlflowExperimentName:
          type: string
          description: The MLflow experiment name used for tracking.
        MlflowRunName:
          type: string
          description: The MLflow run name used for tracking.
      required:
      - MlflowResourceArn
    CreateAIBenchmarkJobRequest:
      type: object
      properties:
        AIBenchmarkJobName:
          type: string
          description: The name of the AI benchmark job. The name must be unique within your Amazon Web Services account in
            the current Amazon Web Services Region.
        BenchmarkTarget:
          $ref: '#/components/schemas/AIBenchmarkTarget'
        OutputConfig:
          $ref: '#/components/schemas/AIBenchmarkOutputConfig'
        AIWorkloadConfigIdentifier:
          type: string
          description: The name or Amazon Resource Name (ARN) of the AI workload configuration to use for this benchmark job.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on
            your behalf.
        NetworkConfig:
          $ref: '#/components/schemas/AIBenchmarkNetworkConfig'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.
            Each tag consists of a key and a value, both of which you define.
      required:
      - AIBenchmarkJobName
      - BenchmarkTarget
      - OutputConfig
      - AIWorkloadConfigIdentifier
      - RoleArn
    CreateAIBenchmarkJobResponse:
      type: object
      properties:
        AIBenchmarkJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the created benchmark job.
      required:
      - AIBenchmarkJobArn
    DeleteAIBenchmarkJobRequest:
      type: object
      properties:
        AIBenchmarkJobName:
          type: string
          description: The name of the AI benchmark job to delete.
      required:
      - AIBenchmarkJobName
    DeleteAIBenchmarkJobResponse:
      type: object
      properties:
        AIBenchmarkJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the deleted benchmark job.
    DescribeAIBenchmarkJobRequest:
      type: object
      properties:
        AIBenchmarkJobName:
          type: string
          description: The name of the AI benchmark job to describe.
      required:
      - AIBenchmarkJobName
    DescribeAIBenchmarkJobResponse:
      type: object
      properties:
        AIBenchmarkJobName:
          type: string
          description: The name of the AI benchmark job.
        AIBenchmarkJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the AI benchmark job.
        AIBenchmarkJobStatus:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Stopping
          - Stopped
          description: The status of the AI benchmark job.
        FailureReason:
          type: string
          description: If the benchmark job failed, the reason it failed.
        BenchmarkTarget:
          $ref: '#/components/schemas/AIBenchmarkTarget'
        OutputConfig:
          $ref: '#/components/schemas/AIBenchmarkOutputResult'
        AIWorkloadConfigIdentifier:
          type: string
          description: The name or Amazon Resource Name (ARN) of the AI workload configuration used for this benchmark job.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role used by the benchmark job.
        NetworkConfig:
          $ref: '#/components/schemas/AIBenchmarkNetworkConfig'
        CreationTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the benchmark job was created.
        StartTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the benchmark job started running.
        EndTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the benchmark job completed.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags associated with the benchmark job.
      required:
      - AIBenchmarkJobName
      - AIBenchmarkJobArn
      - AIBenchmarkJobStatus
      - BenchmarkTarget
      - OutputConfig
      - AIWorkloadConfigIdentifier
      - RoleArn
      - CreationTime
    ListAIBenchmarkJobsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of benchmark jobs to return in the response.
        NextToken:
          type: string
          description: If the previous call to ListAIBenchmarkJobs didn't return the full set of jobs, the call returns a
            token for getting the next set.
        NameContains:
          type: string
          description: A string in the job name. This filter returns only jobs whose name contains the specified string.
        StatusEquals:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Stopping
          - Stopped
          description: A filter that returns only benchmark jobs with the specified status.
        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.
        SortBy:
          type: string
          enum:
          - Name
          - CreationTime
          - Status
          description: The field to sort results by. The default is CreationTime.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: The sort order for results. The default is Descending.
    ListAIBenchmarkJobsResponse:
      type: object
      properties:
        AIBenchmarkJobs:
          type: array
          items:
            $ref: '#/components/schemas/AIBenchmarkJobSummary'
          description: An array of AIBenchmarkJobSummary objects, one for each benchmark job that matches the specified filters.
        NextToken:
          type: string
          description: If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of jobs,
            use it in the subsequent request.
      required:
      - AIBenchmarkJobs
    ResourceInUse:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
    StopAIBenchmarkJobRequest:
      type: object
      properties:
        AIBenchmarkJobName:
          type: string
          description: The name of the AI benchmark job to stop.
      required:
      - AIBenchmarkJobName
    StopAIBenchmarkJobResponse:
      type: object
      properties:
        AIBenchmarkJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the stopped benchmark job.
      required:
      - AIBenchmarkJobArn
    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
    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)