Table Of ContentAmazon EC2 Auto Scaling
API Reference
API Version 2011-01-01
Amazon EC2 Auto Scaling API Reference
Amazon EC2 Auto Scaling: API Reference
Copyright © 2023 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon's trademarks and trade dress may not be used in connection with any product or service that is not
Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or
discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may
or may not be affiliated with, connected to, or sponsored by Amazon.
Amazon EC2 Auto Scaling API Reference
Table of Contents
Welcome........................................................................................................................................... 1
List of Actions by Function .................................................................................................................. 2
Actions............................................................................................................................................. 5
AttachInstances.......................................................................................................................... 7
Request Parameters............................................................................................................ 7
Errors............................................................................................................................... 7
Examples........................................................................................................................... 8
See Also............................................................................................................................ 8
AttachLoadBalancers.................................................................................................................. 9
Request Parameters............................................................................................................ 9
Errors............................................................................................................................... 9
Examples......................................................................................................................... 10
See Also.......................................................................................................................... 10
AttachLoadBalancerTargetGroups............................................................................................... 11
Request Parameters.......................................................................................................... 11
Errors.............................................................................................................................. 11
Examples......................................................................................................................... 12
See Also.......................................................................................................................... 12
AttachTrafficSources................................................................................................................. 13
Request Parameters.......................................................................................................... 13
Errors.............................................................................................................................. 13
Examples......................................................................................................................... 14
See Also.......................................................................................................................... 14
BatchDeleteScheduledAction...................................................................................................... 15
Request Parameters.......................................................................................................... 15
Response Elements........................................................................................................... 15
Errors.............................................................................................................................. 15
See Also.......................................................................................................................... 15
BatchPutScheduledUpdateGroupAction....................................................................................... 17
Request Parameters.......................................................................................................... 17
Response Elements........................................................................................................... 17
Errors.............................................................................................................................. 17
See Also.......................................................................................................................... 18
CancelInstanceRefresh............................................................................................................... 19
Request Parameters.......................................................................................................... 19
Response Elements........................................................................................................... 19
Errors.............................................................................................................................. 19
Examples......................................................................................................................... 20
See Also.......................................................................................................................... 20
CompleteLifecycleAction........................................................................................................... 21
Request Parameters.......................................................................................................... 21
Errors.............................................................................................................................. 22
Examples......................................................................................................................... 22
See Also.......................................................................................................................... 22
CreateAutoScalingGroup............................................................................................................ 24
Request Parameters.......................................................................................................... 24
Errors.............................................................................................................................. 30
Examples......................................................................................................................... 31
See Also.......................................................................................................................... 31
CreateLaunchConfiguration........................................................................................................ 32
Request Parameters.......................................................................................................... 32
Errors.............................................................................................................................. 36
Examples......................................................................................................................... 37
See Also.......................................................................................................................... 37
API Version 2011-01-01
iii
Amazon EC2 Auto Scaling API Reference
CreateOrUpdateTags................................................................................................................. 38
Request Parameters.......................................................................................................... 38
Errors.............................................................................................................................. 38
Examples......................................................................................................................... 38
See Also.......................................................................................................................... 39
DeleteAutoScalingGroup............................................................................................................ 40
Request Parameters.......................................................................................................... 40
Errors.............................................................................................................................. 40
Examples......................................................................................................................... 41
See Also.......................................................................................................................... 41
DeleteLaunchConfiguration........................................................................................................ 42
Request Parameters.......................................................................................................... 42
Errors.............................................................................................................................. 42
Examples......................................................................................................................... 42
See Also.......................................................................................................................... 43
DeleteLifecycleHook................................................................................................................. 44
Request Parameters.......................................................................................................... 44
Errors.............................................................................................................................. 44
Examples......................................................................................................................... 44
See Also.......................................................................................................................... 45
DeleteNotificationConfiguration................................................................................................. 46
Request Parameters.......................................................................................................... 46
Errors.............................................................................................................................. 46
Examples......................................................................................................................... 46
See Also.......................................................................................................................... 47
DeletePolicy............................................................................................................................. 48
Request Parameters.......................................................................................................... 48
Errors.............................................................................................................................. 48
Examples......................................................................................................................... 48
See Also.......................................................................................................................... 49
DeleteScheduledAction............................................................................................................. 50
Request Parameters.......................................................................................................... 50
Errors.............................................................................................................................. 50
Examples......................................................................................................................... 50
See Also.......................................................................................................................... 51
DeleteTags............................................................................................................................... 52
Request Parameters.......................................................................................................... 52
Errors.............................................................................................................................. 52
Examples......................................................................................................................... 52
See Also.......................................................................................................................... 52
DeleteWarmPool ...................................................................................................................... 54
Request Parameters.......................................................................................................... 54
Errors.............................................................................................................................. 54
Examples......................................................................................................................... 55
See Also.......................................................................................................................... 55
DescribeAccountLimits.............................................................................................................. 56
Response Elements........................................................................................................... 56
Errors.............................................................................................................................. 56
Examples......................................................................................................................... 56
See Also.......................................................................................................................... 57
DescribeAdjustmentTypes.......................................................................................................... 58
Response Elements........................................................................................................... 58
Errors.............................................................................................................................. 58
Examples......................................................................................................................... 58
See Also.......................................................................................................................... 59
DescribeAutoScalingGroups....................................................................................................... 60
Request Parameters.......................................................................................................... 60
API Version 2011-01-01
iv
Amazon EC2 Auto Scaling API Reference
Response Elements........................................................................................................... 60
Errors.............................................................................................................................. 61
Examples......................................................................................................................... 61
See Also.......................................................................................................................... 63
DescribeAutoScalingInstances.................................................................................................... 64
Request Parameters.......................................................................................................... 64
Response Elements........................................................................................................... 64
Errors.............................................................................................................................. 65
Examples......................................................................................................................... 65
See Also.......................................................................................................................... 65
DescribeAutoScalingNotificationTypes......................................................................................... 67
Response Elements........................................................................................................... 67
Errors.............................................................................................................................. 67
Examples......................................................................................................................... 67
See Also.......................................................................................................................... 68
DescribeInstanceRefreshes......................................................................................................... 69
Request Parameters.......................................................................................................... 69
Response Elements........................................................................................................... 70
Errors.............................................................................................................................. 70
Examples......................................................................................................................... 70
See Also.......................................................................................................................... 71
DescribeLaunchConfigurations.................................................................................................... 72
Request Parameters.......................................................................................................... 72
Response Elements........................................................................................................... 72
Errors.............................................................................................................................. 73
Examples......................................................................................................................... 73
See Also.......................................................................................................................... 74
DescribeLifecycleHooks............................................................................................................. 75
Request Parameters.......................................................................................................... 75
Response Elements........................................................................................................... 75
Errors.............................................................................................................................. 75
Examples......................................................................................................................... 76
See Also.......................................................................................................................... 76
DescribeLifecycleHookTypes....................................................................................................... 77
Response Elements........................................................................................................... 77
Errors.............................................................................................................................. 77
Examples......................................................................................................................... 77
See Also.......................................................................................................................... 78
DescribeLoadBalancers.............................................................................................................. 79
Request Parameters.......................................................................................................... 79
Response Elements........................................................................................................... 80
Errors.............................................................................................................................. 80
Examples......................................................................................................................... 80
See Also.......................................................................................................................... 81
DescribeLoadBalancerTargetGroups............................................................................................. 82
Request Parameters.......................................................................................................... 82
Response Elements........................................................................................................... 83
Errors.............................................................................................................................. 83
See Also.......................................................................................................................... 83
DescribeMetricCollectionTypes................................................................................................... 84
Response Elements........................................................................................................... 84
Errors.............................................................................................................................. 84
Examples......................................................................................................................... 84
See Also.......................................................................................................................... 86
DescribeNotificationConfigurations............................................................................................. 87
Request Parameters.......................................................................................................... 87
Response Elements........................................................................................................... 87
API Version 2011-01-01
v
Amazon EC2 Auto Scaling API Reference
Errors.............................................................................................................................. 88
Examples......................................................................................................................... 88
See Also.......................................................................................................................... 88
DescribePolicies........................................................................................................................ 90
Request Parameters.......................................................................................................... 90
Response Elements........................................................................................................... 91
Errors.............................................................................................................................. 91
Examples......................................................................................................................... 91
See Also.......................................................................................................................... 92
DescribeScalingActivities........................................................................................................... 94
Request Parameters.......................................................................................................... 94
Response Elements........................................................................................................... 95
Errors.............................................................................................................................. 95
Examples......................................................................................................................... 95
See Also.......................................................................................................................... 96
DescribeScalingProcessTypes...................................................................................................... 97
Response Elements........................................................................................................... 97
Errors.............................................................................................................................. 97
Examples......................................................................................................................... 97
See Also.......................................................................................................................... 98
DescribeScheduledActions......................................................................................................... 99
Request Parameters.......................................................................................................... 99
Response Elements......................................................................................................... 100
Errors............................................................................................................................ 100
See Also........................................................................................................................ 100
DescribeTags.......................................................................................................................... 102
Request Parameters........................................................................................................ 102
Response Elements......................................................................................................... 102
Errors............................................................................................................................ 103
Examples....................................................................................................................... 103
See Also........................................................................................................................ 103
DescribeTerminationPolicyTypes............................................................................................... 105
Response Elements......................................................................................................... 105
Errors............................................................................................................................ 105
Examples....................................................................................................................... 105
See Also........................................................................................................................ 106
DescribeTrafficSources............................................................................................................. 107
Request Parameters........................................................................................................ 107
Response Elements......................................................................................................... 107
Errors............................................................................................................................ 108
Examples....................................................................................................................... 108
See Also........................................................................................................................ 108
DescribeWarmPool .................................................................................................................. 110
Request Parameters........................................................................................................ 110
Response Elements......................................................................................................... 110
Errors............................................................................................................................ 111
Examples....................................................................................................................... 111
See Also........................................................................................................................ 112
DetachInstances..................................................................................................................... 113
Request Parameters........................................................................................................ 113
Response Elements......................................................................................................... 113
Errors............................................................................................................................ 114
Examples....................................................................................................................... 114
See Also........................................................................................................................ 114
DetachLoadBalancers.............................................................................................................. 116
Request Parameters........................................................................................................ 116
Errors............................................................................................................................ 116
API Version 2011-01-01
vi
Amazon EC2 Auto Scaling API Reference
Examples....................................................................................................................... 116
See Also........................................................................................................................ 117
DetachLoadBalancerTargetGroups............................................................................................. 118
Request Parameters........................................................................................................ 118
Errors............................................................................................................................ 118
See Also........................................................................................................................ 118
DetachTrafficSources............................................................................................................... 120
Request Parameters........................................................................................................ 120
Errors............................................................................................................................ 120
Examples....................................................................................................................... 120
See Also........................................................................................................................ 121
DisableMetricsCollection.......................................................................................................... 122
Request Parameters........................................................................................................ 122
Errors............................................................................................................................ 123
Examples....................................................................................................................... 123
See Also........................................................................................................................ 123
EnableMetricsCollection........................................................................................................... 124
Request Parameters........................................................................................................ 124
Errors............................................................................................................................ 125
Examples....................................................................................................................... 125
See Also........................................................................................................................ 125
EnterStandby......................................................................................................................... 127
Request Parameters........................................................................................................ 127
Response Elements......................................................................................................... 127
Errors............................................................................................................................ 128
Examples....................................................................................................................... 128
See Also........................................................................................................................ 128
ExecutePolicy......................................................................................................................... 130
Request Parameters........................................................................................................ 130
Errors............................................................................................................................ 131
See Also........................................................................................................................ 131
ExitStandby........................................................................................................................... 132
Request Parameters........................................................................................................ 132
Response Elements......................................................................................................... 132
Errors............................................................................................................................ 132
Examples....................................................................................................................... 133
See Also........................................................................................................................ 133
GetPredictiveScalingForecast.................................................................................................... 134
Request Parameters........................................................................................................ 134
Response Elements......................................................................................................... 135
Errors............................................................................................................................ 135
Examples....................................................................................................................... 135
See Also........................................................................................................................ 135
PutLifecycleHook.................................................................................................................... 137
Request Parameters........................................................................................................ 137
Errors............................................................................................................................ 139
Examples....................................................................................................................... 139
See Also........................................................................................................................ 140
PutNotificationConfiguration.................................................................................................... 141
Request Parameters........................................................................................................ 141
Errors............................................................................................................................ 141
Examples....................................................................................................................... 142
See Also........................................................................................................................ 142
PutScalingPolicy..................................................................................................................... 143
Request Parameters........................................................................................................ 143
Response Elements......................................................................................................... 146
Errors............................................................................................................................ 146
API Version 2011-01-01
vii
Amazon EC2 Auto Scaling API Reference
Examples....................................................................................................................... 147
See Also........................................................................................................................ 148
PutScheduledUpdateGroupAction............................................................................................. 149
Request Parameters........................................................................................................ 149
Errors............................................................................................................................ 151
Examples....................................................................................................................... 151
See Also........................................................................................................................ 152
PutWarmPool......................................................................................................................... 153
Request Parameters........................................................................................................ 153
Errors............................................................................................................................ 154
Examples....................................................................................................................... 154
See Also........................................................................................................................ 155
RecordLifecycleActionHeartbeat................................................................................................ 156
Request Parameters........................................................................................................ 156
Errors............................................................................................................................ 157
See Also........................................................................................................................ 157
ResumeProcesses.................................................................................................................... 158
Request Parameters........................................................................................................ 158
Errors............................................................................................................................ 158
Examples....................................................................................................................... 159
See Also........................................................................................................................ 159
SetDesiredCapacity................................................................................................................. 160
Request Parameters........................................................................................................ 160
Errors............................................................................................................................ 160
Examples....................................................................................................................... 161
See Also........................................................................................................................ 161
SetInstanceHealth................................................................................................................... 162
Request Parameters........................................................................................................ 162
Errors............................................................................................................................ 162
Examples....................................................................................................................... 163
See Also........................................................................................................................ 163
SetInstanceProtection............................................................................................................. 164
Request Parameters........................................................................................................ 164
Errors............................................................................................................................ 164
Examples....................................................................................................................... 165
See Also........................................................................................................................ 165
StartInstanceRefresh............................................................................................................... 166
Request Parameters........................................................................................................ 166
Response Elements......................................................................................................... 167
Errors............................................................................................................................ 167
Examples....................................................................................................................... 167
See Also........................................................................................................................ 168
SuspendProcesses................................................................................................................... 169
Request Parameters........................................................................................................ 169
Errors............................................................................................................................ 169
Examples....................................................................................................................... 170
See Also........................................................................................................................ 170
TerminateInstanceInAutoScalingGroup....................................................................................... 171
Request Parameters........................................................................................................ 171
Response Elements......................................................................................................... 171
Errors............................................................................................................................ 171
Examples....................................................................................................................... 172
See Also........................................................................................................................ 172
UpdateAutoScalingGroup......................................................................................................... 174
Request Parameters........................................................................................................ 174
Errors............................................................................................................................ 178
Examples....................................................................................................................... 179
API Version 2011-01-01
viii
Amazon EC2 Auto Scaling API Reference
See Also........................................................................................................................ 179
Data Types.................................................................................................................................... 181
AcceleratorCountRequest......................................................................................................... 183
Contents........................................................................................................................ 183
See Also........................................................................................................................ 183
AcceleratorTotalMemoryMiBRequest......................................................................................... 184
Contents........................................................................................................................ 184
See Also........................................................................................................................ 184
Activity.................................................................................................................................. 185
Contents........................................................................................................................ 185
See Also........................................................................................................................ 187
AdjustmentType..................................................................................................................... 188
Contents........................................................................................................................ 188
See Also........................................................................................................................ 188
Alarm.................................................................................................................................... 189
Contents........................................................................................................................ 189
See Also........................................................................................................................ 189
AutoScalingGroup................................................................................................................... 190
Contents........................................................................................................................ 190
See Also........................................................................................................................ 195
AutoScalingInstanceDetails...................................................................................................... 196
Contents........................................................................................................................ 196
See Also........................................................................................................................ 198
BaselineEbsBandwidthMbpsRequest.......................................................................................... 199
Contents........................................................................................................................ 199
See Also........................................................................................................................ 199
BlockDeviceMapping ............................................................................................................... 200
Contents........................................................................................................................ 200
See Also........................................................................................................................ 200
CapacityForecast..................................................................................................................... 202
Contents........................................................................................................................ 202
See Also........................................................................................................................ 202
CustomizedMetricSpecification................................................................................................. 203
Contents........................................................................................................................ 203
See Also........................................................................................................................ 204
DesiredConfiguration............................................................................................................... 205
Contents........................................................................................................................ 205
See Also........................................................................................................................ 205
Ebs....................................................................................................................................... 206
Contents........................................................................................................................ 206
See Also........................................................................................................................ 207
EnabledMetric........................................................................................................................ 208
Contents........................................................................................................................ 208
See Also........................................................................................................................ 209
FailedScheduledUpdateGroupActionRequest............................................................................... 210
Contents........................................................................................................................ 210
See Also........................................................................................................................ 210
Filter..................................................................................................................................... 211
Contents........................................................................................................................ 211
See Also........................................................................................................................ 212
Instance................................................................................................................................. 213
Contents........................................................................................................................ 213
See Also........................................................................................................................ 214
InstanceMetadataOptions........................................................................................................ 215
Contents........................................................................................................................ 215
See Also........................................................................................................................ 215
InstanceMonitoring................................................................................................................. 217
API Version 2011-01-01
ix
Amazon EC2 Auto Scaling API Reference
Contents........................................................................................................................ 217
See Also........................................................................................................................ 217
InstanceRefresh...................................................................................................................... 218
Contents........................................................................................................................ 218
See Also........................................................................................................................ 220
InstanceRefreshLivePoolProgress.............................................................................................. 221
Contents........................................................................................................................ 221
See Also........................................................................................................................ 221
InstanceRefreshProgressDetails................................................................................................. 222
Contents........................................................................................................................ 222
See Also........................................................................................................................ 222
InstanceRefreshWarmPoolProgress............................................................................................ 223
Contents........................................................................................................................ 223
See Also........................................................................................................................ 223
InstanceRequirements............................................................................................................. 224
Contents........................................................................................................................ 224
See Also........................................................................................................................ 229
InstanceReusePolicy................................................................................................................ 230
Contents........................................................................................................................ 230
See Also........................................................................................................................ 230
InstancesDistribution............................................................................................................... 231
Contents........................................................................................................................ 231
See Also........................................................................................................................ 233
LaunchConfiguration............................................................................................................... 234
Contents........................................................................................................................ 234
See Also........................................................................................................................ 237
LaunchTemplate..................................................................................................................... 239
Contents........................................................................................................................ 239
See Also........................................................................................................................ 239
LaunchTemplateOverrides........................................................................................................ 240
Contents........................................................................................................................ 240
See Also........................................................................................................................ 241
LaunchTemplateSpecification................................................................................................... 242
Contents........................................................................................................................ 242
See Also........................................................................................................................ 242
LifecycleHook......................................................................................................................... 244
Contents........................................................................................................................ 244
See Also........................................................................................................................ 245
LifecycleHookSpecification....................................................................................................... 246
Contents........................................................................................................................ 246
See Also........................................................................................................................ 247
LoadBalancerState.................................................................................................................. 249
Contents........................................................................................................................ 249
See Also........................................................................................................................ 249
LoadBalancerTargetGroupState................................................................................................. 250
Contents........................................................................................................................ 250
See Also........................................................................................................................ 250
LoadForecast.......................................................................................................................... 251
Contents........................................................................................................................ 251
See Also........................................................................................................................ 251
MemoryGiBPerVCpuRequest..................................................................................................... 252
Contents........................................................................................................................ 252
See Also........................................................................................................................ 252
MemoryMiBRequest................................................................................................................ 253
Contents........................................................................................................................ 253
See Also........................................................................................................................ 253
Metric................................................................................................................................... 254
API Version 2011-01-01
x
Description:Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of