Sample code for 30+ languages & platforms
Java

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.

Chilkat Java Downloads

Chilkat2 Java
import com.chilkatsoft.chilkat2.AuthAws;
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Rest;
import com.chilkatsoft.chilkat2.StringBuilder;

public class ChilkatExample {

    public static void main(String[] args) {
        // This example requires the Chilkat API to have been previously unlocked.
        // See Global Unlock Sample for sample code.

        Rest rest = new Rest();

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

        // Provide AWS credentials.
        AuthAws authAws = new AuthAws();
        authAws.setAccessKey("AWS_ACCESS_KEY");
        authAws.setSecretKey("AWS_SECRET_KEY");
        authAws.setServiceName("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.setRegion("us-west-2");

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

        StringBuilder sbResponse = new StringBuilder();
        try {
            rest.fullRequestNoBodySb("PUT", "/images/sea_creatures/starfish3.jpg", sbResponse);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // When successful, the S3 Storage service will respond with a 200 or 204 response code,
        // with an XML body.
        if (rest.getResponseStatusCode() != 200) {
            // Examine the request/response to see what happened.
            System.out.println("response status code = " + rest.getResponseStatusCode());
            System.out.println("response status text = " + rest.getResponseStatusText());
            System.out.println("response header: " + rest.getResponseHeader());
            System.out.println("response body: " + sbResponse.getAsString());
            System.out.println("---");
            System.out.println("LastRequestStartLine: " + rest.getLastRequestStartLine());
            System.out.println("LastRequestHeader: " + rest.getLastRequestHeader());
        }

        System.out.println(sbResponse.getAsString());
        System.out.println("Copy Successful.");

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

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

        try {
            rest.fullRequestNoBodySb("DELETE", "/images/sea_creatures/starfish.jpg", sbResponse);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // If successfully deleted, the response status code is 204 and the response body text will be empty.
        int statusCode = rest.getResponseStatusCode();
        System.out.println("Response status code = " + statusCode);
        System.out.println("Response text = ");
        System.out.println(sbResponse.getAsString());
    }
}