DELETEANALYSIS()`¶

About DeleteAnalysis¶

Deletes an analysis from Amazon Quick Sight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon Quick Sight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon Quick Sight deletes the analysis permanently.

At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.

An analysis that's scheduled for deletion isn't accessible in the Amazon Quick Sight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.

Method Signature¶

METHODS /AWS1/IF_QST~DELETEANALYSIS
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_ANALYSISID TYPE /AWS1/QSTSHORTRESTRICTIVERES00 OPTIONAL
    !IV_RECOVERYWINDOWINDAYS TYPE /AWS1/QSTRECOVERYWINDOWINDAYS OPTIONAL
    !IV_FORCEDELETEWITHOUTREC TYPE /AWS1/QSTBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstdeletealyresponse
  RAISING
    /AWS1/CX_QSTCONFLICTEXCEPTION
    /AWS1/CX_QSTINTERNALFAILUREEX
    /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 where you want to delete an analysis.

`iv_analysisid` `TYPE /AWS1/QSTSHORTRESTRICTIVERES00` `/AWS1/QSTSHORTRESTRICTIVERES00`¶

The ID of the analysis that you're deleting.

Optional arguments:¶

`iv_recoverywindowindays` `TYPE /AWS1/QSTRECOVERYWINDOWINDAYS` `/AWS1/QSTRECOVERYWINDOWINDAYS`¶

A value that specifies the number of days that Amazon Quick Sight waits before it deletes the analysis. You can't use this parameter with the ForceDeleteWithoutRecovery option in the same API call. The default value is 30.

`iv_forcedeletewithoutrec` `TYPE /AWS1/QSTBOOLEAN` `/AWS1/QSTBOOLEAN`¶

This option defaults to the value NoForceDeleteWithoutRecovery. To immediately delete the analysis, add the ForceDeleteWithoutRecovery option. You can't restore an analysis after it's deleted.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qstdeletealyresponse` `/AWS1/CL_QSTDELETEALYRESPONSE`¶

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->deleteanalysis(
  iv_analysisid = |string|
  iv_awsaccountid = |string|
  iv_forcedeletewithoutrec = ABAP_TRUE
  iv_recoverywindowindays = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_statuscode = lo_result->get_status( ).
  lv_arn = lo_result->get_arn( ).
  lv_shortrestrictiveresourc = lo_result->get_analysisid( ).
  lv_timestamp = lo_result->get_deletiontime( ).
  lv_string = lo_result->get_requestid( ).
ENDIF.

/AWS1/IF_QST=>DELETEANALYSIS()¶