LISTQAPPS()`¶

About ListQApps¶

Lists the Amazon Q Apps owned by or associated with the user either because they created it or because they used it from the library in the past. The user identity is extracted from the credentials used to invoke this operation..

Method Signature¶

METHODS /AWS1/IF_QQA~LISTQAPPS
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/QQAINSTANCEID OPTIONAL
    !IV_LIMIT TYPE /AWS1/QQAPAGELIMIT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/QQAPAGINATIONTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqalistqappsoutput
  RAISING
    /AWS1/CX_QQAACCESSDENIEDEX
    /AWS1/CX_QQAINTERNALSERVEREX
    /AWS1/CX_QQATHROTTLINGEX
    /AWS1/CX_QQAUNAUTHORIZEDEX
    /AWS1/CX_QQAVALIDATIONEX
    /AWS1/CX_QQACLIENTEXC
    /AWS1/CX_QQASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_instanceid` `TYPE /AWS1/QQAINSTANCEID` `/AWS1/QQAINSTANCEID`¶

The unique identifier of the Amazon Q Business application environment instance.

Optional arguments:¶

`iv_limit` `TYPE /AWS1/QQAPAGELIMIT` `/AWS1/QQAPAGELIMIT`¶

The maximum number of Q Apps to return in the response.

`iv_nexttoken` `TYPE /AWS1/QQAPAGINATIONTOKEN` `/AWS1/QQAPAGINATIONTOKEN`¶

The token to request the next page of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qqalistqappsoutput` `/AWS1/CL_QQALISTQAPPSOUTPUT`¶

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->listqapps(
  iv_instanceid = |string|
  iv_limit = 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_apps( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_uuid = lo_row_1->get_appid( ).
      lv_apparn = lo_row_1->get_apparn( ).
      lv_title = lo_row_1->get_title( ).
      lv_description = lo_row_1->get_description( ).
      lv_qappstimestamp = lo_row_1->get_createdat( ).
      lv_boolean = lo_row_1->get_canedit( ).
      lv_string = lo_row_1->get_status( ).
      lv_boolean = lo_row_1->get_isverified( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

List at most 3 Amazon Q Apps in an Q Business application¶

List at most 3 Amazon Q Apps in an Q Business application

DATA(lo_result) = lo_client->listqapps(
  iv_instanceid = |0b95c9c4-89cc-4aa8-9aae-aa91cbec699f|
  iv_limit = 3
).

Retrieve the next page of Amazon Q Apps¶

Retrieve the next page of Amazon Q Apps

DATA(lo_result) = lo_client->listqapps(
  iv_instanceid = |0b95c9c4-89cc-4aa8-9aae-aa91cbec699f|
  iv_limit = 3
  iv_nexttoken = |bXlzdGVyaW91c1BhZ2luYXRpb25Ub2tlbg==|
).

/AWS1/IF_QQA=>LISTQAPPS()¶