Skip to content

Commit 1f69cff

Browse files
author
awstools
committed
docs(client-ec2): Documentation updates for Amazon EC2.
1 parent 43407f7 commit 1f69cff

File tree

11 files changed

+109
-52
lines changed

11 files changed

+109
-52
lines changed

‎clients/client-ec2/src/commands/DescribeElasticGpusCommand.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,12 @@ export interface DescribeElasticGpusCommandOutput extends DescribeElasticGpusRes
2828

2929
/**
3030
* @public
31-
* <p>Describes the Elastic Graphics accelerator associated with your instances. For more information
31+
* <note>
32+
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
33+
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
34+
* G4dn, or G5 instances.</p>
35+
* </note>
36+
* <p>Describes the Elastic Graphics accelerator associated with your instances. For more information
3237
* about Elastic Graphics, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html">Amazon Elastic Graphics</a>.</p>
3338
* @example
3439
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-ec2/src/commands/GetLaunchTemplateDataCommand.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,8 @@ export interface GetLaunchTemplateDataCommandOutput extends GetLaunchTemplateDat
3636
* create a launch template. </p>
3737
* <p>This action calls on other describe actions to get instance information. Depending on
3838
* your instance configuration, you may need to allow the following actions in your IAM
39-
* policy: <code>DescribeSpotInstanceRequests</code>,
40-
* <code>DescribeInstanceCreditSpecifications</code>, <code>DescribeVolumes</code>,
41-
* <code>DescribeInstanceAttribute</code>, and <code>DescribeElasticGpus</code>. Or,
39+
* policy: <code>DescribeSpotInstanceRequests</code>, <code>DescribeInstanceCreditSpecifications</code>,
40+
* <code>DescribeVolumes</code>, and <code>DescribeInstanceAttribute</code>. Or,
4241
* you can allow <code>describe*</code> depending on your instance requirements.</p>
4342
* @example
4443
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-ec2/src/commands/StartInstancesCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ export interface StartInstancesCommandOutput extends StartInstancesResult, __Met
4141
* <p>Performing this operation on an instance that uses an instance store as its root
4242
* device returns an error.</p>
4343
* <p>If you attempt to start a T3 instance with <code>host</code> tenancy and the
44-
* <code>unlimted</code> CPU credit option, the request fails. The
44+
* <code>unlimited</code> CPU credit option, the request fails. The
4545
* <code>unlimited</code> CPU credit option is not supported on Dedicated Hosts. Before
4646
* you start the instance, either change its CPU credit option to <code>standard</code>, or
4747
* change its tenancy to <code>default</code> or <code>dedicated</code>.</p>

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

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1070,6 +1070,8 @@ export interface Subnet {
10701070
/**
10711071
* @public
10721072
* <p>Indicates whether instances launched in this subnet receive a public IPv4 address.</p>
1073+
* <p>Starting on February 1, 2024, Amazon Web Services will charge for all public IPv4 addresses, including public IPv4 addresses
1074+
* associated with running instances and Elastic IP addresses. For more information, see the <i>Public IPv4 Address</i> tab on the <a href="http://aws.amazon.com/vpc/pricing/">Amazon VPC pricing page</a>.</p>
10731075
*/
10741076
MapPublicIpOnLaunch?: boolean;
10751077

@@ -6413,7 +6415,12 @@ export interface CreditSpecificationRequest {
64136415

64146416
/**
64156417
* @public
6416-
* <p>A specification for an Elastic Graphics accelerator.</p>
6418+
* <note>
6419+
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
6420+
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
6421+
* G4dn, or G5 instances.</p>
6422+
* </note>
6423+
* <p>A specification for an Elastic Graphics accelerator.</p>
64176424
*/
64186425
export interface ElasticGpuSpecification {
64196426
/**
@@ -7202,10 +7209,10 @@ export interface LaunchTemplateTagSpecificationRequest {
72027209
* <p>The type of resource to tag.</p>
72037210
* <p>Valid Values lists all resource types for Amazon EC2 that can be tagged. When
72047211
* you create a launch template, you can specify tags for the following resource types
7205-
* only: <code>instance</code> | <code>volume</code> | <code>elastic-gpu</code> |
7212+
* only: <code>instance</code> | <code>volume</code> |
72067213
* <code>network-interface</code> | <code>spot-instances-request</code>.
72077214
* If the instance does not include the resource type that you specify, the instance
7208-
* launch fails. For example, not all instance types include an Elastic GPU.</p>
7215+
* launch fails. For example, not all instance types include a volume.</p>
72097216
* <p>To tag a resource after it has been created, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html">CreateTags</a>.</p>
72107217
*/
72117218
ResourceType?: ResourceType;
@@ -7387,7 +7394,12 @@ export interface RequestLaunchTemplateData {
73877394

73887395
/**
73897396
* @public
7390-
* <p>An elastic GPU to associate with the instance.</p>
7397+
* <p>Deprecated.</p>
7398+
* <note>
7399+
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
7400+
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
7401+
* G4dn, or G5 instances.</p>
7402+
* </note>
73917403
*/
73927404
ElasticGpuSpecifications?: ElasticGpuSpecification[];
73937405

@@ -7943,12 +7955,22 @@ export interface CreditSpecification {
79437955

79447956
/**
79457957
* @public
7946-
* <p>Describes an elastic GPU.</p>
7958+
* <p>Deprecated.</p>
7959+
* <note>
7960+
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
7961+
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
7962+
* G4dn, or G5 instances.</p>
7963+
* </note>
79477964
*/
79487965
export interface ElasticGpuSpecificationResponse {
79497966
/**
79507967
* @public
7951-
* <p>The elastic GPU type.</p>
7968+
* <p>Deprecated.</p>
7969+
* <note>
7970+
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
7971+
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
7972+
* G4dn, or G5 instances.</p>
7973+
* </note>
79527974
*/
79537975
Type?: string;
79547976
}
@@ -8707,7 +8729,12 @@ export interface ResponseLaunchTemplateData {
87078729

87088730
/**
87098731
* @public
8710-
* <p>The elastic GPU specification.</p>
8732+
* <p>Deprecated.</p>
8733+
* <note>
8734+
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
8735+
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
8736+
* G4dn, or G5 instances.</p>
8737+
* </note>
87118738
*/
87128739
ElasticGpuSpecifications?: ElasticGpuSpecificationResponse[];
87138740

‎clients/client-ec2/src/models/models_2.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6988,7 +6988,7 @@ export interface VpnTunnelOptionsSpecification {
69886988
* of the rekey is randomly selected based on the value for
69896989
* <code>RekeyFuzzPercentage</code>.</p>
69906990
* <p>Constraints: A value between 60 and half of <code>Phase2LifetimeSeconds</code>.</p>
6991-
* <p>Default: <code>540</code>
6991+
* <p>Default: <code>270</code>
69926992
* </p>
69936993
*/
69946994
RekeyMarginTimeSeconds?: number;

‎clients/client-ec2/src/models/models_3.ts

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2353,12 +2353,12 @@ export interface DescribeAvailabilityZonesRequest {
23532353
* </li>
23542354
* <li>
23552355
* <p>
2356-
* <code>parent-zoneID</code> - The ID of the zone that handles some of the Local Zone
2356+
* <code>parent-zone-id</code> - The ID of the zone that handles some of the Local Zone
23572357
* and Wavelength Zone control plane operations, such as API calls.</p>
23582358
* </li>
23592359
* <li>
23602360
* <p>
2361-
* <code>parent-zoneName</code> - The ID of the zone that handles some of the Local Zone
2361+
* <code>parent-zone-name</code> - The ID of the zone that handles some of the Local Zone
23622362
* and Wavelength Zone control plane operations, such as API calls.</p>
23632363
* </li>
23642364
* <li>
@@ -5136,7 +5136,12 @@ export type ElasticGpuStatus = (typeof ElasticGpuStatus)[keyof typeof ElasticGpu
51365136

51375137
/**
51385138
* @public
5139-
* <p>Describes the status of an Elastic Graphics accelerator.</p>
5139+
* <note>
5140+
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
5141+
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
5142+
* G4dn, or G5 instances.</p>
5143+
* </note>
5144+
* <p>Describes the status of an Elastic Graphics accelerator.</p>
51405145
*/
51415146
export interface ElasticGpuHealth {
51425147
/**
@@ -5161,7 +5166,12 @@ export type ElasticGpuState = (typeof ElasticGpuState)[keyof typeof ElasticGpuSt
51615166

51625167
/**
51635168
* @public
5164-
* <p>Describes an Elastic Graphics accelerator.</p>
5169+
* <note>
5170+
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
5171+
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
5172+
* G4dn, or G5 instances.</p>
5173+
* </note>
5174+
* <p>Describes an Elastic Graphics accelerator.</p>
51655175
*/
51665176
export interface ElasticGpus {
51675177
/**

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

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1635,7 +1635,12 @@ export type InstanceBootModeValues = (typeof InstanceBootModeValues)[keyof typeo
16351635

16361636
/**
16371637
* @public
1638-
* <p>Describes the association between an instance and an Elastic Graphics accelerator.</p>
1638+
* <note>
1639+
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
1640+
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
1641+
* G4dn, or G5 instances.</p>
1642+
* </note>
1643+
* <p>Describes the association between an instance and an Elastic Graphics accelerator.</p>
16391644
*/
16401645
export interface ElasticGpuAssociation {
16411646
/**
@@ -2582,7 +2587,12 @@ export interface Instance {
25822587

25832588
/**
25842589
* @public
2585-
* <p>The Elastic GPU associated with the instance.</p>
2590+
* <p>Deprecated.</p>
2591+
* <note>
2592+
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
2593+
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
2594+
* G4dn, or G5 instances.</p>
2595+
* </note>
25862596
*/
25872597
ElasticGpuAssociations?: ElasticGpuAssociation[];
25882598

@@ -9129,6 +9139,11 @@ export interface DescribeRouteTablesRequest {
91299139
* <ul>
91309140
* <li>
91319141
* <p>
9142+
* <code>association.gateway-id</code> - The ID of the gateway involved in the
9143+
* association.</p>
9144+
* </li>
9145+
* <li>
9146+
* <p>
91329147
* <code>association.route-table-association-id</code> - The ID of an association
91339148
* ID for the route table.</p>
91349149
* </li>

‎clients/client-ec2/src/models/models_5.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5457,13 +5457,13 @@ export interface EnableAddressTransferResult {
54575457
export interface EnableAwsNetworkPerformanceMetricSubscriptionRequest {
54585458
/**
54595459
* @public
5460-
* <p>The source Region or Availability Zone that the metric subscription is enabled for. For example, <code>us-east-1</code>.</p>
5460+
* <p>The source Region (like <code>us-east-1</code>) or Availability Zone ID (like <code>use1-az1</code>) that the metric subscription is enabled for. If you use Availability Zone IDs, the Source and Destination Availability Zones must be in the same Region.</p>
54615461
*/
54625462
Source?: string;
54635463

54645464
/**
54655465
* @public
5466-
* <p>The target Region or Availability Zone that the metric subscription is enabled for. For example, <code>eu-west-1</code>.</p>
5466+
* <p>The target Region (like <code>us-east-2</code>) or Availability Zone ID (like <code>use2-az2</code>) that the metric subscription is enabled for. If you use Availability Zone IDs, the Source and Destination Availability Zones must be in the same Region.</p>
54675467
*/
54685468
Destination?: string;
54695469

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6192,6 +6192,8 @@ export interface ModifySubnetAttributeRequest {
61926192
* @public
61936193
* <p>Specify <code>true</code> to indicate that network interfaces attached to instances created in the
61946194
* specified subnet should be assigned a public IPv4 address.</p>
6195+
* <p>Starting on February 1, 2024, Amazon Web Services will charge for all public IPv4 addresses, including public IPv4 addresses
6196+
* associated with running instances and Elastic IP addresses. For more information, see the <i>Public IPv4 Address</i> tab on the <a href="http://aws.amazon.com/vpc/pricing/">Amazon VPC pricing page</a>.</p>
61956197
*/
61966198
MapPublicIpOnLaunch?: AttributeBooleanValue;
61976199

@@ -8240,7 +8242,7 @@ export interface ModifyVpnTunnelOptionsSpecification {
82408242
* of the rekey is randomly selected based on the value for
82418243
* <code>RekeyFuzzPercentage</code>.</p>
82428244
* <p>Constraints: A value between 60 and half of <code>Phase2LifetimeSeconds</code>.</p>
8243-
* <p>Default: <code>540</code>
8245+
* <p>Default: <code>270</code>
82448246
* </p>
82458247
*/
82468248
RekeyMarginTimeSeconds?: number;

‎clients/client-ec2/src/models/models_7.ts

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2476,10 +2476,12 @@ export interface RunInstancesRequest {
24762476

24772477
/**
24782478
* @public
2479-
* <p>An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that
2480-
* you can attach to your Windows instance to accelerate the graphics performance of your
2481-
* applications. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html">Amazon EC2 Elastic GPUs</a> in
2482-
* the <i>Amazon EC2 User Guide</i>.</p>
2479+
* <p>Deprecated.</p>
2480+
* <note>
2481+
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
2482+
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
2483+
* G4dn, or G5 instances.</p>
2484+
* </note>
24832485
*/
24842486
ElasticGpuSpecification?: ElasticGpuSpecification[];
24852487

@@ -2513,9 +2515,6 @@ export interface RunInstancesRequest {
25132515
* <p>Volumes</p>
25142516
* </li>
25152517
* <li>
2516-
* <p>Elastic graphics</p>
2517-
* </li>
2518-
* <li>
25192518
* <p>Spot Instance requests</p>
25202519
* </li>
25212520
* <li>

0 commit comments

Comments
 (0)