Retrieves the forecast data for a scalable resource.
autoscalingplans_get_scaling_plan_resource_forecast_data(
ScalingPlanName, ScalingPlanVersion, ServiceNamespace, ResourceId,
ScalableDimension, ForecastDataType, StartTime, EndTime)
[required] The name of the scaling plan.
[required] The version number of the scaling plan.
[required] The namespace of the AWS service.
[required] The ID of the resource. This string consists of the resource type and unique identifier.
Auto Scaling group - The resource type is autoScalingGroup
and the
unique identifier is the name of the Auto Scaling group. Example:
autoScalingGroup/my-asg
.
ECS service - The resource type is service
and the unique
identifier is the cluster name and service name. Example:
service/default/sample-webapp
.
Spot Fleet request - The resource type is spot-fleet-request
and
the unique identifier is the Spot Fleet request ID. Example:
spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
.
DynamoDB table - The resource type is table
and the unique
identifier is the resource ID. Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and
the unique identifier is the resource ID. Example:
table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique
identifier is the cluster name. Example: cluster:my-db-cluster
.
[required] The scalable dimension for the resource.
[required] The type of forecast data to get.
LoadForecast
: The load metric forecast.
CapacityForecast
: The capacity forecast.
ScheduledActionMinCapacity
: The minimum capacity for each
scheduled scaling action. This data is calculated as the larger of
two values: the capacity forecast or the minimum capacity in the
scaling instruction.
ScheduledActionMaxCapacity
: The maximum capacity for each
scheduled scaling action. The calculation used is determined by the
predictive scaling maximum capacity behavior setting in the scaling
instruction.
[required] The inclusive start time of the time range for the forecast data to get. The date and time can be at most 56 days before the current date and time.
[required] 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 seven 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. AWS Auto Scaling only issues forecasts for periods of two days in advance.
svc$get_scaling_plan_resource_forecast_data( ScalingPlanName = "string", ScalingPlanVersion = 123, ServiceNamespace = "autoscaling"|"ecs"|"ec2"|"rds"|"dynamodb", ResourceId = "string", ScalableDimension = "autoscaling:autoScalingGroup:DesiredCapacity"|"ecs:service:DesiredCount"|"ec2:spot-fleet-request:TargetCapacity"|"rds:cluster:ReadReplicaCount"|"dynamodb:table:ReadCapacityUnits"|"dynamodb:table:WriteCapacityUnits"|"dynamodb:index:ReadCapacityUnits"|"dynamodb:index:WriteCapacityUnits", ForecastDataType = "CapacityForecast"|"LoadForecast"|"ScheduledActionMinCapacity"|"ScheduledActionMaxCapacity", StartTime = as.POSIXct( "2015-01-01" ), EndTime = as.POSIXct( "2015-01-01" ) )
Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days.