This operation returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.
This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, 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