Skip to content

S3Retention

Source code in docs_src/capo_s3_control/types/s3_retention.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class S3Retention(TypedDict, closed=True):
    retain_until_date: NotRequired["capo_s3_control.types.time_stamp.TimeStamp"]
    """<p>The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.</p>"""
    mode: NotRequired[
        "capo_s3_control.types.s3_object_lock_retention_mode.S3ObjectLockRetentionMode"
    ]
    """<p>The Object Lock retention mode to be applied to all objects in the Batch Operations job.</p>"""
    event_hold: NotRequired[
        "capo_s3_control.types.s3_object_lock_retention_event_hold.S3ObjectLockRetentionEventHold"
    ]
    """<p>The event hold status to be applied to all objects in the Batch Operations job. Set to <code>ON</code> to enable an event hold or <code>OFF</code> to disable it.</p>"""
    event_hold_duration: NotRequired[
        "capo_s3_control.types.s3_object_lock_retention_event_hold_duration.S3ObjectLockRetentionEventHoldDuration"
    ]
    """<p>The event hold duration to be applied to all objects in the Batch Operations job. The duration specifies how long the object remains protected after the event hold is released.</p>"""

event_hold instance-attribute 

event_hold: NotRequired[S3ObjectLockRetentionEventHold]

The event hold status to be applied to all objects in the Batch Operations job. Set to ON to enable an event hold or OFF to disable it.

event_hold_duration instance-attribute 

event_hold_duration: NotRequired[S3ObjectLockRetentionEventHoldDuration]

The event hold duration to be applied to all objects in the Batch Operations job. The duration specifies how long the object remains protected after the event hold is released.

mode instance-attribute 

mode: NotRequired[S3ObjectLockRetentionMode]

The Object Lock retention mode to be applied to all objects in the Batch Operations job.

retain_until_date instance-attribute 

retain_until_date: NotRequired[TimeStamp]

The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.