Skip to content

Commit 3e83504

Browse files
author
awstools
committed
docs(client-ec2): Documentation updates for Amazon EC2.
1 parent e2fb9d5 commit 3e83504

File tree

70 files changed

+784
-897
lines changed

Some content is hidden

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

70 files changed

+784
-897
lines changed

‎clients/client-ec2/README.md

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,8 @@ AWS SDK for JavaScript EC2 Client for Node.js, Browser and React Native.
88

99
<fullname>Amazon Elastic Compute Cloud</fullname>
1010

11-
<p>Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the Amazon Web Services Cloud.
12-
Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications
13-
faster. Amazon Virtual Private Cloud (Amazon VPC) enables you to provision a logically isolated section of the
14-
Amazon Web Services Cloud where you can launch Amazon Web Services resources in a virtual network that you've defined. Amazon Elastic Block Store
15-
(Amazon EBS) provides block level storage volumes for use with EC2 instances. EBS volumes are highly available
16-
and reliable storage volumes that can be attached to any running instance and used like a hard drive.</p>
17-
<p>To learn more, see the following resources:</p>
18-
<ul>
19-
<li>
20-
<p>Amazon EC2: <a href="http://aws.amazon.com/ec2">Amazon EC2 product page</a>, <a href="https://docs.aws.amazon.com/ec2/index.html">Amazon EC2 documentation</a>
21-
</p>
22-
</li>
23-
<li>
24-
<p>Amazon EBS: <a href="http://aws.amazon.com/ebs">Amazon EBS product page</a>, <a href="https://docs.aws.amazon.com/ebs/index.html">Amazon EBS documentation</a>
25-
</p>
26-
</li>
27-
<li>
28-
<p>Amazon VPC: <a href="http://aws.amazon.com/vpc">Amazon VPC product page</a>, <a href="https://docs.aws.amazon.com/vpc/index.html">Amazon VPC documentation</a>
29-
</p>
30-
</li>
31-
<li>
32-
<p>VPN: <a href="http://aws.amazon.com/vpn">VPN product page</a>, <a href="https://docs.aws.amazon.com/vpn/index.html">VPN documentation</a>
33-
</p>
34-
</li>
35-
</ul>
11+
<p>You can access the features of Amazon Elastic Compute Cloud (Amazon EC2) programmatically. For more information,
12+
see the <a href="https://docs.aws.amazon.com/ec2/latest/devguide">Amazon EC2 Developer Guide</a>.</p>
3613

3714
## Installing
3815

‎clients/client-ec2/src/EC2.ts

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -13729,31 +13729,8 @@ export interface EC2 {
1372913729
/**
1373013730
* @public
1373113731
* <fullname>Amazon Elastic Compute Cloud</fullname>
13732-
* <p>Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the Amazon Web Services Cloud.
13733-
* Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications
13734-
* faster. Amazon Virtual Private Cloud (Amazon VPC) enables you to provision a logically isolated section of the
13735-
* Amazon Web Services Cloud where you can launch Amazon Web Services resources in a virtual network that you've defined. Amazon Elastic Block Store
13736-
* (Amazon EBS) provides block level storage volumes for use with EC2 instances. EBS volumes are highly available
13737-
* and reliable storage volumes that can be attached to any running instance and used like a hard drive.</p>
13738-
* <p>To learn more, see the following resources:</p>
13739-
* <ul>
13740-
* <li>
13741-
* <p>Amazon EC2: <a href="http://aws.amazon.com/ec2">Amazon EC2 product page</a>, <a href="https://docs.aws.amazon.com/ec2/index.html">Amazon EC2 documentation</a>
13742-
* </p>
13743-
* </li>
13744-
* <li>
13745-
* <p>Amazon EBS: <a href="http://aws.amazon.com/ebs">Amazon EBS product page</a>, <a href="https://docs.aws.amazon.com/ebs/index.html">Amazon EBS documentation</a>
13746-
* </p>
13747-
* </li>
13748-
* <li>
13749-
* <p>Amazon VPC: <a href="http://aws.amazon.com/vpc">Amazon VPC product page</a>, <a href="https://docs.aws.amazon.com/vpc/index.html">Amazon VPC documentation</a>
13750-
* </p>
13751-
* </li>
13752-
* <li>
13753-
* <p>VPN: <a href="http://aws.amazon.com/vpn">VPN product page</a>, <a href="https://docs.aws.amazon.com/vpn/index.html">VPN documentation</a>
13754-
* </p>
13755-
* </li>
13756-
* </ul>
13732+
* <p>You can access the features of Amazon Elastic Compute Cloud (Amazon EC2) programmatically. For more information,
13733+
* see the <a href="https://docs.aws.amazon.com/ec2/latest/devguide">Amazon EC2 Developer Guide</a>.</p>
1375713734
*/
1375813735
export class EC2 extends EC2Client implements EC2 {}
1375913736
createAggregatedClient(commands, EC2);

‎clients/client-ec2/src/EC2Client.ts

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3557,31 +3557,8 @@ export interface EC2ClientResolvedConfig extends EC2ClientResolvedConfigType {}
35573557
/**
35583558
* @public
35593559
* <fullname>Amazon Elastic Compute Cloud</fullname>
3560-
* <p>Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the Amazon Web Services Cloud.
3561-
* Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications
3562-
* faster. Amazon Virtual Private Cloud (Amazon VPC) enables you to provision a logically isolated section of the
3563-
* Amazon Web Services Cloud where you can launch Amazon Web Services resources in a virtual network that you've defined. Amazon Elastic Block Store
3564-
* (Amazon EBS) provides block level storage volumes for use with EC2 instances. EBS volumes are highly available
3565-
* and reliable storage volumes that can be attached to any running instance and used like a hard drive.</p>
3566-
* <p>To learn more, see the following resources:</p>
3567-
* <ul>
3568-
* <li>
3569-
* <p>Amazon EC2: <a href="http://aws.amazon.com/ec2">Amazon EC2 product page</a>, <a href="https://docs.aws.amazon.com/ec2/index.html">Amazon EC2 documentation</a>
3570-
* </p>
3571-
* </li>
3572-
* <li>
3573-
* <p>Amazon EBS: <a href="http://aws.amazon.com/ebs">Amazon EBS product page</a>, <a href="https://docs.aws.amazon.com/ebs/index.html">Amazon EBS documentation</a>
3574-
* </p>
3575-
* </li>
3576-
* <li>
3577-
* <p>Amazon VPC: <a href="http://aws.amazon.com/vpc">Amazon VPC product page</a>, <a href="https://docs.aws.amazon.com/vpc/index.html">Amazon VPC documentation</a>
3578-
* </p>
3579-
* </li>
3580-
* <li>
3581-
* <p>VPN: <a href="http://aws.amazon.com/vpn">VPN product page</a>, <a href="https://docs.aws.amazon.com/vpn/index.html">VPN documentation</a>
3582-
* </p>
3583-
* </li>
3584-
* </ul>
3560+
* <p>You can access the features of Amazon Elastic Compute Cloud (Amazon EC2) programmatically. For more information,
3561+
* see the <a href="https://docs.aws.amazon.com/ec2/latest/devguide">Amazon EC2 Developer Guide</a>.</p>
35853562
*/
35863563
export class EC2Client extends __Client<
35873564
__HttpHandlerOptions,

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ export interface AttachVolumeCommandOutput extends VolumeAttachment, __MetadataB
3131
* <p>Attaches an EBS volume to a running or stopped instance and exposes it to the instance
3232
* with the specified device name.</p>
3333
* <p>Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For
34-
* more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
34+
* more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html">Amazon EBS encryption</a> in the <i>Amazon EBS User Guide</i>.</p>
3535
* <p>After you attach an EBS volume, you must make it available. For more information, see
36-
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-using-volumes.html">Make an EBS volume available for use</a>.</p>
36+
* <a href="https://docs.aws.amazon.com/ebs/latest/userguide/ebs-using-volumes.html">Make an EBS volume available for use</a>.</p>
3737
* <p>If a volume has an Amazon Web Services Marketplace product code:</p>
3838
* <ul>
3939
* <li>
@@ -51,8 +51,8 @@ export interface AttachVolumeCommandOutput extends VolumeAttachment, __MetadataB
5151
* instance.</p>
5252
* </li>
5353
* </ul>
54-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html">Attach an Amazon EBS volume to an instance</a> in the
55-
* <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
54+
* <p>For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/ebs-attaching-volume.html">Attach an Amazon EBS volume to an instance</a> in the
55+
* <i>Amazon EBS User Guide</i>.</p>
5656
* @example
5757
* Use a bare-bones client and the command you need to make an API call.
5858
* ```javascript

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

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -30,23 +30,19 @@ export interface AuthorizeSecurityGroupEgressCommandOutput
3030

3131
/**
3232
* @public
33-
* <p>Adds the specified outbound (egress) rules to a security group for use with a VPC.</p>
34-
* <p>An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR
35-
* address ranges, or to the instances that are associated with the specified source
36-
* security groups. When specifying an outbound rule for your security group in a VPC, the
37-
* <code>IpPermissions</code> must include a destination for the traffic.</p>
38-
* <p>You specify a protocol for each rule (for example, TCP).
39-
* For the TCP and UDP protocols, you must also specify the destination port or port range.
40-
* For the ICMP protocol, you must also specify the ICMP type and code.
41-
* You can use -1 for the type or code to mean all types or all codes.</p>
42-
* <p>Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.</p>
43-
* <p>For 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>
44-
* <note>
45-
* <p>If you want to reference a security group across VPCs attached to a transit gateway using the
46-
* <a href="https://docs.aws.amazon.com/vpc/latest/tgw/tgw-transit-gateways.html#create-tgw">security group
47-
* referencing feature</a>, note that you can only reference security groups
48-
* for ingress rules. You cannot reference a security group for egress rules.</p>
49-
* </note>
33+
* <p>Adds the specified outbound (egress) rules to a security group.</p>
34+
* <p>An outbound rule permits instances to send traffic to the specified IPv4 or IPv6
35+
* address ranges, the IP address ranges specified by a prefix list, or the instances
36+
* that are associated with a source security group. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html">Security group rules</a>.</p>
37+
* <p>You must specify exactly one of the following destinations: an IPv4 or IPv6 address range,
38+
* a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP).
39+
* If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is
40+
* ICMP or ICMPv6, you must also specify the ICMP type and code.</p>
41+
* <p>Rule changes are propagated to instances associated with the security group as quickly
42+
* as possible. However, a small delay might occur.</p>
43+
* <p>For examples of rules that you can add to security groups for specific access scenarios,
44+
* see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html">Security group rules for different use cases</a> in the <i>Amazon EC2 User Guide</i>.</p>
45+
* <p>For information about security group quotas, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html">Amazon VPC quotas</a> in the <i>Amazon VPC User Guide</i>.</p>
5046
* @example
5147
* Use a bare-bones client and the command you need to make an API call.
5248
* ```javascript

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

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,18 @@ export interface AuthorizeSecurityGroupIngressCommandOutput
3131
/**
3232
* @public
3333
* <p>Adds the specified inbound (ingress) rules to a security group.</p>
34-
* <p>An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR
35-
* address range, or from the instances that are associated with the specified destination security
36-
* groups. When specifying an inbound rule for your security group in a VPC, the
37-
* <code>IpPermissions</code> must include a source for the traffic.</p>
38-
* <p>You specify a protocol for each rule (for example, TCP).
39-
* For TCP and UDP, you must also specify the destination port or port range.
40-
* For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code.
41-
* You can use -1 to mean all types or all codes.</p>
42-
* <p>Rule changes are propagated to instances within the security group as quickly as possible.
43-
* However, a small delay might occur.</p>
44-
* <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>
34+
* <p>An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6
35+
* address range, the IP address ranges that are specified by a prefix list, or the instances
36+
* that are associated with a destination security group. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html">Security group rules</a>.</p>
37+
* <p>You must specify exactly one of the following sources: an IPv4 or IPv6 address range,
38+
* a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP).
39+
* If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is
40+
* ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code.</p>
41+
* <p>Rule changes are propagated to instances associated with the security group as quickly
42+
* as possible. However, a small delay might occur.</p>
43+
* <p>For examples of rules that you can add to security groups for specific access scenarios,
44+
* see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html">Security group rules for different use cases</a> in the <i>Amazon EC2 User Guide</i>.</p>
45+
* <p>For more information about security group quotas, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html">Amazon VPC quotas</a> in the <i>Amazon VPC User Guide</i>.</p>
4546
* @example
4647
* Use a bare-bones client and the command you need to make an API call.
4748
* ```javascript

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,9 @@ export interface BundleInstanceCommandOutput extends BundleInstanceResult, __Met
3434
/**
3535
* @public
3636
* <p>Bundles an Amazon instance store-backed Windows instance.</p>
37-
* <p>During bundling, only the root device volume (C:\) is bundled. Data on other instance
38-
* store volumes is not preserved.</p>
37+
* <p>During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved.</p>
3938
* <note>
40-
* <p>This action is not applicable for Linux/Unix instances or Windows instances that are
41-
* backed by Amazon EBS.</p>
39+
* <p>This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.</p>
4240
* </note>
4341
* @example
4442
* Use a bare-bones client and the command you need to make an API call.

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,10 @@ export interface CancelImageLaunchPermissionCommandOutput extends CancelImageLau
2828

2929
/**
3030
* @public
31-
* <p>Removes your Amazon Web Services account from the launch permissions for the specified AMI.
32-
* For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cancel-sharing-an-AMI.html"> Cancel having an AMI shared with
33-
* your Amazon Web Services account</a> in the <i>Amazon EC2 User Guide</i>.</p>
31+
* <p>Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more
32+
* information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cancel-sharing-an-AMI.html">
33+
* Cancel having an AMI shared with your Amazon Web Services account</a> in the
34+
* <i>Amazon EC2 User Guide</i>.</p>
3435
* @example
3536
* Use a bare-bones client and the command you need to make an API call.
3637
* ```javascript

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

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,22 @@ export interface CopyImageCommandOutput extends CopyImageResult, __MetadataBeare
2929
/**
3030
* @public
3131
* <p>Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a
32-
* Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to
33-
* another, or within the same Outpost. To copy an AMI to another partition, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html">CreateStoreImageTask</a>.</p>
34-
* <p>To copy an AMI from one Region to another, specify the source Region using the <b>SourceRegion</b> parameter, and specify the destination Region using its
35-
* endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of
36-
* unencrypted backing snapshots remain unencrypted, unless you set <code>Encrypted</code> during
37-
* the copy operation. You cannot create an unencrypted copy of an encrypted backing
38-
* snapshot.</p>
39-
* <p>To copy an AMI from a Region to an Outpost, specify the source Region using the <b>SourceRegion</b> parameter, and specify the ARN of the destination
40-
* Outpost using <b>DestinationOutpostArn</b>. Backing snapshots copied
41-
* to an Outpost are encrypted by default using the default encryption key for the Region, or a
42-
* different key that you specify in the request using <b>KmsKeyId</b>.
43-
* Outposts do not support unencrypted snapshots. For more information, <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami"> Amazon EBS local
44-
* snapshots on Outposts</a> in the <i>Amazon EC2 User Guide</i>.</p>
32+
* Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost
33+
* to another, or within the same Outpost. To copy an AMI to another partition, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html">CreateStoreImageTask</a>.</p>
34+
* <p>To copy an AMI from one Region to another, specify the source Region using the
35+
* <b>SourceRegion</b> parameter, and specify the
36+
* destination Region using its endpoint. Copies of encrypted backing snapshots for
37+
* the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted,
38+
* unless you set <code>Encrypted</code> during the copy operation. You cannot
39+
* create an unencrypted copy of an encrypted backing snapshot.</p>
40+
* <p>To copy an AMI from a Region to an Outpost, specify the source Region using the
41+
* <b>SourceRegion</b> parameter, and specify the
42+
* ARN of the destination Outpost using <b>DestinationOutpostArn</b>.
43+
* Backing snapshots copied to an Outpost are encrypted by default using the default
44+
* encryption key for the Region, or a different key that you specify in the request using
45+
* <b>KmsKeyId</b>. Outposts do not support unencrypted
46+
* snapshots. For more information, <a href="https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#ami">
47+
* Amazon EBS local snapshots on Outposts</a> in the <i>Amazon EBS User Guide</i>.</p>
4548
* <p>For more information about the prerequisites and limits when copying an AMI, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html">Copy an AMI</a> in the
4649
* <i>Amazon EC2 User Guide</i>.</p>
4750
* @example

0 commit comments

Comments
 (0)