LISTDASHBOARDS()`¶

About ListDashboards¶

Returns information about all dashboards in the account, in the current Region.

Method Signature¶

METHODS /AWS1/IF_TRL~LISTDASHBOARDS
  IMPORTING
    !IV_NAMEPREFIX TYPE /AWS1/TRLDASHBOARDNAME OPTIONAL
    !IV_TYPE TYPE /AWS1/TRLDASHBOARDTYPE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/TRLPAGINATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/TRLLSTDASHBOARDSMAXRSSCT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_trllistdashboardsrsp
  RAISING
    /AWS1/CX_TRLUNSUPPORTEDOPEX
    /AWS1/CX_TRLCLIENTEXC
    /AWS1/CX_TRLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_nameprefix` `TYPE /AWS1/TRLDASHBOARDNAME` `/AWS1/TRLDASHBOARDNAME`¶

Specify a name prefix to filter on.

`iv_type` `TYPE /AWS1/TRLDASHBOARDTYPE` `/AWS1/TRLDASHBOARDTYPE`¶

Specify a dashboard type to filter on: CUSTOM or MANAGED.

`iv_nexttoken` `TYPE /AWS1/TRLPAGINATIONTOKEN` `/AWS1/TRLPAGINATIONTOKEN`¶

A token you can use to get the next page of dashboard results.

`iv_maxresults` `TYPE /AWS1/TRLLSTDASHBOARDSMAXRSSCT` `/AWS1/TRLLSTDASHBOARDSMAXRSSCT`¶

The maximum number of dashboards to display on a single page.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_trllistdashboardsrsp` `/AWS1/CL_TRLLISTDASHBOARDSRSP`¶

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->listdashboards(
  iv_maxresults = 123
  iv_nameprefix = |string|
  iv_nexttoken = |string|
  iv_type = |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_dashboards( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_dashboardarn = lo_row_1->get_dashboardarn( ).
      lv_dashboardtype = lo_row_1->get_type( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_TRL=>LISTDASHBOARDS()¶