docs(client-ec2): Documentation updates for VM Import/Export.

aws · Jul 28, 2022 · ef1043e · ef1043e
1 parent c6bb7f9
commit ef1043e
Show file tree

Hide file tree

Showing 15 changed files with 97 additions and 41 deletions.
diff --git a/clients/client-ec2/src/EC2.ts b/clients/client-ec2/src/EC2.ts
@@ -3831,8 +3831,10 @@ export class EC2 extends EC2Client {
 
   /**
    * <p>[VPC only] 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.</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
+   *             <code>IpPermissions</code> must include a destination for the traffic.</p>
    *          <p>You specify a protocol for each rule (for example, TCP).
    *        For the TCP and UDP protocols, you must also specify the destination port or port range.
    *        For the ICMP protocol, you must also specify the ICMP type and code.
@@ -3873,14 +3875,19 @@ export class EC2 extends EC2Client {
    * <p>Adds the specified inbound (ingress) rules to a security group.</p>
    *          <p>An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR
    *        address range, or from the instances that are associated with the specified destination security
-   *        groups.</p>
+   *        groups. When specifying an inbound rule for your security group in a VPC, the
+   *          <code>IpPermissions</code> must include a source for the traffic.</p>
    *          <p>You specify a protocol for each rule (for example, TCP).
    *        For TCP and UDP, you must also specify the destination port or port range.
    *        For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code.
    *        You can use -1 to mean all types or all codes.</p>
    *          <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 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>
+   *          </note>
    */
   public authorizeSecurityGroupIngress(
     args: AuthorizeSecurityGroupIngressCommandInput,
@@ -6001,6 +6008,10 @@ export class EC2 extends EC2Client {
    * 					<a>RevokeSecurityGroupIngress</a>, and
    * 					<a>RevokeSecurityGroupEgress</a>.</p>
    *          <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>
+   *
+   *          <note>
+   *            <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>
+   *          </note>
    */
   public createSecurityGroup(
     args: CreateSecurityGroupCommandInput,
@@ -8349,6 +8360,10 @@ export class EC2 extends EC2Client {
    * 			  referenced by another security group, the operation fails with
    * 				<code>InvalidGroup.InUse</code> in EC2-Classic or
    * 				<code>DependencyViolation</code> in EC2-VPC.</p>
+   *
+   *          <note>
+   *            <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>
+   *          </note>
    */
   public deleteSecurityGroup(
     args: DeleteSecurityGroupCommandInput,
@@ -9652,6 +9667,9 @@ export class EC2 extends EC2Client {
    *           allocate for use with EC2-VPC.</p>
    *             </li>
    *          </ul>
+   *          <note>
+   *            <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 EC2 User Guide</i>.</p>
+   *          </note>
    */
   public describeAccountAttributes(
     args: DescribeAccountAttributesCommandInput,
@@ -12794,6 +12812,9 @@ export class EC2 extends EC2Client {
    * 				the <i>Amazon Elastic Compute Cloud User Guide</i> and
    * 				<a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security groups for your VPC</a> in the
    * 				<i>Amazon Virtual Private Cloud User Guide</i>.</p>
+   *          <note>
+   *            <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>
+   *          </note>
    */
   public describeSecurityGroups(
     args: DescribeSecurityGroupsCommandInput,
@@ -21270,6 +21291,10 @@ export class EC2 extends EC2Client {
    *          <p>Amazon Web Services recommends that you describe the security group to verify that the rules were removed.</p>
    *
    *          <p>Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.</p>
+   *
+   *          <note>
+   *            <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>
+   *          </note>
    */
   public revokeSecurityGroupIngress(
     args: RevokeSecurityGroupIngressCommandInput,

diff --git a/clients/client-ec2/src/commands/AuthorizeSecurityGroupEgressCommand.ts b/clients/client-ec2/src/commands/AuthorizeSecurityGroupEgressCommand.ts
@@ -31,8 +31,10 @@ export interface AuthorizeSecurityGroupEgressCommandOutput
 
 /**
  * <p>[VPC only] 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.</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
+ *             <code>IpPermissions</code> must include a destination for the traffic.</p>
  *          <p>You specify a protocol for each rule (for example, TCP).
  *        For the TCP and UDP protocols, you must also specify the destination port or port range.
  *        For the ICMP protocol, you must also specify the ICMP type and code.

diff --git a/clients/client-ec2/src/commands/AuthorizeSecurityGroupIngressCommand.ts b/clients/client-ec2/src/commands/AuthorizeSecurityGroupIngressCommand.ts
@@ -33,14 +33,19 @@ export interface AuthorizeSecurityGroupIngressCommandOutput
  * <p>Adds the specified inbound (ingress) rules to a security group.</p>
  *          <p>An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR
  *        address range, or from the instances that are associated with the specified destination security
- *        groups.</p>
+ *        groups. When specifying an inbound rule for your security group in a VPC, the
+ *          <code>IpPermissions</code> must include a source for the traffic.</p>
  *          <p>You specify a protocol for each rule (for example, TCP).
  *        For TCP and UDP, you must also specify the destination port or port range.
  *        For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code.
  *        You can use -1 to mean all types or all codes.</p>
  *          <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 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>
+ *          </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/CreateSecurityGroupCommand.ts b/clients/client-ec2/src/commands/CreateSecurityGroupCommand.ts
@@ -43,6 +43,10 @@ export interface CreateSecurityGroupCommandOutput extends CreateSecurityGroupRes
  * 					<a>RevokeSecurityGroupIngress</a>, and
  * 					<a>RevokeSecurityGroupEgress</a>.</p>
  *          <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>
+ *
+ *          <note>
+ *            <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>
+ *          </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/DeleteSecurityGroupCommand.ts b/clients/client-ec2/src/commands/DeleteSecurityGroupCommand.ts
@@ -28,6 +28,10 @@ export interface DeleteSecurityGroupCommandOutput extends __MetadataBearer {}
  * 			  referenced by another security group, the operation fails with
  * 				<code>InvalidGroup.InUse</code> in EC2-Classic or
  * 				<code>DependencyViolation</code> in EC2-VPC.</p>
+ *
+ *          <note>
+ *            <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>
+ *          </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/DescribeAccountAttributesCommand.ts b/clients/client-ec2/src/commands/DescribeAccountAttributesCommand.ts
@@ -63,6 +63,9 @@ export interface DescribeAccountAttributesCommandOutput extends DescribeAccountA
  *           allocate for use with EC2-VPC.</p>
  *             </li>
  *          </ul>
+ *          <note>
+ *            <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 EC2 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/DescribeSecurityGroupsCommand.ts b/clients/client-ec2/src/commands/DescribeSecurityGroupsCommand.ts
@@ -35,6 +35,9 @@ export interface DescribeSecurityGroupsCommandOutput extends DescribeSecurityGro
  * 				the <i>Amazon Elastic Compute Cloud User Guide</i> and
  * 				<a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security groups for your VPC</a> in the
  * 				<i>Amazon Virtual Private Cloud User Guide</i>.</p>
+ *          <note>
+ *            <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>
+ *          </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/RevokeSecurityGroupIngressCommand.ts b/clients/client-ec2/src/commands/RevokeSecurityGroupIngressCommand.ts
@@ -42,6 +42,10 @@ export interface RevokeSecurityGroupIngressCommandOutput extends RevokeSecurityG
  *          <p>Amazon Web Services recommends that you describe the security group to verify that the rules were removed.</p>
  *
  *          <p>Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.</p>
+ *
+ *          <note>
+ *            <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>
+ *          </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/models/models_0.ts b/clients/client-ec2/src/models/models_0.ts
@@ -3441,6 +3441,9 @@ export interface PrefixListId {
 
 /**
  * <p>Describes a security group and Amazon Web Services account ID pair.</p>
+ *          <note>
+ *            <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>
+ *          </note>
  */
 export interface UserIdGroupPair {
   /**

diff --git a/clients/client-ec2/src/models/models_1.ts b/clients/client-ec2/src/models/models_1.ts
@@ -544,7 +544,6 @@ export interface Placement {
    *             tenancy is not supported for the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html">ImportInstance</a>
    *             command.</p>
    *         <p>This parameter is not supported by <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet">CreateFleet</a>.</p>
-   *
    *         <p>T3 instances that use the <code>unlimited</code> CPU credit option do not support
    *                 <code>host</code> tenancy.</p>
    */
@@ -2251,8 +2250,9 @@ export interface ExportToS3TaskSpecification {
   DiskImageFormat?: DiskImageFormat | string;
 
   /**
-   * <p>The Amazon S3 bucket for the destination image. The destination bucket must exist and grant
-   *    WRITE and READ_ACP permissions to the Amazon Web Services account <code>vm-import-export@amazon.com</code>.</p>
+   * <p>The Amazon S3 bucket for the destination image. The destination bucket must exist and have
+   *    an access control list (ACL) attached that specifies the Region-specific canonical account ID for
+   *    the <code>Grantee</code>. For more information about the ACL to your S3 bucket, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport.html#vmexport-prerequisites">Prerequisites</a> in the VM Import/Export User Guide.</p>
    */
   S3Bucket?: string;
 
@@ -2308,8 +2308,9 @@ export interface ExportToS3Task {
   DiskImageFormat?: DiskImageFormat | string;
 
   /**
-   * <p>The Amazon S3 bucket for the destination image. The destination bucket must exist and grant
-   *    WRITE and READ_ACP permissions to the Amazon Web Services account <code>vm-import-export@amazon.com</code>.</p>
+   * <p>The Amazon S3 bucket for the destination image. The destination bucket must exist and have
+   *    an access control list (ACL) attached that specifies the Region-specific canonical account ID for
+   *    the <code>Grantee</code>. For more information about the ACL to your S3 bucket, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport.html#vmexport-prerequisites">Prerequisites</a> in the VM Import/Export User Guide.</p>
    */
   S3Bucket?: string;
 
@@ -3911,7 +3912,7 @@ export interface RequestLaunchTemplateData {
   SecurityGroupIds?: string[];
 
   /**
-   * <p>[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you
+   * <p>One or more security group names. For a nondefault VPC, you
    *             must use security group IDs instead. You cannot specify both a security group ID and
    *             security name in the same request.</p>
    */

diff --git a/clients/client-ec2/src/models/models_3.ts b/clients/client-ec2/src/models/models_3.ts
@@ -3877,8 +3877,8 @@ export interface ImageAttribute {
 
   /**
    * <p>The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time
-   *         format</a>, when the AMI was last used to launch an EC2 instance. When the AMI is used,
-   *       there is a 24-hour delay before that usage is reported.</p>
+   *         format</a>, when the AMI was last used to launch an EC2 instance. When the AMI is used
+   *       to launch an instance, there is a 24-hour delay before that usage is reported.</p>
    *          <note>
    *             <p>
    *                <code>lastLaunchedTime</code> data is available starting April 2017.</p>
@@ -4974,8 +4974,9 @@ export interface InstanceCreditSpecification {
   InstanceId?: string;
 
   /**
-   * <p>The credit option for CPU usage of the instance. Valid values are
-   *                 <code>standard</code> and <code>unlimited</code>.</p>
+   * <p>The credit option for CPU usage of the instance.</p>
+   *         <p>Valid values: <code>standard</code> | <code>unlimited</code>
+   *          </p>
    */
   CpuCredits?: string;
 }

diff --git a/clients/client-ec2/src/models/models_4.ts b/clients/client-ec2/src/models/models_4.ts
@@ -3581,8 +3581,9 @@ export interface InstanceNetworkInterfaceSpecification {
 
   /**
    * <p>Indicates whether to assign a carrier IP address to the network interface.</p>
-   *         <p>You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone.
-   *             For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.</p>
+   *         <p>You can only assign a carrier IP address to a network interface that is in a subnet in
+   *             a Wavelength Zone. For more information about carrier IP addresses, see <a href="https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip">Carrier IP address</a> in the <i>Amazon Web Services Wavelength Developer
+   *                 Guide</i>.</p>
    */
   AssociateCarrierIpAddress?: boolean;
 

diff --git a/clients/client-ec2/src/models/models_5.ts b/clients/client-ec2/src/models/models_5.ts
@@ -159,8 +159,7 @@ export interface ExportImageRequest {
   ImageId: string | undefined;
 
   /**
-   * <p>Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE
-   *    and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com.</p>
+   * <p>The Amazon S3 bucket for the destination image. The destination bucket must exist.</p>
    */
   S3ExportLocation: ExportTaskS3LocationRequest | undefined;
 
@@ -4454,8 +4453,9 @@ export interface InstanceCreditSpecificationRequest {
   InstanceId?: string;
 
   /**
-   * <p>The credit option for CPU usage of the instance. Valid values are
-   *                 <code>standard</code> and <code>unlimited</code>.</p>
+   * <p>The credit option for CPU usage of the instance.</p>
+   *         <p>Valid values: <code>standard</code> | <code>unlimited</code>
+   *          </p>
    *         <p>T3 instances with <code>host</code> tenancy do not support the <code>unlimited</code>
    *             CPU credit option.</p>
    */

diff --git a/clients/client-ec2/src/models/models_6.ts b/clients/client-ec2/src/models/models_6.ts
@@ -2090,7 +2090,7 @@ export interface RunInstancesRequest {
    *             launch, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html">
    *                 ModifyInstanceCreditSpecification</a>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html">Burstable
    *                     performance instances</a> in the <i>Amazon EC2 User Guide</i>.</p>
-   *         <p>Default: <code>standard</code> (T2 instances) or <code>unlimited</code> (T3/T3a
+   *         <p>Default: <code>standard</code> (T2 instances) or <code>unlimited</code> (T3/T3a/T4g
    *             instances)</p>
    *         <p>For T3 instances with <code>host</code> tenancy, only <code>standard</code> is
    *             supported.</p>