putBucketRequestPayment method

Future<void> putBucketRequestPayment({ required String bucket, required RequestPaymentConfiguration requestPaymentConfiguration, String? contentMD5, String? expectedBucketOwner, })

Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.

The following operations are related to PutBucketRequestPayment:

• CreateBucket
• GetBucketRequestPayment

Parameter bucket : The bucket name.

Parameter requestPaymentConfiguration : Container for Payer.

Parameter contentMD5 : >The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

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> putBucketRequestPayment({
  required String bucket,
  required RequestPaymentConfiguration requestPaymentConfiguration,
  String? contentMD5,
  String? expectedBucketOwner,
}) async {
  ArgumentError.checkNotNull(bucket, 'bucket');
  ArgumentError.checkNotNull(
      requestPaymentConfiguration, 'requestPaymentConfiguration');
  final headers = <String, String>{
    if (contentMD5 != null) 'Content-MD5': contentMD5.toString(),
    if (expectedBucketOwner != null)
      'x-amz-expected-bucket-owner': expectedBucketOwner.toString(),
  };
  await _protocol.send(
    method: 'PUT',
    requestUri: '/${Uri.encodeComponent(bucket)}?requestPayment',
    headers: headers,
    payload: requestPaymentConfiguration.toXml('RequestPaymentConfiguration'),
    exceptionFnMap: _exceptionFns,
  );
}