LISTRETRIEVERS()`¶

About ListRetrievers¶

Lists the retriever used by an Amazon Q Business application.

Method Signature¶

METHODS /AWS1/IF_QQB~LISTRETRIEVERS
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/QQBAPPLICATIONID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/QQBNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/QQBMAXRSSINTEGERFORLST09 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqblistretrieversrsp
  RAISING
    /AWS1/CX_QQBACCESSDENIEDEX
    /AWS1/CX_QQBINTERNALSERVEREX
    /AWS1/CX_QQBRESOURCENOTFOUNDEX
    /AWS1/CX_QQBTHROTTLINGEX
    /AWS1/CX_QQBVALIDATIONEX
    /AWS1/CX_QQBCLIENTEXC
    /AWS1/CX_QQBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_applicationid` `TYPE /AWS1/QQBAPPLICATIONID` `/AWS1/QQBAPPLICATIONID`¶

The identifier of the Amazon Q Business application using the retriever.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/QQBNEXTTOKEN` `/AWS1/QQBNEXTTOKEN`¶

If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.

`iv_maxresults` `TYPE /AWS1/QQBMAXRSSINTEGERFORLST09` `/AWS1/QQBMAXRSSINTEGERFORLST09`¶

The maximum number of retrievers returned.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qqblistretrieversrsp` `/AWS1/CL_QQBLISTRETRIEVERSRSP`¶

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->listretrievers(
  iv_applicationid = |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_retrievers( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_applicationid = lo_row_1->get_applicationid( ).
      lv_retrieverid = lo_row_1->get_retrieverid( ).
      lv_retrievertype = lo_row_1->get_type( ).
      lv_retrieverstatus = lo_row_1->get_status( ).
      lv_retrievername = lo_row_1->get_displayname( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_QQB=>LISTRETRIEVERS()¶