Skip to content

/AWS1/IF_QST=>DESCRDASHBOARDSNAPJOBRESULT()

About DescribeDashboardSnapshotJobResult

Describes the result of an existing snapshot job that has finished running.

A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call.

If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id has not reached a terminal state..

Registered user support

This API can be called as before to get the result of a job started by the same Quick Sight user. The result for the user will be returned in RegisteredUsers response attribute. The attribute will contain a list with at most one object in it.

Possible error scenarios

The request fails with an Access Denied error in the following scenarios:

  • The credentials have expired.

  • The job was started by a different user.

  • The registered user doesn't have access to the specified dashboard.

The request succeeds but the job fails in the following scenarios:

  • DASHBOARD_ACCESS_DENIED - The registered user lost access to the dashboard.

  • CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in all selected formats.

The request succeeds but the response contains an error code in the following scenarios:

  • CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in some selected formats.

  • RLS_CHANGED - Row-level security settings have changed. Re-run the job with current settings.

  • CLS_CHANGED - Column-level security settings have changed. Re-run the job with current settings.

  • DATASET_DELETED - The dataset has been deleted. Verify the dataset exists before re-running the job.

Method Signature

METHODS /AWS1/IF_QST~DESCRDASHBOARDSNAPJOBRESULT
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_DASHBOARDID TYPE /AWS1/QSTSHORTRESTRICTIVERES00 OPTIONAL
    !IV_SNAPSHOTJOBID TYPE /AWS1/QSTSHORTRESTRICTIVERES00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstdscdashboardsnap03
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTPRECONDNOTMETEX
    /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 have started a snapshot job for.

iv_snapshotjobid TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

RETURNING

oo_output TYPE REF TO /aws1/cl_qstdscdashboardsnap03 /AWS1/CL_QSTDSCDASHBOARDSNAP03

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->descrdashboardsnapjobresult(
  iv_awsaccountid = |string|
  iv_dashboardid = |string|
  iv_snapshotjobid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_arn( ).
  lv_snapshotjobstatus = lo_result->get_jobstatus( ).
  lv_timestamp = lo_result->get_createdtime( ).
  lv_timestamp = lo_result->get_lastupdatedtime( ).
  lo_snapshotjobresult = lo_result->get_result( ).
  IF lo_snapshotjobresult IS NOT INITIAL.
    LOOP AT lo_snapshotjobresult->get_anonymoususers( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        LOOP AT lo_row_1->get_filegroups( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            LOOP AT lo_row_3->get_files( ) into lo_row_4.
              lo_row_5 = lo_row_4.
              IF lo_row_5 IS NOT INITIAL.
                LOOP AT lo_row_5->get_sheetselections( ) into lo_row_6.
                  lo_row_7 = lo_row_6.
                  IF lo_row_7 IS NOT INITIAL.
                    lv_shortrestrictiveresourc = lo_row_7->get_sheetid( ).
                    lv_snapshotfilesheetselect = lo_row_7->get_selectionscope( ).
                    LOOP AT lo_row_7->get_visualids( ) into lo_row_8.
                      lo_row_9 = lo_row_8.
                      IF lo_row_9 IS NOT INITIAL.
                        lv_shortrestrictiveresourc = lo_row_9->get_value( ).
                      ENDIF.
                    ENDLOOP.
                  ENDIF.
                ENDLOOP.
                lv_snapshotfileformattype = lo_row_5->get_formattype( ).
              ENDIF.
            ENDLOOP.
            LOOP AT lo_row_3->get_s3results( ) into lo_row_10.
              lo_row_11 = lo_row_10.
              IF lo_row_11 IS NOT INITIAL.
                lo_snapshots3destinationco = lo_row_11->get_s3destinationconf( ).
                IF lo_snapshots3destinationco IS NOT INITIAL.
                  lo_s3bucketconfiguration = lo_snapshots3destinationco->get_bucketconfiguration( ).
                  IF lo_s3bucketconfiguration IS NOT INITIAL.
                    lv_nonemptystring = lo_s3bucketconfiguration->get_bucketname( ).
                    lv_nonemptystring = lo_s3bucketconfiguration->get_bucketprefix( ).
                    lv_nonemptystring = lo_s3bucketconfiguration->get_bucketregion( ).
                  ENDIF.
                ENDIF.
                lv_sensitives3uri = lo_row_11->get_s3uri( ).
                LOOP AT lo_row_11->get_errorinfo( ) into lo_row_12.
                  lo_row_13 = lo_row_12.
                  IF lo_row_13 IS NOT INITIAL.
                    lv_string = lo_row_13->get_errormessage( ).
                    lv_string = lo_row_13->get_errortype( ).
                  ENDIF.
                ENDLOOP.
              ENDIF.
            ENDLOOP.
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDLOOP.
    LOOP AT lo_snapshotjobresult->get_registeredusers( ) into lo_row_14.
      lo_row_15 = lo_row_14.
      IF lo_row_15 IS NOT INITIAL.
        LOOP AT lo_row_15->get_filegroups( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            LOOP AT lo_row_3->get_files( ) into lo_row_4.
              lo_row_5 = lo_row_4.
              IF lo_row_5 IS NOT INITIAL.
                LOOP AT lo_row_5->get_sheetselections( ) into lo_row_6.
                  lo_row_7 = lo_row_6.
                  IF lo_row_7 IS NOT INITIAL.
                    lv_shortrestrictiveresourc = lo_row_7->get_sheetid( ).
                    lv_snapshotfilesheetselect = lo_row_7->get_selectionscope( ).
                    LOOP AT lo_row_7->get_visualids( ) into lo_row_8.
                      lo_row_9 = lo_row_8.
                      IF lo_row_9 IS NOT INITIAL.
                        lv_shortrestrictiveresourc = lo_row_9->get_value( ).
                      ENDIF.
                    ENDLOOP.
                  ENDIF.
                ENDLOOP.
                lv_snapshotfileformattype = lo_row_5->get_formattype( ).
              ENDIF.
            ENDLOOP.
            LOOP AT lo_row_3->get_s3results( ) into lo_row_10.
              lo_row_11 = lo_row_10.
              IF lo_row_11 IS NOT INITIAL.
                lo_snapshots3destinationco = lo_row_11->get_s3destinationconf( ).
                IF lo_snapshots3destinationco IS NOT INITIAL.
                  lo_s3bucketconfiguration = lo_snapshots3destinationco->get_bucketconfiguration( ).
                  IF lo_s3bucketconfiguration IS NOT INITIAL.
                    lv_nonemptystring = lo_s3bucketconfiguration->get_bucketname( ).
                    lv_nonemptystring = lo_s3bucketconfiguration->get_bucketprefix( ).
                    lv_nonemptystring = lo_s3bucketconfiguration->get_bucketregion( ).
                  ENDIF.
                ENDIF.
                lv_sensitives3uri = lo_row_11->get_s3uri( ).
                LOOP AT lo_row_11->get_errorinfo( ) into lo_row_12.
                  lo_row_13 = lo_row_12.
                  IF lo_row_13 IS NOT INITIAL.
                    lv_string = lo_row_13->get_errormessage( ).
                    lv_string = lo_row_13->get_errortype( ).
                  ENDIF.
                ENDLOOP.
              ENDIF.
            ENDLOOP.
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDLOOP.
  ENDIF.
  lo_snapshotjoberrorinfo = lo_result->get_errorinfo( ).
  IF lo_snapshotjoberrorinfo IS NOT INITIAL.
    lv_string = lo_snapshotjoberrorinfo->get_errormessage( ).
    lv_string = lo_snapshotjoberrorinfo->get_errortype( ).
  ENDIF.
  lv_nonemptystring = lo_result->get_requestid( ).
  lv_statuscode = lo_result->get_status( ).
ENDIF.