Class DeleteObjectRequest
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.
public class DeleteObjectRequest : AmazonWebServiceRequest- Inheritance
-
DeleteObjectRequest
Remarks
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.
Constructors
DeleteObjectRequest()
public DeleteObjectRequest()Properties
BucketName
The bucket name of the bucket containing the object.
When using this API 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 operation with an access point through the AWS 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 Simple Storage Service Developer Guide.
When using this API 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 using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
public string BucketName { get; set; }Property Value
BypassGovernanceRetention
Gets and sets the property BypassGovernanceRetention.
public bool BypassGovernanceRetention { get; set; }Property Value
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
Key
The key identifying the object to delete.
public string Key { get; set; }Property Value
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
Remarks
This is a required property for this request if:
- EnableMfaDelete was configured on the bucket
containing this object's version.
- You are deleting an object's version
RequestPayer
Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.
public RequestPayer RequestPayer { get; set; }Property Value
VersionId
The identifier for the specific version of the object to be deleted, if required.
public string VersionId { get; set; }