autoscalingplans_get_scaling_plan_resource_forecast_data: Retrieves the forecast data for a scalable resource

Description Usage Arguments Value Request syntax

View source: R/autoscalingplans_operations.R

Description

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.

Usage

1
2
3
autoscalingplans_get_scaling_plan_resource_forecast_data(
  ScalingPlanName, ScalingPlanVersion, ServiceNamespace, ResourceId,
  ScalableDimension, ForecastDataType, StartTime, EndTime)

Arguments

ScalingPlanName

[required] The name of the scaling plan.

ScalingPlanVersion

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

ServiceNamespace

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

ResourceId

[required] 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.

ScalableDimension

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

ForecastDataType

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

StartTime

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

EndTime

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

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
list(
  Datapoints = list(
    list(
      Timestamp = as.POSIXct(
        "2015-01-01"
      ),
      Value = 123.0
    )
  )
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
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"
  )
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.