image_versions

Creates, updates, deletes or gets an image_version resource or lists image_versions in a region

Overview

Name	image_versions
Type	Resource
Description	Resource Type definition for AWS::SageMaker::ImageVersion
Id	aws.sagemaker.image_versions

Fields

Name	Datatype	Description
image_name	string	The name of the image this version belongs to.
image_arn	string	The Amazon Resource Name (ARN) of the parent image.
image_version_arn	string	The Amazon Resource Name (ARN) of the image version.
base_image	string	The registry path of the container image on which this image version is based.
container_image	string	The image to use for the container that will be materialized for the inference component
version	integer	The version number of the image version.
alias	string	The alias of the image version.
aliases	array	List of aliases for the image version.
vendor_guidance	string	The availability of the image version specified by the maintainer.
job_type	string	Indicates SageMaker job type compatibility.
ml_framework	string	The machine learning framework vended in the image version.
programming_lang	string	The supported programming language and its version.
processor	string	Indicates CPU or GPU compatibility.
horovod	boolean	Indicates Horovod compatibility.
release_notes	string	The maintainer description of the image version.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ImageName, BaseImage, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all image_versions in a region.

SELECT
region,
image_name,
image_arn,
image_version_arn,
base_image,
container_image,
version,
alias,
aliases,
vendor_guidance,
job_type,
ml_framework,
programming_lang,
processor,
horovod,
release_notes
FROM aws.sagemaker.image_versions
WHERE region = 'us-east-1';

Gets all properties from an individual image_version.

SELECT
region,
image_name,
image_arn,
image_version_arn,
base_image,
container_image,
version,
alias,
aliases,
vendor_guidance,
job_type,
ml_framework,
programming_lang,
processor,
horovod,
release_notes
FROM aws.sagemaker.image_versions
WHERE region = 'us-east-1' AND data__Identifier = '<ImageVersionArn>';

INSERT example

Use the following StackQL query and manifest file to create a new image_version resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.sagemaker.image_versions (
 ImageName,
 BaseImage,
 region
)
SELECT 
'{{ ImageName }}',
 '{{ BaseImage }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.sagemaker.image_versions (
 ImageName,
 BaseImage,
 Alias,
 Aliases,
 VendorGuidance,
 JobType,
 MLFramework,
 ProgrammingLang,
 Processor,
 Horovod,
 ReleaseNotes,
 region
)
SELECT 
 '{{ ImageName }}',
 '{{ BaseImage }}',
 '{{ Alias }}',
 '{{ Aliases }}',
 '{{ VendorGuidance }}',
 '{{ JobType }}',
 '{{ MLFramework }}',
 '{{ ProgrammingLang }}',
 '{{ Processor }}',
 '{{ Horovod }}',
 '{{ ReleaseNotes }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: image_version
    props:
      - name: ImageName
        value: '{{ ImageName }}'
      - name: BaseImage
        value: '{{ BaseImage }}'
      - name: Alias
        value: '{{ Alias }}'
      - name: Aliases
        value:
          - null
      - name: VendorGuidance
        value: '{{ VendorGuidance }}'
      - name: JobType
        value: '{{ JobType }}'
      - name: MLFramework
        value: '{{ MLFramework }}'
      - name: ProgrammingLang
        value: '{{ ProgrammingLang }}'
      - name: Processor
        value: '{{ Processor }}'
      - name: Horovod
        value: '{{ Horovod }}'
      - name: ReleaseNotes
        value: '{{ ReleaseNotes }}'

DELETE example

/*+ delete */
DELETE FROM aws.sagemaker.image_versions
WHERE data__Identifier = '<ImageVersionArn>'
AND region = 'us-east-1';

Permissions

To operate on the image_versions resource, the following permissions are required:

Create

sagemaker:CreateImageVersion,
sagemaker:DescribeImageVersion

Read

sagemaker:DescribeImageVersion

Update

sagemaker:UpdateImageVersion,
sagemaker:DescribeImageVersion,
sagemaker:ListAliases

Delete

sagemaker:DeleteImageVersion,
sagemaker:DescribeImageVersion

List

sagemaker:ListImageVersions