STARTDASHBOARDSNAPJOBSCHD()`¶

About StartDashboardSnapshotJobSchedule¶

Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.

Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202 HTTP status code.

For more information, see Scheduling and sending Amazon Quick Sight reports by email and Configuring email report settings for a Amazon Quick Sight dashboard in the Amazon Quick Sight User Guide.

Method Signature¶

METHODS /AWS1/IF_QST~STARTDASHBOARDSNAPJOBSCHD
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_DASHBOARDID TYPE /AWS1/QSTSHORTRESTRICTIVERES00 OPTIONAL
    !IV_SCHEDULEID TYPE /AWS1/QSTSHORTRESTRICTIVERES00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qststrtdashboardsna03
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTLIMITEXCEEDEDEX
    /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 the dashboard snapshot job is executed in.

`iv_dashboardid` `TYPE /AWS1/QSTSHORTRESTRICTIVERES00` `/AWS1/QSTSHORTRESTRICTIVERES00`¶

The ID of the dashboard that you want to start a snapshot job schedule for.

`iv_scheduleid` `TYPE /AWS1/QSTSHORTRESTRICTIVERES00` `/AWS1/QSTSHORTRESTRICTIVERES00`¶

The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the Amazon Quick Sight console in the Schedules pane of the dashboard that the schedule is configured for.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qststrtdashboardsna03` `/AWS1/CL_QSTSTRTDASHBOARDSNA03`¶

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->startdashboardsnapjobschd(
  iv_awsaccountid = |string|
  iv_dashboardid = |string|
  iv_scheduleid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nonemptystring = lo_result->get_requestid( ).
  lv_statuscode = lo_result->get_status( ).
ENDIF.

/AWS1/IF_QST=>STARTDASHBOARDSNAPJOBSCHD()¶