/AWS1/IF_SGM=>CREMDELEXPLAINABILITYJOBDEFN()

About CreateModelExplainabilityJobDefinition

Creates the definition for a model explainability job.

Method Signature

METHODS /AWS1/IF_SGM~CREMDELEXPLAINABILITYJOBDEFN
  IMPORTING
    !IV_JOBDEFINITIONNAME TYPE /AWS1/SGMMONJOBDEFINITIONNAME OPTIONAL
    !IO_MDELEXPLAINABILITYBASEL00 TYPE REF TO /AWS1/CL_SGMMDELEXPLAINABILI00 OPTIONAL
    !IO_MDELEXPLAINABILITYAPPSPEC TYPE REF TO /AWS1/CL_SGMMDELEXPLAINABILI01 OPTIONAL
    !IO_MODELEXPLAINABILITYJOBINP TYPE REF TO /AWS1/CL_SGMMDELEXPLAINABILI02 OPTIONAL
    !IO_MDELEXPLAINABILITYJOBOU00 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_sgmcremdelexplainab01
  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 model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

io_mdelexplainabilityappspec TYPE REF TO /AWS1/CL_SGMMDELEXPLAINABILI01 /AWS1/CL_SGMMDELEXPLAINABILI01

Configures the model explainability job to run a specified Docker container image.

io_modelexplainabilityjobinp TYPE REF TO /AWS1/CL_SGMMDELEXPLAINABILI02 /AWS1/CL_SGMMDELEXPLAINABILI02

Inputs for the model explainability job.

io_mdelexplainabilityjobou00 TYPE REF TO /AWS1/CL_SGMMONOUTPUTCONFIG /AWS1/CL_SGMMONOUTPUTCONFIG

ModelExplainabilityJobOutputConfig

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_mdelexplainabilitybasel00 TYPE REF TO /AWS1/CL_SGMMDELEXPLAINABILI00 /AWS1/CL_SGMMDELEXPLAINABILI00

The baseline configuration for a model explainability job.

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

Networking options for a model explainability 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_sgmcremdelexplainab01 /AWS1/CL_SGMCREMDELEXPLAINAB01

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->cremdelexplainabilityjobdefn(
  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_mdelexplainabilityappspec = new /aws1/cl_sgmmdelexplainabili01(
    it_environment = VALUE /aws1/cl_sgmmonenvironmentma00=>tt_monitoringenvironmentmap(
      (
        VALUE /aws1/cl_sgmmonenvironmentma00=>ts_monenvironmentmap_maprow(
          key = |string|
          value = new /aws1/cl_sgmmonenvironmentma00( |string| )
        )
      )
    )
    iv_configuri = |string|
    iv_imageuri = |string|
  )
  io_mdelexplainabilitybasel00 = new /aws1/cl_sgmmdelexplainabili00(
    io_constraintsresource = new /aws1/cl_sgmmoncnstrntsresrc( |string| )
    iv_baseliningjobname = |string|
  )
  io_mdelexplainabilityjobou00 = 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_modelexplainabilityjobinp = new /aws1/cl_sgmmdelexplainabili02(
    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_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.