- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteObjectCommand
Removes an object from a bucket. The behavior depends on the bucket's versioning state:
-
If bucket versioning is not enabled, the operation permanently deletes the object.
-
If bucket versioning is enabled, the operation inserts a delete marker, which becomes the current version of the object. To permanently delete an object in a versioned bucket, you must include the object’s
versionId
in the request. For more information about versioning-enabled buckets, see Deleting object versions from a versioning-enabled bucket . -
If bucket versioning is suspended, the operation removes the object that has a null
versionId
, if there is one, and inserts a delete marker that becomes the current version of the object. If there isn't an object with a nullversionId
, and all versions of the object have aversionId
, Amazon S3 does not remove the object and only inserts a delete marker. To permanently delete an object that has aversionId
, you must include the object’sversionId
in the request. For more information about versioning-suspended buckets, see Deleting objects from versioning-suspended buckets .
-
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the
null
value of the version ID is supported by directory buckets. You can only specifynull
to theversionId
query parameter in the request. -
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format
https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name
. Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
To remove a specific version, you must use the versionId
query parameter. Using this query parameter 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 in the Amazon S3 User Guide. To see sample requests that use versioning, see Sample Request .
Directory buckets - MFA delete is not supported by directory buckets.
You can delete objects by explicitly calling DELETE Object or calling (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.
Directory buckets - S3 Lifecycle is not supported by directory buckets.
- Permissions
-
-
General purpose bucket permissions - The following permissions are required in your policies when your
DeleteObjects
request includes specific headers.-
s3:DeleteObject
- To delete an object from a bucket, you must always have thes3:DeleteObject
permission. -
s3:DeleteObjectVersion
- To delete a specific version of an object from a versioning-enabled bucket, you must have thes3:DeleteObjectVersion
permission.
-
-
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the
CreateSession
API operation for session-based authorization. Specifically, you grant thes3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make anotherCreateSession
API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, seeCreateSession
.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket-name.s3express-zone-id.region-code.amazonaws.com
.
The following action is related to DeleteObject
:
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { S3Client, DeleteObjectCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, DeleteObjectCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // DeleteObjectRequest
Bucket: "STRING_VALUE", // required
Key: "STRING_VALUE", // required
MFA: "STRING_VALUE",
VersionId: "STRING_VALUE",
RequestPayer: "requester",
BypassGovernanceRetention: true || false,
ExpectedBucketOwner: "STRING_VALUE",
IfMatch: "STRING_VALUE",
IfMatchLastModifiedTime: new Date("TIMESTAMP"),
IfMatchSize: Number("long"),
};
const command = new DeleteObjectCommand(input);
const response = await client.send(command);
// { // DeleteObjectOutput
// DeleteMarker: true || false,
// VersionId: "STRING_VALUE",
// RequestCharged: "requester",
// };
Example Usage
DeleteObjectCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
Bucket Required | string | undefined | The bucket name of the bucket containing the object. Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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. Access points and Object Lambda access points are not supported by directory buckets. S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues |
Key Required | string | undefined | Key name of the object to delete. |
BypassGovernanceRetention | boolean | undefined | Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the This functionality is not supported for directory buckets. |
ExpectedBucketOwner | string | undefined | The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code |
IfMatch | string | undefined | The For more information about conditional requests, see RFC 7232 . This functionality is only supported for directory buckets. |
IfMatchLastModifiedTime | Date | undefined | If present, the object is deleted only if its modification times matches the provided This functionality is only supported for directory buckets. |
IfMatchSize | number | undefined | If present, the object is deleted only if its size matches the provided size in bytes. If the This functionality is only supported for directory buckets. You can use the |
MFA | string | undefined | 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. This functionality is not supported for directory buckets. |
RequestPayer | RequestPayer | undefined | Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide. This functionality is not supported for directory buckets. |
VersionId | string | undefined | Version ID used to reference a specific version of the object. For directory buckets in this API operation, only the |
DeleteObjectCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
DeleteMarker | boolean | undefined | Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker. To learn more about delete markers, see Working with delete markers . This functionality is not supported for directory buckets. |
RequestCharged | RequestCharged | undefined | If present, indicates that the requester was successfully charged for the request. This functionality is not supported for directory buckets. |
VersionId | string | undefined | Returns the version ID of the delete marker created as a result of the DELETE operation. This functionality is not supported for directory buckets. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
S3ServiceException | Base exception class for all service exceptions from S3 service. |