/AWS1/IF_SGM=>CREATEMODELQUALITYJOBDEFN()

About CreateModelQualityJobDefinition

Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.

Method Signature

METHODS /AWS1/IF_SGM~CREATEMODELQUALITYJOBDEFN
  IMPORTING
    !IV_JOBDEFINITIONNAME TYPE /AWS1/SGMMONJOBDEFINITIONNAME OPTIONAL
    !IO_MODELQUALITYBASELINECFG TYPE REF TO /AWS1/CL_SGMMDELQUALITYBASEL00 OPTIONAL
    !IO_MODELQUALITYAPPSPEC TYPE REF TO /AWS1/CL_SGMMDELQUALITYAPPSPEC OPTIONAL
    !IO_MODELQUALITYJOBINPUT TYPE REF TO /AWS1/CL_SGMMODELQUALITYJOBINP OPTIONAL
    !IO_MODELQUALITYJOBOUTPUTCFG TYPE REF TO /AWS1/CL_SGMMONOUTPUTCONFIG OPTIONAL
    !IO_JOBRESOURCES TYPE REF TO /AWS1/CL_SGMMONRESOURCES OPTIONAL
    !IO_NETWORKCONFIG TYPE REF TO /AWS1/CL_SGMMONNETWORKCONFIG OPTIONAL
    !IV_ROLEARN TYPE /AWS1/SGMROLEARN OPTIONAL
    !IO_STOPPINGCONDITION TYPE REF TO /AWS1/CL_SGMMONSTOPPINGCOND OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmcremdelqualityjo01
  RAISING
    /AWS1/CX_SGMRESOURCEINUSE
    /AWS1/CX_SGMRESOURCELIMITEXCD
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_jobdefinitionname TYPE /AWS1/SGMMONJOBDEFINITIONNAME /AWS1/SGMMONJOBDEFINITIONNAME

The name of the monitoring job definition.

io_modelqualityappspec TYPE REF TO /AWS1/CL_SGMMDELQUALITYAPPSPEC /AWS1/CL_SGMMDELQUALITYAPPSPEC

The container that runs the monitoring job.

io_modelqualityjobinput TYPE REF TO /AWS1/CL_SGMMODELQUALITYJOBINP /AWS1/CL_SGMMODELQUALITYJOBINP

A list of the inputs that are monitored. Currently endpoints are supported.

io_modelqualityjoboutputcfg TYPE REF TO /AWS1/CL_SGMMONOUTPUTCONFIG /AWS1/CL_SGMMONOUTPUTCONFIG

ModelQualityJobOutputConfig

io_jobresources TYPE REF TO /AWS1/CL_SGMMONRESOURCES /AWS1/CL_SGMMONRESOURCES

JobResources

iv_rolearn TYPE /AWS1/SGMROLEARN /AWS1/SGMROLEARN

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

Optional arguments:

io_modelqualitybaselinecfg TYPE REF TO /AWS1/CL_SGMMDELQUALITYBASEL00 /AWS1/CL_SGMMDELQUALITYBASEL00

Specifies the constraints and baselines for the monitoring job.

io_networkconfig TYPE REF TO /AWS1/CL_SGMMONNETWORKCONFIG /AWS1/CL_SGMMONNETWORKCONFIG

Specifies the network configuration for the monitoring job.

io_stoppingcondition TYPE REF TO /AWS1/CL_SGMMONSTOPPINGCOND /AWS1/CL_SGMMONSTOPPINGCOND

StoppingCondition

it_tags TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST TT_TAGLIST

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmcremdelqualityjo01 /AWS1/CL_SGMCREMDELQUALITYJO01

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->createmodelqualityjobdefn(
  io_jobresources = new /aws1/cl_sgmmonresources(
    io_clusterconfig = new /aws1/cl_sgmmonclusterconfig(
      iv_instancecount = 123
      iv_instancetype = |string|
      iv_volumekmskeyid = |string|
      iv_volumesizeingb = 123
    )
  )
  io_modelqualityappspec = new /aws1/cl_sgmmdelqualityappspec(
    it_containerarguments = VALUE /aws1/cl_sgmmoncontainerargu00=>tt_moncontainerarguments(
      ( new /aws1/cl_sgmmoncontainerargu00( |string| ) )
    )
    it_containerentrypoint = VALUE /aws1/cl_sgmcontainerentrpt_w=>tt_containerentrypoint(
      ( new /aws1/cl_sgmcontainerentrpt_w( |string| ) )
    )
    it_environment = VALUE /aws1/cl_sgmmonenvironmentma00=>tt_monitoringenvironmentmap(
      (
        VALUE /aws1/cl_sgmmonenvironmentma00=>ts_monenvironmentmap_maprow(
          key = |string|
          value = new /aws1/cl_sgmmonenvironmentma00( |string| )
        )
      )
    )
    iv_imageuri = |string|
    iv_postalysprocorsourceuri = |string|
    iv_problemtype = |string|
    iv_recordpreprocorsourceuri = |string|
  )
  io_modelqualitybaselinecfg = new /aws1/cl_sgmmdelqualitybasel00(
    io_constraintsresource = new /aws1/cl_sgmmoncnstrntsresrc( |string| )
    iv_baseliningjobname = |string|
  )
  io_modelqualityjobinput = new /aws1/cl_sgmmodelqualityjobinp(
    io_batchtransforminput = new /aws1/cl_sgmbatchtransforminp(
      io_datasetformat = new /aws1/cl_sgmmondatasetformat(
        io_csv = new /aws1/cl_sgmmoncsvdsformat( ABAP_TRUE )
        io_json = new /aws1/cl_sgmmonjsondsformat( ABAP_TRUE )
        io_parquet = new /aws1/cl_sgmmonparquetdsformat( )
      )
      iv_datacaptureddsts3uri = |string|
      iv_endtimeoffset = |string|
      iv_excludefeaturesattribute = |string|
      iv_featuresattribute = |string|
      iv_inferenceattribute = |string|
      iv_localpath = |string|
      iv_probabilityattribute = |string|
      iv_probabilitythresholdattr = '0.1'
      iv_s3datadistributiontype = |string|
      iv_s3inputmode = |string|
      iv_starttimeoffset = |string|
    )
    io_endpointinput = new /aws1/cl_sgmendpointinput(
      iv_endpointname = |string|
      iv_endtimeoffset = |string|
      iv_excludefeaturesattribute = |string|
      iv_featuresattribute = |string|
      iv_inferenceattribute = |string|
      iv_localpath = |string|
      iv_probabilityattribute = |string|
      iv_probabilitythresholdattr = '0.1'
      iv_s3datadistributiontype = |string|
      iv_s3inputmode = |string|
      iv_starttimeoffset = |string|
    )
    io_groundtruths3input = new /aws1/cl_sgmmongroundtruths300( |string| )
  )
  io_modelqualityjoboutputcfg = new /aws1/cl_sgmmonoutputconfig(
    it_monitoringoutputs = VALUE /aws1/cl_sgmmonitoringoutput=>tt_monitoringoutputs(
      (
        new /aws1/cl_sgmmonitoringoutput(
          io_s3output = new /aws1/cl_sgmmonitorings3output(
            iv_localpath = |string|
            iv_s3uploadmode = |string|
            iv_s3uri = |string|
          )
        )
      )
    )
    iv_kmskeyid = |string|
  )
  io_networkconfig = new /aws1/cl_sgmmonnetworkconfig(
    io_vpcconfig = new /aws1/cl_sgmvpcconfig(
      it_securitygroupids = VALUE /aws1/cl_sgmvpcsecgroupids_w=>tt_vpcsecuritygroupids(
        ( new /aws1/cl_sgmvpcsecgroupids_w( |string| ) )
      )
      it_subnets = VALUE /aws1/cl_sgmsubnets_w=>tt_subnets(
        ( new /aws1/cl_sgmsubnets_w( |string| ) )
      )
    )
    iv_enablenetworkisolation = ABAP_TRUE
    iv_enbintercontainertrafenc = ABAP_TRUE
  )
  io_stoppingcondition = new /aws1/cl_sgmmonstoppingcond( 123 )
  it_tags = VALUE /aws1/cl_sgmtag=>tt_taglist(
    (
      new /aws1/cl_sgmtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_jobdefinitionname = |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_monitoringjobdefinition = lo_result->get_jobdefinitionarn( ).
ENDIF.