View a markdown version of this page

ObjectLockRetention - Amazon S3

ObjectLockRetention

A Retention configuration for an object.

Contents

EventHold

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

Type: String

Valid Values: ON | OFF

Required: No

EventHoldDuration

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

Type: EventHoldDuration data type

Required: No

Mode

Indicates the Retention mode for the specified object.

Type: String

Valid Values: GOVERNANCE | COMPLIANCE

Required: No

RetainUntilDate

The date on which this Object Lock Retention will expire.

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: