Container for the parameters to the DeleteObjects operation.
This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.
Inheritance Hierarchy
Namespace: Amazon.S3.Model
Assembly: AWSSDK.dll
Version: 2.0.0.3
Syntax
public class DeleteObjectsRequest : AmazonWebServiceRequest IRequestEvents
The DeleteObjectsRequest type exposes the following members
Constructors
Name | Description | |
---|---|---|
![]() |
DeleteObjectsRequest() |
Properties
Name | Description | |
---|---|---|
![]() |
BucketName | The name of the bucket containing the objects to be deleted. |
![]() |
MfaCodes | The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the Multi-Factor Authentication device associated with your AWS Account. |
![]() |
Objects | |
![]() |
Quiet | Toggles between Quiet and Verbose mode for the operation. If set to true (Quiet mode), the response includes only those keys for objects on which the delete operation failed. |
Methods
Name | Description | |
---|---|---|
![]() |
AddKey(string) | Add a key to the set of keys of objects to be deleted. |
![]() |
AddKey(string, string) | Add a key and a version to be deleted. |
Examples
This example shows how to delete multiple objects in a single request.
Note that the call may not delete all objects. In that case, an exception
will be thrown. This exception will contain the list of encountered
delete errors.
DeleteObjects sample
// Create a client AmazonS3Client client = new AmazonS3Client(); // Create a DeleteObject request DeleteObjectsRequest request = new DeleteObjectsRequest { BucketName = "SampleBucket", Objects = new List<KeyVersion> { new KeyVersion() {Key = "Item1"}, // Versioned item new KeyVersion() { Key = "Item2", VersionId = "Rej8CiBxcZKVK81cLr39j27Y5FVXghDK", }, // Item in subdirectory new KeyVersion() { Key = "Logs/error.txt"} } }; try { // Issue request DeleteObjectsResponse response = client.DeleteObjects(request); } catch (DeleteObjectsException doe) { // Catch error and list error details DeleteObjectsResponse errorResponse = doe.Response; foreach (DeletedObject deletedObject in errorResponse.DeletedObjects) { Console.WriteLine("Deleted item " + deletedObject.Key); } foreach (DeleteError deleteError in errorResponse.DeleteErrors) { Console.WriteLine("Error deleting item " + deleteError.Key); Console.WriteLine(" Code - " + deleteError.Code); Console.WriteLine(" Message - " + deleteError.Message); } }
Version Information
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8
.NET for Windows Phone:
Supported in: Window Phone 8