Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . autoscaling ]

execute-policy

Description

Executes the specified policy.

See also: AWS API Documentation

Synopsis

  execute-policy
[--auto-scaling-group-name <value>]
--policy-name <value>
[--honor-cooldown | --no-honor-cooldown]
[--metric-value <value>]
[--breach-threshold <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--auto-scaling-group-name (string)

The name or Amazon Resource Name (ARN) of the Auto Scaling group.

--policy-name (string)

The name or ARN of the policy.

--honor-cooldown | --no-honor-cooldown (boolean)

If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete.

This parameter is not supported if the policy type is StepScaling .

For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide .

--metric-value (double)

The metric value to compare to BreachThreshold . This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.

This parameter is required if the policy type is StepScaling and not supported otherwise.

--breach-threshold (double)

The breach threshold for the alarm.

This parameter is required if the policy type is StepScaling and not supported otherwise.

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

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

Examples

To execute an Auto Scaling policy

This example executes the specified Auto Scaling policy for the specified Auto Scaling group:

aws autoscaling execute-policy --auto-scaling-group-name my-auto-scaling-group --policy-name ScaleIn --honor-cooldown

For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.

Output

None