get-scaling-plan-resource-forecast-data¶

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.

Synopsis¶

  get-scaling-plan-resource-forecast-data
--scaling-plan-name <value>
--scaling-plan-version <value>
--service-namespace <value>
--resource-id <value>
--scalable-dimension <value>
--forecast-data-type <value>
--start-time <value>
--end-time <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--scaling-plan-name (string)

The name of the scaling plan.

--scaling-plan-version (long)

The version number of the scaling plan.

--service-namespace (string)

The namespace of the AWS service.

Possible values:

autoscaling

ecs

ec2

rds

dynamodb

--resource-id (string)

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 .

--scalable-dimension (string)

The scalable dimension for the resource.

Possible values:

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

--forecast-data-type (string)

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.

Possible values:

CapacityForecast

LoadForecast

ScheduledActionMinCapacity

ScheduledActionMaxCapacity

--start-time (timestamp)

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.

--end-time (timestamp)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To retrieve load forecast data

This example retrieves load forecast data for a scalable resource (an Auto Scaling group) that is associated with the specified scaling plan.

aws autoscaling-plans get-scaling-plan-resource-forecast-data \
    --scaling-plan-name my-scaling-plan \
    --scaling-plan-version 1 \
    --service-namespace "autoscaling" \
    --resource-id autoScalingGroup/my-asg \
    --scalable-dimension "autoscaling:autoScalingGroup:DesiredCapacity" \
    --forecast-data-type "LoadForecast" \
    --start-time "2019-08-30T00:00:00Z" \
    --end-time "2019-09-06T00:00:00Z"

Output:

{
    "Datapoints": [...]
}

For more information, see What Is AWS Auto Scaling in the AWS Auto Scaling User Guide.

Output¶

Datapoints -> (list)

The data points to return.

(structure)

Represents a single value in the forecast data used for predictive scaling.

Timestamp -> (timestamp)

The time stamp for the data point in UTC format.

Value -> (double)

The value of the data point.

Table of Contents

Feedback

User Guide