autoscaling_describe_auto_scaling_groups: Describes one or more Auto Scaling groups

Description Usage Arguments Value Request syntax Examples

View source: R/autoscaling_operations.R

Description

Describes one or more Auto Scaling groups.

Usage

1
2
autoscaling_describe_auto_scaling_groups(AutoScalingGroupNames,
  NextToken, MaxRecords)

Arguments

AutoScalingGroupNames

The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords parameter.

If you omit this parameter, all Auto Scaling groups are described.

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 return with this 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
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
list(
  AutoScalingGroups = list(
    list(
      AutoScalingGroupName = "string",
      AutoScalingGroupARN = "string",
      LaunchConfigurationName = "string",
      LaunchTemplate = list(
        LaunchTemplateId = "string",
        LaunchTemplateName = "string",
        Version = "string"
      ),
      MixedInstancesPolicy = list(
        LaunchTemplate = list(
          LaunchTemplateSpecification = list(
            LaunchTemplateId = "string",
            LaunchTemplateName = "string",
            Version = "string"
          ),
          Overrides = list(
            list(
              InstanceType = "string",
              WeightedCapacity = "string",
              LaunchTemplateSpecification = list(
                LaunchTemplateId = "string",
                LaunchTemplateName = "string",
                Version = "string"
              )
            )
          )
        ),
        InstancesDistribution = list(
          OnDemandAllocationStrategy = "string",
          OnDemandBaseCapacity = 123,
          OnDemandPercentageAboveBaseCapacity = 123,
          SpotAllocationStrategy = "string",
          SpotInstancePools = 123,
          SpotMaxPrice = "string"
        )
      ),
      MinSize = 123,
      MaxSize = 123,
      DesiredCapacity = 123,
      DefaultCooldown = 123,
      AvailabilityZones = list(
        "string"
      ),
      LoadBalancerNames = list(
        "string"
      ),
      TargetGroupARNs = list(
        "string"
      ),
      HealthCheckType = "string",
      HealthCheckGracePeriod = 123,
      Instances = list(
        list(
          InstanceId = "string",
          InstanceType = "string",
          AvailabilityZone = "string",
          LifecycleState = "Pending"|"Pending:Wait"|"Pending:Proceed"|"Quarantined"|"InService"|"Terminating"|"Terminating:Wait"|"Terminating:Proceed"|"Terminated"|"Detaching"|"Detached"|"EnteringStandby"|"Standby",
          HealthStatus = "string",
          LaunchConfigurationName = "string",
          LaunchTemplate = list(
            LaunchTemplateId = "string",
            LaunchTemplateName = "string",
            Version = "string"
          ),
          ProtectedFromScaleIn = TRUE|FALSE,
          WeightedCapacity = "string"
        )
      ),
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      SuspendedProcesses = list(
        list(
          ProcessName = "string",
          SuspensionReason = "string"
        )
      ),
      PlacementGroup = "string",
      VPCZoneIdentifier = "string",
      EnabledMetrics = list(
        list(
          Metric = "string",
          Granularity = "string"
        )
      ),
      Status = "string",
      Tags = list(
        list(
          ResourceId = "string",
          ResourceType = "string",
          Key = "string",
          Value = "string",
          PropagateAtLaunch = TRUE|FALSE
        )
      ),
      TerminationPolicies = list(
        "string"
      ),
      NewInstancesProtectedFromScaleIn = TRUE|FALSE,
      ServiceLinkedRoleARN = "string",
      MaxInstanceLifetime = 123,
      CapacityRebalance = TRUE|FALSE
    )
  ),
  NextToken = "string"
)

Request syntax

1
2
3
4
5
6
7
svc$describe_auto_scaling_groups(
  AutoScalingGroupNames = list(
    "string"
  ),
  NextToken = "string",
  MaxRecords = 123
)

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
# This example describes the specified Auto Scaling group.
svc$describe_auto_scaling_groups(
  AutoScalingGroupNames = list(
    "my-auto-scaling-group"
  )
)

## End(Not run)

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