Table Of Contents

Feedback

User Guide

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

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.

[ aws . s3api ]

get-object-lock-configuration

Description

Gets the Object Lock configuration for a 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 .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-object-lock-configuration
--bucket <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--bucket (string)

The bucket whose Object Lock configuration you want to retrieve.

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

Examples

To retrieve an object lock configuration for a bucket

The following get-object-lock-configuration example retrieves the object lock configuration for the specified bucket.

aws s3api get-object-lock-configuration \
    --bucket my-bucket-with-object-lock

Output:

{
    "ObjectLockConfiguration": {
        "ObjectLockEnabled": "Enabled",
        "Rule": {
            "DefaultRetention": {
                "Mode": "COMPLIANCE",
                "Days": 50
            }
        }
    }
}

Output

ObjectLockConfiguration -> (structure)

The specified bucket's Object Lock configuration.

ObjectLockEnabled -> (string)

Indicates whether this bucket has an Object Lock configuration enabled.

Rule -> (structure)

The Object Lock rule in place for the specified object.

DefaultRetention -> (structure)

The default retention period that you want to apply to new objects placed in the specified bucket.

Mode -> (string)

The default Object Lock retention mode you want to apply to new objects placed in the specified bucket.

Days -> (integer)

The number of days that you want to specify for the default retention period.

Years -> (integer)

The number of years that you want to specify for the default retention period.