Skip to content

Commit 57d2abc

Browse files
author
awstools
committed
docs(client-ec2): Doc-only updates for EC2 for March 2025.
1 parent 5715d11 commit 57d2abc

11 files changed

+135
-158
lines changed

Diff for: clients/client-ec2/src/commands/AssociateInstanceEventWindowCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ export interface AssociateInstanceEventWindowCommandOutput
3030
__MetadataBearer {}
3131

3232
/**
33-
* <p>Associates one or more targets with an event window. Only one type of target (instance IDs,
34-
* Dedicated Host IDs, or tags) can be specified with an event window.</p>
33+
* <p>Associates one or more targets with an event window. Only one type of target (instance
34+
* IDs, Dedicated Host IDs, or tags) can be specified with an event window.</p>
3535
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html">Define event windows for scheduled
3636
* events</a> in the <i>Amazon EC2 User Guide</i>.</p>
3737
* @example

Diff for: clients/client-ec2/src/commands/DeregisterInstanceEventNotificationAttributesCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ export interface DeregisterInstanceEventNotificationAttributesCommandOutput
3737
__MetadataBearer {}
3838

3939
/**
40-
* <p>Deregisters tag keys to prevent tags that have the specified tag keys from being included
41-
* in scheduled event notifications for resources in the Region.</p>
40+
* <p>Deregisters tag keys to prevent tags that have the specified tag keys from being
41+
* included in scheduled event notifications for resources in the Region.</p>
4242
* @example
4343
* Use a bare-bones client and the command you need to make an API call.
4444
* ```javascript

Diff for: clients/client-ec2/src/commands/DescribeInstanceEventNotificationAttributesCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ export interface DescribeInstanceEventNotificationAttributesCommandOutput
3737
__MetadataBearer {}
3838

3939
/**
40-
* <p>Describes the tag keys that are registered to appear in scheduled event notifications for
41-
* resources in the current Region.</p>
40+
* <p>Describes the tag keys that are registered to appear in scheduled event notifications
41+
* for resources in the current Region.</p>
4242
* @example
4343
* Use a bare-bones client and the command you need to make an API call.
4444
* ```javascript

Diff for: clients/client-ec2/src/commands/RegisterInstanceEventNotificationAttributesCommand.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,9 @@ export interface RegisterInstanceEventNotificationAttributesCommandOutput
3737
__MetadataBearer {}
3838

3939
/**
40-
* <p>Registers a set of tag keys to include in scheduled event notifications for your resources.
41-
* </p>
40+
* <p>Registers a set of tag keys to include in scheduled event notifications for your
41+
* resources.
42+
* </p>
4243
* <p>To remove tags, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeregisterInstanceEventNotificationAttributes.html">DeregisterInstanceEventNotificationAttributes</a>.</p>
4344
* @example
4445
* Use a bare-bones client and the command you need to make an API call.

Diff for: clients/client-ec2/src/models/models_0.ts

+8-2
Original file line numberDiff line numberDiff line change
@@ -4577,6 +4577,9 @@ export interface InstanceEventWindowAssociationRequest {
45774577
/**
45784578
* <p>The instance tags to associate with the event window. Any instances associated with the
45794579
* tags will be associated with the event window.</p>
4580+
* <p>Note that while you can't create tag keys beginning with <code>aws:</code>, you can
4581+
* specify existing Amazon Web Services managed tag keys (with the <code>aws:</code> prefix) when specifying
4582+
* them as targets to associate with the event window.</p>
45804583
* @public
45814584
*/
45824585
InstanceTags?: Tag[] | undefined;
@@ -4625,8 +4628,11 @@ export interface InstanceEventWindowAssociationTarget {
46254628
InstanceIds?: string[] | undefined;
46264629

46274630
/**
4628-
* <p>The instance tags associated with the event window. Any instances associated with the tags
4629-
* will be associated with the event window.</p>
4631+
* <p>The instance tags associated with the event window. Any instances associated with the
4632+
* tags will be associated with the event window.</p>
4633+
* <p>Note that while you can't create tag keys beginning with <code>aws:</code>, you can
4634+
* specify existing Amazon Web Services managed tag keys (with the <code>aws:</code> prefix) when specifying
4635+
* them as targets to associate with the event window.</p>
46304636
* @public
46314637
*/
46324638
Tags?: Tag[] | undefined;

Diff for: clients/client-ec2/src/models/models_1.ts

+35-81
Original file line numberDiff line numberDiff line change
@@ -556,24 +556,34 @@ export interface CapacityReservation {
556556
* </li>
557557
* <li>
558558
* <p>
559-
* <code>scheduled</code> - (<i>Future-dated Capacity Reservations only</i>) The
559+
* <code>scheduled</code> - (<i>Future-dated Capacity Reservations</i>) The
560560
* future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled
561561
* for delivery on the requested start date.</p>
562562
* </li>
563563
* <li>
564564
* <p>
565-
* <code>assessing</code> - (<i>Future-dated Capacity Reservations only</i>)
565+
* <code>payment-pending</code> - (<i>Capacity Blocks</i>) The upfront
566+
* payment has not been processed yet.</p>
567+
* </li>
568+
* <li>
569+
* <p>
570+
* <code>payment-failed</code> - (<i>Capacity Blocks</i>) The upfront
571+
* payment was not processed in the 12-hour time frame. Your Capacity Block was released.</p>
572+
* </li>
573+
* <li>
574+
* <p>
575+
* <code>assessing</code> - (<i>Future-dated Capacity Reservations</i>)
566576
* Amazon EC2 is assessing your request for a future-dated Capacity Reservation.</p>
567577
* </li>
568578
* <li>
569579
* <p>
570-
* <code>delayed</code> - (<i>Future-dated Capacity Reservations only</i>) Amazon EC2
580+
* <code>delayed</code> - (<i>Future-dated Capacity Reservations</i>) Amazon EC2
571581
* encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is
572582
* unable to deliver the requested capacity by the requested start date and time.</p>
573583
* </li>
574584
* <li>
575585
* <p>
576-
* <code>unsupported</code> - (<i>Future-dated Capacity Reservations only</i>) Amazon EC2
586+
* <code>unsupported</code> - (<i>Future-dated Capacity Reservations</i>) Amazon EC2
577587
* can't support the future-dated Capacity Reservation request due to capacity constraints. You can view
578588
* unsupported requests for 30 days. The Capacity Reservation will not be delivered.</p>
579589
* </li>
@@ -3831,8 +3841,7 @@ export interface FleetEbsBlockDeviceRequest {
38313841
* <p>Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key
38323842
* to use for EBS encryption.</p>
38333843
* <p>This parameter is only supported on <code>BlockDeviceMapping</code> objects called by
3834-
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html">RunInstances</a>, <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html">RequestSpotFleet</a>,
3835-
* and <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html">RequestSpotInstances</a>.</p>
3844+
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet.html">CreateFleet</a>, <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html">RequestSpotInstances</a>, and <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html">RunInstances</a>.</p>
38363845
* @public
38373846
*/
38383847
KmsKeyId?: string | undefined;
@@ -4583,9 +4592,6 @@ export interface InstanceRequirementsRequest {
45834592
* <li>
45844593
* <p>For instance types with GPU accelerators, specify <code>gpu</code>.</p>
45854594
* </li>
4586-
* <li>
4587-
* <p>For instance types with Inference accelerators, specify <code>inference</code>.</p>
4588-
* </li>
45894595
* </ul>
45904596
* <p>Default: Any accelerator type</p>
45914597
* @public
@@ -4906,34 +4912,12 @@ export interface FleetLaunchTemplateOverridesRequest {
49064912
Placement?: Placement | undefined;
49074913

49084914
/**
4909-
* <p>The block device mapping, which defines the EBS volumes and instance store volumes to
4910-
* attach to the instance at launch. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html">Block device mappings
4915+
* <p>The block device mappings, which define the EBS volumes and instance store volumes to
4916+
* attach to the instance at launch.</p>
4917+
* <p>Supported only for fleets of type <code>instant</code>.</p>
4918+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html">Block device mappings
49114919
* for volumes on Amazon EC2 instances</a> in the <i>Amazon EC2 User
49124920
* Guide</i>.</p>
4913-
* <p>To override a block device mapping specified in the launch template:</p>
4914-
* <ul>
4915-
* <li>
4916-
* <p>Specify the exact same <code>DeviceName</code> here as specified in the launch
4917-
* template.</p>
4918-
* </li>
4919-
* <li>
4920-
* <p>Only specify the parameters you want to change.</p>
4921-
* </li>
4922-
* <li>
4923-
* <p>Any parameters you don't specify here will keep their original launch template
4924-
* values.</p>
4925-
* </li>
4926-
* </ul>
4927-
* <p>To add a new block device mapping:</p>
4928-
* <ul>
4929-
* <li>
4930-
* <p>Specify a <code>DeviceName</code> that doesn't exist in the launch
4931-
* template.</p>
4932-
* </li>
4933-
* <li>
4934-
* <p>Specify all desired parameters here.</p>
4935-
* </li>
4936-
* </ul>
49374921
* @public
49384922
*/
49394923
BlockDeviceMappings?: FleetBlockDeviceMappingRequest[] | undefined;
@@ -6298,12 +6282,6 @@ export interface InstanceRequirements {
62986282
* <li>
62996283
* <p>For instance types with GPU accelerators, specify <code>gpu</code>.</p>
63006284
* </li>
6301-
* <li>
6302-
* <p>For instance types with Inference accelerators, specify <code>inference</code>.</p>
6303-
* </li>
6304-
* <li>
6305-
* <p>For instance types with Inference accelerators, specify <code>inference</code>.</p>
6306-
* </li>
63076285
* </ul>
63086286
* <p>Default: Any accelerator type</p>
63096287
* @public
@@ -6636,8 +6614,10 @@ export interface FleetLaunchTemplateOverrides {
66366614
ImageId?: string | undefined;
66376615

66386616
/**
6639-
* <p>The block device mapping, which defines the EBS volumes and instance store volumes to
6640-
* attach to the instance at launch. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html">Block device mappings
6617+
* <p>The block device mappings, which define the EBS volumes and instance store volumes to
6618+
* attach to the instance at launch.</p>
6619+
* <p>Supported only for fleets of type <code>instant</code>.</p>
6620+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html">Block device mappings
66416621
* for volumes on Amazon EC2 instances</a> in the <i>Amazon EC2 User
66426622
* Guide</i>.</p>
66436623
* @public
@@ -7678,15 +7658,15 @@ export interface CreateInstanceEventWindowRequest {
76787658
Name?: string | undefined;
76797659

76807660
/**
7681-
* <p>The time range for the event window. If you specify a time range, you can't specify a cron
7682-
* expression.</p>
7661+
* <p>The time range for the event window. If you specify a time range, you can't specify a
7662+
* cron expression.</p>
76837663
* @public
76847664
*/
76857665
TimeRanges?: InstanceEventWindowTimeRangeRequest[] | undefined;
76867666

76877667
/**
7688-
* <p>The cron expression for the event window, for example, <code>* 0-4,20-23 * * 1,5</code>. If
7689-
* you specify a cron expression, you can't specify a time range.</p>
7668+
* <p>The cron expression for the event window, for example, <code>* 0-4,20-23 * * 1,5</code>.
7669+
* If you specify a cron expression, you can't specify a time range.</p>
76907670
* <p>Constraints:</p>
76917671
* <ul>
76927672
* <li>
@@ -7702,11 +7682,11 @@ export interface CreateInstanceEventWindowRequest {
77027682
* </li>
77037683
* <li>
77047684
* <p>The hour value must be one or a multiple range, for example, <code>0-4</code> or
7705-
* <code>0-4,20-23</code>.</p>
7685+
* <code>0-4,20-23</code>.</p>
77067686
* </li>
77077687
* <li>
77087688
* <p>Each hour range must be >= 2 hours, for example, <code>0-2</code> or
7709-
* <code>20-23</code>.</p>
7689+
* <code>20-23</code>.</p>
77107690
* </li>
77117691
* <li>
77127692
* <p>The event window must be >= 4 hours. The combined total time ranges in the event
@@ -10715,9 +10695,7 @@ export interface RequestLaunchTemplateData {
1071510695
/**
1071610696
* <p>Deprecated.</p>
1071710697
* <note>
10718-
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
10719-
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
10720-
* G4dn, or G5 instances.</p>
10698+
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024.</p>
1072110699
* </note>
1072210700
* @public
1072310701
*/
@@ -10731,15 +10709,6 @@ export interface RequestLaunchTemplateData {
1073110709
* accelerators are a resource you can attach to your Amazon EC2 instances to accelerate
1073210710
* your Deep Learning (DL) inference workloads.</p>
1073310711
* <p>You cannot specify accelerators from different generations in the same request.</p>
10734-
* <note>
10735-
* <p>Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon
10736-
* Elastic Inference (EI), and will help current customers migrate their workloads to
10737-
* options that offer better price and performance. After April 15, 2023, new customers
10738-
* will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker,
10739-
* Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during
10740-
* the past 30-day period are considered current customers and will be able to continue
10741-
* using the service.</p>
10742-
* </note>
1074310712
* @public
1074410713
*/
1074510714
ElasticInferenceAccelerators?: LaunchTemplateElasticInferenceAccelerator[] | undefined;
@@ -10951,13 +10920,13 @@ export interface CreateLaunchTemplateRequest {
1095110920
}
1095210921

1095310922
/**
10954-
* <p>Describes whether the resource is managed by an service provider and, if so, describes
10923+
* <p>Describes whether the resource is managed by a service provider and, if so, describes
1095510924
* the service provider that manages it.</p>
1095610925
* @public
1095710926
*/
1095810927
export interface OperatorResponse {
1095910928
/**
10960-
* <p>If <code>true</code>, the resource is managed by an service provider.</p>
10929+
* <p>If <code>true</code>, the resource is managed by a service provider.</p>
1096110930
* @public
1096210931
*/
1096310932
Managed?: boolean | undefined;
@@ -11334,19 +11303,15 @@ export interface CreditSpecification {
1133411303
/**
1133511304
* <p>Deprecated.</p>
1133611305
* <note>
11337-
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
11338-
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
11339-
* G4dn, or G5 instances.</p>
11306+
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024.</p>
1134011307
* </note>
1134111308
* @public
1134211309
*/
1134311310
export interface ElasticGpuSpecificationResponse {
1134411311
/**
1134511312
* <p>Deprecated.</p>
1134611313
* <note>
11347-
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
11348-
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
11349-
* G4dn, or G5 instances.</p>
11314+
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024.</p>
1135011315
* </note>
1135111316
* @public
1135211317
*/
@@ -12129,9 +12094,7 @@ export interface ResponseLaunchTemplateData {
1212912094
/**
1213012095
* <p>Deprecated.</p>
1213112096
* <note>
12132-
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
12133-
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
12134-
* G4dn, or G5 instances.</p>
12097+
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024.</p>
1213512098
* </note>
1213612099
* @public
1213712100
*/
@@ -12145,15 +12108,6 @@ export interface ResponseLaunchTemplateData {
1214512108
* accelerators are a resource you can attach to your Amazon EC2 instances to accelerate
1214612109
* your Deep Learning (DL) inference workloads.</p>
1214712110
* <p>You cannot specify accelerators from different generations in the same request.</p>
12148-
* <note>
12149-
* <p>Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon
12150-
* Elastic Inference (EI), and will help current customers migrate their workloads to
12151-
* options that offer better price and performance. After April 15, 2023, new customers
12152-
* will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker,
12153-
* Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during
12154-
* the past 30-day period are considered current customers and will be able to continue
12155-
* using the service.</p>
12156-
* </note>
1215712111
* @public
1215812112
*/
1215912113
ElasticInferenceAccelerators?: LaunchTemplateElasticInferenceAcceleratorResponse[] | undefined;

0 commit comments

Comments
 (0)