predictive_scaling_forecasts
Creates, updates, deletes, gets or lists a predictive_scaling_forecasts resource.
Overview
| Name | predictive_scaling_forecasts |
| Type | Resource |
| Id | aws.autoscaling.predictive_scaling_forecasts |
Fields
The following fields are returned by SELECT queries:
- get_predictive_scaling_forecast
| Name | Datatype | Description |
|---|---|---|
capacity_forecast | string | The capacity forecast. |
load_forecast | string | The load forecast. |
update_time | string | The time the forecast was made. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_predictive_scaling_forecast | select | AutoScalingGroupName, PolicyName, StartTime, EndTime, region | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
AutoScalingGroupName | string | The name of the Auto Scaling group. |
EndTime | string (date-time) | 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. |
PolicyName | string | The name of the policy. |
StartTime | string (date-time) | 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. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_predictive_scaling_forecast
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.
SELECT
capacity_forecast,
load_forecast,
update_time
FROM aws.autoscaling.predictive_scaling_forecasts
WHERE AutoScalingGroupName = '{{ AutoScalingGroupName }}' -- required
AND PolicyName = '{{ PolicyName }}' -- required
AND StartTime = '{{ StartTime }}' -- required
AND EndTime = '{{ EndTime }}' -- required
AND region = '{{ region }}' -- required
;