DeleteObjects
This action enables you to delete multiple objects from a bucket using a single HTTP request
If you know the object keys that you want to delete, then this action provides a suitable alternative to sending individual delete requests, reducing per-request overhead.
The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Petabox performs a delete action and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Petabox returns the result as deleted.
The action supports two modes for the response: verbose and quiet. By default, the action uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete action encountered an error. For a successful deletion, the action does not return any information about the delete in the response body.
MFA Deletes are not supported for the moment.
Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Petabox uses the header value to ensure that your request body has not been altered in transit.
Request Syntax
URI Request Parameters
The request uses the following URI parameters.
Bucket
The bucket name containing the objects to delete.
Required: Yes
x-amz-bypass-governance-retention
Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the s3:BypassGovernanceRetention permission.
x-amz-expected-bucket-owner
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
x-amz-request-payer
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests.
Valid Values: requester
x-amz-sdk-checksum-algorithm
Not supported at the moment.
Request Body
The request accepts the following data in XML format.
Delete
Root level tag for the Delete parameters.
Required: Yes
Object
The objects to delete.
Type: Array of ObjectIdentifier data types
Required: Yes
Quiet
Element to enable quiet mode for the request. When you add this element, you must set its value to true.
Type: Boolean
Required: No
Response Syntax
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
x-amz-request-charged
If present, indicates that the requester was successfully charged for the request.
Valid Values: requester
The following data is returned in XML format by the service.
DeleteResult
Root level tag for the DeleteResult parameters.
Required: Yes
Deleted
Container element for a successful delete. It identifies the object that was successfully deleted.
Type: Array of DeletedObject data types
Error
Container for a failed delete action that describes the object that Petabox attempted to delete and the error it encountered.
Type: Array of Error data types
Examples
Sample Request: Multi-object delete resulting in mixed success/error response
This example illustrates a Multi-Object Delete request to delete objects that result in mixed success and errors response. The following request deletes two objects from a bucket (bucketname). In this example, the requester does not have permission to delete the sample2.txt object.
Sample Response
The response includes a DeleteResult element that includes a Deleted element for the item that Petabox successfully deleted and an Error element that Petabox did not delete because you didn't have permission to delete the object.
Sample Request: Deleting an object from a versioned bucket
If you delete an item from a versioning enabled bucket, all versions of that object remain in the bucket; however, Petabox inserts a delete marker.
The following scenarios describe the behavior of a multi-object Delete request when versioning is enabled for your bucket.
Case 1 - Simple Delete: In the following sample request, the multi-object delete request specifies only one key.
Sample Response
Because versioning is enabled on the bucket, Petabox does not delete the object. Instead, it adds a delete marker for this object. The following response indicates that a delete marker was added (the DeleteMarker element in the response as a value of true) and the version number of the delete marker it added.
Case 2 - Versioned Delete
The following request attempts to delete a specific version of an object.
Sample Response
In this case, Petabox deletes the specific object version from the bucket and returns the following response. In the response, Petabox returns the key and version ID of the object deleted.
Case 3 - Versioned delete of a delete marker
In the preceding example, the request refers to a delete marker (instead of an object), then Petabox deletes the delete marker. The effect of this action is to make your object reappear in your bucket. Petabox returns a response that indicates the delete marker it deleted (DeleteMarker element with value true) and the version ID of the delete marker.
Sample Response
In general, when a multi-object Delete request results in Petabox either adding a delete marker or removing a delete marker, the response returns the following elements.
Sample Request: Malformed XML in the request
This example shows how Petabox responds to a request that includes a malformed XML document. The following request sends a malformed XML document (missing the Delete end element).
Sample Response
The response returns the error messages that describe the error.
Sample Request to DeleteObjects containing a carriage return
The following example illustrates the use of an XML entity code as a substitution for a carriage return. This DeleteObjects request deletes an object with the key parameter: /some/prefix/objectwith\rcarriagereturn (where the \r is the carriage return).
Last updated