STARTINGESTIONJOB()`¶

About StartIngestionJob¶

Begins a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.

Method Signature¶

METHODS /AWS1/IF_BDA~STARTINGESTIONJOB
  IMPORTING
    !IV_KNOWLEDGEBASEID TYPE /AWS1/BDAID OPTIONAL
    !IV_DATASOURCEID TYPE /AWS1/BDAID OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/BDACLIENTTOKEN OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/BDADESCRIPTION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdastrtingestionjob01
  RAISING
    /AWS1/CX_BDAACCESSDENIEDEX
    /AWS1/CX_BDACONFLICTEXCEPTION
    /AWS1/CX_BDAINTERNALSERVEREX
    /AWS1/CX_BDARESOURCENOTFOUNDEX
    /AWS1/CX_BDASERVICEQUOTAEXCDEX
    /AWS1/CX_BDATHROTTLINGEX
    /AWS1/CX_BDAVALIDATIONEX
    /AWS1/CX_BDACLIENTEXC
    /AWS1/CX_BDASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_knowledgebaseid` `TYPE /AWS1/BDAID` `/AWS1/BDAID`¶

The unique identifier of the knowledge base for the data ingestion job.

`iv_datasourceid` `TYPE /AWS1/BDAID` `/AWS1/BDAID`¶

The unique identifier of the data source you want to ingest into your knowledge base.

Optional arguments:¶

`iv_clienttoken` `TYPE /AWS1/BDACLIENTTOKEN` `/AWS1/BDACLIENTTOKEN`¶

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

`iv_description` `TYPE /AWS1/BDADESCRIPTION` `/AWS1/BDADESCRIPTION`¶

A description of the data ingestion job.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_bdastrtingestionjob01` `/AWS1/CL_BDASTRTINGESTIONJOB01`¶

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->startingestionjob(
  iv_clienttoken = |string|
  iv_datasourceid = |string|
  iv_description = |string|
  iv_knowledgebaseid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_ingestionjob = lo_result->get_ingestionjob( ).
  IF lo_ingestionjob IS NOT INITIAL.
    lv_id = lo_ingestionjob->get_knowledgebaseid( ).
    lv_id = lo_ingestionjob->get_datasourceid( ).
    lv_id = lo_ingestionjob->get_ingestionjobid( ).
    lv_description = lo_ingestionjob->get_description( ).
    lv_ingestionjobstatus = lo_ingestionjob->get_status( ).
    lo_ingestionjobstatistics = lo_ingestionjob->get_statistics( ).
    IF lo_ingestionjobstatistics IS NOT INITIAL.
      lv_primitivelong = lo_ingestionjobstatistics->get_numberofdocumentsscanned( ).
      lv_primitivelong = lo_ingestionjobstatistics->get_numberofmetdocsscanned( ).
      lv_primitivelong = lo_ingestionjobstatistics->get_numberofnewdocsindexed( ).
      lv_primitivelong = lo_ingestionjobstatistics->get_numofmoddeddocsindexed( ).
      lv_primitivelong = lo_ingestionjobstatistics->get_numberofmetdocsmodified( ).
      lv_primitivelong = lo_ingestionjobstatistics->get_numberofdocumentsdeleted( ).
      lv_primitivelong = lo_ingestionjobstatistics->get_numberofdocumentsfailed( ).
    ENDIF.
    LOOP AT lo_ingestionjob->get_failurereasons( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_failurereason = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_datetimestamp = lo_ingestionjob->get_startedat( ).
    lv_datetimestamp = lo_ingestionjob->get_updatedat( ).
  ENDIF.
ENDIF.

/AWS1/IF_BDA=>STARTINGESTIONJOB()¶