PutObjectTagging
Sets the supplied tag-set to an object that already exists in a bucket.
A tag is a key-value pair. 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.
For information about the Amazon S3 object tagging feature, see Object Tagging.
Special Errors
-
-
Code: InvalidTagError
-
Cause: 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.
-
-
-
Code: MalformedXMLError
-
Cause: The XML provided does not match the schema.
-
-
-
Code: OperationAbortedError
-
Cause: A conflicting conditional action is currently in progress against this resource. Please try again.
-
-
-
Code: InternalError
-
Cause: The service was unable to apply the provided tag to the object.
-
Related Resources
Request Syntax
PUT /{Key+}?tagging&versionId=VersionId
HTTP/1.1
Host: Bucket
.s3.amazonaws.com
Content-MD5: ContentMD5
x-amz-expected-bucket-owner: ExpectedBucketOwner
x-amz-request-payer: RequestPayer
<?xml version="1.0" encoding="UTF-8"?>
<Tagging xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<TagSet>
<Tag>
<Key>string
</Key>
<Value>string
</Value>
</Tag>
</TagSet>
</Tagging>
URI Request Parameters
The request uses the following URI parameters.
- Bucket
-
The bucket name containing the object.
When using this action with an access point, 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 AWS 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 Simple Storage Service Developer Guide.
When using this action with Amazon 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 using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
Required: Yes
- Content-MD5
-
The MD5 hash for the request body.
For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
- Key
-
Name of the object key.
Length Constraints: Minimum length of 1.
Required: Yes
- versionId
-
The versionId of the object that the tag-set will be added to.
- x-amz-expected-bucket-owner
-
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP
403 (Access Denied)
error. - x-amz-request-payer
-
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 Developer Guide.
Valid Values:
requester
Request Body
The request accepts the following data in XML format.
Response Syntax
HTTP/1.1 200
x-amz-version-id: VersionId
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
- x-amz-version-id
-
The versionId of the object the tag-set was added to.
Examples
Sample Request: Add tag set to an object
The following request adds a tag set to the existing object object-key in the
examplebucket
bucket.
PUT object-key?tagging HTTP/1.1 Host: examplebucket.s3.<Region>.amazonaws.com Content-Length: length Content-MD5: pUNXr/BjKK5G2UKExample== x-amz-date: 20160923T001956Z Authorization: authorization string <Tagging> <TagSet> <Tag> <Key>tag1</Key> <Value>val1</Value> </Tag> <Tag> <Key>tag2</Key> <Value>val2</Value> </Tag> </TagSet> </Tagging>
Sample Response
This example illustrates one usage of PutObjectTagging.
HTTP/1.1 200 OK x-amz-id-2: YgIPIfBiKa2bj0KMgUAdQkf3ShJTOOpXUueF6QKo x-amz-request-id: 236A8905248E5A01 Date: Fri, 23 Sep 2016 00:20:19 GMT
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: