Amazon SageMaker Sagemaker Ai Workload Config API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Ai Workload Config API
  version: '2017-07-24'
  description: Generated from AWS's published Smithy model for Amazon SageMaker Service. 4 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:
  /#CreateAIWorkloadConfig:
    post:
      operationId: CreateAIWorkloadConfig
      summary: Create AIWorkload Config
      description: Creates a reusable AI workload configuration that defines datasets, data sources, and benchmark tool settings
        for consistent performance testing of generative AI inference deployments on Amazon SageMaker AI.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateAIWorkloadConfigResponse'
        '400':
          description: ResourceInUse; ResourceLimitExceeded
          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.CreateAIWorkloadConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateAIWorkloadConfigRequest'
      tags:
      - Ai Workload Config
  /#DeleteAIWorkloadConfig:
    post:
      operationId: DeleteAIWorkloadConfig
      summary: Delete AIWorkload Config
      description: Deletes the specified AI workload configuration. You cannot delete a configuration that is referenced by
        an active benchmark job.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteAIWorkloadConfigResponse'
        '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.DeleteAIWorkloadConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteAIWorkloadConfigRequest'
      tags:
      - Ai Workload Config
  /#DescribeAIWorkloadConfig:
    post:
      operationId: DescribeAIWorkloadConfig
      summary: Describe AIWorkload Config
      description: Returns details of an AI workload configuration, including the dataset configuration, benchmark tool settings,
        tags, and creation time.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeAIWorkloadConfigResponse'
        '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.DescribeAIWorkloadConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeAIWorkloadConfigRequest'
      tags:
      - Ai Workload Config
  /#ListAIWorkloadConfigs:
    post:
      operationId: ListAIWorkloadConfigs
      summary: List AIWorkload Configs
      description: Returns a list of AI workload configurations in your account. You can filter the results by name 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/ListAIWorkloadConfigsResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListAIWorkloadConfigs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListAIWorkloadConfigsRequest'
      tags:
      - Ai Workload Config
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:
    AIDatasetConfig:
      type: object
      properties:
        InputDataConfig:
          type: array
          items:
            $ref: '#/components/schemas/AIWorkloadInputDataConfig'
          description: An array of input data channel configurations for the workload.
      description: Exactly one member is set.
    AIWorkloadConfigSummary:
      type: object
      properties:
        AIWorkloadConfigName:
          type: string
          description: The name of the AI workload configuration.
        AIWorkloadConfigArn:
          type: string
          description: The Amazon Resource Name (ARN) of the AI workload configuration.
        CreationTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the configuration was created.
      required:
      - AIWorkloadConfigName
      - AIWorkloadConfigArn
      - CreationTime
    AIWorkloadConfigs:
      type: object
      properties:
        WorkloadSpec:
          $ref: '#/components/schemas/WorkloadSpec'
      required:
      - WorkloadSpec
    AIWorkloadDataSource:
      type: object
      properties:
        S3DataSource:
          $ref: '#/components/schemas/AIWorkloadS3DataSource'
    AIWorkloadInputDataConfig:
      type: object
      properties:
        ChannelName:
          type: string
          description: The logical name for the data channel.
        DataSource:
          $ref: '#/components/schemas/AIWorkloadDataSource'
      required:
      - ChannelName
      - DataSource
    AIWorkloadS3DataSource:
      type: object
      properties:
        S3Uri:
          type: string
          description: The Amazon S3 URI of the data.
      required:
      - S3Uri
    CreateAIWorkloadConfigRequest:
      type: object
      properties:
        AIWorkloadConfigName:
          type: string
          description: The name of the AI workload configuration. The name must be unique within your Amazon Web Services
            account in the current Amazon Web Services Region.
        DatasetConfig:
          $ref: '#/components/schemas/AIDatasetConfig'
        AIWorkloadConfigs:
          $ref: '#/components/schemas/AIWorkloadConfigs'
        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. For more information, see Tagging Amazon Web
            Services Resources in the Amazon Web Services General Reference.
      required:
      - AIWorkloadConfigName
    CreateAIWorkloadConfigResponse:
      type: object
      properties:
        AIWorkloadConfigArn:
          type: string
          description: The Amazon Resource Name (ARN) of the created AI workload configuration.
      required:
      - AIWorkloadConfigArn
    DeleteAIWorkloadConfigRequest:
      type: object
      properties:
        AIWorkloadConfigName:
          type: string
          description: The name of the AI workload configuration to delete.
      required:
      - AIWorkloadConfigName
    DeleteAIWorkloadConfigResponse:
      type: object
      properties:
        AIWorkloadConfigArn:
          type: string
          description: The Amazon Resource Name (ARN) of the deleted AI workload configuration.
    DescribeAIWorkloadConfigRequest:
      type: object
      properties:
        AIWorkloadConfigName:
          type: string
          description: The name of the AI workload configuration to describe.
      required:
      - AIWorkloadConfigName
    DescribeAIWorkloadConfigResponse:
      type: object
      properties:
        AIWorkloadConfigName:
          type: string
          description: The name of the AI workload configuration.
        AIWorkloadConfigArn:
          type: string
          description: The Amazon Resource Name (ARN) of the AI workload configuration.
        DatasetConfig:
          $ref: '#/components/schemas/AIDatasetConfig'
        AIWorkloadConfigs:
          $ref: '#/components/schemas/AIWorkloadConfigs'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags associated with the AI workload configuration.
        CreationTime:
          type: string
          format: date-time
          description: A timestamp that indicates when the AI workload configuration was created.
      required:
      - AIWorkloadConfigName
      - AIWorkloadConfigArn
      - CreationTime
    ListAIWorkloadConfigsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of AI workload configurations to return in the response.
        NextToken:
          type: string
          description: If the previous call to ListAIWorkloadConfigs didn't return the full set of configurations, the call
            returns a token for getting the next set of configurations.
        NameContains:
          type: string
          description: A string in the configuration name. This filter returns only configurations whose name contains the
            specified string.
        CreationTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only configurations created after the specified time.
        CreationTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only configurations created before the specified time.
        SortBy:
          type: string
          enum:
          - Name
          - CreationTime
          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.
    ListAIWorkloadConfigsResponse:
      type: object
      properties:
        AIWorkloadConfigs:
          type: array
          items:
            $ref: '#/components/schemas/AIWorkloadConfigSummary'
          description: An array of AIWorkloadConfigSummary objects, one for each AI workload configuration 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 configurations,
            use it in the subsequent request.
      required:
      - AIWorkloadConfigs
    ResourceInUse:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
    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
    WorkloadSpec:
      type: object
      properties:
        Inline:
          type: string
          description: An inline YAML or JSON string that defines benchmark parameters.
      description: Exactly one member is set.
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)