AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . autoscaling-plans ]

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.

See also: AWS API Documentation

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 <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--scaling-plan-name (string)

The name of the scaling plan.

--scaling-plan-version (long)

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

--service-namespace (string)

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

Possible values:

  • autoscaling
  • ecs
  • ec2
  • rds
  • dynamodb

--resource-id (string)

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 .

--scalable-dimension (string)

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

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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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.