| 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.AutoScaling.GetPredictiveScalingForecast
Description
Retrieves the forecast data for a predictive scaling policy.
Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast.
A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts.
For more information, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Synopsis
- data GetPredictiveScalingForecast = GetPredictiveScalingForecast' {}
- newGetPredictiveScalingForecast :: Text -> Text -> UTCTime -> UTCTime -> GetPredictiveScalingForecast
- getPredictiveScalingForecast_autoScalingGroupName :: Lens' GetPredictiveScalingForecast Text
- getPredictiveScalingForecast_policyName :: Lens' GetPredictiveScalingForecast Text
- getPredictiveScalingForecast_startTime :: Lens' GetPredictiveScalingForecast UTCTime
- getPredictiveScalingForecast_endTime :: Lens' GetPredictiveScalingForecast UTCTime
- data GetPredictiveScalingForecastResponse = GetPredictiveScalingForecastResponse' {}
- newGetPredictiveScalingForecastResponse :: Int -> CapacityForecast -> UTCTime -> GetPredictiveScalingForecastResponse
- getPredictiveScalingForecastResponse_httpStatus :: Lens' GetPredictiveScalingForecastResponse Int
- getPredictiveScalingForecastResponse_loadForecast :: Lens' GetPredictiveScalingForecastResponse [LoadForecast]
- getPredictiveScalingForecastResponse_capacityForecast :: Lens' GetPredictiveScalingForecastResponse CapacityForecast
- getPredictiveScalingForecastResponse_updateTime :: Lens' GetPredictiveScalingForecastResponse UTCTime
Creating a Request
data GetPredictiveScalingForecast Source #
See: newGetPredictiveScalingForecast smart constructor.
Constructors
| GetPredictiveScalingForecast' | |
Fields
| |
Instances
newGetPredictiveScalingForecast Source #
Arguments
| :: Text | |
| -> Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> GetPredictiveScalingForecast |
Create a value of GetPredictiveScalingForecast 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:autoScalingGroupName:GetPredictiveScalingForecast', getPredictiveScalingForecast_autoScalingGroupName - The name of the Auto Scaling group.
$sel:policyName:GetPredictiveScalingForecast', getPredictiveScalingForecast_policyName - The name of the policy.
$sel:startTime:GetPredictiveScalingForecast', getPredictiveScalingForecast_startTime - The inclusive start time of the time range for the forecast data to get.
At most, the date and time can be one year before the current date and
time.
$sel:endTime:GetPredictiveScalingForecast', getPredictiveScalingForecast_endTime - The exclusive end time of the time range for the forecast data to get.
The maximum time duration between the start and end time is 30 days.
Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for periods of two days in advance.
Request Lenses
getPredictiveScalingForecast_autoScalingGroupName :: Lens' GetPredictiveScalingForecast Text Source #
The name of the Auto Scaling group.
getPredictiveScalingForecast_policyName :: Lens' GetPredictiveScalingForecast Text Source #
The name of the policy.
getPredictiveScalingForecast_startTime :: Lens' GetPredictiveScalingForecast UTCTime Source #
The inclusive start time of the time range for the forecast data to get. At most, the date and time can be one year before the current date and time.
getPredictiveScalingForecast_endTime :: Lens' GetPredictiveScalingForecast UTCTime Source #
The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is 30 days.
Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for periods of two days in advance.
Destructuring the Response
data GetPredictiveScalingForecastResponse Source #
See: newGetPredictiveScalingForecastResponse smart constructor.
Constructors
| GetPredictiveScalingForecastResponse' | |
Fields
| |
Instances
newGetPredictiveScalingForecastResponse Source #
Arguments
| :: Int | |
| -> CapacityForecast | |
| -> UTCTime | |
| -> GetPredictiveScalingForecastResponse |
Create a value of GetPredictiveScalingForecastResponse 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:httpStatus:GetPredictiveScalingForecastResponse', getPredictiveScalingForecastResponse_httpStatus - The response's http status code.
$sel:loadForecast:GetPredictiveScalingForecastResponse', getPredictiveScalingForecastResponse_loadForecast - The load forecast.
$sel:capacityForecast:GetPredictiveScalingForecastResponse', getPredictiveScalingForecastResponse_capacityForecast - The capacity forecast.
$sel:updateTime:GetPredictiveScalingForecastResponse', getPredictiveScalingForecastResponse_updateTime - The time the forecast was made.
Response Lenses
getPredictiveScalingForecastResponse_httpStatus :: Lens' GetPredictiveScalingForecastResponse Int Source #
The response's http status code.
getPredictiveScalingForecastResponse_loadForecast :: Lens' GetPredictiveScalingForecastResponse [LoadForecast] Source #
The load forecast.
getPredictiveScalingForecastResponse_capacityForecast :: Lens' GetPredictiveScalingForecastResponse CapacityForecast Source #
The capacity forecast.
getPredictiveScalingForecastResponse_updateTime :: Lens' GetPredictiveScalingForecastResponse UTCTime Source #
The time the forecast was made.