Menu
AWS Storage Gateway Service
API Reference (API Version 2013-06-30)

DescribeBandwidthRateLimit

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.

Request Syntax

{
   "GatewayARN": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

GatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Required: Yes

Response Syntax

{
   "AverageDownloadRateLimitInBitsPerSec": number,
   "AverageUploadRateLimitInBitsPerSec": number,
   "GatewayARN": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AverageDownloadRateLimitInBitsPerSec

The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.

Type: Long

Valid Range: Minimum value of 102400.

AverageUploadRateLimitInBitsPerSec

The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.

Type: Long

Valid Range: Minimum value of 51200.

GatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An internal server error has occurred during the request. For more information, see the error and message fields.

HTTP Status Code: 400

InvalidGatewayRequestException

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

HTTP Status Code: 400

Example

Example Request

The following example shows a request that returns the bandwidth throttle properties of a gateway.

Sample Request


POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20120630.DescribeBandwidthRateLimit
{
   "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
               

Sample Response


HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 169
{
   "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
   "AverageUploadRateLimitInBitsPerSec": 102400,
   "AverageDownloadRateLimitInBitsPerSec": 51200
}
               

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: