describe-policies¶

Description¶

Describes the policies for the specified Auto Scaling group.

Synopsis¶

  describe-policies
[--auto-scaling-group-name <value>]
[--policy-names <value>]
[--policy-types <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

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

The name of the Auto Scaling group.

--policy-names (list)

The names of one or more policies. If you omit this parameter, all policies are described. If a group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.

(string)

Syntax:

"string" "string" ...

--policy-types (list)

One or more policy types. The valid values are SimpleScaling , StepScaling , and TargetTrackingScaling .

(string)

Syntax:

"string" "string" ...

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

See ‘aws help’ for descriptions of global parameters.

Examples¶

To describe Auto Scaling policies

This example describes the policies for the specified Auto Scaling group:

aws autoscaling describe-policies --auto-scaling-group-name my-auto-scaling-group

The following is example output:

{
    "ScalingPolicies": [
        {
            "PolicyName": "ScaleIn",
            "AutoScalingGroupName": "my-auto-scaling-group",
            "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn",
            "AdjustmentType": "ChangeInCapacity",
            "Alarms": [],
            "ScalingAdjustment": -1
        },
        {
            "PolicyName": "ScalePercentChange",
            "MinAdjustmentStep": 2,
            "AutoScalingGroupName": "my-auto-scaling-group",
            "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange",
            "Cooldown": 60,
            "AdjustmentType": "PercentChangeInCapacity",
            "Alarms": [],
            "ScalingAdjustment": 25
        }
    ]
}

To return specific scaling policies, use the policy-names parameter:

aws autoscaling describe-policies --auto-scaling-group-name my-auto-scaling-group --policy-names ScaleIn

To return a specific number of policies, use the max-items parameter:

aws autoscaling describe-policies --auto-scaling-group-name my-auto-scaling-group --max-items 1

The following is example output:

{
    "ScalingPolicies": [
        {
            "PolicyName": "ScaleIn",
            "AutoScalingGroupName": "my-auto-scaling-group",
            "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn",
            "AdjustmentType": "ChangeInCapacity",
            "Alarms": [],
            "ScalingAdjustment": -1
        }
    ],
    "NextToken": "Z3M3LMPEXAMPLE"
}

If the output includes a NextToken field, use the value of this field with the starting-token parameter in a subsequent call to get the additional policies:

aws autoscaling describe-policies --auto-scaling-group-name my-auto-scaling-group --starting-token Z3M3LMPEXAMPLE

For more information, see Dynamic Scaling in the Amazon EC2 Auto Scaling User Guide.

Output¶

ScalingPolicies -> (list)

The scaling policies.

(structure)

Describes a scaling policy.

AutoScalingGroupName -> (string)

The name of the Auto Scaling group.

PolicyName -> (string)

The name of the scaling policy.

PolicyARN -> (string)

The Amazon Resource Name (ARN) of the policy.

PolicyType -> (string)

One of the following policy types:

TargetTrackingScaling

StepScaling

SimpleScaling (default)

For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide .

AdjustmentType -> (string)

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity , ExactCapacity , and PercentChangeInCapacity .

MinAdjustmentStep -> (integer)

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

MinAdjustmentMagnitude -> (integer)

The minimum value to scale by when the adjustment type is PercentChangeInCapacity .

ScalingAdjustment -> (integer)

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

Cooldown -> (integer)

The duration of the policy’s cooldown period, in seconds.

StepAdjustments -> (list)

A set of adjustments that enable you to scale based on the size of the alarm breach.

(structure)

Describes information used to create a step adjustment for a step scaling policy.

For the following examples, suppose that you have an alarm with a breach threshold of 50:

To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.

To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.

There are a few rules for the step adjustments for your step policy:

The ranges of your step adjustments can’t overlap or have a gap.

At most, one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.

At most, one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.

The upper and lower bound can’t be null in the same step adjustment.

For more information, see Step adjustments in the Amazon EC2 Auto Scaling User Guide .

MetricIntervalLowerBound -> (double)

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.

MetricIntervalUpperBound -> (double)

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.

The upper bound must be greater than the lower bound.

ScalingAdjustment -> (integer)

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

MetricAggregationType -> (string)

The aggregation type for the CloudWatch metrics. The valid values are Minimum , Maximum , and Average .

EstimatedInstanceWarmup -> (integer)

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

Alarms -> (list)

The CloudWatch alarms related to the policy.

(structure)

Describes an alarm.

AlarmName -> (string)

The name of the alarm.

AlarmARN -> (string)

The Amazon Resource Name (ARN) of the alarm.

TargetTrackingConfiguration -> (structure)

A target tracking scaling policy.

PredefinedMetricSpecification -> (structure)

A predefined metric. You must specify either a predefined metric or a customized metric.

PredefinedMetricType -> (string)

The metric type. The following predefined metrics are available:

ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.

ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.

ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.

ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.

ResourceLabel -> (string)

Identifies the resource associated with the metric type. You can’t specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Auto Scaling group.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:

app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

CustomizedMetricSpecification -> (structure)

A customized metric. You must specify either a predefined metric or a customized metric.

MetricName -> (string)

The name of the metric.

Namespace -> (string)

The namespace of the metric.

Dimensions -> (list)

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

(structure)

Describes the dimension of a metric.

Name -> (string)

The name of the dimension.

Value -> (string)

The value of the dimension.

Statistic -> (string)

The statistic of the metric.

Unit -> (string)

The unit of the metric.

TargetValue -> (double)

The target value for the metric.

DisableScaleIn -> (boolean)

Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn’t remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is false .

Enabled -> (boolean)

Indicates whether the policy is enabled (true ) or disabled (false ).

NextToken -> (string)

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Table of Contents

Feedback

User Guide