| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.StorageGateway.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.
See: AWS API Reference for UpdateBandwidthRateLimit.
- updateBandwidthRateLimit :: Text -> UpdateBandwidthRateLimit
- data UpdateBandwidthRateLimit
- ubrlAverageUploadRateLimitInBitsPerSec :: Lens' UpdateBandwidthRateLimit (Maybe Natural)
- ubrlAverageDownloadRateLimitInBitsPerSec :: Lens' UpdateBandwidthRateLimit (Maybe Natural)
- ubrlGatewayARN :: Lens' UpdateBandwidthRateLimit Text
- updateBandwidthRateLimitResponse :: Int -> UpdateBandwidthRateLimitResponse
- data UpdateBandwidthRateLimitResponse
- ubrlrsGatewayARN :: Lens' UpdateBandwidthRateLimitResponse (Maybe Text)
- ubrlrsResponseStatus :: Lens' UpdateBandwidthRateLimitResponse Int
Creating a Request
updateBandwidthRateLimit Source
Arguments
| :: Text | |
| -> UpdateBandwidthRateLimit |
Creates a value of UpdateBandwidthRateLimit with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UpdateBandwidthRateLimit Source
A JSON object containing one or more of the following fields:
- UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec
- UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec
See: updateBandwidthRateLimit smart constructor.
Instances
Request Lenses
ubrlAverageUploadRateLimitInBitsPerSec :: Lens' UpdateBandwidthRateLimit (Maybe Natural) Source
The average upload bandwidth rate limit in bits per second.
ubrlAverageDownloadRateLimitInBitsPerSec :: Lens' UpdateBandwidthRateLimit (Maybe Natural) Source
The average download bandwidth rate limit in bits per second.
ubrlGatewayARN :: Lens' UpdateBandwidthRateLimit Text Source
Undocumented member.
Destructuring the Response
updateBandwidthRateLimitResponse Source
Arguments
| :: Int | |
| -> UpdateBandwidthRateLimitResponse |
Creates a value of UpdateBandwidthRateLimitResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UpdateBandwidthRateLimitResponse Source
A JSON object containing the of the gateway whose throttle information was updated.
See: updateBandwidthRateLimitResponse smart constructor.
Response Lenses
ubrlrsGatewayARN :: Lens' UpdateBandwidthRateLimitResponse (Maybe Text) Source
Undocumented member.
ubrlrsResponseStatus :: Lens' UpdateBandwidthRateLimitResponse Int Source
The response status code.