BATCHDELETEDOCUMENT()`¶

About BatchDeleteDocument¶

Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API.

The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of deleting your documents.

Deleting documents from an index using BatchDeleteDocument could take up to an hour or more, depending on the number of documents you want to delete.

Method Signature¶

METHODS /AWS1/IF_KND~BATCHDELETEDOCUMENT
  IMPORTING
    !IV_INDEXID TYPE /AWS1/KNDINDEXID OPTIONAL
    !IT_DOCUMENTIDLIST TYPE /AWS1/CL_KNDDOCUMENTIDLIST_W=>TT_DOCUMENTIDLIST OPTIONAL
    !IO_DATASRCSYNCJOBMETRICTGT TYPE REF TO /AWS1/CL_KNDDATASRCSYNCJOBME00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_kndbatchdeletedocrsp
  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_indexid` `TYPE /AWS1/KNDINDEXID` `/AWS1/KNDINDEXID`¶

The identifier of the index that contains the documents to delete.

`it_documentidlist` `TYPE /AWS1/CL_KNDDOCUMENTIDLIST_W=>TT_DOCUMENTIDLIST` `TT_DOCUMENTIDLIST`¶

One or more identifiers for documents to delete from the index.

Optional arguments:¶

`io_datasrcsyncjobmetrictgt` `TYPE REF TO /AWS1/CL_KNDDATASRCSYNCJOBME00` `/AWS1/CL_KNDDATASRCSYNCJOBME00`¶

DataSourceSyncJobMetricTarget

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_kndbatchdeletedocrsp` `/AWS1/CL_KNDBATCHDELETEDOCRSP`¶

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->batchdeletedocument(
  io_datasrcsyncjobmetrictgt = new /aws1/cl_knddatasrcsyncjobme00(
    iv_datasourceid = |string|
    iv_datasourcesyncjobid = |string|
  )
  it_documentidlist = VALUE /aws1/cl_knddocumentidlist_w=>tt_documentidlist(
    ( new /aws1/cl_knddocumentidlist_w( |string| ) )
  )
  iv_indexid = |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_faileddocuments( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_documentid = lo_row_1->get_id( ).
      lv_datasourceid = lo_row_1->get_datasourceid( ).
      lv_errorcode = lo_row_1->get_errorcode( ).
      lv_errormessage = lo_row_1->get_errormessage( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_KND=>BATCHDELETEDOCUMENT()¶