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

awstools · awstools · commit 08bd27c46fa8 · 2024-04-17T18:35:29.000Z
diff --git a/clients/client-ec2/src/commands/CancelSpotFleetRequestsCommand.ts b/clients/client-ec2/src/commands/CancelSpotFleetRequestsCommand.ts
@@ -34,6 +34,15 @@ export interface CancelSpotFleetRequestsCommandOutput extends CancelSpotFleetReq
  *                 <code>cancelled_terminating</code> state. Otherwise, the Spot Fleet request enters
  *             the <code>cancelled_running</code> state and the instances continue to run until they
  *             are interrupted or you terminate them manually.</p>
+ *          <p class="title">
+ *             <b>Restrictions</b>
+ *          </p>
+ *          <ul>
+ *             <li>
+ *                <p>You can delete up to 100 fleets in a single request. If you exceed the specified
+ *                number, no fleets are deleted.</p>
+ *             </li>
+ *          </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-ec2/src/commands/DeleteFleetsCommand.ts b/clients/client-ec2/src/commands/DeleteFleetsCommand.ts
@@ -34,21 +34,28 @@ export interface DeleteFleetsCommandOutput extends DeleteFleetsResult, __Metadat
  *          state. Otherwise, the EC2 Fleet enters the <code>deleted_running</code> state, and the instances
  *          continue to run until they are interrupted or you terminate them manually.</p>
  *          <p>For <code>instant</code> fleets, EC2 Fleet must terminate the instances when the fleet is
- *          deleted. A deleted <code>instant</code> fleet with running instances is not
- *          supported.</p>
+ *          deleted. Up to 1000 instances can be terminated in a single request to delete
+ *             <code>instant</code> fleets. A deleted <code>instant</code> fleet with running instances
+ *          is not supported.</p>
  *          <p class="title">
  *             <b>Restrictions</b>
  *          </p>
  *          <ul>
  *             <li>
- *                <p>You can delete up to 25 <code>instant</code> fleets in a single request. If you exceed this
- *                number, no <code>instant</code> fleets are deleted and an error is returned. There is no
- *                restriction on the number of fleets of type <code>maintain</code> or <code>request</code> that can be deleted
- *                in a single request.</p>
+ *                <p>You can delete up to 25 fleets of type <code>instant</code> in a single
+ *                request.</p>
  *             </li>
  *             <li>
- *                <p>Up to 1000 instances can be terminated in a single request to delete
- *                <code>instant</code> fleets.</p>
+ *                <p>You can delete up to 100 fleets of type <code>maintain</code> or
+ *                   <code>request</code> in a single request.</p>
+ *             </li>
+ *             <li>
+ *                <p>You can delete up to 125 fleets in a single request, provided you do not exceed
+ *                the quota for each fleet type, as specified above.</p>
+ *             </li>
+ *             <li>
+ *                <p>If you exceed the specified number of fleets to delete, no fleets are
+ *                deleted.</p>
  *             </li>
  *          </ul>
  *          <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#delete-fleet">Delete an EC2
diff --git a/clients/client-ec2/src/commands/DescribeInstanceTypeOfferingsCommand.ts b/clients/client-ec2/src/commands/DescribeInstanceTypeOfferingsCommand.ts
@@ -29,8 +29,8 @@ export interface DescribeInstanceTypeOfferingsCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Returns a list of all instance types offered. The results can be filtered by location (Region or Availability
- *    Zone). If no location is specified, the instance types offered in the current Region are returned.</p>
+ * <p>Lists the instance types that are offered for the specified location. If no location is specified, the default
+ *    is to list the instance types that are offered in the current Region.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-ec2/src/commands/DescribeInstanceTypesCommand.ts b/clients/client-ec2/src/commands/DescribeInstanceTypesCommand.ts
@@ -27,8 +27,8 @@ export interface DescribeInstanceTypesCommandInput extends DescribeInstanceTypes
 export interface DescribeInstanceTypesCommandOutput extends DescribeInstanceTypesResult, __MetadataBearer {}
 
 /**
- * <p>Describes the details of the instance types that are offered in a location. The results can be filtered by the
- *    attributes of the instance types.</p>
+ * <p>Describes the specified instance types. By default, all instance types for the current Region are described.
+ *     Alternatively, you can filter the results.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-ec2/src/commands/GetConsoleScreenshotCommand.ts b/clients/client-ec2/src/commands/GetConsoleScreenshotCommand.ts
@@ -30,6 +30,7 @@ export interface GetConsoleScreenshotCommandOutput extends GetConsoleScreenshotR
  * <p>Retrieve a JPG-format screenshot of a running instance to help with
  *             troubleshooting.</p>
  *          <p>The returned content is Base64-encoded.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/troubleshoot-unreachable-instance.html#instance-console-console-output">Instance console output</a> in the <i>Amazon EC2 User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-ec2/src/commands/ModifyInstanceMetadataDefaultsCommand.ts b/clients/client-ec2/src/commands/ModifyInstanceMetadataDefaultsCommand.ts
@@ -36,8 +36,9 @@ export interface ModifyInstanceMetadataDefaultsCommandOutput
  *             the specified Amazon Web Services  Region.</p>
  *          <note>
  *             <p>To remove a parameter's account-level default setting, specify
- *                     <code>no-preference</code>. At instance launch, the value will come from the
- *                 AMI, or from the launch parameter if specified. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence">Order of precedence for instance metadata options</a> in the
+ *                     <code>no-preference</code>. If an account-level setting is cleared with
+ *                     <code>no-preference</code>, then the instance launch considers the other
+ *                 instance metadata settings. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence">Order of precedence for instance metadata options</a> in the
  *                     <i>Amazon EC2 User Guide</i>.</p>
  *          </note>
  * @example
diff --git a/clients/client-ec2/src/models/models_0.ts b/clients/client-ec2/src/models/models_0.ts
@@ -7527,6 +7527,7 @@ export interface CancelSpotFleetRequestsRequest {
 
   /**
    * <p>The IDs of the Spot Fleet requests.</p>
+   *          <p>Constraint: You can specify up to 100 IDs in a single request.</p>
    * @public
    */
   SpotFleetRequestIds: string[] | undefined;
diff --git a/clients/client-ec2/src/models/models_1.ts b/clients/client-ec2/src/models/models_1.ts
@@ -3761,14 +3761,14 @@ export interface CreateFleetError {
 
   /**
    * <p>The error code that indicates why the instance could not be launched. For more
-   *          information about error codes, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html">Error codes</a>.</p>
+   *          information about error codes, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html">Error codes</a>.</p>
    * @public
    */
   ErrorCode?: string;
 
   /**
    * <p>The error message that describes why the instance could not be launched. For more
-   *          information about error messages, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html">Error codes</a>.</p>
+   *          information about error messages, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html">Error codes</a>.</p>
    * @public
    */
   ErrorMessage?: string;
@@ -7357,8 +7357,7 @@ export interface RequestLaunchTemplateData {
   BlockDeviceMappings?: LaunchTemplateBlockDeviceMappingRequest[];
 
   /**
-   * <p>One or more network interfaces. If you specify a network interface, you must specify
-   *             any security groups and subnets as part of the network interface.</p>
+   * <p>The network interfaces for the instance.</p>
    * @public
    */
   NetworkInterfaces?: LaunchTemplateInstanceNetworkInterfaceSpecificationRequest[];
@@ -7513,14 +7512,18 @@ export interface RequestLaunchTemplateData {
   ElasticInferenceAccelerators?: LaunchTemplateElasticInferenceAccelerator[];
 
   /**
-   * <p>One or more security group IDs. You can create a security group using <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html">CreateSecurityGroup</a>.</p>
+   * <p>The IDs of the security groups.</p>
+   *          <p>If you specify a network interface, you must specify any security groups as part of
+   *             the network interface instead of using this parameter.</p>
    * @public
    */
   SecurityGroupIds?: string[];
 
   /**
-   * <p>One or more security group names. For a nondefault VPC, you must use security group
+   * <p>The names of the security groups. For a nondefault VPC, you must use security group
    *             IDs instead.</p>
+   *          <p>If you specify a network interface, you must specify any security groups as part of
+   *             the network interface instead of using this parameter.</p>
    * @public
    */
   SecurityGroups?: string[];
diff --git a/clients/client-ec2/src/models/models_2.ts b/clients/client-ec2/src/models/models_2.ts
@@ -8237,6 +8237,8 @@ export interface DeleteFleetsRequest {
 
   /**
    * <p>The IDs of the EC2 Fleets.</p>
+   *          <p>Constraints: In a single request, you can specify up to 25 <code>instant</code> fleet
+   *          IDs and up to 100 <code>maintain</code> or <code>request</code> fleet IDs. </p>
    * @public
    */
   FleetIds: string[] | undefined;
diff --git a/clients/client-ec2/src/models/models_4.ts b/clients/client-ec2/src/models/models_4.ts
@@ -3347,6 +3347,27 @@ export interface DescribeInstanceTypeOfferingsRequest {
 
   /**
    * <p>The location type.</p>
+   *          <ul>
+   *             <li>
+   *                <p>
+   *                   <code>availability-zone</code> - The Availability Zone. When you specify a location filter, it must be
+   *      an Availability Zone for the current Region.</p>
+   *             </li>
+   *             <li>
+   *                <p>
+   *                   <code>availability-zone-id</code> - The AZ ID. When you specify a location filter, it must be
+   *     an AZ ID for the current Region.</p>
+   *             </li>
+   *             <li>
+   *                <p>
+   *                   <code>outpost</code> - The Outpost ARN. When you specify a location filter, it must be an Outpost ARN
+   *     for the current Region.</p>
+   *             </li>
+   *             <li>
+   *                <p>
+   *                   <code>region</code> - The current Region. If you specify a location filter, it must match the current Region.</p>
+   *             </li>
+   *          </ul>
    * @public
    */
   LocationType?: LocationType;
@@ -3356,13 +3377,12 @@ export interface DescribeInstanceTypeOfferingsRequest {
    *          <ul>
    *             <li>
    *                <p>
-   *                   <code>location</code> - This depends on the location type. For example, if the location type is
-   *       <code>region</code> (default), the location is the Region code (for example, <code>us-east-2</code>.)</p>
+   *                   <code>instance-type</code> - The instance type. For a list of possible values, see
+   *      <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Instance.html">Instance</a>.</p>
    *             </li>
    *             <li>
    *                <p>
-   *                   <code>instance-type</code> - The instance type. For example,
-   *      <code>c5.2xlarge</code>.</p>
+   *                   <code>location</code> - The location. For a list of possible identifiers, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html">Regions and Zones</a>.</p>
    *             </li>
    *          </ul>
    * @public
@@ -3414,7 +3434,7 @@ export interface InstanceTypeOffering {
  */
 export interface DescribeInstanceTypeOfferingsResult {
   /**
-   * <p>The instance types offered.</p>
+   * <p>The instance types offered in the location.</p>
    * @public
    */
   InstanceTypeOfferings?: InstanceTypeOffering[];
@@ -3440,7 +3460,7 @@ export interface DescribeInstanceTypesRequest {
   DryRun?: boolean;
 
   /**
-   * <p>The instance types. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance types</a> in the <i>Amazon EC2 User Guide</i>.</p>
+   * <p>The instance types.</p>
    * @public
    */
   InstanceTypes?: _InstanceType[];
@@ -4813,7 +4833,7 @@ export interface InstanceTypeInfo {
  */
 export interface DescribeInstanceTypesResult {
   /**
-   * <p>The instance type. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance types</a> in the <i>Amazon EC2 User Guide</i>.</p>
+   * <p>The instance type.</p>
    * @public
    */
   InstanceTypes?: InstanceTypeInfo[];
@@ -11296,6 +11316,8 @@ export interface SpotFleetTagSpecification {
 export interface SpotFleetLaunchSpecification {
   /**
    * <p>The security groups.</p>
+   *          <p>If you specify a network interface, you must specify any security groups as part of
+   *         the network interface instead of using this parameter.</p>
    * @public
    */
   SecurityGroups?: GroupIdentifier[];
@@ -11360,11 +11382,11 @@ export interface SpotFleetLaunchSpecification {
   Monitoring?: SpotFleetMonitoring;
 
   /**
-   * <p>One or more network interfaces. If you specify a network interface, you must specify
-   *           subnet IDs and security group IDs using the network interface.</p>
+   * <p>The network interfaces.</p>
    *          <note>
    *             <p>
-   *                <code>SpotFleetLaunchSpecification</code> currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateConfig.html">LaunchTemplateConfig</a>.</p>
+   *                <code>SpotFleetLaunchSpecification</code> does not support Elastic Fabric Adapter (EFA).
+   *              You must use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateConfig.html">LaunchTemplateConfig</a> instead.</p>
    *          </note>
    * @public
    */
@@ -11396,7 +11418,9 @@ export interface SpotFleetLaunchSpecification {
 
   /**
    * <p>The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate
-   *           them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".</p>
+   *          them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".</p>
+   *          <p>If you specify a network interface, you must specify any subnets as part of the
+   *          network interface instead of using this parameter.</p>
    * @public
    */
   SubnetId?: string;
diff --git a/clients/client-ec2/src/models/models_6.ts b/clients/client-ec2/src/models/models_6.ts
@@ -5519,11 +5519,10 @@ export interface ModifyInstanceMetadataDefaultsRequest {
   HttpTokens?: MetadataDefaultHttpTokensState;
 
   /**
-   * <p>The maximum number of hops that the metadata token can travel.</p>
-   *          <p>Minimum: <code>1</code>
-   *          </p>
-   *          <p>Maximum: <code>64</code>
-   *          </p>
+   * <p>The maximum number of hops that the metadata token can travel. To indicate no
+   *             preference, specify <code>-1</code>.</p>
+   *          <p>Possible values: Integers from <code>1</code> to <code>64</code>, and <code>-1</code>
+   *             to indicate no preference</p>
    * @public
    */
   HttpPutResponseHopLimit?: number;
diff --git a/clients/client-ec2/src/models/models_7.ts b/clients/client-ec2/src/models/models_7.ts
@@ -2897,15 +2897,15 @@ export interface RunInstancesRequest {
   /**
    * <p>The IDs of the security groups. You can create a security group using <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html">CreateSecurityGroup</a>.</p>
    *          <p>If you specify a network interface, you must specify any security groups as part of
-   *             the network interface.</p>
+   *             the network interface instead of using this parameter.</p>
    * @public
    */
   SecurityGroupIds?: string[];
 
   /**
    * <p>[Default VPC] The names of the security groups.</p>
    *          <p>If you specify a network interface, you must specify any security groups as part of
-   *             the network interface.</p>
+   *             the network interface instead of using this parameter.</p>
    *          <p>Default: Amazon EC2 uses the default security group.</p>
    * @public
    */
@@ -2914,7 +2914,7 @@ export interface RunInstancesRequest {
   /**
    * <p>The ID of the subnet to launch the instance into.</p>
    *          <p>If you specify a network interface, you must specify any subnets as part of the
-   *             network interface.</p>
+   *             network interface instead of using this parameter.</p>
    * @public
    */
   SubnetId?: string;
@@ -2996,9 +2996,7 @@ export interface RunInstancesRequest {
   InstanceInitiatedShutdownBehavior?: ShutdownBehavior;
 
   /**
-   * <p>The network interfaces to associate with the instance. If you specify a network
-   *             interface, you must specify any security groups and subnets as part of the network
-   *             interface.</p>
+   * <p>The network interfaces to associate with the instance.</p>
    * @public
    */
   NetworkInterfaces?: InstanceNetworkInterfaceSpecification[];
@@ -3017,29 +3015,19 @@ export interface RunInstancesRequest {
   PrivateIpAddress?: string;
 
   /**
-   * <p>Deprecated.</p>
+   * <p>An elastic GPU to associate with the instance.</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>
+   *             <p>Amazon Elastic Graphics reached end of life on January 8, 2024.</p>
    *          </note>
    * @public
    */
   ElasticGpuSpecification?: ElasticGpuSpecification[];
 
   /**
-   * <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>
+   * <p>An elastic inference accelerator to associate with the instance.</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>
+   *             <p>Amazon Elastic Inference (EI) is no longer available to new customers. For more
+   *             information, see <a href="http://aws.amazon.com/machine-learning/elastic-inference/faqs/">Amazon Elastic Inference FAQs</a>.</p>
    *          </note>
    * @public
    */
@@ -3909,7 +3897,8 @@ export interface SearchTransitGatewayRoutesRequest {
   Filters: Filter[] | undefined;
 
   /**
-   * <p>The maximum number of routes to return.</p>
+   * <p>The maximum number of routes to return. If a value is not provided, the default is
+   *          1000.</p>
    * @public
    */
   MaxResults?: number;
diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json
