@aws-sdk/client-s3
Version:
AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native
147 lines • 6.16 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.PutObjectTaggingCommand = void 0;
const models_0_1 = require("../models/models_0");
const Aws_restXml_1 = require("../protocols/Aws_restXml");
const middleware_bucket_endpoint_1 = require("@aws-sdk/middleware-bucket-endpoint");
const middleware_serde_1 = require("@aws-sdk/middleware-serde");
const smithy_client_1 = require("@aws-sdk/smithy-client");
/**
* <p>Sets the supplied tag-set to an object that already exists in a bucket.</p>
* <p>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a>.</p>
*
* <p>For tagging-related restrictions related to characters and encodings, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">Tag
* Restrictions</a>. Note that Amazon S3 limits the maximum number of tags to 10 tags per
* object.</p>
*
* <p>To use this operation, you must have permission to perform the
* <code>s3:PutObjectTagging</code> action. By default, the bucket owner has this
* permission and can grant this permission to others.</p>
*
* <p>To put tags of any other version, use the <code>versionId</code> query parameter. You
* also need permission for the <code>s3:PutObjectVersionTagging</code> action.</p>
*
* <p>For information about the Amazon S3 object tagging feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>.</p>
*
*
* <p class="title">
* <b>Special Errors</b>
* </p>
* <ul>
* <li>
* <ul>
* <li>
* <p>
* <i>Code: InvalidTagError </i>
* </p>
* </li>
* <li>
* <p>
* <i>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>.</i>
* </p>
* </li>
* </ul>
* </li>
* <li>
* <ul>
* <li>
* <p>
* <i>Code: MalformedXMLError </i>
* </p>
* </li>
* <li>
* <p>
* <i>Cause: The XML provided does not match the schema.</i>
* </p>
* </li>
* </ul>
* </li>
* <li>
* <ul>
* <li>
* <p>
* <i>Code: OperationAbortedError </i>
* </p>
* </li>
* <li>
* <p>
* <i>Cause: A conflicting conditional operation is currently in
* progress against this resource. Please try again.</i>
* </p>
* </li>
* </ul>
* </li>
* <li>
* <ul>
* <li>
* <p>
* <i>Code: InternalError</i>
* </p>
* </li>
* <li>
* <p>
* <i>Cause: The service was unable to apply the provided tag to the
* object.</i>
* </p>
* </li>
* </ul>
* </li>
* </ul>
*
*
*
*
*
*
* <p class="title">
* <b>Related Resources</b>
* </p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a>
* </p>
* </li>
* </ul>
*/
class PutObjectTaggingCommand extends smithy_client_1.Command {
// Start section: command_properties
// End section: command_properties
constructor(input) {
// Start section: command_constructor
super();
this.input = input;
// End section: command_constructor
}
/**
* @internal
*/
resolveMiddleware(clientStack, configuration, options) {
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(middleware_bucket_endpoint_1.getBucketEndpointPlugin(configuration));
const stack = clientStack.concat(this.middlewareStack);
const { logger } = configuration;
const clientName = "S3Client";
const commandName = "PutObjectTaggingCommand";
const handlerExecutionContext = {
logger,
clientName,
commandName,
inputFilterSensitiveLog: models_0_1.PutObjectTaggingRequest.filterSensitiveLog,
outputFilterSensitiveLog: models_0_1.PutObjectTaggingOutput.filterSensitiveLog,
};
const { requestHandler } = configuration;
return stack.resolve((request) => requestHandler.handle(request.request, options || {}), handlerExecutionContext);
}
serialize(input, context) {
return Aws_restXml_1.serializeAws_restXmlPutObjectTaggingCommand(input, context);
}
deserialize(output, context) {
return Aws_restXml_1.deserializeAws_restXmlPutObjectTaggingCommand(output, context);
}
}
exports.PutObjectTaggingCommand = PutObjectTaggingCommand;
//# sourceMappingURL=PutObjectTaggingCommand.js.map