UpdateImageVersion
Updates the properties of a SageMaker AI image version.
Request Syntax
{
"Alias": "string",
"AliasesToAdd": [ "string" ],
"AliasesToDelete": [ "string" ],
"Horovod": boolean,
"ImageName": "string",
"JobType": "string",
"MLFramework": "string",
"Processor": "string",
"ProgrammingLang": "string",
"ReleaseNotes": "string",
"VendorGuidance": "string",
"Version": number
}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.
- Alias
-
The alias of the image version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
(?!^[.-])^([a-zA-Z0-9-_.]+)$Required: No
- AliasesToAdd
-
A list of aliases to add.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
(?!^[.-])^([a-zA-Z0-9-_.]+)$Required: No
- AliasesToDelete
-
A list of aliases to delete.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
(?!^[.-])^([a-zA-Z0-9-_.]+)$Required: No
- Horovod
-
Indicates Horovod compatibility.
Type: Boolean
Required: No
- ImageName
-
The name of the image.
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 AI job type compatibility.
-
TRAINING: The image version is compatible with SageMaker AI training jobs. -
INFERENCE: The image version is compatible with SageMaker AI inference jobs. -
NOTEBOOK_KERNEL: The image version is compatible with SageMaker AI notebook kernels.
Type: String
Valid Values:
TRAINING | INFERENCE | NOTEBOOK_KERNELRequired: 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 | GPURequired: 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 availability 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 | ARCHIVEDRequired: No
-
- Version
-
The version of the image.
Type: Integer
Valid Range: Minimum value of 0.
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]+|None)$
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
- 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:
