getBucketRequestPayment method

Future<GetBucketRequestPaymentOutput> getBucketRequestPayment({
  1. required String bucket,
  2. String? expectedBucketOwner,
})

Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets.

The following operations are related to GetBucketRequestPayment:

Parameter bucket : The name of the bucket for which to get the payment request 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<GetBucketRequestPaymentOutput> getBucketRequestPayment({
  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)}?requestPayment',
    headers: headers,
    exceptionFnMap: _exceptionFns,
  );
  return GetBucketRequestPaymentOutput.fromXml($result.body);
}