/AWS1/IF_QST=>DESCRIBEDASHBOARDSNAPSHOTJOB()

About DescribeDashboardSnapshotJob

Describes an existing snapshot job.

Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus.

Method Signature

METHODS /AWS1/IF_QST~DESCRIBEDASHBOARDSNAPSHOTJOB
  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_qstdscdashboardsnap01
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /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_qstdscdashboardsnap01 /AWS1/CL_QSTDSCDASHBOARDSNAP01

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->describedashboardsnapshotjob(
  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_awsaccountid = lo_result->get_awsaccountid( ).
  lv_shortrestrictiveresourc = lo_result->get_dashboardid( ).
  lv_shortrestrictiveresourc = lo_result->get_snapshotjobid( ).
  lo_snapshotuserconfigurati = lo_result->get_userconfiguration( ).
  IF lo_snapshotuserconfigurati IS NOT INITIAL.
    LOOP AT lo_snapshotuserconfigurati->get_anonymoususers( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        LOOP AT lo_row_1->get_rowlevelpermtagkeys( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_sessiontagkey = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDLOOP.
  ENDIF.
  lo_snapshotconfiguration = lo_result->get_snapshotconfiguration( ).
  IF lo_snapshotconfiguration IS NOT INITIAL.
    LOOP AT lo_snapshotconfiguration->get_filegroups( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        LOOP AT lo_row_5->get_files( ) into lo_row_6.
          lo_row_7 = lo_row_6.
          IF lo_row_7 IS NOT INITIAL.
            LOOP AT lo_row_7->get_sheetselections( ) into lo_row_8.
              lo_row_9 = lo_row_8.
              IF lo_row_9 IS NOT INITIAL.
                lv_shortrestrictiveresourc = lo_row_9->get_sheetid( ).
                lv_snapshotfilesheetselect = lo_row_9->get_selectionscope( ).
                LOOP AT lo_row_9->get_visualids( ) into lo_row_10.
                  lo_row_11 = lo_row_10.
                  IF lo_row_11 IS NOT INITIAL.
                    lv_shortrestrictiveresourc = lo_row_11->get_value( ).
                  ENDIF.
                ENDLOOP.
              ENDIF.
            ENDLOOP.
            lv_snapshotfileformattype = lo_row_7->get_formattype( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDLOOP.
    lo_snapshotdestinationconf = lo_snapshotconfiguration->get_destinationconfiguration( ).
    IF lo_snapshotdestinationconf IS NOT INITIAL.
      LOOP AT lo_snapshotdestinationconf->get_s3destinations( ) into lo_row_12.
        lo_row_13 = lo_row_12.
        IF lo_row_13 IS NOT INITIAL.
          lo_s3bucketconfiguration = lo_row_13->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.
      ENDLOOP.
    ENDIF.
    lo_parameters = lo_snapshotconfiguration->get_parameters( ).
    IF lo_parameters IS NOT INITIAL.
      LOOP AT lo_parameters->get_stringparameters( ) into lo_row_14.
        lo_row_15 = lo_row_14.
        IF lo_row_15 IS NOT INITIAL.
          lv_nonemptystring = lo_row_15->get_name( ).
          LOOP AT lo_row_15->get_values( ) into lo_row_16.
            lo_row_17 = lo_row_16.
            IF lo_row_17 IS NOT INITIAL.
              lv_sensitivestring = lo_row_17->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
      LOOP AT lo_parameters->get_integerparameters( ) into lo_row_18.
        lo_row_19 = lo_row_18.
        IF lo_row_19 IS NOT INITIAL.
          lv_nonemptystring = lo_row_19->get_name( ).
          LOOP AT lo_row_19->get_values( ) into lo_row_20.
            lo_row_21 = lo_row_20.
            IF lo_row_21 IS NOT INITIAL.
              lv_sensitivelong = lo_row_21->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
      LOOP AT lo_parameters->get_decimalparameters( ) into lo_row_22.
        lo_row_23 = lo_row_22.
        IF lo_row_23 IS NOT INITIAL.
          lv_nonemptystring = lo_row_23->get_name( ).
          LOOP AT lo_row_23->get_values( ) into lo_row_24.
            lo_row_25 = lo_row_24.
            IF lo_row_25 IS NOT INITIAL.
              lv_sensitivedouble = lo_row_25->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
      LOOP AT lo_parameters->get_datetimeparameters( ) into lo_row_26.
        lo_row_27 = lo_row_26.
        IF lo_row_27 IS NOT INITIAL.
          lv_nonemptystring = lo_row_27->get_name( ).
          LOOP AT lo_row_27->get_values( ) into lo_row_28.
            lo_row_29 = lo_row_28.
            IF lo_row_29 IS NOT INITIAL.
              lv_sensitivetimestamp = lo_row_29->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDIF.
  lv_arn = lo_result->get_arn( ).
  lv_snapshotjobstatus = lo_result->get_jobstatus( ).
  lv_timestamp = lo_result->get_createdtime( ).
  lv_timestamp = lo_result->get_lastupdatedtime( ).
  lv_nonemptystring = lo_result->get_requestid( ).
  lv_statuscode = lo_result->get_status( ).
ENDIF.