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

GetBucketVersioning

Returns the versioning state of a bucket.

To retrieve the versioning state of a bucket, you must be the bucket owner.

This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is enabled, the bucket owner must use an authentication device to change the versioning state of the bucket.

The following operations are related to GetBucketVersioning:

Request Syntax

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

URI Request Parameters

The request requires the following URI parameters.

Bucket

The name of the bucket for which to get the versioning information.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <GetBucketVersioningOutput> <Status>string</Status> <MfaDelete>string</MfaDelete> </GetBucketVersioningOutput>

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.

GetBucketVersioningOutput

Root level tag for the GetBucketVersioningOutput parameters.

Required: Yes

MFADelete

Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.

Type: String

Valid Values: Enabled | Disabled

Status

The versioning state of the bucket.

Type: String

Valid Values: Enabled | Suspended

Examples

Example

This example returns the versioning state of myBucket.

GET /?versioning HTTP/1.1 Host: myBucket.s3.amazonaws.com Date: Wed, 12 Oct 2009 17:50:00 GMT Authorization: authorization string Content-Type: text/plain

Example

There are three versioning states:

If you enabled versioning on a bucket, the response is:

<VersioningConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Status>Enabled</Status> </VersioningConfiguration>

Example

If you suspended versioning on a bucket, the response is:

<VersioningConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Status>Suspended</Status> </VersioningConfiguration>

Example

If you never enabled (or suspended) versioning on a bucket, the response is:

<VersioningConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"/>

See Also

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