Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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 is supported only for the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits for S3 file gateways, use DescribeBandwidthRateLimitSchedule.
This operation 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.
Synopsis
- data DescribeBandwidthRateLimit = DescribeBandwidthRateLimit' {
- gatewayARN :: Text
- newDescribeBandwidthRateLimit :: Text -> DescribeBandwidthRateLimit
- describeBandwidthRateLimit_gatewayARN :: Lens' DescribeBandwidthRateLimit Text
- data DescribeBandwidthRateLimitResponse = DescribeBandwidthRateLimitResponse' {}
- newDescribeBandwidthRateLimitResponse :: Int -> DescribeBandwidthRateLimitResponse
- describeBandwidthRateLimitResponse_averageDownloadRateLimitInBitsPerSec :: Lens' DescribeBandwidthRateLimitResponse (Maybe Natural)
- describeBandwidthRateLimitResponse_averageUploadRateLimitInBitsPerSec :: Lens' DescribeBandwidthRateLimitResponse (Maybe Natural)
- describeBandwidthRateLimitResponse_gatewayARN :: Lens' DescribeBandwidthRateLimitResponse (Maybe Text)
- describeBandwidthRateLimitResponse_httpStatus :: Lens' DescribeBandwidthRateLimitResponse Int
Creating a Request
data DescribeBandwidthRateLimit Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway.
See: newDescribeBandwidthRateLimit
smart constructor.
Instances
newDescribeBandwidthRateLimit Source #
Create a value of DescribeBandwidthRateLimit
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:
DescribeBandwidthRateLimit
, describeBandwidthRateLimit_gatewayARN
- Undocumented member.
Request Lenses
describeBandwidthRateLimit_gatewayARN :: Lens' DescribeBandwidthRateLimit Text Source #
Undocumented member.
Destructuring the Response
data DescribeBandwidthRateLimitResponse Source #
A JSON object containing the following fields:
See: newDescribeBandwidthRateLimitResponse
smart constructor.
DescribeBandwidthRateLimitResponse' | |
|
Instances
newDescribeBandwidthRateLimitResponse Source #
Create a value of DescribeBandwidthRateLimitResponse
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:
DescribeBandwidthRateLimitResponse
, describeBandwidthRateLimitResponse_averageDownloadRateLimitInBitsPerSec
- 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.
DescribeBandwidthRateLimitResponse
, describeBandwidthRateLimitResponse_averageUploadRateLimitInBitsPerSec
- 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.
DescribeBandwidthRateLimit
, describeBandwidthRateLimitResponse_gatewayARN
- Undocumented member.
$sel:httpStatus:DescribeBandwidthRateLimitResponse'
, describeBandwidthRateLimitResponse_httpStatus
- The response's http status code.
Response Lenses
describeBandwidthRateLimitResponse_averageDownloadRateLimitInBitsPerSec :: 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.
describeBandwidthRateLimitResponse_averageUploadRateLimitInBitsPerSec :: 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.
describeBandwidthRateLimitResponse_gatewayARN :: Lens' DescribeBandwidthRateLimitResponse (Maybe Text) Source #
Undocumented member.
describeBandwidthRateLimitResponse_httpStatus :: Lens' DescribeBandwidthRateLimitResponse Int Source #
The response's http status code.