SEARCHKNOWLEDGEBASES()`¶

About SearchKnowledgeBases¶

Searches for a subset of knowledge bases based on specified filters.

Method Signature¶

METHODS /AWS1/IF_QST~SEARCHKNOWLEDGEBASES
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTKBAWSACCOUNTID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/QSTNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/QSTMAXRESULTS OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_QSTKNWLDGBASESRCHFILT=>TT_KNOWLEDGEBASESEARCHFILTERS OPTIONAL
    !IO_SORTBY TYPE REF TO /AWS1/CL_QSTKNWLDGBASESORTBY OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstsrchknwldgbasesrsp
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVALIDNEXTTOKENEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTPRECONDNOTMETEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /AWS1/CX_QSTTHROTTLINGEX
    /AWS1/CX_QSTCLIENTEXC
    /AWS1/CX_QSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_awsaccountid` `TYPE /AWS1/QSTKBAWSACCOUNTID` `/AWS1/QSTKBAWSACCOUNTID`¶

The ID of the Amazon Web Services account that contains the knowledge base.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/QSTNEXTTOKEN` `/AWS1/QSTNEXTTOKEN`¶

The token for the next set of results, or null if there are no more results.

`iv_maxresults` `TYPE /AWS1/QSTMAXRESULTS` `/AWS1/QSTMAXRESULTS`¶

The maximum number of results to return.

`it_filters` `TYPE /AWS1/CL_QSTKNWLDGBASESRCHFILT=>TT_KNOWLEDGEBASESEARCHFILTERS` `TT_KNOWLEDGEBASESEARCHFILTERS`¶

The filters to apply when searching knowledge bases.

`io_sortby` `TYPE REF TO /AWS1/CL_QSTKNWLDGBASESORTBY` `/AWS1/CL_QSTKNWLDGBASESORTBY`¶

The sort configuration for the search results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qstsrchknwldgbasesrsp` `/AWS1/CL_QSTSRCHKNWLDGBASESRSP`¶

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->searchknowledgebases(
  io_sortby = new /aws1/cl_qstknwldgbasesortby(
    iv_sortbyfield = |string|
    iv_sortorder = |string|
  )
  it_filters = VALUE /aws1/cl_qstknwldgbasesrchfilt=>tt_knowledgebasesearchfilters(
    (
      new /aws1/cl_qstknwldgbasesrchfilt(
        iv_name = |string|
        iv_operator = |string|
        iv_value = |string|
      )
    )
  )
  iv_awsaccountid = |string|
  iv_maxresults = 123
  iv_nexttoken = |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_knowledgebasesummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_knowledgebasearn = lo_row_1->get_knowledgebasearn( ).
      lv_knowledgebaseid = lo_row_1->get_knowledgebaseid( ).
      lv_knowledgebasename = lo_row_1->get_name( ).
      lv_datasetstatus = lo_row_1->get_status( ).
      lv_datasourcearn = lo_row_1->get_datasourcearn( ).
      lv_string = lo_row_1->get_type( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_updatedat( ).
      lv_long = lo_row_1->get_knowledgebasesizebytes( ).
      lv_long = lo_row_1->get_documentcount( ).
      lv_string = lo_row_1->get_primaryownerarn( ).
      lv_sensitivestring = lo_row_1->get_primaryownerusername( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
  lv_string = lo_result->get_requestid( ).
  lv_statuscode = lo_result->get_status( ).
ENDIF.

/AWS1/IF_QST=>SEARCHKNOWLEDGEBASES()¶