Skip to content

/AWS1/CL_CPD=>STARTDOCCLASSIFICATIONJOB()

About StartDocumentClassificationJob

Starts an asynchronous document classification job using a custom classification model. Use the DescribeDocumentClassificationJob operation to track the progress of the job.

Method Signature

IMPORTING

Required arguments:

io_inputdataconfig TYPE REF TO /AWS1/CL_CPDINPUTDATACONFIG /AWS1/CL_CPDINPUTDATACONFIG

Specifies the format and location of the input data for the job.

io_outputdataconfig TYPE REF TO /AWS1/CL_CPDOUTPUTDATACONFIG /AWS1/CL_CPDOUTPUTDATACONFIG

Specifies where to send the output files.

iv_dataaccessrolearn TYPE /AWS1/CPDIAMROLEARN /AWS1/CPDIAMROLEARN

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

Optional arguments:

iv_jobname TYPE /AWS1/CPDJOBNAME /AWS1/CPDJOBNAME

The identifier of the job.

iv_documentclassifierarn TYPE /AWS1/CPDDOCUMENTCLASSIFIERARN /AWS1/CPDDOCUMENTCLASSIFIERARN

The Amazon Resource Name (ARN) of the document classifier to use to process the job.

iv_clientrequesttoken TYPE /AWS1/CPDCLIENTREQTOKENSTRING /AWS1/CPDCLIENTREQTOKENSTRING

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

iv_volumekmskeyid TYPE /AWS1/CPDKMSKEYID /AWS1/CPDKMSKEYID

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

io_vpcconfig TYPE REF TO /AWS1/CL_CPDVPCCONFIG /AWS1/CL_CPDVPCCONFIG

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

it_tags TYPE /AWS1/CL_CPDTAG=>TT_TAGLIST TT_TAGLIST

Tags to associate with the document classification job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

iv_flywheelarn TYPE /AWS1/CPDCOMPREHENDFLYWHEELARN /AWS1/CPDCOMPREHENDFLYWHEELARN

The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

RETURNING

oo_output TYPE REF TO /aws1/cl_cpdstrtdocclificati01 /AWS1/CL_CPDSTRTDOCCLIFICATI01

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_cpd~startdocclassificationjob(
  io_inputdataconfig = new /aws1/cl_cpdinputdataconfig(
    io_documentreaderconfig = new /aws1/cl_cpddocreaderconfig(
      it_featuretypes = VALUE /aws1/cl_cpdlstofdocreadftty00=>tt_listofdocreadfeaturetypes(
        ( new /aws1/cl_cpdlstofdocreadftty00( |string| ) )
      )
      iv_documentreadaction = |string|
      iv_documentreadmode = |string|
    )
    iv_inputformat = |string|
    iv_s3uri = |string|
  )
  io_outputdataconfig = new /aws1/cl_cpdoutputdataconfig(
    iv_kmskeyid = |string|
    iv_s3uri = |string|
  )
  io_vpcconfig = new /aws1/cl_cpdvpcconfig(
    it_securitygroupids = VALUE /aws1/cl_cpdsecuritygroupids_w=>tt_securitygroupids(
      ( new /aws1/cl_cpdsecuritygroupids_w( |string| ) )
    )
    it_subnets = VALUE /aws1/cl_cpdsubnets_w=>tt_subnets(
      ( new /aws1/cl_cpdsubnets_w( |string| ) )
    )
  )
  it_tags = VALUE /aws1/cl_cpdtag=>tt_taglist(
    (
      new /aws1/cl_cpdtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_clientrequesttoken = |string|
  iv_dataaccessrolearn = |string|
  iv_documentclassifierarn = |string|
  iv_flywheelarn = |string|
  iv_jobname = |string|
  iv_volumekmskeyid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_jobid = lo_result->get_jobid( ).
  lv_comprehendarn = lo_result->get_jobarn( ).
  lv_jobstatus = lo_result->get_jobstatus( ).
  lv_documentclassifierarn = lo_result->get_documentclassifierarn( ).
ENDIF.