Table of Contents

Class DeleteObjectRequest

Namespace
Amazon.S3.Model
Assembly
AWSSDK.S3.dll

Container for the parameters to the DeleteObject 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. If there isn't a null version, Amazon S3 does not remove any objects but will still respond that the command was successful.

To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header, 

x-amz-delete-marker
, to true.

If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the 

x-amz-mfa
request header in the DELETE 
versionId
request. Requests that include 
x-amz-mfa
must use HTTPS.

For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.

You can delete objects by explicitly calling DELETE Object or configure its lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the 

s3:DeleteObject
, 
s3:DeleteObjectVersion
, and 
s3:PutLifeCycleConfiguration
actions.

The following action is related to 

DeleteObject
: 
public class DeleteObjectRequest : AmazonWebServiceRequest
Inheritance
DeleteObjectRequest

Constructors

DeleteObjectRequest() 

public DeleteObjectRequest()

Properties

BucketName

Gets and sets the property BucketName.

The bucket name of the bucket containing the object.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form 

AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide. 
public string BucketName { get; set; }

Property Value

string

BypassGovernanceRetention

Gets and sets the property BypassGovernanceRetention.

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the 

s3:PutBucketPublicAccessBlock
permission. 
public bool BypassGovernanceRetention { get; set; }

Property Value

bool

ExpectedBucketOwner

Gets and sets the property ExpectedBucketOwner.

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 

403 (Access Denied)
error. 
public string ExpectedBucketOwner { get; set; }

Property Value

string

Key

The key identifying the object to delete.

public string Key { get; set; }

Property Value

string

Remarks

This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." is interpreted as use parent directory. For further information view the documentation for the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri

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.

public MfaCodes MfaCodes { get; set; }

Property Value

MfaCodes

Remarks

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

RequestPayer

Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests.

public RequestPayer RequestPayer { get; set; }

Property Value

RequestPayer

VersionId

Gets and sets the property VersionId.

VersionId used to reference a specific version of the object. 

public string VersionId { get; set; }

Property Value

string