Container for the parameters to the PutObjectTagging operation.
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:
Inheritance Hierarchy
Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z
Syntax
public class PutObjectTaggingRequest : AmazonWebServiceRequest IAmazonWebServiceRequest
The PutObjectTaggingRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
PutObjectTaggingRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
BucketName | System.String |
Gets and sets the property 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 |
|
|
ChecksumAlgorithm | Amazon.S3.ChecksumAlgorithm |
Gets and sets the property 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
If you provide an individual checksum, Amazon S3 ignores any provided |
|
|
ExpectedBucketOwner | System.String |
Gets and sets the property ExpectedBucketOwner.
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
|
|
|
Key | System.String |
Gets and sets Key property. This key is used to identify the object in S3. |
|
|
RequestPayer | Amazon.S3.RequestPayer |
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests . |
|
|
Tagging | Amazon.S3.Model.Tagging |
The tag-set for the object. The tag-set must be encoded as URL Query parameters |
|
|
VersionId | System.String |
Gets and sets the property VersionId. The versionId of the object that the tag-set will be added to. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5