Gets information about a warm pool and its instances¶

Description¶

Gets information about a warm pool and its instances.

For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Usage¶

autoscaling_describe_warm_pool(AutoScalingGroupName, MaxRecords,
  NextToken)

Arguments¶

AutoScalingGroupName

[required] The name of the Auto Scaling group.
MaxRecords

The maximum number of instances to return with this call. The maximum value is 50.
NextToken

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

Value¶

A list with the following syntax:

list(
  WarmPoolConfiguration = list(
    MaxGroupPreparedCapacity = 123,
    MinSize = 123,
    PoolState = "Stopped"|"Running"|"Hibernated",
    Status = "PendingDelete",
    InstanceReusePolicy = list(
      ReuseOnScaleIn = TRUE|FALSE
    )
  ),
  Instances = list(
    list(
      InstanceId = "string",
      InstanceType = "string",
      AvailabilityZone = "string",
      AvailabilityZoneId = "string",
      LifecycleState = "Pending"|"Pending:Wait"|"Pending:Proceed"|"Quarantined"|"InService"|"Terminating"|"Terminating:Wait"|"Terminating:Proceed"|"Terminating:Retained"|"Terminated"|"Detaching"|"Detached"|"EnteringStandby"|"Standby"|"ReplacingRootVolume"|"ReplacingRootVolume:Wait"|"ReplacingRootVolume:Proceed"|"RootVolumeReplaced"|"Warmed:Pending"|"Warmed:Pending:Wait"|"Warmed:Pending:Proceed"|"Warmed:Pending:Retained"|"Warmed:Terminating"|"Warmed:Terminating:Wait"|"Warmed:Terminating:Proceed"|"Warmed:Terminating:Retained"|"Warmed:Terminated"|"Warmed:Stopped"|"Warmed:Running"|"Warmed:Hibernated",
      HealthStatus = "string",
      LaunchConfigurationName = "string",
      LaunchTemplate = list(
        LaunchTemplateId = "string",
        LaunchTemplateName = "string",
        Version = "string"
      ),
      ImageId = "string",
      ProtectedFromScaleIn = TRUE|FALSE,
      WeightedCapacity = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_warm_pool(
  AutoScalingGroupName = "string",
  MaxRecords = 123,
  NextToken = "string"
)