putObjectLegalHold method

Puts or removes legal hold for an object version.

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

Users with the storage.uploader role can place or release a legal hold. To check a legal hold, use the getObjectLegalHold 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}?legal-hold&versionId={versionId} HTTP/2

Path parametersPath parameters

Query parametersQuery parameters

HeadersHeaders

Use the appropriate common headers in your request.

Data schemaData schema

<LegalHold xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Status>string</Status>
</LegalHold>

ResponseResponse

HeadersHeaders

Responses can only contain common response 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
• Example of signature generation code