Skip to content

Updates the properties of a SageMaker AI image

Description

Updates the properties of a SageMaker AI image. To change the image's tags, use the add_tags and delete_tags APIs.

Usage

sagemaker_update_image(DeleteProperties, Description, DisplayName,
  ImageName, RoleArn)

Arguments

  • DeleteProperties

    A list of properties to delete. Only the Description and DisplayName properties can be deleted.

  • Description

    The new description for the image.

  • DisplayName

    The new display name for the image.

  • ImageName

    [required] The name of the image to update.

  • RoleArn

    The new ARN for the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

Value

A list with the following syntax:

list(
  ImageArn = "string"
)

Request syntax

svc$update_image(
  DeleteProperties = list(
    "string"
  ),
  Description = "string",
  DisplayName = "string",
  ImageName = "string",
  RoleArn = "string"
)