Skip to content

/AWS1/IF_KND=>LISTDATASOURCESYNCJOBS()

About ListDataSourceSyncJobs

Gets statistics about synchronizing a data source connector.

Method Signature

METHODS /AWS1/IF_KND~LISTDATASOURCESYNCJOBS
  IMPORTING
    !IV_ID TYPE /AWS1/KNDDATASOURCEID OPTIONAL
    !IV_INDEXID TYPE /AWS1/KNDINDEXID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/KNDNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/KNDMAXRSSINTEGERFORLST02 OPTIONAL
    !IO_STARTTIMEFILTER TYPE REF TO /AWS1/CL_KNDTIMERANGE OPTIONAL
    !IV_STATUSFILTER TYPE /AWS1/KNDDATASRCSYNCJOBSTATUS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_kndlstdatasrcsyncjo01
  RAISING
    /AWS1/CX_KNDACCESSDENIEDEX
    /AWS1/CX_KNDCONFLICTEXCEPTION
    /AWS1/CX_KNDINTERNALSERVEREX
    /AWS1/CX_KNDRESOURCENOTFOUNDEX
    /AWS1/CX_KNDTHROTTLINGEX
    /AWS1/CX_KNDVALIDATIONEX
    /AWS1/CX_KNDCLIENTEXC
    /AWS1/CX_KNDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_id TYPE /AWS1/KNDDATASOURCEID /AWS1/KNDDATASOURCEID

The identifier of the data source connector.

iv_indexid TYPE /AWS1/KNDINDEXID /AWS1/KNDINDEXID

The identifier of the index used with the data source connector.

Optional arguments:

iv_nexttoken TYPE /AWS1/KNDNEXTTOKEN /AWS1/KNDNEXTTOKEN

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.

iv_maxresults TYPE /AWS1/KNDMAXRSSINTEGERFORLST02 /AWS1/KNDMAXRSSINTEGERFORLST02

The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

io_starttimefilter TYPE REF TO /AWS1/CL_KNDTIMERANGE /AWS1/CL_KNDTIMERANGE

When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

iv_statusfilter TYPE /AWS1/KNDDATASRCSYNCJOBSTATUS /AWS1/KNDDATASRCSYNCJOBSTATUS

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

RETURNING

oo_output TYPE REF TO /aws1/cl_kndlstdatasrcsyncjo01 /AWS1/CL_KNDLSTDATASRCSYNCJO01

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(
  io_starttimefilter = new /aws1/cl_kndtimerange(
    iv_endtime = '20150101000000.0000000'
    iv_starttime = '20150101000000.0000000'
  )
  iv_id = |string|
  iv_indexid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  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_string = 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( ).
      lv_errormessage = lo_row_1->get_errormessage( ).
      lv_errorcode = lo_row_1->get_errorcode( ).
      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.