(Lianja) 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.

For more information, see https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html#API_CopyObject_Examples

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loRest = createobject("CkRest")

// Connect to the Amazon AWS REST server in the desired region.
llBTls = .T.
lnPort = 443
llBAutoReconnect = .T.
llSuccess = loRest.Connect("s3-us-west-2.amazonaws.com",lnPort,llBTls,llBAutoReconnect)

// Provide AWS credentials.
loAuthAws = createobject("CkAuthAws")
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("CkStringBuilder")
llSuccess = loRest.FullRequestNoBodySb("PUT","/images/sea_creatures/starfish3.jpg",loSbResponse)
if (llSuccess = .F.) then
    ? loRest.LastErrorText
    release loRest
    release loAuthAws
    release loSbResponse
    return
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")

llSuccess = loRest.FullRequestNoBodySb("DELETE","/images/sea_creatures/starfish.jpg",loSbResponse)
if (llSuccess = .F.) then
    ? loRest.LastErrorText
    release loRest
    release loAuthAws
    release loSbResponse
    return
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