Skip to content

Commit

Permalink
feat(client-ec2): Documentation updates for Amazon EC2.
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Jul 29, 2022
1 parent d907155 commit 504891a
Show file tree
Hide file tree
Showing 35 changed files with 294 additions and 61 deletions.
102 changes: 95 additions & 7 deletions clients/client-ec2/src/EC2.ts

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions clients/client-ec2/src/commands/AllocateAddressCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ export interface AllocateAddressCommandOutput extends AllocateAddressResult, __M
* 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.</p>
* <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>
* <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>
* <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
Expand Down
4 changes: 4 additions & 0 deletions clients/client-ec2/src/commands/AssociateAddressCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ export interface AssociateAddressCommandOutput extends AssociateAddressResult, _
* Addresses</i> section of <a href="http://aws.amazon.com/ec2/pricing/">Amazon EC2
* Pricing</a>.</p>
* </important>
*
* <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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@ export interface AttachClassicLinkVpcCommandInput extends AttachClassicLinkVpcRe
export interface AttachClassicLinkVpcCommandOutput extends AttachClassicLinkVpcResult, __MetadataBearer {}

/**
* <p>Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's
* <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>
* <p>Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's
* 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
Expand Down
3 changes: 3 additions & 0 deletions clients/client-ec2/src/commands/CreateDefaultVpcCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ export interface CreateDefaultVpcCommandOutput extends CreateDefaultVpcResult, _
* 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 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
Expand Down
3 changes: 3 additions & 0 deletions clients/client-ec2/src/commands/DescribeAddressesCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ export interface DescribeAddressesCommandOutput extends DescribeAddressesResult,
* <p>Describes the specified Elastic IP addresses or all of your Elastic IP addresses.</p>
* <p>An Elastic IP address is for use in either the EC2-Classic platform or in a VPC.
* 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>
* <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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ export interface DescribeClassicLinkInstancesCommandOutput
* <p>Describes one or more of your linked EC2-Classic instances. This request only returns
* information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot
* use this request to return information about other instances.</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
Expand Down
3 changes: 3 additions & 0 deletions clients/client-ec2/src/commands/DescribeInstancesCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ export interface DescribeInstancesCommandOutput extends DescribeInstancesResult,
* not specify any instance IDs at all, the call fails. If you describe instances and
* specify only instance IDs that are in an unaffected zone, the call works
* normally.</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 EC2 User Guide</i>.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ export interface DescribeReservedInstancesCommandOutput extends DescribeReserved
* <p>Describes one or more of the Reserved Instances that you purchased.</p>
* <p>For more information about Reserved Instances, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved
* Instances</a> in the <i>Amazon EC2 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ export interface DescribeReservedInstancesModificationsCommandOutput
/**
* <p>Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the <i>Amazon EC2 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ export interface DescribeReservedInstancesOfferingsCommandOutput
* <p>If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a>
* in the <i>Amazon EC2 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ export interface DescribeScheduledInstanceAvailabilityCommandOutput
* <p>You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.</p>
* <p>After you find a schedule that meets your needs, call <a>PurchaseScheduledInstances</a>
* to purchase Scheduled Instances with that schedule.</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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ export interface DescribeScheduledInstancesCommandOutput extends DescribeSchedul

/**
* <p>Describes the specified Scheduled Instances or all your Scheduled Instances.</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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ export interface DescribeVpcClassicLinkCommandOutput extends DescribeVpcClassicL

/**
* <p>Describes the ClassicLink status of one or more VPCs.</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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@ export interface DescribeVpcClassicLinkDnsSupportCommandOutput
__MetadataBearer {}

/**
* <p>Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS
* <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>
* <p>Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS
* hostname of a linked EC2-Classic instance resolves to its private IP address when
* addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname
* of an instance in a VPC resolves to its private IP address when addressed from a linked
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@ export interface DetachClassicLinkVpcCommandInput extends DetachClassicLinkVpcRe
export interface DetachClassicLinkVpcCommandOutput extends DetachClassicLinkVpcResult, __MetadataBearer {}

/**
* <p>Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.</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>
* <p>Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ export interface DisableVpcClassicLinkCommandOutput extends DisableVpcClassicLin

/**
* <p>Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.</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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ export interface DisableVpcClassicLinkDnsSupportCommandOutput
* in the VPC to which it's linked. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the
* <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
* <p>You must specify a VPC ID in the request.</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
Expand Down
4 changes: 4 additions & 0 deletions clients/client-ec2/src/commands/DisassociateAddressCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ export interface DisassociateAddressCommandOutput extends __MetadataBearer {}
* <p>An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. 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>
*
* <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>
* <p>This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@ export interface EnableVpcClassicLinkCommandInput extends EnableVpcClassicLinkRe
export interface EnableVpcClassicLinkCommandOutput extends EnableVpcClassicLinkResult, __MetadataBearer {}

/**
* <p>Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your
* <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>
* <p>Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your
* ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot
* enable your VPC for ClassicLink if any of your VPC route tables have existing routes for
* address ranges within the <code>10.0.0.0/8</code> IP address range, excluding local
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@ export interface EnableVpcClassicLinkDnsSupportCommandOutput
__MetadataBearer {}

/**
* <p>Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS
* <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>
* <p>Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS
* hostname of a linked EC2-Classic instance resolves to its private IP address when
* addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname
* of an instance in a VPC resolves to its private IP address when addressed from a linked
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ export interface ModifyReservedInstancesCommandOutput extends ModifyReservedInst
* type.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved
* Instances</a> in the <i>Amazon EC2 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@ export interface ModifyVpcPeeringConnectionOptionsCommandOutput
__MetadataBearer {}

/**
* <p>Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:</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>
* <p>Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:</p>
* <ul>
* <li>
* <p>Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.</p>
Expand Down
Loading

0 comments on commit 504891a

Please sign in to comment.