LISTJOBS()`¶

About ListJobs¶

Retrieves a paginated list of the asynchronous jobs in your account. You can filter the results by status, brand profile, or operation type.

Method Signature¶

METHODS /AWS1/IF_PPU~LISTJOBS
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/PPUMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/PPUNEXTTOKEN OPTIONAL
    !IV_STATUS TYPE /AWS1/PPUJOBSTATUS OPTIONAL
    !IV_BRANDPROFILEID TYPE /AWS1/PPUBRANDPROFILEIDORARN OPTIONAL
    !IV_OPERATIONTYPE TYPE /AWS1/PPUJOBOPERATIONTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ppulistjobsoutput
  RAISING
    /AWS1/CX_PPUACCESSDENIEDEX
    /AWS1/CX_PPUINTERNALSERVEREX
    /AWS1/CX_PPUTHROTTLINGEX
    /AWS1/CX_PPUVLDTNEXCEPTION
    /AWS1/CX_PPUCLIENTEXC
    /AWS1/CX_PPUSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/PPUMAXRESULTS` `/AWS1/PPUMAXRESULTS`¶

The maximum number of results to return per page.

`iv_nexttoken` `TYPE /AWS1/PPUNEXTTOKEN` `/AWS1/PPUNEXTTOKEN`¶

The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.

`iv_status` `TYPE /AWS1/PPUJOBSTATUS` `/AWS1/PPUJOBSTATUS`¶

Filters the results to jobs that have the specified status.

`iv_brandprofileid` `TYPE /AWS1/PPUBRANDPROFILEIDORARN` `/AWS1/PPUBRANDPROFILEIDORARN`¶

Filters the results to jobs for the specified brand profile.

`iv_operationtype` `TYPE /AWS1/PPUJOBOPERATIONTYPE` `/AWS1/PPUJOBOPERATIONTYPE`¶

Filters the results to jobs of the specified operation type.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ppulistjobsoutput` `/AWS1/CL_PPULISTJOBSOUTPUT`¶

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->listjobs(
  iv_brandprofileid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_operationtype = |string|
  iv_status = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_jobs( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_jobid = lo_row_1->get_jobid( ).
      lv_jobstatus = lo_row_1->get_status( ).
      lv_joboperationtype = lo_row_1->get_operationtype( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_updatedat( ).
      lv_brandprofileidorarn = lo_row_1->get_brandprofileid( ).
      lv_joberrorcode = lo_row_1->get_errorcode( ).
      lv_joberrormessage = lo_row_1->get_errormessage( ).
      LOOP AT lo_row_1->get_resources( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_jobresourcetype = lo_row_3->get_resourcetype( ).
          lv_jobresourceid = lo_row_3->get_resourceid( ).
          lv_amazonresourcename = lo_row_3->get_resourcearn( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

List async jobs¶

List async jobs

DATA(lo_result) = lo_client->listjobs(
  iv_maxresults = 10
  iv_status = |SUCCESS|
).

/AWS1/IF_PPU=>LISTJOBS()¶