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. If there isn’t a null version, Zenko does not remove any objects.
See also: AWS API Documentation.
Synopsis¶
delete-object
--bucket <value>
--key <value>
[--mfa <value>]
[--version-id <value>]
[--bypass-governance-retention | --no-bypass-governance-retention]
[--cli-input-json <value>]
Options¶
--bucket
(string)
--key
(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.
--bypass-governance-retention
| --no-bypass-governance-retention
(Boolean)
Indicates whether S3 object lock should bypass governance-mode restrictions to process this operation.
--cli-input-json
(string)
Operates a service or services based on the provided JSON string. If other arguments are provided on the command line, the CLI values override the JSON-provided values. You cannot pass arbitrary binary values using a JSON-provided value, because the string is taken literally.
Examples¶
The following command deletes an object named “test.txt” from a bucket named “my-bucket”:
$ aws s3api delete-object --bucket my-bucket --key test.txt
If bucket versioning is enabled, the output will contain the version ID of the delete marker:
{
"VersionId": "9_gKg5vG56F.TTEUdwkxGpJ3tNDlWlGq",
"DeleteMarker": true
}
For more information about deleting objects, see Deleting Objects in the Amazon S3 Developer Guide.
Output¶
DeleteMarker -> (Boolean)
Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.
VersionId -> (string)
Returns the version ID of the delete marker created as a result of the DELETE operation.