Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class DeleteObjectsOnCancelCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { LakeFormationClient, DeleteObjectsOnCancelCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import
// const { LakeFormationClient, DeleteObjectsOnCancelCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import
const client = new LakeFormationClient(config);
const input = { // DeleteObjectsOnCancelRequest
CatalogId: "STRING_VALUE",
DatabaseName: "STRING_VALUE", // required
TableName: "STRING_VALUE", // required
TransactionId: "STRING_VALUE", // required
Objects: [ // VirtualObjectList // required
{ // VirtualObject
Uri: "STRING_VALUE", // required
ETag: "STRING_VALUE",
},
],
};
const command = new DeleteObjectsOnCancelCommand(input);
const response = await client.send(command);
// {};

Param

DeleteObjectsOnCancelCommandInput

Returns

DeleteObjectsOnCancelCommandOutput

See

Throws

ConcurrentModificationException (client fault)

Two processes are trying to modify a resource simultaneously.

Throws

EntityNotFoundException (client fault)

A specified entity does not exist.

Throws

InternalServiceException (server fault)

An internal service error occurred.

Throws

InvalidInputException (client fault)

The input provided was not valid.

Throws

OperationTimeoutException (client fault)

The operation timed out.

Throws

ResourceNotReadyException (client fault)

Contains details about an error related to a resource which is not ready for a transaction.

Throws

TransactionCanceledException (client fault)

Contains details about an error related to a transaction that was cancelled.

Throws

TransactionCommittedException (client fault)

Contains details about an error where the specified transaction has already been committed and cannot be used for UpdateTableObjects.

Throws

LakeFormationServiceException

Base exception class for all service exceptions from LakeFormation service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods