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
Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format
bucket-base-name--zone-id--x-s3 (for example,
amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming
restrictions, see Directory bucket naming
rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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.
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
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@ibm-cos/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 name of the object to delete.
OptionalMFAThe 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.
OptionalVersionVersion ID used to reference a specific version of the object.
For directory buckets in this API operation, only the null value of the version ID is supported.
OptionalRequestConfirms 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 the corresponding charges. 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.
OptionalBypassIndicates whether S3 Object Lock should bypass Governance-mode restrictions to process this
operation. To use this header, you must have the s3:BypassGovernanceRetention
permission.
This functionality is not supported for directory buckets.
OptionalExpectedThe 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 403 Forbidden (access denied).
OptionalIfDeletes the object if the ETag (entity tag) value provided during the delete operation matches the ETag of the object in S3.
If the ETag values do not match, the operation returns a 412 Precondition Failed error.
Expects the ETag value as a string. If-Match does accept a string value of an '*' (asterisk) character to denote a match of any ETag.
For more information about conditional requests, see RFC 7232.
OptionalIfIf present, the object is deleted only if its modification times matches the provided
Timestamp. If the Timestamp values do not match, the operation returns a
412 Precondition Failed error. If the Timestamp matches or if the object
doesn’t exist, the operation returns a 204 Success (No Content) response.
This functionality is only supported for directory buckets.
OptionalIfIf present, the object is deleted only if its size matches the provided size in bytes. If the
Size value does not match, the operation returns a 412 Precondition Failed
error. If the Size matches or if the object doesn’t exist, the operation returns a
204 Success (No Content) response.
This functionality is only supported for directory buckets.
You can use the If-Match, x-amz-if-match-last-modified-time and
x-amz-if-match-size conditional headers in conjunction with each-other or
individually.
The input for DeleteObjectCommand.