putBucketAccelerateConfiguration method

Future<void> putBucketAccelerateConfiguration({ required AccelerateConfiguration accelerateConfiguration, required String bucket, String? expectedBucketOwner, })

Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.

To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration 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.

The Transfer Acceleration state of a bucket can be set to one of the following two values:

• Enabled – Enables accelerated data transfers to the bucket.
• Suspended – Disables accelerated data transfers to the bucket.

The GetBucketAccelerateConfiguration operation returns the transfer acceleration state of a bucket.

After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (".").

For more information about transfer acceleration, see Transfer Acceleration.

The following operations are related to PutBucketAccelerateConfiguration:

• GetBucketAccelerateConfiguration
• CreateBucket

Parameter accelerateConfiguration : Container for setting the transfer acceleration state.

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

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