Skip to content

Commit 36ac02c

Browse files
author
awstools
committed
feat(client-ec2): Documentation updates for Amazon EC2.
1 parent 61a70d7 commit 36ac02c

26 files changed

+196
-150
lines changed

Diff for: clients/client-ec2/src/EC2.ts

+28-17
Original file line numberDiff line numberDiff line change
@@ -2940,7 +2940,7 @@ export class EC2 extends EC2Client {
29402940
* <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>
29412941
* <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>
29422942
* <note>
2943-
* <p>We are retiring EC2-Classic on August 15, 2022. 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>
2943+
* <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>
29442944
* </note>
29452945
*/
29462946
public allocateAddress(
@@ -3191,7 +3191,7 @@ export class EC2 extends EC2Client {
31913191
* </important>
31923192
*
31933193
* <note>
3194-
* <p>We are retiring EC2-Classic on August 15, 2022. 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>
3194+
* <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>
31953195
* </note>
31963196
*/
31973197
public associateAddress(
@@ -3298,7 +3298,7 @@ export class EC2 extends EC2Client {
32983298
* User Guide</i>.</p>
32993299
*
33003300
* <p>When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted
3301-
* private key are placed in an Amazon S3 bucket that only the associated IAM role can access. The private key of the certificate
3301+
* private key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate
33023302
* is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.</p>
33033303
*
33043304
* <p>To enable the IAM role to access the Amazon S3 object, you must grant it permission to call <code>s3:GetObject</code>
@@ -3941,7 +3941,7 @@ export class EC2 extends EC2Client {
39413941
* <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>
39423942
*
39433943
* <note>
3944-
* <p>We are retiring EC2-Classic on August 15, 2022. 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>
3944+
* <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>
39453945
* </note>
39463946
*/
39473947
public authorizeSecurityGroupIngress(
@@ -5860,8 +5860,11 @@ export class EC2 extends EC2Client {
58605860

58615861
/**
58625862
* <p>Creates a network interface in the specified subnet.</p>
5863-
* <p>For more information about network interfaces, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html">Elastic Network Interfaces</a>
5864-
* in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>
5863+
* <p>The number of IP addresses you can assign to a network interface varies by instance
5864+
* type. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI">IP Addresses Per ENI Per
5865+
* Instance Type</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>
5866+
* <p>For more information about network interfaces, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html">Elastic network interfaces</a>
5867+
* in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
58655868
*/
58665869
public createNetworkInterface(
58675870
args: CreateNetworkInterfaceCommandInput,
@@ -6217,7 +6220,7 @@ export class EC2 extends EC2Client {
62176220
* <p>For more information about VPC security group limits, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html">Amazon VPC Limits</a>.</p>
62186221
*
62196222
* <note>
6220-
* <p>We are retiring EC2-Classic on August 15, 2022. 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>
6223+
* <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>
62216224
* </note>
62226225
*/
62236226
public createSecurityGroup(
@@ -6311,8 +6314,10 @@ export class EC2 extends EC2Client {
63116314
/**
63126315
* <p>Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3.
63136316
* Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot
6314-
* each that is crash-consistent across the instance. Boot volumes can be excluded by changing the
6315-
* parameters. </p>
6317+
* each that is crash-consistent across the instance.</p>
6318+
*
6319+
* <p>You can include all of the volumes currently attached to the instance, or you can exclude
6320+
* the root volume or specific data (non-root) volumes from the multi-volume snapshot set.</p>
63166321
*
63176322
* <p>You can create multi-volume snapshots of instances in a Region and instances on an
63186323
* Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored
@@ -8705,7 +8710,7 @@ export class EC2 extends EC2Client {
87058710
* <code>DependencyViolation</code> in EC2-VPC.</p>
87068711
*
87078712
* <note>
8708-
* <p>We are retiring EC2-Classic on August 15, 2022. 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>
8713+
* <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>
87098714
* </note>
87108715
*/
87118716
public deleteSecurityGroup(
@@ -10048,7 +10053,7 @@ export class EC2 extends EC2Client {
1004810053
* <p>An Elastic IP address is for use in either the EC2-Classic platform or in a VPC.
1004910054
* 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>
1005010055
* <note>
10051-
* <p>We are retiring EC2-Classic on August 15, 2022. 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>
10056+
* <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>
1005210057
* </note>
1005310058
*/
1005410059
public describeAddresses(
@@ -13162,7 +13167,7 @@ export class EC2 extends EC2Client {
1316213167
* <a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security groups for your VPC</a> in the
1316313168
* <i>Amazon Virtual Private Cloud User Guide</i>.</p>
1316413169
* <note>
13165-
* <p>We are retiring EC2-Classic on August 15, 2022. 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>
13170+
* <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>
1316613171
* </note>
1316713172
*/
1316813173
public describeSecurityGroups(
@@ -15318,7 +15323,7 @@ export class EC2 extends EC2Client {
1531815323
* Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
1531915324
*
1532015325
* <note>
15321-
* <p>We are retiring EC2-Classic on August 15, 2022. 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>
15326+
* <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>
1532215327
* </note>
1532315328
* <p>This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.</p>
1532415329
*/
@@ -17624,6 +17629,12 @@ export class EC2 extends EC2Client {
1762417629

1762517630
/**
1762617631
* <p>Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).</p>
17632+
* <important>
17633+
* <p>Amazon Web Services VM Import/Export strongly recommends specifying a value for either the
17634+
* <code>--license-type</code> or <code>--usage-operation</code> parameter when you create a new
17635+
* VM Import task. This ensures your operating system is licensed appropriately and your billing is
17636+
* optimized.</p>
17637+
* </important>
1762717638
* <p>For more information, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html">Importing a
1762817639
* VM as an image using VM Import/Export</a> in the <i>VM Import/Export User Guide</i>.</p>
1762917640
*/
@@ -20051,7 +20062,7 @@ export class EC2 extends EC2Client {
2005120062
* <a>RestoreAddressToClassic</a> request. You cannot move an Elastic IP address that was
2005220063
* originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.</p>
2005320064
* <note>
20054-
* <p>We are retiring EC2-Classic on August 15, 2022. 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>
20065+
* <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>
2005520066
* </note>
2005620067
*/
2005720068
public moveAddressToVpc(
@@ -20758,7 +20769,7 @@ export class EC2 extends EC2Client {
2075820769
* from any instance that it's associated with. To disassociate an Elastic IP address without
2075920770
* releasing it, use <a>DisassociateAddress</a>.</p>
2076020771
* <note>
20761-
* <p>We are retiring EC2-Classic on August 15, 2022. 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>
20772+
* <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>
2076220773
* </note>
2076320774
* <p>[Nondefault VPC] You must use <a>DisassociateAddress</a> to disassociate the Elastic IP address
2076420775
* before you can release it. Otherwise, Amazon EC2 returns an error (<code>InvalidIPAddress.InUse</code>).</p>
@@ -21461,7 +21472,7 @@ export class EC2 extends EC2Client {
2146121472
/**
2146221473
* <p>Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.</p>
2146321474
* <note>
21464-
* <p>We are retiring EC2-Classic on August 15, 2022. 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>
21475+
* <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>
2146521476
* </note>
2146621477
*/
2146721478
public restoreAddressToClassic(
@@ -21723,7 +21734,7 @@ export class EC2 extends EC2Client {
2172321734
* <p>Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.</p>
2172421735
*
2172521736
* <note>
21726-
* <p>We are retiring EC2-Classic on August 15, 2022. 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>
21737+
* <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>
2172721738
* </note>
2172821739
*/
2172921740
public revokeSecurityGroupIngress(

Diff for: clients/client-ec2/src/commands/AllocateAddressCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ export interface AllocateAddressCommandOutput extends AllocateAddressResult, __M
3939
* <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>
4040
* <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>
4141
* <note>
42-
* <p>We are retiring EC2-Classic on August 15, 2022. 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>
42+
* <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>
4343
* </note>
4444
* @example
4545
* Use a bare-bones client and the command you need to make an API call.

Diff for: clients/client-ec2/src/commands/AssociateAddressCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ export interface AssociateAddressCommandOutput extends AssociateAddressResult, _
5555
* </important>
5656
*
5757
* <note>
58-
* <p>We are retiring EC2-Classic on August 15, 2022. 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>
58+
* <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>
5959
* </note>
6060
* @example
6161
* Use a bare-bones client and the command you need to make an API call.

Diff for: clients/client-ec2/src/commands/AssociateEnclaveCertificateIamRoleCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export interface AssociateEnclaveCertificateIamRoleCommandOutput
3636
* User Guide</i>.</p>
3737
*
3838
* <p>When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted
39-
* private key are placed in an Amazon S3 bucket that only the associated IAM role can access. The private key of the certificate
39+
* private key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate
4040
* is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.</p>
4141
*
4242
* <p>To enable the IAM role to access the Amazon S3 object, you must grant it permission to call <code>s3:GetObject</code>

Diff for: clients/client-ec2/src/commands/AuthorizeSecurityGroupIngressCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export interface AuthorizeSecurityGroupIngressCommandOutput
4444
* <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>
4545
*
4646
* <note>
47-
* <p>We are retiring EC2-Classic on August 15, 2022. 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>
47+
* <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>
4848
* </note>
4949
* @example
5050
* Use a bare-bones client and the command you need to make an API call.

0 commit comments

Comments
 (0)