Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions
Important
To use this operation, you must have permissions to perform the s3:ListBucketVersionsaction. Be aware of the name difference.
Note
A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.
To use this operation, you must have READ access to the bucket.
Request Syntax
GET /?versions&delimiter=Delimiter&encoding-type=EncodingType&key-marker=KeyMarker&max-keys=MaxKeys&prefix=Prefix&version-id-marker=VersionIdMarker HTTP/1.1
Host: Bucket.s3.petabox.io
x-amz-expected-bucket-owner: ExpectedBucketOwner
URI Request Parameters
The request uses the following URI parameters.
Bucket
The bucket name that contains the objects.
Required: Yes
delimiter
Delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.
encoding-type
Requests Petabox to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Petabox encode the keys in the response.
Valid Values: url
key-marker
Specifies the key to start with when listing objects in a bucket.
max-keys
Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.
prefix
Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.
version-id-marker
Specifies the object version you want to start listing from.
x-amz-expected-bucket-owner
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service.
ListVersionsResult
Root level tag for the ListVersionsResult parameters.
Required: Yes
CommonPrefixes
All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.
Type: Array of CommonPrefix data types
DeleteMarker
Container for an object that is a delete marker.
Type: Array of DeleteMarkerEntry data types
Delimiter
The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.
Type: String
EncodingType
Encoding type used by Petabox to encode object key names in the XML response.
If you specify encoding-type request parameter, Petabox includes this element in the response, and returns encoded key name values in the following response elements:
KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.
Type: String
Valid Values: url
IsTruncated
A flag that indicates whether Petabox returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.
Type: Boolean
KeyMarker
Marks the last key returned in a truncated response.
Type: String
MaxKeys
Specifies the maximum number of objects to return.
Type: Integer
Name
The bucket name.
Type: String
NextKeyMarker
When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.
Type: String
NextVersionIdMarker
When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.
Type: String
Prefix
Selects objects that start with the value supplied by this parameter.
Type: String
Version
Container for version information.
Type: Array of ObjectVersion data types
VersionIdMarker
Marks the last version of the key returned in a truncated response.
Type: String
Examples
Sample Request
The following request returns all of the versions of all of the objects in the specified bucket.
GET /?versions HTTP/1.1
Host: BucketName.s3.<Region>.petabox.io
Date: Wed, 28 Oct 2009 22:32:00 +0000
Authorization: authorization string (see Authenticating Requests (AWS Signature Version
4))
Sample Response
This example illustrates one usage of ListObjectVersions.
The following request returns objects in the order they were stored, returning the most recently stored object first starting with the value for key-marker.
Sample Request: Using key-marker, version-id-marker, and max-keys
The following request returns up to three (the value of max-keys) objects starting with the key specified by key-marker and the version ID specified by version-id-marker.
GET /?versions&key-marker=key3&version-id-marker=t46Z0menlYTZBnj&max-keys=3
Host: bucket.s3.<Region>.petabox.io
Date: Wed, 28 Oct 2009 22:32:00 +0000
Authorization: authorization string
Sample Response
This example illustrates one usage of ListObjectVersions.
Sample Request: Using the delimiter and prefix parameters
Assume you have the following keys in your bucket, example-bucket.
photos/2006/January/sample.jpg
photos/2006/February/sample.jpg
photos/2006/March/sample.jpg
videos/2006/March/sample.wmv
sample.jpg
The following GET versions request specifies the delimiter parameter with value "/".
GET /?versions&delimiter=/ HTTP/1.1
Host: example-bucket.s3.<Region>.petabox.io
Date: Wed, 02 Feb 2011 20:34:56 GMT
Authorization: authorization string
Sample Response
The list of keys from the specified bucket is shown in the following response.
The response returns the sample.jpg key in a <Version> element. However, because all the other keys contain the specified delimiter, a distinct substring, from the beginning of the key to the first occurrence of the delimiter, from each of these keys is returned in a <CommonPrefixes> element. The key substrings, photos/ and videos/, in the <CommonPrefixes> element indicate that there are one or more keys with these key prefixes.
This is a useful scenario if you use key prefixes for your objects to create a logical folder-like structure. In this case, you can interpret the result as the folders photos/ and videos/ have one or more objects.
In addition to the delimiter parameter, you can filter results by adding a prefix parameter as shown in the following request.
GET /?versions&prefix=photos/2006/&delimiter=/ HTTP/1.1
Host: example-bucket.s3.<Region>.petabox.io
Date: Wed, 02 Feb 2011 19:34:02 GMT
Authorization: authorization string
Example
In this case, the response will include only objects keys that start with the specified prefix. The value returned in the <CommonPrefixes> element is a substring from the beginning of the key to the first occurrence of the specified delimiter after the prefix.
Note
If you created folders by using the Petabox console, you will see an additional 0-byte object with a key of photos/2006/. This is because of the way that the console supports folder structures.
