AutoScaling / Client / describe_auto_scaling_groups
describe_auto_scaling_groups#
- AutoScaling.Client.describe_auto_scaling_groups(**kwargs)#
Gets information about the Auto Scaling groups in the account and Region.
If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.
This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.
See also: AWS API Documentation
Request Syntax
response = client.describe_auto_scaling_groups( AutoScalingGroupNames=[ 'string', ], NextToken='string', MaxRecords=123, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] )
- Parameters:
AutoScalingGroupNames (list) –
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
MaxRecordsproperty.If you omit this property, all Auto Scaling groups are described.
(string) –
NextToken (string) – The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords (integer) – The maximum number of items to return with this call. The default value is
50and the maximum value is100.Filters (list) –
One or more filters to limit the results based on specific tags.
(dict) –
Describes a filter that is used to return a more specific list of results from a describe operation.
If you specify multiple filters, the filters are automatically logically joined with an
AND, and the request returns only the results that match all of the specified filters.For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
Name (string) –
The name of the filter.
The valid values for
Namedepend on which API operation you’re using with the filter ( DescribeAutoScalingGroups or DescribeTags).DescribeAutoScalingGroups
Valid values for
Nameinclude the following:tag-key- Accepts tag keys. The results only include information about the Auto Scaling groups associated with these tag keys.tag-value- Accepts tag values. The results only include information about the Auto Scaling groups associated with these tag values.tag:<key>- Accepts the key/value combination of the tag. Use the tag key in the filter name and the tag value as the filter value. The results only include information about the Auto Scaling groups associated with the specified key/value combination.
DescribeTags
Valid values for
Nameinclude the following:auto-scaling-group- Accepts the names of Auto Scaling groups. The results only include information about the tags associated with these Auto Scaling groups.key- Accepts tag keys. The results only include information about the tags associated with these tag keys.value- Accepts tag values. The results only include information about the tags associated with these tag values.propagate-at-launch- Accepts a Boolean value, which specifies whether tags propagate to instances at launch. The results only include information about the tags associated with the specified Boolean value.
Values (list) –
One or more filter values. Filter values are case-sensitive.
If you specify multiple values for a filter, the values are automatically logically joined with an
OR, and the request returns all results that match any of the specified values. For example, specify “tag:environment” for the filter name and “production,development” for the filter values to find Auto Scaling groups with the tag “environment=production” or “environment=development”.(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'AutoScalingGroups': [ { 'AutoScalingGroupName': 'string', 'AutoScalingGroupARN': 'string', 'LaunchConfigurationName': 'string', 'LaunchTemplate': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, 'MixedInstancesPolicy': { 'LaunchTemplate': { 'LaunchTemplateSpecification': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, 'Overrides': [ { 'InstanceType': 'string', 'WeightedCapacity': 'string', 'LaunchTemplateSpecification': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'excluded'|'required', 'BurstablePerformance': 'included'|'excluded'|'required', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'excluded'|'required', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'nvidia'|'amd'|'amazon-web-services'|'xilinx', ], 'AcceleratorNames': [ 'a100'|'v100'|'k80'|'t4'|'m60'|'radeon-pro-v520'|'vu9p', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ] } }, ] }, 'InstancesDistribution': { 'OnDemandAllocationStrategy': 'string', 'OnDemandBaseCapacity': 123, 'OnDemandPercentageAboveBaseCapacity': 123, 'SpotAllocationStrategy': 'string', 'SpotInstancePools': 123, 'SpotMaxPrice': 'string' } }, 'MinSize': 123, 'MaxSize': 123, 'DesiredCapacity': 123, 'PredictedCapacity': 123, 'DefaultCooldown': 123, 'AvailabilityZones': [ 'string', ], 'LoadBalancerNames': [ 'string', ], 'TargetGroupARNs': [ 'string', ], 'HealthCheckType': 'string', 'HealthCheckGracePeriod': 123, 'Instances': [ { 'InstanceId': 'string', 'InstanceType': 'string', 'AvailabilityZone': 'string', 'LifecycleState': 'Pending'|'Pending:Wait'|'Pending:Proceed'|'Quarantined'|'InService'|'Terminating'|'Terminating:Wait'|'Terminating:Proceed'|'Terminated'|'Detaching'|'Detached'|'EnteringStandby'|'Standby'|'Warmed:Pending'|'Warmed:Pending:Wait'|'Warmed:Pending:Proceed'|'Warmed:Terminating'|'Warmed:Terminating:Wait'|'Warmed:Terminating:Proceed'|'Warmed:Terminated'|'Warmed:Stopped'|'Warmed:Running'|'Warmed:Hibernated', 'HealthStatus': 'string', 'LaunchConfigurationName': 'string', 'LaunchTemplate': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, 'ProtectedFromScaleIn': True|False, 'WeightedCapacity': 'string' }, ], 'CreatedTime': datetime(2015, 1, 1), 'SuspendedProcesses': [ { 'ProcessName': 'string', 'SuspensionReason': 'string' }, ], 'PlacementGroup': 'string', 'VPCZoneIdentifier': 'string', 'EnabledMetrics': [ { 'Metric': 'string', 'Granularity': 'string' }, ], 'Status': 'string', 'Tags': [ { 'ResourceId': 'string', 'ResourceType': 'string', 'Key': 'string', 'Value': 'string', 'PropagateAtLaunch': True|False }, ], 'TerminationPolicies': [ 'string', ], 'NewInstancesProtectedFromScaleIn': True|False, 'ServiceLinkedRoleARN': 'string', 'MaxInstanceLifetime': 123, 'CapacityRebalance': True|False, 'WarmPoolConfiguration': { 'MaxGroupPreparedCapacity': 123, 'MinSize': 123, 'PoolState': 'Stopped'|'Running'|'Hibernated', 'Status': 'PendingDelete', 'InstanceReusePolicy': { 'ReuseOnScaleIn': True|False } }, 'WarmPoolSize': 123, 'Context': 'string', 'DesiredCapacityType': 'string', 'DefaultInstanceWarmup': 123, 'TrafficSources': [ { 'Identifier': 'string', 'Type': 'string' }, ], 'InstanceMaintenancePolicy': { 'MinHealthyPercentage': 123, 'MaxHealthyPercentage': 123 } }, ], 'NextToken': 'string' }
Response Structure
(dict) –
AutoScalingGroups (list) –
The groups.
(dict) –
Describes an Auto Scaling group.
AutoScalingGroupName (string) –
The name of the Auto Scaling group.
AutoScalingGroupARN (string) –
The Amazon Resource Name (ARN) of the Auto Scaling group.
LaunchConfigurationName (string) –
The name of the associated launch configuration.
LaunchTemplate (dict) –
The launch template for the group.
LaunchTemplateId (string) –
The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a
LaunchTemplateIdor aLaunchTemplateName.LaunchTemplateName (string) –
The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a
LaunchTemplateIdor aLaunchTemplateName.Version (string) –
The version number,
$Latest, or$Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is$Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is$Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is$Default.
MixedInstancesPolicy (dict) –
The mixed instances policy for the group.
LaunchTemplate (dict) –
One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.
LaunchTemplateSpecification (dict) –
The launch template.
LaunchTemplateId (string) –
The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a
LaunchTemplateIdor aLaunchTemplateName.LaunchTemplateName (string) –
The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a
LaunchTemplateIdor aLaunchTemplateName.Version (string) –
The version number,
$Latest, or$Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is$Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is$Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is$Default.
Overrides (list) –
Any properties that you specify override the same properties in the launch template.
(dict) –
Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed instances policy:
Override the instance type that is specified in the launch template.
Use multiple instance types.
Specify the instance types that you want, or define your instance requirements instead and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements. This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when fulfilling Spot and On-Demand capacities. You can view which instance types are matched before you apply the instance requirements to your Auto Scaling group.
After you define your instance requirements, you don’t have to keep updating these settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance requirements of the Auto Scaling group to determine whether a new EC2 instance type can be used.
InstanceType (string) –
The instance type, such as
m3.xlarge. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see Instance types in the Amazon EC2 User Guide for Linux Instances.You can specify up to 40 instance types per Auto Scaling group.
WeightedCapacity (string) –
If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a
WeightedCapacityof five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see Configure an Auto Scaling group to use instance weights in the Amazon EC2 Auto Scaling User Guide. Value must be in the range of 1–999.If you specify a value for
WeightedCapacityfor one instance type, you must specify a value forWeightedCapacityfor all of them.Warning
Every Auto Scaling group has three size parameters (
DesiredCapacity,MaxSize, andMinSize). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.LaunchTemplateSpecification (dict) –
Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that’s specified in the
LaunchTemplatedefinition. For more information, see Specifying a different launch template for an instance type in the Amazon EC2 Auto Scaling User Guide.You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the
LaunchTemplatedefinition count towards this limit.LaunchTemplateId (string) –
The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a
LaunchTemplateIdor aLaunchTemplateName.LaunchTemplateName (string) –
The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a
LaunchTemplateIdor aLaunchTemplateName.Version (string) –
The version number,
$Latest, or$Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is$Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is$Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is$Default.
InstanceRequirements (dict) –
The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.
You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template.
Note
If you specify
InstanceRequirements, you can’t specifyInstanceType.VCpuCount (dict) –
The minimum and maximum number of vCPUs for an instance type.
Min (integer) –
The minimum number of vCPUs.
Max (integer) –
The maximum number of vCPUs.
MemoryMiB (dict) –
The minimum and maximum instance memory size for an instance type, in MiB.
Min (integer) –
The memory minimum in MiB.
Max (integer) –
The memory maximum in MiB.
CpuManufacturers (list) –
Lists which specific CPU manufacturers to include.
For instance types with Intel CPUs, specify
intel.For instance types with AMD CPUs, specify
amd.For instance types with Amazon Web Services CPUs, specify
amazon-web-services.
Note
Don’t confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
(string) –
MemoryGiBPerVCpu (dict) –
The minimum and maximum amount of memory per vCPU for an instance type, in GiB.
Default: No minimum or maximum limits
Min (float) –
The memory minimum in GiB.
Max (float) –
The memory maximum in GiB.
ExcludedInstanceTypes (list) –
The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (
*), to exclude an instance family, type, size, or generation. The following are examples:m5.8xlarge,c5*.*,m5a.*,r*,*3*.For example, if you specify
c5*, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.Note
If you specify
ExcludedInstanceTypes, you can’t specifyAllowedInstanceTypes.Default: No excluded instance types
(string) –
InstanceGenerations (list) –
Indicates whether current or previous generation instance types are included.
For current generation instance types, specify
current. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide for Linux Instances.For previous generation instance types, specify
previous.
Default: Any current or previous generation
(string) –
SpotMaxPricePercentageOverLowestPrice (integer) –
[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
If you set
DesiredCapacityTypetovcpuormemory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price.Note
Only one of
SpotMaxPricePercentageOverLowestPriceorMaxSpotPriceAsPercentageOfOptimalOnDemandPricecan be specified. If you don’t specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as999999.MaxSpotPriceAsPercentageOfOptimalOnDemandPrice (integer) –
[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
If you set
DesiredCapacityTypetovcpuormemory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price.Note
Only one of
SpotMaxPricePercentageOverLowestPriceorMaxSpotPriceAsPercentageOfOptimalOnDemandPricecan be specified. If you don’t specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as999999.OnDemandMaxPricePercentageOverLowestPrice (integer) –
[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
To turn off price protection, specify a high value, such as
999999.If you set
DesiredCapacityTypetovcpuormemory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price.Default:
20BareMetal (string) –
Indicates whether bare metal instance types are included, excluded, or required.
Default:
excludedBurstablePerformance (string) –
Indicates whether burstable performance instance types are included, excluded, or required. For more information, see Burstable performance instances in the Amazon EC2 User Guide for Linux Instances.
Default:
excludedRequireHibernateSupport (boolean) –
Indicates whether instance types must provide On-Demand Instance hibernation support.
Default:
falseNetworkInterfaceCount (dict) –
The minimum and maximum number of network interfaces for an instance type.
Default: No minimum or maximum limits
Min (integer) –
The minimum number of network interfaces.
Max (integer) –
The maximum number of network interfaces.
LocalStorage (string) –
Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide for Linux Instances.
Default:
includedLocalStorageTypes (list) –
Indicates the type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify
hdd.For instance types with solid state drive (SSD) storage, specify
ssd.
Default: Any local storage type
(string) –
TotalLocalStorageGB (dict) –
The minimum and maximum total local storage size for an instance type, in GB.
Default: No minimum or maximum limits
Min (float) –
The storage minimum in GB.
Max (float) –
The storage maximum in GB.
BaselineEbsBandwidthMbps (dict) –
The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide for Linux Instances.
Default: No minimum or maximum limits
Min (integer) –
The minimum value in Mbps.
Max (integer) –
The maximum value in Mbps.
AcceleratorTypes (list) –
Lists the accelerator types that must be on an instance type.
For instance types with GPU accelerators, specify
gpu.For instance types with FPGA accelerators, specify
fpga.For instance types with inference accelerators, specify
inference.
Default: Any accelerator type
(string) –
AcceleratorCount (dict) –
The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) for an instance type.
To exclude accelerator-enabled instance types, set
Maxto0.Default: No minimum or maximum limits
Min (integer) –
The minimum value.
Max (integer) –
The maximum value.
AcceleratorManufacturers (list) –
Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with NVIDIA devices, specify
nvidia.For instance types with AMD devices, specify
amd.For instance types with Amazon Web Services devices, specify
amazon-web-services.For instance types with Xilinx devices, specify
xilinx.
Default: Any manufacturer
(string) –
AcceleratorNames (list) –
Lists the accelerators that must be on an instance type.
For instance types with NVIDIA A100 GPUs, specify
a100.For instance types with NVIDIA V100 GPUs, specify
v100.For instance types with NVIDIA K80 GPUs, specify
k80.For instance types with NVIDIA T4 GPUs, specify
t4.For instance types with NVIDIA M60 GPUs, specify
m60.For instance types with AMD Radeon Pro V520 GPUs, specify
radeon-pro-v520.For instance types with Xilinx VU9P FPGAs, specify
vu9p.
Default: Any accelerator
(string) –
AcceleratorTotalMemoryMiB (dict) –
The minimum and maximum total memory size for the accelerators on an instance type, in MiB.
Default: No minimum or maximum limits
Min (integer) –
The memory minimum in MiB.
Max (integer) –
The memory maximum in MiB.
NetworkBandwidthGbps (dict) –
The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
Min (float) –
The minimum amount of network bandwidth, in gigabits per second (Gbps).
Max (float) –
The maximum amount of network bandwidth, in gigabits per second (Gbps).
AllowedInstanceTypes (list) –
The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
You can use strings with one or more wild cards, represented by an asterisk (
*), to allow an instance type, size, or generation. The following are examples:m5.8xlarge,c5*.*,m5a.*,r*,*3*.For example, if you specify
c5*, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.Note
If you specify
AllowedInstanceTypes, you can’t specifyExcludedInstanceTypes.Default: All instance types
(string) –
InstancesDistribution (dict) –
The instances distribution.
OnDemandAllocationStrategy (string) –
The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.
The following lists the valid values:
lowest-price
Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements.
prioritized
You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don’t specify InstanceRequirements and cannot be used for groups that do.
OnDemandBaseCapacity (integer) –
The minimum amount of the Auto Scaling group’s capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.
This number has the same unit of measurement as the group’s desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement.
Default: 0
OnDemandPercentageAboveBaseCapacity (integer) –
Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond
OnDemandBaseCapacity. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.Default: 100
SpotAllocationStrategy (string) –
The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.
The following lists the valid values:
capacity-optimized
Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use
capacity-optimized-prioritized.capacity-optimized-prioritized
You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to
prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements.lowest-price
Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the
SpotInstancePoolsproperty. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity.price-capacity-optimized (recommended)
The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price.
SpotInstancePools (integer) –
The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the
SpotAllocationStrategyislowest-price. Value must be in the range of 1–20.Default: 2
SpotMaxPrice (string) –
The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string (“”) for the value.
Warning
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one.
Valid Range: Minimum value of 0.001
MinSize (integer) –
The minimum size of the group.
MaxSize (integer) –
The maximum size of the group.
DesiredCapacity (integer) –
The desired size of the group.
PredictedCapacity (integer) –
The predicted capacity of the group when it has a predictive scaling policy.
DefaultCooldown (integer) –
The duration of the default cooldown period, in seconds.
AvailabilityZones (list) –
One or more Availability Zones for the group.
(string) –
LoadBalancerNames (list) –
One or more load balancers associated with the group.
(string) –
TargetGroupARNs (list) –
The Amazon Resource Names (ARN) of the target groups for your load balancer.
(string) –
HealthCheckType (string) –
A comma-separated value string of one or more health check types.
HealthCheckGracePeriod (integer) –
The duration of the health check grace period, in seconds.
Instances (list) –
The EC2 instances associated with the group.
(dict) –
Describes an EC2 instance.
InstanceId (string) –
The ID of the instance.
InstanceType (string) –
The instance type of the EC2 instance.
AvailabilityZone (string) –
The Availability Zone in which the instance is running.
LifecycleState (string) –
A description of the current lifecycle state. The
Quarantinedstate is not used. For more information, see Amazon EC2 Auto Scaling instance lifecycle in the Amazon EC2 Auto Scaling User Guide.HealthStatus (string) –
The last reported health status of the instance.
Healthymeans that the instance is healthy and should remain in service.Unhealthymeans that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.LaunchConfigurationName (string) –
The launch configuration associated with the instance.
LaunchTemplate (dict) –
The launch template for the instance.
LaunchTemplateId (string) –
The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a
LaunchTemplateIdor aLaunchTemplateName.LaunchTemplateName (string) –
The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a
LaunchTemplateIdor aLaunchTemplateName.Version (string) –
The version number,
$Latest, or$Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is$Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is$Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is$Default.
ProtectedFromScaleIn (boolean) –
Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
WeightedCapacity (string) –
The number of capacity units contributed by the instance based on its instance type.
Valid Range: Minimum value of 1. Maximum value of 999.
CreatedTime (datetime) –
The date and time the group was created.
SuspendedProcesses (list) –
The suspended processes associated with the group.
(dict) –
Describes an auto scaling process that has been suspended.
For more information, see Types of processes in the Amazon EC2 Auto Scaling User Guide.
ProcessName (string) –
The name of the suspended process.
SuspensionReason (string) –
The reason that the process was suspended.
PlacementGroup (string) –
The name of the placement group into which to launch your instances, if any.
VPCZoneIdentifier (string) –
One or more subnet IDs, if applicable, separated by commas.
EnabledMetrics (list) –
The metrics enabled for the group.
(dict) –
Describes an enabled Auto Scaling group metric.
Metric (string) –
One of the following metrics:
GroupMinSizeGroupMaxSizeGroupDesiredCapacityGroupInServiceInstancesGroupPendingInstancesGroupStandbyInstancesGroupTerminatingInstancesGroupTotalInstancesGroupInServiceCapacityGroupPendingCapacityGroupStandbyCapacityGroupTerminatingCapacityGroupTotalCapacityWarmPoolDesiredCapacityWarmPoolWarmedCapacityWarmPoolPendingCapacityWarmPoolTerminatingCapacityWarmPoolTotalCapacityGroupAndWarmPoolDesiredCapacityGroupAndWarmPoolTotalCapacity
For more information, see Amazon CloudWatch metrics for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Granularity (string) –
The granularity of the metric. The only valid value is
1Minute.
Status (string) –
The current state of the group when the DeleteAutoScalingGroup operation is in progress.
Tags (list) –
The tags for the group.
(dict) –
Describes a tag for an Auto Scaling group.
ResourceId (string) –
The name of the group.
ResourceType (string) –
The type of resource. The only supported value is
auto-scaling-group.Key (string) –
The tag key.
Value (string) –
The tag value.
PropagateAtLaunch (boolean) –
Determines whether the tag is added to new instances as they are launched in the group.
TerminationPolicies (list) –
The termination policies for the group.
(string) –
NewInstancesProtectedFromScaleIn (boolean) –
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
ServiceLinkedRoleARN (string) –
The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf.
MaxInstanceLifetime (integer) –
The maximum amount of time, in seconds, that an instance can be in service.
Valid Range: Minimum value of 0.
CapacityRebalance (boolean) –
Indicates whether Capacity Rebalancing is enabled.
WarmPoolConfiguration (dict) –
The warm pool for the group.
MaxGroupPreparedCapacity (integer) –
The maximum number of instances that are allowed to be in the warm pool or in any state except
Terminatedfor the Auto Scaling group.MinSize (integer) –
The minimum number of instances to maintain in the warm pool.
PoolState (string) –
The instance state to transition to after the lifecycle actions are complete.
Status (string) –
The status of a warm pool that is marked for deletion.
InstanceReusePolicy (dict) –
The instance reuse policy.
ReuseOnScaleIn (boolean) –
Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in.
WarmPoolSize (integer) –
The current size of the warm pool.
Context (string) –
Reserved.
DesiredCapacityType (string) –
The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports
DesiredCapacityTypefor attribute-based instance type selection only.DefaultInstanceWarmup (integer) –
The duration of the default instance warmup, in seconds.
TrafficSources (list) –
The traffic sources associated with this Auto Scaling group.
(dict) –
Identifying information for a traffic source.
Identifier (string) –
Identifies the traffic source.
For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name of the Classic Load Balancer in this account and Region.
For example:
Application Load Balancer ARN:
arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456Classic Load Balancer name:
my-classic-load-balancerVPC Lattice ARN:
arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456
To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.
To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.
Type (string) –
Provides additional context for the value of
Identifier.The following lists the valid values:
elbifIdentifieris the name of a Classic Load Balancer.elbv2ifIdentifieris the ARN of an Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target group.vpc-latticeifIdentifieris the ARN of a VPC Lattice target group.
Required if the identifier is the name of a Classic Load Balancer.
InstanceMaintenancePolicy (dict) –
An instance maintenance policy.
MinHealthyPercentage (integer) –
Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of
-1.MaxHealthyPercentage (integer) –
Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of
-1.Both
MinHealthyPercentageandMaxHealthyPercentagemust be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time.
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
NextTokenvalue when requesting the next set of items. This value is null when there are no more items to return.
Exceptions
AutoScaling.Client.exceptions.InvalidNextTokenAutoScaling.Client.exceptions.ResourceContentionFault
Examples
This example describes the specified Auto Scaling group.
response = client.describe_auto_scaling_groups( AutoScalingGroupNames=[ 'my-auto-scaling-group', ], ) print(response)
Expected Output:
{ 'AutoScalingGroups': [ { 'AutoScalingGroupARN': 'arn:aws:autoscaling:us-west-1:123456789012:autoScalingGroup:12345678-1234-1234-1234-123456789012:autoScalingGroupName/my-auto-scaling-group', 'AutoScalingGroupName': 'my-auto-scaling-group', 'AvailabilityZones': [ 'us-west-2a', 'us-west-2b', 'us-west-2c', ], 'CreatedTime': datetime(2023, 3, 9, 22, 15, 11, 3, 68, 0), 'DefaultCooldown': 300, 'DesiredCapacity': 2, 'EnabledMetrics': [ ], 'HealthCheckGracePeriod': 300, 'HealthCheckType': 'EC2', 'Instances': [ { 'AvailabilityZone': 'us-west-2c', 'HealthStatus': 'Healthy', 'InstanceId': 'i-05b4f7d5be44822a6', 'InstanceType': 't3.micro', 'LaunchConfigurationName': 'my-launch-config', 'LifecycleState': 'InService', 'ProtectedFromScaleIn': False, }, { 'AvailabilityZone': 'us-west-2b', 'HealthStatus': 'Healthy', 'InstanceId': 'i-0c20ac468fa3049e8', 'InstanceType': 't3.micro', 'LaunchConfigurationName': 'my-launch-config', 'LifecycleState': 'InService', 'ProtectedFromScaleIn': False, }, ], 'LaunchConfigurationName': 'my-launch-config', 'LoadBalancerNames': [ ], 'MaxSize': 5, 'MinSize': 1, 'NewInstancesProtectedFromScaleIn': False, 'ServiceLinkedRoleARN': 'arn:aws:iam::123456789012:role/aws-service-role/autoscaling.amazonaws.com/AWSServiceRoleForAutoScaling', 'SuspendedProcesses': [ ], 'Tags': [ ], 'TargetGroupARNs': [ ], 'TerminationPolicies': [ 'Default', ], 'TrafficSources': [ ], 'VPCZoneIdentifier': 'subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782', }, ], 'ResponseMetadata': { '...': '...', }, }