AWS cli documentation change
Summary
Updated documentation for Auto Scaling group filters and parameters. Added new filter options for DescribeScalingActivities, clarified parameter descriptions, fixed formatting, and updated CLI version references.
Security assessment
Changes are primarily clarifications and additions of new filter options (DescribeScalingActivities). No security vulnerabilities, patches, or security features are mentioned. The instance protection documentation remains unchanged in substance.
Diff
diff --git a/cli/latest/reference/autoscaling/describe-auto-scaling-groups.md b/cli/latest/reference/autoscaling/describe-auto-scaling-groups.md index 816ac0af3..42aeafcfe 100644 --- a//cli/latest/reference/autoscaling/describe-auto-scaling-groups.md +++ b//cli/latest/reference/autoscaling/describe-auto-scaling-groups.md @@ -15 +15 @@ - * [AWS CLI 2.33.2 Command Reference](../../index.html) » + * [AWS CLI 2.33.4 Command Reference](../../index.html) » @@ -146 +146 @@ Syntax: ->>> The valid values for `Name` depend on which API operation you’re using with the filter ([DescribeAutoScalingGroups](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAutoScalingGroups.html) or [DescribeTags](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeTags.html) ). +>>> The valid values for `Name` depend on which API operation you’re using with the filter. @@ -148 +148 @@ Syntax: ->>>> **DescribeAutoScalingGroups** +>>>> ** [DescribeAutoScalingGroups](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAutoScalingGroups.html) ** @@ -158 +158 @@ Syntax: ->>>> **DescribeTags** +>>>> ** [DescribeTags](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeTags.html) ** @@ -167,0 +168,10 @@ Syntax: +>>> +>>>> ** [DescribeScalingActivities](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeScalingActivities.html) ** +>>> +>>> Valid values for `Name` include the following: +>>> +>>> * `StartTimeLowerBound` \- The earliest scaling activities to return based on the activity start time. Scaling activities with a start time earlier than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified. +>>> * `StartTimeUpperBound` \- The latest scaling activities to return based on the activity start time. Scaling activities with a start time later than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified. +>>> * `Status` \- The `StatusCode` value of the scaling activity. This filter can only be used in combination with the `AutoScalingGroupName` parameter. For valid `StatusCode` values, see [Activity](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_Activity.html) in the _Amazon EC2 Auto Scaling API Reference_ . +>>> + @@ -179 +189,5 @@ Syntax: ->>> If you specify multiple values for a filter, the values are automatically logically joined with an `OR` , and the request returns all results that match any of the specified values. For example, specify “[tag:environment](tag:environment)” for the filter name and “production,development” for the filter values to find Auto Scaling groups with the tag “environment=production” or “environment=development”. +>>> If you specify multiple values for a filter, the values are automatically logically joined with an `OR` , and the request returns all results that match any of the specified values. +>>> +>>>> **DescribeAutoScalingGroups example:** Specify “[tag:environment](tag:environment)” for the filter name and “production,development” for the filter values to find Auto Scaling groups with the tag “environment=production” or “environment=development”. +>>>> +>>>> **DescribeScalingActivities example:** Specify “Status” for the filter name and “Successful,Failed” for the filter values to find scaling activities with a status of either “Successful” or “Failed”. @@ -534 +548 @@ AutoScalingGroups -> (list) ->>> The name of the associated launch configuration. +>>> The name of the associated launch configuration for the Auto Scaling group. @@ -546 +560 @@ AutoScalingGroups -> (list) ->>> The launch template for the group. +>>> The launch template for the Auto Scaling group. @@ -1441 +1455 @@ AutoScalingGroups -> (list) ->>> The minimum size of the group. +>>> The minimum size of the Auto Scaling group. @@ -1445 +1459 @@ AutoScalingGroups -> (list) ->>> The maximum size of the group. +>>> The maximum size of the Auto Scaling group. @@ -1449 +1463 @@ AutoScalingGroups -> (list) ->>> The desired size of the group. +>>> The desired size of the Auto Scaling group. @@ -1457 +1471 @@ AutoScalingGroups -> (list) ->>> The duration of the default cooldown period, in seconds. +>>> The duration of the default cooldown period, in seconds, for the Auto Scaling group. @@ -1461 +1475 @@ AutoScalingGroups -> (list) ->>> One or more Availability Zones for the group. +>>> One or more Availability Zones for the Auto Scaling group. @@ -1503 +1517 @@ AutoScalingGroups -> (list) ->>> A comma-separated value string of one or more health check types. +>>> One or more comma-separated health check types for the Auto Scaling group. @@ -1515 +1529 @@ AutoScalingGroups -> (list) ->>> The duration of the health check grace period, in seconds. +>>> The duration of the health check grace period, in seconds, for the Auto Scaling group. @@ -1519 +1533 @@ AutoScalingGroups -> (list) ->>> The EC2 instances associated with the group. +>>> The EC2 instances associated with the Auto Scaling group. @@ -1707 +1721 @@ AutoScalingGroups -> (list) ->>> The date and time the group was created. +>>> The date and time the Auto Scaling group was created. @@ -1711 +1725 @@ AutoScalingGroups -> (list) ->>> The suspended processes associated with the group. +>>> The suspended processes associated with the Auto Scaling group. @@ -1745 +1759 @@ AutoScalingGroups -> (list) ->>> The name of the placement group into which to launch your instances, if any. +>>> The name of the placement group into which to launch EC2 instances for the Auto Scaling group. @@ -1757 +1771 @@ AutoScalingGroups -> (list) ->>> One or more subnet IDs, if applicable, separated by commas. +>>> One or more comma-separated subnet IDs for the Auto Scaling group. @@ -1769 +1783 @@ AutoScalingGroups -> (list) ->>> The metrics enabled for the group. +>>> The metrics enabled for the Auto Scaling group. @@ -1826 +1840 @@ AutoScalingGroups -> (list) ->>> The current state of the group when the [DeleteAutoScalingGroup](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DeleteAutoScalingGroup.html) operation is in progress. +>>> The current state of the Auto Scaling group when the [DeleteAutoScalingGroup](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DeleteAutoScalingGroup.html) operation is in progress. @@ -1838 +1852 @@ AutoScalingGroups -> (list) ->>> The tags for the group. +>>> The tags for the Auto Scaling group. @@ -1894 +1908 @@ AutoScalingGroups -> (list) ->>> The termination policies for the group. +>>> The termination policies for the Auto Scaling group. @@ -1908 +1922,3 @@ AutoScalingGroups -> (list) ->>> Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Use instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the _Amazon EC2 Auto Scaling User Guide_ . +>>> Indicates whether newly launched EC2 instances are protected from termination when scaling in for the Auto Scaling group. +>>> +>>> For more information about preventing instances from terminating on scale in, see [Use instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the _Amazon EC2 Auto Scaling User Guide_ . @@ -1924,3 +1940 @@ AutoScalingGroups -> (list) ->>> The maximum amount of time, in seconds, that an instance can be in service. ->>> ->>> Valid Range: Minimum value of 0. +>>> The maximum amount of time, in seconds, that an EC2 instance can be in service for the Auto Scaling group. @@ -2008 +2022 @@ AutoScalingGroups -> (list) ->>> The duration of the default instance warmup, in seconds. +>>> The duration of the default EC2 instance warmup time, in seconds, for the Auto Scaling group. @@ -2096 +2110 @@ AutoScalingGroups -> (list) ->>> The instance capacity distribution across Availability Zones. +>>> The EC2 instance capacity distribution across Availability Zones for the Auto Scaling group. @@ -2116 +2130 @@ AutoScalingGroups -> (list) ->>> The Availability Zone impairment policy. +>>> The Availability Zone impairment policy for the Auto Scaling group. @@ -2135 +2149 @@ AutoScalingGroups -> (list) ->>> The capacity reservation specification. +>>> The capacity reservation specification for the Auto Scaling group. @@ -2191 +2205 @@ AutoScalingGroups -> (list) ->>> The instance lifecycle policy applied to this Auto Scaling group. This policy determines instance behavior when an instance transitions through its lifecycle states. It provides additional control over graceful instance management processes. +>>> The instance lifecycle policy for the Auto Scaling group. @@ -2195 +2209 @@ AutoScalingGroups -> (list) ->>>> Specifies the conditions that trigger instance retention behavior. These triggers determine when instances should move to a Retained state instead of being terminated. This allows you to maintain control over instance management when lifecycle operations fail. +>>>> Specifies the conditions that trigger instance retention behavior. These triggers determine when instances should move to a `Retained` state instead of automatic termination. This allows you to maintain control over instance management when lifecycles transition and operations fail. @@ -2201 +2215 @@ AutoScalingGroups -> (list) ->>>>> Set to `Retain` to move instances to a `Retained` state. Set to `Terminate` for default termination behavior. +>>>>> Set to `retain` to move instances to a retained state. Set to `terminate` for default termination behavior. @@ -2232 +2246 @@ NextToken -> (string) - * [AWS CLI 2.33.2 Command Reference](../../index.html) » + * [AWS CLI 2.33.4 Command Reference](../../index.html) »