Class PutBucketMetricsConfigurationCommand

This operation is not supported for directory buckets.

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.

To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to PutBucketMetricsConfiguration:

• DeleteBucketMetricsConfiguration

• GetBucketMetricsConfiguration

• ListBucketMetricsConfigurations

PutBucketMetricsConfiguration has the following special error:

• Error code: TooManyConfigurations

  • Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

  • HTTP Status Code: HTTP 400 Bad Request

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

import { S3Client, PutBucketMetricsConfigurationCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, PutBucketMetricsConfigurationCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
// import type { S3ClientConfig } from "ibm-cos-sdk-v2";
const config = {}; // type is S3ClientConfig
const client = new S3Client(config);
const input = { // PutBucketMetricsConfigurationRequest
  Bucket: "STRING_VALUE", // required
  Id: "STRING_VALUE", // required
  MetricsConfiguration: { // MetricsConfiguration
    Id: "STRING_VALUE", // required
    Filter: { // MetricsFilter Union: only one key present
      Prefix: "STRING_VALUE",
      Tag: { // Tag
        Key: "STRING_VALUE", // required
        Value: "STRING_VALUE", // required
      },
      AccessPointArn: "STRING_VALUE",
      And: { // MetricsAndOperator
        Prefix: "STRING_VALUE",
        Tags: [ // TagSet
          {
            Key: "STRING_VALUE", // required
            Value: "STRING_VALUE", // required
          },
        ],
        AccessPointArn: "STRING_VALUE",
      },
    },
  },
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new PutBucketMetricsConfigurationCommand(input);
const response = await client.send(command);
// {};

Copy