@aws-sdk/client-s3
Version:
AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native
128 lines • 6.59 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.PutBucketTaggingCommand = void 0;
const models_0_1 = require("../models/models_0");
const Aws_restXml_1 = require("../protocols/Aws_restXml");
const middleware_apply_body_checksum_1 = require("@aws-sdk/middleware-apply-body-checksum");
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 tags for a bucket.</p>
* <p>Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign
* up to get your AWS account bill with tag key values included. Then, to see the cost of
* combined resources, organize your billing information according to resources with the same
* tag key values. For example, you can tag several resources with a specific application
* name, and then organize your billing information to see the total cost of that application
* across several services. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Cost Allocation
* and Tagging</a>.</p>
*
* <note>
* <p>Within a bucket, if you add a tag that has the same key as an existing tag, the new
* value overwrites the old value. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html">Using Cost Allocation in Amazon S3 Bucket
* Tags</a>.</p>
* </note>
* <p>To use this operation, you must have permissions to perform the
* <code>s3:PutBucketTagging</code> action. The bucket owner has this permission by default
* and can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html">Managing Access Permissions to Your Amazon S3
* Resources</a>.</p>
*
* <p>
* <code>PutBucketTagging</code> has the following special errors:</p>
* <ul>
* <li>
* <p>Error code: <code>InvalidTagError</code>
* </p>
* <ul>
* <li>
* <p>Description: The tag provided was not a valid tag. This error can occur if
* the tag did not pass input validation. For information about tag restrictions,
* see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">User-Defined Tag Restrictions</a> and <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html">AWS-Generated Cost Allocation Tag Restrictions</a>.</p>
* </li>
* </ul>
* </li>
* <li>
* <p>Error code: <code>MalformedXMLError</code>
* </p>
* <ul>
* <li>
* <p>Description: The XML provided does not match the schema.</p>
* </li>
* </ul>
* </li>
* <li>
* <p>Error code: <code>OperationAbortedError </code>
* </p>
* <ul>
* <li>
* <p>Description: A conflicting conditional operation is currently in progress
* against this resource. Please try again.</p>
* </li>
* </ul>
* </li>
* <li>
* <p>Error code: <code>InternalError</code>
* </p>
* <ul>
* <li>
* <p>Description: The service was unable to apply the provided tag to the
* bucket.</p>
* </li>
* </ul>
* </li>
* </ul>
*
*
* <p>The following operations are related to <code>PutBucketTagging</code>:</p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html">GetBucketTagging</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html">DeleteBucketTagging</a>
* </p>
* </li>
* </ul>
*/
class PutBucketTaggingCommand 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));
this.middlewareStack.use(middleware_apply_body_checksum_1.getApplyMd5BodyChecksumPlugin(configuration));
const stack = clientStack.concat(this.middlewareStack);
const { logger } = configuration;
const clientName = "S3Client";
const commandName = "PutBucketTaggingCommand";
const handlerExecutionContext = {
logger,
clientName,
commandName,
inputFilterSensitiveLog: models_0_1.PutBucketTaggingRequest.filterSensitiveLog,
outputFilterSensitiveLog: (output) => output,
};
const { requestHandler } = configuration;
return stack.resolve((request) => requestHandler.handle(request.request, options || {}), handlerExecutionContext);
}
serialize(input, context) {
return Aws_restXml_1.serializeAws_restXmlPutBucketTaggingCommand(input, context);
}
deserialize(output, context) {
return Aws_restXml_1.deserializeAws_restXmlPutBucketTaggingCommand(output, context);
}
}
exports.PutBucketTaggingCommand = PutBucketTaggingCommand;
//# sourceMappingURL=PutBucketTaggingCommand.js.map