docs(client-ec2): Documentation updates for Amazon EC2.

aws · Jun 14, 2024 · 227e399 · 227e399
1 parent 5d00c7e
commit 227e399
Show file tree

Hide file tree

Showing 82 changed files with 846 additions and 795 deletions.
diff --git a/clients/client-ec2/src/commands/AcceptAddressTransferCommand.ts b/clients/client-ec2/src/commands/AcceptAddressTransferCommand.ts
@@ -28,7 +28,7 @@ export interface AcceptAddressTransferCommandInput extends AcceptAddressTransfer
 export interface AcceptAddressTransferCommandOutput extends AcceptAddressTransferResult, __MetadataBearer {}
 
 /**
- * <p>Accepts an Elastic IP address transfer. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#using-instance-addressing-eips-transfer-accept">Accept a transferred Elastic IP address</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>
+ * <p>Accepts an Elastic IP address transfer. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#using-instance-addressing-eips-transfer-accept">Accept a transferred Elastic IP address</a> in the <i>Amazon VPC 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/AllocateAddressCommand.ts b/clients/client-ec2/src/commands/AllocateAddressCommand.ts
@@ -33,11 +33,11 @@ export interface AllocateAddressCommandOutput extends AllocateAddressResult, __M
  *          pool and can be allocated to a different Amazon Web Services account.</p>
  *          <p>You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created
  *        from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own
- *          IP addresses (BYOIP). For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html">Bring Your Own IP Addresses (BYOIP)</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
+ *          IP addresses (BYOIP). For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html">Bring Your Own IP Addresses (BYOIP)</a> in the <i>Amazon EC2 User Guide</i>.</p>
  *          <p>If you release an Elastic IP address, you might be able to recover it. You cannot recover
  *       an Elastic IP address that you released after it is allocated to another Amazon Web Services account. To attempt to recover an Elastic IP address that you released, specify
  *       it in this operation.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon EC2 User Guide</i>.</p>
  *          <p>You can allocate a carrier IP address which is a public IP address from a telecommunication carrier,
  *        to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).</p>
  * @example

diff --git a/clients/client-ec2/src/commands/AssignIpv6AddressesCommand.ts b/clients/client-ec2/src/commands/AssignIpv6AddressesCommand.ts
@@ -32,13 +32,12 @@ export interface AssignIpv6AddressesCommandOutput extends AssignIpv6AddressesRes
  *             specify one or more specific IPv6 addresses, or you can specify the number of IPv6
  *             addresses to be automatically assigned from within the subnet's IPv6 CIDR block range.
  *             You can assign as many IPv6 addresses to a network interface as you can assign private
- *             IPv4 addresses, and the limit varies per instance type. For information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI">IP Addresses Per Network Interface Per Instance Type</a>
- *             in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
+ *             IPv4 addresses, and the limit varies per instance type.</p>
  *          <p>You must specify either the IPv6 addresses or the IPv6 address count in the request. </p>
  *          <p>You can optionally use Prefix Delegation on the network interface. You must specify
  *             either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For
  *             information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html">
- *                 Assigning prefixes to Amazon EC2 network interfaces</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
+ *                 Assigning prefixes to network interfaces</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/AssignPrivateIpAddressesCommand.ts b/clients/client-ec2/src/commands/AssignPrivateIpAddressesCommand.ts
@@ -32,8 +32,7 @@ export interface AssignPrivateIpAddressesCommandOutput extends AssignPrivateIpAd
  *          <p>You can specify one or more specific secondary IP addresses, or you can specify the number
  *             of secondary IP addresses to be automatically assigned within the subnet's CIDR block range.
  *             The number of secondary IP addresses that you can assign to an instance varies by instance type.
- *             For information about instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about
- *             Elastic IP addresses, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
+ *             For more information about Elastic IP addresses, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon EC2 User Guide</i>.</p>
  *          <p>When you move a secondary private IP address to another network interface, any Elastic IP address
  *             that is associated with the IP address is also moved.</p>
  *          <p>Remapping an IP address is an asynchronous operation. When you move an IP address from one network
@@ -43,7 +42,7 @@ export interface AssignPrivateIpAddressesCommandOutput extends AssignPrivateIpAd
  *          <p>You can optionally use Prefix Delegation on the network interface. You must specify
  *             either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For
  *             information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html">
- *                 Assigning prefixes to Amazon EC2 network interfaces</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
+ *                 Assigning prefixes to network interfaces</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/AssignPrivateNatGatewayAddressCommand.ts b/clients/client-ec2/src/commands/AssignPrivateNatGatewayAddressCommand.ts
@@ -33,7 +33,7 @@ export interface AssignPrivateNatGatewayAddressCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Assigns one or more private IPv4 addresses to a private NAT gateway. For more information, see
+ * <p>Assigns private IPv4 addresses to a private 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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-ec2/src/commands/AssociateDhcpOptionsCommand.ts b/clients/client-ec2/src/commands/AssociateDhcpOptionsCommand.ts
@@ -30,7 +30,7 @@ export interface AssociateDhcpOptionsCommandOutput extends __MetadataBearer {}
 /**
  * <p>Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.</p>
  *          <p>After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP options sets</a>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP option sets</a>
  *           in the <i>Amazon VPC User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-ec2/src/commands/AssociateNatGatewayAddressCommand.ts b/clients/client-ec2/src/commands/AssociateNatGatewayAddressCommand.ts
@@ -30,7 +30,8 @@ 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>
+ *          <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>

diff --git a/clients/client-ec2/src/commands/AssociateTrunkInterfaceCommand.ts b/clients/client-ec2/src/commands/AssociateTrunkInterfaceCommand.ts
@@ -29,8 +29,10 @@ export interface AssociateTrunkInterfaceCommandOutput extends AssociateTrunkInte
 
 /**
  * <p>Associates a branch network interface with a trunk network interface.</p>
- *          <p>Before you create the association, run the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html">create-network-interface</a> command and set
- *             <code>--interface-type</code> to <code>trunk</code>. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.</p>
+ *          <p>Before you create the association, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html">CreateNetworkInterface</a> command and set the interface type
+ *             to <code>trunk</code>. You must also create a network interface for
+ *             each branch network interface that you want to associate with the trunk
+ *             network interface.</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/AssociateVpcCidrBlockCommand.ts b/clients/client-ec2/src/commands/AssociateVpcCidrBlockCommand.ts
@@ -30,7 +30,7 @@ export interface AssociateVpcCidrBlockCommandOutput extends AssociateVpcCidrBloc
 /**
  * <p>Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block,
  *             an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that
- *             you provisioned through bring your own IP addresses (<a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html">BYOIP</a>). </p>
+ *             you provisioned through bring your own IP addresses (<a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html">BYOIP</a>).</p>
  *          <p>You must specify one of the following in the request: an IPv4 CIDR block, an IPv6
  *             pool, or an Amazon-provided IPv6 CIDR block.</p>
  *          <p>For more information about associating CIDR blocks with your VPC and applicable

diff --git a/clients/client-ec2/src/commands/CancelReservedInstancesListingCommand.ts b/clients/client-ec2/src/commands/CancelReservedInstancesListingCommand.ts
@@ -34,9 +34,8 @@ export interface CancelReservedInstancesListingCommandOutput
 
 /**
  * <p>Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.</p>
- *          <p>For more information, see
- *         <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a>
- *         in the <i>Amazon EC2 User Guide</i>.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Sell in the Reserved Instance
+ *         Marketplace</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/CopySnapshotCommand.ts b/clients/client-ec2/src/commands/CopySnapshotCommand.ts
@@ -36,8 +36,8 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
  *          <p>You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).</p>
  *          <p>When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted.
  *     	Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the
- *     	snapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS)
- *     	KMS key; however, you can specify a different KMS key. To copy an encrypted
+ *     	snapshot copy operation. By default, encrypted snapshot copies use the default KMS key;
+ *     	however, you can specify a different KMS key. To copy an encrypted
  *     	snapshot that has been shared from another account, you must have permissions for the KMS key
  *     	used to encrypt the snapshot.</p>
  *          <p>Snapshots copied to an Outpost are encrypted by default using the default

diff --git a/clients/client-ec2/src/commands/CreateCapacityReservationFleetCommand.ts b/clients/client-ec2/src/commands/CreateCapacityReservationFleetCommand.ts
@@ -33,8 +33,9 @@ export interface CreateCapacityReservationFleetCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Creates a Capacity Reservation Fleet. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-cr-fleets.html#create-crfleet">Create a Capacity
- * 			Reservation Fleet</a> in the Amazon EC2 User Guide.</p>
+ * <p>Creates a Capacity Reservation Fleet. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-cr-fleets.html#create-crfleet">Create a
+ * 				Capacity Reservation Fleet</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/CreateDhcpOptionsCommand.ts b/clients/client-ec2/src/commands/CreateDhcpOptionsCommand.ts
@@ -32,7 +32,7 @@ export interface CreateDhcpOptionsCommandOutput extends CreateDhcpOptionsResult,
  * 	       it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly
  * 	       launched instances in the VPC use this set of DHCP options.</p>
  *          <p>The following are the individual DHCP options you can specify. For more information, see
- *            <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP options sets</a>
+ *            <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP option sets</a>
  *            in the <i>Amazon VPC User Guide</i>.</p>
  *          <ul>
  *             <li>
@@ -69,7 +69,7 @@ export interface CreateDhcpOptionsCommandOutput extends CreateDhcpOptionsResult,
  *                <p>
  *                   <code>netbios-node-type</code> - The NetBIOS node type (1, 2, 4, or 8). We recommend that
  *                    you specify 2. Broadcast and multicast are not supported. For more information about
- *                    NetBIOS node types, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>.</p>
+ *                    NetBIOS node types, see <a href="https://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>.</p>
  *             </li>
  *             <li>
  *                <p>

diff --git a/clients/client-ec2/src/commands/CreateFlowLogsCommand.ts b/clients/client-ec2/src/commands/CreateFlowLogsCommand.ts
@@ -33,12 +33,13 @@ export interface CreateFlowLogsCommandOutput extends CreateFlowLogsResult, __Met
  *          <p>Flow log data for a monitored network interface is recorded as flow log records, which are log events
  *             consisting of fields that describe the traffic flow. For more information, see
  *             <a href="https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records">Flow log records</a>
- *             in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>
+ *             in the <i>Amazon VPC User Guide</i>.</p>
  *          <p>When publishing to CloudWatch Logs, flow log records are published to a log group, and each network
  *             interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all
  *             of the monitored network interfaces are published to a single log file object that is stored in the specified
  *             bucket.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html">VPC Flow Logs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html">VPC Flow Logs</a>
+ *             in the <i>Amazon VPC 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/CreateInstanceConnectEndpointCommand.ts b/clients/client-ec2/src/commands/CreateInstanceConnectEndpointCommand.ts
@@ -33,8 +33,7 @@ export interface CreateInstanceConnectEndpointCommandOutput
  * <p>Creates an EC2 Instance Connect Endpoint.</p>
  *          <p>An EC2 Instance Connect Endpoint allows you to connect to an instance, without
  *             requiring the instance to have a public IPv4 address. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Connect-using-EC2-Instance-Connect-Endpoint.html">Connect to your instances without requiring a public IPv4 address using EC2
- *                 Instance Connect Endpoint</a> in the <i>Amazon EC2 User
- *             Guide</i>.</p>
+ *                 Instance Connect Endpoint</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/CreateLaunchTemplateCommand.ts b/clients/client-ec2/src/commands/CreateLaunchTemplateCommand.ts
@@ -37,11 +37,11 @@ export interface CreateLaunchTemplateCommandOutput extends CreateLaunchTemplateR
  *             instance using <a>RunInstances</a>, you can specify a launch template instead
  *             of providing the launch parameters in the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html">Launch
  *                 an instance from a launch template</a> in the
- *                 <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
+ *                 <i>Amazon EC2 User Guide</i>.</p>
  *          <p>To clone an existing launch template as the basis for a new launch template, use the
  *             Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more
  *             information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template-from-existing-launch-template">Create a launch template from an existing launch template</a> in the
- *                 <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
+ *                 <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/CreateLaunchTemplateVersionCommand.ts b/clients/client-ec2/src/commands/CreateLaunchTemplateVersionCommand.ts
@@ -42,7 +42,7 @@ export interface CreateLaunchTemplateVersionCommandOutput extends CreateLaunchTe
  *             it. Instead, you can create a new version of the launch template that includes the
  *             changes that you require.</p>
  *          <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#manage-launch-template-versions">Modify a launch template (manage launch template versions)</a> in the
- *                 <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
+ *                 <i>Amazon EC2 User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript