| 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.DescribeBandwidthRateLimitSchedule
Description
Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only in the volume and tape gateway types.
This operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.
A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading
If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
Synopsis
- data DescribeBandwidthRateLimitSchedule = DescribeBandwidthRateLimitSchedule' {
- gatewayARN :: Text
- newDescribeBandwidthRateLimitSchedule :: Text -> DescribeBandwidthRateLimitSchedule
- describeBandwidthRateLimitSchedule_gatewayARN :: Lens' DescribeBandwidthRateLimitSchedule Text
- data DescribeBandwidthRateLimitScheduleResponse = DescribeBandwidthRateLimitScheduleResponse' {}
- newDescribeBandwidthRateLimitScheduleResponse :: Int -> DescribeBandwidthRateLimitScheduleResponse
- describeBandwidthRateLimitScheduleResponse_gatewayARN :: Lens' DescribeBandwidthRateLimitScheduleResponse (Maybe Text)
- describeBandwidthRateLimitScheduleResponse_bandwidthRateLimitIntervals :: Lens' DescribeBandwidthRateLimitScheduleResponse (Maybe [BandwidthRateLimitInterval])
- describeBandwidthRateLimitScheduleResponse_httpStatus :: Lens' DescribeBandwidthRateLimitScheduleResponse Int
Creating a Request
data DescribeBandwidthRateLimitSchedule Source #
See: newDescribeBandwidthRateLimitSchedule smart constructor.
Constructors
| DescribeBandwidthRateLimitSchedule' | |
Fields
| |
Instances
newDescribeBandwidthRateLimitSchedule Source #
Arguments
| :: Text | |
| -> DescribeBandwidthRateLimitSchedule |
Create a value of DescribeBandwidthRateLimitSchedule 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:DescribeBandwidthRateLimitSchedule', describeBandwidthRateLimitSchedule_gatewayARN - Undocumented member.
Request Lenses
describeBandwidthRateLimitSchedule_gatewayARN :: Lens' DescribeBandwidthRateLimitSchedule Text Source #
Undocumented member.
Destructuring the Response
data DescribeBandwidthRateLimitScheduleResponse Source #
See: newDescribeBandwidthRateLimitScheduleResponse smart constructor.
Constructors
| DescribeBandwidthRateLimitScheduleResponse' | |
Fields
| |
Instances
newDescribeBandwidthRateLimitScheduleResponse Source #
Arguments
| :: Int | |
| -> DescribeBandwidthRateLimitScheduleResponse |
Create a value of DescribeBandwidthRateLimitScheduleResponse 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:DescribeBandwidthRateLimitSchedule', describeBandwidthRateLimitScheduleResponse_gatewayARN - Undocumented member.
$sel:bandwidthRateLimitIntervals:DescribeBandwidthRateLimitScheduleResponse', describeBandwidthRateLimitScheduleResponse_bandwidthRateLimitIntervals - An array that contains the bandwidth rate limit intervals for a tape or
volume gateway.
$sel:httpStatus:DescribeBandwidthRateLimitScheduleResponse', describeBandwidthRateLimitScheduleResponse_httpStatus - The response's http status code.
Response Lenses
describeBandwidthRateLimitScheduleResponse_gatewayARN :: Lens' DescribeBandwidthRateLimitScheduleResponse (Maybe Text) Source #
Undocumented member.
describeBandwidthRateLimitScheduleResponse_bandwidthRateLimitIntervals :: Lens' DescribeBandwidthRateLimitScheduleResponse (Maybe [BandwidthRateLimitInterval]) Source #
An array that contains the bandwidth rate limit intervals for a tape or volume gateway.
describeBandwidthRateLimitScheduleResponse_httpStatus :: Lens' DescribeBandwidthRateLimitScheduleResponse Int Source #
The response's http status code.