Skip to content

List Object Versions

s3_list_object_versions R Documentation

This operation is not supported for directory buckets

Description

This operation is not supported for directory buckets.

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.

To use this operation, you must have permission to perform the s3:ListBucketVersions action. Be aware of the name difference.

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.

The following operations are related to list_object_versions:

  • list_objects_v2

  • get_object

  • put_object

  • delete_object

You must URL encode any signed header values that contain spaces. For example, if your header value is ⁠my file.txt⁠, containing two spaces after my, you must URL encode this value to ⁠my%20%20file.txt⁠.

Usage

s3_list_object_versions(Bucket, Delimiter, EncodingType, KeyMarker,
  MaxKeys, Prefix, VersionIdMarker, ExpectedBucketOwner, RequestPayer,
  OptionalObjectAttributes)

Arguments

Bucket

[required] The bucket name that contains the objects.
Delimiter

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.

CommonPrefixes is filtered out from results if it is not lexicographically greater than the key-marker.
EncodingType

Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see Object key naming guidelines.

When using the URL encoding type, non-ASCII characters that are used in an object's key name will be percent-encoded according to UTF-8 code values. For example, the object ⁠test_file(3).png⁠ will appear as ⁠test_file%283%29.png⁠.
KeyMarker

Specifies the key to start with when listing objects in a bucket.
MaxKeys

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 that 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.
VersionIdMarker

Specifies the object version you want to start listing from.
ExpectedBucketOwner

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ⁠403 Forbidden⁠ (access denied).
RequestPayer

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for the corresponding charges. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.
OptionalObjectAttributes

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

Value

A list with the following syntax:

list(
  IsTruncated = TRUE|FALSE,
  KeyMarker = "string",
  VersionIdMarker = "string",
  NextKeyMarker = "string",
  NextVersionIdMarker = "string",
  Versions = list(
    list(
      ETag = "string",
      ChecksumAlgorithm = list(
        "CRC32"|"CRC32C"|"SHA1"|"SHA256"|"CRC64NVME"|"SHA512"|"MD5"|"XXHASH64"|"XXHASH3"|"XXHASH128"
      ),
      ChecksumType = "COMPOSITE"|"FULL_OBJECT",
      Size = 123,
      StorageClass = "STANDARD",
      Key = "string",
      VersionId = "string",
      IsLatest = TRUE|FALSE,
      LastModified = as.POSIXct(
        "2015-01-01"
      ),
      Owner = list(
        DisplayName = "string",
        ID = "string"
      ),
      RestoreStatus = list(
        IsRestoreInProgress = TRUE|FALSE,
        RestoreExpiryDate = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  ),
  DeleteMarkers = list(
    list(
      Owner = list(
        DisplayName = "string",
        ID = "string"
      ),
      Key = "string",
      VersionId = "string",
      IsLatest = TRUE|FALSE,
      LastModified = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  Name = "string",
  Prefix = "string",
  Delimiter = "string",
  MaxKeys = 123,
  CommonPrefixes = list(
    list(
      Prefix = "string"
    )
  ),
  EncodingType = "url",
  RequestCharged = "requester"
)

Request syntax

svc$list_object_versions(
  Bucket = "string",
  Delimiter = "string",
  EncodingType = "url",
  KeyMarker = "string",
  MaxKeys = 123,
  Prefix = "string",
  VersionIdMarker = "string",
  ExpectedBucketOwner = "string",
  RequestPayer = "requester",
  OptionalObjectAttributes = list(
    "RestoreStatus"
  )
)

Examples

## Not run: 
# The following example return versions of an object with specific key
# name prefix. The request limits the number of items returned to two. If
# there are are more than two object version, S3 returns NextToken in the
# response. You can specify this token value in your next request to fetch
# next set of object versions.
svc$list_object_versions(
  Bucket = "examplebucket",
  Prefix = "HappyFace.jpg"
)

## End(Not run)