DELETEOBJECTSONCANCEL()`¶

About DeleteObjectsOnCancel¶

For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted if the transaction is canceled. Without this call, no Amazon S3 objects are automatically deleted when a transaction cancels.

The Glue ETL library function write_dynamic_frame.from_catalog() includes an option to automatically call DeleteObjectsOnCancel before writes. For more information, see Rolling Back Amazon S3 Writes.

Method Signature¶

METHODS /AWS1/IF_LKF~DELETEOBJECTSONCANCEL
  IMPORTING
    !IV_CATALOGID TYPE /AWS1/LKFCATALOGIDSTRING OPTIONAL
    !IV_DATABASENAME TYPE /AWS1/LKFNAMESTRING OPTIONAL
    !IV_TABLENAME TYPE /AWS1/LKFNAMESTRING OPTIONAL
    !IV_TRANSACTIONID TYPE /AWS1/LKFTRANSACTIONIDSTRING OPTIONAL
    !IT_OBJECTS TYPE /AWS1/CL_LKFVIRTUALOBJECT=>TT_VIRTUALOBJECTLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lkfdelobjsoncancrsp
  RAISING
    /AWS1/CX_LKFCONCURRENTMODEX
    /AWS1/CX_LKFENTITYNOTFOUNDEX
    /AWS1/CX_LKFINTERNALSERVICEEX
    /AWS1/CX_LKFINVALIDINPUTEX
    /AWS1/CX_LKFOPERATIONTIMEOUTEX
    /AWS1/CX_LKFRESOURCENOTREADYEX
    /AWS1/CX_LKFTRANSACTCANCEDEX
    /AWS1/CX_LKFTRANSACTCOMMITTE00
    /AWS1/CX_LKFCLIENTEXC
    /AWS1/CX_LKFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_databasename` `TYPE /AWS1/LKFNAMESTRING` `/AWS1/LKFNAMESTRING`¶

The database that contains the governed table.

`iv_tablename` `TYPE /AWS1/LKFNAMESTRING` `/AWS1/LKFNAMESTRING`¶

The name of the governed table.

`iv_transactionid` `TYPE /AWS1/LKFTRANSACTIONIDSTRING` `/AWS1/LKFTRANSACTIONIDSTRING`¶

ID of the transaction that the writes occur in.

`it_objects` `TYPE /AWS1/CL_LKFVIRTUALOBJECT=>TT_VIRTUALOBJECTLIST` `TT_VIRTUALOBJECTLIST`¶

A list of VirtualObject structures, which indicates the Amazon S3 objects to be deleted if the transaction cancels.

Optional arguments:¶

`iv_catalogid` `TYPE /AWS1/LKFCATALOGIDSTRING` `/AWS1/LKFCATALOGIDSTRING`¶

The Glue data catalog that contains the governed table. Defaults to the current account ID.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_lkfdelobjsoncancrsp` `/AWS1/CL_LKFDELOBJSONCANCRSP`¶

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->deleteobjectsoncancel(
  it_objects = VALUE /aws1/cl_lkfvirtualobject=>tt_virtualobjectlist(
    (
      new /aws1/cl_lkfvirtualobject(
        iv_etag = |string|
        iv_uri = |string|
      )
    )
  )
  iv_catalogid = |string|
  iv_databasename = |string|
  iv_tablename = |string|
  iv_transactionid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

/AWS1/IF_LKF=>DELETEOBJECTSONCANCEL()¶