Skip to content

ObjectLockRetention

Source code in docs_src/capo_s3/types/object_lock_retention.py
class ObjectLockRetention(TypedDict, closed=True):
    mode: NotRequired[
        "capo_s3.types.object_lock_retention_mode.ObjectLockRetentionMode"
    ]
    """<p>Indicates the Retention mode for the specified object.</p>"""
    retain_until_date: NotRequired["capo_s3.types.date.Date"]
    """<p>The date on which this Object Lock Retention will expire.</p>"""
    event_hold: NotRequired["capo_s3.types.object_lock_event_hold.ObjectLockEventHold"]
    """<p>The event hold status for the object. Set to <code>ON</code> to enable an event hold or <code>OFF</code> to disable it.</p>"""
    event_hold_duration: NotRequired[
        "capo_s3.types.event_hold_duration.EventHoldDuration"
    ]
    """<p>The event hold duration for the object. Specifies how long the object remains protected after the event hold is released.</p>"""

event_hold instance-attribute

event_hold: NotRequired[ObjectLockEventHold]

The event hold status for the object. Set to ON to enable an event hold or OFF to disable it.

event_hold_duration instance-attribute

event_hold_duration: NotRequired[EventHoldDuration]

The event hold duration for the object. Specifies how long the object remains protected after the event hold is released.

mode instance-attribute

mode: NotRequired[ObjectLockRetentionMode]

Indicates the Retention mode for the specified object.

retain_until_date instance-attribute

retain_until_date: NotRequired[Date]

The date on which this Object Lock Retention will expire.