/AWS1/CL_S3=>PUTOBJECTTAGGING()
¶
About PutObjectTagging¶
This operation is not supported by 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
:
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_BUCKET
TYPE /AWS1/S3_BUCKETNAME
/AWS1/S3_BUCKETNAME
¶
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 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
IV_KEY
TYPE /AWS1/S3_OBJECTKEY
/AWS1/S3_OBJECTKEY
¶
Name of the object key.
IO_TAGGING
TYPE REF TO /AWS1/CL_S3_TAGGING
/AWS1/CL_S3_TAGGING
¶
Container for the
TagSet
andTag
elements
Optional arguments:¶
IV_VERSIONID
TYPE /AWS1/S3_OBJECTVERSIONID
/AWS1/S3_OBJECTVERSIONID
¶
The versionId of the object that the tag-set will be added to.
IV_CONTENTMD5
TYPE /AWS1/S3_CONTENTMD5
/AWS1/S3_CONTENTMD5
¶
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.
IV_CHECKSUMALGORITHM
TYPE /AWS1/S3_CHECKSUMALGORITHM
/AWS1/S3_CHECKSUMALGORITHM
¶
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
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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.
IV_EXPECTEDBUCKETOWNER
TYPE /AWS1/S3_ACCOUNTID
/AWS1/S3_ACCOUNTID
¶
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).
IV_REQUESTPAYER
TYPE /AWS1/S3_REQUESTPAYER
/AWS1/S3_REQUESTPAYER
¶
RequestPayer