SageMaker / Client / update_image_version
update_image_version#
- SageMaker.Client.update_image_version(**kwargs)#
Updates the properties of a SageMaker image version.
See also: AWS API Documentation
Request Syntax
response = client.update_image_version( ImageName='string', Alias='string', Version=123, AliasesToAdd=[ 'string', ], AliasesToDelete=[ 'string', ], VendorGuidance='NOT_PROVIDED'|'STABLE'|'TO_BE_ARCHIVED'|'ARCHIVED', JobType='TRAINING'|'INFERENCE'|'NOTEBOOK_KERNEL', MLFramework='string', ProgrammingLang='string', Processor='CPU'|'GPU', Horovod=True|False, ReleaseNotes='string' )
- Parameters:
ImageName (string) –
[REQUIRED]
The name of the image.
Alias (string) – The alias of the image version.
Version (integer) – The version of the image.
AliasesToAdd (list) –
A list of aliases to add.
(string) –
AliasesToDelete (list) –
A list of aliases to delete.
(string) –
VendorGuidance (string) –
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.
JobType (string) –
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.
MLFramework (string) – The machine learning framework vended in the image version.
ProgrammingLang (string) – The supported programming language and its version.
Processor (string) –
Indicates CPU or GPU compatibility.
CPU
: The image version is compatible with CPU.GPU
: The image version is compatible with GPU.
Horovod (boolean) – Indicates Horovod compatibility.
ReleaseNotes (string) – The maintainer description of the image version.
- Return type:
dict
- Returns:
Response Syntax
{ 'ImageVersionArn': 'string' }
Response Structure
(dict) –
ImageVersionArn (string) –
The ARN of the image version.
Exceptions
SageMaker.Client.exceptions.ResourceInUse
SageMaker.Client.exceptions.ResourceNotFound