| 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.DescribeBandwidthRateLimit
Description
This operation 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.
See: AWS API Reference for DescribeBandwidthRateLimit.
- describeBandwidthRateLimit :: Text -> DescribeBandwidthRateLimit
- data DescribeBandwidthRateLimit
- dbrlGatewayARN :: Lens' DescribeBandwidthRateLimit Text
- describeBandwidthRateLimitResponse :: Int -> DescribeBandwidthRateLimitResponse
- data DescribeBandwidthRateLimitResponse
- dbrlrsGatewayARN :: Lens' DescribeBandwidthRateLimitResponse (Maybe Text)
- dbrlrsAverageUploadRateLimitInBitsPerSec :: Lens' DescribeBandwidthRateLimitResponse (Maybe Natural)
- dbrlrsAverageDownloadRateLimitInBitsPerSec :: Lens' DescribeBandwidthRateLimitResponse (Maybe Natural)
- dbrlrsStatus :: Lens' DescribeBandwidthRateLimitResponse Int
Creating a Request
describeBandwidthRateLimit Source
Arguments
| :: Text | |
| -> DescribeBandwidthRateLimit |
Creates a value of DescribeBandwidthRateLimit with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeBandwidthRateLimit Source
A JSON object containing the of the gateway.
See: describeBandwidthRateLimit smart constructor.
Instances
Request Lenses
dbrlGatewayARN :: Lens' DescribeBandwidthRateLimit Text Source
Undocumented member.
Destructuring the Response
describeBandwidthRateLimitResponse Source
Arguments
| :: Int | |
| -> DescribeBandwidthRateLimitResponse |
Creates a value of DescribeBandwidthRateLimitResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeBandwidthRateLimitResponse Source
A JSON object containing the following fields:
See: describeBandwidthRateLimitResponse smart constructor.
Response Lenses
dbrlrsGatewayARN :: Lens' DescribeBandwidthRateLimitResponse (Maybe Text) Source
Undocumented member.
dbrlrsAverageUploadRateLimitInBitsPerSec :: Lens' DescribeBandwidthRateLimitResponse (Maybe Natural) Source
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.
dbrlrsAverageDownloadRateLimitInBitsPerSec :: Lens' DescribeBandwidthRateLimitResponse (Maybe Natural) Source
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.
dbrlrsStatus :: Lens' DescribeBandwidthRateLimitResponse Int Source
The response status code.