Skip to content

DeletedObject

Source code in docs_src/capo_s3/types/deleted_object.py
class DeletedObject(TypedDict, closed=True):
    key: NotRequired["capo_s3.types.object_key.ObjectKey"]
    """<p>The name of the deleted object.</p>"""
    version_id: NotRequired["capo_s3.types.object_version_id.ObjectVersionId"]
    """<p>The version ID of the deleted object.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>"""
    delete_marker: NotRequired["capo_s3.types.delete_marker.DeleteMarker"]
    """<p>Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker. To learn more about delete markers, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html">Working with delete markers</a>.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>"""
    delete_marker_version_id: NotRequired[
        "capo_s3.types.delete_marker_version_id.DeleteMarkerVersionId"
    ]
    """<p>The version ID of the delete marker created as a result of the DELETE operation. If you delete a specific object version, the value returned by this header is the version ID of the object version deleted.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>"""

delete_marker instance-attribute

delete_marker: NotRequired[DeleteMarker]

Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker. To learn more about delete markers, see Working with delete markers.

This functionality is not supported for directory buckets.

delete_marker_version_id instance-attribute

delete_marker_version_id: NotRequired[DeleteMarkerVersionId]

The version ID of the delete marker created as a result of the DELETE operation. If you delete a specific object version, the value returned by this header is the version ID of the object version deleted.

This functionality is not supported for directory buckets.

key instance-attribute

key: NotRequired[ObjectKey]

The name of the deleted object.

version_id instance-attribute

version_id: NotRequired[ObjectVersionId]

The version ID of the deleted object.

This functionality is not supported for directory buckets.