GetBucketOwnershipControls - Amazon Simple Storage Service

GetBucketOwnershipControls

Note

This operation is not supported by 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.

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

The following operations are related to GetBucketOwnershipControls:

Request Syntax

GET /?ownershipControls HTTP/1.1 Host: Bucket.s3.amazonaws.com x-amz-expected-bucket-owner: ExpectedBucketOwner

URI Request Parameters

The request uses the following URI parameters.

Bucket

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

Required: Yes

x-amz-expected-bucket-owner

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <OwnershipControls> <Rule> <ObjectOwnership>string</ObjectOwnership> </Rule> ... </OwnershipControls>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in XML format by the service.

OwnershipControls

Root level tag for the OwnershipControls parameters.

Required: Yes

Rule

The container element for an ownership control rule.

Type: Array of OwnershipControlsRule data types

Examples

Sample GetBucketOwnershipControls Request for BucketOwnerEnforced

This example illustrates one usage of GetBucketOwnershipControls.

GET /DOC-EXAMPLE-BUCKET?/ownershipControls HTTP/1.1 Host: DOC-EXAMPLE-BUCKET.s3.<Region>.amazonaws.com Date: Mon, 29 Nov 2021 00:17:22 GMT Authorization: signatureValue;

Sample GetBucketOwnershipControls Response

This example illustrates one usage of GetBucketOwnershipControls.

HTTP/1.1 200 OK x-amz-id-2: Adphn7MaAHDEg9mh5JmcTN8mzyVX0JhIztSiQNaqTxnXXcYi4uiZbYdwWC3JXmh/XXVUUQwO4Vs= x-amz-request-id: 252631E05F84A415 Date: Mon, 29 Nov 2021 00:17:22 GMT Server: AmazonS3 Content-Length: 194 <OwnershipControls xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Rule> <ObjectOwnership>BucketOwnerEnforced</ObjectOwnership> </Rule> </OwnershipControls>

Sample GetBucketOwnershipControls Request for BucketOwnerPreferred

This example illustrates one usage of GetBucketOwnershipControls.

GET /DOC-EXAMPLE-BUCKET?/ownershipControls HTTP/1.1 Host: DOC-EXAMPLE-BUCKET.s3.<Region>.amazonaws.com Date: Thu, 18 Jun 2017 00:17:22 GMT Authorization: signatureValue;

Sample GetBucketOwnershipControls Response

This example illustrates one usage of GetBucketOwnershipControls.

HTTP/1.1 200 OK x-amz-id-2: Adphn7MaAHDEg9mh5JmcTN8mzyVX0JhIztSiQNaqTxnXXcYi4uiZbYdwWC3JXmh/XXVUUQwO4Vs= x-amz-request-id: 252631E05F84A415 Date: Thu, 18 Jun 2020 00:17:22 GMT Server: AmazonS3 Content-Length: 194 <OwnershipControls xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Rule> <ObjectOwnership>BucketOwnerPreferred</ObjectOwnership> </Rule> </OwnershipControls>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: