Method: Aws::S3::Client#delete_object

Defined in:: lib/aws-sdk-s3/client.rb

#delete_object(params = {}) ⇒ `Types::DeleteObjectOutput`

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.

Examples:

Example: To delete an object (from a non-versioned bucket)


# The following example deletes an object from a non-versioned bucket.

resp = client.delete_object({
  bucket: "ExampleBucket", 
  key: "HappyFace.jpg", 
})

Example: To delete an object


# The following example deletes an object from an S3 bucket.

resp = client.delete_object({
  bucket: "examplebucket", 
  key: "objectkey.jpg", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.delete_object({
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  mfa: "MFA",
  version_id: "ObjectVersionId",
  request_payer: "requester", # accepts requester
})

Response structure


resp.delete_marker #=> Boolean
resp.version_id #=> String
resp.request_charged #=> String, one of "requester"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:bucket (required, String)
:key (required, String)
:mfa (String) —

The concatenation of the authentication device’s serial number, a space, and the value that is displayed on your authentication device.
:version_id (String) —

VersionId used to reference a specific version of the object.
:request_payer (String) —

Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

(Types::DeleteObjectOutput) —
Returns a response object which responds to the following methods:
- #delete_marker => Boolean
- #version_id => String
- #request_charged => String