Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
version: 1.0.0
x-release: v4
title: 'Auto Scaling #Action=AttachInstances #Action=AttachInstances #Action=DescribePolicies #Action=Describe Policies #Action=Describe Policies API'
description: <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>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: autoscaling
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/autoscaling-2011-01-01.normal.json
converter:
url: https://github.com/mermade/aws2openapi
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://autoscaling.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Auto Scaling multi-region endpoint
- url: https://autoscaling.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Auto Scaling multi-region endpoint
- url: http://autoscaling.amazonaws.com
variables: {}
description: The general Auto Scaling endpoint for US East (N. Virginia)
- url: https://autoscaling.amazonaws.com
variables: {}
description: The general Auto Scaling endpoint for US East (N. Virginia)
- url: http://autoscaling.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Auto Scaling endpoint for China (Beijing) and China (Ningxia)
- url: https://autoscaling.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Auto Scaling endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#Action=DescribePolicies'
paths:
/#Action=DescribePolicies:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
x-aws-operation-name: DescribePolicies
operationId: GET_DescribePolicies
description: Gets information about the scaling policies in the account and Region.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/PoliciesType'
examples:
GET_DescribePolicies200Example:
summary: Default GET_DescribePolicies 200 response
x-microcks-default: true
value:
ScalingPolicies: example-string
NextToken: example-string
'480':
description: InvalidNextToken
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidNextToken'
examples:
GET_DescribePolicies480Example:
summary: Default GET_DescribePolicies 480 response
x-microcks-default: true
value: {}
'481':
description: ResourceContentionFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ResourceContentionFault'
examples:
GET_DescribePolicies481Example:
summary: Default GET_DescribePolicies 481 response
x-microcks-default: true
value: {}
'482':
description: ServiceLinkedRoleFailure
content:
text/xml:
schema:
$ref: '#/components/schemas/ServiceLinkedRoleFailure'
parameters:
- name: AutoScalingGroupName
in: query
required: false
description: The name of the Auto Scaling group.
schema:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
- name: PolicyNames
in: query
required: false
description: '<p>The names of one or more policies. If you omit this property, all policies are described. If a group name is provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no error.</p> <p>Array Members: Maximum number of 50 items.</p>'
schema:
type: array
items:
$ref: '#/components/schemas/ResourceName'
- name: PolicyTypes
in: query
required: false
description: One or more policy types. The valid values are <code>SimpleScaling</code>, <code>StepScaling</code>, <code>TargetTrackingScaling</code>, and <code>PredictiveScaling</code>.
schema:
type: array
items:
$ref: '#/components/schemas/XmlStringMaxLen64'
- name: NextToken
in: query
required: false
description: The token for the next set of items to return. (You received this token from a previous call.)
schema:
type: string
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
- name: MaxRecords
in: query
required: false
description: The maximum number of items to be returned with each call. The default value is <code>50</code> and the maximum value is <code>100</code>.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribePolicies
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Policies
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=DescribePolicies'
post:
x-aws-operation-name: DescribePolicies
operationId: POST_DescribePolicies
description: Gets information about the scaling policies in the account and Region.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/PoliciesType'
examples:
POST_DescribePolicies200Example:
summary: Default POST_DescribePolicies 200 response
x-microcks-default: true
value:
ScalingPolicies: example-string
NextToken: example-string
'480':
description: InvalidNextToken
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidNextToken'
examples:
POST_DescribePolicies480Example:
summary: Default POST_DescribePolicies 480 response
x-microcks-default: true
value: {}
'481':
description: ResourceContentionFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ResourceContentionFault'
examples:
POST_DescribePolicies481Example:
summary: Default POST_DescribePolicies 481 response
x-microcks-default: true
value: {}
'482':
description: ServiceLinkedRoleFailure
content:
text/xml:
schema:
$ref: '#/components/schemas/ServiceLinkedRoleFailure'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribePoliciesType'
parameters:
- name: MaxRecords
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribePolicies
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling POST_ Describe Policies
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=DescribePolicies'
components:
schemas:
PredictiveScalingMetricSpecification:
type: object
required:
- TargetValue
properties:
TargetValue:
allOf:
- $ref: '#/components/schemas/MetricScale'
- description: <p>Specifies the target utilization.</p> <note> <p>Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval. </p> </note>
PredefinedMetricPairSpecification:
allOf:
- $ref: '#/components/schemas/PredictiveScalingPredefinedMetricPair'
- description: The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
PredefinedScalingMetricSpecification:
allOf:
- $ref: '#/components/schemas/PredictiveScalingPredefinedScalingMetric'
- description: The predefined scaling metric specification.
PredefinedLoadMetricSpecification:
allOf:
- $ref: '#/components/schemas/PredictiveScalingPredefinedLoadMetric'
- description: The predefined load metric specification.
CustomizedScalingMetricSpecification:
allOf:
- $ref: '#/components/schemas/PredictiveScalingCustomizedScalingMetric'
- description: The customized scaling metric specification.
CustomizedLoadMetricSpecification:
allOf:
- $ref: '#/components/schemas/PredictiveScalingCustomizedLoadMetric'
- description: The customized load metric specification.
CustomizedCapacityMetricSpecification:
allOf:
- $ref: '#/components/schemas/PredictiveScalingCustomizedCapacityMetric'
- description: The customized capacity metric specification.
description: <p>This structure specifies the metrics and target utilization settings for a predictive scaling policy. </p> <p>You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.</p> <p>Example</p> <ul> <li> <p>You create a predictive scaling policy and specify <code>ALBRequestCount</code> as the value for the metric pair and <code>1000.0</code> as the target value. For this type of metric, you must provide the metric dimension for the corresponding target group, so you also provide a resource label for the Application Load Balancer target group that is attached to your Auto Scaling group.</p> </li> <li> <p>The number of requests the target group receives per minute provides the load metric, and the request count averaged between the members of the target group provides the scaling metric. In CloudWatch, this refers to the <code>RequestCount</code> and <code>RequestCountPerTarget</code> metrics, respectively.</p> </li> <li> <p>For optimal use of predictive scaling, you adhere to the best practice of using a dynamic scaling policy to automatically scale between the minimum capacity and maximum capacity in response to real-time changes in resource utilization.</p> </li> <li> <p>Amazon EC2 Auto Scaling consumes data points for the load metric over the last 14 days and creates an hourly load forecast for predictive scaling. (A minimum of 24 hours of data is required.)</p> </li> <li> <p>After creating the load forecast, Amazon EC2 Auto Scaling determines when to reduce or increase the capacity of your Auto Scaling group in each hour of the forecast period so that the average number of requests received by each instance is as close to 1000 requests per minute as possible at all times.</p> </li> </ul> <p>For information about using custom metrics with predictive scaling, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/predictive-scaling-customized-metric-specification.html">Advanced predictive scaling policy configurations using custom metrics</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
MetricDimensions:
type: array
items:
$ref: '#/components/schemas/MetricDimension'
MetricUnit:
type: string
CustomizedMetricSpecification:
type: object
properties:
MetricName:
allOf:
- $ref: '#/components/schemas/MetricName'
- description: The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html">Metric</a> object that is returned by a call to <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html">ListMetrics</a>.
Namespace:
allOf:
- $ref: '#/components/schemas/MetricNamespace'
- description: The namespace of the metric.
Dimensions:
allOf:
- $ref: '#/components/schemas/MetricDimensions'
- description: '<p>The dimensions of the metric.</p> <p>Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.</p>'
Statistic:
allOf:
- $ref: '#/components/schemas/MetricStatistic'
- description: The statistic of the metric.
Unit:
allOf:
- $ref: '#/components/schemas/MetricUnit'
- description: The unit of the metric. For a complete list of the units that CloudWatch supports, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">MetricDatum</a> data type in the <i>Amazon CloudWatch API Reference</i>.
Metrics:
allOf:
- $ref: '#/components/schemas/TargetTrackingMetricDataQueries'
- description: The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.
description: <p>Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.</p> <p>To create your customized metric specification:</p> <ul> <li> <p>Add values for each required property from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html">Publish custom metrics</a> in the <i>Amazon CloudWatch User Guide</i>.</p> </li> <li> <p>Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.</p> </li> </ul> <p>For more information about the CloudWatch terminology below, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html">Amazon CloudWatch concepts</a>.</p> <note> <p>Each individual service provides information about the metrics, namespace, and dimensions they use. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html">Amazon Web Services services that publish CloudWatch metrics</a> in the <i>Amazon CloudWatch User Guide</i>.</p> </note>
MetricDimension:
type: object
required:
- Name
- Value
properties:
Name:
allOf:
- $ref: '#/components/schemas/MetricDimensionName'
- description: The name of the dimension.
Value:
allOf:
- $ref: '#/components/schemas/MetricDimensionValue'
- description: The value of the dimension.
description: Describes the dimension of a metric.
PredefinedMetricPairType:
type: string
enum:
- ASGCPUUtilization
- ASGNetworkIn
- ASGNetworkOut
- ALBRequestCount
XmlStringMaxLen32:
type: string
minLength: 1
maxLength: 32
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
PredictiveScalingPredefinedScalingMetric:
type: object
required:
- PredefinedMetricType
properties:
PredefinedMetricType:
allOf:
- $ref: '#/components/schemas/PredefinedScalingMetricType'
- description: The metric type.
ResourceLabel:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen1023'
- description: <p>A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.</p> <p>You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:</p> <p> <code>app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff</code>.</p> <p>Where:</p> <ul> <li> <p>app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN</p> </li> <li> <p>targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.</p> </li> </ul> <p>To find the ARN for an Application Load Balancer, use the <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html">DescribeLoadBalancers</a> API operation. To find the ARN for the target group, use the <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html">DescribeTargetGroups</a> API operation.</p>
description: <p>Describes a scaling metric for a predictive scaling policy.</p> <p>When returned in the output of <code>DescribePolicies</code>, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.</p>
TargetTrackingMetricDataQueries:
type: array
items:
$ref: '#/components/schemas/TargetTrackingMetricDataQuery'
PredictiveScalingConfiguration:
type: object
required:
- MetricSpecifications
properties:
MetricSpecifications:
allOf:
- $ref: '#/components/schemas/PredictiveScalingMetricSpecifications'
- description: <p>This structure includes the metrics and target utilization to use for predictive scaling. </p> <p>This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.</p>
Mode:
allOf:
- $ref: '#/components/schemas/PredictiveScalingMode'
- description: The predictive scaling mode. Defaults to <code>ForecastOnly</code> if not specified.
SchedulingBufferTime:
allOf:
- $ref: '#/components/schemas/PredictiveScalingSchedulingBufferTime'
- description: <p>The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete. </p> <p>The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. </p>
MaxCapacityBreachBehavior:
allOf:
- $ref: '#/components/schemas/PredictiveScalingMaxCapacityBreachBehavior'
- description: <p>Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to <code>HonorMaxCapacity</code> if not specified.</p> <p>The following are possible values:</p> <ul> <li> <p> <code>HonorMaxCapacity</code> - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit. </p> </li> <li> <p> <code>IncreaseMaxCapacity</code> - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for <code>MaxCapacityBuffer</code>.</p> </li> </ul>
MaxCapacityBuffer:
allOf:
- $ref: '#/components/schemas/PredictiveScalingMaxCapacityBuffer'
- description: <p>The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.</p> <p>If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity. </p> <p>Required if the <code>MaxCapacityBreachBehavior</code> property is set to <code>IncreaseMaxCapacity</code>, and cannot be used otherwise.</p>
description: Represents a predictive scaling policy configuration to use with Amazon EC2 Auto Scaling.
XmlStringMetricLabel:
type: string
maxLength: 2047
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
XmlStringMaxLen255:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
PredictiveScalingCustomizedScalingMetric:
type: object
required:
- MetricDataQueries
properties:
MetricDataQueries:
allOf:
- $ref: '#/components/schemas/MetricDataQueries'
- description: 'One or more metric data queries to provide the data points for a scaling metric. Use multiple metric data queries only if you are performing a math expression on returned data. '
description: Describes a custom scaling metric for a predictive scaling policy.
MetricDimensionValue:
type: string
MetricNamespace:
type: string
XmlString:
type: string
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
ResourceContentionFault: {}
PolicyTypes:
type: array
items:
$ref: '#/components/schemas/XmlStringMaxLen64'
DescribePoliciesType:
type: object
title: DescribePoliciesType
properties:
AutoScalingGroupName:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The name of the Auto Scaling group.
PolicyNames:
allOf:
- $ref: '#/components/schemas/PolicyNames'
- description: '<p>The names of one or more policies. If you omit this property, all policies are described. If a group name is provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no error.</p> <p>Array Members: Maximum number of 50 items.</p>'
PolicyTypes:
allOf:
- $ref: '#/components/schemas/PolicyTypes'
- description: One or more policy types. The valid values are <code>SimpleScaling</code>, <code>StepScaling</code>, <code>TargetTrackingScaling</code>, and <code>PredictiveScaling</code>.
NextToken:
allOf:
- $ref: '#/components/schemas/XmlString'
- description: The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords:
allOf:
- $ref: '#/components/schemas/MaxRecords'
- description: The maximum number of items to be returned with each call. The default value is <code>50</code> and the maximum value is <code>100</code>.
PredictiveScalingMetricSpecifications:
type: array
items:
$ref: '#/components/schemas/PredictiveScalingMetricSpecification'
PredictiveScalingSchedulingBufferTime:
type: integer
minimum: 0
StepAdjustment:
type: object
required:
- ScalingAdjustment
properties:
MetricIntervalLowerBound:
allOf:
- $ref: '#/components/schemas/MetricScale'
- description: The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
MetricIntervalUpperBound:
allOf:
- $ref: '#/components/schemas/MetricScale'
- description: <p>The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.</p> <p>The upper bound must be greater than the lower bound.</p>
ScalingAdjustment:
allOf:
- $ref: '#/components/schemas/PolicyIncrement'
- description: <p>The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.</p> <p>The amount by which to scale. The adjustment is based on the value that you specified in the <code>AdjustmentType</code> property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity. </p>
description: <p>Describes information used to create a step adjustment for a step scaling policy.</p> <p>For the following examples, suppose that you have an alarm with a breach threshold of 50:</p> <ul> <li> <p>To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.</p> </li> <li> <p>To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.</p> </li> </ul> <p>There are a few rules for the step adjustments for your step policy:</p> <ul> <li> <p>The ranges of your step adjustments can't overlap or have a gap.</p> </li> <li> <p>At most, one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.</p> </li> <li> <p>At most, one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.</p> </li> <li> <p>The upper and lower bound can't be null in the same step adjustment.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-steps">Step adjustments</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
MetricStatistic:
type: string
enum:
- Average
- Minimum
- Maximum
- SampleCount
- Sum
ScalingPolicyEnabled:
type: boolean
DisableScaleIn:
type: boolean
PredictiveScalingMaxCapacityBuffer:
type: integer
minimum: 0
maximum: 100
PredefinedLoadMetricType:
type: string
enum:
- ASGTotalCPUUtilization
- ASGTotalNetworkIn
- ASGTotalNetworkOut
- ALBTargetGroupRequestCount
MetricName:
type: string
ResourceName:
type: string
minLength: 1
maxLength: 1600
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
TargetTrackingMetricStat:
type: object
required:
- Metric
- Stat
properties:
Metric:
allOf:
- $ref: '#/components/schemas/Metric'
- description: The metric to use.
Stat:
allOf:
- $ref: '#/components/schemas/XmlStringMetricStat'
- description: <p>The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic">Statistics</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>The most commonly used metric for scaling is <code>Average</code>.</p>
Unit:
allOf:
- $ref: '#/components/schemas/MetricUnit'
- description: The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">MetricDatum</a> data type in the <i>Amazon CloudWatch API Reference</i>.
description: <p>This structure defines the CloudWatch metric to return, along with the statistic and unit.</p> <p>For more information about the CloudWatch terminology below, see <a href="https://
# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-ec2-auto-scaling/refs/heads/main/openapi/amazon-ec2-auto-scaling-action-describepolicies-api-openapi.yml