paws.storage (version 0.1.0)

s3_delete_object: Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object

Description

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.

Usage

s3_delete_object(Bucket, Key, MFA, VersionId, RequestPayer,
  BypassGovernanceRetention)

Arguments

Bucket

[required]

Key

[required]

MFA

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

VersionId

VersionId used to reference a specific version of the object.

RequestPayer

BypassGovernanceRetention

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.

Request syntax

svc$delete_object(
  Bucket = "string",
  Key = "string",
  MFA = "string",
  VersionId = "string",
  RequestPayer = "requester",
  BypassGovernanceRetention = TRUE|FALSE
)

Examples

# NOT RUN {
# The following example deletes an object from a non-versioned bucket.
# }
# NOT RUN {
svc$delete_object(
  Bucket = "ExampleBucket",
  Key = "HappyFace.jpg"
)
# }
# NOT RUN {
# The following example deletes an object from an S3 bucket.
# }
# NOT RUN {
svc$delete_object(
  Bucket = "examplebucket",
  Key = "objectkey.jpg"
)
# }
# NOT RUN {
# }