Skip to main content
Go to Latest
class DeleteObjectCommand
extends $Command<DeleteObjectCommandInput, DeleteObjectCommandOutput, S3ClientResolvedConfig>
import { DeleteObjectCommand } from "https://deno.land/x/darkflare@v6.0.0/s3/mod.ts";
     <p>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,
     <code>x-amz-delete-marker</code>, to true. </p>

     <p>If the object you want to delete is in a bucket where the bucket versioning
     configuration is MFA Delete enabled, you must include the <code>x-amz-mfa</code> request
     header in the DELETE <code>versionId</code> request. Requests that include
        <code>x-amz-mfa</code> must use HTTPS. </p>

     <p> For more information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html">Using MFA Delete</a>. To see sample requests that use versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete">Sample Request</a>. </p>

     <p>You can delete objects by explicitly calling DELETE Object or configure its
     lifecycle (<a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>) 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 <code>s3:DeleteObject</code>,
        <code>s3:DeleteObjectVersion</code>, and <code>s3:PutLifeCycleConfiguration</code>
     actions. </p>

     <p>The following action is related to <code>DeleteObject</code>:</p>
     <ul>
        <li>
           <p>
              <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a>
           </p>
        </li>
     </ul>

Examples

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 command = new DeleteObjectCommand(input);
const response = await client.send(command);

Constructors

new
DeleteObjectCommand(input: DeleteObjectCommandInput)

Properties

private
deserialize
private
serialize
readonly
input: DeleteObjectCommandInput

Methods

resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: S3ClientResolvedConfig,
options?: __HttpHandlerOptions,
): Handler<DeleteObjectCommandInput, DeleteObjectCommandOutput>

Static Methods

getEndpointParameterInstructions(): EndpointParameterInstructions