Skip to content

/AWS1/IF_NED=>STARTMLDATAPROCESSINGJOB()

About StartMLDataProcessingJob

Creates a new Neptune ML data processing job for processing the graph data exported from Neptune for training. See The dataprocessing command.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartMLModelDataProcessingJob IAM action in that cluster.

Method Signature

METHODS /AWS1/IF_NED~STARTMLDATAPROCESSINGJOB
  IMPORTING
    !IV_ID TYPE /AWS1/NEDSTRING OPTIONAL
    !IV_PREVIOUSDATAPROCINGJOBID TYPE /AWS1/NEDSTRING OPTIONAL
    !IV_INPUTDATAS3LOCATION TYPE /AWS1/NEDSTRING OPTIONAL
    !IV_PROCESSEDDATAS3LOCATION TYPE /AWS1/NEDSTRING OPTIONAL
    !IV_SAGEMAKERIAMROLEARN TYPE /AWS1/NEDSTRING OPTIONAL
    !IV_NEPTUNEIAMROLEARN TYPE /AWS1/NEDSTRING OPTIONAL
    !IV_PROCESSINGINSTANCETYPE TYPE /AWS1/NEDSTRING OPTIONAL
    !IV_PROCINGINSTVOLUMESIZEINGB TYPE /AWS1/NEDINTEGER OPTIONAL
    !IV_PROCESSINGTMOUTINSECONDS TYPE /AWS1/NEDINTEGER OPTIONAL
    !IV_MODELTYPE TYPE /AWS1/NEDSTRING OPTIONAL
    !IV_CONFIGFILENAME TYPE /AWS1/NEDSTRING OPTIONAL
    !IT_SUBNETS TYPE /AWS1/CL_NEDSTRINGLIST_W=>TT_STRINGLIST OPTIONAL
    !IT_SECURITYGROUPIDS TYPE /AWS1/CL_NEDSTRINGLIST_W=>TT_STRINGLIST OPTIONAL
    !IV_VOLUMEENCRYPTIONKMSKEY TYPE /AWS1/NEDSTRING OPTIONAL
    !IV_S3OUTPUTENCRYPTIONKMSKEY TYPE /AWS1/NEDSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_nedstrtmldataprocin01
  RAISING
    /AWS1/CX_NEDBADREQUESTEX
    /AWS1/CX_NEDCLIENTTIMEOUTEX
    /AWS1/CX_NEDCNSTRNTVIOLATIONEX
    /AWS1/CX_NEDILLEGALARGUMENTEX
    /AWS1/CX_NEDINVALIDARGUMENTEX
    /AWS1/CX_NEDINVALIDPARAMETEREX
    /AWS1/CX_NEDMISSINGPARAMETEREX
    /AWS1/CX_NEDMLRESRCNOTFOUNDEX
    /AWS1/CX_NEDPRECONDSFAILEDEX
    /AWS1/CX_NEDTOOMANYREQUESTSEX
    /AWS1/CX_NEDUNSUPPORTEDOPEX
    /AWS1/CX_NEDCLIENTEXC
    /AWS1/CX_NEDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_inputdatas3location TYPE /AWS1/NEDSTRING /AWS1/NEDSTRING

The URI of the Amazon S3 location where you want SageMaker to download the data needed to run the data processing job.

iv_processeddatas3location TYPE /AWS1/NEDSTRING /AWS1/NEDSTRING

The URI of the Amazon S3 location where you want SageMaker to save the results of a data processing job.

Optional arguments:

iv_id TYPE /AWS1/NEDSTRING /AWS1/NEDSTRING

A unique identifier for the new job. The default is an autogenerated UUID.

iv_previousdataprocingjobid TYPE /AWS1/NEDSTRING /AWS1/NEDSTRING

The job ID of a completed data processing job run on an earlier version of the data.

iv_sagemakeriamrolearn TYPE /AWS1/NEDSTRING /AWS1/NEDSTRING

The ARN of an IAM role for SageMaker execution. This must be listed in your DB cluster parameter group or an error will occur.

iv_neptuneiamrolearn TYPE /AWS1/NEDSTRING /AWS1/NEDSTRING

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf. This must be listed in your DB cluster parameter group or an error will occur.

iv_processinginstancetype TYPE /AWS1/NEDSTRING /AWS1/NEDSTRING

The type of ML instance used during data processing. Its memory should be large enough to hold the processed dataset. The default is the smallest ml.r5 type whose memory is ten times larger than the size of the exported graph data on disk.

iv_procinginstvolumesizeingb TYPE /AWS1/NEDINTEGER /AWS1/NEDINTEGER

The disk volume size of the processing instance. Both input data and processed data are stored on disk, so the volume size must be large enough to hold both data sets. The default is 0. If not specified or 0, Neptune ML chooses the volume size automatically based on the data size.

iv_processingtmoutinseconds TYPE /AWS1/NEDINTEGER /AWS1/NEDINTEGER

Timeout in seconds for the data processing job. The default is 86,400 (1 day).

iv_modeltype TYPE /AWS1/NEDSTRING /AWS1/NEDSTRING

One of the two model types that Neptune ML currently supports: heterogeneous graph models (heterogeneous), and knowledge graph (kge). The default is none. If not specified, Neptune ML chooses the model type automatically based on the data.

iv_configfilename TYPE /AWS1/NEDSTRING /AWS1/NEDSTRING

A data specification file that describes how to load the exported graph data for training. The file is automatically generated by the Neptune export toolkit. The default is training-data-configuration.json.

it_subnets TYPE /AWS1/CL_NEDSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST

The IDs of the subnets in the Neptune VPC. The default is None.

it_securitygroupids TYPE /AWS1/CL_NEDSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST

The VPC security group IDs. The default is None.

iv_volumeencryptionkmskey TYPE /AWS1/NEDSTRING /AWS1/NEDSTRING

The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.

iv_s3outputencryptionkmskey TYPE /AWS1/NEDSTRING /AWS1/NEDSTRING

The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.

RETURNING

oo_output TYPE REF TO /aws1/cl_nedstrtmldataprocin01 /AWS1/CL_NEDSTRTMLDATAPROCIN01

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->startmldataprocessingjob(
  it_securitygroupids = VALUE /aws1/cl_nedstringlist_w=>tt_stringlist(
    ( new /aws1/cl_nedstringlist_w( |string| ) )
  )
  it_subnets = VALUE /aws1/cl_nedstringlist_w=>tt_stringlist(
    ( new /aws1/cl_nedstringlist_w( |string| ) )
  )
  iv_configfilename = |string|
  iv_id = |string|
  iv_inputdatas3location = |string|
  iv_modeltype = |string|
  iv_neptuneiamrolearn = |string|
  iv_previousdataprocingjobid = |string|
  iv_processeddatas3location = |string|
  iv_processinginstancetype = |string|
  iv_processingtmoutinseconds = 123
  iv_procinginstvolumesizeingb = 123
  iv_s3outputencryptionkmskey = |string|
  iv_sagemakeriamrolearn = |string|
  iv_volumeencryptionkmskey = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_id( ).
  lv_string = lo_result->get_arn( ).
  lv_long = lo_result->get_creationtimeinmillis( ).
ENDIF.