Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.
For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.
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:Retrieves the forecast data for a predictive scaling policy.
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.
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.
For more information, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
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: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.
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.
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:Retrieves the forecast data for a predictive scaling policy.
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.
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.
For more information, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
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: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.
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.
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 Metric object that is returned by a call to ListMetrics. Stat: allOf: - $ref: '#/components/schemas/XmlStringMetricStat' - description:The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
The most commonly used metrics for predictive scaling are Average and Sum.
This structure defines the CloudWatch metric to return, along with the statistic, period, and unit.
For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts in the Amazon CloudWatch User Guide.
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 isASGCPUUtilization, 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: 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.
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:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
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: 'AGetPredictiveScalingForecast 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: 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.
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:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
description:Describes a load metric for a predictive scaling policy.
When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.
The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
' 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:Specifies the target utilization.
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.
This structure specifies the metrics and target utilization settings for a predictive scaling policy.
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.
Example
You create a predictive scaling policy and specify ALBRequestCount as the value for the metric pair and 1000.0 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.
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 RequestCount and RequestCountPerTarget metrics, respectively.
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.
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.)
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.
For information about using custom metrics with predictive scaling, see Advanced predictive scaling policy configurations using custom metrics in the Amazon EC2 Auto Scaling User Guide.
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 allMetricDataQuery 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: 'The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions.
Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
Information about the metric data to return.
Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).
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.
For more information and examples, see Advanced predictive scaling policy configurations using custom metrics in the Amazon EC2 Auto Scaling User Guide.
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. Values: allOf: - $ref: '#/components/schemas/PredictiveScalingForecastValues' - description: The values of the data points. description: 'AGetPredictiveScalingForecast call returns the capacity forecast for a predictive scaling policy. This structure includes the data points for that capacity forecast, along with the timestamps of those data points. '
PredictiveScalingPredefinedScalingMetric:
type: object
required:
- PredefinedMetricType
properties:
PredefinedMetricType:
allOf:
- $ref: '#/components/schemas/PredefinedScalingMetricType'
- description: The metric type.
ResourceLabel:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen1023'
- description: 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.
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:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
description:Describes a scaling metric for a predictive scaling policy.
When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.