Skip to content

Commit 864dcb0

Browse files
author
awstools
committed
feat(client-auto-scaling): Add IncludeInstances parameter to DescribeAutoScalingGroups API
1 parent f0f582b commit 864dcb0

File tree

8 files changed

+48
-18
lines changed

8 files changed

+48
-18
lines changed

‎clients/client-auto-scaling/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ AWS SDK for JavaScript AutoScaling Client for Node.js, Browser and React Native.
88

99
<fullname>Amazon EC2 Auto Scaling</fullname>
1010

11+
<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.
12+
To help prevent throttling, you can set the <code>IncludeInstances</code> parameter to <code>false</code> to exclude instance details from the response.</p>
1113
<p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
1214
based on user-defined scaling policies, scheduled actions, and health checks.</p>
1315
<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>

‎clients/client-auto-scaling/src/AutoScaling.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1455,6 +1455,8 @@ export interface AutoScaling {
14551455

14561456
/**
14571457
* <fullname>Amazon EC2 Auto Scaling</fullname>
1458+
* <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.
1459+
* To help prevent throttling, you can set the <code>IncludeInstances</code> parameter to <code>false</code> to exclude instance details from the response.</p>
14581460
* <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
14591461
* based on user-defined scaling policies, scheduled actions, and health checks.</p>
14601462
* <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>

‎clients/client-auto-scaling/src/AutoScalingClient.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -599,6 +599,8 @@ export interface AutoScalingClientResolvedConfig extends AutoScalingClientResolv
599599

600600
/**
601601
* <fullname>Amazon EC2 Auto Scaling</fullname>
602+
* <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.
603+
* To help prevent throttling, you can set the <code>IncludeInstances</code> parameter to <code>false</code> to exclude instance details from the response.</p>
602604
* <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
603605
* based on user-defined scaling policies, scheduled actions, and health checks.</p>
604606
* <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>

‎clients/client-auto-scaling/src/commands/DescribeAutoScalingGroupsCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ export interface DescribeAutoScalingGroupsCommandOutput extends AutoScalingGroup
4646
* AutoScalingGroupNames: [ // AutoScalingGroupNames
4747
* "STRING_VALUE",
4848
* ],
49+
* IncludeInstances: true || false,
4950
* NextToken: "STRING_VALUE",
5051
* MaxRecords: Number("int"),
5152
* Filters: [ // Filters

‎clients/client-auto-scaling/src/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
/* eslint-disable */
33
/**
44
* <fullname>Amazon EC2 Auto Scaling</fullname>
5+
* <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.
6+
* To help prevent throttling, you can set the <code>IncludeInstances</code> parameter to <code>false</code> to exclude instance details from the response.</p>
57
* <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
68
* based on user-defined scaling policies, scheduled actions, and health checks.</p>
79
* <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>

‎clients/client-auto-scaling/src/models/models_0.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3204,6 +3204,14 @@ export interface AutoScalingGroupNamesType {
32043204
*/
32053205
AutoScalingGroupNames?: string[] | undefined;
32063206

3207+
/**
3208+
* <p>
3209+
* Specifies whether to include information about Amazon EC2 instances in the response. When set to <code>true</code> (default), the response includes instance details.
3210+
* </p>
3211+
* @public
3212+
*/
3213+
IncludeInstances?: boolean | undefined;
3214+
32073215
/**
32083216
* <p>The token for the next set of items to return. (You received this token from a
32093217
* previous call.)</p>

‎clients/client-auto-scaling/src/protocols/Aws_query.ts

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3223,6 +3223,9 @@ const se_AutoScalingGroupNamesType = (input: AutoScalingGroupNamesType, context:
32233223
entries[loc] = value;
32243224
});
32253225
}
3226+
if (input[_IIn] != null) {
3227+
entries[_IIn] = input[_IIn];
3228+
}
32263229
if (input[_NT] != null) {
32273230
entries[_NT] = input[_NT];
32283231
}
@@ -3557,8 +3560,8 @@ const se_CompleteLifecycleActionType = (input: CompleteLifecycleActionType, cont
35573560
if (input[_LAR] != null) {
35583561
entries[_LAR] = input[_LAR];
35593562
}
3560-
if (input[_IIn] != null) {
3561-
entries[_IIn] = input[_IIn];
3563+
if (input[_IIns] != null) {
3564+
entries[_IIns] = input[_IIns];
35623565
}
35633566
return entries;
35643567
};
@@ -3622,8 +3625,8 @@ const se_CreateAutoScalingGroupType = (input: CreateAutoScalingGroupType, contex
36223625
entries[loc] = value;
36233626
});
36243627
}
3625-
if (input[_IIn] != null) {
3626-
entries[_IIn] = input[_IIn];
3628+
if (input[_IIns] != null) {
3629+
entries[_IIns] = input[_IIns];
36273630
}
36283631
if (input[_MS] != null) {
36293632
entries[_MS] = input[_MS];
@@ -3814,8 +3817,8 @@ const se_CreateLaunchConfigurationType = (input: CreateLaunchConfigurationType,
38143817
if (input[_UD] != null) {
38153818
entries[_UD] = input[_UD];
38163819
}
3817-
if (input[_IIn] != null) {
3818-
entries[_IIn] = input[_IIn];
3820+
if (input[_IIns] != null) {
3821+
entries[_IIns] = input[_IIns];
38193822
}
38203823
if (input[_IT] != null) {
38213824
entries[_IT] = input[_IT];
@@ -5947,8 +5950,8 @@ const se_RecordLifecycleActionHeartbeatType = (
59475950
if (input[_LAT] != null) {
59485951
entries[_LAT] = input[_LAT];
59495952
}
5950-
if (input[_IIn] != null) {
5951-
entries[_IIn] = input[_IIn];
5953+
if (input[_IIns] != null) {
5954+
entries[_IIns] = input[_IIns];
59525955
}
59535956
return entries;
59545957
};
@@ -6148,8 +6151,8 @@ const se_SetDesiredCapacityType = (input: SetDesiredCapacityType, context: __Ser
61486151
*/
61496152
const se_SetInstanceHealthQuery = (input: SetInstanceHealthQuery, context: __SerdeContext): any => {
61506153
const entries: any = {};
6151-
if (input[_IIn] != null) {
6152-
entries[_IIn] = input[_IIn];
6154+
if (input[_IIns] != null) {
6155+
entries[_IIns] = input[_IIns];
61536156
}
61546157
if (input[_HS] != null) {
61556158
entries[_HS] = input[_HS];
@@ -6415,8 +6418,8 @@ const se_TerminateInstanceInAutoScalingGroupType = (
64156418
context: __SerdeContext
64166419
): any => {
64176420
const entries: any = {};
6418-
if (input[_IIn] != null) {
6419-
entries[_IIn] = input[_IIn];
6421+
if (input[_IIns] != null) {
6422+
entries[_IIns] = input[_IIns];
64206423
}
64216424
if (input[_SDDC] != null) {
64226425
entries[_SDDC] = input[_SDDC];
@@ -7093,8 +7096,8 @@ const de_AutoScalingGroupsType = (output: any, context: __SerdeContext): AutoSca
70937096
*/
70947097
const de_AutoScalingInstanceDetails = (output: any, context: __SerdeContext): AutoScalingInstanceDetails => {
70957098
const contents: any = {};
7096-
if (output[_IIn] != null) {
7097-
contents[_IIn] = __expectString(output[_IIn]);
7099+
if (output[_IIns] != null) {
7100+
contents[_IIns] = __expectString(output[_IIns]);
70987101
}
70997102
if (output[_IT] != null) {
71007103
contents[_IT] = __expectString(output[_IT]);
@@ -7912,8 +7915,8 @@ const de_GetPredictiveScalingForecastAnswer = (
79127915
*/
79137916
const de_Instance = (output: any, context: __SerdeContext): Instance => {
79147917
const contents: any = {};
7915-
if (output[_IIn] != null) {
7916-
contents[_IIn] = __expectString(output[_IIn]);
7918+
if (output[_IIns] != null) {
7919+
contents[_IIns] = __expectString(output[_IIns]);
79177920
}
79187921
if (output[_IT] != null) {
79197922
contents[_IT] = __expectString(output[_IT]);
@@ -9962,7 +9965,8 @@ const _IG = "InstanceGenerations";
99629965
const _II = "InstanceIds";
99639966
const _IIP = "IamInstanceProfile";
99649967
const _IIm = "ImageId";
9965-
const _IIn = "InstanceId";
9968+
const _IIn = "IncludeInstances";
9969+
const _IIns = "InstanceId";
99669970
const _IM = "InstanceMonitoring";
99679971
const _IMP = "InstanceMaintenancePolicy";
99689972
const _IR = "InstanceRequirements";

‎codegen/sdk-codegen/aws-models/auto-scaling.json

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -972,6 +972,12 @@
972972
"smithy.api#documentation": "<p>The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can\n optionally increase this limit using the <code>MaxRecords</code> property.</p>\n <p>If you omit this property, all Auto Scaling groups are described.</p>"
973973
}
974974
},
975+
"IncludeInstances": {
976+
"target": "com.amazonaws.autoscaling#IncludeInstances",
977+
"traits": {
978+
"smithy.api#documentation": "<p>\n Specifies whether to include information about Amazon EC2 instances in the response. When set to <code>true</code> (default), the response includes instance details.\n </p>"
979+
}
980+
},
975981
"NextToken": {
976982
"target": "com.amazonaws.autoscaling#XmlString",
977983
"traits": {
@@ -1351,7 +1357,7 @@
13511357
"name": "autoscaling"
13521358
},
13531359
"aws.protocols#awsQuery": {},
1354-
"smithy.api#documentation": "<fullname>Amazon EC2 Auto Scaling</fullname>\n <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances\n based on user-defined scaling policies, scheduled actions, and health checks.</p>\n <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>",
1360+
"smithy.api#documentation": "<fullname>Amazon EC2 Auto Scaling</fullname>\n <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. \n To help prevent throttling, you can set the <code>IncludeInstances</code> parameter to <code>false</code> to exclude instance details from the response.</p>\n <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances\n based on user-defined scaling policies, scheduled actions, and health checks.</p>\n <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>",
13551361
"smithy.api#title": "Auto Scaling",
13561362
"smithy.api#xmlNamespace": {
13571363
"uri": "http://autoscaling.amazonaws.com/doc/2011-01-01/"
@@ -6431,6 +6437,9 @@
64316437
"com.amazonaws.autoscaling#IncludeDeletedGroups": {
64326438
"type": "boolean"
64336439
},
6440+
"com.amazonaws.autoscaling#IncludeInstances": {
6441+
"type": "boolean"
6442+
},
64346443
"com.amazonaws.autoscaling#Instance": {
64356444
"type": "structure",
64366445
"members": {

0 commit comments

Comments
 (0)