Skip to content

Creates a version of the SageMaker AI image specified by ImageName

Description

Creates a version of the SageMaker AI image specified by ImageName. The version represents the Amazon ECR container image specified by BaseImage.

Usage

sagemaker_create_image_version(BaseImage, ClientToken, ImageName,
  Aliases, VendorGuidance, JobType, MLFramework, ProgrammingLang,
  Processor, Horovod, ReleaseNotes)

Arguments

  • BaseImage

    [required] 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

    [required] 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

    [required] The ImageName of the Image to create a version of.

  • Aliases

    A list of aliases created with the image version.

  • VendorGuidance

    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

    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

    The machine learning framework vended in the image version.

  • ProgrammingLang

    The supported programming language and its version.

  • Processor

    Indicates CPU or GPU compatibility.

    • CPU: The image version is compatible with CPU.
    • GPU: The image version is compatible with GPU.

  • Horovod

    Indicates Horovod compatibility.

  • ReleaseNotes

    The maintainer description of the image version.

Value

A list with the following syntax:

list(
  ImageVersionArn = "string"
)

Request syntax

svc$create_image_version(
  BaseImage = "string",
  ClientToken = "string",
  ImageName = "string",
  Aliases = list(
    "string"
  ),
  VendorGuidance = "NOT_PROVIDED"|"STABLE"|"TO_BE_ARCHIVED"|"ARCHIVED",
  JobType = "TRAINING"|"INFERENCE"|"NOTEBOOK_KERNEL",
  MLFramework = "string",
  ProgrammingLang = "string",
  Processor = "CPU"|"GPU",
  Horovod = TRUE|FALSE,
  ReleaseNotes = "string"
)