PureBasic

Read S3 Object Metadata of File Already Uploaded to S3

See more Amazon S3 Examples

Demonstrates how to retrieve the metadata from an S3 object.

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.

PureBasic

IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkMime.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Insert your AWS keys here:
    CkHttp::setCkAwsAccessKey(http, "AWS_ACCESS_KEY")
    CkHttp::setCkAwsSecretKey(http, "AWS_SECRET_KEY")

    bucketName.s = "chilkat.ocean"
    objectName.s = "seahorse.jpg"

    ; 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.

    ; A HEAD request can be sent to return the response header without the response body.
    ; The S3_FileExists method sends a HEAD request.
    ; It can be used to get the response header.
    retval.i = CkHttp::ckS3_FileExists(http,bucketName,objectName)
    If retval < 0
        Debug "Failed to check for the S3 object existence"
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    If retval = 0
        Debug "The S3 object does not exist."
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    ; The response header is available in the LastResponseHeader property.
    responseHeader.s = CkHttp::ckLastResponseHeader(http)
    Debug "Response header:"
    Debug responseHeader
    Debug "--"

    ; 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

    ; HTTP requests and responses are MIME.  For easy parsing, the response header
    ; can be loaded into a Chilkat MIME object
    mime.i = CkMime::ckCreate()
    If mime.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkMime::ckLoadMime(mime,responseHeader)

    ; Examine the metadata values:
    Debug "x-amz-meta-species: " + CkMime::ckGetHeaderField(mime,"x-amz-meta-species")
    Debug "x-amz-meta-genus: " + CkMime::ckGetHeaderField(mime,"x-amz-meta-genus")
    Debug "x-amz-meta-habitat: " + CkMime::ckGetHeaderField(mime,"x-amz-meta-habitat")
    Debug "--"

    ; It is possible to iterate over the header fields to find all x-amz-meta* headers
    i.i = 0
    numHeaders.i = CkMime::ckNumHeaderFields(mime)
    sbName.i = CkStringBuilder::ckCreate()
    If sbName.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    While i < numHeaders
        CkStringBuilder::ckSetString(sbName,CkMime::ckGetHeaderFieldName(mime,i))
        If CkStringBuilder::ckStartsWith(sbName,"x-amz-meta",0) = 1
            Debug CkStringBuilder::ckGetAsString(sbName) + ": " + CkMime::ckGetHeaderFieldValue(mime,i)
        EndIf

        i = i + 1
    Wend

    ; The output:

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


    CkHttp::ckDispose(http)
    CkMime::ckDispose(mime)
    CkStringBuilder::ckDispose(sbName)


    ProcedureReturn
EndProcedure