v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1490380385.5 KB

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. This operation is supported only for the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits for S3 file gateways, use UpdateBandwidthRateLimitSchedule.

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.

post/#X-Amz-Target=StorageGateway_20130630.UpdateBandwidthRateLimit

Headers

X-Amz-Target'StorageGateway_20130630.UpdateBandwidthRateLimit' required

Request body

GatewayARNstring required

The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of gateways for your account and Amazon Web Services Region.

AverageUploadRateLimitInBitsPerSecinteger

The average upload bandwidth rate limit in bits per second.

AverageDownloadRateLimitInBitsPerSecinteger

The average download bandwidth rate limit in bits per second.

Response

Success

GatewayARNstring

The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of gateways for your account and Amazon Web Services Region.

Example response

{
  "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
}