Skip to content

/AWS1/CL_SGM=>CREATECOMPILATIONJOB()

About CreateCompilationJob

Starts a model compilation job. After the model has been compiled, Amazon SageMaker AI saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

If you choose to host your model using Amazon SageMaker AI hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.

In the request body, you provide the following:

  • A name for the compilation job

  • Information about the input model artifacts

  • The output location for the compiled model and the device (target) that the model runs on

  • The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker AI assumes to perform the model compilation job.

You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.

To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

Method Signature

IMPORTING

Required arguments:

iv_compilationjobname TYPE /AWS1/SGMENTITYNAME /AWS1/SGMENTITYNAME

A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

iv_rolearn TYPE /AWS1/SGMROLEARN /AWS1/SGMROLEARN

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

During model compilation, Amazon SageMaker AI needs your permission to:

  • Read input data from an S3 bucket

  • Write model artifacts to an S3 bucket

  • Write logs to Amazon CloudWatch Logs

  • Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker AI, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker AI Roles.

io_outputconfig TYPE REF TO /AWS1/CL_SGMOUTPUTCONFIG /AWS1/CL_SGMOUTPUTCONFIG

Provides information about the output location for the compiled model and the target device the model runs on.

io_stoppingcondition TYPE REF TO /AWS1/CL_SGMSTOPPINGCONDITION /AWS1/CL_SGMSTOPPINGCONDITION

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training costs.

Optional arguments:

iv_modelpackageversionarn TYPE /AWS1/SGMMODELPACKAGEARN /AWS1/SGMMODELPACKAGEARN

The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.

io_inputconfig TYPE REF TO /AWS1/CL_SGMINPUTCONFIG /AWS1/CL_SGMINPUTCONFIG

Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

io_vpcconfig TYPE REF TO /AWS1/CL_SGMNEOVPCCONFIG /AWS1/CL_SGMNEOVPCCONFIG

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

it_tags TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST TT_TAGLIST

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmcrecompilationjo01 /AWS1/CL_SGMCRECOMPILATIONJO01

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->/aws1/if_sgm~createcompilationjob(
  io_inputconfig = new /aws1/cl_sgminputconfig(
    iv_datainputconfig = |string|
    iv_framework = |string|
    iv_frameworkversion = |string|
    iv_s3uri = |string|
  )
  io_outputconfig = new /aws1/cl_sgmoutputconfig(
    io_targetplatform = new /aws1/cl_sgmtargetplatform(
      iv_accelerator = |string|
      iv_arch = |string|
      iv_os = |string|
    )
    iv_compileroptions = |string|
    iv_kmskeyid = |string|
    iv_s3outputlocation = |string|
    iv_targetdevice = |string|
  )
  io_stoppingcondition = new /aws1/cl_sgmstoppingcondition(
    iv_maxpendingtimeinseconds = 123
    iv_maxruntimeinseconds = 123
    iv_maxwaittimeinseconds = 123
  )
  io_vpcconfig = new /aws1/cl_sgmneovpcconfig(
    it_securitygroupids = VALUE /aws1/cl_sgmneovpcsecgrpids_w=>tt_neovpcsecuritygroupids(
      ( new /aws1/cl_sgmneovpcsecgrpids_w( |string| ) )
    )
    it_subnets = VALUE /aws1/cl_sgmneovpcsubnets_w=>tt_neovpcsubnets(
      ( new /aws1/cl_sgmneovpcsubnets_w( |string| ) )
    )
  )
  it_tags = VALUE /aws1/cl_sgmtag=>tt_taglist(
    (
      new /aws1/cl_sgmtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_compilationjobname = |string|
  iv_modelpackageversionarn = |string|
  iv_rolearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_compilationjobarn = lo_result->get_compilationjobarn( ).
ENDIF.