This operation updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don’t set a bandwidth rate limit, the existing rate limit remains.
By default, a gateway’s bandwidth rate limits are not set. If you don’t set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.
To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
Access
public
Parameters
Parameter |
Type |
Required |
Description |
---|---|---|---|
|
Optional |
An associative array of parameters that can have the following keys:
|
Returns
Type |
Description |
---|---|
A |
Examples
Bandwidth Rate Limit
$sg = new AmazonStorageGateway(); $response = $sg->update_bandwidth_rate_limit(array( 'GatewayARN' => $gateway_arn, 'AverageUploadRateLimitInBitsPerSec' => 51200, 'AverageDownloadRateLimitInBitsPerSec' => 102400, )); var_dump($response->isOK()); sleep(2); $response = $sg->describe_bandwidth_rate_limit(array( 'GatewayARN' => $gateway_arn, )); var_dump($response->isOK()); sleep(2); $response = $sg->delete_bandwidth_rate_limit(array( 'GatewayARN' => $gateway_arn, 'BandwidthType' => 'ALL', )); var_dump($response->isOK());
Source
Method defined in services/storagegateway.class.php | Toggle source view (6 lines) | View on GitHub