getBucketTagging method

Future<GetBucketTaggingOutput> getBucketTagging({ required String bucket, String? expectedBucketOwner, })

Returns the tag set associated with the bucket.

To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

GetBucketTagging has the following special error:

• Error code: NoSuchTagSetError
  • Description: There is no tag set associated with the bucket.

The following operations are related to GetBucketTagging:

• PutBucketTagging
• DeleteBucketTagging

Parameter bucket : The name of the bucket for which to get the tagging information.

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<GetBucketTaggingOutput> getBucketTagging({
  required String bucket,
  String? expectedBucketOwner,
}) async {
  ArgumentError.checkNotNull(bucket, 'bucket');
  final headers = <String, String>{
    if (expectedBucketOwner != null)
      'x-amz-expected-bucket-owner': expectedBucketOwner.toString(),
  };
  final $result = await _protocol.send(
    method: 'GET',
    requestUri: '/${Uri.encodeComponent(bucket)}?tagging',
    headers: headers,
    exceptionFnMap: _exceptionFns,
  );
  return GetBucketTaggingOutput.fromXml($result.body);
}