Skip to content

Commit c3de9d4

Browse files
author
awstools
committed
docs(client-ec2): With this release, Amazon EC2 Auto Scaling groups, EC2 Fleet, and Spot Fleet improve the default price protection behavior of attribute-based instance type selection of Spot Instances, to consistently select from a wide range of instance types.
1 parent a1a1f67 commit c3de9d4

15 files changed

+118
-48
lines changed

clients/client-ec2/src/commands/DescribeCapacityBlockOfferingsCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface DescribeCapacityBlockOfferingsCommandOutput
3333

3434
/**
3535
* @public
36-
* <p>Describes Capacity Block offerings available for purchase. With Capacity Blocks, you purchase a specific instance type for a period of time.</p>
36+
* <p>Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you purchase a specific instance type for a period of time.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript

clients/client-ec2/src/commands/DescribeFleetInstancesCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,13 @@ export interface DescribeFleetInstancesCommandOutput extends DescribeFleetInstan
2929
/**
3030
* @public
3131
* <p>Describes the running instances for the specified EC2 Fleet.</p>
32-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet">Monitor your EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p>
32+
* <note>
33+
* <p>Currently, <code>DescribeFleetInstances</code> does not support fleets of type
34+
* <code>instant</code>. Instead, use <code>DescribeFleets</code>, specifying the
35+
* <code>instant</code> fleet ID in the request.</p>
36+
* </note>
37+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet">Describe your
38+
* EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p>
3339
* @example
3440
* Use a bare-bones client and the command you need to make an API call.
3541
* ```javascript

clients/client-ec2/src/commands/DescribeFleetsCommand.ts

+7-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,13 @@ export interface DescribeFleetsCommandOutput extends DescribeFleetsResult, __Met
2828

2929
/**
3030
* @public
31-
* <p>Describes the specified EC2 Fleets or all of your EC2 Fleets.</p>
32-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet">Monitor your EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p>
31+
* <p>Describes the specified EC2 Fleet or all of your EC2 Fleets.</p>
32+
* <important>
33+
* <p>If a fleet is of type <code>instant</code>, you must specify the fleet ID in the
34+
* request, otherwise the fleet does not appear in the response.</p>
35+
* </important>
36+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet">Describe your
37+
* EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p>
3338
* @example
3439
* Use a bare-bones client and the command you need to make an API call.
3540
* ```javascript

clients/client-ec2/src/commands/DescribeInstanceStatusCommand.ts

+5
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,11 @@ export interface DescribeInstanceStatusCommandOutput extends DescribeInstanceSta
5757
* lifecycle</a> in the <i>Amazon EC2 User Guide</i>.</p>
5858
* </li>
5959
* </ul>
60+
* <note>
61+
* <p>The order of the elements in the response, including those within nested
62+
* structures, might vary. Applications should not assume the elements appear in a
63+
* particular order.</p>
64+
* </note>
6065
* @example
6166
* Use a bare-bones client and the command you need to make an API call.
6267
* ```javascript

clients/client-ec2/src/commands/DescribeInstancesCommand.ts

+5
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,11 @@ export interface DescribeInstancesCommandOutput extends DescribeInstancesResult,
4444
* not specify any instance IDs at all, the call fails. If you describe instances and
4545
* specify only instance IDs that are in an unaffected zone, the call works
4646
* normally.</p>
47+
* <note>
48+
* <p>The order of the elements in the response, including those within nested
49+
* structures, might vary. Applications should not assume the elements appear in a
50+
* particular order.</p>
51+
* </note>
4752
* @example
4853
* Use a bare-bones client and the command you need to make an API call.
4954
* ```javascript

clients/client-ec2/src/commands/DescribeReservedInstancesCommand.ts

+5
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@ export interface DescribeReservedInstancesCommandOutput extends DescribeReserved
3131
* <p>Describes one or more of the Reserved Instances that you purchased.</p>
3232
* <p>For more information about Reserved Instances, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved
3333
* Instances</a> in the <i>Amazon EC2 User Guide</i>.</p>
34+
* <note>
35+
* <p>The order of the elements in the response, including those within nested
36+
* structures, might vary. Applications should not assume the elements appear in a
37+
* particular order.</p>
38+
* </note>
3439
* @example
3540
* Use a bare-bones client and the command you need to make an API call.
3641
* ```javascript

clients/client-ec2/src/commands/DescribeReservedInstancesListingsCommand.ts

+5
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@ export interface DescribeReservedInstancesListingsCommandOutput
3939
* <p>As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.</p>
4040
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a>
4141
* in the <i>Amazon EC2 User Guide</i>.</p>
42+
* <note>
43+
* <p>The order of the elements in the response, including those within nested
44+
* structures, might vary. Applications should not assume the elements appear in a
45+
* particular order.</p>
46+
* </note>
4247
* @example
4348
* Use a bare-bones client and the command you need to make an API call.
4449
* ```javascript

clients/client-ec2/src/commands/DescribeReservedInstancesModificationsCommand.ts

+5
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@ export interface DescribeReservedInstancesModificationsCommandOutput
3939
* @public
4040
* <p>Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.</p>
4141
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the <i>Amazon EC2 User Guide</i>.</p>
42+
* <note>
43+
* <p>The order of the elements in the response, including those within nested
44+
* structures, might vary. Applications should not assume the elements appear in a
45+
* particular order.</p>
46+
* </note>
4247
* @example
4348
* Use a bare-bones client and the command you need to make an API call.
4449
* ```javascript

clients/client-ec2/src/commands/DescribeReservedInstancesOfferingsCommand.ts

+5
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ export interface DescribeReservedInstancesOfferingsCommandOutput
4040
* <p>If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.</p>
4141
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a>
4242
* in the <i>Amazon EC2 User Guide</i>.</p>
43+
* <note>
44+
* <p>The order of the elements in the response, including those within nested
45+
* structures, might vary. Applications should not assume the elements appear in a
46+
* particular order.</p>
47+
* </note>
4348
* @example
4449
* Use a bare-bones client and the command you need to make an API call.
4550
* ```javascript

clients/client-ec2/src/commands/ModifyInstancePlacementCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export interface ModifyInstancePlacementCommandOutput extends ModifyInstancePlac
3535
* <p>Modify the affinity between an instance and a <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html">Dedicated
3636
* Host</a>. When affinity is set to <code>host</code> and the instance is
3737
* not associated with a specific Dedicated Host, the next time the instance is
38-
* launched, it is automatically associated with the host on which it lands. If the
38+
* started, it is automatically associated with the host on which it lands. If the
3939
* instance is restarted or rebooted, this relationship persists.</p>
4040
* </li>
4141
* <li>

clients/client-ec2/src/models/models_1.ts

+38-17
Original file line numberDiff line numberDiff line change
@@ -1906,16 +1906,18 @@ export interface InstanceRequirementsRequest {
19061906
* selects instance types with your attributes, it will exclude instance types whose Spot
19071907
* price exceeds your specified threshold.</p>
19081908
* <p>The parameter accepts an integer, which Amazon EC2 interprets as a percentage.</p>
1909-
* <p>To indicate no price protection threshold, specify a high value, such as <code>999999</code>.</p>
19101909
* <p>If you set <code>TargetCapacityUnitType</code> to <code>vcpu</code> or
19111910
* <code>memory-mib</code>, the price protection threshold is applied based on the
19121911
* per-vCPU or per-memory price instead of the per-instance price.</p>
19131912
* <p>This parameter is not supported for <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html">GetSpotPlacementScores</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html">GetInstanceTypesFromInstanceRequirements</a>.</p>
19141913
* <note>
19151914
* <p>Only one of <code>SpotMaxPricePercentageOverLowestPrice</code> or
1916-
* <code>MaxSpotPriceAsPercentageOfOptimalOnDemandPrice</code> can be specified. If you
1917-
* don't specify either, then <code>SpotMaxPricePercentageOverLowestPrice</code> is used
1918-
* and the value for that parameter defaults to <code>100</code>.</p>
1915+
* <code>MaxSpotPriceAsPercentageOfOptimalOnDemandPrice</code> can be specified. If you
1916+
* don't specify either, Amazon EC2 will automatically apply optimal price protection to
1917+
* consistently select from a wide range of instance types. To indicate no price protection
1918+
* threshold for Spot Instances, meaning you want to consider all instance types that match your
1919+
* attributes, include one of these parameters and specify a high value, such as
1920+
* <code>999999</code>.</p>
19191921
* </note>
19201922
* <p>Default: <code>100</code>
19211923
* </p>
@@ -2196,16 +2198,17 @@ export interface InstanceRequirementsRequest {
21962198
* selects instance types with your attributes, it will exclude instance types whose price
21972199
* exceeds your specified threshold.</p>
21982200
* <p>The parameter accepts an integer, which Amazon EC2 interprets as a percentage.</p>
2199-
* <p>To indicate no price protection threshold, specify a high value, such as
2200-
* <code>999999</code>.</p>
22012201
* <p>If you set <code>DesiredCapacityType</code> to <code>vcpu</code> or
22022202
* <code>memory-mib</code>, the price protection threshold is based on the per vCPU or per
22032203
* memory price instead of the per instance price.</p>
22042204
* <note>
22052205
* <p>Only one of <code>SpotMaxPricePercentageOverLowestPrice</code> or
22062206
* <code>MaxSpotPriceAsPercentageOfOptimalOnDemandPrice</code> can be specified. If you
2207-
* don't specify either, then <code>SpotMaxPricePercentageOverLowestPrice</code> is used
2208-
* and the value for that parameter defaults to <code>100</code>.</p>
2207+
* don't specify either, Amazon EC2 will automatically apply optimal price protection to
2208+
* consistently select from a wide range of instance types. To indicate no price protection
2209+
* threshold for Spot Instances, meaning you want to consider all instance types that match your
2210+
* attributes, include one of these parameters and specify a high value, such as
2211+
* <code>999999</code>.</p>
22092212
* </note>
22102213
*/
22112214
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice?: number;
@@ -2329,6 +2332,14 @@ export interface FleetLaunchTemplateOverridesRequest {
23292332
/**
23302333
* @public
23312334
* <p>The number of units provided by the specified instance type.</p>
2335+
* <note>
2336+
* <p>When specifying weights, the price used in the <code>lowest-price</code> and
2337+
* <code>price-capacity-optimized</code> allocation strategies is per
2338+
* <i>unit</i> hour (where the instance price is divided by the specified
2339+
* weight). However, if all the specified weights are above the requested
2340+
* <code>TargetCapacity</code>, resulting in only 1 instance being launched, the price
2341+
* used is per <i>instance</i> hour.</p>
2342+
* </note>
23322343
*/
23332344
WeightedCapacity?: number;
23342345

@@ -3282,17 +3293,18 @@ export interface InstanceRequirements {
32823293
* selects instance types with your attributes, it will exclude instance types whose Spot
32833294
* price exceeds your specified threshold.</p>
32843295
* <p>The parameter accepts an integer, which Amazon EC2 interprets as a percentage.</p>
3285-
* <p>To indicate no price protection threshold, specify a high value, such as
3286-
* <code>999999</code>.</p>
32873296
* <p>If you set <code>TargetCapacityUnitType</code> to <code>vcpu</code> or
32883297
* <code>memory-mib</code>, the price protection threshold is applied based on the per-vCPU
32893298
* or per-memory price instead of the per-instance price.</p>
32903299
* <p>This parameter is not supported for <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html">GetSpotPlacementScores</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html">GetInstanceTypesFromInstanceRequirements</a>.</p>
32913300
* <note>
32923301
* <p>Only one of <code>SpotMaxPricePercentageOverLowestPrice</code> or
3293-
* <code>MaxSpotPriceAsPercentageOfOptimalOnDemandPrice</code> can be specified. If you
3294-
* don't specify either, then <code>SpotMaxPricePercentageOverLowestPrice</code> is used
3295-
* and the value for that parameter defaults to <code>100</code>.</p>
3302+
* <code>MaxSpotPriceAsPercentageOfOptimalOnDemandPrice</code> can be specified. If you
3303+
* don't specify either, Amazon EC2 will automatically apply optimal price protection to
3304+
* consistently select from a wide range of instance types. To indicate no price protection
3305+
* threshold for Spot Instances, meaning you want to consider all instance types that match your
3306+
* attributes, include one of these parameters and specify a high value, such as
3307+
* <code>999999</code>.</p>
32963308
* </note>
32973309
* <p>Default: <code>100</code>
32983310
* </p>
@@ -3572,16 +3584,17 @@ export interface InstanceRequirements {
35723584
* selects instance types with your attributes, it will exclude instance types whose price
35733585
* exceeds your specified threshold.</p>
35743586
* <p>The parameter accepts an integer, which Amazon EC2 interprets as a percentage.</p>
3575-
* <p>To indicate no price protection threshold, specify a high value, such as
3576-
* <code>999999</code>.</p>
35773587
* <p>If you set <code>DesiredCapacityType</code> to <code>vcpu</code> or
35783588
* <code>memory-mib</code>, the price protection threshold is based on the per vCPU or per
35793589
* memory price instead of the per instance price.</p>
35803590
* <note>
35813591
* <p>Only one of <code>SpotMaxPricePercentageOverLowestPrice</code> or
35823592
* <code>MaxSpotPriceAsPercentageOfOptimalOnDemandPrice</code> can be specified. If you
3583-
* don't specify either, then <code>SpotMaxPricePercentageOverLowestPrice</code> is used
3584-
* and the value for that parameter defaults to <code>100</code>.</p>
3593+
* don't specify either, Amazon EC2 will automatically apply optimal price protection to
3594+
* consistently select from a wide range of instance types. To indicate no price protection
3595+
* threshold for Spot Instances, meaning you want to consider all instance types that match your
3596+
* attributes, include one of these parameters and specify a high value, such as
3597+
* <code>999999</code>.</p>
35853598
* </note>
35863599
*/
35873600
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice?: number;
@@ -3641,6 +3654,14 @@ export interface FleetLaunchTemplateOverrides {
36413654
/**
36423655
* @public
36433656
* <p>The number of units provided by the specified instance type.</p>
3657+
* <note>
3658+
* <p>When specifying weights, the price used in the <code>lowest-price</code> and
3659+
* <code>price-capacity-optimized</code> allocation strategies is per
3660+
* <i>unit</i> hour (where the instance price is divided by the specified
3661+
* weight). However, if all the specified weights are above the requested
3662+
* <code>TargetCapacity</code>, resulting in only 1 instance being launched, the price
3663+
* used is per <i>instance</i> hour.</p>
3664+
* </note>
36443665
*/
36453666
WeightedCapacity?: number;
36463667

clients/client-ec2/src/models/models_4.ts

+11-3
Original file line numberDiff line numberDiff line change
@@ -3286,7 +3286,7 @@ export interface InstanceTopology {
32863286
/**
32873287
* @public
32883288
* <p>The network nodes. The nodes are hashed based on your account. Instances from
3289-
* different accounts running under the same droplet will return a different hashed list of
3289+
* different accounts running under the same server will return a different hashed list of
32903290
* strings.</p>
32913291
*/
32923292
NetworkNodes?: string[];
@@ -11235,6 +11235,14 @@ export interface LaunchTemplateOverrides {
1123511235
/**
1123611236
* @public
1123711237
* <p>The number of units provided by the specified instance type.</p>
11238+
* <note>
11239+
* <p>When specifying weights, the price used in the <code>lowest-price</code> and
11240+
* <code>price-capacity-optimized</code> allocation strategies is per
11241+
* <i>unit</i> hour (where the instance price is divided by the specified
11242+
* weight). However, if all the specified weights are above the requested
11243+
* <code>TargetCapacity</code>, resulting in only 1 instance being launched, the price
11244+
* used is per <i>instance</i> hour.</p>
11245+
* </note>
1123811246
*/
1123911247
WeightedCapacity?: number;
1124011248

@@ -12518,8 +12526,8 @@ export interface SpotPrice {
1251812526
export interface DescribeSpotPriceHistoryResult {
1251912527
/**
1252012528
* @public
12521-
* <p>The token to include in another request to get the next page of items. This value is <code>null</code> when there
12522-
* are no more items to return.</p>
12529+
* <p>The token to include in another request to get the next page of items. This value is
12530+
* an empty string (<code>""</code>) or <code>null</code> when there are no more items to return.</p>
1252312531
*/
1252412532
NextToken?: string;
1252512533

clients/client-ec2/src/models/models_6.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -5102,7 +5102,7 @@ export type HostTenancy = (typeof HostTenancy)[keyof typeof HostTenancy];
51025102
export interface ModifyInstancePlacementRequest {
51035103
/**
51045104
* @public
5105-
* <p>The affinity setting for the instance.</p>
5105+
* <p>The affinity setting for the instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-affinity">Host affinity</a> in the <i>Amazon EC2 User Guide</i>.</p>
51065106
*/
51075107
Affinity?: Affinity;
51085108

0 commit comments

Comments
 (0)