Tagging an S3 Bucket or S3 Objects with the AWS CLI

# Table of Contents

1. Tagging S3 Buckets with AWS CLI
2. Tagging S3 Objects with AWS CLI

# Tagging S3 Buckets with AWS CLI

To tag an S3 bucket with the AWS CLI, run the put-bucket-tagging command, passing in the tag key-value pairs.

Copied!
aws s3api put-bucket-tagging --bucket your_bucket --tagging "TagSet=[{Key=department, Value=accounting}]"

The example command creates a tag with the key of department and a value of accounting.

To verify the S3 Bucket has been tagged, run the get-bucket-tagging command.

Copied!
aws s3api get-bucket-tagging --bucket your_bucket

To create multiple tags on the bucket, pass multiple key-value pairs to the --tagging parameter:

Copied!
aws s3api put-bucket-tagging --bucket your_bucket --tagging "TagSet=[{Key=department, Value=accounting}, {Key=food, Value=cake}]"

To verify the tags got created successfully, run the get-bucket-tagging command again.

Copied!
aws s3api get-bucket-tagging --bucket your_bucket

An alternative to passing the tag key-value pairs directly in the --tagging parameter is to store the tag values in a file

You can then pass the file to the put-bucket-tagging command.

Create a file called bucket-tags.json with the following contents:

Copied!
{
   "TagSet": [
     {
       "Key": "color",
       "Value": "green"
     },
     {
       "Key": "fruit",
       "Value": "avocado"
     }
   ]
}

Open your terminal in the directory where you stored the bucket-tags.json file and run the put-bucket-tagging command pointing it to the file.

Copied!
aws s3api put-bucket-tagging --bucket your_bucket --tagging file://bucket-tags.json

When we list the tags for the bucket, we can see that the tags from the file have been created:

To delete all of the tags of an S3 Bucket, run the delete-bucket-tagging command:

Copied!
aws s3api delete-bucket-tagging --bucket your_bucket

Note that running the get-bucket-tagging command on a bucket that has no tags, throws an error - "The TagSet does not exist".

# Tagging S3 Objects with AWS CLI

To tag an S3 object with the AWS CLI, use the put-object-tagging command.

Copied!
aws s3api put-object-tagging --bucket your_bucket --key dog.png --tagging "{\"TagSet\": [{\"Key\": \"department\", \"Value\": \"accounting\"}]}"

The command creates a tag with a key of department and a value of accounting.

If the S3 object is nested in a "directory", pass the --key parameter as the whole path that leads to the object, i.e. /static/images/dog.png.

To verify the S3 object got tagged successfully, run the get-object-tagging command.

Copied!
aws s3api get-object-tagging --bucket your_bucket --key dog.png

To create multiple tags on an S3 object with the AWS CLI, pass multiple key:value pair objects in the --tagging parameter.

Copied!
aws s3api put-object-tagging --bucket your_bucket --key dog.png --tagging "{\"TagSet\": [{\"Key\": \"department\", \"Value\": \"accounting\"}, {\"Key\": \"color\", \"Value\": \"green\"}]}"

To verify that both of the tags were created on the S3 object, run the get-object-tagging command.

Copied!
aws s3api get-object-tagging --bucket your_bucket --key dog.png

# Additional Resources

You can learn more about the related topics by checking out the following tutorials:

• S3 Bucket Example in AWS CDK - Complete Guide
• S3 Bucket Policy Example in AWS CDK
• Configure S3 Lifecycle Rules in AWS CDK
• Count Number of Objects in S3 Bucket
• List all Files in an S3 Bucket with AWS CLI
• How to Grant AWS Lambda Access to an S3 Bucket
• Could not Parse Request body into JSON Error - AWS CLI
• Query Contains Examples with AWS CLI
• S3 Access Denied when calling ListObjectsV2 error [Solved]
• S3 Access Denied when calling PutObject
• S3 Action does not Apply to any Resources Error
• How to Rename a Bucket in AWS S3
• How to Rename a Folder in AWS S3