describe_bandwidth_rate_limit ( $opt )

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

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • GatewayARN - string - Required - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

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

public function describe_bandwidth_rate_limit($opt = null)
{
    if (!$opt) $opt = array();
    
    return $this->authenticate('DescribeBandwidthRateLimit', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback