Skip to content

/AWS1/IF_BDK=>LISTMODELINVOCATIONJOBS()

About ListModelInvocationJobs

Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.

Method Signature

METHODS /AWS1/IF_BDK~LISTMODELINVOCATIONJOBS
  IMPORTING
    !IV_SUBMITTIMEAFTER TYPE /AWS1/BDKTIMESTAMP OPTIONAL
    !IV_SUBMITTIMEBEFORE TYPE /AWS1/BDKTIMESTAMP OPTIONAL
    !IV_STATUSEQUALS TYPE /AWS1/BDKMODELINVCJOBSTATUS OPTIONAL
    !IV_NAMECONTAINS TYPE /AWS1/BDKMODELINVCJOBNAME OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BDKMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BDKPAGINATIONTOKEN OPTIONAL
    !IV_SORTBY TYPE /AWS1/BDKSORTJOBSBY OPTIONAL
    !IV_SORTORDER TYPE /AWS1/BDKSORTORDER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdklstmdelinvcjobsrsp
  RAISING
    /AWS1/CX_BDKACCESSDENIEDEX
    /AWS1/CX_BDKINTERNALSERVEREX
    /AWS1/CX_BDKTHROTTLINGEX
    /AWS1/CX_BDKVALIDATIONEX
    /AWS1/CX_BDKCLIENTEXC
    /AWS1/CX_BDKSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_submittimeafter TYPE /AWS1/BDKTIMESTAMP /AWS1/BDKTIMESTAMP

Specify a time to filter for batch inference jobs that were submitted after the time you specify.

iv_submittimebefore TYPE /AWS1/BDKTIMESTAMP /AWS1/BDKTIMESTAMP

Specify a time to filter for batch inference jobs that were submitted before the time you specify.

iv_statusequals TYPE /AWS1/BDKMODELINVCJOBSTATUS /AWS1/BDKMODELINVCJOBSTATUS

Specify a status to filter for batch inference jobs whose statuses match the string you specify.

The following statuses are possible:

  • Submitted – This job has been submitted to a queue for validation.

  • Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:

    • Your IAM service role has access to the Amazon S3 buckets containing your files.

    • Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the modelInput value matches the request body for the model.

    • Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.

  • Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.

  • Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.

  • InProgress – This job has begun. You can start viewing the results in the output S3 location.

  • Completed – This job has successfully completed. View the output files in the output S3 location.

  • PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.

  • Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web Services Support Center.

  • Stopped – This job was stopped by a user.

  • Stopping – This job is being stopped by a user.

iv_namecontains TYPE /AWS1/BDKMODELINVCJOBNAME /AWS1/BDKMODELINVCJOBNAME

Specify a string to filter for batch inference jobs whose names contain the string.

iv_maxresults TYPE /AWS1/BDKMAXRESULTS /AWS1/BDKMAXRESULTS

The maximum number of results to return. If there are more results than the number that you specify, a nextToken value is returned. Use the nextToken in a request to return the next batch of results.

iv_nexttoken TYPE /AWS1/BDKPAGINATIONTOKEN /AWS1/BDKPAGINATIONTOKEN

If there were more results than the value you specified in the maxResults field in a previous ListModelInvocationJobs request, the response would have returned a nextToken value. To see the next batch of results, send the nextToken value in another request.

iv_sortby TYPE /AWS1/BDKSORTJOBSBY /AWS1/BDKSORTJOBSBY

An attribute by which to sort the results.

iv_sortorder TYPE /AWS1/BDKSORTORDER /AWS1/BDKSORTORDER

Specifies whether to sort the results by ascending or descending order.

RETURNING

oo_output TYPE REF TO /aws1/cl_bdklstmdelinvcjobsrsp /AWS1/CL_BDKLSTMDELINVCJOBSRSP

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->listmodelinvocationjobs(
  iv_maxresults = 123
  iv_namecontains = |string|
  iv_nexttoken = |string|
  iv_sortby = |string|
  iv_sortorder = |string|
  iv_statusequals = |string|
  iv_submittimeafter = '20150101000000.0000000'
  iv_submittimebefore = '20150101000000.0000000'
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_paginationtoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_invocationjobsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_modelinvocationjobarn = lo_row_1->get_jobarn( ).
      lv_modelinvocationjobname = lo_row_1->get_jobname( ).
      lv_modelid = lo_row_1->get_modelid( ).
      lv_modelinvocationidempote = lo_row_1->get_clientrequesttoken( ).
      lv_rolearn = lo_row_1->get_rolearn( ).
      lv_modelinvocationjobstatu = lo_row_1->get_status( ).
      lv_message = lo_row_1->get_message( ).
      lv_timestamp = lo_row_1->get_submittime( ).
      lv_timestamp = lo_row_1->get_lastmodifiedtime( ).
      lv_timestamp = lo_row_1->get_endtime( ).
      lo_modelinvocationjobinput = lo_row_1->get_inputdataconfig( ).
      IF lo_modelinvocationjobinput IS NOT INITIAL.
        lo_modelinvocationjobs3inp = lo_modelinvocationjobinput->get_s3inputdataconfig( ).
        IF lo_modelinvocationjobs3inp IS NOT INITIAL.
          lv_s3inputformat = lo_modelinvocationjobs3inp->get_s3inputformat( ).
          lv_s3uri = lo_modelinvocationjobs3inp->get_s3uri( ).
          lv_accountid = lo_modelinvocationjobs3inp->get_s3bucketowner( ).
        ENDIF.
      ENDIF.
      lo_modelinvocationjoboutpu = lo_row_1->get_outputdataconfig( ).
      IF lo_modelinvocationjoboutpu IS NOT INITIAL.
        lo_modelinvocationjobs3out = lo_modelinvocationjoboutpu->get_s3outputdataconfig( ).
        IF lo_modelinvocationjobs3out IS NOT INITIAL.
          lv_s3uri = lo_modelinvocationjobs3out->get_s3uri( ).
          lv_kmskeyid = lo_modelinvocationjobs3out->get_s3encryptionkeyid( ).
          lv_accountid = lo_modelinvocationjobs3out->get_s3bucketowner( ).
        ENDIF.
      ENDIF.
      lo_vpcconfig = lo_row_1->get_vpcconfig( ).
      IF lo_vpcconfig IS NOT INITIAL.
        LOOP AT lo_vpcconfig->get_subnetids( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_subnetid = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_vpcconfig->get_securitygroupids( ) into lo_row_4.
          lo_row_5 = lo_row_4.
          IF lo_row_5 IS NOT INITIAL.
            lv_securitygroupid = lo_row_5->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lv_modelinvocationjobtimeo = lo_row_1->get_timeoutdurationinhours( ).
      lv_timestamp = lo_row_1->get_jobexpirationtime( ).
    ENDIF.
  ENDLOOP.
ENDIF.