Managing Tags Using the AWS SDK for Java

The following example shows how to use the AWS SDK for Java to set tags for a new object and retrieve or replace tags for an existing object. For more information about object tagging, see Object Tagging. For instructions on creating and testing a working sample, see Testing the Amazon S3 Java Code Examples.

import com.amazonaws.AmazonServiceException;

import com.amazonaws.SdkClientException;

import com.amazonaws.auth.profile.ProfileCredentialsProvider;

import com.amazonaws.regions.Regions;

import com.amazonaws.services.s3.AmazonS3;

import com.amazonaws.services.s3.AmazonS3ClientBuilder;

import com.amazonaws.services.s3.model.*;

import java.io.File;

import java.util.ArrayList;

import java.util.List;

public class ManagingObjectTags {

public static void main(String[] args) {

Regions clientRegion = Regions.DEFAULT_REGION;

String bucketName = "*** Bucket name ***";

String keyName = "*** Object key ***";

String filePath = "*** File path ***";

try {

AmazonS3 s3Client = AmazonS3ClientBuilder.standard()

.withCredentials(new ProfileCredentialsProvider())

.withRegion(clientRegion)

.build();

// Create an object, add two new tags, and upload the object to Amazon S3.

PutObjectRequest putRequest = new PutObjectRequest(bucketName, keyName, new File(filePath));

List<Tag> tags = new ArrayList<Tag>();

tags.add(new Tag("Tag 1", "This is tag 1"));

tags.add(new Tag("Tag 2", "This is tag 2"));

putRequest.setTagging(new ObjectTagging(tags));

PutObjectResult putResult = s3Client.putObject(putRequest);

// Retrieve the object's tags.

GetObjectTaggingRequest getTaggingRequest = new GetObjectTaggingRequest(bucketName, keyName);

GetObjectTaggingResult getTagsResult = s3Client.getObjectTagging(getTaggingRequest);

// Replace the object's tags with two new tags.

List<Tag> newTags = new ArrayList<Tag>();

newTags.add(new Tag("Tag 3", "This is tag 3"));

newTags.add(new Tag("Tag 4", "This is tag 4"));

s3Client.setObjectTagging(new SetObjectTaggingRequest(bucketName, keyName, new ObjectTagging(newTags)));

} catch (AmazonServiceException e) {

// The call was transmitted successfully, but Amazon S3 couldn't process

// it, so it returned an error response.

e.printStackTrace();

} catch (SdkClientException e) {

// Amazon S3 couldn't be contacted for a response, or the client

// couldn't parse the response from Amazon S3.

e.printStackTrace();

}

}

}