Skip to content

ObjectIdentifier

Source code in docs_src/capo_s3/types/object_identifier.py
class ObjectIdentifier(TypedDict, closed=True):
    key: "capo_s3.types.object_key.ObjectKey"
    """<p>Key name of the object.</p> <important> <p>Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints"> XML related object key constraints</a>.</p> </important>"""
    version_id: NotRequired["capo_s3.types.object_version_id.ObjectVersionId"]
    """<p>Version ID for the specific version of the object to delete.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>"""
    e_tag: NotRequired["capo_s3.types.e_tag.ETag"]
    """<p>An entity tag (ETag) is an identifier assigned by a web server to a specific version of a resource found at a URL. This header field makes the request method conditional on <code>ETags</code>. </p> <note> <p>Entity tags (ETags) for S3 Express One Zone are random alphanumeric strings unique to the object. </p> </note>"""
    last_modified_time: NotRequired["capo_s3.types.last_modified_time.LastModifiedTime"]
    """<p>If present, the objects are deleted only if its modification times matches the provided <code>Timestamp</code>. </p> <note> <p>This functionality is only supported for directory buckets.</p> </note>"""
    size: NotRequired["capo_s3.types.size.Size"]
    """<p>If present, the objects are deleted only if its size matches the provided size in bytes. </p> <note> <p>This functionality is only supported for directory buckets.</p> </note>"""

e_tag instance-attribute

e_tag: NotRequired[ETag]

An entity tag (ETag) is an identifier assigned by a web server to a specific version of a resource found at a URL. This header field makes the request method conditional on ETags.

Entity tags (ETags) for S3 Express One Zone are random alphanumeric strings unique to the object.

key instance-attribute

key: ObjectKey

Key name of the object.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

last_modified_time instance-attribute

last_modified_time: NotRequired[LastModifiedTime]

If present, the objects are deleted only if its modification times matches the provided Timestamp.

This functionality is only supported for directory buckets.

size instance-attribute

size: NotRequired[Size]

If present, the objects are deleted only if its size matches the provided size in bytes.

This functionality is only supported for directory buckets.

version_id instance-attribute

version_id: NotRequired[ObjectVersionId]

Version ID for the specific version of the object to delete.

This functionality is not supported for directory buckets.