PutObjectTaggingCommand

Suggest an Edit

This operation is not supported for directory buckets.

Sets the supplied tag-set to an object that already exists in a bucket. A tag is a key-value pair. For more information, see Object Tagging .

You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging .

For tagging-related restrictions related to characters and encodings, see Tag Restrictions . Note that Amazon S3 limits the maximum number of tags to 10 tags per object.

To use this operation, you must have permission to perform the s3:PutObjectTagging action. By default, the bucket owner has this permission and can grant this permission to others.

To put tags of any other version, use the versionId query parameter. You also need permission for the s3:PutObjectVersionTagging action.

PutObjectTagging has the following special errors. For more Amazon S3 errors see, Error Responses .

  • InvalidTag - The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Object Tagging .

  • MalformedXML - The XML provided does not match the schema.

  • OperationAborted - A conflicting conditional action is currently in progress against this resource. Please try again.

  • InternalError - The service was unable to apply the provided tag to the object.

The following operations are related to PutObjectTagging:

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { S3Client, PutObjectTaggingCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, PutObjectTaggingCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // PutObjectTaggingRequest
  Bucket: "STRING_VALUE", // required
  Key: "STRING_VALUE", // required
  VersionId: "STRING_VALUE",
  ContentMD5: "STRING_VALUE",
  ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME",
  Tagging: { // Tagging
    TagSet: [ // TagSet // required
      { // Tag
        Key: "STRING_VALUE", // required
        Value: "STRING_VALUE", // required
      },
    ],
  },
  ExpectedBucketOwner: "STRING_VALUE",
  RequestPayer: "requester",
};
const command = new PutObjectTaggingCommand(input);
const response = await client.send(command);
// { // PutObjectTaggingOutput
//   VersionId: "STRING_VALUE",
// };

Example Usage

 Loading code editor

PutObjectTaggingCommand Input

See PutObjectTaggingCommandInput for more details

Parameter
Type
Description
Bucket
Required
string | undefined

The bucket name containing the object.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points  in the Amazon S3 User Guide.

S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts?  in the Amazon S3 User Guide.

Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues

Key
Required
string | undefined

Name of the object key.

Tagging
Required
Tagging | undefined

Container for the TagSet and Tag elements

ChecksumAlgorithm
ChecksumAlgorithm | undefined

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity  in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ContentMD5
string | undefined

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

ExpectedBucketOwner
string | undefined

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

RequestPayer
RequestPayer | undefined

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets  in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

VersionId
string | undefined

The versionId of the object that the tag-set will be added to.

PutObjectTaggingCommand Output

See PutObjectTaggingCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
VersionId
string | undefined

The versionId of the object the tag-set was added to.

Throws

Name
Fault
Details
S3ServiceException
Base exception class for all service exceptions from S3 service.