Sign in

v1

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

Describes a version of a SageMaker image.

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

Headers

X-Amz-Target'SageMaker.DescribeImageVersion' required

Request body

ImageNamestring required

The name of the image.

Versioninteger

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

Aliasstring

The alias of the image version.

Response

Success

BaseImagestring

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

ContainerImagestring

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

CreationTimestring date-time

When the version was created.

FailureReasonstring

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

ImageArnstring

The ARN of the image the version is based on.

ImageVersionArnstring

The ARN of the version.

ImageVersionStatus'CREATING' | 'CREATED' | 'CREATE_FAILED' | 'DELETING' | 'DELETE_FAILED'

The status of the version.

LastModifiedTimestring date-time

When the version was last modified.

Versioninteger

The version number.

VendorGuidance'NOT_PROVIDED' | 'STABLE' | 'TO_BE_ARCHIVED' | 'ARCHIVED'
<p>The stability of the image version specified by the maintainer.</p> <ul> <li> <p> <code>NOT_PROVIDED</code>: The maintainers did not provide a status for image version stability.</p> </li> <li> <p> <code>STABLE</code>: The image version is stable.</p> </li> <li> <p> <code>TO_BE_ARCHIVED</code>: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.</p> </li> <li> <p> <code>ARCHIVED</code>: The image version is archived. Archived image versions are not searchable and are no longer actively supported. </p> </li> </ul>
JobType'TRAINING' | 'INFERENCE' | 'NOTEBOOK_KERNEL'
<p>Indicates SageMaker job type compatibility.</p> <ul> <li> <p> <code>TRAINING</code>: The image version is compatible with SageMaker training jobs.</p> </li> <li> <p> <code>INFERENCE</code>: The image version is compatible with SageMaker inference jobs.</p> </li> <li> <p> <code>NOTEBOOK_KERNEL</code>: The image version is compatible with SageMaker notebook kernels.</p> </li> </ul>
MLFrameworkstring

The machine learning framework vended in the image version.

ProgrammingLangstring

The supported programming language and its version.

Processor'CPU' | 'GPU'
<p>Indicates CPU or GPU compatibility.</p> <ul> <li> <p> <code>CPU</code>: The image version is compatible with CPU.</p> </li> <li> <p> <code>GPU</code>: The image version is compatible with GPU.</p> </li> </ul>
Horovodboolean

Indicates Horovod compatibility.

ReleaseNotesstring

The maintainer description of the image version.