| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.StorageGateway.UpdateBandwidthRateLimit
Description
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 for the stored volume, cached volume, and tape gateway types.
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.
Synopsis
- data UpdateBandwidthRateLimit = UpdateBandwidthRateLimit' {}
- newUpdateBandwidthRateLimit :: Text -> UpdateBandwidthRateLimit
- updateBandwidthRateLimit_averageUploadRateLimitInBitsPerSec :: Lens' UpdateBandwidthRateLimit (Maybe Natural)
- updateBandwidthRateLimit_averageDownloadRateLimitInBitsPerSec :: Lens' UpdateBandwidthRateLimit (Maybe Natural)
- updateBandwidthRateLimit_gatewayARN :: Lens' UpdateBandwidthRateLimit Text
- data UpdateBandwidthRateLimitResponse = UpdateBandwidthRateLimitResponse' {
- gatewayARN :: Maybe Text
- httpStatus :: Int
- newUpdateBandwidthRateLimitResponse :: Int -> UpdateBandwidthRateLimitResponse
- updateBandwidthRateLimitResponse_gatewayARN :: Lens' UpdateBandwidthRateLimitResponse (Maybe Text)
- updateBandwidthRateLimitResponse_httpStatus :: Lens' UpdateBandwidthRateLimitResponse Int
Creating a Request
data UpdateBandwidthRateLimit Source #
A JSON object containing one or more of the following fields:
- UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec
- UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec
See: newUpdateBandwidthRateLimit smart constructor.
Constructors
| UpdateBandwidthRateLimit' | |
Fields
| |
Instances
newUpdateBandwidthRateLimit Source #
Create a value of UpdateBandwidthRateLimit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:averageUploadRateLimitInBitsPerSec:UpdateBandwidthRateLimit', updateBandwidthRateLimit_averageUploadRateLimitInBitsPerSec - The average upload bandwidth rate limit in bits per second.
$sel:averageDownloadRateLimitInBitsPerSec:UpdateBandwidthRateLimit', updateBandwidthRateLimit_averageDownloadRateLimitInBitsPerSec - The average download bandwidth rate limit in bits per second.
$sel:gatewayARN:UpdateBandwidthRateLimit', updateBandwidthRateLimit_gatewayARN - Undocumented member.
Request Lenses
updateBandwidthRateLimit_averageUploadRateLimitInBitsPerSec :: Lens' UpdateBandwidthRateLimit (Maybe Natural) Source #
The average upload bandwidth rate limit in bits per second.
updateBandwidthRateLimit_averageDownloadRateLimitInBitsPerSec :: Lens' UpdateBandwidthRateLimit (Maybe Natural) Source #
The average download bandwidth rate limit in bits per second.
updateBandwidthRateLimit_gatewayARN :: Lens' UpdateBandwidthRateLimit Text Source #
Undocumented member.
Destructuring the Response
data UpdateBandwidthRateLimitResponse Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway whose throttle information was updated.
See: newUpdateBandwidthRateLimitResponse smart constructor.
Constructors
| UpdateBandwidthRateLimitResponse' | |
Fields
| |
Instances
newUpdateBandwidthRateLimitResponse Source #
Create a value of UpdateBandwidthRateLimitResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:UpdateBandwidthRateLimit', updateBandwidthRateLimitResponse_gatewayARN - Undocumented member.
$sel:httpStatus:UpdateBandwidthRateLimitResponse', updateBandwidthRateLimitResponse_httpStatus - The response's http status code.
Response Lenses
updateBandwidthRateLimitResponse_gatewayARN :: Lens' UpdateBandwidthRateLimitResponse (Maybe Text) Source #
Undocumented member.
updateBandwidthRateLimitResponse_httpStatus :: Lens' UpdateBandwidthRateLimitResponse Int Source #
The response's http status code.