put_object_lock_configuration¶
Operation¶
async
¶
put_object_lock_configuration(input: PutObjectLockConfigurationInput, plugins: list[Plugin] | None = None) -> PutObjectLockConfigurationOutput
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
DefaultRetentionsettings require both a mode and a period. -
The
DefaultRetentionperiod can be eitherDaysorYearsbut you must select one. You cannot specifyDaysandYearsat the same time. -
You can enable Object Lock for new or existing buckets. For more information, see Configuring Object Lock.
Warning:
You must URL encode any signed header values that contain spaces. For
example, if your header value is my file.txt, containing two spaces
after my, you must URL encode this value to my%20%20file.txt.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PutObjectLockConfigurationInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
PutObjectLockConfigurationOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for PutObjectLockConfigurationInput structure.
Attributes¶
class-attribute
instance-attribute
¶
bucket: str | None = ...
The bucket whose Object Lock configuration you want to create or replace.
class-attribute
instance-attribute
¶
checksum_algorithm: str | None = ...
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.
class-attribute
instance-attribute
¶
content_md5: str | None = ...
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.
class-attribute
instance-attribute
¶
expected_bucket_owner: str | None = ...
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).
class-attribute
instance-attribute
¶
The Object Lock configuration that you want to apply to the specified bucket.
class-attribute
instance-attribute
¶
request_payer: str | None = ...
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 the corresponding charges. 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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for PutObjectLockConfigurationOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
request_charged: str | None = ...
If present, indicates that the requester was successfully charged for the request. For more information, see Using Requester Pays buckets for storage transfers and usage in the Amazon Simple Storage Service user guide.
Note
This functionality is not supported for directory buckets.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.