Skip to content

/AWS1/IF_QST=>LISTKNOWLEDGEBASES()

About ListKnowledgeBases

Lists all knowledge bases in an Amazon QuickSight account.

Method Signature

METHODS /AWS1/IF_QST~LISTKNOWLEDGEBASES
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTKBAWSACCOUNTID OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/QSTMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/QSTNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstlistknwldgbasesrsp
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTINVALIDREQUESTEX
    /AWS1/CX_QSTPRECONDNOTMETEX
    /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_maxresults TYPE /AWS1/QSTMAXRESULTS /AWS1/QSTMAXRESULTS

The maximum number of results to return.

iv_nexttoken TYPE /AWS1/QSTNEXTTOKEN /AWS1/QSTNEXTTOKEN

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

RETURNING

oo_output TYPE REF TO /aws1/cl_qstlistknwldgbasesrsp /AWS1/CL_QSTLISTKNWLDGBASESRSP

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->listknowledgebases(
  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_1 = lo_result->get_requestid( ).
  lv_statuscode = lo_result->get_status( ).
ENDIF.