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.
Base exception class for all service exceptions from S3 service.
Example
To delete an object (from a non-versioned bucket)
// The following example deletes an object from a non-versioned bucket. constinput = { "Bucket":"ExampleBucket", "Key":"HappyFace.jpg" }; constcommand = newDeleteObjectCommand(input); awaitclient.send(command); // example id: to-delete-an-object-from-a-non-versioned-bucket-1481588533089
Example
To delete an object
// The following example deletes an object from an S3 bucket. constinput = { "Bucket":"examplebucket", "Key":"objectkey.jpg" }; constcommand = newDeleteObjectCommand(input); awaitclient.send(command); // example id: to-delete-an-object-1472850136595
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 DELETEversionId
request. Requests that includex-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
, ands3:PutLifeCycleConfiguration
actions.The following action is related to
DeleteObject
:PutObject
Example
Use a bare-bones client and the command you need to make an API call.
Param
DeleteObjectCommandInput
Returns
DeleteObjectCommandOutput
See
input
shape.response
shape.config
shape.Throws
S3ServiceException
Base exception class for all service exceptions from S3 service.
Example
To delete an object (from a non-versioned bucket)
Example
To delete an object