getBucketMetricsConfiguration method

Future<GetBucketMetricsConfigurationOutput> getBucketMetricsConfiguration({ required String bucket, required String id, String? expectedBucketOwner, })

Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration 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 GetBucketMetricsConfiguration:

• PutBucketMetricsConfiguration
• DeleteBucketMetricsConfiguration
• ListBucketMetricsConfigurations
• Monitoring Metrics with Amazon CloudWatch

Parameter bucket : The name of the bucket containing the metrics configuration to retrieve.

Parameter id : The ID used to identify 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<GetBucketMetricsConfigurationOutput> getBucketMetricsConfiguration({
  required String bucket,
  required String id,
  String? expectedBucketOwner,
}) async {
  ArgumentError.checkNotNull(bucket, 'bucket');
  ArgumentError.checkNotNull(id, 'id');
  final headers = <String, String>{
    if (expectedBucketOwner != null)
      'x-amz-expected-bucket-owner': expectedBucketOwner.toString(),
  };
  final $query = <String, List<String>>{
    'id': [id],
  };
  final $result = await _protocol.sendRaw(
    method: 'GET',
    requestUri: '/${Uri.encodeComponent(bucket)}?metrics',
    queryParams: $query,
    headers: headers,
    exceptionFnMap: _exceptionFns,
  );
  final $elem = await _s.xmlFromResponse($result);
  return GetBucketMetricsConfigurationOutput(
    metricsConfiguration: MetricsConfiguration.fromXml($elem),
  );
}