CreateImageVersion
Creates a version of the SageMaker image specified by ImageName
. The version
represents the Amazon Container Registry (ECR) container image specified by BaseImage
.
Request Syntax
{
"BaseImage": "string
",
"ClientToken": "string
",
"ImageName": "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.
- BaseImage
-
The registry path of the container image to use as the starting point for this version. The path is an Amazon 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 AWS CLI and AWS 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
- ImageName
-
The
ImageName
of theImage
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
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 Amazon Resource Name (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 Amazon 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: