Skip to content

Commit 227e399

Browse files
author
awstools
committed
docs(client-ec2): Documentation updates for Amazon EC2.
1 parent 5d00c7e commit 227e399

File tree

82 files changed

+846
-795
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+846
-795
lines changed

‎clients/client-ec2/src/commands/AcceptAddressTransferCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface AcceptAddressTransferCommandInput extends AcceptAddressTransfer
2828
export interface AcceptAddressTransferCommandOutput extends AcceptAddressTransferResult, __MetadataBearer {}
2929

3030
/**
31-
* <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>
31+
* <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>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

‎clients/client-ec2/src/commands/AllocateAddressCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ export interface AllocateAddressCommandOutput extends AllocateAddressResult, __M
3333
* pool and can be allocated to a different Amazon Web Services account.</p>
3434
* <p>You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created
3535
* 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
36-
* 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>
36+
* 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>
3737
* <p>If you release an Elastic IP address, you might be able to recover it. You cannot recover
3838
* 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
3939
* it in this operation.</p>
40-
* <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>
40+
* <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>
4141
* <p>You can allocate a carrier IP address which is a public IP address from a telecommunication carrier,
4242
* to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).</p>
4343
* @example

‎clients/client-ec2/src/commands/AssignIpv6AddressesCommand.ts

+2-3
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,12 @@ export interface AssignIpv6AddressesCommandOutput extends AssignIpv6AddressesRes
3232
* specify one or more specific IPv6 addresses, or you can specify the number of IPv6
3333
* addresses to be automatically assigned from within the subnet's IPv6 CIDR block range.
3434
* You can assign as many IPv6 addresses to a network interface as you can assign private
35-
* 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>
36-
* in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
35+
* IPv4 addresses, and the limit varies per instance type.</p>
3736
* <p>You must specify either the IPv6 addresses or the IPv6 address count in the request. </p>
3837
* <p>You can optionally use Prefix Delegation on the network interface. You must specify
3938
* either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For
4039
* information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html">
41-
* Assigning prefixes to Amazon EC2 network interfaces</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
40+
* Assigning prefixes to network interfaces</a> in the <i>Amazon EC2 User Guide</i>.</p>
4241
* @example
4342
* Use a bare-bones client and the command you need to make an API call.
4443
* ```javascript

‎clients/client-ec2/src/commands/AssignPrivateIpAddressesCommand.ts

+2-3
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@ export interface AssignPrivateIpAddressesCommandOutput extends AssignPrivateIpAd
3232
* <p>You can specify one or more specific secondary IP addresses, or you can specify the number
3333
* of secondary IP addresses to be automatically assigned within the subnet's CIDR block range.
3434
* The number of secondary IP addresses that you can assign to an instance varies by instance type.
35-
* 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
36-
* 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>
35+
* 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>
3736
* <p>When you move a secondary private IP address to another network interface, any Elastic IP address
3837
* that is associated with the IP address is also moved.</p>
3938
* <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
4342
* <p>You can optionally use Prefix Delegation on the network interface. You must specify
4443
* either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For
4544
* information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html">
46-
* Assigning prefixes to Amazon EC2 network interfaces</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
45+
* Assigning prefixes to network interfaces</a> in the <i>Amazon EC2 User Guide</i>.</p>
4746
* @example
4847
* Use a bare-bones client and the command you need to make an API call.
4948
* ```javascript

‎clients/client-ec2/src/commands/AssignPrivateNatGatewayAddressCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface AssignPrivateNatGatewayAddressCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Assigns one or more private IPv4 addresses to a private NAT gateway. For more information, see
36+
* <p>Assigns private IPv4 addresses to a private NAT gateway. For more information, see
3737
* <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>
3838
* @example
3939
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-ec2/src/commands/AssociateDhcpOptionsCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface AssociateDhcpOptionsCommandOutput extends __MetadataBearer {}
3030
/**
3131
* <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>
3232
* <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>
33-
* <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP options sets</a>
33+
* <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP option sets</a>
3434
* in the <i>Amazon VPC User Guide</i>.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.

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

+2-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ export interface AssociateNatGatewayAddressCommandOutput extends AssociateNatGat
3030
/**
3131
* <p>Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information,
3232
* 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>
33-
* <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>
33+
* <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.
34+
* 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>
3435
* <important>
3536
* <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>.
3637
* </p>

‎clients/client-ec2/src/commands/AssociateTrunkInterfaceCommand.ts

+4-2
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,10 @@ export interface AssociateTrunkInterfaceCommandOutput extends AssociateTrunkInte
2929

3030
/**
3131
* <p>Associates a branch network interface with a trunk network interface.</p>
32-
* <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
33-
* <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>
32+
* <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
33+
* to <code>trunk</code>. You must also create a network interface for
34+
* each branch network interface that you want to associate with the trunk
35+
* network interface.</p>
3436
* @example
3537
* Use a bare-bones client and the command you need to make an API call.
3638
* ```javascript

‎clients/client-ec2/src/commands/AssociateVpcCidrBlockCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface AssociateVpcCidrBlockCommandOutput extends AssociateVpcCidrBloc
3030
/**
3131
* <p>Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block,
3232
* an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that
33-
* you provisioned through bring your own IP addresses (<a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html">BYOIP</a>). </p>
33+
* you provisioned through bring your own IP addresses (<a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html">BYOIP</a>).</p>
3434
* <p>You must specify one of the following in the request: an IPv4 CIDR block, an IPv6
3535
* pool, or an Amazon-provided IPv6 CIDR block.</p>
3636
* <p>For more information about associating CIDR blocks with your VPC and applicable

‎clients/client-ec2/src/commands/CancelReservedInstancesListingCommand.ts

+2-3
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,8 @@ export interface CancelReservedInstancesListingCommandOutput
3434

3535
/**
3636
* <p>Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.</p>
37-
* <p>For more information, see
38-
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a>
39-
* in the <i>Amazon EC2 User Guide</i>.</p>
37+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Sell in the Reserved Instance
38+
* Marketplace</a> in the <i>Amazon EC2 User Guide</i>.</p>
4039
* @example
4140
* Use a bare-bones client and the command you need to make an API call.
4241
* ```javascript

‎clients/client-ec2/src/commands/CopySnapshotCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
3636
* <p>You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).</p>
3737
* <p>When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted.
3838
* Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the
39-
* snapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS)
40-
* KMS key; however, you can specify a different KMS key. To copy an encrypted
39+
* snapshot copy operation. By default, encrypted snapshot copies use the default KMS key;
40+
* however, you can specify a different KMS key. To copy an encrypted
4141
* snapshot that has been shared from another account, you must have permissions for the KMS key
4242
* used to encrypt the snapshot.</p>
4343
* <p>Snapshots copied to an Outpost are encrypted by default using the default

‎clients/client-ec2/src/commands/CreateCapacityReservationFleetCommand.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,9 @@ export interface CreateCapacityReservationFleetCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <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
37-
* Reservation Fleet</a> in the Amazon EC2 User Guide.</p>
36+
* <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
37+
* Capacity Reservation Fleet</a> in the
38+
* <i>Amazon EC2 User Guide</i>.</p>
3839
* @example
3940
* Use a bare-bones client and the command you need to make an API call.
4041
* ```javascript

‎clients/client-ec2/src/commands/CreateDhcpOptionsCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface CreateDhcpOptionsCommandOutput extends CreateDhcpOptionsResult,
3232
* it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly
3333
* launched instances in the VPC use this set of DHCP options.</p>
3434
* <p>The following are the individual DHCP options you can specify. For more information, see
35-
* <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP options sets</a>
35+
* <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP option sets</a>
3636
* in the <i>Amazon VPC User Guide</i>.</p>
3737
* <ul>
3838
* <li>
@@ -69,7 +69,7 @@ export interface CreateDhcpOptionsCommandOutput extends CreateDhcpOptionsResult,
6969
* <p>
7070
* <code>netbios-node-type</code> - The NetBIOS node type (1, 2, 4, or 8). We recommend that
7171
* you specify 2. Broadcast and multicast are not supported. For more information about
72-
* NetBIOS node types, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>.</p>
72+
* NetBIOS node types, see <a href="https://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>.</p>
7373
* </li>
7474
* <li>
7575
* <p>

‎clients/client-ec2/src/commands/CreateFlowLogsCommand.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,13 @@ export interface CreateFlowLogsCommandOutput extends CreateFlowLogsResult, __Met
3333
* <p>Flow log data for a monitored network interface is recorded as flow log records, which are log events
3434
* consisting of fields that describe the traffic flow. For more information, see
3535
* <a href="https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records">Flow log records</a>
36-
* in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>
36+
* in the <i>Amazon VPC User Guide</i>.</p>
3737
* <p>When publishing to CloudWatch Logs, flow log records are published to a log group, and each network
3838
* interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all
3939
* of the monitored network interfaces are published to a single log file object that is stored in the specified
4040
* bucket.</p>
41-
* <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>
41+
* <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html">VPC Flow Logs</a>
42+
* in the <i>Amazon VPC User Guide</i>.</p>
4243
* @example
4344
* Use a bare-bones client and the command you need to make an API call.
4445
* ```javascript

‎clients/client-ec2/src/commands/CreateInstanceConnectEndpointCommand.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ export interface CreateInstanceConnectEndpointCommandOutput
3333
* <p>Creates an EC2 Instance Connect Endpoint.</p>
3434
* <p>An EC2 Instance Connect Endpoint allows you to connect to an instance, without
3535
* 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
36-
* Instance Connect Endpoint</a> in the <i>Amazon EC2 User
37-
* Guide</i>.</p>
36+
* Instance Connect Endpoint</a> in the <i>Amazon EC2 User Guide</i>.</p>
3837
* @example
3938
* Use a bare-bones client and the command you need to make an API call.
4039
* ```javascript

‎clients/client-ec2/src/commands/CreateLaunchTemplateCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ export interface CreateLaunchTemplateCommandOutput extends CreateLaunchTemplateR
3737
* instance using <a>RunInstances</a>, you can specify a launch template instead
3838
* 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
3939
* an instance from a launch template</a> in the
40-
* <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
40+
* <i>Amazon EC2 User Guide</i>.</p>
4141
* <p>To clone an existing launch template as the basis for a new launch template, use the
4242
* Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more
4343
* 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
44-
* <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
44+
* <i>Amazon EC2 User Guide</i>.</p>
4545
* @example
4646
* Use a bare-bones client and the command you need to make an API call.
4747
* ```javascript

‎clients/client-ec2/src/commands/CreateLaunchTemplateVersionCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface CreateLaunchTemplateVersionCommandOutput extends CreateLaunchTe
4242
* it. Instead, you can create a new version of the launch template that includes the
4343
* changes that you require.</p>
4444
* <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
45-
* <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
45+
* <i>Amazon EC2 User Guide</i>.</p>
4646
* @example
4747
* Use a bare-bones client and the command you need to make an API call.
4848
* ```javascript

0 commit comments

Comments
 (0)