Amazon SageMaker

Amazon SageMaker Sagemaker Image Version API

The Sagemaker Image Version API from Amazon SageMaker — 5 operation(s) for sagemaker image version.

GitHub OpenAPI

Operations 5

POST /#CreateImageVersion Create Image Version #
POST /#DeleteImageVersion Delete Image Version #
POST /#DescribeImageVersion Describe Image Version #
POST /#ListImageVersions List Image Versions #
POST /#UpdateImageVersion Update Image Version #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-sagemaker/openapi/amazon-sagemaker-image-version-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-sagemaker:amazon-sagemaker-image-version-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-sagemaker-image-version-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Amazon SageMaker Service Image Version 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:
  /#CreateImageVersion:
    post:
      operationId: CreateImageVersion
      summary: Create Image Version
      description: Creates a version of the SageMaker AI image specified by ImageName. The version represents the Amazon ECR
        container image specified by BaseImage.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateImageVersionResponse'
        '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.CreateImageVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateImageVersionRequest'
      tags:
      - Image Version
  /#DeleteImageVersion:
    post:
      operationId: DeleteImageVersion
      summary: Delete Image Version
      description: Deletes a version of a SageMaker AI image. The container image the version represents isn't deleted.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteImageVersionResponse'
        '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.DeleteImageVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteImageVersionRequest'
      tags:
      - Image Version
  /#DescribeImageVersion:
    post:
      operationId: DescribeImageVersion
      summary: Describe Image Version
      description: Describes a version of a SageMaker AI image.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeImageVersionResponse'
        '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.DescribeImageVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeImageVersionRequest'
      tags:
      - Image Version
  /#ListImageVersions:
    post:
      operationId: ListImageVersions
      summary: List Image Versions
      description: Lists the versions of a specified image and their properties. The list can be filtered by creation time
        or modified time.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListImageVersionsResponse'
        '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.ListImageVersions
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListImageVersionsRequest'
      tags:
      - Image Version
  /#UpdateImageVersion:
    post:
      operationId: UpdateImageVersion
      summary: Update Image Version
      description: Updates the properties of a SageMaker AI image version.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateImageVersionResponse'
        '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.UpdateImageVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateImageVersionRequest'
      tags:
      - Image Version
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:
    CreateImageVersionRequest:
      type: object
      properties:
        BaseImage:
          type: string
          description: 'The registry path of the container image to use as the starting point for this version. The path is
            an Amazon ECR URI in the following format: <acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag]
            or [@digest]>'
        ClientToken:
          type: string
          description: A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the
            SDK for Python (Boto3), add a unique value to the call.
        ImageName:
          type: string
          description: The ImageName of the Image to create a version of.
        Aliases:
          type: array
          items:
            type: string
          description: A list of aliases created with the image version.
        VendorGuidance:
          type: string
          enum:
          - NOT_PROVIDED
          - STABLE
          - TO_BE_ARCHIVED
          - ARCHIVED
          description: 'The stability of the image version, specified by the maintainer. NOT_PROVIDED: The maintainers did
            not provide a status for image version stability. STABLE: The image version is stable. TO_BE_ARCHIVED: The image
            version is set to be archived. Custom image versions that are set to be archived are automatically archived after
            three months. ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer
            actively supported.'
        JobType:
          type: string
          enum:
          - TRAINING
          - INFERENCE
          - NOTEBOOK_KERNEL
          description: 'Indicates SageMaker AI job type compatibility. TRAINING: The image version is compatible with SageMaker
            AI training jobs. INFERENCE: The image version is compatible with SageMaker AI inference jobs. NOTEBOOK_KERNEL:
            The image version is compatible with SageMaker AI notebook kernels.'
        MLFramework:
          type: string
          description: The machine learning framework vended in the image version.
        ProgrammingLang:
          type: string
          description: The supported programming language and its version.
        Processor:
          type: string
          enum:
          - CPU
          - GPU
          description: 'Indicates CPU or GPU compatibility. CPU: The image version is compatible with CPU. GPU: The image
            version is compatible with GPU.'
        Horovod:
          type: boolean
          description: Indicates Horovod compatibility.
        ReleaseNotes:
          type: string
          description: The maintainer description of the image version.
      required:
      - BaseImage
      - ClientToken
      - ImageName
    CreateImageVersionResponse:
      type: object
      properties:
        ImageVersionArn:
          type: string
          description: The ARN of the image version.
    DeleteImageVersionRequest:
      type: object
      properties:
        ImageName:
          type: string
          description: The name of the image to delete.
        Version:
          type: integer
          description: The version to delete.
        Alias:
          type: string
          description: The alias of the image to delete.
      required:
      - ImageName
    DeleteImageVersionResponse:
      type: object
      properties: {}
    DescribeImageVersionRequest:
      type: object
      properties:
        ImageName:
          type: string
          description: The name of the image.
        Version:
          type: integer
          description: The version of the image. If not specified, the latest version is described.
        Alias:
          type: string
          description: The alias of the image version.
      required:
      - ImageName
    DescribeImageVersionResponse:
      type: object
      properties:
        BaseImage:
          type: string
          description: The registry path of the container image on which this image version is based.
        ContainerImage:
          type: string
          description: The registry path of the container image that contains this image version.
        CreationTime:
          type: string
          format: date-time
          description: When the version was created.
        FailureReason:
          type: string
          description: When a create or delete operation fails, the reason for the failure.
        ImageArn:
          type: string
          description: The ARN of the image the version is based on.
        ImageVersionArn:
          type: string
          description: The ARN of the version.
        ImageVersionStatus:
          type: string
          enum:
          - CREATING
          - CREATED
          - CREATE_FAILED
          - DELETING
          - DELETE_FAILED
          description: The status of the version.
        LastModifiedTime:
          type: string
          format: date-time
          description: When the version was last modified.
        Version:
          type: integer
          description: The version number.
        VendorGuidance:
          type: string
          enum:
          - NOT_PROVIDED
          - STABLE
          - TO_BE_ARCHIVED
          - ARCHIVED
          description: 'The stability of the image version specified by the maintainer. NOT_PROVIDED: The maintainers did
            not provide a status for image version stability. STABLE: The image version is stable. TO_BE_ARCHIVED: The image
            version is set to be archived. Custom image versions that are set to be archived are automatically archived after
            three months. ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer
            actively supported.'
        JobType:
          type: string
          enum:
          - TRAINING
          - INFERENCE
          - NOTEBOOK_KERNEL
          description: 'Indicates SageMaker AI job type compatibility. TRAINING: The image version is compatible with SageMaker
            AI training jobs. INFERENCE: The image version is compatible with SageMaker AI inference jobs. NOTEBOOK_KERNEL:
            The image version is compatible with SageMaker AI notebook kernels.'
        MLFramework:
          type: string
          description: The machine learning framework vended in the image version.
        ProgrammingLang:
          type: string
          description: The supported programming language and its version.
        Processor:
          type: string
          enum:
          - CPU
          - GPU
          description: 'Indicates CPU or GPU compatibility. CPU: The image version is compatible with CPU. GPU: The image
            version is compatible with GPU.'
        Horovod:
          type: boolean
          description: Indicates Horovod compatibility.
        ReleaseNotes:
          type: string
          description: The maintainer description of the image version.
    ImageVersion:
      type: object
      properties:
        CreationTime:
          type: string
          format: date-time
          description: When the version was created.
        FailureReason:
          type: string
          description: When a create or delete operation fails, the reason for the failure.
        ImageArn:
          type: string
          description: The ARN of the image the version is based on.
        ImageVersionArn:
          type: string
          description: The ARN of the version.
        ImageVersionStatus:
          type: string
          enum:
          - CREATING
          - CREATED
          - CREATE_FAILED
          - DELETING
          - DELETE_FAILED
          description: The status of the version.
        LastModifiedTime:
          type: string
          format: date-time
          description: When the version was last modified.
        Version:
          type: integer
          description: The version number.
      required:
      - CreationTime
      - ImageArn
      - ImageVersionArn
      - ImageVersionStatus
      - LastModifiedTime
      - Version
    ListImageVersionsRequest:
      type: object
      properties:
        CreationTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only versions created on or after the specified time.
        CreationTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only versions created on or before the specified time.
        ImageName:
          type: string
          description: The name of the image to list the versions of.
        LastModifiedTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only versions modified on or after the specified time.
        LastModifiedTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only versions modified on or before the specified time.
        MaxResults:
          type: integer
          description: The maximum number of versions to return in the response. The default value is 10.
        NextToken:
          type: string
          description: If the previous call to ListImageVersions didn't return the full set of versions, the call returns
            a token for getting the next set of versions.
        SortBy:
          type: string
          enum:
          - CREATION_TIME
          - LAST_MODIFIED_TIME
          - VERSION
          description: The property used to sort results. The default value is CREATION_TIME.
        SortOrder:
          type: string
          enum:
          - ASCENDING
          - DESCENDING
          description: The sort order. The default value is DESCENDING.
      required:
      - ImageName
    ListImageVersionsResponse:
      type: object
      properties:
        ImageVersions:
          type: array
          items:
            $ref: '#/components/schemas/ImageVersion'
          description: A list of versions and their properties.
        NextToken:
          type: string
          description: A token for getting the next set of versions, if there are any.
    ResourceInUse:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFound:
      type: object
      properties:
        Message:
          type: string
    UpdateImageVersionRequest:
      type: object
      properties:
        ImageName:
          type: string
          description: The name of the image.
        Alias:
          type: string
          description: The alias of the image version.
        Version:
          type: integer
          description: The version of the image.
        AliasesToAdd:
          type: array
          items:
            type: string
          description: A list of aliases to add.
        AliasesToDelete:
          type: array
          items:
            type: string
          description: A list of aliases to delete.
        VendorGuidance:
          type: string
          enum:
          - NOT_PROVIDED
          - STABLE
          - TO_BE_ARCHIVED
          - ARCHIVED
          description: 'The availability of the image version specified by the maintainer. NOT_PROVIDED: The maintainers did
            not provide a status for image version stability. STABLE: The image version is stable. TO_BE_ARCHIVED: The image
            version is set to be archived. Custom image versions that are set to be archived are automatically archived after
            three months. ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer
            actively supported.'
        JobType:
          type: string
          enum:
          - TRAINING
          - INFERENCE
          - NOTEBOOK_KERNEL
          description: 'Indicates SageMaker AI job type compatibility. TRAINING: The image version is compatible with SageMaker
            AI training jobs. INFERENCE: The image version is compatible with SageMaker AI inference jobs. NOTEBOOK_KERNEL:
            The image version is compatible with SageMaker AI notebook kernels.'
        MLFramework:
          type: string
          description: The machine learning framework vended in the image version.
        ProgrammingLang:
          type: string
          description: The supported programming language and its version.
        Processor:
          type: string
          enum:
          - CPU
          - GPU
          description: 'Indicates CPU or GPU compatibility. CPU: The image version is compatible with CPU. GPU: The image
            version is compatible with GPU.'
        Horovod:
          type: boolean
          description: Indicates Horovod compatibility.
        ReleaseNotes:
          type: string
          description: The maintainer description of the image version.
      required:
      - ImageName
    UpdateImageVersionResponse:
      type: object
      properties:
        ImageVersionArn:
          type: string
          description: The ARN of the image version.
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)