Amazon SageMaker

Amazon SageMaker Sagemaker Image API

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

GitHub OpenAPI

Operations 5

POST /#CreateImage Create Image #
POST /#DeleteImage Delete Image #
POST /#DescribeImage Describe Image #
POST /#ListImages List Images #
POST /#UpdateImage Update Image #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-sagemaker/openapi/amazon-sagemaker-image-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-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-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Amazon SageMaker Service Image 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:
  /#CreateImage:
    post:
      operationId: CreateImage
      summary: Create Image
      description: Creates a custom SageMaker AI image. A SageMaker AI image is a set of image versions. Each image version
        represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker AI image.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateImageResponse'
        '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.CreateImage
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateImageRequest'
      tags:
      - Image
  /#DeleteImage:
    post:
      operationId: DeleteImage
      summary: Delete Image
      description: Deletes a SageMaker AI image and all versions of the image. The container images aren't deleted.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteImageResponse'
        '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.DeleteImage
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteImageRequest'
      tags:
      - Image
  /#DescribeImage:
    post:
      operationId: DescribeImage
      summary: Describe Image
      description: Describes a SageMaker AI image.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeImageResponse'
        '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.DescribeImage
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeImageRequest'
      tags:
      - Image
  /#ListImages:
    post:
      operationId: ListImages
      summary: List Images
      description: Lists the images in your account and their properties. The list can be filtered by creation time or modified
        time, and whether the image name contains a specified string.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListImagesResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListImages
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListImagesRequest'
      tags:
      - Image
  /#UpdateImage:
    post:
      operationId: UpdateImage
      summary: Update Image
      description: Updates the properties of a SageMaker AI image. To change the image's tags, use the AddTags and DeleteTags
        APIs.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateImageResponse'
        '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.UpdateImage
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateImageRequest'
      tags:
      - Image
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:
    CreateImageRequest:
      type: object
      properties:
        Description:
          type: string
          description: The description of the image.
        DisplayName:
          type: string
          description: The display name of the image. If not provided, ImageName is displayed.
        ImageName:
          type: string
          description: The name of the image. Must be unique to your account.
        RoleArn:
          type: string
          description: The ARN of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to apply to the image.
      required:
      - ImageName
      - RoleArn
    CreateImageResponse:
      type: object
      properties:
        ImageArn:
          type: string
          description: The ARN of the image.
    DeleteImageRequest:
      type: object
      properties:
        ImageName:
          type: string
          description: The name of the image to delete.
      required:
      - ImageName
    DeleteImageResponse:
      type: object
      properties: {}
    DescribeImageRequest:
      type: object
      properties:
        ImageName:
          type: string
          description: The name of the image to describe.
      required:
      - ImageName
    DescribeImageResponse:
      type: object
      properties:
        CreationTime:
          type: string
          format: date-time
          description: When the image was created.
        Description:
          type: string
          description: The description of the image.
        DisplayName:
          type: string
          description: The name of the image as displayed.
        FailureReason:
          type: string
          description: When a create, update, or delete operation fails, the reason for the failure.
        ImageArn:
          type: string
          description: The ARN of the image.
        ImageName:
          type: string
          description: The name of the image.
        ImageStatus:
          type: string
          enum:
          - CREATING
          - CREATED
          - CREATE_FAILED
          - UPDATING
          - UPDATE_FAILED
          - DELETING
          - DELETE_FAILED
          description: The status of the image.
        LastModifiedTime:
          type: string
          format: date-time
          description: When the image was last modified.
        RoleArn:
          type: string
          description: The ARN of the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
    Image:
      type: object
      properties:
        CreationTime:
          type: string
          format: date-time
          description: When the image was created.
        Description:
          type: string
          description: The description of the image.
        DisplayName:
          type: string
          description: The name of the image as displayed.
        FailureReason:
          type: string
          description: When a create, update, or delete operation fails, the reason for the failure.
        ImageArn:
          type: string
          description: The ARN of the image.
        ImageName:
          type: string
          description: The name of the image.
        ImageStatus:
          type: string
          enum:
          - CREATING
          - CREATED
          - CREATE_FAILED
          - UPDATING
          - UPDATE_FAILED
          - DELETING
          - DELETE_FAILED
          description: The status of the image.
        LastModifiedTime:
          type: string
          format: date-time
          description: When the image was last modified.
      required:
      - CreationTime
      - ImageArn
      - ImageName
      - ImageStatus
      - LastModifiedTime
    ListImagesRequest:
      type: object
      properties:
        CreationTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only images created on or after the specified time.
        CreationTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only images created on or before the specified time.
        LastModifiedTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only images modified on or after the specified time.
        LastModifiedTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only images modified on or before the specified time.
        MaxResults:
          type: integer
          description: The maximum number of images to return in the response. The default value is 10.
        NameContains:
          type: string
          description: A filter that returns only images whose name contains the specified string.
        NextToken:
          type: string
          description: If the previous call to ListImages didn't return the full set of images, the call returns a token for
            getting the next set of images.
        SortBy:
          type: string
          enum:
          - CREATION_TIME
          - LAST_MODIFIED_TIME
          - IMAGE_NAME
          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.
    ListImagesResponse:
      type: object
      properties:
        Images:
          type: array
          items:
            $ref: '#/components/schemas/Image'
          description: A list of images and their properties.
        NextToken:
          type: string
          description: A token for getting the next set of images, if there are any.
    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
    UpdateImageRequest:
      type: object
      properties:
        DeleteProperties:
          type: array
          items:
            type: string
          description: A list of properties to delete. Only the Description and DisplayName properties can be deleted.
        Description:
          type: string
          description: The new description for the image.
        DisplayName:
          type: string
          description: The new display name for the image.
        ImageName:
          type: string
          description: The name of the image to update.
        RoleArn:
          type: string
          description: The new ARN for the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
      required:
      - ImageName
    UpdateImageResponse:
      type: object
      properties:
        ImageArn:
          type: string
          description: The ARN of the image.
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)