get_bucket_ownership_controls

get_bucket_ownership_controls(**kwargs)

Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in a policy.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to GetBucketOwnershipControls :

• PutBucketOwnershipControls
• DeleteBucketOwnershipControls

See also: AWS API Documentation

Request Syntax

response = client.get_bucket_ownership_controls(
    Bucket='string',
    ExpectedBucketOwner='string'
)

Parameters

• Bucket (string) --

  [REQUIRED]

  The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve.

• ExpectedBucketOwner (string) -- The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Return type

dict

Returns

Response Syntax

{
    'OwnershipControls': {
        'Rules': [
            {
                'ObjectOwnership': 'BucketOwnerPreferred'|'ObjectWriter'|'BucketOwnerEnforced'
            },
        ]
    }
}

Response Structure

• (dict) --

  • OwnershipControls (dict) --

    The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) currently in effect for this Amazon S3 bucket.

    • Rules (list) --

      The container element for an ownership control rule.

      • (dict) --

        The container element for an ownership control rule.

        • ObjectOwnership (string) --

          The container element for object ownership for a bucket's ownership controls.

          BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control canned ACL.

          ObjectWriter - The uploading account will own the object if the object is uploaded with the bucket-owner-full-control canned ACL.

          BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL or bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format.