Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]



Updates the properties of a SageMaker image. To change the image's tags, use the AddTags and DeleteTags APIs.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--delete-properties <value>]
[--description <value>]
[--display-name <value>]
--image-name <value>
[--role-arn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--delete-properties (list)

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



"string" "string" ...

--description (string)

The new description for the image.

--display-name (string)

The new display name for the image.

--image-name (string)

The name of the image to update.

--role-arn (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


ImageArn -> (string)

The Amazon Resource Name (ARN) of the image.