SEARCHDASHBOARDS()`¶

About SearchDashboards¶

Searches for dashboards that belong to a user.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Method Signature¶

METHODS /AWS1/IF_QST~SEARCHDASHBOARDS
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_QSTDASHBOARDSRCHFILT=>TT_DASHBOARDSEARCHFILTERLIST OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/QSTSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/QSTMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstsrchdashboardsrsp
  RAISING
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVALIDNEXTTOKENEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /AWS1/CX_QSTTHROTTLINGEX
    /AWS1/CX_QSTUNSUPPEDUSEREDIT00
    /AWS1/CX_QSTCLIENTEXC
    /AWS1/CX_QSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_awsaccountid` `TYPE /AWS1/QSTAWSACCOUNTID` `/AWS1/QSTAWSACCOUNTID`¶

The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.

`it_filters` `TYPE /AWS1/CL_QSTDASHBOARDSRCHFILT=>TT_DASHBOARDSEARCHFILTERLIST` `TT_DASHBOARDSEARCHFILTERLIST`¶

The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/QSTSTRING` `/AWS1/QSTSTRING`¶

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

`iv_maxresults` `TYPE /AWS1/QSTMAXRESULTS` `/AWS1/QSTMAXRESULTS`¶

The maximum number of results to be returned per request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qstsrchdashboardsrsp` `/AWS1/CL_QSTSRCHDASHBOARDSRSP`¶

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->searchdashboards(
  it_filters = VALUE /aws1/cl_qstdashboardsrchfilt=>tt_dashboardsearchfilterlist(
    (
      new /aws1/cl_qstdashboardsrchfilt(
        iv_name = |string|
        iv_operator = |string|
        iv_value = |string|
      )
    )
  )
  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_dashboardsummarylist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_arn = lo_row_1->get_arn( ).
      lv_shortrestrictiveresourc = lo_row_1->get_dashboardid( ).
      lv_dashboardname = lo_row_1->get_name( ).
      lv_timestamp = lo_row_1->get_createdtime( ).
      lv_timestamp = lo_row_1->get_lastupdatedtime( ).
      lv_versionnumber = lo_row_1->get_publishedversionnumber( ).
      lv_timestamp = lo_row_1->get_lastpublishedtime( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
  lv_statuscode = lo_result->get_status( ).
  lv_string = lo_result->get_requestid( ).
ENDIF.

/AWS1/IF_QST=>SEARCHDASHBOARDS()¶