Skip to content

Commit 2598eb2

Browse files
author
awstools
committed
feat(client-auto-scaling): Doc only update for Auto Scaling's TargetTrackingMetricDataQuery
1 parent 50f2aa7 commit 2598eb2

21 files changed

+256
-251
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ AWS SDK for JavaScript AutoScaling Client for Node.js, Browser and React Native.
1010

1111
<p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
1212
based on user-defined scaling policies, scheduled actions, and health checks.</p>
13-
<p>For more information, see the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/">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>
13+
<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>
1414

1515
## Installing
1616

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1457,7 +1457,7 @@ export interface AutoScaling {
14571457
* <fullname>Amazon EC2 Auto Scaling</fullname>
14581458
* <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
14591459
* based on user-defined scaling policies, scheduled actions, and health checks.</p>
1460-
* <p>For more information, see the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/">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>
1460+
* <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>
14611461
* @public
14621462
*/
14631463
export class AutoScaling extends AutoScalingClient implements AutoScaling {}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -582,7 +582,7 @@ export interface AutoScalingClientResolvedConfig extends AutoScalingClientResolv
582582
* <fullname>Amazon EC2 Auto Scaling</fullname>
583583
* <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
584584
* based on user-defined scaling policies, scheduled actions, and health checks.</p>
585-
* <p>For more information, see the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/">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>
585+
* <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>
586586
* @public
587587
*/
588588
export class AutoScalingClient extends __Client<

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ export interface AttachInstancesCommandOutput extends __MetadataBearer {}
3636
* <p>If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are
3737
* also registered with the load balancer. If there are target groups attached to your Auto Scaling
3838
* group, the instances are also registered with the target groups.</p>
39-
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-instance-asg.html">Attach EC2 instances to
40-
* your Auto Scaling group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
39+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-detach-attach-instances.html">Detach
40+
* or attach instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
4141
* @example
4242
* Use a bare-bones client and the command you need to make an API call.
4343
* ```javascript

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ export interface CreateLaunchConfigurationCommandOutput extends __MetadataBearer
3333
* this limit, call the <a>DescribeAccountLimits</a> API. For information about
3434
* updating this limit, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html">Quotas for
3535
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
36-
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html">Launch
37-
* configurations</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
36+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html">Launch
37+
* configurations</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3838
* <note>
3939
* <p>Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a
4040
* launch template or a launch configuration. We strongly recommend that you do not use

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {}
3232
* <p>Deleting either a step scaling policy or a simple scaling policy deletes the
3333
* underlying alarm action, but does not delete the alarm, even if it no longer has an
3434
* associated action.</p>
35-
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/deleting-scaling-policy.html">Deleting a scaling
35+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/deleting-scaling-policy.html">Delete a scaling
3636
* policy</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface DescribeScalingActivitiesCommandOutput extends ActivitiesType,
3030
/**
3131
* <p>Gets information about the scaling activities in the account and Region.</p>
3232
* <p>When scaling events occur, you see a record of the scaling activity in the scaling
33-
* activities. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-verify-scaling-activity.html">Verifying a scaling
33+
* activities. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-verify-scaling-activity.html">Verify a scaling
3434
* activity for an Auto Scaling group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3535
* <p>If the scaling event succeeds, the value of the <code>StatusCode</code> element in the
3636
* response is <code>Successful</code>. If an attempt to launch instances failed, the

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ export interface DescribeTerminationPolicyTypesCommandOutput
3434

3535
/**
3636
* <p>Describes the termination policies supported by Amazon EC2 Auto Scaling.</p>
37-
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html">Work with
38-
* Amazon EC2 Auto Scaling termination policies</a> in the
37+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html">Configure
38+
* termination policies for Amazon EC2 Auto Scaling</a> in the
3939
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
4040
* @example
4141
* Use a bare-bones client and the command you need to make an API call.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ export interface DetachInstancesCommandOutput extends DetachInstancesAnswer, __M
3636
* <p>If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are
3737
* deregistered from the load balancer. If there are target groups attached to the Auto Scaling
3838
* group, the instances are deregistered from the target groups.</p>
39-
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/detach-instance-asg.html">Detach EC2 instances from
40-
* your Auto Scaling group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
39+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-detach-attach-instances.html">Detach
40+
* or attach instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
4141
* @example
4242
* Use a bare-bones client and the command you need to make an API call.
4343
* ```javascript

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ export interface PutNotificationConfigurationCommandOutput extends __MetadataBea
3232
* Subscribers to the specified topic can have messages delivered to an endpoint such as a
3333
* web server or an email address.</p>
3434
* <p>This configuration overwrites any existing configuration.</p>
35-
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html">Getting Amazon SNS
36-
* notifications when your Auto Scaling group scales</a> in the
37-
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
35+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-sns-notifications.html">Amazon SNS
36+
* notification options for Amazon EC2 Auto Scaling</a> in the
37+
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3838
* <p>If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call
3939
* fails.</p>
4040
* @example

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface PutScheduledUpdateGroupActionCommandOutput extends __MetadataBe
3232

3333
/**
3434
* <p>Creates or updates a scheduled scaling action for an Auto Scaling group.</p>
35-
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html">Scheduled scaling</a> in the
35+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html">Scheduled scaling</a> in the
3636
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3737
* <p>You can view the scheduled actions for an Auto Scaling group using the <a>DescribeScheduledActions</a> API call. If you are no longer using a
3838
* scheduled action, you can delete it by calling the <a>DeleteScheduledAction</a> API.</p>

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ export interface PutWarmPoolCommandOutput extends PutWarmPoolAnswer, __MetadataB
3131
* <p>Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of
3232
* pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your
3333
* application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new
34-
* desired capacity. For more information and example configurations, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html">Warm pools for
35-
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
36-
* <p>This operation must be called from the Region in which the Auto Scaling group was created.
37-
* This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a
38-
* launch template or launch configuration that requests Spot Instances.</p>
34+
* desired capacity.</p>
35+
* <p>This operation must be called from the Region in which the Auto Scaling group was
36+
* created.</p>
3937
* <p>You can view the instances in the warm pool using the <a>DescribeWarmPool</a> API call. If you are no longer using a warm pool, you can delete it by calling the
4038
* <a>DeleteWarmPool</a> API.</p>
39+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html">Warm pools for
40+
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
4141
* @example
4242
* Use a bare-bones client and the command you need to make an API call.
4343
* ```javascript

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ export interface ResumeProcessesCommandOutput extends __MetadataBearer {}
3030
/**
3131
* <p>Resumes the specified suspended auto scaling processes, or all suspended process, for
3232
* the specified Auto Scaling group.</p>
33-
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html">Suspending and
34-
* resuming scaling processes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
33+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html">Suspend and resume
34+
* Amazon EC2 Auto Scaling processes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ export interface SetDesiredCapacityCommandOutput extends __MetadataBearer {}
3232
* <p>If a scale-in activity occurs as a result of a new <code>DesiredCapacity</code> value
3333
* that is lower than the current size of the group, the Auto Scaling group uses its termination
3434
* policy to determine which instances to terminate. </p>
35-
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-manual-scaling.html">Manual scaling</a> in the
36-
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
35+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-manually.html">Manual
36+
* scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@ export interface SetInstanceHealthCommandOutput extends __MetadataBearer {}
2929

3030
/**
3131
* <p>Sets the health status of the specified instance.</p>
32-
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html">Health checks for Auto Scaling
33-
* instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
32+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html">Health checks
33+
* for instances in an Auto Scaling group</a> in the
34+
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3435
* @example
3536
* Use a bare-bones client and the command you need to make an API call.
3637
* ```javascript

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ export interface SetInstanceProtectionCommandOutput extends SetInstanceProtectio
3030
/**
3131
* <p>Updates the instance protection settings of the specified instances. This operation
3232
* cannot be called on instances in a warm pool.</p>
33-
* <p>For more information about preventing instances that are part of an Auto Scaling group from
34-
* terminating on scale in, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html">Using
33+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html">Use
3534
* instance scale-in protection</a> in the
3635
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3736
* <p>If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ export interface SuspendProcessesCommandOutput extends __MetadataBearer {}
3232
* Auto Scaling group.</p>
3333
* <p>If you suspend either the <code>Launch</code> or <code>Terminate</code> process types,
3434
* it can prevent other process types from functioning properly. For more information, see
35-
* <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html">Suspending and
36-
* resuming scaling processes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
35+
* <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html">Suspend and resume
36+
* Amazon EC2 Auto Scaling processes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3737
* <p>To resume processes that have been suspended, call the <a>ResumeProcesses</a> API.</p>
3838
* @example
3939
* Use a bare-bones client and the command you need to make an API call.

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ export interface TerminateInstanceInAutoScalingGroupCommandOutput extends Activi
4242
* <p>By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you
4343
* decrement the desired capacity, your Auto Scaling group can become unbalanced between
4444
* Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might
45-
* terminate instances in other zones. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-benefits.html#AutoScalingBehavior.InstanceUsage">Rebalancing activities</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
45+
* terminate instances in other zones. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-manually.html">Manual
46+
* scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
4647
* @example
4748
* Use a bare-bones client and the command you need to make an API call.
4849
* ```javascript

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* <fullname>Amazon EC2 Auto Scaling</fullname>
55
* <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
66
* based on user-defined scaling policies, scheduled actions, and health checks.</p>
7-
* <p>For more information, see the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/">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>
7+
* <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>
88
*
99
* @packageDocumentation
1010
*/

0 commit comments

Comments
 (0)