/AWS1/IF_PZZ=>CREATEBATCHSEGMENTJOB()

About CreateBatchSegmentJob

Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Getting batch recommendations and user segments.

Method Signature

METHODS /AWS1/IF_PZZ~CREATEBATCHSEGMENTJOB
  IMPORTING
    !IV_JOBNAME TYPE /AWS1/PZZNAME OPTIONAL
    !IV_SOLUTIONVERSIONARN TYPE /AWS1/PZZARN OPTIONAL
    !IV_FILTERARN TYPE /AWS1/PZZARN OPTIONAL
    !IV_NUMRESULTS TYPE /AWS1/PZZNUMBATCHRESULTS OPTIONAL
    !IO_JOBINPUT TYPE REF TO /AWS1/CL_PZZBATCHSEGMENTJOBINP OPTIONAL
    !IO_JOBOUTPUT TYPE REF TO /AWS1/CL_PZZBATCHSEGMENTJOBOUT OPTIONAL
    !IV_ROLEARN TYPE /AWS1/PZZROLEARN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_PZZTAG=>TT_TAGS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_pzzcrebtcsegmentjob01
  RAISING
    /AWS1/CX_PZZINVALIDINPUTEX
    /AWS1/CX_PZZLIMITEXCEEDEDEX
    /AWS1/CX_PZZRESRCALRDYEXISTSEX
    /AWS1/CX_PZZRESOURCEINUSEEX
    /AWS1/CX_PZZRESOURCENOTFOUNDEX
    /AWS1/CX_PZZTOOMANYTAGSEX
    /AWS1/CX_PZZCLIENTEXC
    /AWS1/CX_PZZSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_jobname TYPE /AWS1/PZZNAME /AWS1/PZZNAME

The name of the batch segment job to create.

iv_solutionversionarn TYPE /AWS1/PZZARN /AWS1/PZZARN

The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.

io_jobinput TYPE REF TO /AWS1/CL_PZZBATCHSEGMENTJOBINP /AWS1/CL_PZZBATCHSEGMENTJOBINP

The Amazon S3 path for the input data used to generate the batch segment job.

io_joboutput TYPE REF TO /AWS1/CL_PZZBATCHSEGMENTJOBOUT /AWS1/CL_PZZBATCHSEGMENTJOBOUT

The Amazon S3 path for the bucket where the job's output will be stored.

iv_rolearn TYPE /AWS1/PZZROLEARN /AWS1/PZZROLEARN

The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.

Optional arguments:

iv_filterarn TYPE /AWS1/PZZARN /AWS1/PZZARN

The ARN of the filter to apply to the batch segment job. For more information on using filters, see Filtering batch recommendations.

iv_numresults TYPE /AWS1/PZZNUMBATCHRESULTS /AWS1/PZZNUMBATCHRESULTS

The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.

it_tags TYPE /AWS1/CL_PZZTAG=>TT_TAGS TT_TAGS

A list of tags to apply to the batch segment job.

RETURNING

oo_output TYPE REF TO /aws1/cl_pzzcrebtcsegmentjob01 /AWS1/CL_PZZCREBTCSEGMENTJOB01

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->createbatchsegmentjob(
  io_jobinput = new /aws1/cl_pzzbatchsegmentjobinp(
    io_s3datasource = new /aws1/cl_pzzs3dataconfig(
      iv_kmskeyarn = |string|
      iv_path = |string|
    )
  )
  io_joboutput = new /aws1/cl_pzzbatchsegmentjobout(
    io_s3datadestination = new /aws1/cl_pzzs3dataconfig(
      iv_kmskeyarn = |string|
      iv_path = |string|
    )
  )
  it_tags = VALUE /aws1/cl_pzztag=>tt_tags(
    (
      new /aws1/cl_pzztag(
        iv_tagkey = |string|
        iv_tagvalue = |string|
      )
    )
  )
  iv_filterarn = |string|
  iv_jobname = |string|
  iv_numresults = 123
  iv_rolearn = |string|
  iv_solutionversionarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_batchsegmentjobarn( ).
ENDIF.