AWS Auto Scaling
API Reference (API Version 2018-01-06)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

GetScalingPlanResourceForecastData

Retrieves the forecast data for a scalable resource.

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.

Request Syntax

{ "EndTime": number, "ForecastDataType": "string", "ResourceId": "string", "ScalableDimension": "string", "ScalingPlanName": "string", "ScalingPlanVersion": number, "ServiceNamespace": "string", "StartTime": number }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

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 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.

Type: Timestamp

Required: Yes

ForecastDataType

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.

Type: String

Valid Values: CapacityForecast | LoadForecast | ScheduledActionMinCapacity | ScheduledActionMaxCapacity

Required: Yes

ResourceId

The ID of the resource. This string consists of a prefix (autoScalingGroup) followed by the name of a specified Auto Scaling group (my-asg). Example: autoScalingGroup/my-asg.

Type: String

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

ScalableDimension

The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.

Type: String

Valid Values: autoscaling:autoScalingGroup:DesiredCapacity

Required: Yes

ScalingPlanName

The name of the scaling plan.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{Print}&&[^|:/]]+

Required: Yes

ScalingPlanVersion

The version number of the scaling plan. Currently, the only valid value is 1.

Type: Long

Required: Yes

ServiceNamespace

The namespace of the AWS service. The only valid value is autoscaling.

Type: String

Valid Values: autoscaling

Required: Yes

StartTime

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.

Type: Timestamp

Required: Yes

Response Syntax

{ "Datapoints": [ { "Timestamp": number, "Value": number } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Datapoints

The data points to return.

Type: Array of Datapoint objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

The service encountered an internal error.

HTTP Status Code: 400

ValidationException

An exception was thrown for a validation issue. Review the parameters provided.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: