Twoorb Plugins  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Amazon.S3.Model.DeleteObjectsRequest Class Reference

Container for the parameters to the DeleteObjects operation. More...

Inheritance diagram for Amazon.S3.Model.DeleteObjectsRequest:

Public Member Functions

void AddKey (string key)
 Add a key to the set of keys of objects to be deleted. More...
 
void AddKey (string key, string version)
 Add a key and a version to be deleted. More...
 

Properties

string BucketName [get, set]
 The name of the bucket containing the objects to be deleted. More...
 
List< KeyVersionObjects [get, set]
 
bool Quiet [get, set]
 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. More...
 
MfaCodes MfaCodes [get, set]
 The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the Multi-Factor Authentication device associated with your AWS Account. More...
 

Detailed Description

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.

Member Function Documentation

void Amazon.S3.Model.DeleteObjectsRequest.AddKey ( string  key)

Add a key to the set of keys of objects to be deleted.

Parameters
keyObject key
void Amazon.S3.Model.DeleteObjectsRequest.AddKey ( string  key,
string  version 
)

Add a key and a version to be deleted.

Parameters
keyKey of the object to be deleted.
versionVersion of the object to be deleted.

Property Documentation

string Amazon.S3.Model.DeleteObjectsRequest.BucketName
getset

The name of the bucket containing the objects to be deleted.

MfaCodes Amazon.S3.Model.DeleteObjectsRequest.MfaCodes
getset

The MfaCodes Tuple associates the Serial Number and the current Token/Code displayed on the Multi-Factor Authentication device associated with your AWS Account.

This is a required property for this request if:

  1. EnableMfaDelete was configured on the bucket containing this object's version.
  2. You are deleting an object's version
bool Amazon.S3.Model.DeleteObjectsRequest.Quiet
getset

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.

By default this property is false and keys for both successful deletes and failures are returned in the response.


The documentation for this class was generated from the following files: