Skip to content

PutObjectLockConfigurationRequest

Source code in docs_src/capo_s3/types/put_object_lock_configuration_request.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class PutObjectLockConfigurationRequest(TypedDict, closed=True):
    bucket: "capo_s3.types.bucket_name.BucketName"
    """<p>The bucket whose Object Lock configuration you want to create or replace.</p>"""
    object_lock_configuration: NotRequired[
        "capo_s3.types.object_lock_configuration.ObjectLockConfiguration"
    ]
    """<p>The Object Lock configuration that you want to apply to the specified bucket.</p>"""
    request_payer: NotRequired["capo_s3.types.request_payer.RequestPayer"]
    token: NotRequired["capo_s3.types.object_lock_token.ObjectLockToken"]
    """<p>A token to allow Object Lock to be enabled for an existing bucket.</p>"""
    content_md5: NotRequired["capo_s3.types.content_md5.ContentMD5"]
    """<p>The MD5 hash for the request body.</p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>"""
    checksum_algorithm: NotRequired[
        "capo_s3.types.checksum_algorithm.ChecksumAlgorithm"
    ]
    """<p>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 <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>"""
    expected_bucket_owner: NotRequired["capo_s3.types.account_id.AccountId"]
    """<p>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 <code>403 Forbidden</code> (access denied).</p>"""

bucket instance-attribute 

bucket: BucketName

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

checksum_algorithm instance-attribute 

checksum_algorithm: NotRequired[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.

content_md5 instance-attribute 

content_md5: NotRequired[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.

expected_bucket_owner instance-attribute 

expected_bucket_owner: NotRequired[AccountId]

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

object_lock_configuration instance-attribute 

object_lock_configuration: NotRequired[ObjectLockConfiguration]

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

request_payer instance-attribute 

request_payer: NotRequired[RequestPayer]

token instance-attribute 

token: NotRequired[ObjectLockToken]

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