Skip to content

/AWS1/IF_AMB=>LISTBACKENDJOBS()

About ListBackendJobs

Lists the jobs for the backend of an Amplify app.

Method Signature

METHODS /AWS1/IF_AMB~LISTBACKENDJOBS
  IMPORTING
    !IV_APPID TYPE /AWS1/AMB__STRING OPTIONAL
    !IV_BACKENDENVIRONMENTNAME TYPE /AWS1/AMB__STRING OPTIONAL
    !IV_JOBID TYPE /AWS1/AMB__STRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/AMB__INTEGERMIN1MAX25 OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/AMB__STRING OPTIONAL
    !IV_OPERATION TYPE /AWS1/AMB__STRING OPTIONAL
    !IV_STATUS TYPE /AWS1/AMB__STRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_amblistbackendjobsrsp
  RAISING
    /AWS1/CX_AMBBADREQUESTEX
    /AWS1/CX_AMBGATEWAYTIMEOUTEX
    /AWS1/CX_AMBNOTFOUNDEXCEPTION
    /AWS1/CX_AMBTOOMANYREQUESTSEX
    /AWS1/CX_AMBCLIENTEXC
    /AWS1/CX_AMBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_appid TYPE /AWS1/AMB__STRING /AWS1/AMB__STRING

The app ID.

iv_backendenvironmentname TYPE /AWS1/AMB__STRING /AWS1/AMB__STRING

The name of the backend environment.

Optional arguments:

iv_jobid TYPE /AWS1/AMB__STRING /AWS1/AMB__STRING

The ID for the job.

iv_maxresults TYPE /AWS1/AMB__INTEGERMIN1MAX25 /AWS1/AMB__INTEGERMIN1MAX25

The maximum number of results that you want in the response.

iv_nexttoken TYPE /AWS1/AMB__STRING /AWS1/AMB__STRING

The token for the next set of results.

iv_operation TYPE /AWS1/AMB__STRING /AWS1/AMB__STRING

Filters the list of response objects to include only those with the specified operation name.

iv_status TYPE /AWS1/AMB__STRING /AWS1/AMB__STRING

Filters the list of response objects to include only those with the specified status.

RETURNING

oo_output TYPE REF TO /aws1/cl_amblistbackendjobsrsp /AWS1/CL_AMBLISTBACKENDJOBSRSP

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->listbackendjobs(
  iv_appid = |string|
  iv_backendenvironmentname = |string|
  iv_jobid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_operation = |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___string = lo_row_1->get_appid( ).
      lv___string = lo_row_1->get_backendenvironmentname( ).
      lv___string = lo_row_1->get_createtime( ).
      lv___string = lo_row_1->get_error( ).
      lv___string = lo_row_1->get_jobid( ).
      lv___string = lo_row_1->get_operation( ).
      lv___string = lo_row_1->get_status( ).
      lv___string = lo_row_1->get_updatetime( ).
    ENDIF.
  ENDLOOP.
  lv___string = lo_result->get_nexttoken( ).
ENDIF.