Xbase++

S3 Rename File

See more Amazon S3 (new) Examples

Demonstrates how to rename a file on Amazon S3.

Renaming an object (file) in AWS S3 using the AWS S3 API involves copying the object to a new location with the desired name and then deleting the original object.

Xbase++

LOCAL nSuccess
LOCAL oRest
LOCAL nBTls
LOCAL nPort
LOCAL nBAutoReconnect
LOCAL oAuthAws
LOCAL oSbResponse
LOCAL nStatusCode

nSuccess := 0

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

oRest := CreateObject("Chilkat.Rest")

//  Connect to the Amazon AWS REST server in the desired region.
nBTls := 1
nPort := 443
nBAutoReconnect := 1
nSuccess := oRest:Connect("s3-us-west-2.amazonaws.com", nPort, nBTls, nBAutoReconnect)

//  Provide AWS credentials.
oAuthAws := CreateObject("Chilkat.AuthAws")
oAuthAws:AccessKey := "AWS_ACCESS_KEY"
oAuthAws:SecretKey := "AWS_SECRET_KEY"
oAuthAws:ServiceName := "s3"

//  This particular bucket is in the Oregon region, as opposed to the US Standard,
//  therefore the Region must be set appropriately.
//  Also note that we connected to "s3-us-west-2.amazonaws.com".
oAuthAws:Region := "us-west-2"

oRest:SetAuthAws(oAuthAws)

//  Set the bucket name via the HOST header.
//  In this case, the bucket name is "chilkat.qa".
//  Note that the Host header should use "bucketName.s3.amazonaws.com", not "bucketName.s3-us-west-2.amazonaws.com"
oRest:Host := "chilkat.qa.s3.amazonaws.com"

//  Copy /images/sea_creatures/starfish.jpg to /images/sea_creatures/starfish3.jpg
//  Notice here that the x-amz-copy-source includes the bucket in the source path,
//  but the target path passed to FullRequestNoBody does NOT contain the bucket (because the bucket
//  was already specified in the Host header).
oRest:AddHeader("x-amz-copy-source", "/chilkat.qa/images/sea_creatures/starfish.jpg")

oSbResponse := CreateObject("Chilkat.StringBuilder")
nSuccess := oRest:FullRequestNoBodySb("PUT", "/images/sea_creatures/starfish3.jpg", oSbResponse)
IF (nSuccess == 0)
    ? oRest:LastErrorText
    oRest:destroy()
    oAuthAws:destroy()
    oSbResponse:destroy()
    RETURN
ENDIF

//  When successful, the S3 Storage service will respond with a 200 or 204 response code,
//  with an XML body.  
IF (oRest:ResponseStatusCode != 200)
    //  Examine the request/response to see what happened.
    ? "response status code = " + Str(oRest:ResponseStatusCode)
    ? "response status text = " + oRest:ResponseStatusText
    ? "response header: " + oRest:ResponseHeader
    ? "response body: " + oSbResponse:GetAsString()
    ? "---"
    ? "LastRequestStartLine: " + oRest:LastRequestStartLine
    ? "LastRequestHeader: " + oRest:LastRequestHeader
ENDIF

? oSbResponse:GetAsString()
? "Copy Successful."

//  --------------------------------------
//  Now we can delete the original file..
//  --------------------------------------

//  We no longer want to send the x-amz-copy-source header.  Remove it.
oRest:RemoveHeader("x-amz-copy-source")

nSuccess := oRest:FullRequestNoBodySb("DELETE", "/images/sea_creatures/starfish.jpg", oSbResponse)
IF (nSuccess == 0)
    ? oRest:LastErrorText
    oRest:destroy()
    oAuthAws:destroy()
    oSbResponse:destroy()
    RETURN
ENDIF

//  If successfully deleted, the response status code is 204 and the response body text will be empty.
nStatusCode := oRest:ResponseStatusCode
? "Response status code = " + Str(nStatusCode)
? "Response text = "
? oSbResponse:GetAsString()

oRest:destroy()
oAuthAws:destroy()
oSbResponse:destroy()