Skip to content

Commit

Permalink
docs(client-ec2): Documentation updates for Amazon EC2.
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Jan 22, 2024
1 parent 43407f7 commit 1f69cff
Show file tree
Hide file tree
Showing 11 changed files with 109 additions and 52 deletions.
7 changes: 6 additions & 1 deletion clients/client-ec2/src/commands/DescribeElasticGpusCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,12 @@ export interface DescribeElasticGpusCommandOutput extends DescribeElasticGpusRes

/**
* @public
* <p>Describes the Elastic Graphics accelerator associated with your instances. For more information
* <note>
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
* G4dn, or G5 instances.</p>
* </note>
* <p>Describes the Elastic Graphics accelerator associated with your instances. For more information
* about Elastic Graphics, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html">Amazon Elastic Graphics</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
5 changes: 2 additions & 3 deletions clients/client-ec2/src/commands/GetLaunchTemplateDataCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,8 @@ export interface GetLaunchTemplateDataCommandOutput extends GetLaunchTemplateDat
* create a launch template. </p>
* <p>This action calls on other describe actions to get instance information. Depending on
* your instance configuration, you may need to allow the following actions in your IAM
* policy: <code>DescribeSpotInstanceRequests</code>,
* <code>DescribeInstanceCreditSpecifications</code>, <code>DescribeVolumes</code>,
* <code>DescribeInstanceAttribute</code>, and <code>DescribeElasticGpus</code>. Or,
* policy: <code>DescribeSpotInstanceRequests</code>, <code>DescribeInstanceCreditSpecifications</code>,
* <code>DescribeVolumes</code>, and <code>DescribeInstanceAttribute</code>. Or,
* you can allow <code>describe*</code> depending on your instance requirements.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
2 changes: 1 addition & 1 deletion clients/client-ec2/src/commands/StartInstancesCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export interface StartInstancesCommandOutput extends StartInstancesResult, __Met
* <p>Performing this operation on an instance that uses an instance store as its root
* device returns an error.</p>
* <p>If you attempt to start a T3 instance with <code>host</code> tenancy and the
* <code>unlimted</code> CPU credit option, the request fails. The
* <code>unlimited</code> CPU credit option, the request fails. The
* <code>unlimited</code> CPU credit option is not supported on Dedicated Hosts. Before
* you start the instance, either change its CPU credit option to <code>standard</code>, or
* change its tenancy to <code>default</code> or <code>dedicated</code>.</p>
Expand Down
41 changes: 34 additions & 7 deletions clients/client-ec2/src/models/models_1.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1070,6 +1070,8 @@ export interface Subnet {
/**
* @public
* <p>Indicates whether instances launched in this subnet receive a public IPv4 address.</p>
* <p>Starting on February 1, 2024, Amazon Web Services will charge for all public IPv4 addresses, including public IPv4 addresses
* 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>
*/
MapPublicIpOnLaunch?: boolean;

Expand Down Expand Up @@ -6413,7 +6415,12 @@ export interface CreditSpecificationRequest {

/**
* @public
* <p>A specification for an Elastic Graphics accelerator.</p>
* <note>
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
* G4dn, or G5 instances.</p>
* </note>
* <p>A specification for an Elastic Graphics accelerator.</p>
*/
export interface ElasticGpuSpecification {
/**
Expand Down Expand Up @@ -7202,10 +7209,10 @@ export interface LaunchTemplateTagSpecificationRequest {
* <p>The type of resource to tag.</p>
* <p>Valid Values lists all resource types for Amazon EC2 that can be tagged. When
* you create a launch template, you can specify tags for the following resource types
* only: <code>instance</code> | <code>volume</code> | <code>elastic-gpu</code> |
* only: <code>instance</code> | <code>volume</code> |
* <code>network-interface</code> | <code>spot-instances-request</code>.
* If the instance does not include the resource type that you specify, the instance
* launch fails. For example, not all instance types include an Elastic GPU.</p>
* launch fails. For example, not all instance types include a volume.</p>
* <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>
*/
ResourceType?: ResourceType;
Expand Down Expand Up @@ -7387,7 +7394,12 @@ export interface RequestLaunchTemplateData {

/**
* @public
* <p>An elastic GPU to associate with the instance.</p>
* <p>Deprecated.</p>
* <note>
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
* G4dn, or G5 instances.</p>
* </note>
*/
ElasticGpuSpecifications?: ElasticGpuSpecification[];

Expand Down Expand Up @@ -7943,12 +7955,22 @@ export interface CreditSpecification {

/**
* @public
* <p>Describes an elastic GPU.</p>
* <p>Deprecated.</p>
* <note>
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
* G4dn, or G5 instances.</p>
* </note>
*/
export interface ElasticGpuSpecificationResponse {
/**
* @public
* <p>The elastic GPU type.</p>
* <p>Deprecated.</p>
* <note>
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
* G4dn, or G5 instances.</p>
* </note>
*/
Type?: string;
}
Expand Down Expand Up @@ -8707,7 +8729,12 @@ export interface ResponseLaunchTemplateData {

/**
* @public
* <p>The elastic GPU specification.</p>
* <p>Deprecated.</p>
* <note>
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
* G4dn, or G5 instances.</p>
* </note>
*/
ElasticGpuSpecifications?: ElasticGpuSpecificationResponse[];

Expand Down
2 changes: 1 addition & 1 deletion clients/client-ec2/src/models/models_2.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6988,7 +6988,7 @@ export interface VpnTunnelOptionsSpecification {
* of the rekey is randomly selected based on the value for
* <code>RekeyFuzzPercentage</code>.</p>
* <p>Constraints: A value between 60 and half of <code>Phase2LifetimeSeconds</code>.</p>
* <p>Default: <code>540</code>
* <p>Default: <code>270</code>
* </p>
*/
RekeyMarginTimeSeconds?: number;
Expand Down
18 changes: 14 additions & 4 deletions clients/client-ec2/src/models/models_3.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2353,12 +2353,12 @@ export interface DescribeAvailabilityZonesRequest {
* </li>
* <li>
* <p>
* <code>parent-zoneID</code> - The ID of the zone that handles some of the Local Zone
* <code>parent-zone-id</code> - The ID of the zone that handles some of the Local Zone
* and Wavelength Zone control plane operations, such as API calls.</p>
* </li>
* <li>
* <p>
* <code>parent-zoneName</code> - The ID of the zone that handles some of the Local Zone
* <code>parent-zone-name</code> - The ID of the zone that handles some of the Local Zone
* and Wavelength Zone control plane operations, such as API calls.</p>
* </li>
* <li>
Expand Down Expand Up @@ -5136,7 +5136,12 @@ export type ElasticGpuStatus = (typeof ElasticGpuStatus)[keyof typeof ElasticGpu

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

/**
* @public
* <p>Describes an Elastic Graphics accelerator.</p>
* <note>
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
* G4dn, or G5 instances.</p>
* </note>
* <p>Describes an Elastic Graphics accelerator.</p>
*/
export interface ElasticGpus {
/**
Expand Down
19 changes: 17 additions & 2 deletions clients/client-ec2/src/models/models_4.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1635,7 +1635,12 @@ export type InstanceBootModeValues = (typeof InstanceBootModeValues)[keyof typeo

/**
* @public
* <p>Describes the association between an instance and an Elastic Graphics accelerator.</p>
* <note>
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
* G4dn, or G5 instances.</p>
* </note>
* <p>Describes the association between an instance and an Elastic Graphics accelerator.</p>
*/
export interface ElasticGpuAssociation {
/**
Expand Down Expand Up @@ -2582,7 +2587,12 @@ export interface Instance {

/**
* @public
* <p>The Elastic GPU associated with the instance.</p>
* <p>Deprecated.</p>
* <note>
* <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For
* workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
* G4dn, or G5 instances.</p>
* </note>
*/
ElasticGpuAssociations?: ElasticGpuAssociation[];

Expand Down Expand Up @@ -9129,6 +9139,11 @@ export interface DescribeRouteTablesRequest {
* <ul>
* <li>
* <p>
* <code>association.gateway-id</code> - The ID of the gateway involved in the
* association.</p>
* </li>
* <li>
* <p>
* <code>association.route-table-association-id</code> - The ID of an association
* ID for the route table.</p>
* </li>
Expand Down
4 changes: 2 additions & 2 deletions clients/client-ec2/src/models/models_5.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5457,13 +5457,13 @@ export interface EnableAddressTransferResult {
export interface EnableAwsNetworkPerformanceMetricSubscriptionRequest {
/**
* @public
* <p>The source Region or Availability Zone that the metric subscription is enabled for. For example, <code>us-east-1</code>.</p>
* <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>
*/
Source?: string;

/**
* @public
* <p>The target Region or Availability Zone that the metric subscription is enabled for. For example, <code>eu-west-1</code>.</p>
* <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>
*/
Destination?: string;

Expand Down
4 changes: 3 additions & 1 deletion clients/client-ec2/src/models/models_6.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6192,6 +6192,8 @@ export interface ModifySubnetAttributeRequest {
* @public
* <p>Specify <code>true</code> to indicate that network interfaces attached to instances created in the
* specified subnet should be assigned a public IPv4 address.</p>
* <p>Starting on February 1, 2024, Amazon Web Services will charge for all public IPv4 addresses, including public IPv4 addresses
* 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>
*/
MapPublicIpOnLaunch?: AttributeBooleanValue;

Expand Down Expand Up @@ -8240,7 +8242,7 @@ export interface ModifyVpnTunnelOptionsSpecification {
* of the rekey is randomly selected based on the value for
* <code>RekeyFuzzPercentage</code>.</p>
* <p>Constraints: A value between 60 and half of <code>Phase2LifetimeSeconds</code>.</p>
* <p>Default: <code>540</code>
* <p>Default: <code>270</code>
* </p>
*/
RekeyMarginTimeSeconds?: number;
Expand Down
13 changes: 6 additions & 7 deletions clients/client-ec2/src/models/models_7.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2476,10 +2476,12 @@ export interface RunInstancesRequest {

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

Expand Down Expand Up @@ -2513,9 +2515,6 @@ export interface RunInstancesRequest {
* <p>Volumes</p>
* </li>
* <li>
* <p>Elastic graphics</p>
* </li>
* <li>
* <p>Spot Instance requests</p>
* </li>
* <li>
Expand Down
Loading

0 comments on commit 1f69cff

Please sign in to comment.