| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
UpdateBandwidthRateLimit
Description
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.
Request
Syntax
POST / HTTP/1.1 Host: storagegateway.region.amazonaws.com Authorization:authorizationContent-Type: application/x-amz-json-1.1 x-amz-date:datex-amz-target: StorageGateway_20120630.UpdateBandwidthRateLimit { "GatewayARN": "String", "AverageUploadRateLimitInBitsPerSec":Number, "AverageDownloadRateLimitInBitsPerSec":Number}
JSON Fields
- AverageDownloadRateLimitInBitsPerSec
The average download bandwidth rate limit in bits per second.
Constraint: Minimum value of 102400.
Required: Yes, if
AverageUploadRateLimitInBitsPerSecis not specified, otherwise, not required.Type: Number
- AverageUploadRateLimitInBitsPerSec
The average upload bandwidth rate limit in bits per second.
Constraint: Minimum value of 51200.
Required: Yes, if
AverageDownloadRateLimitInBitsPerSecis not specified, otherwise, not required.Type: Number
- GatewayARN
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Required: yes
Type: String
Response
Syntax
HTTP/1.1 200 OK x-amzn-RequestId: x-amzn-RequestId Content-Type: application/x-amz-json-1.1 Content-length: payloadLength Date: date { "GatewayARN": "String" }
JSON Fields
- GatewayARN
The Amazon Resource Name (ARN) of the gateway whose throttle information was updated.
Type: String
Errors
This operation returns the following error codes in addition to exceptions common to all operations. For information about these errors and common exceptions, see Error Responses.
GatewayInternalError
GatewayNotConnected
GatewayNotFound
GatewayProxyNetworkConnectionBusy
InternalError
InvalidParameters
NotSupported
Examples
Example Request
The following example shows a request that returns the bandwidth throttle properties of a gateway.
POST / HTTP/1.1
Host: storagegateway.us-east-1.amazonaws.com
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20120912T120000Z
x-amz-target: StorageGateway_20120630.UpdateBandwidthRateLimit
{
"GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway",
"AverageUploadRateLimitInBitsPerSec": 51200,
"AverageDownloadRateLimitInBitsPerSec": 102400
}Example Response
HTTP/1.1 200 OK
x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0
Date: Wed, 12 Sep 2012 12:00:02 GMT
Content-Type: application/x-amz-json-1.1
Content-length: 85
{
"GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway"
} 
