STARTDASHBOARDREFRESH()`¶

About StartDashboardRefresh¶

Starts a refresh of the specified dashboard.

Each time a dashboard is refreshed, CloudTrail runs queries to populate the dashboard's widgets. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.

Method Signature¶

METHODS /AWS1/IF_TRL~STARTDASHBOARDREFRESH
  IMPORTING
    !IV_DASHBOARDID TYPE /AWS1/TRLDASHBOARDARN OPTIONAL
    !IT_QUERYPARAMETERVALUES TYPE /AWS1/CL_TRLQUERYPARAMVALUES_W=>TT_QUERYPARAMETERVALUES OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_trlstrtdashboardref01
  RAISING
    /AWS1/CX_TRLEVTDATASTORENOTF00
    /AWS1/CX_TRLINACTEVTDATASTOR00
    /AWS1/CX_TRLRESOURCENOTFOUNDEX
    /AWS1/CX_TRLSERVICEQUOTAEXCDEX
    /AWS1/CX_TRLUNSUPPORTEDOPEX
    /AWS1/CX_TRLCLIENTEXC
    /AWS1/CX_TRLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_dashboardid` `TYPE /AWS1/TRLDASHBOARDARN` `/AWS1/TRLDASHBOARDARN`¶

The name or ARN of the dashboard.

Optional arguments:¶

`it_queryparametervalues` `TYPE /AWS1/CL_TRLQUERYPARAMVALUES_W=>TT_QUERYPARAMETERVALUES` `TT_QUERYPARAMETERVALUES`¶

The query parameter values for the dashboard

For custom dashboards, the following query parameters are valid: $StartTime$ , $EndTime$ , and $Period$ .

For managed dashboards, the following query parameters are valid: $StartTime$ , $EndTime$ , $Period$ , and $EventDataStoreId$ . The $EventDataStoreId$ query parameter is required.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_trlstrtdashboardref01` `/AWS1/CL_TRLSTRTDASHBOARDREF01`¶

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->startdashboardrefresh(
  it_queryparametervalues = VALUE /aws1/cl_trlqueryparamvalues_w=>tt_queryparametervalues(
    (
      VALUE /aws1/cl_trlqueryparamvalues_w=>ts_queryparametervalues_maprow(
        key = |string|
        value = new /aws1/cl_trlqueryparamvalues_w( |string| )
      )
    )
  )
  iv_dashboardid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_refreshid = lo_result->get_refreshid( ).
ENDIF.

/AWS1/IF_TRL=>STARTDASHBOARDREFRESH()¶