GetBucketVersioning
Returns the versioning state of a bucket.
Description
The GetBucketVersioning operation returns the versioning state of a bucket. To retrieve the versioning state of a bucket, you must be the bucket owner.
A bucket's versioning state can be one of the following:
- Enabled - Versioning is enabled for the bucket
- Suspended - Versioning was previously enabled but is currently suspended
- Unversioned - Versioning has never been enabled on the bucket
For more information about versioning, see Object Versioning.
note
- To use this operation, you must have permission to perform the
s3:GetBucketVersioningaction. - You must be the bucket owner to use this operation.
- The return format is XML
Request Syntax
GET /?versioning 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 versioning when versioning is enabled
GET /?versioning 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
<?xml version="1.0" encoding="UTF-8"?>
<VersioningConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<Status>Enabled</Status>
</VersioningConfiguration>
Values in italics indicate variable response values.
Example 2: Get bucket versioning when versioning is suspended
GET /?versioning 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
<?xml version="1.0" encoding="UTF-8"?>
<VersioningConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<Status>Suspended</Status>
</VersioningConfiguration>
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
<?xml version="1.0" encoding="UTF-8"?>
<VersioningConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<Status>Status</Status>
<MFADelete>MFADeleteStatus</MFADelete>
</VersioningConfiguration>
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 |
|---|---|---|---|
| VersioningConfiguration | Container for versioning configuration. See VersioningConfiguration for details. | No | String |
| Status | The versioning state of the bucket. Valid values: Enabled | Suspended | No | String |
| MFADelete | Specifies whether MFA delete is enabled in the bucket versioning configuration. Valid values: Enabled | Disabled. This element is only returned if the bucket has been configured with MFA delete. | No | String |
Special Errors
| Error Code | Description |
|---|---|
| NoSuchBucket | The specified bucket does not exist |
| 403 | Forbidden. Authentication failed or you do not have permission to get the bucket versioning configuration |
Permissions
You must have the s3:GetBucketVersioning permission.
Try It Out
Test GetBucketVersioning
Get the versioning state of a bucket.
Coming Soon
This feature is currently under development and will be available soon.