Skip to content

Put Object Lock Configuration

s3_put_object_lock_configuration R Documentation

This operation is not supported by directory buckets

Description

This operation is not supported by 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.

  • The DefaultRetention settings require both a mode and a period.

  • The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

  • You can enable Object Lock for new or existing buckets. For more information, see Configuring Object Lock.

Usage

s3_put_object_lock_configuration(Bucket, ObjectLockConfiguration,
  RequestPayer, Token, ContentMD5, ChecksumAlgorithm, ExpectedBucketOwner)

Arguments

Bucket

[required] The bucket whose Object Lock configuration you want to create or replace.

ObjectLockConfiguration

The Object Lock configuration that you want to apply to the specified bucket.

RequestPayer
Token

A token to allow Object Lock to be enabled for an existing bucket.

ContentMD5

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

ChecksumAlgorithm

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 or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code ⁠400 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.

ExpectedBucketOwner

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).

Value

A list with the following syntax: 

list(
  RequestCharged = "requester"
)

Request syntax

svc$put_object_lock_configuration(
  Bucket = "string",
  ObjectLockConfiguration = list(
    ObjectLockEnabled = "Enabled",
    Rule = list(
      DefaultRetention = list(
        Mode = "GOVERNANCE"|"COMPLIANCE",
        Days = 123,
        Years = 123
      )
    )
  ),
  RequestPayer = "requester",
  Token = "string",
  ContentMD5 = "string",
  ChecksumAlgorithm = "CRC32"|"CRC32C"|"SHA1"|"SHA256",
  ExpectedBucketOwner = "string"
)