paws.management (version 0.1.12)

autoscaling_describe_policies: Describes the policies for the specified Auto Scaling group

Description

Describes the policies for the specified Auto Scaling group.

Usage

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

Value

A list with the following syntax:

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"
)

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.

Request syntax

svc$describe_policies(
  AutoScalingGroupName = "string",
  PolicyNames = list(
    "string"
  ),
  PolicyTypes = list(
    "string"
  ),
  NextToken = "string",
  MaxRecords = 123
)

Examples

if (FALSE) {
# This example describes the policies for the specified Auto Scaling
# group.
svc$describe_policies(
  AutoScalingGroupName = "my-auto-scaling-group"
)
}