openapi: 3.0.0
info:
version: 2011-01-01
x-release: v4
title: 'Auto Scaling #Action=AttachInstances #Action=AttachInstances #Action=DescribePolicies 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
version: 1.0.0
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:
XmlString:
type: string
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
MetricStat:
type: object
required:
- Metric
- Stat
properties:
Metric:
allOf:
- $ref: '#/components/schemas/Metric'
- description: The CloudWatch metric to return, including the metric name, namespace, and dimensions. 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>.
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 metrics for predictive scaling are <code>Average</code> and <code>Sum</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, period, and unit.</p> <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> in the <i>Amazon CloudWatch User Guide</i>.</p>
TargetTrackingConfiguration:
type: object
required:
- TargetValue
properties:
PredefinedMetricSpecification:
allOf:
- $ref: '#/components/schemas/PredefinedMetricSpecification'
- description: A predefined metric. You must specify either a predefined metric or a customized metric.
CustomizedMetricSpecification:
allOf:
- $ref: '#/components/schemas/CustomizedMetricSpecification'
- description: A customized metric. You must specify either a predefined metric or a customized metric.
TargetValue:
allOf:
- $ref: '#/components/schemas/MetricScale'
- description: <p>The target value for the metric.</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>
DisableScaleIn:
allOf:
- $ref: '#/components/schemas/DisableScaleIn'
- description: Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is <code>false</code>.
description: Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.
MetricDataQueries:
type: array
items:
$ref: '#/components/schemas/MetricDataQuery'
PolicyNames:
type: array
items:
$ref: '#/components/schemas/ResourceName'
PolicyIncrement:
type: integer
PredefinedScalingMetricType:
type: string
enum:
- ASGAverageCPUUtilization
- ASGAverageNetworkIn
- ASGAverageNetworkOut
- ALBRequestCountPerTarget
MetricName:
type: string
MetricDimensions:
type: array
items:
$ref: '#/components/schemas/MetricDimension'
PredictiveScalingMaxCapacityBuffer:
type: integer
minimum: 0
maximum: 100
PredefinedMetricSpecification:
type: object
required:
- PredefinedMetricType
properties:
PredefinedMetricType:
allOf:
- $ref: '#/components/schemas/MetricType'
- description: <p>The metric type. The following predefined metrics are available:</p> <ul> <li> <p> <code>ASGAverageCPUUtilization</code> - Average CPU utilization of the Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> - Average number of bytes received on all network interfaces by the Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - Average number of bytes sent out on all network interfaces by the Auto Scaling group.</p> </li> <li> <p> <code>ALBRequestCountPerTarget</code> - Average Application Load Balancer request count per target for your Auto Scaling group.</p> </li> </ul>
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: Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.
MetricNamespace:
type: string
MetricDimensionName:
type: string
MinAdjustmentStep:
type: integer
deprecated: true
ResourceContentionFault: {}
XmlStringMaxLen64:
type: string
minLength: 1
maxLength: 64
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
EstimatedInstanceWarmup:
type: integer
XmlStringMaxLen1023:
type: string
minLength: 1
maxLength: 1023
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
PredictiveScalingPredefinedMetricPair:
type: object
required:
- PredefinedMetricType
properties:
PredefinedMetricType:
allOf:
- $ref: '#/components/schemas/PredefinedMetricPairType'
- description: 'Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric. For example, if the metric type is <code>ASGCPUUtilization</code>, the Auto Scaling group''s total CPU metric is used as the load metric, and the average CPU metric is used for the scaling metric.'
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 total and 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: 'Represents a metric pair for a predictive scaling policy. '
XmlStringMaxLen32:
type: string
minLength: 1
maxLength: 32
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
XmlStringMetricStat:
type: string
minLength: 1
maxLength: 100
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
StepAdjustments:
type: array
items:
$ref: '#/components/schemas/StepAdjustment'
PredictiveScalingCustomizedCapacityMetric:
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 capacity metric. Use multiple metric data queries only if you are performing a math expression on returned data. '
description: Describes a customized capacity metric for a predictive scaling policy.
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.
PredefinedLoadMetricType:
type: string
enum:
- ASGTotalCPUUtilization
- ASGTotalNetworkIn
- ASGTotalNetworkOut
- ALBTargetGroupRequestCount
MinAdjustmentMagnitude:
type: integer
MetricDimensionValue:
type: string
PredictiveScalingPredefinedLoadMetric:
type: object
required:
- PredefinedMetricType
properties:
PredefinedMetricType:
allOf:
- $ref: '#/components/schemas/PredefinedLoadMetricType'
- 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 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 load 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>
PredictiveScalingCustomizedLoadMetric:
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 load metric. Use multiple metric data queries only if you are performing a math expression on returned data. '
description: Describes a custom load metric for a predictive scaling policy.
Alarms:
type: array
items:
$ref: '#/components/schemas/Alarm'
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>
MaxRecords:
type: integer
MetricUnit:
type: string
Alarm:
type: object
properties:
AlarmName:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The name of the alarm.
AlarmARN:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The Amazon Resource Name (ARN) of the alarm.
description: Describes an alarm.
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://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html">Amazon CloudWatch concepts</a> in the <i>Amazon CloudWatch User Guide</i>.</p>
PredictiveScalingSchedulingBufferTime:
type: integer
minimum: 0
MetricType:
type: string
enum:
- ASGAverageCPUUtilization
- ASGAverageNetworkIn
- ASGAverageNetworkOut
- ALBRequestCountPerTarget
Metric:
type: object
required:
- Namespace
- MetricName
properties:
Namespace:
allOf:
- $ref: '#/components/schemas/MetricNamespace'
- description: The namespace of the metric. For more information, see the table in <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>.
MetricName:
allOf:
- $ref: '#/components/schemas/MetricName'
- description: The name of the metric.
Dimensions:
allOf:
- $ref: '#/components/schemas/MetricDimensions'
- description: '<p>The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in <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> <p>Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.</p>'
description: 'Represents a specific metric. '
Cooldown:
type: integer
PredictiveScalingMetricSpecifications:
type: array
items:
$ref: '#/components/schemas/PredictiveScalingMetricSpecification'
TargetTrackingMetricDataQuery:
type: object
required:
- Id
properties:
Id:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: 'A short name that identifies the object''s results in the response. This name must be unique among all <code>TargetTrackingMetricDataQuery</code> objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter. '
Expression:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen2047'
- description: '<p>The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the <code>Id</code> of the other metrics to refer to those metrics, and can also use the <code>Id</code> of other expressions to use the result of those expressions. </p> <p>Conditional: Within each <code>TargetTrackingMetricDataQuery</code> object, you must specify either <code>Expression</code> or <code>MetricStat</code>, but not both.</p>'
MetricStat:
allOf:
- $ref: '#/components/schemas/TargetTrackingMetricStat'
- description: '<p>Information about the metric data to return.</p> <p>Conditional: Within each <code>TargetTrackingMetricDataQuery</code
# --- 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