DeleteObject
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 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
:
Request Syntax
DELETE /Key+
?versionId=VersionId
HTTP/1.1
Host: Bucket
.s3.amazonaws.com
x-amz-mfa: MFA
x-amz-request-payer: RequestPayer
x-amz-bypass-governance-retention: BypassGovernanceRetention
x-amz-expected-bucket-owner: ExpectedBucketOwner
URI Request Parameters
The request uses the following URI parameters.
- Bucket
-
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 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 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.Required: Yes
- Key
-
Key name of the object to delete.
Length Constraints: Minimum length of 1.
Required: Yes
- versionId
-
VersionId used to reference a specific version of the object.
- x-amz-bypass-governance-retention
-
Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the
s3:BypassGovernanceRetention
permission. - x-amz-expected-bucket-owner
-
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code
403 Forbidden
(access denied). - x-amz-mfa
-
The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.
- x-amz-request-payer
-
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
Valid Values:
requester
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 204
x-amz-delete-marker: DeleteMarker
x-amz-version-id: VersionId
x-amz-request-charged: RequestCharged
Response Elements
If the action is successful, the service sends back an HTTP 204 response.
The response returns the following HTTP headers.
- x-amz-delete-marker
-
Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.
- x-amz-request-charged
-
If present, indicates that the requester was successfully charged for the request.
Valid Values:
requester
- x-amz-version-id
-
Returns the version ID of the delete marker created as a result of the DELETE operation.
Examples
Sample Request
The following request deletes the object my-second-image.jpg
.
DELETE /my-second-image.jpg HTTP/1.1 Host: bucket.s3.<Region>.amazonaws.com Date: Wed, 12 Oct 2009 17:50:00 GMT Authorization: authorization string Content-Type: text/plain
Sample Response
This example illustrates one usage of DeleteObject.
HTTP/1.1 204 NoContent x-amz-id-2: LriYPLdmOdAiIfgSm/F1YsViT1LW94/xUQxMsF7xiEb1a0wiIOIxl+zbwZ163pt7 x-amz-request-id: 0A49CE4060975EAC Date: Wed, 12 Oct 2009 17:50:00 GMT Content-Length: 0 Connection: close Server: AmazonS3
Sample Request: Deleting a specified version of an object
The following request deletes the specified version of the object
my-third-image.jpg
.
DELETE /my-third-image.jpg?versionId=UIORUnfndfiufdisojhr398493jfdkjFJjkndnqUifhnw89493jJFJ HTTP/1.1 Host: bucket.s3.<Region>.amazonaws.com Date: Wed, 12 Oct 2009 17:50:00 GMT Authorization: authorization string Content-Type: text/plain Content-Length: 0
Sample Response
This example illustrates one usage of DeleteObject.
HTTP/1.1 204 NoContent x-amz-id-2: LriYPLdmOdAiIfgSm/F1YsViT1LW94/xUQxMsF7xiEb1a0wiIOIxl+zbwZ163pt7 x-amz-request-id: 0A49CE4060975EAC x-amz-version-id: UIORUnfndfiufdisojhr398493jfdkjFJjkndnqUifhnw89493jJFJ Date: Wed, 12 Oct 2009 17:50:00 GMT Content-Length: 0 Connection: close Server: AmazonS3
Sample Response: If the object deleted is a delete marker
This example illustrates one usage of DeleteObject.
HTTP/1.1 204 NoContent x-amz-id-2: LriYPLdmOdAiIfgSm/F1YsViT1LW94/xUQxMsF7xiEb1a0wiIOIxl+zbwZ163pt7 x-amz-request-id: 0A49CE4060975EAC x-amz-version-id: 3/L4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo x-amz-delete-marker: true Date: Wed, 12 Oct 2009 17:50:00 GMT Content-Length: 0 Connection: close Server: AmazonS3
Sample Request: Deleting a specified version of an object in an MFA-enabled bucket
The following request deletes the specified version of the object
my-third-image.jpg
, which is stored in an MFA-enabled bucket.
DELETE /my-third-image.jpg?versionId=UIORUnfndfiuf HTTP/1.1 Host: bucket.s3.<Region>.amazonaws.com Date: Wed, 12 Oct 2009 17:50:00 GMT x-amz-mfa:[SerialNumber] [AuthenticationCode] Authorization: authorization string Content-Type: text/plain Content-Length: 0
Sample Response
This example illustrates one usage of DeleteObject.
HTTP/1.1 204 NoContent x-amz-id-2: LriYPLdmOdAiIfgSm/F1YsViT1LW94/xUQxMsF7xiEb1a0wiIOIxl+zbwZ163pt7 x-amz-request-id: 0A49CE4060975EAC x-amz-version-id: UIORUnfndfiuf Date: Wed, 12 Oct 2009 17:50:00 GMT Content-Length: 0 Connection: close Server: AmazonS3
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: