1{
2  "version": "2.0",
3  "service": "<fullname>AWS Auto Scaling</fullname> <p>Use AWS Auto Scaling to quickly discover all the scalable AWS resources for your application and configure dynamic scaling for your scalable resources.</p> <p>To get started, create a scaling plan with a set of instructions used to configure dynamic scaling for the scalable resources in your application. AWS Auto Scaling creates target tracking scaling policies for the scalable resources in your scaling plan. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.</p>",
4  "operations": {
5    "CreateScalingPlan": "<p>Creates a scaling plan.</p> <p>A scaling plan contains a set of instructions used to configure dynamic scaling for the scalable resources in your application. AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions in your scaling plan.</p>",
6    "DeleteScalingPlan": "<p>Deletes the specified scaling plan.</p>",
7    "DescribeScalingPlanResources": "<p>Describes the scalable resources in the specified scaling plan.</p>",
8    "DescribeScalingPlans": "<p>Describes the specified scaling plans or all of your scaling plans.</p>",
9    "UpdateScalingPlan": "<p>Updates the scaling plan for the specified scaling plan.</p> <p>You cannot update a scaling plan if it is in the process of being created, updated, or deleted.</p>"
10  },
11  "shapes": {
12    "ApplicationSource": {
13      "base": "<p>Represents an application source.</p>",
14      "refs": {
15        "ApplicationSources$member": null,
16        "CreateScalingPlanRequest$ApplicationSource": "<p>A CloudFormation stack or set of tags. You can create one scaling plan per application source.</p>",
17        "ScalingPlan$ApplicationSource": "<p>The application source.</p>",
18        "UpdateScalingPlanRequest$ApplicationSource": "<p>A CloudFormation stack or set of tags.</p>"
19      }
20    },
21    "ApplicationSources": {
22      "base": null,
23      "refs": {
24        "DescribeScalingPlansRequest$ApplicationSources": "<p>The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.</p>"
25      }
26    },
27    "ConcurrentUpdateException": {
28      "base": "<p>Concurrent updates caused an exception, for example, if you request an update to a scaling plan that already has a pending update.</p>",
29      "refs": {
30      }
31    },
32    "Cooldown": {
33      "base": null,
34      "refs": {
35        "TargetTrackingConfiguration$ScaleOutCooldown": "<p>The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. This value is not used if the scalable resource is an Auto Scaling group.</p> <p>While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.</p>",
36        "TargetTrackingConfiguration$ScaleInCooldown": "<p>The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.</p> <p>The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, AWS Auto Scaling scales out your scalable target immediately.</p>",
37        "TargetTrackingConfiguration$EstimatedInstanceWarmup": "<p>The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.</p>"
38      }
39    },
40    "CreateScalingPlanRequest": {
41      "base": null,
42      "refs": {
43      }
44    },
45    "CreateScalingPlanResponse": {
46      "base": null,
47      "refs": {
48      }
49    },
50    "CustomizedScalingMetricSpecification": {
51      "base": "<p>Represents a customized metric for a target tracking policy.</p>",
52      "refs": {
53        "TargetTrackingConfiguration$CustomizedScalingMetricSpecification": "<p>A customized metric.</p>"
54      }
55    },
56    "DeleteScalingPlanRequest": {
57      "base": null,
58      "refs": {
59      }
60    },
61    "DeleteScalingPlanResponse": {
62      "base": null,
63      "refs": {
64      }
65    },
66    "DescribeScalingPlanResourcesRequest": {
67      "base": null,
68      "refs": {
69      }
70    },
71    "DescribeScalingPlanResourcesResponse": {
72      "base": null,
73      "refs": {
74      }
75    },
76    "DescribeScalingPlansRequest": {
77      "base": null,
78      "refs": {
79      }
80    },
81    "DescribeScalingPlansResponse": {
82      "base": null,
83      "refs": {
84      }
85    },
86    "DisableScaleIn": {
87      "base": null,
88      "refs": {
89        "TargetTrackingConfiguration$DisableScaleIn": "<p>Indicates whether scale in by the target tracking policy is disabled. If the value is <code>true</code>, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is <code>false</code>.</p>"
90      }
91    },
92    "ErrorMessage": {
93      "base": null,
94      "refs": {
95        "ConcurrentUpdateException$Message": null,
96        "InternalServiceException$Message": null,
97        "InvalidNextTokenException$Message": null,
98        "LimitExceededException$Message": null,
99        "ObjectNotFoundException$Message": null,
100        "ValidationException$Message": null
101      }
102    },
103    "InternalServiceException": {
104      "base": "<p>The service encountered an internal error.</p>",
105      "refs": {
106      }
107    },
108    "InvalidNextTokenException": {
109      "base": "<p>The token provided is not valid.</p>",
110      "refs": {
111      }
112    },
113    "LimitExceededException": {
114      "base": "<p>Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded.</p>",
115      "refs": {
116      }
117    },
118    "MaxResults": {
119      "base": null,
120      "refs": {
121        "DescribeScalingPlanResourcesRequest$MaxResults": "<p>The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.</p>",
122        "DescribeScalingPlansRequest$MaxResults": "<p>The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.</p>"
123      }
124    },
125    "MetricDimension": {
126      "base": "<p>Represents a dimension for a customized metric.</p>",
127      "refs": {
128        "MetricDimensions$member": null
129      }
130    },
131    "MetricDimensionName": {
132      "base": null,
133      "refs": {
134        "MetricDimension$Name": "<p>The name of the dimension.</p>"
135      }
136    },
137    "MetricDimensionValue": {
138      "base": null,
139      "refs": {
140        "MetricDimension$Value": "<p>The value of the dimension.</p>"
141      }
142    },
143    "MetricDimensions": {
144      "base": null,
145      "refs": {
146        "CustomizedScalingMetricSpecification$Dimensions": "<p>The dimensions of the metric.</p>"
147      }
148    },
149    "MetricName": {
150      "base": null,
151      "refs": {
152        "CustomizedScalingMetricSpecification$MetricName": "<p>The name of the metric.</p>"
153      }
154    },
155    "MetricNamespace": {
156      "base": null,
157      "refs": {
158        "CustomizedScalingMetricSpecification$Namespace": "<p>The namespace of the metric.</p>"
159      }
160    },
161    "MetricScale": {
162      "base": null,
163      "refs": {
164        "TargetTrackingConfiguration$TargetValue": "<p>The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).</p>"
165      }
166    },
167    "MetricStatistic": {
168      "base": null,
169      "refs": {
170        "CustomizedScalingMetricSpecification$Statistic": "<p>The statistic of the metric.</p>"
171      }
172    },
173    "MetricUnit": {
174      "base": null,
175      "refs": {
176        "CustomizedScalingMetricSpecification$Unit": "<p>The unit of the metric.</p>"
177      }
178    },
179    "NextToken": {
180      "base": null,
181      "refs": {
182        "DescribeScalingPlanResourcesRequest$NextToken": "<p>The token for the next set of results.</p>",
183        "DescribeScalingPlanResourcesResponse$NextToken": "<p>The token required to get the next set of results. This value is <code>null</code> if there are no more results to return.</p>",
184        "DescribeScalingPlansRequest$NextToken": "<p>The token for the next set of results.</p>",
185        "DescribeScalingPlansResponse$NextToken": "<p>The token required to get the next set of results. This value is <code>null</code> if there are no more results to return.</p>"
186      }
187    },
188    "ObjectNotFoundException": {
189      "base": "<p>The specified object could not be found.</p>",
190      "refs": {
191      }
192    },
193    "PolicyName": {
194      "base": null,
195      "refs": {
196        "ScalingPolicy$PolicyName": "<p>The name of the scaling policy.</p>"
197      }
198    },
199    "PolicyType": {
200      "base": null,
201      "refs": {
202        "ScalingPolicy$PolicyType": "<p>The type of scaling policy.</p>"
203      }
204    },
205    "PredefinedScalingMetricSpecification": {
206      "base": "<p>Represents a predefined metric for a target tracking policy.</p>",
207      "refs": {
208        "TargetTrackingConfiguration$PredefinedScalingMetricSpecification": "<p>A predefined metric.</p>"
209      }
210    },
211    "ResourceCapacity": {
212      "base": null,
213      "refs": {
214        "ScalingInstruction$MinCapacity": "<p>The minimum value to scale to in response to a scale in event.</p>",
215        "ScalingInstruction$MaxCapacity": "<p>The maximum value to scale to in response to a scale out event.</p>"
216      }
217    },
218    "ResourceIdMaxLen1600": {
219      "base": null,
220      "refs": {
221        "ScalingInstruction$ResourceId": "<p>The ID of the resource. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>Auto Scaling group - The resource type is <code>autoScalingGroup</code> and the unique identifier is the name of the Auto Scaling group. Example: <code>autoScalingGroup/my-asg</code>.</p> </li> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
222        "ScalingPlanResource$ResourceId": "<p>The ID of the resource. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>Auto Scaling group - The resource type is <code>autoScalingGroup</code> and the unique identifier is the name of the Auto Scaling group. Example: <code>autoScalingGroup/my-asg</code>.</p> </li> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>"
223      }
224    },
225    "ResourceLabel": {
226      "base": null,
227      "refs": {
228        "PredefinedScalingMetricSpecification$ResourceLabel": "<p>Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is <code>ALBRequestCountPerTarget</code> and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.</p> <p>The format is app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt;/targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt;, where:</p> <ul> <li> <p>app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt; is the final portion of the load balancer ARN</p> </li> <li> <p>targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt; is the final portion of the target group ARN.</p> </li> </ul>"
229      }
230    },
231    "ScalableDimension": {
232      "base": null,
233      "refs": {
234        "ScalingInstruction$ScalableDimension": "<p>The scalable dimension associated with the resource.</p> <ul> <li> <p> <code>autoscaling:autoScalingGroup:DesiredCapacity</code> - The desired capacity of an Auto Scaling group.</p> </li> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>",
235        "ScalingPlanResource$ScalableDimension": "<p>The scalable dimension for the resource.</p> <ul> <li> <p> <code>autoscaling:autoScalingGroup:DesiredCapacity</code> - The desired capacity of an Auto Scaling group.</p> </li> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>"
236      }
237    },
238    "ScalingInstruction": {
239      "base": "<p>Specifies the scaling configuration for a scalable resource.</p>",
240      "refs": {
241        "ScalingInstructions$member": null
242      }
243    },
244    "ScalingInstructions": {
245      "base": null,
246      "refs": {
247        "CreateScalingPlanRequest$ScalingInstructions": "<p>The scaling instructions.</p>",
248        "ScalingPlan$ScalingInstructions": "<p>The scaling instructions.</p>",
249        "UpdateScalingPlanRequest$ScalingInstructions": "<p>The scaling instructions.</p>"
250      }
251    },
252    "ScalingMetricType": {
253      "base": null,
254      "refs": {
255        "PredefinedScalingMetricSpecification$PredefinedScalingMetricType": "<p>The metric type. The <code>ALBRequestCountPerTarget</code> metric type applies only to Auto Scaling groups, Sport Fleet requests, and ECS services.</p>"
256      }
257    },
258    "ScalingPlan": {
259      "base": "<p>Represents a scaling plan.</p>",
260      "refs": {
261        "ScalingPlans$member": null
262      }
263    },
264    "ScalingPlanName": {
265      "base": null,
266      "refs": {
267        "CreateScalingPlanRequest$ScalingPlanName": "<p>The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.</p>",
268        "DeleteScalingPlanRequest$ScalingPlanName": "<p>The name of the scaling plan.</p>",
269        "DescribeScalingPlanResourcesRequest$ScalingPlanName": "<p>The name of the scaling plan.</p>",
270        "ScalingPlan$ScalingPlanName": "<p>The name of the scaling plan.</p>",
271        "ScalingPlanNames$member": null,
272        "ScalingPlanResource$ScalingPlanName": "<p>The name of the scaling plan.</p>",
273        "UpdateScalingPlanRequest$ScalingPlanName": "<p>The name of the scaling plan.</p>"
274      }
275    },
276    "ScalingPlanNames": {
277      "base": null,
278      "refs": {
279        "DescribeScalingPlansRequest$ScalingPlanNames": "<p>The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.</p>"
280      }
281    },
282    "ScalingPlanResource": {
283      "base": "<p>Represents a scalable resource.</p>",
284      "refs": {
285        "ScalingPlanResources$member": null
286      }
287    },
288    "ScalingPlanResources": {
289      "base": null,
290      "refs": {
291        "DescribeScalingPlanResourcesResponse$ScalingPlanResources": "<p>Information about the scalable resources.</p>"
292      }
293    },
294    "ScalingPlanStatusCode": {
295      "base": null,
296      "refs": {
297        "ScalingPlan$StatusCode": "<p>The status of the scaling plan.</p> <ul> <li> <p> <code>Active</code> - The scaling plan is active.</p> </li> <li> <p> <code>ActiveWithProblems</code> - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.</p> </li> <li> <p> <code>CreationInProgress</code> - The scaling plan is being created.</p> </li> <li> <p> <code>CreationFailed</code> - The scaling plan could not be created.</p> </li> <li> <p> <code>DeletionInProgress</code> - The scaling plan is being deleted.</p> </li> <li> <p> <code>DeletionFailed</code> - The scaling plan could not be deleted.</p> </li> </ul>"
298      }
299    },
300    "ScalingPlanVersion": {
301      "base": null,
302      "refs": {
303        "CreateScalingPlanResponse$ScalingPlanVersion": "<p>The version of the scaling plan. This value is always 1.</p>",
304        "DeleteScalingPlanRequest$ScalingPlanVersion": "<p>The version of the scaling plan.</p>",
305        "DescribeScalingPlanResourcesRequest$ScalingPlanVersion": "<p>The version of the scaling plan.</p>",
306        "DescribeScalingPlansRequest$ScalingPlanVersion": "<p>The version of the scaling plan. If you specify a scaling plan version, you must also specify a scaling plan name.</p>",
307        "ScalingPlan$ScalingPlanVersion": "<p>The version of the scaling plan.</p>",
308        "ScalingPlanResource$ScalingPlanVersion": "<p>The version of the scaling plan.</p>",
309        "UpdateScalingPlanRequest$ScalingPlanVersion": "<p>The version number.</p>"
310      }
311    },
312    "ScalingPlans": {
313      "base": null,
314      "refs": {
315        "DescribeScalingPlansResponse$ScalingPlans": "<p>Information about the scaling plans.</p>"
316      }
317    },
318    "ScalingPolicies": {
319      "base": null,
320      "refs": {
321        "ScalingPlanResource$ScalingPolicies": "<p>The scaling policies.</p>"
322      }
323    },
324    "ScalingPolicy": {
325      "base": "<p>Represents a scaling policy.</p>",
326      "refs": {
327        "ScalingPolicies$member": null
328      }
329    },
330    "ScalingStatusCode": {
331      "base": null,
332      "refs": {
333        "ScalingPlanResource$ScalingStatusCode": "<p>The scaling status of the resource.</p> <ul> <li> <p> <code>Active</code> - The scaling configuration is active.</p> </li> <li> <p> <code>Inactive</code> - The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information.</p> </li> <li> <p> <code>PartiallyActive</code> - The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.</p> </li> </ul>"
334      }
335    },
336    "ServiceNamespace": {
337      "base": null,
338      "refs": {
339        "ScalingInstruction$ServiceNamespace": "<p>The namespace of the AWS service.</p>",
340        "ScalingPlanResource$ServiceNamespace": "<p>The namespace of the AWS service.</p>"
341      }
342    },
343    "TagFilter": {
344      "base": "<p>Represents a tag.</p>",
345      "refs": {
346        "TagFilters$member": null
347      }
348    },
349    "TagFilters": {
350      "base": null,
351      "refs": {
352        "ApplicationSource$TagFilters": "<p>A set of tags (up to 50).</p>"
353      }
354    },
355    "TagValues": {
356      "base": null,
357      "refs": {
358        "TagFilter$Values": "<p>The tag values (0 to 20).</p>"
359      }
360    },
361    "TargetTrackingConfiguration": {
362      "base": "<p>Represents a target tracking scaling policy.</p>",
363      "refs": {
364        "ScalingPolicy$TargetTrackingConfiguration": "<p>The target tracking scaling policy.</p>",
365        "TargetTrackingConfigurations$member": null
366      }
367    },
368    "TargetTrackingConfigurations": {
369      "base": null,
370      "refs": {
371        "ScalingInstruction$TargetTrackingConfigurations": "<p>The target tracking scaling policies (up to 10).</p>"
372      }
373    },
374    "TimestampType": {
375      "base": null,
376      "refs": {
377        "ScalingPlan$StatusStartTime": "<p>The Unix timestamp when the scaling plan entered the current status.</p>",
378        "ScalingPlan$CreationTime": "<p>The Unix timestamp when the scaling plan was created.</p>"
379      }
380    },
381    "UpdateScalingPlanRequest": {
382      "base": null,
383      "refs": {
384      }
385    },
386    "UpdateScalingPlanResponse": {
387      "base": null,
388      "refs": {
389      }
390    },
391    "ValidationException": {
392      "base": "<p>An exception was thrown for a validation issue. Review the parameters provided.</p>",
393      "refs": {
394      }
395    },
396    "XmlString": {
397      "base": null,
398      "refs": {
399        "ApplicationSource$CloudFormationStackARN": "<p>The Amazon Resource Name (ARN) of a CloudFormation stack.</p>",
400        "ScalingPlan$StatusMessage": "<p>A simple message about the current status of the scaling plan.</p>",
401        "ScalingPlanResource$ScalingStatusMessage": "<p>A simple message about the current scaling status of the resource.</p>"
402      }
403    },
404    "XmlStringMaxLen128": {
405      "base": null,
406      "refs": {
407        "TagFilter$Key": "<p>The tag key.</p>"
408      }
409    },
410    "XmlStringMaxLen256": {
411      "base": null,
412      "refs": {
413        "TagValues$member": null
414      }
415    }
416  }
417}
418