GetBucketPolicy
Returns the policy of a specified bucket in JSON format.
Description
The GetBucketPolicy operation returns the policy of the specified bucket. If you are using an identity other than the root user of the account that owns the bucket, the calling identity must have the s3:GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account.
note
- To use this operation, you must have permission to perform the
s3:GetBucketPolicyaction. - You must be the bucket owner to use this operation.
- If there is no policy on the bucket, QStorage returns a
NoSuchBucketPolicyerror.
Request Syntax
GET /?policy HTTP/1.1
Host: BucketName.qstorage.quilibrium.com
x-amz-expected-bucket-owner: OwnerAccountId
Values in italics indicate user input and should be replaced with actual values.
This operation does not have a request body.
Request Parameters
Headers
| Name | Description | Required | Type |
|---|---|---|---|
| x-amz-expected-bucket-owner | The account ID of the expected bucket owner | No | text |
Examples
Example 1: Get bucket policy
GET /?policy HTTP/1.1
Host: my-bucket.qstorage.quilibrium.com
Values in italics indicate user input and should be replaced with actual values.
HTTP/1.1 200 OK
x-amz-id-2: Example7qoYGN7uMuFuYS6m7a4l
x-amz-request-id: TX234S0F24A06C7
Date: Wed, 01 Mar 2024 12:00:00 GMT
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "PublicReadGetObject",
"Effect": "Allow",
"Principal": "*",
"Action": "s3:GetObject",
"Resource": "arn:aws:s3:::my-bucket/*"
}
]
}
Values in italics indicate variable response values.
Response Syntax
HTTP/1.1 200 OK
x-amz-id-2: RequestId
x-amz-request-id: AmazonRequestId
Date: ISO8601Date
{
"Version": "Version",
"Statement": [
{
"Sid": "StatementId",
"Effect": "Effect",
"Principal": "Principal",
"Action": "Action",
"Resource": "Resource",
"Condition": {
"ConditionOperator": {
"ConditionKey": "ConditionValue"
}
}
}
]
}
Values in italics indicate variable response values.
Response Elements
Response Headers
| Name | Description | Required | Type |
|---|---|---|---|
| x-amz-id-2 | An identifier for the request | No | String |
| x-amz-request-id | A unique identifier for the request | No | String |
| Date | The date and time at which the response was sent | No | String |
Response Body Elements
| Name | Description | Required | Type |
|---|---|---|---|
| Policy | The bucket's Policy in JSON format. See BucketPolicy for details. | No | String |
Special Errors
| Error Code | Description |
|---|---|
| NoSuchBucket | The specified bucket does not exist |
| NoSuchBucketPolicy | The specified bucket does not have a bucket policy |
| 403 | Forbidden. Authentication failed or you do not have permission to get the bucket policy |
Permissions
You must have the s3:GetBucketPolicy permission.
Try It Out
Test GetBucketPolicy
Get the policy of a bucket.
Coming Soon
This feature is currently under development and will be available soon.