Get Predictive Scaling Forecast

applicationautoscaling_get_predictive_scaling_forecast

R Documentation

Retrieves the forecast data for a predictive scaling policy

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.

Usage

applicationautoscaling_get_predictive_scaling_forecast(ServiceNamespace,
  ResourceId, ScalableDimension, PolicyName, StartTime, EndTime)

Arguments

ServiceNamespace

[required] The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.

ResourceId

[required] The identifier of the resource.

ScalableDimension

[required] The scalable dimension.

PolicyName

[required] The name of the policy.

StartTime

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

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

Value

A list with the following syntax:

list(
  LoadForecast = list(
    list(
      Timestamps = list(
        as.POSIXct(
          "2015-01-01"
        )
      ),
      Values = list(
        123.0
      ),
      MetricSpecification = list(
        TargetValue = 123.0,
        PredefinedMetricPairSpecification = list(
          PredefinedMetricType = "string",
          ResourceLabel = "string"
        ),
        PredefinedScalingMetricSpecification = list(
          PredefinedMetricType = "string",
          ResourceLabel = "string"
        ),
        PredefinedLoadMetricSpecification = list(
          PredefinedMetricType = "string",
          ResourceLabel = "string"
        ),
        CustomizedScalingMetricSpecification = list(
          MetricDataQueries = list(
            list(
              Id = "string",
              Expression = "string",
              MetricStat = list(
                Metric = list(
                  Dimensions = list(
                    list(
                      Name = "string",
                      Value = "string"
                    )
                  ),
                  MetricName = "string",
                  Namespace = "string"
                ),
                Stat = "string",
                Unit = "string"
              ),
              Label = "string",
              ReturnData = TRUE|FALSE
            )
          )
        ),
        CustomizedLoadMetricSpecification = list(
          MetricDataQueries = list(
            list(
              Id = "string",
              Expression = "string",
              MetricStat = list(
                Metric = list(
                  Dimensions = list(
                    list(
                      Name = "string",
                      Value = "string"
                    )
                  ),
                  MetricName = "string",
                  Namespace = "string"
                ),
                Stat = "string",
                Unit = "string"
              ),
              Label = "string",
              ReturnData = TRUE|FALSE
            )
          )
        ),
        CustomizedCapacityMetricSpecification = list(
          MetricDataQueries = list(
            list(
              Id = "string",
              Expression = "string",
              MetricStat = list(
                Metric = list(
                  Dimensions = list(
                    list(
                      Name = "string",
                      Value = "string"
                    )
                  ),
                  MetricName = "string",
                  Namespace = "string"
                ),
                Stat = "string",
                Unit = "string"
              ),
              Label = "string",
              ReturnData = TRUE|FALSE
            )
          )
        )
      )
    )
  ),
  CapacityForecast = list(
    Timestamps = list(
      as.POSIXct(
        "2015-01-01"
      )
    ),
    Values = list(
      123.0
    )
  ),
  UpdateTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$get_predictive_scaling_forecast(
  ServiceNamespace = "ecs"|"elasticmapreduce"|"ec2"|"appstream"|"dynamodb"|"rds"|"sagemaker"|"custom-resource"|"comprehend"|"lambda"|"cassandra"|"kafka"|"elasticache"|"neptune"|"workspaces",
  ResourceId = "string",
  ScalableDimension = "ecs:service:DesiredCount"|"ec2:spot-fleet-request:TargetCapacity"|"elasticmapreduce:instancegroup:InstanceCount"|"appstream:fleet:DesiredCapacity"|"dynamodb:table:ReadCapacityUnits"|"dynamodb:table:WriteCapacityUnits"|"dynamodb:index:ReadCapacityUnits"|"dynamodb:index:WriteCapacityUnits"|"rds:cluster:ReadReplicaCount"|"sagemaker:variant:DesiredInstanceCount"|"custom-resource:ResourceType:Property"|"comprehend:document-classifier-endpoint:DesiredInferenceUnits"|"comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"|"lambda:function:ProvisionedConcurrency"|"cassandra:table:ReadCapacityUnits"|"cassandra:table:WriteCapacityUnits"|"kafka:broker-storage:VolumeSize"|"elasticache:replication-group:NodeGroups"|"elasticache:replication-group:Replicas"|"neptune:cluster:ReadReplicaCount"|"sagemaker:variant:DesiredProvisionedConcurrency"|"sagemaker:inference-component:DesiredCopyCount"|"workspaces:workspacespool:DesiredUserSessions",
  PolicyName = "string",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  )
)