(PHP Extension) Fetch S3 Object Metadata

Demonstrates how to get the metadata for an S3 object using the REST API.

The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you are interested only in an object's metadata. To use HEAD, you must have READ access to the object.

A HEAD request has the same options as a GET operation on an object. The response is identical to the GET response except that there is no response body.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$rest = new CkRest();

// Connect to the Amazon AWS REST server using the correct region (in this example, "us-west-2")
$bTls = true;
$port = 443;
$bAutoReconnect = true;
$success = $rest->Connect('s3-us-west-2.amazonaws.com',$port,$bTls,$bAutoReconnect);

// Provide AWS credentials for the REST call.
$authAws = new CkAuthAws();
$authAws->put_AccessKey('AWS_ACCESS_KEY');
$authAws->put_SecretKey('AWS_SECRET_KEY');
$authAws->put_ServiceName('s3');
// Make sure the Region agrees with the region in the Connect.
$authAws->put_Region('us-west-2');
$success = $rest->SetAuthAws($authAws);

// User-defined metadata are name/value pairs, and are returned in the HTTP response header.
// Metadata header names begin with "x-amz-meta-" to distinguish them from other HTTP headers.
// Note that Amazon S3 stores user-defined metadata keys in lowercase.

// Set the bucket name via the HOST header.
// In this case, the bucket name is "chilkat.ocean".
$rest->put_Host('chilkat.ocean.s3.amazonaws.com');

// Send the HEAD request.
$success = $rest->SendReqNoBody('HEAD','/seahorse.jpg');
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

// Read the response header.
$responseStatusCode = $rest->ReadResponseHeader();
if ($responseStatusCode < 0) {
    print $rest->lastErrorText() . "\n";
    exit;
}

print 'Response status code = ' . $responseStatusCode . "\n";
if ($responseStatusCode != 200) {
    print $rest->responseHeader() . "\n";
    print 'Object does not exist.' . "\n";
    exit;
}

// Show the full response header that was received:
print 'Response header:' . "\n";
print $rest->responseHeader() . "\n";
print '--' . "\n";

// Here is an example response header:

// 	x-amz-id-2: uS4Flff04M8x5YWajU231TP0ClBL19mMhuyfU5ZVQd6NsUHXVhHK+H3b0sjxY98Fujet1ejhyzk=
// 	x-amz-request-id: 27950009AA8E68AA
// 	Date: Mon, 23 Jan 2017 20:12:58 GMT
// 	Last-Modified: Fri, 20 Jan 2017 00:22:57 GMT
// 	ETag: "a8551f0a5437f43a796fca7623ee9232"
// 	x-amz-meta-species: big-belly seahorse
// 	x-amz-meta-genus: Hippocampus
// 	x-amz-meta-habitat: shallow tropical and temperate waters
// 	Accept-Ranges: bytes
// 	Content-Type: image/jpg
// 	Content-Length: 24388
// 	Server: AmazonS3

// Examine particular response headers (the object metadata headers..)
print 'x-amz-meta-species: ' . $rest->responseHdrByName('x-amz-meta-species') . "\n";
print 'x-amz-meta-genus: ' . $rest->responseHdrByName('x-amz-meta-genus') . "\n";
print 'x-amz-meta-habitat: ' . $rest->responseHdrByName('x-amz-meta-habitat') . "\n";
print '--' . "\n";

// It is possible to iterate over the header fields to find all x-amz-meta* headers
$i = 0;
$numHeaders = $rest->get_NumResponseHeaders();
$sbName = new CkStringBuilder();
while ($i < $numHeaders) {
    $sbName->SetString($rest->responseHdrName($i));
    if ($sbName->StartsWith('x-amz-meta',false) == true) {
        print $sbName->getAsString() . ': ' . $rest->responseHdrValue($i) . "\n";
    }

    $i = $i + 1;
}

// The output:

// 	x-amz-meta-species: big-belly seahorse
// 	x-amz-meta-genus: Hippocampus
// 	x-amz-meta-habitat: shallow tropical and temperate waters

?>