putBucketMetricsConfiguration method

Future<void> putBucketMetricsConfiguration({ required String bucket, required String id, required MetricsConfiguration metricsConfiguration, String? expectedBucketOwner, })

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
• PutBucketMetricsConfiguration
• ListBucketMetricsConfigurations

GetBucketLifecycle 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

Parameter bucket : The name of the bucket for which the metrics configuration is set.

Parameter id : The ID used to identify the metrics configuration.

Parameter metricsConfiguration : Specifies the metrics configuration.

Parameter expectedBucketOwner : The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Implementation

Future<void> putBucketMetricsConfiguration({
  required String bucket,
  required String id,
  required MetricsConfiguration metricsConfiguration,
  String? expectedBucketOwner,
}) async {
  ArgumentError.checkNotNull(bucket, 'bucket');
  ArgumentError.checkNotNull(id, 'id');
  ArgumentError.checkNotNull(metricsConfiguration, 'metricsConfiguration');
  final headers = <String, String>{
    if (expectedBucketOwner != null)
      'x-amz-expected-bucket-owner': expectedBucketOwner.toString(),
  };
  final $query = <String, List<String>>{
    'id': [id],
  };
  await _protocol.send(
    method: 'PUT',
    requestUri: '/${Uri.encodeComponent(bucket)}?metrics',
    queryParams: $query,
    headers: headers,
    payload: metricsConfiguration.toXml('MetricsConfiguration'),
    exceptionFnMap: _exceptionFns,
  );
}