Skip to content

Commit

Permalink
feat(client-auto-scaling): Doc only update for Auto Scaling's TargetT…
Browse files Browse the repository at this point in the history
…rackingMetricDataQuery
  • Loading branch information
awstools committed Jun 25, 2024
1 parent 50f2aa7 commit 2598eb2
Show file tree
Hide file tree
Showing 21 changed files with 256 additions and 251 deletions.
2 changes: 1 addition & 1 deletion clients/client-auto-scaling/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ AWS SDK for JavaScript AutoScaling Client for Node.js, Browser and React Native.

<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/">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>
<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>

## Installing

Expand Down
2 changes: 1 addition & 1 deletion clients/client-auto-scaling/src/AutoScaling.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1457,7 +1457,7 @@ export interface AutoScaling {
* <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/">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>
* <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>
* @public
*/
export class AutoScaling extends AutoScalingClient implements AutoScaling {}
Expand Down
2 changes: 1 addition & 1 deletion clients/client-auto-scaling/src/AutoScalingClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -582,7 +582,7 @@ export interface AutoScalingClientResolvedConfig extends AutoScalingClientResolv
* <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/">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>
* <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>
* @public
*/
export class AutoScalingClient extends __Client<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ export interface AttachInstancesCommandOutput extends __MetadataBearer {}
* <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/attach-instance-asg.html">Attach EC2 instances to
* your Auto Scaling group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ export interface CreateLaunchConfigurationCommandOutput extends __MetadataBearer
* this limit, call the <a>DescribeAccountLimits</a> API. For information about
* updating this limit, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html">Quotas for
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html">Launch
* configurations</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html">Launch
* configurations</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* <note>
* <p>Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a
* launch template or a launch configuration. We strongly recommend that you do not use
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {}
* <p>Deleting either a step scaling policy or a simple scaling policy deletes the
* underlying alarm action, but does not delete the alarm, even if it no longer has an
* associated action.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/deleting-scaling-policy.html">Deleting a scaling
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/deleting-scaling-policy.html">Delete a scaling
* policy</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export interface DescribeScalingActivitiesCommandOutput extends ActivitiesType,
/**
* <p>Gets information about the scaling activities in the account and Region.</p>
* <p>When scaling events occur, you see a record of the scaling activity in the scaling
* activities. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-verify-scaling-activity.html">Verifying a scaling
* activities. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-verify-scaling-activity.html">Verify a scaling
* activity for an Auto Scaling group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* <p>If the scaling event succeeds, the value of the <code>StatusCode</code> element in the
* response is <code>Successful</code>. If an attempt to launch instances failed, the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ export interface DescribeTerminationPolicyTypesCommandOutput

/**
* <p>Describes the termination policies supported by Amazon EC2 Auto Scaling.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html">Work with
* Amazon EC2 Auto Scaling termination policies</a> in the
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html">Configure
* termination policies for Amazon EC2 Auto Scaling</a> in the
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ export interface DetachInstancesCommandOutput extends DetachInstancesAnswer, __M
* <p>If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are
* deregistered from the load balancer. If there are target groups attached to the Auto Scaling
* group, the instances are deregistered from the target groups.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/detach-instance-asg.html">Detach EC2 instances from
* your Auto Scaling group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ export interface PutNotificationConfigurationCommandOutput extends __MetadataBea
* Subscribers to the specified topic can have messages delivered to an endpoint such as a
* web server or an email address.</p>
* <p>This configuration overwrites any existing configuration.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html">Getting Amazon SNS
* notifications when your Auto Scaling group scales</a> in the
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-sns-notifications.html">Amazon SNS
* notification options for Amazon EC2 Auto Scaling</a> in the
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* <p>If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call
* fails.</p>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export interface PutScheduledUpdateGroupActionCommandOutput extends __MetadataBe

/**
* <p>Creates or updates a scheduled scaling action for an Auto Scaling group.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html">Scheduled scaling</a> in the
* <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
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* <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
* scheduled action, you can delete it by calling the <a>DeleteScheduledAction</a> API.</p>
Expand Down
10 changes: 5 additions & 5 deletions clients/client-auto-scaling/src/commands/PutWarmPoolCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ export interface PutWarmPoolCommandOutput extends PutWarmPoolAnswer, __MetadataB
* <p>Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of
* pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your
* application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new
* 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
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* <p>This operation must be called from the Region in which the Auto Scaling group was created.
* This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a
* launch template or launch configuration that requests Spot Instances.</p>
* desired capacity.</p>
* <p>This operation must be called from the Region in which the Auto Scaling group was
* created.</p>
* <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
* <a>DeleteWarmPool</a> API.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html">Warm pools for
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ export interface ResumeProcessesCommandOutput extends __MetadataBearer {}
/**
* <p>Resumes the specified suspended auto scaling processes, or all suspended process, for
* the specified Auto Scaling group.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html">Suspending and
* resuming scaling processes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html">Suspend and resume
* Amazon EC2 Auto Scaling processes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ export interface SetDesiredCapacityCommandOutput extends __MetadataBearer {}
* <p>If a scale-in activity occurs as a result of a new <code>DesiredCapacity</code> value
* that is lower than the current size of the group, the Auto Scaling group uses its termination
* policy to determine which instances to terminate. </p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-manual-scaling.html">Manual scaling</a> in the
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-manually.html">Manual
* scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,9 @@ export interface SetInstanceHealthCommandOutput extends __MetadataBearer {}

/**
* <p>Sets the health status of the specified instance.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html">Health checks for Auto Scaling
* instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html">Health checks
* for instances in an Auto Scaling group</a> in the
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ export interface SetInstanceProtectionCommandOutput extends SetInstanceProtectio
/**
* <p>Updates the instance protection settings of the specified instances. This operation
* cannot be called on instances in a warm pool.</p>
* <p>For more information about preventing instances that are part of an Auto Scaling group from
* terminating on scale in, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html">Using
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html">Use
* instance scale-in protection</a> in the
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* <p>If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ export interface SuspendProcessesCommandOutput extends __MetadataBearer {}
* Auto Scaling group.</p>
* <p>If you suspend either the <code>Launch</code> or <code>Terminate</code> process types,
* it can prevent other process types from functioning properly. For more information, see
* <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html">Suspending and
* resuming scaling processes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html">Suspend and resume
* Amazon EC2 Auto Scaling processes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* <p>To resume processes that have been suspended, call the <a>ResumeProcesses</a> API.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ export interface TerminateInstanceInAutoScalingGroupCommandOutput extends Activi
* <p>By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you
* decrement the desired capacity, your Auto Scaling group can become unbalanced between
* Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might
* 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>
* 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
* scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
2 changes: 1 addition & 1 deletion clients/client-auto-scaling/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* <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/">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>
* <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>
*
* @packageDocumentation
*/
Expand Down
Loading

0 comments on commit 2598eb2

Please sign in to comment.