Skip to content

Update Image Version

sagemaker_update_image_version R Documentation

Updates the properties of a SageMaker image version

Description

Updates the properties of a SageMaker image version.

Usage

sagemaker_update_image_version(ImageName, Alias, Version, AliasesToAdd,
  AliasesToDelete, VendorGuidance, JobType, MLFramework, ProgrammingLang,
  Processor, Horovod, ReleaseNotes)

Arguments

ImageName

[required] The name of the image.

Alias

The alias of the image version.

Version

The version of the image.

AliasesToAdd

A list of aliases to add.

AliasesToDelete

A list of aliases to delete.

VendorGuidance

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

Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.

  • INFERENCE: The image version is compatible with SageMaker inference jobs.

  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker 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$update_image_version(
  ImageName = "string",
  Alias = "string",
  Version = 123,
  AliasesToAdd = list(
    "string"
  ),
  AliasesToDelete = 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"
)