Skip to content

PutBucketAclRequest

Source code in docs_src/capo_s3/types/put_bucket_acl_request.py
class PutBucketAclRequest(TypedDict, closed=True):
    acl: NotRequired["capo_s3.types.bucket_canned_acl.BucketCannedACL"]
    """<p>The canned ACL to apply to the bucket.</p>"""
    access_control_policy: NotRequired[
        "capo_s3.types.access_control_policy.AccessControlPolicy"
    ]
    """<p>Contains the elements that set the ACL permissions for an object per grantee.</p>"""
    bucket: "capo_s3.types.bucket_name.BucketName"
    """<p>The bucket to which to apply the ACL.</p>"""
    content_md5: NotRequired["capo_s3.types.content_md5.ContentMD5"]
    """<p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864.</a> </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 request 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>"""
    grant_full_control: NotRequired["capo_s3.types.grant_full_control.GrantFullControl"]
    """<p>Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.</p>"""
    grant_read: NotRequired["capo_s3.types.grant_read.GrantRead"]
    """<p>Allows grantee to list the objects in the bucket.</p>"""
    grant_read_acp: NotRequired["capo_s3.types.grant_read_acp.GrantReadACP"]
    """<p>Allows grantee to read the bucket ACL.</p>"""
    grant_write: NotRequired["capo_s3.types.grant_write.GrantWrite"]
    """<p>Allows grantee to create new objects in the bucket.</p> <p>For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.</p>"""
    grant_write_acp: NotRequired["capo_s3.types.grant_write_acp.GrantWriteACP"]
    """<p>Allows grantee to write the ACL for the applicable bucket.</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>"""

access_control_policy instance-attribute

access_control_policy: NotRequired[AccessControlPolicy]

Contains the elements that set the ACL permissions for an object per grantee.

acl instance-attribute

acl: NotRequired[BucketCannedACL]

The canned ACL to apply to the bucket.

bucket instance-attribute

bucket: BucketName

The bucket to which to apply the ACL.

checksum_algorithm instance-attribute

checksum_algorithm: NotRequired[ChecksumAlgorithm]

Indicates the algorithm used to create the checksum for the request 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 Base64 encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

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

grant_full_control instance-attribute

grant_full_control: NotRequired[GrantFullControl]

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

grant_read instance-attribute

grant_read: NotRequired[GrantRead]

Allows grantee to list the objects in the bucket.

grant_read_acp instance-attribute

grant_read_acp: NotRequired[GrantReadACP]

Allows grantee to read the bucket ACL.

grant_write instance-attribute

grant_write: NotRequired[GrantWrite]

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

grant_write_acp instance-attribute

grant_write_acp: NotRequired[GrantWriteACP]

Allows grantee to write the ACL for the applicable bucket.