Get Bucket Ownership Controls

s3_get_bucket_ownership_controls

R Documentation

This operation is not supported for directory buckets¶

Description¶

This operation is not supported for directory buckets.

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.

A bucket doesn't have OwnershipControls settings in the following cases:

The bucket was created before the BucketOwnerEnforced ownership setting was introduced and you've never explicitly applied this value
You've manually deleted the bucket ownership control value using the delete_bucket_ownership_controls API operation.

By default, Amazon S3 sets OwnershipControls for all newly created buckets.

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

The following operations are related to get_bucket_ownership_controls:

put_bucket_ownership_controls
delete_bucket_ownership_controls

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

Usage¶

s3_get_bucket_ownership_controls(Bucket, ExpectedBucketOwner)

Arguments¶

Bucket

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

ExpectedBucketOwner

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

Value¶

A list with the following syntax:

list(
  OwnershipControls = list(
    Rules = list(
      list(
        ObjectOwnership = "BucketOwnerPreferred"|"ObjectWriter"|"BucketOwnerEnforced"
      )
    )
  )
)

Request syntax¶

svc$get_bucket_ownership_controls(
  Bucket = "string",
  ExpectedBucketOwner = "string"
)