Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateImageVersion

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

Request Syntax


{
   "Aliases": [ "string" ],
   "BaseImage": "string",
   "ClientToken": "string",
   "Horovod": boolean,
   "ImageName": "string",
   "JobType": "string",
   "MLFramework": "string",
   "Processor": "string",
   "ProgrammingLang": "string",
   "ReleaseNotes": "string",
   "VendorGuidance": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Aliases

A list of aliases created with the image version.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: (?!^[.-])^([a-zA-Z0-9-_.]+)$

Required: No

BaseImage

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:

<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: .*

Required: Yes

ClientToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: ^[a-zA-Z0-9-]+$

Required: Yes

Horovod

Indicates Horovod compatibility.

Type: Boolean

Required: No

ImageName

The ImageName of the Image to create a version of.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

Required: Yes

JobType

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.

Type: String

Valid Values: TRAINING | INFERENCE | NOTEBOOK_KERNEL

Required: No

MLFramework

The machine learning framework vended in the image version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z]+ ?\d+\.\d+(\.\d+)?$

Required: No

Processor

Indicates CPU or GPU compatibility.

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

Type: String

Valid Values: CPU | GPU

Required: No

ProgrammingLang

The supported programming language and its version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z]+ ?\d+\.\d+(\.\d+)?$

Required: No

ReleaseNotes

The maintainer description of the image version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: .*

Required: No

VendorGuidance

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.

Type: String

Valid Values: NOT_PROVIDED | STABLE | TO_BE_ARCHIVED | ARCHIVED

Required: No

Response Syntax


{
   "ImageVersionArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ImageVersionArn

The ARN of the image version.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceInUse

Resource being accessed is in use.

HTTP Status Code: 400

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400