feat(client-ec2): Documentation updates for Elastic Compute Cloud (EC2).

Author: awstools

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

@@ -40,6 +40,10 @@ export interface AssociateNatGatewayAddressCommandOutput extends AssociateNatGat
  * <p>Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information,
  *             see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-working-with">Work with NAT gateways</a> in the <i>Amazon VPC User Guide</i>.</p>
  *          <p>By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-eips">Elastic IP address quotas</a> in the <i>Amazon VPC User Guide</i>.</p>
+ *          <important>
+ *             <p>When you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the EIP will fail to associate. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip">Allocate an Elastic IP address</a> in the <i>Amazon VPC User Guide</i>.
+ *         </p>
+ *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -47,6 +47,10 @@ export interface CreateNatGatewayCommandOutput extends CreateNatGatewayResult, _
  *             running large workloads behind a small pool of allowlisted IPv4 addresses, preserving
  *             private IPv4 addresses, and communicating between overlapping networks.</p>
  *          <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html">NAT gateways</a> in the <i>Amazon VPC User Guide</i>.</p>
+ *          <important>
+ *             <p>When you create a public NAT gateway and assign it an EIP or secondary EIPs, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the NAT gateway will fail to launch. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip">Allocate an Elastic IP address</a> in the <i>Amazon VPC User Guide</i>.
+ *       </p>
+ *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -37,7 +37,7 @@ export interface DeleteVpcCommandOutput extends __MetadataBearer {}
 
 /**
  * @public
- * <p>Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.</p>
+ * <p>Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. When you delete the VPC, it deletes the VPC's default security group, network ACL, and route table.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -38,6 +38,10 @@ export interface DescribeNetworkInterfacesCommandOutput extends DescribeNetworkI
 /**
  * @public
  * <p>Describes one or more of your network interfaces.</p>
+ *          <p>If you have a large number of network interfaces, the operation fails unless
+ *            you use pagination or one of the following filters: <code>group-id</code>,
+ *            <code>mac-address</code>, <code>private-dns-name</code>, <code>private-ip-address</code>,
+ *            <code>private-dns-name</code>, <code>subnet-id</code>, or <code>vpc-id</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -3051,8 +3051,6 @@ export interface AllocateAddressRequest {
    *       advertises IP addresses. Use this parameter to limit the IP address to this location. IP
    *       addresses cannot move between network border groups.</p>
    *          <p>Use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html">DescribeAvailabilityZones</a> to view the network border groups.</p>
-   *          <p>You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic,
-   *       you receive an <code>InvalidParameterCombination</code> error.</p>
    */
   NetworkBorderGroup?: string;
 
@@ -7055,7 +7053,8 @@ export interface CancelConversionRequest {
 export interface CancelExportTaskRequest {
   /**
    * @public
-   * <p>The ID of the export task. This is the ID returned by <code>CreateInstanceExportTask</code>.</p>
+   * <p>The ID of the export task. This is the ID returned by the
+   *     <code>CreateInstanceExportTask</code> and <code>ExportImage</code> operations.</p>
    */
   ExportTaskId: string | undefined;
 }

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

@@ -2340,6 +2340,14 @@ export interface OnDemandOptionsRequest {
   /**
    * @public
    * <p>The maximum amount per hour for On-Demand Instances that you're willing to pay.</p>
+   *          <note>
+   *             <p>If your fleet includes T instances that are configured as <code>unlimited</code>,
+   *             and if their average CPU usage exceeds the baseline utilization, you will incur a charge
+   *             for surplus credits. The <code>MaxTotalPrice</code> does not account for surplus
+   *             credits, and, if you use surplus credits, your final cost might be higher than what you
+   *             specified for <code>MaxTotalPrice</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits">Surplus credits can incur charges</a> in the <i>EC2 User
+   *                   Guide</i>.</p>
+   *          </note>
    */
   MaxTotalPrice?: string;
 }
@@ -2560,6 +2568,14 @@ export interface SpotOptionsRequest {
    *          <important>
    *             <p>If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.</p>
    *          </important>
+   *          <note>
+   *             <p>If your fleet includes T instances that are configured as <code>unlimited</code>,
+   *             and if their average CPU usage exceeds the baseline utilization, you will incur a charge
+   *             for surplus credits. The <code>MaxTotalPrice</code> does not account for surplus
+   *             credits, and, if you use surplus credits, your final cost might be higher than what you
+   *             specified for <code>MaxTotalPrice</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits">Surplus credits can incur charges</a> in the <i>EC2 User
+   *                   Guide</i>.</p>
+   *          </note>
    */
   MaxTotalPrice?: string;
 }
@@ -2772,7 +2788,7 @@ export interface CreateFleetRequest {
   /**
    * @public
    * <p>The key-value pair for tagging the EC2 Fleet request on creation. For more information, see
-   *          <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources">Tagging your resources</a>.</p>
+   *          <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources">Tag your resources</a>.</p>
    *          <p>If the fleet type is <code>instant</code>, specify a resource type of <code>fleet</code>
    *          to tag the fleet or <code>instance</code> to tag the instances at launch.</p>
    *          <p>If the fleet type is <code>maintain</code> or <code>request</code>, specify a resource
@@ -6820,11 +6836,12 @@ export interface LaunchTemplateTagSpecificationRequest {
   /**
    * @public
    * <p>The type of resource to tag.</p>
-   *          <p>The <code>Valid Values</code> are all the resource types that can be tagged. However,
-   *             when creating a launch template, you can specify tags for the following resource types
+   *          <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> |
-   *                 <code>network-interface</code> | <code>spot-instances-request</code>
-   *          </p>
+   *                 <code>network-interface</code> | <code>spot-instances-request</code>.
+   *             If the instance does include the resource type that you specify, the instance
+   *             launch fails. For example, not all instance types include an Elastic GPU.</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 | string;
@@ -7033,7 +7050,19 @@ export interface RequestLaunchTemplateData {
 
   /**
    * @public
-   * <p> The elastic inference accelerator for the instance. </p>
+   * <p>An elastic inference accelerator to associate with the instance. Elastic inference
+   *             accelerators are a resource you can attach to your Amazon EC2 instances to accelerate
+   *             your Deep Learning (DL) inference workloads.</p>
+   *          <p>You cannot specify accelerators from different generations in the same request.</p>
+   *          <note>
+   *             <p>Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon
+   *                 Elastic Inference (EI), and will help current customers migrate their workloads to
+   *                 options that offer better price and performance. After April 15, 2023, new customers
+   *                 will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker,
+   *                 Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during
+   *                 the past 30-day period are considered current customers and will be able to continue
+   *                 using the service.</p>
+   *          </note>
    */
   ElasticInferenceAccelerators?: LaunchTemplateElasticInferenceAccelerator[];
 
@@ -8250,7 +8279,19 @@ export interface ResponseLaunchTemplateData {
 
   /**
    * @public
-   * <p> The elastic inference accelerator for the instance. </p>
+   * <p>An elastic inference accelerator to associate with the instance. Elastic inference
+   *             accelerators are a resource you can attach to your Amazon EC2 instances to accelerate
+   *             your Deep Learning (DL) inference workloads.</p>
+   *          <p>You cannot specify accelerators from different generations in the same request.</p>
+   *          <note>
+   *             <p>Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon
+   *                 Elastic Inference (EI), and will help current customers migrate their workloads to
+   *                 options that offer better price and performance. After April 15, 2023, new customers
+   *                 will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker,
+   *                 Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during
+   *                 the past 30-day period are considered current customers and will be able to continue
+   *                 using the service.</p>
+   *          </note>
    */
   ElasticInferenceAccelerators?: LaunchTemplateElasticInferenceAcceleratorResponse[];