feat(client-auto-scaling): Add IncludeInstances parameter to DescribeAutoScalingGroups API

Author: awstools

clients/client-auto-scaling/README.md

@@ -8,6 +8,8 @@ AWS SDK for JavaScript AutoScaling Client for Node.js, Browser and React Native.
 
 <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>

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

@@ -1455,6 +1455,8 @@ export interface AutoScaling {
 
 /**
  * <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>

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

@@ -599,6 +599,8 @@ export interface AutoScalingClientResolvedConfig extends AutoScalingClientResolv
 
 /**
  * <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>

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

@@ -46,6 +46,7 @@ export interface DescribeAutoScalingGroupsCommandOutput extends AutoScalingGroup
  *   AutoScalingGroupNames: [ // AutoScalingGroupNames
  *     "STRING_VALUE",
  *   ],
+ *   IncludeInstances: true || false,
  *   NextToken: "STRING_VALUE",
  *   MaxRecords: Number("int"),
  *   Filters: [ // Filters

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

@@ -2,6 +2,8 @@
 /* eslint-disable */
 /**
  * <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>

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

@@ -3204,6 +3204,14 @@ export interface AutoScalingGroupNamesType {
    */
   AutoScalingGroupNames?: string[] | undefined;
 
+  /**
+   * <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>
+   * @public
+   */
+  IncludeInstances?: boolean | undefined;
+
   /**
    * <p>The token for the next set of items to return. (You received this token from a
    *             previous call.)</p>

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

@@ -3223,6 +3223,9 @@ const se_AutoScalingGroupNamesType = (input: AutoScalingGroupNamesType, context:
       entries[loc] = value;
     });
   }
+  if (input[_IIn] != null) {
+    entries[_IIn] = input[_IIn];
+  }
   if (input[_NT] != null) {
     entries[_NT] = input[_NT];
   }
@@ -3557,8 +3560,8 @@ const se_CompleteLifecycleActionType = (input: CompleteLifecycleActionType, cont
   if (input[_LAR] != null) {
     entries[_LAR] = input[_LAR];
   }
-  if (input[_IIn] != null) {
-    entries[_IIn] = input[_IIn];
+  if (input[_IIns] != null) {
+    entries[_IIns] = input[_IIns];
   }
   return entries;
 };
@@ -3622,8 +3625,8 @@ const se_CreateAutoScalingGroupType = (input: CreateAutoScalingGroupType, contex
       entries[loc] = value;
     });
   }
-  if (input[_IIn] != null) {
-    entries[_IIn] = input[_IIn];
+  if (input[_IIns] != null) {
+    entries[_IIns] = input[_IIns];
   }
   if (input[_MS] != null) {
     entries[_MS] = input[_MS];
@@ -3814,8 +3817,8 @@ const se_CreateLaunchConfigurationType = (input: CreateLaunchConfigurationType,
   if (input[_UD] != null) {
     entries[_UD] = input[_UD];
   }
-  if (input[_IIn] != null) {
-    entries[_IIn] = input[_IIn];
+  if (input[_IIns] != null) {
+    entries[_IIns] = input[_IIns];
   }
   if (input[_IT] != null) {
     entries[_IT] = input[_IT];
@@ -5947,8 +5950,8 @@ const se_RecordLifecycleActionHeartbeatType = (
   if (input[_LAT] != null) {
     entries[_LAT] = input[_LAT];
   }
-  if (input[_IIn] != null) {
-    entries[_IIn] = input[_IIn];
+  if (input[_IIns] != null) {
+    entries[_IIns] = input[_IIns];
   }
   return entries;
 };
@@ -6148,8 +6151,8 @@ const se_SetDesiredCapacityType = (input: SetDesiredCapacityType, context: __Ser
  */
 const se_SetInstanceHealthQuery = (input: SetInstanceHealthQuery, context: __SerdeContext): any => {
   const entries: any = {};
-  if (input[_IIn] != null) {
-    entries[_IIn] = input[_IIn];
+  if (input[_IIns] != null) {
+    entries[_IIns] = input[_IIns];
   }
   if (input[_HS] != null) {
     entries[_HS] = input[_HS];
@@ -6415,8 +6418,8 @@ const se_TerminateInstanceInAutoScalingGroupType = (
   context: __SerdeContext
 ): any => {
   const entries: any = {};
-  if (input[_IIn] != null) {
-    entries[_IIn] = input[_IIn];
+  if (input[_IIns] != null) {
+    entries[_IIns] = input[_IIns];
   }
   if (input[_SDDC] != null) {
     entries[_SDDC] = input[_SDDC];
@@ -7093,8 +7096,8 @@ const de_AutoScalingGroupsType = (output: any, context: __SerdeContext): AutoSca
  */
 const de_AutoScalingInstanceDetails = (output: any, context: __SerdeContext): AutoScalingInstanceDetails => {
   const contents: any = {};
-  if (output[_IIn] != null) {
-    contents[_IIn] = __expectString(output[_IIn]);
+  if (output[_IIns] != null) {
+    contents[_IIns] = __expectString(output[_IIns]);
   }
   if (output[_IT] != null) {
     contents[_IT] = __expectString(output[_IT]);
@@ -7912,8 +7915,8 @@ const de_GetPredictiveScalingForecastAnswer = (
  */
 const de_Instance = (output: any, context: __SerdeContext): Instance => {
   const contents: any = {};
-  if (output[_IIn] != null) {
-    contents[_IIn] = __expectString(output[_IIn]);
+  if (output[_IIns] != null) {
+    contents[_IIns] = __expectString(output[_IIns]);
   }
   if (output[_IT] != null) {
     contents[_IT] = __expectString(output[_IT]);
@@ -9962,7 +9965,8 @@ const _IG = "InstanceGenerations";
 const _II = "InstanceIds";
 const _IIP = "IamInstanceProfile";
 const _IIm = "ImageId";
-const _IIn = "InstanceId";
+const _IIn = "IncludeInstances";
+const _IIns = "InstanceId";
 const _IM = "InstanceMonitoring";
 const _IMP = "InstanceMaintenancePolicy";
 const _IR = "InstanceRequirements";

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

@@ -972,6 +972,12 @@
             "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>"
           }
         },
+        "IncludeInstances": {
+          "target": "com.amazonaws.autoscaling#IncludeInstances",
+          "traits": {
+            "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>"
+          }
+        },
         "NextToken": {
           "target": "com.amazonaws.autoscaling#XmlString",
           "traits": {
@@ -1351,7 +1357,7 @@
           "name": "autoscaling"
         },
         "aws.protocols#awsQuery": {},
-        "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>",
+        "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>",
         "smithy.api#title": "Auto Scaling",
         "smithy.api#xmlNamespace": {
           "uri": "http://autoscaling.amazonaws.com/doc/2011-01-01/"
@@ -6431,6 +6437,9 @@
     "com.amazonaws.autoscaling#IncludeDeletedGroups": {
       "type": "boolean"
     },
+    "com.amazonaws.autoscaling#IncludeInstances": {
+      "type": "boolean"
+    },
     "com.amazonaws.autoscaling#Instance": {
       "type": "structure",
       "members": {