feat(client-ec2): Documentation updates for Amazon EC2.

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

@@ -52,7 +52,6 @@ export interface AllocateAddressCommandOutput extends AllocateAddressResult, __M
  *   PublicIpv4Pool: "STRING_VALUE",
  *   NetworkBorderGroup: "STRING_VALUE",
  *   CustomerOwnedIpv4Pool: "STRING_VALUE",
- *   DryRun: true || false,
  *   TagSpecifications: [ // TagSpecificationList
  *     { // TagSpecification
  *       ResourceType: "capacity-reservation" || "client-vpn-endpoint" || "customer-gateway" || "carrier-gateway" || "coip-pool" || "dedicated-host" || "dhcp-options" || "egress-only-internet-gateway" || "elastic-ip" || "elastic-gpu" || "export-image-task" || "export-instance-task" || "fleet" || "fpga-image" || "host-reservation" || "image" || "import-image-task" || "import-snapshot-task" || "instance" || "instance-event-window" || "internet-gateway" || "ipam" || "ipam-pool" || "ipam-scope" || "ipv4pool-ec2" || "ipv6pool-ec2" || "key-pair" || "launch-template" || "local-gateway" || "local-gateway-route-table" || "local-gateway-virtual-interface" || "local-gateway-virtual-interface-group" || "local-gateway-route-table-vpc-association" || "local-gateway-route-table-virtual-interface-group-association" || "natgateway" || "network-acl" || "network-interface" || "network-insights-analysis" || "network-insights-path" || "network-insights-access-scope" || "network-insights-access-scope-analysis" || "placement-group" || "prefix-list" || "replace-root-volume-task" || "reserved-instances" || "route-table" || "security-group" || "security-group-rule" || "snapshot" || "spot-fleet-request" || "spot-instances-request" || "subnet" || "subnet-cidr-reservation" || "traffic-mirror-filter" || "traffic-mirror-session" || "traffic-mirror-target" || "transit-gateway" || "transit-gateway-attachment" || "transit-gateway-connect-peer" || "transit-gateway-multicast-domain" || "transit-gateway-policy-table" || "transit-gateway-route-table" || "transit-gateway-route-table-announcement" || "volume" || "vpc" || "vpc-endpoint" || "vpc-endpoint-connection" || "vpc-endpoint-service" || "vpc-endpoint-service-permission" || "vpc-peering-connection" || "vpn-connection" || "vpn-gateway" || "vpc-flow-log" || "capacity-reservation-fleet" || "traffic-mirror-filter-rule" || "vpc-endpoint-connection-device-type" || "verified-access-instance" || "verified-access-group" || "verified-access-endpoint" || "verified-access-policy" || "verified-access-trust-provider" || "vpn-connection-device-type" || "vpc-block-public-access-exclusion" || "ipam-resource-discovery" || "ipam-resource-discovery-association" || "instance-connect-endpoint" || "ipam-external-resource-verification-token",
@@ -65,18 +64,19 @@ export interface AllocateAddressCommandOutput extends AllocateAddressResult, __M
  *     },
  *   ],
  *   IpamPoolId: "STRING_VALUE",
+ *   DryRun: true || false,
  * };
  * const command = new AllocateAddressCommand(input);
  * const response = await client.send(command);
  * // { // AllocateAddressResult
- * //   PublicIp: "STRING_VALUE",
  * //   AllocationId: "STRING_VALUE",
  * //   PublicIpv4Pool: "STRING_VALUE",
  * //   NetworkBorderGroup: "STRING_VALUE",
  * //   Domain: "vpc" || "standard",
  * //   CustomerOwnedIp: "STRING_VALUE",
  * //   CustomerOwnedIpv4Pool: "STRING_VALUE",
  * //   CarrierIp: "STRING_VALUE",
+ * //   PublicIp: "STRING_VALUE",
  * // };
  *
  * ```

clients/client-ec2/src/commands/AllocateHostsCommand.ts

@@ -38,12 +38,7 @@ export interface AllocateHostsCommandOutput extends AllocateHostsResult, __Metad
  * // const { EC2Client, AllocateHostsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
  * const client = new EC2Client(config);
  * const input = { // AllocateHostsRequest
- *   AutoPlacement: "on" || "off",
- *   AvailabilityZone: "STRING_VALUE", // required
- *   ClientToken: "STRING_VALUE",
- *   InstanceType: "STRING_VALUE",
  *   InstanceFamily: "STRING_VALUE",
- *   Quantity: Number("int"),
  *   TagSpecifications: [ // TagSpecificationList
  *     { // TagSpecification
  *       ResourceType: "capacity-reservation" || "client-vpn-endpoint" || "customer-gateway" || "carrier-gateway" || "coip-pool" || "dedicated-host" || "dhcp-options" || "egress-only-internet-gateway" || "elastic-ip" || "elastic-gpu" || "export-image-task" || "export-instance-task" || "fleet" || "fpga-image" || "host-reservation" || "image" || "import-image-task" || "import-snapshot-task" || "instance" || "instance-event-window" || "internet-gateway" || "ipam" || "ipam-pool" || "ipam-scope" || "ipv4pool-ec2" || "ipv6pool-ec2" || "key-pair" || "launch-template" || "local-gateway" || "local-gateway-route-table" || "local-gateway-virtual-interface" || "local-gateway-virtual-interface-group" || "local-gateway-route-table-vpc-association" || "local-gateway-route-table-virtual-interface-group-association" || "natgateway" || "network-acl" || "network-interface" || "network-insights-analysis" || "network-insights-path" || "network-insights-access-scope" || "network-insights-access-scope-analysis" || "placement-group" || "prefix-list" || "replace-root-volume-task" || "reserved-instances" || "route-table" || "security-group" || "security-group-rule" || "snapshot" || "spot-fleet-request" || "spot-instances-request" || "subnet" || "subnet-cidr-reservation" || "traffic-mirror-filter" || "traffic-mirror-session" || "traffic-mirror-target" || "transit-gateway" || "transit-gateway-attachment" || "transit-gateway-connect-peer" || "transit-gateway-multicast-domain" || "transit-gateway-policy-table" || "transit-gateway-route-table" || "transit-gateway-route-table-announcement" || "volume" || "vpc" || "vpc-endpoint" || "vpc-endpoint-connection" || "vpc-endpoint-service" || "vpc-endpoint-service-permission" || "vpc-peering-connection" || "vpn-connection" || "vpn-gateway" || "vpc-flow-log" || "capacity-reservation-fleet" || "traffic-mirror-filter-rule" || "vpc-endpoint-connection-device-type" || "verified-access-instance" || "verified-access-group" || "verified-access-endpoint" || "verified-access-policy" || "verified-access-trust-provider" || "vpn-connection-device-type" || "vpc-block-public-access-exclusion" || "ipam-resource-discovery" || "ipam-resource-discovery-association" || "instance-connect-endpoint" || "ipam-external-resource-verification-token",
@@ -61,6 +56,11 @@ export interface AllocateHostsCommandOutput extends AllocateHostsResult, __Metad
  *   AssetIds: [ // AssetIdList
  *     "STRING_VALUE",
  *   ],
+ *   AutoPlacement: "on" || "off",
+ *   ClientToken: "STRING_VALUE",
+ *   InstanceType: "STRING_VALUE",
+ *   Quantity: Number("int"),
+ *   AvailabilityZone: "STRING_VALUE", // required
  * };
  * const command = new AllocateHostsCommand(input);
  * const response = await client.send(command);

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

@@ -45,15 +45,15 @@ export interface AssignIpv6AddressesCommandOutput extends AssignIpv6AddressesRes
  * // const { EC2Client, AssignIpv6AddressesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
  * const client = new EC2Client(config);
  * const input = { // AssignIpv6AddressesRequest
- *   Ipv6AddressCount: Number("int"),
- *   Ipv6Addresses: [ // Ipv6AddressList
- *     "STRING_VALUE",
- *   ],
  *   Ipv6PrefixCount: Number("int"),
  *   Ipv6Prefixes: [ // IpPrefixList
  *     "STRING_VALUE",
  *   ],
  *   NetworkInterfaceId: "STRING_VALUE", // required
+ *   Ipv6Addresses: [ // Ipv6AddressList
+ *     "STRING_VALUE",
+ *   ],
+ *   Ipv6AddressCount: Number("int"),
  * };
  * const command = new AssignIpv6AddressesCommand(input);
  * const response = await client.send(command);

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

@@ -50,16 +50,16 @@ export interface AssignPrivateIpAddressesCommandOutput extends AssignPrivateIpAd
  * // const { EC2Client, AssignPrivateIpAddressesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
  * const client = new EC2Client(config);
  * const input = { // AssignPrivateIpAddressesRequest
- *   AllowReassignment: true || false,
+ *   Ipv4Prefixes: [ // IpPrefixList
+ *     "STRING_VALUE",
+ *   ],
+ *   Ipv4PrefixCount: Number("int"),
  *   NetworkInterfaceId: "STRING_VALUE", // required
  *   PrivateIpAddresses: [ // PrivateIpAddressStringList
  *     "STRING_VALUE",
  *   ],
  *   SecondaryPrivateIpAddressCount: Number("int"),
- *   Ipv4Prefixes: [ // IpPrefixList
- *     "STRING_VALUE",
- *   ],
- *   Ipv4PrefixCount: Number("int"),
+ *   AllowReassignment: true || false,
  * };
  * const command = new AssignPrivateIpAddressesCommand(input);
  * const response = await client.send(command);

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

@@ -34,7 +34,7 @@ export interface AssignPrivateNatGatewayAddressCommandOutput
 
 /**
  * <p>Assigns private IPv4 addresses to a private NAT gateway. For more information, 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>
+ *             <a href="https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html">Work with NAT gateways</a> in the <i>Amazon VPC User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-ec2/src/commands/AssociateAddressCommand.ts

@@ -56,10 +56,10 @@ export interface AssociateAddressCommandOutput extends AssociateAddressResult, _
  *   AllocationId: "STRING_VALUE",
  *   InstanceId: "STRING_VALUE",
  *   PublicIp: "STRING_VALUE",
- *   AllowReassociation: true || false,
  *   DryRun: true || false,
  *   NetworkInterfaceId: "STRING_VALUE",
  *   PrivateIpAddress: "STRING_VALUE",
+ *   AllowReassociation: true || false,
  * };
  * const command = new AssociateAddressCommand(input);
  * const response = await client.send(command);

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

@@ -29,11 +29,15 @@ export interface AssociateNatGatewayAddressCommandOutput extends AssociateNatGat
 
 /**
  * <p>Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information,
- *             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>
+ *             see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html">Work with NAT gateways</a> in the <i>Amazon VPC User Guide</i>.</p>
  *          <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>
  *          <important>
- *             <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>.
+ *             <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/WorkWithEIPs.html">Allocate an Elastic IP address</a> in the <i>Amazon VPC User Guide</i>.
  *         </p>
  *          </important>
  * @example

clients/client-ec2/src/commands/AssociateRouteTableCommand.ts

@@ -42,10 +42,10 @@ export interface AssociateRouteTableCommandOutput extends AssociateRouteTableRes
  * // const { EC2Client, AssociateRouteTableCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
  * const client = new EC2Client(config);
  * const input = { // AssociateRouteTableRequest
+ *   GatewayId: "STRING_VALUE",
  *   DryRun: true || false,
- *   RouteTableId: "STRING_VALUE", // required
  *   SubnetId: "STRING_VALUE",
- *   GatewayId: "STRING_VALUE",
+ *   RouteTableId: "STRING_VALUE", // required
  * };
  * const command = new AssociateRouteTableCommand(input);
  * const response = await client.send(command);

clients/client-ec2/src/commands/AssociateSubnetCidrBlockCommand.ts

@@ -37,10 +37,10 @@ export interface AssociateSubnetCidrBlockCommandOutput extends AssociateSubnetCi
  * // const { EC2Client, AssociateSubnetCidrBlockCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
  * const client = new EC2Client(config);
  * const input = { // AssociateSubnetCidrBlockRequest
- *   Ipv6CidrBlock: "STRING_VALUE",
- *   SubnetId: "STRING_VALUE", // required
  *   Ipv6IpamPoolId: "STRING_VALUE",
  *   Ipv6NetmaskLength: Number("int"),
+ *   SubnetId: "STRING_VALUE", // required
+ *   Ipv6CidrBlock: "STRING_VALUE",
  * };
  * const command = new AssociateSubnetCidrBlockCommand(input);
  * const response = await client.send(command);

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

@@ -43,16 +43,16 @@ export interface AssociateVpcCidrBlockCommandOutput extends AssociateVpcCidrBloc
  * // const { EC2Client, AssociateVpcCidrBlockCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
  * const client = new EC2Client(config);
  * const input = { // AssociateVpcCidrBlockRequest
- *   AmazonProvidedIpv6CidrBlock: true || false,
  *   CidrBlock: "STRING_VALUE",
- *   VpcId: "STRING_VALUE", // required
  *   Ipv6CidrBlockNetworkBorderGroup: "STRING_VALUE",
  *   Ipv6Pool: "STRING_VALUE",
  *   Ipv6CidrBlock: "STRING_VALUE",
  *   Ipv4IpamPoolId: "STRING_VALUE",
  *   Ipv4NetmaskLength: Number("int"),
  *   Ipv6IpamPoolId: "STRING_VALUE",
  *   Ipv6NetmaskLength: Number("int"),
+ *   VpcId: "STRING_VALUE", // required
+ *   AmazonProvidedIpv6CidrBlock: true || false,
  * };
  * const command = new AssociateVpcCidrBlockCommand(input);
  * const response = await client.send(command);

clients/client-ec2/src/commands/AttachClassicLinkVpcCommand.ts

@@ -46,11 +46,11 @@ export interface AttachClassicLinkVpcCommandOutput extends AttachClassicLinkVpcR
  * const client = new EC2Client(config);
  * const input = { // AttachClassicLinkVpcRequest
  *   DryRun: true || false,
+ *   InstanceId: "STRING_VALUE", // required
+ *   VpcId: "STRING_VALUE", // required
  *   Groups: [ // GroupIdStringList // required
  *     "STRING_VALUE",
  *   ],
- *   InstanceId: "STRING_VALUE", // required
- *   VpcId: "STRING_VALUE", // required
  * };
  * const command = new AttachClassicLinkVpcCommand(input);
  * const response = await client.send(command);

clients/client-ec2/src/commands/AttachNetworkInterfaceCommand.ts

@@ -36,17 +36,17 @@ export interface AttachNetworkInterfaceCommandOutput extends AttachNetworkInterf
  * // const { EC2Client, AttachNetworkInterfaceCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
  * const client = new EC2Client(config);
  * const input = { // AttachNetworkInterfaceRequest
- *   DeviceIndex: Number("int"), // required
- *   DryRun: true || false,
- *   InstanceId: "STRING_VALUE", // required
- *   NetworkInterfaceId: "STRING_VALUE", // required
  *   NetworkCardIndex: Number("int"),
  *   EnaSrdSpecification: { // EnaSrdSpecification
  *     EnaSrdEnabled: true || false,
  *     EnaSrdUdpSpecification: { // EnaSrdUdpSpecification
  *       EnaSrdUdpEnabled: true || false,
  *     },
  *   },
+ *   DryRun: true || false,
+ *   NetworkInterfaceId: "STRING_VALUE", // required
+ *   InstanceId: "STRING_VALUE", // required
+ *   DeviceIndex: Number("int"), // required
  * };
  * const command = new AttachNetworkInterfaceCommand(input);
  * const response = await client.send(command);

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

@@ -68,14 +68,14 @@ export interface AttachVolumeCommandOutput extends VolumeAttachment, __MetadataB
  * const command = new AttachVolumeCommand(input);
  * const response = await client.send(command);
  * // { // VolumeAttachment
- * //   AttachTime: new Date("TIMESTAMP"),
- * //   Device: "STRING_VALUE",
- * //   InstanceId: "STRING_VALUE",
- * //   State: "attaching" || "attached" || "detaching" || "detached" || "busy",
- * //   VolumeId: "STRING_VALUE",
  * //   DeleteOnTermination: true || false,
  * //   AssociatedResource: "STRING_VALUE",
  * //   InstanceOwningService: "STRING_VALUE",
+ * //   VolumeId: "STRING_VALUE",
+ * //   InstanceId: "STRING_VALUE",
+ * //   Device: "STRING_VALUE",
+ * //   State: "attaching" || "attached" || "detaching" || "detached" || "busy",
+ * //   AttachTime: new Date("TIMESTAMP"),
  * // };
  *
  * ```

clients/client-ec2/src/commands/AttachVpnGatewayCommand.ts

@@ -28,7 +28,7 @@ export interface AttachVpnGatewayCommandInput extends AttachVpnGatewayRequest {}
 export interface AttachVpnGatewayCommandOutput extends AttachVpnGatewayResult, __MetadataBearer {}
 
 /**
- * <p>Attaches a virtual private gateway to a VPC. You can attach one virtual private
+ * <p>Attaches an available virtual private gateway to a VPC. You can attach one virtual private
  *             gateway to one VPC at a time.</p>
  *          <p>For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html">Amazon Web Services Site-to-Site VPN</a> in the <i>Amazon Web Services Site-to-Site VPN
  *                 User Guide</i>.</p>
@@ -47,8 +47,8 @@ export interface AttachVpnGatewayCommandOutput extends AttachVpnGatewayResult, _
  * const response = await client.send(command);
  * // { // AttachVpnGatewayResult
  * //   VpcAttachment: { // VpcAttachment
- * //     State: "attaching" || "attached" || "detaching" || "detached",
  * //     VpcId: "STRING_VALUE",
+ * //     State: "attaching" || "attached" || "detaching" || "detached",
  * //   },
  * // };
  *