autoscaling_describe_policies: Describes the policies for the specified Auto Scaling group

Description Usage Arguments Value Request syntax Examples

View source: R/autoscaling_operations.R

Description

Describes the policies for the specified Auto Scaling group.

Usage

1
2
autoscaling_describe_policies(AutoScalingGroupName, PolicyNames,
  PolicyTypes, NextToken, MaxRecords)

Arguments

AutoScalingGroupName

The name of the Auto Scaling group.

PolicyNames

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.

PolicyTypes

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

NextToken

The token for the next set of items to return. (You received this token from a previous call.)

MaxRecords

The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
list(
  ScalingPolicies = list(
    list(
      AutoScalingGroupName = "string",
      PolicyName = "string",
      PolicyARN = "string",
      PolicyType = "string",
      AdjustmentType = "string",
      MinAdjustmentStep = 123,
      MinAdjustmentMagnitude = 123,
      ScalingAdjustment = 123,
      Cooldown = 123,
      StepAdjustments = list(
        list(
          MetricIntervalLowerBound = 123.0,
          MetricIntervalUpperBound = 123.0,
          ScalingAdjustment = 123
        )
      ),
      MetricAggregationType = "string",
      EstimatedInstanceWarmup = 123,
      Alarms = list(
        list(
          AlarmName = "string",
          AlarmARN = "string"
        )
      ),
      TargetTrackingConfiguration = list(
        PredefinedMetricSpecification = list(
          PredefinedMetricType = "ASGAverageCPUUtilization"|"ASGAverageNetworkIn"|"ASGAverageNetworkOut"|"ALBRequestCountPerTarget",
          ResourceLabel = "string"
        ),
        CustomizedMetricSpecification = list(
          MetricName = "string",
          Namespace = "string",
          Dimensions = list(
            list(
              Name = "string",
              Value = "string"
            )
          ),
          Statistic = "Average"|"Minimum"|"Maximum"|"SampleCount"|"Sum",
          Unit = "string"
        ),
        TargetValue = 123.0,
        DisableScaleIn = TRUE|FALSE
      ),
      Enabled = TRUE|FALSE
    )
  ),
  NextToken = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
svc$describe_policies(
  AutoScalingGroupName = "string",
  PolicyNames = list(
    "string"
  ),
  PolicyTypes = list(
    "string"
  ),
  NextToken = "string",
  MaxRecords = 123
)

Examples

1
2
3
4
5
6
7
8
## Not run: 
# This example describes the policies for the specified Auto Scaling
# group.
svc$describe_policies(
  AutoScalingGroupName = "my-auto-scaling-group"
)

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.