(Xojo Plugin) 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 Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

Dim rest As New Chilkat.Rest

// Connect to the Amazon AWS REST server in the desired region.
Dim bTls As Boolean
bTls = True
Dim port As Int32
port = 443
Dim bAutoReconnect As Boolean
bAutoReconnect = True
Dim success As Boolean
success = rest.Connect("s3-us-west-2.amazonaws.com",port,bTls,bAutoReconnect)

// Provide AWS credentials.
Dim authAws As New Chilkat.AuthAws
authAws.AccessKey = "AWS_ACCESS_KEY"
authAws.SecretKey = "AWS_SECRET_KEY"
authAws.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".
authAws.Region = "us-west-2"

success = rest.SetAuthAws(authAws)

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

Dim sbResponse As New Chilkat.StringBuilder
success = rest.FullRequestNoBodySb("PUT","/images/sea_creatures/starfish3.jpg",sbResponse)
If (success = False) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// When successful, the S3 Storage service will respond with a 200 or 204 response code,
// with an XML body.  
If (rest.ResponseStatusCode <> 200) Then
    // Examine the request/response to see what happened.
    System.DebugLog("response status code = " + Str(rest.ResponseStatusCode))
    System.DebugLog("response status text = " + rest.ResponseStatusText)
    System.DebugLog("response header: " + rest.ResponseHeader)
    System.DebugLog("response body: " + sbResponse.GetAsString())
    System.DebugLog("---")
    System.DebugLog("LastRequestStartLine: " + rest.LastRequestStartLine)
    System.DebugLog("LastRequestHeader: " + rest.LastRequestHeader)
End If

System.DebugLog(sbResponse.GetAsString())
System.DebugLog("Copy Successful.")

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

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

success = rest.FullRequestNoBodySb("DELETE","/images/sea_creatures/starfish.jpg",sbResponse)
If (success = False) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// If successfully deleted, the response status code is 204 and the response body text will be empty.
Dim statusCode As Int32
statusCode = rest.ResponseStatusCode
System.DebugLog("Response status code = " + Str(statusCode))
System.DebugLog("Response text = ")
System.DebugLog(sbResponse.GetAsString())