UNPKG

@aws-sdk/client-s3

Version:

AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native

104 lines 5.08 kB
"use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.PutBucketMetricsConfigurationCommand = 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 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> */ class PutBucketMetricsConfigurationCommand 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 = "PutBucketMetricsConfigurationCommand"; const handlerExecutionContext = { logger, clientName, commandName, inputFilterSensitiveLog: models_0_1.PutBucketMetricsConfigurationRequest.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_restXmlPutBucketMetricsConfigurationCommand(input, context); } deserialize(output, context) { return Aws_restXml_1.deserializeAws_restXmlPutBucketMetricsConfigurationCommand(output, context); } } exports.PutBucketMetricsConfigurationCommand = PutBucketMetricsConfigurationCommand; //# sourceMappingURL=PutBucketMetricsConfigurationCommand.js.map