Visual FoxPro

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.

Visual FoxPro

LOCAL lnSuccess
LOCAL loRest
LOCAL lnBTls
LOCAL lnPort
LOCAL lnBAutoReconnect
LOCAL loAuthAws
LOCAL loSbResponse
LOCAL lnStatusCode

lnSuccess = 0

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

loRest = CreateObject('Chilkat.Rest')

* Connect to the Amazon AWS REST server in the desired region.
lnBTls = 1
lnPort = 443
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("s3-us-west-2.amazonaws.com",lnPort,lnBTls,lnBAutoReconnect)

* Provide AWS credentials.
loAuthAws = CreateObject('Chilkat.AuthAws')
loAuthAws.AccessKey = "AWS_ACCESS_KEY"
loAuthAws.SecretKey = "AWS_SECRET_KEY"
loAuthAws.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".
loAuthAws.Region = "us-west-2"

loRest.SetAuthAws(loAuthAws)

* 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"
loRest.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).
loRest.AddHeader("x-amz-copy-source","/chilkat.qa/images/sea_creatures/starfish.jpg")

loSbResponse = CreateObject('Chilkat.StringBuilder')
lnSuccess = loRest.FullRequestNoBodySb("PUT","/images/sea_creatures/starfish3.jpg",loSbResponse)
IF (lnSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    RELEASE loAuthAws
    RELEASE loSbResponse
    CANCEL
ENDIF

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

? loSbResponse.GetAsString()
? "Copy Successful."

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

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

lnSuccess = loRest.FullRequestNoBodySb("DELETE","/images/sea_creatures/starfish.jpg",loSbResponse)
IF (lnSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    RELEASE loAuthAws
    RELEASE loSbResponse
    CANCEL
ENDIF

* If successfully deleted, the response status code is 204 and the response body text will be empty.
lnStatusCode = loRest.ResponseStatusCode
? "Response status code = " + STR(lnStatusCode)
? "Response text = "
? loSbResponse.GetAsString()

RELEASE loRest
RELEASE loAuthAws
RELEASE loSbResponse