Dart

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.

Dart

import 'package:chilkat/chilkat.dart';

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

  final rest = CkRest();

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

  // Provide AWS credentials.
  final authAws = CkAuthAws();
  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');

  final sbResponse = CkStringBuilder();
  try {
    rest.fullRequestNoBodySb('PUT', '/images/sea_creatures/starfish3.jpg', sbResponse);
  } on ChilkatException catch (e) {
    print(e.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.
    print('response status code = ${rest.responseStatusCode}');
    print('response status text = ${rest.responseStatusText}');
    print('response header: ${rest.responseHeader}');
    print('response body: ${sbResponse.getAsString()}');
    print('---');
    print('LastRequestStartLine: ${rest.lastRequestStartLine}');
    print('LastRequestHeader: ${rest.lastRequestHeader}');
  }

  print(sbResponse.getAsString());
  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.removeHeader('x-amz-copy-source');

  try {
    rest.fullRequestNoBodySb('DELETE', '/images/sea_creatures/starfish.jpg', sbResponse);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

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