getObjectLegalHold method
Written by
Updated at September 30, 2024
Returns the settings of the legal hold placed on the 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}?legal-hold&versionId={versionId} HTTP/2
Path parameters
| Parameter | Description |
|---|---|
bucket |
Bucket name. |
key |
Object key. |
Query parameters
| Parameter | Description |
|---|---|
legal-hold |
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
<LegalHold xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<Status>string</Status>
</LegalHold>
| Element | Description |
|---|---|
Status |
Legal hold status:
Path: |