2022/12/19 - Amazon SageMaker Service - 2 new 3 updated api methods
Changes AWS Sagemaker - Sagemaker Images now supports Aliases as secondary identifiers for ImageVersions. SageMaker Images now supports additional metadata for ImageVersions for better images management.
Lists the aliases of a specified image or image version.
See also: AWS API Documentation
Request Syntax
client.list_aliases( ImageName='string', Alias='string', Version=123, MaxResults=123, NextToken='string' )
string
[REQUIRED]
The name of the image.
string
The alias of the image version.
integer
The version of the image. If image version is not specified, the aliases of all versions of the image are listed.
integer
The maximum number of aliases to return.
string
If the previous call to ListAliases didn't return the full set of aliases, the call returns a token for retrieving the next set of aliases.
dict
Response Syntax
{ 'SageMakerImageVersionAliases': [ 'string', ], 'NextToken': 'string' }
Response Structure
(dict) --
SageMakerImageVersionAliases (list) --
A list of SageMaker image version aliases.
(string) --
NextToken (string) --
A token for getting the next set of aliases, if more aliases exist.
Updates the properties of a SageMaker image version.
See also: AWS API Documentation
Request Syntax
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' )
string
[REQUIRED]
The name of the image.
string
The alias of the image version.
integer
The version of the image.
list
A list of aliases to add.
(string) --
list
A list of aliases to delete.
(string) --
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.
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.
string
The machine learning framework vended in the image version.
string
The supported programming language and its version.
string
Indicates CPU or GPU compatibility.
CPU : The image version is compatible with CPU.
GPU : The image version is compatible with GPU.
boolean
Indicates Horovod compatibility.
string
The maintainer description of the image version.
dict
Response Syntax
{ 'ImageVersionArn': 'string' }
Response Structure
(dict) --
ImageVersionArn (string) --
The ARN of the image version.
{'Aliases': ['string'], 'Horovod': 'boolean', 'JobType': 'TRAINING | INFERENCE | NOTEBOOK_KERNEL', 'MLFramework': 'string', 'Processor': 'CPU | GPU', 'ProgrammingLang': 'string', 'ReleaseNotes': 'string', 'VendorGuidance': 'NOT_PROVIDED | STABLE | TO_BE_ARCHIVED | ARCHIVED'}
Creates a version of the SageMaker image specified by ImageName . The version represents the Amazon Elastic Container Registry (ECR) container image specified by BaseImage .
See also: AWS API Documentation
Request Syntax
client.create_image_version( BaseImage='string', ClientToken='string', ImageName='string', Aliases=[ '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' )
string
[REQUIRED]
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]>
string
[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.
This field is autopopulated if not provided.
string
[REQUIRED]
The ImageName of the Image to create a version of.
list
A list of aliases created with the image version.
(string) --
string
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.
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.
string
The machine learning framework vended in the image version.
string
The supported programming language and its version.
string
Indicates CPU or GPU compatibility.
CPU : The image version is compatible with CPU.
GPU : The image version is compatible with GPU.
boolean
Indicates Horovod compatibility.
string
The maintainer description of the image version.
dict
Response Syntax
{ 'ImageVersionArn': 'string' }
Response Structure
(dict) --
ImageVersionArn (string) --
The ARN of the image version.
{'Alias': 'string'}
Deletes a version of a SageMaker image. The container image the version represents isn't deleted.
See also: AWS API Documentation
Request Syntax
client.delete_image_version( ImageName='string', Version=123, Alias='string' )
string
[REQUIRED]
The name of the image to delete.
integer
The version to delete.
string
The alias of the image to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
{'Alias': 'string'}Response
{'Horovod': 'boolean', 'JobType': 'TRAINING | INFERENCE | NOTEBOOK_KERNEL', 'MLFramework': 'string', 'Processor': 'CPU | GPU', 'ProgrammingLang': 'string', 'ReleaseNotes': 'string', 'VendorGuidance': 'NOT_PROVIDED | STABLE | TO_BE_ARCHIVED | ARCHIVED'}
Describes a version of a SageMaker image.
See also: AWS API Documentation
Request Syntax
client.describe_image_version( ImageName='string', Version=123, Alias='string' )
string
[REQUIRED]
The name of the image.
integer
The version of the image. If not specified, the latest version is described.
string
The alias of the image version.
dict
Response Syntax
{ 'BaseImage': 'string', 'ContainerImage': 'string', 'CreationTime': datetime(2015, 1, 1), 'FailureReason': 'string', 'ImageArn': 'string', 'ImageVersionArn': 'string', 'ImageVersionStatus': 'CREATING'|'CREATED'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED', 'LastModifiedTime': datetime(2015, 1, 1), 'Version': 123, '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' }
Response Structure
(dict) --
BaseImage (string) --
The registry path of the container image on which this image version is based.
ContainerImage (string) --
The registry path of the container image that contains this image version.
CreationTime (datetime) --
When the version was created.
FailureReason (string) --
When a create or delete operation fails, the reason for the failure.
ImageArn (string) --
The ARN of the image the version is based on.
ImageVersionArn (string) --
The ARN of the version.
ImageVersionStatus (string) --
The status of the version.
LastModifiedTime (datetime) --
When the version was last modified.
Version (integer) --
The version number.
VendorGuidance (string) --
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.
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.