import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DeleteObjectOutput, DeleteObjectRequest } from "../models/models_0"; import type { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DeleteObjectCommand}. */ export interface DeleteObjectCommandInput extends DeleteObjectRequest { } /** * @public * * The output of {@link DeleteObjectCommand}. */ export interface DeleteObjectCommandOutput extends DeleteObjectOutput, __MetadataBearer { } declare const DeleteObjectCommand_base: { new (input: DeleteObjectCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: DeleteObjectCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Removes an object from a bucket. The behavior depends on the bucket's versioning state:

* * *
    *
  • *

    * 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 specify null to the versionId 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 the * s3:DeleteObject permission.

      *
      • *
    • *

      * * s3:DeleteObjectVersion * - To delete a specific version of an object from a versioning-enabled * bucket, you must have the s3:DeleteObjectVersion permission.

      * *

      If the s3:DeleteObject or s3:DeleteObjectVersion permissions are explicitly * denied in your bucket policy, attempts to delete any unversioned objects * result in a 403 Access Denied error.

      *       *
      • *
    *
    • *
  • *

    * 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 the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession 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 another CreateSession 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, see * CreateSession * .

    *
    • *
*
*
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:

* * *

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

* * *

The If-Match header is supported for both general purpose and directory buckets. IfMatchLastModifiedTime and IfMatchSize is only supported for directory buckets.

* * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3Client, DeleteObjectCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, DeleteObjectCommand } = require("@aws-sdk/client-s3"); // CommonJS import * // import type { S3ClientConfig } from "@aws-sdk/client-s3"; * const config = {}; // type is S3ClientConfig * 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", * // }; * * ``` * * @param DeleteObjectCommandInput - {@link DeleteObjectCommandInput} * @returns {@link DeleteObjectCommandOutput} * @see {@link DeleteObjectCommandInput} for command's `input` shape. * @see {@link DeleteObjectCommandOutput} for command's `response` shape. * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape. * * @throws {@link S3ServiceException} *

Base exception class for all service exceptions from S3 service.

* * * @example To delete an object (from a non-versioned bucket) * ```javascript * // The following example deletes an object from a non-versioned bucket. * const input = { * Bucket: "ExampleBucket", * Key: "HappyFace.jpg" * }; * const command = new DeleteObjectCommand(input); * const response = await client.send(command); * /* response is * { /* metadata only *\/ } * *\/ * ``` * * @example To delete an object * ```javascript * // The following example deletes an object from an S3 bucket. * const input = { * Bucket: "examplebucket", * Key: "objectkey.jpg" * }; * const command = new DeleteObjectCommand(input); * const response = await client.send(command); * /* response is * { /* empty *\/ } * *\/ * ``` * * @public */ export declare class DeleteObjectCommand extends DeleteObjectCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DeleteObjectRequest; output: DeleteObjectOutput; }; sdk: { input: DeleteObjectCommandInput; output: DeleteObjectCommandOutput; }; }; }