Request Syntax Request Parameters Response Elements Errors See Also

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 AWS 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.

Request Syntax


{
   "CatalogId": "string",
   "DatabaseName": "string",
   "Objects": [ 
      { 
         "ETag": "string",
         "Uri": "string"
      }
   ],
   "TableName": "string",
   "TransactionId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CatalogId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

DatabaseName

The database that contains the governed table.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Objects

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

Type: Array of VirtualObject objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: Yes

TableName

The name of the governed table.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

TransactionId

ID of the transaction that the writes occur in.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\p{L}\p{N}\p{P}]*

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

Two processes are trying to modify a resource simultaneously.

HTTP Status Code: 400

EntityNotFoundException

A specified entity does not exist.

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400

ResourceNotReadyException

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

HTTP Status Code: 400

TransactionCanceledException

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

HTTP Status Code: 400

TransactionCommittedException

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

HTTP Status Code: 400