openapi: 3.0.0
info:
version: 2011-01-01
x-release: v4
title: 'Auto Scaling #Action=AttachInstances #Action=AttachInstances #Action=GetPredictiveScalingForecast 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=GetPredictiveScalingForecast'
paths:
/#Action=GetPredictiveScalingForecast:
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: GetPredictiveScalingForecast
operationId: GET_GetPredictiveScalingForecast
description: <p>Retrieves the forecast data for a predictive scaling policy.</p> <p>Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast.</p> <p>A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html">Predictive scaling for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetPredictiveScalingForecastAnswer'
examples:
GET_GetPredictiveScalingForecast200Example:
summary: Default GET_GetPredictiveScalingForecast 200 response
x-microcks-default: true
value:
LoadForecast: example-string
CapacityForecast: example-string
UpdateTime: example-string
'480':
description: ResourceContentionFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ResourceContentionFault'
examples:
GET_GetPredictiveScalingForecast480Example:
summary: Default GET_GetPredictiveScalingForecast 480 response
x-microcks-default: true
value: {}
parameters:
- name: AutoScalingGroupName
in: query
required: true
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: PolicyName
in: query
required: true
description: The name of the policy.
schema:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
- name: StartTime
in: query
required: true
description: The inclusive start time of the time range for the forecast data to get. At most, the date and time can be one year before the current date and time.
schema:
type: string
format: date-time
- name: EndTime
in: query
required: true
description: <p>The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is 30 days. </p> <p>Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for periods of two days in advance.</p>
schema:
type: string
format: date-time
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetPredictiveScalingForecast
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Get Predictive Scaling Forecast
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=GetPredictiveScalingForecast'
post:
x-aws-operation-name: GetPredictiveScalingForecast
operationId: POST_GetPredictiveScalingForecast
description: <p>Retrieves the forecast data for a predictive scaling policy.</p> <p>Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast.</p> <p>A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html">Predictive scaling for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetPredictiveScalingForecastAnswer'
examples:
POST_GetPredictiveScalingForecast200Example:
summary: Default POST_GetPredictiveScalingForecast 200 response
x-microcks-default: true
value:
LoadForecast: example-string
CapacityForecast: example-string
UpdateTime: example-string
'480':
description: ResourceContentionFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ResourceContentionFault'
examples:
POST_GetPredictiveScalingForecast480Example:
summary: Default POST_GetPredictiveScalingForecast 480 response
x-microcks-default: true
value: {}
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetPredictiveScalingForecastType'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetPredictiveScalingForecast
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling POST_ Get Predictive Scaling Forecast
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=GetPredictiveScalingForecast'
components:
schemas:
GetPredictiveScalingForecastType:
type: object
required:
- AutoScalingGroupName
- PolicyName
- StartTime
- EndTime
title: GetPredictiveScalingForecastType
properties:
AutoScalingGroupName:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The name of the Auto Scaling group.
PolicyName:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The name of the policy.
StartTime:
allOf:
- $ref: '#/components/schemas/TimestampType'
- description: The inclusive start time of the time range for the forecast data to get. At most, the date and time can be one year before the current date and time.
EndTime:
allOf:
- $ref: '#/components/schemas/TimestampType'
- description: <p>The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is 30 days. </p> <p>Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for periods of two days in advance.</p>
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>
MetricDataQueries:
type: array
items:
$ref: '#/components/schemas/MetricDataQuery'
PredefinedScalingMetricType:
type: string
enum:
- ASGAverageCPUUtilization
- ASGAverageNetworkIn
- ASGAverageNetworkOut
- ALBRequestCountPerTarget
LoadForecasts:
type: array
items:
$ref: '#/components/schemas/LoadForecast'
MetricName:
type: string
MetricDimensions:
type: array
items:
$ref: '#/components/schemas/MetricDimension'
MetricNamespace:
type: string
MetricDimensionName:
type: string
ResourceContentionFault: {}
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. '
XmlStringMetricStat:
type: string
minLength: 1
maxLength: 100
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
LoadForecast:
type: object
required:
- Timestamps
- Values
- MetricSpecification
properties:
Timestamps:
allOf:
- $ref: '#/components/schemas/PredictiveScalingForecastTimestamps'
- description: The timestamps for the data points, in UTC format.
Values:
allOf:
- $ref: '#/components/schemas/PredictiveScalingForecastValues'
- description: The values of the data points.
MetricSpecification:
allOf:
- $ref: '#/components/schemas/PredictiveScalingMetricSpecification'
- description: The metric specification for the load forecast.
description: 'A <code>GetPredictiveScalingForecast</code> call returns the load forecast for a predictive scaling policy. This structure includes the data points for that load forecast, along with the timestamps of those data points and the metric specification. '
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.
PredictiveScalingForecastValues:
type: array
items:
$ref: '#/components/schemas/MetricScale'
PredictiveScalingForecastTimestamps:
type: array
items:
$ref: '#/components/schemas/TimestampType'
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
TimestampType:
type: string
format: date-time
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.
MetricUnit:
type: string
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. '
ReturnData:
type: boolean
XmlStringMaxLen255:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
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>
GetPredictiveScalingForecastAnswer:
type: object
required:
- LoadForecast
- CapacityForecast
- UpdateTime
properties:
LoadForecast:
allOf:
- $ref: '#/components/schemas/LoadForecasts'
- description: The load forecast.
CapacityForecast:
allOf:
- $ref: '#/components/schemas/CapacityForecast'
- description: The capacity forecast.
UpdateTime:
allOf:
- $ref: '#/components/schemas/TimestampType'
- description: The time the forecast was made.
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.
XmlStringMetricLabel:
type: string
maxLength: 2047
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
MetricScale:
type: number
format: double
MetricDataQuery:
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>MetricDataQuery</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/XmlStringMaxLen1023'
- 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>MetricDataQuery</code> object, you must specify either <code>Expression</code> or <code>MetricStat</code>, but not both.</p>'
MetricStat:
allOf:
- $ref: '#/components/schemas/MetricStat'
- description: '<p>Information about the metric data to return.</p> <p>Conditional: Within each <code>MetricDataQuery</code> object, you must specify either <code>Expression</code> or <code>MetricStat</code>, but not both.</p>'
Label:
allOf:
- $ref: '#/components/schemas/XmlStringMetricLabel'
- description: A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
ReturnData:
allOf:
- $ref: '#/components/schemas/ReturnData'
- description: <p>Indicates whether to return the timestamps and raw data values of this metric. </p> <p>If you use any math expressions, specify <code>true</code> for this value for only the final math expression that the metric specification is based on. You must specify <code>false</code> for <code>ReturnData</code> for all the other metrics and expressions used in the metric specification.</p> <p>If you are only retrieving metrics and not performing any math expressions, do not specify anything for <code>ReturnData</code>. This sets it to its default (<code>true</code>).</p>
description: <p>The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.</p> <p>For more information and examples, 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>
PredefinedMetricPairType:
type: string
enum:
- ASGCPUUtilization
- ASGNetworkIn
- ASGNetworkOut
- ALBRequestCount
CapacityForecast:
type: object
required:
- Timestamps
- Values
properties:
Timestamps:
allOf:
- $ref: '#/components/schemas/PredictiveScalingForecastTimestamps'
- description: The timestamps for the data points, in UTC format.
# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-ec2-auto-scaling/refs/heads/main/openapi/amazon-ec2-auto-scaling-action-getpredictivescalingforecast-api-openapi.yml