Skip to content

/AWS1/CL_QQB=>LISTPLUGINTYPEMETADATA()

About ListPluginTypeMetadata

Lists metadata for all Amazon Q Business plugin types.

Method Signature

IMPORTING

Optional arguments:

iv_nexttoken TYPE /AWS1/QQBNEXTTOKEN /AWS1/QQBNEXTTOKEN

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

iv_maxresults TYPE /AWS1/QQBMAXRSSINTEGERFORLST14 /AWS1/QQBMAXRSSINTEGERFORLST14

The maximum number of plugin metadata items to return.

RETURNING

oo_output TYPE REF TO /aws1/cl_qqblstplugintypemet01 /AWS1/CL_QQBLSTPLUGINTYPEMET01

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->/aws1/if_qqb~listplugintypemetadata(
  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.
  lv_nexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_plugintype = lo_row_1->get_type( ).
      lv_plugintypecategory = lo_row_1->get_category( ).
      lv_string = lo_row_1->get_description( ).
    ENDIF.
  ENDLOOP.
ENDIF.