Lua

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.

Lua

local chilkat = require("chilkat")

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

local rest = chilkat.Rest.new()

-- Connect to the Amazon AWS REST server in the desired region.
local bTls = true
local port = 443
local bAutoReconnect = true
local success = rest:connect("s3-us-west-2.amazonaws.com", port, bTls, bAutoReconnect)

-- Provide AWS credentials.
local authAws = chilkat.AuthAws.new()
authAws.access_key = "AWS_ACCESS_KEY"
authAws.secret_key = "AWS_SECRET_KEY"
authAws.service_name = "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"

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

local sbResponse = chilkat.StringBuilder.new()
success = rest:full_request_no_body_sb("PUT", "/images/sea_creatures/starfish3.jpg", sbResponse)
if not success then
    print(rest.last_error_text)
    return
end

-- When successful, the S3 Storage service will respond with a 200 or 204 response code,
-- with an XML body.
if rest.response_status_code ~= 200 then
    -- Examine the request/response to see what happened.
    print("response status code = " .. rest.response_status_code)
    print("response status text = " .. rest.response_status_text)
    print("response header: " .. rest.response_header)
    print("response body: " .. sbResponse:get_as_string())
    print("---")
    print("LastRequestStartLine: " .. rest.last_request_start_line)
    print("LastRequestHeader: " .. rest.last_request_header)
end

print(sbResponse:get_as_string())
print("Copy Successful.")

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

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

success = rest:full_request_no_body_sb("DELETE", "/images/sea_creatures/starfish.jpg", sbResponse)
if not success then
    print(rest.last_error_text)
    return
end

-- If successfully deleted, the response status code is 204 and the response body text will be empty.
local statusCode = rest.response_status_code
print("Response status code = " .. statusCode)
print("Response text = ")
print(sbResponse:get_as_string())