PutObjectLockConfiguration
Note
This operation is not supported for directory buckets.
Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
Note
-
The
DefaultRetention
settings require both a mode and a period. -
The
DefaultRetention
period can be eitherDays
orYears
but you must select one. You cannot specifyDays
andYears
at the same time. -
You can enable Object Lock for new or existing buckets. For more information, see Configuring Object Lock.
Request Syntax
PUT /?object-lock HTTP/1.1
Host: Bucket
.s3.amazonaws.com
x-amz-request-payer: RequestPayer
x-amz-bucket-object-lock-token: Token
Content-MD5: ContentMD5
x-amz-sdk-checksum-algorithm: ChecksumAlgorithm
x-amz-expected-bucket-owner: ExpectedBucketOwner
<?xml version="1.0" encoding="UTF-8"?>
<ObjectLockConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<ObjectLockEnabled>string
</ObjectLockEnabled>
<Rule>
<DefaultRetention>
<Days>integer
</Days>
<Mode>string
</Mode>
<Years>integer
</Years>
</DefaultRetention>
</Rule>
</ObjectLockConfiguration>
URI Request Parameters
The request uses the following URI parameters.
- Bucket
-
The bucket whose Object Lock configuration you want to create or replace.
Required: Yes
- Content-MD5
-
The MD5 hash for the request body.
For requests made using the Amazon Command Line Interface (CLI) or Amazon SDKs, this field is calculated automatically.
- x-amz-bucket-object-lock-token
-
A token to allow Object Lock to be enabled for an existing bucket.
- x-amz-expected-bucket-owner
-
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code
403 Forbidden
(access denied). - x-amz-request-payer
-
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
Note
This functionality is not supported for directory buckets.
Valid Values:
requester
- x-amz-sdk-checksum-algorithm
-
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
. For more information, see Checking object integrity in the Amazon S3 User Guide.If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter.Valid Values:
CRC32 | CRC32C | SHA1 | SHA256
Request Body
The request accepts the following data in XML format.
- ObjectLockConfiguration
-
Root level tag for the ObjectLockConfiguration parameters.
Required: Yes
- ObjectLockEnabled
-
Indicates whether this bucket has an Object Lock configuration enabled. Enable
ObjectLockEnabled
when you applyObjectLockConfiguration
to a bucket.Type: String
Valid Values:
Enabled
Required: No
- Rule
-
Specifies the Object Lock rule for the specified object. Enable the this rule when you apply
ObjectLockConfiguration
to a bucket. Bucket settings require both a mode and a period. The period can be eitherDays
orYears
but you must select one. You cannot specifyDays
andYears
at the same time.Type: ObjectLockRule data type
Required: No
Response Syntax
HTTP/1.1 200
x-amz-request-charged: RequestCharged
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
- x-amz-request-charged
-
If present, indicates that the requester was successfully charged for the request.
Note
This functionality is not supported for directory buckets.
Valid Values:
requester
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: