v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-143021,9861.6 MB

Updates the properties of a SageMaker image. To change the image's tags, use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html">AddTags</a> and <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteTags.html">DeleteTags</a> APIs.

post/#X-Amz-Target=SageMaker.UpdateImage

Headers

X-Amz-Target'SageMaker.UpdateImage' required

Request body

DeletePropertiesImageDeleteProperty[]

A list of properties to delete. Only the <code>Description</code> and <code>DisplayName</code> properties can be deleted.

Descriptionstring

The new description for the image.

DisplayNamestring

The new display name for the image.

ImageNamestring required

The name of the image to update.

RoleArnstring

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

Response

Success

ImageArnstring

The ARN of the image.