Skip to content

/AWS1/IF_FSX=>DELETESNAPSHOT()

About DeleteSnapshot

Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup.

The DeleteSnapshot operation returns instantly. The snapshot appears with the lifecycle status of DELETING until the deletion is complete.

Method Signature

METHODS /AWS1/IF_FSX~DELETESNAPSHOT
  IMPORTING
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/FSXCLIENTREQUESTTOKEN OPTIONAL
    !IV_SNAPSHOTID TYPE /AWS1/FSXSNAPSHOTID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_fsxdeletesnapresponse
  RAISING
    /AWS1/CX_FSXBADREQUEST
    /AWS1/CX_FSXINTERNALSERVERERR
    /AWS1/CX_FSXSNAPSHOTNOTFOUND
    /AWS1/CX_FSXCLIENTEXC
    /AWS1/CX_FSXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_snapshotid TYPE /AWS1/FSXSNAPSHOTID /AWS1/FSXSNAPSHOTID

The ID of the snapshot that you want to delete.

Optional arguments:

iv_clientrequesttoken TYPE /AWS1/FSXCLIENTREQUESTTOKEN /AWS1/FSXCLIENTREQUESTTOKEN

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

RETURNING

oo_output TYPE REF TO /aws1/cl_fsxdeletesnapresponse /AWS1/CL_FSXDELETESNAPRESPONSE

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->deletesnapshot(
  iv_clientrequesttoken = |string|
  iv_snapshotid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_snapshotid = lo_result->get_snapshotid( ).
  lv_snapshotlifecycle = lo_result->get_lifecycle( ).
ENDIF.