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

The parameters to request deletion of an object in a bucket. The operation removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. More...

Inheritance diagram for Amazon.S3.Model.DeleteObjectRequest:

Properties

string BucketName [get, set]
 The name of the bucket containing the object to delete. More...
 
string Key [get, set]
 The key identifying the object to delete. More...
 
string VersionId [get, set]
 The identifier for the specific version of the object to be deleted, if required. 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

The parameters to request deletion of an object in a bucket. The operation removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object.

To remove a specific version, you must be the bucket owner and you must use the versionId subresource. Using this subresource permanently deletes the version.

If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include specify the MFA serial number and value in the request.

If there isn't a null version, Amazon S3 does not remove any objects.

Property Documentation

string Amazon.S3.Model.DeleteObjectRequest.BucketName
getset

The name of the bucket containing the object to delete.

string Amazon.S3.Model.DeleteObjectRequest.Key
getset

The key identifying the object to delete.

MfaCodes Amazon.S3.Model.DeleteObjectRequest.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
string Amazon.S3.Model.DeleteObjectRequest.VersionId
getset

The identifier for the specific version of the object to be deleted, if required.


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