Skip to content

Commit 404a00a

Browse files
author
awstools
committed
feat(client-ec2): Documentation updates for Amazon EC2.
1 parent fc14586 commit 404a00a

File tree

155 files changed

+8894
-8839
lines changed

Some content is hidden

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

155 files changed

+8894
-8839
lines changed

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ export interface AllocateAddressCommandOutput extends AllocateAddressResult, __M
5252
* PublicIpv4Pool: "STRING_VALUE",
5353
* NetworkBorderGroup: "STRING_VALUE",
5454
* CustomerOwnedIpv4Pool: "STRING_VALUE",
55-
* DryRun: true || false,
5655
* TagSpecifications: [ // TagSpecificationList
5756
* { // TagSpecification
5857
* 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
6564
* },
6665
* ],
6766
* IpamPoolId: "STRING_VALUE",
67+
* DryRun: true || false,
6868
* };
6969
* const command = new AllocateAddressCommand(input);
7070
* const response = await client.send(command);
7171
* // { // AllocateAddressResult
72-
* // PublicIp: "STRING_VALUE",
7372
* // AllocationId: "STRING_VALUE",
7473
* // PublicIpv4Pool: "STRING_VALUE",
7574
* // NetworkBorderGroup: "STRING_VALUE",
7675
* // Domain: "vpc" || "standard",
7776
* // CustomerOwnedIp: "STRING_VALUE",
7877
* // CustomerOwnedIpv4Pool: "STRING_VALUE",
7978
* // CarrierIp: "STRING_VALUE",
79+
* // PublicIp: "STRING_VALUE",
8080
* // };
8181
*
8282
* ```

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,7 @@ export interface AllocateHostsCommandOutput extends AllocateHostsResult, __Metad
3838
* // const { EC2Client, AllocateHostsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
3939
* const client = new EC2Client(config);
4040
* const input = { // AllocateHostsRequest
41-
* AutoPlacement: "on" || "off",
42-
* AvailabilityZone: "STRING_VALUE", // required
43-
* ClientToken: "STRING_VALUE",
44-
* InstanceType: "STRING_VALUE",
4541
* InstanceFamily: "STRING_VALUE",
46-
* Quantity: Number("int"),
4742
* TagSpecifications: [ // TagSpecificationList
4843
* { // TagSpecification
4944
* 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
6156
* AssetIds: [ // AssetIdList
6257
* "STRING_VALUE",
6358
* ],
59+
* AutoPlacement: "on" || "off",
60+
* ClientToken: "STRING_VALUE",
61+
* InstanceType: "STRING_VALUE",
62+
* Quantity: Number("int"),
63+
* AvailabilityZone: "STRING_VALUE", // required
6464
* };
6565
* const command = new AllocateHostsCommand(input);
6666
* const response = await client.send(command);

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,15 @@ export interface AssignIpv6AddressesCommandOutput extends AssignIpv6AddressesRes
4545
* // const { EC2Client, AssignIpv6AddressesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
4646
* const client = new EC2Client(config);
4747
* const input = { // AssignIpv6AddressesRequest
48-
* Ipv6AddressCount: Number("int"),
49-
* Ipv6Addresses: [ // Ipv6AddressList
50-
* "STRING_VALUE",
51-
* ],
5248
* Ipv6PrefixCount: Number("int"),
5349
* Ipv6Prefixes: [ // IpPrefixList
5450
* "STRING_VALUE",
5551
* ],
5652
* NetworkInterfaceId: "STRING_VALUE", // required
53+
* Ipv6Addresses: [ // Ipv6AddressList
54+
* "STRING_VALUE",
55+
* ],
56+
* Ipv6AddressCount: Number("int"),
5757
* };
5858
* const command = new AssignIpv6AddressesCommand(input);
5959
* const response = await client.send(command);

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -50,16 +50,16 @@ export interface AssignPrivateIpAddressesCommandOutput extends AssignPrivateIpAd
5050
* // const { EC2Client, AssignPrivateIpAddressesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
5151
* const client = new EC2Client(config);
5252
* const input = { // AssignPrivateIpAddressesRequest
53-
* AllowReassignment: true || false,
53+
* Ipv4Prefixes: [ // IpPrefixList
54+
* "STRING_VALUE",
55+
* ],
56+
* Ipv4PrefixCount: Number("int"),
5457
* NetworkInterfaceId: "STRING_VALUE", // required
5558
* PrivateIpAddresses: [ // PrivateIpAddressStringList
5659
* "STRING_VALUE",
5760
* ],
5861
* SecondaryPrivateIpAddressCount: Number("int"),
59-
* Ipv4Prefixes: [ // IpPrefixList
60-
* "STRING_VALUE",
61-
* ],
62-
* Ipv4PrefixCount: Number("int"),
62+
* AllowReassignment: true || false,
6363
* };
6464
* const command = new AssignPrivateIpAddressesCommand(input);
6565
* const response = await client.send(command);

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export interface AssignPrivateNatGatewayAddressCommandOutput
3434

3535
/**
3636
* <p>Assigns private IPv4 addresses to a private NAT gateway. For more information, see
37-
* <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>
37+
* <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>
3838
* @example
3939
* Use a bare-bones client and the command you need to make an API call.
4040
* ```javascript

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,10 @@ export interface AssociateAddressCommandOutput extends AssociateAddressResult, _
5656
* AllocationId: "STRING_VALUE",
5757
* InstanceId: "STRING_VALUE",
5858
* PublicIp: "STRING_VALUE",
59-
* AllowReassociation: true || false,
6059
* DryRun: true || false,
6160
* NetworkInterfaceId: "STRING_VALUE",
6261
* PrivateIpAddress: "STRING_VALUE",
62+
* AllowReassociation: true || false,
6363
* };
6464
* const command = new AssociateAddressCommand(input);
6565
* const response = await client.send(command);

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

+6-2
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,15 @@ export interface AssociateNatGatewayAddressCommandOutput extends AssociateNatGat
2929

3030
/**
3131
* <p>Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information,
32-
* 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>
32+
* 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>
3333
* <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.
3434
* 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>
3535
* <important>
36-
* <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>.
36+
* <p>When you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the EIPs
37+
* must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same,
38+
* 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.
39+
* Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information
40+
* 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>.
3741
* </p>
3842
* </important>
3943
* @example

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ export interface AssociateRouteTableCommandOutput extends AssociateRouteTableRes
4242
* // const { EC2Client, AssociateRouteTableCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
4343
* const client = new EC2Client(config);
4444
* const input = { // AssociateRouteTableRequest
45+
* GatewayId: "STRING_VALUE",
4546
* DryRun: true || false,
46-
* RouteTableId: "STRING_VALUE", // required
4747
* SubnetId: "STRING_VALUE",
48-
* GatewayId: "STRING_VALUE",
48+
* RouteTableId: "STRING_VALUE", // required
4949
* };
5050
* const command = new AssociateRouteTableCommand(input);
5151
* const response = await client.send(command);

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ export interface AssociateSubnetCidrBlockCommandOutput extends AssociateSubnetCi
3737
* // const { EC2Client, AssociateSubnetCidrBlockCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
3838
* const client = new EC2Client(config);
3939
* const input = { // AssociateSubnetCidrBlockRequest
40-
* Ipv6CidrBlock: "STRING_VALUE",
41-
* SubnetId: "STRING_VALUE", // required
4240
* Ipv6IpamPoolId: "STRING_VALUE",
4341
* Ipv6NetmaskLength: Number("int"),
42+
* SubnetId: "STRING_VALUE", // required
43+
* Ipv6CidrBlock: "STRING_VALUE",
4444
* };
4545
* const command = new AssociateSubnetCidrBlockCommand(input);
4646
* const response = await client.send(command);

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,16 +43,16 @@ export interface AssociateVpcCidrBlockCommandOutput extends AssociateVpcCidrBloc
4343
* // const { EC2Client, AssociateVpcCidrBlockCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
4444
* const client = new EC2Client(config);
4545
* const input = { // AssociateVpcCidrBlockRequest
46-
* AmazonProvidedIpv6CidrBlock: true || false,
4746
* CidrBlock: "STRING_VALUE",
48-
* VpcId: "STRING_VALUE", // required
4947
* Ipv6CidrBlockNetworkBorderGroup: "STRING_VALUE",
5048
* Ipv6Pool: "STRING_VALUE",
5149
* Ipv6CidrBlock: "STRING_VALUE",
5250
* Ipv4IpamPoolId: "STRING_VALUE",
5351
* Ipv4NetmaskLength: Number("int"),
5452
* Ipv6IpamPoolId: "STRING_VALUE",
5553
* Ipv6NetmaskLength: Number("int"),
54+
* VpcId: "STRING_VALUE", // required
55+
* AmazonProvidedIpv6CidrBlock: true || false,
5656
* };
5757
* const command = new AssociateVpcCidrBlockCommand(input);
5858
* const response = await client.send(command);

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ export interface AttachClassicLinkVpcCommandOutput extends AttachClassicLinkVpcR
4646
* const client = new EC2Client(config);
4747
* const input = { // AttachClassicLinkVpcRequest
4848
* DryRun: true || false,
49+
* InstanceId: "STRING_VALUE", // required
50+
* VpcId: "STRING_VALUE", // required
4951
* Groups: [ // GroupIdStringList // required
5052
* "STRING_VALUE",
5153
* ],
52-
* InstanceId: "STRING_VALUE", // required
53-
* VpcId: "STRING_VALUE", // required
5454
* };
5555
* const command = new AttachClassicLinkVpcCommand(input);
5656
* const response = await client.send(command);

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,17 @@ export interface AttachNetworkInterfaceCommandOutput extends AttachNetworkInterf
3636
* // const { EC2Client, AttachNetworkInterfaceCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
3737
* const client = new EC2Client(config);
3838
* const input = { // AttachNetworkInterfaceRequest
39-
* DeviceIndex: Number("int"), // required
40-
* DryRun: true || false,
41-
* InstanceId: "STRING_VALUE", // required
42-
* NetworkInterfaceId: "STRING_VALUE", // required
4339
* NetworkCardIndex: Number("int"),
4440
* EnaSrdSpecification: { // EnaSrdSpecification
4541
* EnaSrdEnabled: true || false,
4642
* EnaSrdUdpSpecification: { // EnaSrdUdpSpecification
4743
* EnaSrdUdpEnabled: true || false,
4844
* },
4945
* },
46+
* DryRun: true || false,
47+
* NetworkInterfaceId: "STRING_VALUE", // required
48+
* InstanceId: "STRING_VALUE", // required
49+
* DeviceIndex: Number("int"), // required
5050
* };
5151
* const command = new AttachNetworkInterfaceCommand(input);
5252
* const response = await client.send(command);

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -68,14 +68,14 @@ export interface AttachVolumeCommandOutput extends VolumeAttachment, __MetadataB
6868
* const command = new AttachVolumeCommand(input);
6969
* const response = await client.send(command);
7070
* // { // VolumeAttachment
71-
* // AttachTime: new Date("TIMESTAMP"),
72-
* // Device: "STRING_VALUE",
73-
* // InstanceId: "STRING_VALUE",
74-
* // State: "attaching" || "attached" || "detaching" || "detached" || "busy",
75-
* // VolumeId: "STRING_VALUE",
7671
* // DeleteOnTermination: true || false,
7772
* // AssociatedResource: "STRING_VALUE",
7873
* // InstanceOwningService: "STRING_VALUE",
74+
* // VolumeId: "STRING_VALUE",
75+
* // InstanceId: "STRING_VALUE",
76+
* // Device: "STRING_VALUE",
77+
* // State: "attaching" || "attached" || "detaching" || "detached" || "busy",
78+
* // AttachTime: new Date("TIMESTAMP"),
7979
* // };
8080
*
8181
* ```

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface AttachVpnGatewayCommandInput extends AttachVpnGatewayRequest {}
2828
export interface AttachVpnGatewayCommandOutput extends AttachVpnGatewayResult, __MetadataBearer {}
2929

3030
/**
31-
* <p>Attaches a virtual private gateway to a VPC. You can attach one virtual private
31+
* <p>Attaches an available virtual private gateway to a VPC. You can attach one virtual private
3232
* gateway to one VPC at a time.</p>
3333
* <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
3434
* User Guide</i>.</p>
@@ -47,8 +47,8 @@ export interface AttachVpnGatewayCommandOutput extends AttachVpnGatewayResult, _
4747
* const response = await client.send(command);
4848
* // { // AttachVpnGatewayResult
4949
* // VpcAttachment: { // VpcAttachment
50-
* // State: "attaching" || "attached" || "detaching" || "detached",
5150
* // VpcId: "STRING_VALUE",
51+
* // State: "attaching" || "attached" || "detaching" || "detached",
5252
* // },
5353
* // };
5454
*

0 commit comments

Comments
 (0)