getObjectRetention method
Written by
Updated at October 27, 2023
Returns settings of the retention put on an object version.
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 necessary common request headers in requests.
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:
Path: |
RetainUntilDate |
Lock end date and time in the RFC3339 Path: |