Renaming objects in directory buckets

You can use the Amazon SDK for Java to rename your objects. To use these examples, replace the user input placeholders with your own information

The following example demonstrates how to create a RenameObjectRequest using the Amazon SDK for Java

String key = "key";
String newKey = "new-key";
String expectedETag = "e5f3g7h8i9j0";
RenameObjectRequest renameRequest = RenameObjectRequest.builder()
    .bucket(amzn-s3-demo-bucket--usw2-az1--x-s3)
    .key(newKey)
    .renameSource(key)
    .destinationIfMatch(e5f3g7h8i9j0)
    .build();

This code does the following:

The following example shows how to create a RenameObjectRequest with a none-match condition using the Amazon SDK for Java.

String key = "key";
String newKey = "new-key";
String noneMatchETag = "e5f3g7h8i9j0";
RenameObjectRequest renameRequest = RenameObjectRequest.builder()
    .bucket(amzn-s3-demo-bucket--usw2-az1--x-s3)
    .key(newKey)
    .renameSource(key)
    .destinationIfNoneMatch(noneMatchETag)
    .build();

This code does the following:

The operation will fail with a 412 Precondition Failed error if an object exists with the new specified name and has the specified ETag.

You can use the SDK for Python to rename your objects. To use these examples, replace the user input placeholders with your own information.

The following example demonstrates how to rename an object using the Amazon SDK for Python (Boto3).

def basic_rename(bucket, source_key, destination_key):
    try:
        s3.rename_object(
            Bucket=amzn-s3-demo-bucket--usw2-az1--x-s3,
            Key=destination_key,
            RenameSource=f"{amzn-s3-demo-bucket--usw2-az1--x-s3}/{source_key}"
        )
        print(f"Successfully renamed {source_key} to {destination_key}")
    except ClientError as e:
        print(f"Error renaming object: {e}")

This code does the following:

The following example demonstrate how to rename an object with the SourceIfMatch and DestinationIfNoneMatch conditions using the Amazon SDK for Python (Boto3).

def rename_with_conditions(bucket, source_key, destination_key, source_etag, dest_etag):
    try:
        s3.rename_object(
            Bucket=amzn-s3-demo-bucket--usw2-az1--x-s3,
            Key=destination_key,
            RenameSource=f"{amzn-s3-demo-bucket--usw2-az1--x-s3}/{source_key}",
            SourceIfMatch=source_ETag,
            DestinationIfNoneMatch=dest_ETag
        )
        print(f"Successfully renamed {source_key} to {destination_key} with conditions")
    except ClientError as e:
        print(f"Error renaming object: {e}")

This code does the following:

You can use the SDK for Rust to rename your objects. To use these examples, replace the user input placeholders with your own information.

The following example demonstrates how to rename an object in the amzn-s3-demo-bucket--usw2-az1--x-s3 directory bucket using the SDK for Rust.

async fn basic_rename_example(client: &Client) -> Result<(), Box<dyn Error>> {
    let response = client
        .rename_object()
        .bucket(" amzn-s3-demo-bucket--usw2-az1--x-s3")
        .key("new-name.txt")  // New name/path for the object
        .rename_source("old-name.txt")  // Original object name/path
        .send()
        .await?;
    Ok(())
}

This code does the following: