Contact UsGet started

getObjectRetention method

Written by
Updated at September 30, 2024

Returns settings of the retention put on an object version.

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

Request

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

Path parameters

Parameter Description
bucket Bucket name.
key Object key.

Query parameters

Parameter Description
retention Required parameter that indicates the type of operation.
versionId Object version ID. This is a required parameter.

Headers

Use the appropriate common headers in your request.

Response

Headers

Responses can only contain common response headers.

Response codes

For a list of possible responses, see Responses.

Data schema

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

Type of retention:

  • GOVERNANCE: Object lock with governance-mode retention.
  • COMPLIANCE: Object lock with compliance-mode retention.

Path: Retention\Mode.
RetainUntilDate

Lock end date and time in the RFC3339 format, e.g., 2025-01-01T00:00:00. The lock end time value is specified in the UTC±00:00 time zone. To use a different time zone, add + or - and a UTC±00:00 offset to the end of the record.

Path: Retention\RetainUntilDate.

See also

Previous
putObjectLegalHold
Next
getObjectLegalHold