Skip to content
AWS for Query.Farm

aws.autoscaling_plans.get_scaling_plan_resource_forecast_data

Example SQL Queries

SELECT * FROM
aws.autoscaling_plans.get_scaling_plan_resource_forecast_data
WHERE
"scaling_plan_name" = 'VALUE'
AND "scaling_plan_version" = 'VALUE'
AND "service_namespace" = 'VALUE'
AND "resource_id" = 'VALUE'
AND "scalable_dimension" = 'VALUE'
AND "forecast_data_type" = 'VALUE'
AND "start_time" = 'VALUE'
AND "end_time" = 'VALUE';

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.

Table Definition

Column NameColumn Data Type
end_time Required Input Column

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.

TIMESTAMP_S
forecast_data_type Required Input Column

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.

VARCHAR
resource_id Required Input Column

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. 

VARCHAR
scalable_dimension Required Input Column

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

VARCHAR
scaling_plan_name Required Input Column

The name of the scaling plan.

VARCHAR
scaling_plan_version Required Input Column

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

BIGINT
service_namespace Required Input Column

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

VARCHAR
start_time Required Input Column

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. 

TIMESTAMP_S
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
datapoints

The data points to return.

STRUCT(
    "timestamp" TIMESTAMP_S,
    "value" DOUBLE
)[]
Show child fields
datapoints[]
Show child fields
datapoints[].timestamp

The time stamp for the data point in UTC format.

datapoints[].value

The value of the data point.