docs(client-ec2): Amazon EC2 documentation updates.

aws · Jul 19, 2023 · ae29cc2 · ae29cc2
1 parent 99e559f
commit ae29cc2
Show file tree

Hide file tree

Showing 65 changed files with 495 additions and 485 deletions.
diff --git a/clients/client-ec2/src/commands/AssignPrivateNatGatewayAddressCommand.ts b/clients/client-ec2/src/commands/AssignPrivateNatGatewayAddressCommand.ts
@@ -41,7 +41,8 @@ export interface AssignPrivateNatGatewayAddressCommandOutput
 
 /**
  * @public
- * <p>Assigns one or more 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 Virtual Private Cloud User Guide</i>.</p>
+ * <p>Assigns one or more 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.
  * ```javascript

diff --git a/clients/client-ec2/src/commands/AssociateDhcpOptionsCommand.ts b/clients/client-ec2/src/commands/AssociateDhcpOptionsCommand.ts
@@ -39,7 +39,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>
- *           in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>
+ *           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/AssociateNatGatewayAddressCommand.ts b/clients/client-ec2/src/commands/AssociateNatGatewayAddressCommand.ts
@@ -36,8 +36,9 @@ export interface AssociateNatGatewayAddressCommandOutput extends AssociateNatGat
 
 /**
  * @public
- * <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 Virtual Private Cloud 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 Virtual Private Cloud User Guide</i>.</p>
+ * <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>
  * @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/AssociateRouteTableCommand.ts b/clients/client-ec2/src/commands/AssociateRouteTableCommand.ts
@@ -42,7 +42,7 @@ export interface AssociateRouteTableCommandOutput extends AssociateRouteTableRes
  *             action returns an association ID, which you need in order to disassociate the route
  *             table later. A route table can be associated with multiple subnets.</p>
  *          <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html">Route tables</a> in the
- *                 <i>Amazon Virtual Private Cloud User Guide</i>.</p>
+ *                 <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/AssociateVpcCidrBlockCommand.ts b/clients/client-ec2/src/commands/AssociateVpcCidrBlockCommand.ts
@@ -43,8 +43,8 @@ export interface AssociateVpcCidrBlockCommandOutput extends AssociateVpcCidrBloc
  *          <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
- *             restrictions, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#VPC_Sizing">VPC and subnet sizing</a> in the
- *                 <i>Amazon Virtual Private Cloud User Guide</i>.</p>
+ *             restrictions, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-ip-addressing.html">IP addressing for your VPCs and subnets</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/AttachClassicLinkVpcCommand.ts b/clients/client-ec2/src/commands/AttachClassicLinkVpcCommand.ts
@@ -37,9 +37,9 @@ export interface AttachClassicLinkVpcCommandOutput extends AttachClassicLinkVpcR
 /**
  * @public
  * <note>
- *             <p>We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html">Migrate from EC2-Classic to a VPC</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
+ *             <p>This action is deprecated.</p>
  *          </note>
- *          <p>Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's
+ *          <p>Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC
  * 			security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You
  * 			can only link an instance that's in the <code>running</code> state. An instance is
  * 			automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when

diff --git a/clients/client-ec2/src/commands/AttachInternetGatewayCommand.ts b/clients/client-ec2/src/commands/AttachInternetGatewayCommand.ts
@@ -36,8 +36,9 @@ export interface AttachInternetGatewayCommandOutput extends __MetadataBearer {}
 
 /**
  * @public
- * <p>Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and
- * 			the VPC. For more information about your VPC and internet gateway, see the <a href="https://docs.aws.amazon.com/vpc/latest/userguide/">Amazon Virtual Private Cloud User Guide</a>.</p>
+ * <p>Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity
+ * 		        between the internet and the VPC. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html">Internet 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.
  * ```javascript

diff --git a/clients/client-ec2/src/commands/AuthorizeSecurityGroupEgressCommand.ts b/clients/client-ec2/src/commands/AuthorizeSecurityGroupEgressCommand.ts
@@ -38,7 +38,7 @@ export interface AuthorizeSecurityGroupEgressCommandOutput
 
 /**
  * @public
- * <p>[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.</p>
+ * <p>Adds the specified outbound (egress) rules to a security group for use with a VPC.</p>
  *          <p>An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR
  *             address ranges, or to the instances that are associated with the specified source
  *             security groups. When specifying an outbound rule for your security group in a VPC, the

diff --git a/clients/client-ec2/src/commands/AuthorizeSecurityGroupIngressCommand.ts b/clients/client-ec2/src/commands/AuthorizeSecurityGroupIngressCommand.ts
@@ -50,9 +50,6 @@ export interface AuthorizeSecurityGroupIngressCommandOutput
  *          <p>Rule changes are propagated to instances within the security group as quickly as possible.
  *          However, a small delay might occur.</p>
  *          <p>For more information about VPC security group quotas, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html">Amazon VPC quotas</a>.</p>
- *          <note>
- *             <p>We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html">Migrate from EC2-Classic to a VPC</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
- *          </note>
  * @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/CreateDefaultSubnetCommand.ts b/clients/client-ec2/src/commands/CreateDefaultSubnetCommand.ts
@@ -38,8 +38,8 @@ export interface CreateDefaultSubnetCommandOutput extends CreateDefaultSubnetRes
  * @public
  * <p>Creates a default subnet with a size <code>/20</code> IPv4 CIDR block in the
  *             specified Availability Zone in your default VPC. You can have only one default subnet
- *             per Availability Zone. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html#create-default-subnet">Creating a default
- *                 subnet</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>
+ *             per Availability Zone. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html#create-default-subnet">Create a default
+ *                 subnet</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/CreateDefaultVpcCommand.ts b/clients/client-ec2/src/commands/CreateDefaultVpcCommand.ts
@@ -38,19 +38,11 @@ export interface CreateDefaultVpcCommandOutput extends CreateDefaultVpcResult, _
  * @public
  * <p>Creates a default VPC with a size <code>/16</code> IPv4 CIDR block and a default subnet
  * 			in each Availability Zone. For more information about the components of a default VPC,
- * 			see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html">Default VPC and
- * 			default subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. You cannot
- * 			specify the components of the default VPC yourself.</p>
+ * 			see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html">Default VPCs</a>
+ * 		    in the <i>Amazon VPC User Guide</i>. You cannot specify the components of the
+ * 		    default VPC yourself.</p>
  *          <p>If you deleted your previous default VPC, you can create a default VPC. You cannot have
  * 			more than one default VPC per Region.</p>
- *          <p>If your account supports EC2-Classic, you cannot use this action to create a default VPC
- * 			in a Region that supports EC2-Classic. If you want a default VPC in a Region that
- * 			supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is
- * 			that possible?" in the <a href="http://aws.amazon.com/vpc/faqs/#Default_VPCs">Default VPCs
- * 			FAQ</a>.</p>
- *          <note>
- *             <p>We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html">Migrate from EC2-Classic to a VPC</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
- *          </note>
  * @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
@@ -87,7 +87,7 @@ export interface CreateDhcpOptionsCommandOutput extends CreateDhcpOptionsResult,
  * 			VPC has an internet gateway, make sure to set the <code>domain-name-servers</code>
  * 			option either to <code>AmazonProvidedDNS</code> or to a domain name server of your
  * 			choice. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP options sets</a> in the
- * 			<i>Amazon Virtual Private Cloud User Guide</i>.</p>
+ * 			<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/CreateImageCommand.ts b/clients/client-ec2/src/commands/CreateImageCommand.ts
@@ -38,16 +38,6 @@ export interface CreateImageCommandOutput extends CreateImageResult, __MetadataB
  * @public
  * <p>Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance
  *      	that is either running or stopped.</p>
- *          <p>By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can
- * 					take snapshots of the attached volumes while data is at rest, in order to ensure a consistent
- * 					state. You can set the <code>NoReboot</code> parameter to <code>true</code> in the API request,
- * 					or use the <code>--no-reboot</code> option in the CLI to prevent Amazon EC2 from shutting down and
- * 					rebooting the instance.</p>
- *          <important>
- *             <p>If you choose to bypass the shutdown and reboot process by setting the <code>NoReboot</code>
- * 					parameter to <code>true</code> in the API request, or by using the <code>--no-reboot</code> option
- * 					in the CLI, we can't guarantee the file system integrity of the created image.</p>
- *          </important>
  *          <p>If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the
  *      	new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI,
  *      	the instance automatically launches with those additional volumes.</p>

diff --git a/clients/client-ec2/src/commands/CreateInstanceConnectEndpointCommand.ts b/clients/client-ec2/src/commands/CreateInstanceConnectEndpointCommand.ts
@@ -39,8 +39,8 @@ export interface CreateInstanceConnectEndpointCommandOutput
 /**
  * @public
  * <p>Creates an EC2 Instance Connect Endpoint.</p>
- *          <p>An EC2 Instance Connect Endpoint allows you to connect to a resource, without
- *             requiring the resource 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 resources without requiring a public IPv4 address using EC2
+ *          <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>
  * @example

diff --git a/clients/client-ec2/src/commands/CreateInstanceExportTaskCommand.ts b/clients/client-ec2/src/commands/CreateInstanceExportTaskCommand.ts
@@ -37,9 +37,9 @@ export interface CreateInstanceExportTaskCommandOutput extends CreateInstanceExp
 /**
  * @public
  * <p>Exports a running or stopped instance to an Amazon S3 bucket.</p>
- *          <p>For information about the supported operating systems, image formats, and known limitations
- *    for the types of instances you can export, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport.html">Exporting an instance as a VM Using VM Import/Export</a>
- *    in the <i>VM Import/Export User Guide</i>.</p>
+ *          <p>For information about the prerequisites for your Amazon S3 bucket, supported operating systems,
+ *    image formats, and known limitations for the types of instances you can export, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport.html">Exporting an instance as a VM Using VM
+ *     Import/Export</a> in the <i>VM Import/Export 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/CreateInternetGatewayCommand.ts b/clients/client-ec2/src/commands/CreateInternetGatewayCommand.ts
@@ -38,7 +38,8 @@ export interface CreateInternetGatewayCommandOutput extends CreateInternetGatewa
  * @public
  * <p>Creates an internet gateway for use with a VPC. After creating the internet gateway,
  * 			you attach it to a VPC using <a>AttachInternetGateway</a>.</p>
- *          <p>For more information about your VPC and internet gateway, see the <a href="https://docs.aws.amazon.com/vpc/latest/userguide/">Amazon Virtual Private Cloud User Guide</a>.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html">Internet 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.
  * ```javascript

diff --git a/clients/client-ec2/src/commands/CreateNatGatewayCommand.ts b/clients/client-ec2/src/commands/CreateNatGatewayCommand.ts
@@ -45,7 +45,7 @@ export interface CreateNatGatewayCommandOutput extends CreateNatGatewayResult, _
  *             networks through a transit gateway or virtual private gateway. Common use cases include
  *             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 Virtual Private Cloud User Guide</i>.</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>
  * @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/CreateNetworkAclCommand.ts b/clients/client-ec2/src/commands/CreateNetworkAclCommand.ts
@@ -37,8 +37,8 @@ export interface CreateNetworkAclCommandOutput extends CreateNetworkAclResult, _
 /**
  * @public
  * <p>Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_ACLs.html">Network ACLs</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/vpc-network-acls.html">Network ACLs</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/CreateNetworkAclEntryCommand.ts b/clients/client-ec2/src/commands/CreateNetworkAclEntryCommand.ts
@@ -43,7 +43,8 @@ export interface CreateNetworkAclEntryCommandOutput extends __MetadataBearer {}
  *          <p>We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the
  * 		        other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.</p>
  *          <p>After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.</p>
- *          <p>For more information about network ACLs, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>
+ *          <p>For more information about network ACLs, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html">Network ACLs</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/CreateRouteCommand.ts b/clients/client-ec2/src/commands/CreateRouteCommand.ts
@@ -56,7 +56,7 @@ export interface CreateRouteCommandOutput extends CreateRouteResult, __MetadataB
  * 				in the list covers a smaller number of IP addresses and is therefore more specific,
  * 				so we use that route to determine where to target the traffic.</p>
  *          <p>For more information about route tables, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html">Route tables</a> in the
- *          <i>Amazon Virtual Private Cloud User Guide</i>.</p>
+ *          <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/CreateRouteTableCommand.ts b/clients/client-ec2/src/commands/CreateRouteTableCommand.ts
@@ -38,7 +38,7 @@ export interface CreateRouteTableCommandOutput extends CreateRouteTableResult, _
  * @public
  * <p>Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.</p>
  *          <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html">Route tables</a> in the
- * 				<i>Amazon Virtual Private Cloud User Guide</i>.</p>
+ * 				<i>Amazon VPC User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript