Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . s3api ]



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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--bucket <value>
[--object-lock-configuration <value>]
[--request-payer <value>]
[--token <value>]
[--content-md5 <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.

Shorthand Syntax:


JSON Syntax:

  "ObjectLockEnabled": "Enabled",
  "Rule": {
    "DefaultRetention": {
      "Days": integer,
      "Years": integer

--request-payer (string)

Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at

Possible values:

  • requester

--token (string)

A token to allow Amazon S3 object lock to be enabled for an existing bucket.

--content-md5 (string)

The MD5 hash for the request body.

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


RequestCharged -> (string)

If present, indicates that the requester was successfully charged for the request.