/AWS1/IF_KND=>BATCHGETDOCUMENTSTATUS()

About BatchGetDocumentStatus

Returns the indexing status for one or more documents submitted with the BatchPutDocument API.

When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the BatchGetDocumentStatus API to get the current status of a list of documents so that you can determine if they have been successfully indexed.

You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.

Method Signature

METHODS /AWS1/IF_KND~BATCHGETDOCUMENTSTATUS
  IMPORTING
    !IV_INDEXID TYPE /AWS1/KNDINDEXID OPTIONAL
    !IT_DOCUMENTINFOLIST TYPE /AWS1/CL_KNDDOCUMENTINFO=>TT_DOCUMENTINFOLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_kndbatchgetdocstatrsp
  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 to add documents to. The index ID is returned by the CreateIndex API.

it_documentinfolist TYPE /AWS1/CL_KNDDOCUMENTINFO=>TT_DOCUMENTINFOLIST TT_DOCUMENTINFOLIST

A list of DocumentInfo objects that identify the documents for which to get the status. You identify the documents by their document ID and optional attributes.

RETURNING

oo_output TYPE REF TO /aws1/cl_kndbatchgetdocstatrsp /AWS1/CL_KNDBATCHGETDOCSTATRSP

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->batchgetdocumentstatus(
  it_documentinfolist = VALUE /aws1/cl_knddocumentinfo=>tt_documentinfolist(
    (
      new /aws1/cl_knddocumentinfo(
        it_attributes = VALUE /aws1/cl_knddocumentattribute=>tt_documentattributelist(
          (
            new /aws1/cl_knddocumentattribute(
              io_value = new /aws1/cl_knddocumentattrvalue(
                it_stringlistvalue = VALUE /aws1/cl_knddocattrstrlstval_w=>tt_documentattrstringlistvalue(
                  ( new /aws1/cl_knddocattrstrlstval_w( |string| ) )
                )
                iv_datevalue = '20150101000000.0000000'
                iv_longvalue = 123
                iv_stringvalue = |string|
              )
              iv_key = |string|
            )
          )
        )
        iv_documentid = |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_errors( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_documentid = lo_row_1->get_documentid( ).
      lv_datasourceid = lo_row_1->get_datasourceid( ).
      lv_errorcode = lo_row_1->get_errorcode( ).
      lv_errormessage = lo_row_1->get_errormessage( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_documentstatuslist( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_documentid = lo_row_3->get_documentid( ).
      lv_documentstatus = lo_row_3->get_documentstatus( ).
      lv_string = lo_row_3->get_failurecode( ).
      lv_string = lo_row_3->get_failurereason( ).
    ENDIF.
  ENDLOOP.
ENDIF.