Skip to content

S3  >  Structures  >  ObjectLockRetention

ObjectLockRetention

Structure Class

ObjectLockRetention dataclass

Bases: _SerdeShape

A Retention configuration for an object.

Attributes

event_hold class-attribute instance-attribute 
event_hold: str | None = ...

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

event_hold_duration class-attribute instance-attribute 
event_hold_duration: EventHoldDuration | None = ...

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

mode class-attribute instance-attribute 
mode: str | None = ...

Indicates the Retention mode for the specified object.

retain_until_date class-attribute instance-attribute 
retain_until_date: datetime | None = ...

The date on which this Object Lock Retention will expire.