Skip to content

/AWS1/IF_QQB=>LISTDATASOURCESYNCJOBS()

About ListDataSourceSyncJobs

Get information about an Amazon Q Business data source connector synchronization.

Method Signature

METHODS /AWS1/IF_QQB~LISTDATASOURCESYNCJOBS
  IMPORTING
    !IV_DATASOURCEID TYPE /AWS1/QQBDATASOURCEID OPTIONAL
    !IV_APPLICATIONID TYPE /AWS1/QQBAPPLICATIONID OPTIONAL
    !IV_INDEXID TYPE /AWS1/QQBINDEXID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/QQBNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/QQBMAXRSSINTEGERFORLST01 OPTIONAL
    !IV_STARTTIME TYPE /AWS1/QQBTIMESTAMP OPTIONAL
    !IV_ENDTIME TYPE /AWS1/QQBTIMESTAMP OPTIONAL
    !IV_STATUSFILTER TYPE /AWS1/QQBDATASRCSYNCJOBSTATUS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqblstdatasrcsyncjo01
  RAISING
    /AWS1/CX_QQBACCESSDENIEDEX
    /AWS1/CX_QQBCONFLICTEXCEPTION
    /AWS1/CX_QQBINTERNALSERVEREX
    /AWS1/CX_QQBRESOURCENOTFOUNDEX
    /AWS1/CX_QQBTHROTTLINGEX
    /AWS1/CX_QQBVALIDATIONEX
    /AWS1/CX_QQBCLIENTEXC
    /AWS1/CX_QQBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_datasourceid TYPE /AWS1/QQBDATASOURCEID /AWS1/QQBDATASOURCEID

The identifier of the data source connector.

iv_applicationid TYPE /AWS1/QQBAPPLICATIONID /AWS1/QQBAPPLICATIONID

The identifier of the Amazon Q Business application connected to the data source.

iv_indexid TYPE /AWS1/QQBINDEXID /AWS1/QQBINDEXID

The identifier of the index used with the Amazon Q Business data source connector.

Optional arguments:

iv_nexttoken TYPE /AWS1/QQBNEXTTOKEN /AWS1/QQBNEXTTOKEN

If the maxResults response was incpmplete because there is more data to retriever, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.

iv_maxresults TYPE /AWS1/QQBMAXRSSINTEGERFORLST01 /AWS1/QQBMAXRSSINTEGERFORLST01

The maximum number of synchronization jobs to return in the response.

iv_starttime TYPE /AWS1/QQBTIMESTAMP /AWS1/QQBTIMESTAMP

The start time of the data source connector sync.

iv_endtime TYPE /AWS1/QQBTIMESTAMP /AWS1/QQBTIMESTAMP

The end time of the data source connector sync.

iv_statusfilter TYPE /AWS1/QQBDATASRCSYNCJOBSTATUS /AWS1/QQBDATASRCSYNCJOBSTATUS

Only returns synchronization jobs with the Status field equal to the specified status.

RETURNING

oo_output TYPE REF TO /aws1/cl_qqblstdatasrcsyncjo01 /AWS1/CL_QQBLSTDATASRCSYNCJO01

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->listdatasourcesyncjobs(
  iv_applicationid = |string|
  iv_datasourceid = |string|
  iv_endtime = '20150101000000.0000000'
  iv_indexid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_starttime = '20150101000000.0000000'
  iv_statusfilter = |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_history( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_executionid = lo_row_1->get_executionid( ).
      lv_timestamp = lo_row_1->get_starttime( ).
      lv_timestamp = lo_row_1->get_endtime( ).
      lv_datasourcesyncjobstatus = lo_row_1->get_status( ).
      lo_errordetail = lo_row_1->get_error( ).
      IF lo_errordetail IS NOT INITIAL.
        lv_errormessage = lo_errordetail->get_errormessage( ).
        lv_errorcode = lo_errordetail->get_errorcode( ).
      ENDIF.
      lv_string = lo_row_1->get_datasourceerrorcode( ).
      lo_datasourcesyncjobmetric = lo_row_1->get_metrics( ).
      IF lo_datasourcesyncjobmetric IS NOT INITIAL.
        lv_metricvalue = lo_datasourcesyncjobmetric->get_documentsadded( ).
        lv_metricvalue = lo_datasourcesyncjobmetric->get_documentsmodified( ).
        lv_metricvalue = lo_datasourcesyncjobmetric->get_documentsdeleted( ).
        lv_metricvalue = lo_datasourcesyncjobmetric->get_documentsfailed( ).
        lv_metricvalue = lo_datasourcesyncjobmetric->get_documentsscanned( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.