Sign in

v1

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

Creates a version of the SageMaker image specified by <code>ImageName</code>. The version represents the Amazon Elastic Container Registry (ECR) container image specified by <code>BaseImage</code>.

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

Headers

X-Amz-Target'SageMaker.CreateImageVersion' required

Request body

BaseImagestring required
<p>The registry path of the container image to use as the starting point for this version. The path is an Amazon Elastic Container Registry (ECR) URI in the following format:</p> <p> <code>&lt;acct-id&gt;.dkr.ecr.&lt;region&gt;.amazonaws.com/&lt;repo-name[:tag] or [@digest]&gt;</code> </p>
ClientTokenstring required

A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.

ImageNamestring required

The <code>ImageName</code> of the <code>Image</code> to create a version of.

AliasesSageMakerImageVersionAlias[]

A list of aliases created with the image version.

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.

Response

Success

ImageVersionArnstring

The ARN of the image version.