STARTMEDIAANALYSISJOB()`¶

About StartMediaAnalysisJob¶

Initiates a new media analysis job. Accepts a manifest file in an Amazon S3 bucket. The output is a manifest file and a summary of the manifest stored in the Amazon S3 bucket.

Method Signature¶

METHODS /AWS1/IF_REK~STARTMEDIAANALYSISJOB
  IMPORTING
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/REKCLIENTREQUESTTOKEN OPTIONAL
    !IV_JOBNAME TYPE /AWS1/REKMEDIAANALYSISJOBNAME OPTIONAL
    !IO_OPERATIONSCONFIG TYPE REF TO /AWS1/CL_REKMEDIAALYOPSCONFIG OPTIONAL
    !IO_INPUT TYPE REF TO /AWS1/CL_REKMEDIAANALYSISINPUT OPTIONAL
    !IO_OUTPUTCONFIG TYPE REF TO /AWS1/CL_REKMEDIAALYOUTPUTCFG OPTIONAL
    !IV_KMSKEYID TYPE /AWS1/REKKMSKEYID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rekstrtmediaalyjobrsp
  RAISING
    /AWS1/CX_REKACCESSDENIEDEX
    /AWS1/CX_REKIDEMPOTENTPRMMIS00
    /AWS1/CX_REKINTERNALSERVERERR
    /AWS1/CX_REKINVALIDMANIFESTEX
    /AWS1/CX_REKINVALIDPARAMETEREX
    /AWS1/CX_REKINVALIDS3OBJECTEX
    /AWS1/CX_REKLIMITEXCEEDEDEX
    /AWS1/CX_REKPROVTHRUPUTEXCDEX
    /AWS1/CX_REKRESOURCENOTFOUNDEX
    /AWS1/CX_REKRESOURCENOTREADYEX
    /AWS1/CX_REKTHROTTLINGEX
    /AWS1/CX_REKCLIENTEXC
    /AWS1/CX_REKSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`io_operationsconfig` `TYPE REF TO /AWS1/CL_REKMEDIAALYOPSCONFIG` `/AWS1/CL_REKMEDIAALYOPSCONFIG`¶

Configuration options for the media analysis job to be created.

`io_input` `TYPE REF TO /AWS1/CL_REKMEDIAANALYSISINPUT` `/AWS1/CL_REKMEDIAANALYSISINPUT`¶

Input data to be analyzed by the job.

`io_outputconfig` `TYPE REF TO /AWS1/CL_REKMEDIAALYOUTPUTCFG` `/AWS1/CL_REKMEDIAALYOUTPUTCFG`¶

The Amazon S3 bucket location to store the results.

Optional arguments:¶

`iv_clientrequesttoken` `TYPE /AWS1/REKCLIENTREQUESTTOKEN` `/AWS1/REKCLIENTREQUESTTOKEN`¶

Idempotency token used to prevent the accidental creation of duplicate versions. If you use the same token with multiple StartMediaAnalysisJobRequest requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

`iv_jobname` `TYPE /AWS1/REKMEDIAANALYSISJOBNAME` `/AWS1/REKMEDIAANALYSISJOBNAME`¶

The name of the job. Does not have to be unique.

`iv_kmskeyid` `TYPE /AWS1/REKKMSKEYID` `/AWS1/REKKMSKEYID`¶

The identifier of customer managed AWS KMS key (name or ARN). The key is used to encrypt images copied into the service. The key is also used to encrypt results and manifest files written to the output Amazon S3 bucket.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_rekstrtmediaalyjobrsp` `/AWS1/CL_REKSTRTMEDIAALYJOBRSP`¶

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->startmediaanalysisjob(
  io_input = new /aws1/cl_rekmediaanalysisinput(
    io_s3object = new /aws1/cl_reks3object(
      iv_bucket = |string|
      iv_name = |string|
      iv_version = |string|
    )
  )
  io_operationsconfig = new /aws1/cl_rekmediaalyopsconfig(
    io_detectmoderationlabels00 = new /aws1/cl_rekmediaalydetectmd00(
      iv_minconfidence = '0.1'
      iv_projectversion = |string|
    )
  )
  io_outputconfig = new /aws1/cl_rekmediaalyoutputcfg(
    iv_s3bucket = |string|
    iv_s3keyprefix = |string|
  )
  iv_clientrequesttoken = |string|
  iv_jobname = |string|
  iv_kmskeyid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_mediaanalysisjobid = lo_result->get_jobid( ).
ENDIF.

StartMediaAnalysisJob¶

Initiates a new media analysis job.

DATA(lo_result) = lo_client->startmediaanalysisjob(
  io_input = new /aws1/cl_rekmediaanalysisinput(
    io_s3object = new /aws1/cl_reks3object(
      iv_bucket = |input-bucket|
      iv_name = |input-manifest.json|
    )
  )
  io_operationsconfig = new /aws1/cl_rekmediaalyopsconfig(
    io_detectmoderationlabels00 = new /aws1/cl_rekmediaalydetectmd00(
      iv_minconfidence = '50'
      iv_projectversion = |arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958|
    )
  )
  io_outputconfig = new /aws1/cl_rekmediaalyoutputcfg(
    iv_s3bucket = |output-bucket|
    iv_s3keyprefix = |output-location|
  )
  iv_jobname = |job-name|
).

/AWS1/IF_REK=>STARTMEDIAANALYSISJOB()¶