POST

/DeleteObjectsOnCancel

http://lakeformation.{region}.amazonaws.com/DeleteObjectsOnCancel

<p>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. </p> <p> The Glue ETL library function <code>write_dynamic_frame.from_catalog()</code> includes an option to automatically call <code>DeleteObjectsOnCancel</code> before writes. For more information, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html#rolling-back-writes">Rolling Back Amazon S3 Writes</a>. </p>

Access Token Required: API Key

Body Params

Objectsarrayrequired

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

CatalogIdstring

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

TableNamestringrequired

The name of the governed table.

DatabaseNamestringrequired

The database that contains the governed table.

TransactionIdstringrequired

ID of the transaction that the writes occur in.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://lakeformation.{region}.amazonaws.com/DeleteObjectsOnCancel' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}