@aws-sdk/client-s3
Version:
AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native
108 lines • 5.47 kB
JavaScript
import { __extends } from "tslib";
import { PutBucketMetricsConfigurationRequest } from "../models/models_0";
import { deserializeAws_restXmlPutBucketMetricsConfigurationCommand, serializeAws_restXmlPutBucketMetricsConfigurationCommand, } from "../protocols/Aws_restXml";
import { getBucketEndpointPlugin } from "@aws-sdk/middleware-bucket-endpoint";
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
import { Command as $Command } from "@aws-sdk/smithy-client";
/**
* <p>Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
* You can have up to 1,000 metrics configurations per bucket. If you're updating an existing
* metrics configuration, note that this is a full replacement of the existing metrics
* configuration. If you don't include the elements you want to keep, they are erased.</p>
*
* <p>To use this operation, you must have permissions to perform the
* <code>s3:PutMetricsConfiguration</code> action. The bucket owner has this permission by
* default. The bucket owner 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>For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon
* CloudWatch</a>.</p>
*
* <p>The following operations are related to
* <code>PutBucketMetricsConfiguration</code>:</p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html">DeleteBucketMetricsConfiguration</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html">ListBucketMetricsConfigurations</a>
* </p>
* </li>
* </ul>
*
*
*
*
*
*
* <p>
* <code>GetBucketLifecycle</code> has the following special error:</p>
* <ul>
* <li>
* <p>Error code: <code>TooManyConfigurations</code>
* </p>
* <ul>
* <li>
* <p>Description: You are attempting to create a new configuration but have
* already reached the 1,000-configuration limit.</p>
* </li>
* <li>
* <p>HTTP Status Code: HTTP 400 Bad Request</p>
* </li>
* </ul>
* </li>
* </ul>
*/
var PutBucketMetricsConfigurationCommand = /** @class */ (function (_super) {
__extends(PutBucketMetricsConfigurationCommand, _super);
// Start section: command_properties
// End section: command_properties
function PutBucketMetricsConfigurationCommand(input) {
var _this =
// Start section: command_constructor
_super.call(this) || this;
_this.input = input;
return _this;
// End section: command_constructor
}
/**
* @internal
*/
PutBucketMetricsConfigurationCommand.prototype.resolveMiddleware = function (clientStack, configuration, options) {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(getBucketEndpointPlugin(configuration));
var stack = clientStack.concat(this.middlewareStack);
var logger = configuration.logger;
var clientName = "S3Client";
var commandName = "PutBucketMetricsConfigurationCommand";
var handlerExecutionContext = {
logger: logger,
clientName: clientName,
commandName: commandName,
inputFilterSensitiveLog: PutBucketMetricsConfigurationRequest.filterSensitiveLog,
outputFilterSensitiveLog: function (output) { return output; },
};
var requestHandler = configuration.requestHandler;
return stack.resolve(function (request) {
return requestHandler.handle(request.request, options || {});
}, handlerExecutionContext);
};
PutBucketMetricsConfigurationCommand.prototype.serialize = function (input, context) {
return serializeAws_restXmlPutBucketMetricsConfigurationCommand(input, context);
};
PutBucketMetricsConfigurationCommand.prototype.deserialize = function (output, context) {
return deserializeAws_restXmlPutBucketMetricsConfigurationCommand(output, context);
};
return PutBucketMetricsConfigurationCommand;
}($Command));
export { PutBucketMetricsConfigurationCommand };
//# sourceMappingURL=PutBucketMetricsConfigurationCommand.js.map