Skip to content

/AWS1/IF_SGM=>CREATEIMAGEVERSION()

About CreateImageVersion

Creates a version of the SageMaker AI image specified by ImageName. The version represents the Amazon ECR container image specified by BaseImage.

Method Signature

METHODS /AWS1/IF_SGM~CREATEIMAGEVERSION
  IMPORTING
    !IV_BASEIMAGE TYPE /AWS1/SGMIMAGEBASEIMAGE OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/SGMCLIENTTOKEN OPTIONAL
    !IV_IMAGENAME TYPE /AWS1/SGMIMAGENAME OPTIONAL
    !IT_ALIASES TYPE /AWS1/CL_SGMSMIMAGEVRSALIASE00=>TT_SMIMAGEVERSIONALIASES OPTIONAL
    !IV_VENDORGUIDANCE TYPE /AWS1/SGMVENDORGUIDANCE OPTIONAL
    !IV_JOBTYPE TYPE /AWS1/SGMJOBTYPE OPTIONAL
    !IV_MLFRAMEWORK TYPE /AWS1/SGMMLFRAMEWORK OPTIONAL
    !IV_PROGRAMMINGLANG TYPE /AWS1/SGMPROGRAMMINGLANG OPTIONAL
    !IV_PROCESSOR TYPE /AWS1/SGMPROCESSOR OPTIONAL
    !IV_HOROVOD TYPE /AWS1/SGMHOROVOD OPTIONAL
    !IV_RELEASENOTES TYPE /AWS1/SGMRELEASENOTES OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmcreateimagevrsrsp
  RAISING
    /AWS1/CX_SGMRESOURCEINUSE
    /AWS1/CX_SGMRESOURCELIMITEXCD
    /AWS1/CX_SGMRESOURCENOTFOUND
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_baseimage TYPE /AWS1/SGMIMAGEBASEIMAGE /AWS1/SGMIMAGEBASEIMAGE

The registry path of the container image to use as the starting point for this version. The path is an Amazon ECR URI in the following format:

<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

iv_clienttoken TYPE /AWS1/SGMCLIENTTOKEN /AWS1/SGMCLIENTTOKEN

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.

iv_imagename TYPE /AWS1/SGMIMAGENAME /AWS1/SGMIMAGENAME

The ImageName of the Image to create a version of.

Optional arguments:

it_aliases TYPE /AWS1/CL_SGMSMIMAGEVRSALIASE00=>TT_SMIMAGEVERSIONALIASES TT_SMIMAGEVERSIONALIASES

A list of aliases created with the image version.

iv_vendorguidance TYPE /AWS1/SGMVENDORGUIDANCE /AWS1/SGMVENDORGUIDANCE

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.

iv_jobtype TYPE /AWS1/SGMJOBTYPE /AWS1/SGMJOBTYPE

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.

iv_mlframework TYPE /AWS1/SGMMLFRAMEWORK /AWS1/SGMMLFRAMEWORK

The machine learning framework vended in the image version.

iv_programminglang TYPE /AWS1/SGMPROGRAMMINGLANG /AWS1/SGMPROGRAMMINGLANG

The supported programming language and its version.

iv_processor TYPE /AWS1/SGMPROCESSOR /AWS1/SGMPROCESSOR

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.

  • GPU: The image version is compatible with GPU.

iv_horovod TYPE /AWS1/SGMHOROVOD /AWS1/SGMHOROVOD

Indicates Horovod compatibility.

iv_releasenotes TYPE /AWS1/SGMRELEASENOTES /AWS1/SGMRELEASENOTES

The maintainer description of the image version.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmcreateimagevrsrsp /AWS1/CL_SGMCREATEIMAGEVRSRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createimageversion(
  it_aliases = VALUE /aws1/cl_sgmsmimagevrsaliase00=>tt_smimageversionaliases(
    ( new /aws1/cl_sgmsmimagevrsaliase00( |string| ) )
  )
  iv_baseimage = |string|
  iv_clienttoken = |string|
  iv_horovod = ABAP_TRUE
  iv_imagename = |string|
  iv_jobtype = |string|
  iv_mlframework = |string|
  iv_processor = |string|
  iv_programminglang = |string|
  iv_releasenotes = |string|
  iv_vendorguidance = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_imageversionarn = lo_result->get_imageversionarn( ).
ENDIF.