S3 put object retention

The put object retention API places an object retention configuration on an object. A retention period protects an object version for a fixed amount of time. There are two modes: GOVERNANCE and COMPLIANCE. These two retention modes apply different levels of protection to your objects.

Note: During this period, your object is Write-Once-Read-Many (WORM-protected) and cannot be overwritten or deleted. For more information about the WORM model, see Ceph Object Gateway.

Syntax

PUT /BUCKET/OBJECT?retention&versionId= HTTP/1.1

Example

PUT /testbucket/testobject?retention&versionId= HTTP/1.1

The versionId sub-resource retrieves a particular version of the object.

Request Entities

Retention

Description: A container for the request.
Type: Container
Required: Yes

Mode

Description: Retention mode for the specified object.; Valid values: GOVERNANCE, COMPLIANCE.
Type: String
Required: Yes

RetainUntilDate

Description: Retention date.
Format: 2020-01-05T00:00:00.000Z
Type: Timestamp
Required: Yes

Reference

For more information about this API call, see S3 API.