Skip to content

Commit a0e23a8

Browse files
Add IncludeInstances parameter to DescribeAutoScalingGroups API
1 parent e24c065 commit a0e23a8

File tree

11 files changed

+87
-2
lines changed

11 files changed

+87
-2
lines changed

generator/ServiceModels/autoscaling/autoscaling-2011-01-01.api.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1262,6 +1262,7 @@
12621262
"type":"structure",
12631263
"members":{
12641264
"AutoScalingGroupNames":{"shape":"AutoScalingGroupNames"},
1265+
"IncludeInstances":{"shape":"IncludeInstances"},
12651266
"NextToken":{"shape":"XmlString"},
12661267
"MaxRecords":{"shape":"MaxRecords"},
12671268
"Filters":{"shape":"Filters"}
@@ -2157,6 +2158,7 @@
21572158
]
21582159
},
21592160
"IncludeDeletedGroups":{"type":"boolean"},
2161+
"IncludeInstances":{"type":"boolean"},
21602162
"Instance":{
21612163
"type":"structure",
21622164
"required":[

generator/ServiceModels/autoscaling/autoscaling-2011-01-01.docs.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"version": "2.0",
3-
"service": "<fullname>Amazon EC2 Auto Scaling</fullname> <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.</p> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html\">Amazon EC2 Auto Scaling User Guide</a> and the <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/Welcome.html\">Amazon EC2 Auto Scaling API Reference</a>.</p>",
3+
"service": "<fullname>Amazon EC2 Auto Scaling</fullname> <p>The <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAutoScalingGroups.html\">DescribeAutoScalingGroups</a> API operation might be throttled when retrieving details for an Auto Scaling group that contains many instances. By default, this operation returns details for all instances in the group. To help prevent throttling, you can set the <code>IncludeInstances</code> parameter to <code>false</code> to exclude instance details from the response.</p> <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.</p> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html\">Amazon EC2 Auto Scaling User Guide</a> and the <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/Welcome.html\">Amazon EC2 Auto Scaling API Reference</a>.</p>",
44
"operations": {
55
"AttachInstances": "<p>Attaches one or more EC2 instances to the specified Auto Scaling group.</p> <p>When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.</p> <p>If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-detach-attach-instances.html\">Detach or attach instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>",
66
"AttachLoadBalancerTargetGroups": "<note> <p>This API operation is superseded by <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_AttachTrafficSources.html\">AttachTrafficSources</a>, which can attach multiple traffic sources types. We recommend using <code>AttachTrafficSources</code> to simplify how you manage traffic sources. However, we continue to support <code>AttachLoadBalancerTargetGroups</code>. You can use both the original <code>AttachLoadBalancerTargetGroups</code> API operation and <code>AttachTrafficSources</code> on the same Auto Scaling group.</p> </note> <p>Attaches one or more target groups to the specified Auto Scaling group.</p> <p>This operation is used with the following load balancer types: </p> <ul> <li> <p>Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS. </p> </li> <li> <p>Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP. </p> </li> <li> <p>Gateway Load Balancer - Operates at the network layer (layer 3).</p> </li> </ul> <p>To describe the target groups for an Auto Scaling group, call the <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeLoadBalancerTargetGroups.html\">DescribeLoadBalancerTargetGroups</a> API. To detach the target group from the Auto Scaling group, call the <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DetachLoadBalancerTargetGroups.html\">DetachLoadBalancerTargetGroups</a> API.</p> <p>This operation is additive and does not detach existing target groups or Classic Load Balancers from the Auto Scaling group.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html\">Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. </p>",
@@ -966,6 +966,12 @@
966966
"DescribeScalingActivitiesType$IncludeDeletedGroups": "<p>Indicates whether to include scaling activity from deleted Auto Scaling groups.</p>"
967967
}
968968
},
969+
"IncludeInstances": {
970+
"base": null,
971+
"refs": {
972+
"AutoScalingGroupNamesType$IncludeInstances": "<p> Specifies whether to include information about Amazon EC2 instances in the response. When set to <code>true</code> (default), the response includes instance details. </p>"
973+
}
974+
},
969975
"Instance": {
970976
"base": "<p>Describes an EC2 instance.</p>",
971977
"refs": {

generator/ServiceModels/autoscaling/autoscaling-2011-01-01.normal.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1552,6 +1552,10 @@
15521552
"shape":"AutoScalingGroupNames",
15531553
"documentation":"<p>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 <code>MaxRecords</code> property.</p> <p>If you omit this property, all Auto Scaling groups are described.</p>"
15541554
},
1555+
"IncludeInstances":{
1556+
"shape":"IncludeInstances",
1557+
"documentation":"<p> Specifies whether to include information about Amazon EC2 instances in the response. When set to <code>true</code> (default), the response includes instance details. </p>"
1558+
},
15551559
"NextToken":{
15561560
"shape":"XmlString",
15571561
"documentation":"<p>The token for the next set of items to return. (You received this token from a previous call.)</p>"
@@ -3172,6 +3176,7 @@
31723176
]
31733177
},
31743178
"IncludeDeletedGroups":{"type":"boolean"},
3179+
"IncludeInstances":{"type":"boolean"},
31753180
"Instance":{
31763181
"type":"structure",
31773182
"required":[
@@ -5983,5 +5988,5 @@
59835988
},
59845989
"ZonalShiftEnabled":{"type":"boolean"}
59855990
},
5986-
"documentation":"<fullname>Amazon EC2 Auto Scaling</fullname> <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.</p> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html\">Amazon EC2 Auto Scaling User Guide</a> and the <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/Welcome.html\">Amazon EC2 Auto Scaling API Reference</a>.</p>"
5991+
"documentation":"<fullname>Amazon EC2 Auto Scaling</fullname> <p>The <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAutoScalingGroups.html\">DescribeAutoScalingGroups</a> API operation might be throttled when retrieving details for an Auto Scaling group that contains many instances. By default, this operation returns details for all instances in the group. To help prevent throttling, you can set the <code>IncludeInstances</code> parameter to <code>false</code> to exclude instance details from the response.</p> <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.</p> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html\">Amazon EC2 Auto Scaling User Guide</a> and the <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/Welcome.html\">Amazon EC2 Auto Scaling API Reference</a>.</p>"
59875992
}

sdk/src/Services/AutoScaling/Generated/Model/DescribeAutoScalingGroupsRequest.cs

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ public partial class DescribeAutoScalingGroupsRequest : AmazonAutoScalingRequest
5252
{
5353
private List<string> _autoScalingGroupNames = AWSConfigs.InitializeCollections ? new List<string>() : null;
5454
private List<Filter> _filters = AWSConfigs.InitializeCollections ? new List<Filter>() : null;
55+
private bool? _includeInstances;
5556
private int? _maxRecords;
5657
private string _nextToken;
5758

@@ -96,6 +97,25 @@ internal bool IsSetFilters()
9697
return this._filters != null && (this._filters.Count > 0 || !AWSConfigs.InitializeCollections);
9798
}
9899

100+
/// <summary>
101+
/// Gets and sets the property IncludeInstances.
102+
/// <para>
103+
/// Specifies whether to include information about Amazon EC2 instances in the response.
104+
/// When set to <c>true</c> (default), the response includes instance details.
105+
/// </para>
106+
/// </summary>
107+
public bool IncludeInstances
108+
{
109+
get { return this._includeInstances.GetValueOrDefault(); }
110+
set { this._includeInstances = value; }
111+
}
112+
113+
// Check to see if IncludeInstances property is set
114+
internal bool IsSetIncludeInstances()
115+
{
116+
return this._includeInstances.HasValue;
117+
}
118+
99119
/// <summary>
100120
/// Gets and sets the property MaxRecords.
101121
/// <para>

sdk/src/Services/AutoScaling/Generated/Model/Internal/MarshallTransformations/DescribeAutoScalingGroupsRequestMarshaller.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,10 @@ public IRequest Marshall(DescribeAutoScalingGroupsRequest publicRequest)
8989
publicRequestlistValueIndex++;
9090
}
9191
}
92+
if(publicRequest.IsSetIncludeInstances())
93+
{
94+
request.Parameters.Add("IncludeInstances", StringUtils.FromBool(publicRequest.IncludeInstances));
95+
}
9296
if(publicRequest.IsSetMaxRecords())
9397
{
9498
request.Parameters.Add("MaxRecords", StringUtils.FromInt(publicRequest.MaxRecords));

sdk/src/Services/AutoScaling/Generated/_bcl35/AmazonAutoScalingClient.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@ namespace Amazon.AutoScaling
3838
///
3939
/// Amazon EC2 Auto Scaling
4040
/// <para>
41+
/// The <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAutoScalingGroups.html">DescribeAutoScalingGroups</a>
42+
/// API operation might be throttled when retrieving details for an Auto Scaling group
43+
/// that contains many instances. By default, this operation returns details for all instances
44+
/// in the group. To help prevent throttling, you can set the <c>IncludeInstances</c>
45+
/// parameter to <c>false</c> to exclude instance details from the response.
46+
/// </para>
47+
///
48+
/// <para>
4149
/// Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
4250
/// based on user-defined scaling policies, scheduled actions, and health checks.
4351
/// </para>

sdk/src/Services/AutoScaling/Generated/_bcl35/IAmazonAutoScaling.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,14 @@ namespace Amazon.AutoScaling
3232
///
3333
/// Amazon EC2 Auto Scaling
3434
/// <para>
35+
/// The <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAutoScalingGroups.html">DescribeAutoScalingGroups</a>
36+
/// API operation might be throttled when retrieving details for an Auto Scaling group
37+
/// that contains many instances. By default, this operation returns details for all instances
38+
/// in the group. To help prevent throttling, you can set the <c>IncludeInstances</c>
39+
/// parameter to <c>false</c> to exclude instance details from the response.
40+
/// </para>
41+
///
42+
/// <para>
3543
/// Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
3644
/// based on user-defined scaling policies, scheduled actions, and health checks.
3745
/// </para>

sdk/src/Services/AutoScaling/Generated/_bcl45/AmazonAutoScalingClient.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,14 @@ namespace Amazon.AutoScaling
4141
///
4242
/// Amazon EC2 Auto Scaling
4343
/// <para>
44+
/// The <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAutoScalingGroups.html">DescribeAutoScalingGroups</a>
45+
/// API operation might be throttled when retrieving details for an Auto Scaling group
46+
/// that contains many instances. By default, this operation returns details for all instances
47+
/// in the group. To help prevent throttling, you can set the <c>IncludeInstances</c>
48+
/// parameter to <c>false</c> to exclude instance details from the response.
49+
/// </para>
50+
///
51+
/// <para>
4452
/// Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
4553
/// based on user-defined scaling policies, scheduled actions, and health checks.
4654
/// </para>

sdk/src/Services/AutoScaling/Generated/_bcl45/IAmazonAutoScaling.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,14 @@ namespace Amazon.AutoScaling
3434
///
3535
/// Amazon EC2 Auto Scaling
3636
/// <para>
37+
/// The <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAutoScalingGroups.html">DescribeAutoScalingGroups</a>
38+
/// API operation might be throttled when retrieving details for an Auto Scaling group
39+
/// that contains many instances. By default, this operation returns details for all instances
40+
/// in the group. To help prevent throttling, you can set the <c>IncludeInstances</c>
41+
/// parameter to <c>false</c> to exclude instance details from the response.
42+
/// </para>
43+
///
44+
/// <para>
3745
/// Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
3846
/// based on user-defined scaling policies, scheduled actions, and health checks.
3947
/// </para>

sdk/src/Services/AutoScaling/Generated/_netstandard/AmazonAutoScalingClient.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,14 @@ namespace Amazon.AutoScaling
4141
///
4242
/// Amazon EC2 Auto Scaling
4343
/// <para>
44+
/// The <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAutoScalingGroups.html">DescribeAutoScalingGroups</a>
45+
/// API operation might be throttled when retrieving details for an Auto Scaling group
46+
/// that contains many instances. By default, this operation returns details for all instances
47+
/// in the group. To help prevent throttling, you can set the <c>IncludeInstances</c>
48+
/// parameter to <c>false</c> to exclude instance details from the response.
49+
/// </para>
50+
///
51+
/// <para>
4452
/// Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
4553
/// based on user-defined scaling policies, scheduled actions, and health checks.
4654
/// </para>

0 commit comments

Comments
 (0)