putObjectRetention method

Puts retention on the object version or configures/disables a previously set lock.

To be able to put locks on object versions, enable object lock in the bucket using the putObjectLockConfiguration method.

Only a user with the storage.admin role can change a lock once it was set. For a governance-mode retention, use a header that confirms retention bypass (see below). You can only extend compliance-mode retention. To check the retention status, use the getObjectRetention method.

For more information on getting started with the API and the general request format, see How to use the S3 API.

RequestRequest

PUT /{bucket}/{key}?retention&versionId={versionId} HTTP/2

Path parametersPath parameters

Request parametersRequest parameters

HeadersHeaders

Use the appropriate common headers in your request.

Moreover, if the governance-mode retention is set for an object version, make sure to use the below-specified header to bypass the retention and confirm its change.

Data schemaData schema

<Retention xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Mode>string</Mode>
    <RetainUntilDate>timestamp</RetainUntilDate>
</Retention>

ResponseResponse

HeadersHeaders

Responses can only contain common headers.

Response codesResponse codes

For a list of possible responses, see Responses.

See alsoSee also

• Debugging requests using the AWS CLI
• Example of sending a signed request using curl
• Code example for generating a signature