/AWS1/IF_QQB=>STARTDATASOURCESYNCJOB()

About StartDataSourceSyncJob

Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException.

Method Signature

METHODS /AWS1/IF_QQB~STARTDATASOURCESYNCJOB
  IMPORTING
    !IV_DATASOURCEID TYPE /AWS1/QQBDATASOURCEID OPTIONAL
    !IV_APPLICATIONID TYPE /AWS1/QQBAPPLICATIONID OPTIONAL
    !IV_INDEXID TYPE /AWS1/QQBINDEXID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqbstrtdatasrcsyncj01
  RAISING
    /AWS1/CX_QQBACCESSDENIEDEX
    /AWS1/CX_QQBCONFLICTEXCEPTION
    /AWS1/CX_QQBINTERNALSERVEREX
    /AWS1/CX_QQBRESOURCENOTFOUNDEX
    /AWS1/CX_QQBSERVICEQUOTAEXCDEX
    /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 Amazon Q Business application the data source is connected to.

iv_indexid TYPE /AWS1/QQBINDEXID /AWS1/QQBINDEXID

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

RETURNING

oo_output TYPE REF TO /aws1/cl_qqbstrtdatasrcsyncj01 /AWS1/CL_QQBSTRTDATASRCSYNCJ01

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->startdatasourcesyncjob(
  iv_applicationid = |string|
  iv_datasourceid = |string|
  iv_indexid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_executionid = lo_result->get_executionid( ).
ENDIF.