[ aws . sagemaker ]



Describes a version of a SageMaker image.

See also: AWS API Documentation


--image-name <value>
[--alias <value>]
[--version-number <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--endpoint-url <value>]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]


--image-name (string)

The name of the image.

--alias (string)

The alias of the image version.

--version-number (integer)

The version of the image. If not specified, the latest version is described.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.


BaseImage -> (string)

The registry path of the container image on which this image version is based.

ContainerImage -> (string)

The registry path of the container image that contains this image version.

CreationTime -> (timestamp)

When the version was created.

FailureReason -> (string)

When a create or delete operation fails, the reason for the failure.

ImageArn -> (string)

The ARN of the image the version is based on.

ImageVersionArn -> (string)

The ARN of the version.

ImageVersionStatus -> (string)

The status of the version.

LastModifiedTime -> (timestamp)

When the version was last modified.

Version -> (integer)

The version number.

VendorGuidance -> (string)

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 -> (string)

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 -> (string)

The machine learning framework vended in the image version.

ProgrammingLang -> (string)

The supported programming language and its version.

Processor -> (string)

Indicates CPU or GPU compatibility.

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

Horovod -> (boolean)

Indicates Horovod compatibility.

ReleaseNotes -> (string)

The maintainer description of the image version.