React Native

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.

React Native

import { AuthAws, Rest, StringBuilder } from '@chilkat/react-native'

async function chilkatExample() {
  // This example requires the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  const rest = new Rest();

  // Connect to the Amazon AWS REST server in the desired region.
  const bTls = true;
  const port = 443;
  const bAutoReconnect = true;
  await rest.connectAsync('s3-us-west-2.amazonaws.com', port, bTls, bAutoReconnect);

  // Provide AWS credentials.
  const authAws = new 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';

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

  const sbResponse = new StringBuilder();
  try {
    await rest.fullRequestNoBodySbAsync('PUT', '/images/sea_creatures/starfish3.jpg', sbResponse);
  } catch {
    console.log(rest.lastErrorText);
    return;
  }

  // When successful, the S3 Storage service will respond with a 200 or 204 response code,
  // with an XML body.  
  if (rest.responseStatusCode !== 200) {
    // Examine the request/response to see what happened.
    console.log(`response status code = ${rest.responseStatusCode}`);
    console.log(`response status text = ${rest.responseStatusText}`);
    console.log(`response header: ${rest.responseHeader}`);
    console.log(`response body: ${sbResponse.getAsString()}`);
    console.log('---');
    console.log(`LastRequestStartLine: ${rest.lastRequestStartLine}`);
    console.log(`LastRequestHeader: ${rest.lastRequestHeader}`);
  }

  console.log(sbResponse.getAsString());
  console.log('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 {
    await rest.fullRequestNoBodySbAsync('DELETE', '/images/sea_creatures/starfish.jpg', sbResponse);
  } catch {
    console.log(rest.lastErrorText);
    return;
  }

  // If successfully deleted, the response status code is 204 and the response body text will be empty.
  const statusCode = rest.responseStatusCode;
  console.log(`Response status code = ${statusCode}`);
  console.log('Response text = ');
  console.log(sbResponse.getAsString());
}