Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).
AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
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
DefaultRetention
settings require both a mode and a period.DefaultRetention
period can be either Days
or Years
but you must select one. You cannot specify Days
and Years
at the same time.See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
put-object-lock-configuration
--bucket <value>
[--object-lock-configuration <value>]
[--request-payer <value>]
[--token <value>]
[--content-md5 <value>]
[--checksum-algorithm <value>]
[--expected-bucket-owner <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
--bucket
(string)
The bucket whose Object Lock configuration you want to create or replace.
--object-lock-configuration
(structure)
The Object Lock configuration that you want to apply to the specified bucket.
ObjectLockEnabled -> (string)
Indicates whether this bucket has an Object Lock configuration enabled. EnableObjectLockEnabled
when you applyObjectLockConfiguration
to a bucket.Rule -> (structure)
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.DefaultRetention -> (structure)
The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. Bucket settings require both a mode and a period. The period can be either
Days
orYears
but you must select one. You cannot specifyDays
andYears
at the same time.Mode -> (string)
The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with eitherDays
orYears
.Days -> (integer)
The number of days that you want to specify for the default retention period. Must be used withMode
.Years -> (integer)
The number of years that you want to specify for the default retention period. Must be used withMode
.
Shorthand Syntax:
ObjectLockEnabled=string,Rule={DefaultRetention={Mode=string,Days=integer,Years=integer}}
JSON Syntax:
{
"ObjectLockEnabled": "Enabled",
"Rule": {
"DefaultRetention": {
"Mode": "GOVERNANCE"|"COMPLIANCE",
"Days": integer,
"Years": integer
}
}
}
--request-payer
(string)
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide .
Possible values:
requester
--token
(string)
A token to allow Object Lock to be enabled for an existing bucket.
--content-md5
(string)
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.
--checksum-algorithm
(string)
Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending 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.Possible values:
CRC32
CRC32C
SHA1
SHA256
--expected-bucket-owner
(string)
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code403 Forbidden
(access denied).
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See 'aws help' for descriptions of global parameters.
To set an object lock configuration on a bucket
The following put-object-lock-configuration
example sets a 50-day object lock on the specified bucket.
aws s3api put-object-lock-configuration \
--bucket my-bucket-with-object-lock \
--object-lock-configuration '{ "ObjectLockEnabled": "Enabled", "Rule": { "DefaultRetention": { "Mode": "COMPLIANCE", "Days": 50 }}}'
This command produces no output.
RequestCharged -> (string)
If present, indicates that the requester was successfully charged for the request.