Amazon Simple Storage Service
API Reference (API Version 2006-03-01)

GetBucketPolicyStatus

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".

The following operations are related to GetBucketPolicyStatus:

Request Syntax

GET /?policyStatus HTTP/1.1 Host: Bucket.s3.amazonaws.com

URI Request Parameters

The request requires the following URI parameters.

Bucket

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <PolicyStatus> <IsPublic>boolean</IsPublic> </PolicyStatus>

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.

PolicyStatus

Root level tag for the PolicyStatus parameters.

Required: Yes

IsPublic

The policy status for this bucket. TRUE indicates that this bucket is public. FALSE indicates that the bucket is not public.

Type: Boolean

Examples

Sample Request

The following request gets a bucket policy status.

GET /<bucket-name>?policyStatus HTTP/1.1 Host: <bucket-name>.s3.amazonaws.com x-amz-date: <Thu, 15 Nov 2016 00:17:21 GMT> Authorization: <signatureValue>

Sample Response

HTTP/1.1 200 OK x-amz-id-2: ITnGT1y4REXAMPLEPi4hklTXouTf0hccUjo0iCPEXAMPLEutBj3M7fPGlWO2SEWp x-amz-request-id: 51991EXAMPLE5321 Date: Thu, 15 Nov 2016 00:17:22 GMT Server: AmazonS3 Content-Length: 0 <PolicyStatus> <IsPublic>TRUE</IsPublic> </PolicyStatus>

See Also

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