Skip to main content
  • delimiter

    index The Vault system does not support %c2%85(U+0085) as a delimiter value
  • encoding-type

  • marker

  • max-keys

  • prefix

Vault Extension to the S3 API

The Vault system supports the following Request Parameter as an extension to the "GET Bucket (List Objects)" operation:

Parameter

Description

Required

meta

You can use the request parameter meta=true to return user-defined object metadata with the GET Bucket response. Without this Vault extension, the GET Bucket method returns only system metadata, not user-defined metadata. You would have to do a GET Object on individual objects to get the user-defined object metadata. (For more information on user-defined metadata versus system metadata, see Object Key and Metadata in the Amazon S3 documentation).

If you use the meta=true option for GET Bucket, then within the XML response body the user-defined metadata will be presented as a metadata element nested in the Contents element. In the example below, the lines that follow the Owner element show how user-defined metadata will be included in the result if you use the meta=true request parameter with the GET Bucket request.

HTTP/1.1 200 OK
...

<ListBucketResult xmlns="http://s3.nicmanlab.com/2013-10-01/">
  ...
    <Contents>
        <Key>my-image.jpg</Key>
        <LastModified>2009-10-12T17:50:30.000Z</LastModified>
        <ETag>&quot;fba9dede5f27731c9771645a39863328&quot;</ETag>
        <Size>434234</Size>
        <StorageClass>STANDARD</StorageClass>
        <Owner>
            <ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>
            <DisplayName>mtd@amazon.com</DisplayName>
        </Owner>
        <metadata name="name1">value1</metadata>
        <metadata name="name2">value2</metadata>
        <metadata name="name3">value3</metadata>
    </Contents>
    ...
  ...
</ListBucketResult>
index

The x-amz-meta- (or x-yourservice-meta-) extension header prefixes that you use to create user-defined object metadata items (with the PUT Object operation) are not included in the metadata names in the GET Bucket response. For example, if you created a user-defined metadata item by using an x-amz-meta-groupid header in a PUT Object operation, in a GET Bucket response the metadata name would simply be groupid.

When you create user-defined object metadata (with PUT Object), the metadata values must be UTF-8 and must not contain control characters less than 0x20 except for \r, \n, and \t. Also, normal XML escaping is required where appropriate.

No (defaults to "false")

Connect with Us on LinkedIn

Follow Us on LinkedIn to find out what is currently going on and link with our Consultants!