You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: clients/client-ec2/README.md
+52-2Lines changed: 52 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,8 +7,58 @@
7
7
AWS SDK for JavaScript EC2 Client for Node.js, Browser and React Native.
8
8
9
9
<fullname>Amazon Elastic Compute Cloud</fullname>
10
-
<p>You can access the features of Amazon Elastic Compute Cloud (Amazon EC2) programmatically. For more information,
11
-
see the <ahref="https://docs.aws.amazon.com/ec2/latest/devguide">Amazon EC2 Developer Guide</a>.</p>
10
+
<p>This is the <i>Amazon EC2 API Reference</i>. It provides descriptions, API request
11
+
parameters, and the XML response for each of the Amazon EC2 Query API actions. Note that the
12
+
Amazon EC2 API includes actions for Amazon EC2 plus additional services, such as Amazon EBS and Amazon VPC.</p>
13
+
<pclass="title">
14
+
<b>Learn more</b>
15
+
</p>
16
+
<ul>
17
+
<li>
18
+
<p>To learn about using the Query API, see
19
+
<ahref="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-low-level-api.html">Using the API for Amazon EC2</a>.</p>
20
+
</li>
21
+
<li>
22
+
<p>To learn about the permissions required to call an Amazon EC2 API action, see
23
+
<ahref="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonec2.html">Actions, resources, and condition keys for Amazon EC2</a>.</p>
24
+
</li>
25
+
<li>
26
+
<p>To get the list of API actions by service and resource, see
27
+
<ahref="https://docs.aws.amazon.com/ec2/latest/devguide/OperationList-query.html">Actions by service</a>.</p>
28
+
</li>
29
+
<li>
30
+
<p>To get the alphabetical list of API actions, see
31
+
.</p>
32
+
</li>
33
+
<li>
34
+
<p>To get descriptions of the API error codes, see
35
+
<ahref="https://docs.aws.amazon.com/ec2/latest/devguide/errors-overview.html">Error codes for the Amazon EC2 API</a>.</p>
36
+
</li>
37
+
</ul>
38
+
<p>Alternatively, use one of the following methods to access the Amazon EC2 API, instead of using
39
+
the Query API directly:</p>
40
+
<ul>
41
+
<li>
42
+
<p>
43
+
<ahref="https://docs.aws.amazon.com/cli/latest/reference/ec2/">Amazon Web Services CLI Command Reference - ec2 commands</a>
44
+
</p>
45
+
</li>
46
+
<li>
47
+
<p>
48
+
<ahref="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/AWS_EC2.html">CloudFormation - Amazon EC2 resource type reference</a>
49
+
</p>
50
+
</li>
51
+
<li>
52
+
<p>
53
+
<ahref="https://docs.aws.amazon.com/powershell/v5/reference/items/EC2_cmdlets.html">Amazon Web Services Tools for PowerShell Cmdlet Reference - Amazon EC2 cmdlets</a>
54
+
</p>
55
+
</li>
56
+
<li>
57
+
<p>
58
+
<ahref="https://builder.aws.com/build/tools">Amazon Web Services SDKs</a>
* <p>You can access the features of Amazon Elastic Compute Cloud (Amazon EC2) programmatically. For more information,
20624
-
* see the <a href="https://docs.aws.amazon.com/ec2/latest/devguide">Amazon EC2 Developer Guide</a>.</p>
20623
+
* <p>This is the <i>Amazon EC2 API Reference</i>. It provides descriptions, API request
20624
+
* parameters, and the XML response for each of the Amazon EC2 Query API actions. Note that the
20625
+
* Amazon EC2 API includes actions for Amazon EC2 plus additional services, such as Amazon EBS and Amazon VPC.</p>
20626
+
* <p class="title">
20627
+
* <b>Learn more</b>
20628
+
* </p>
20629
+
* <ul>
20630
+
* <li>
20631
+
* <p>To learn about using the Query API, see
20632
+
* <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-low-level-api.html">Using the API for Amazon EC2</a>.</p>
20633
+
* </li>
20634
+
* <li>
20635
+
* <p>To learn about the permissions required to call an Amazon EC2 API action, see
20636
+
* <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonec2.html">Actions, resources, and condition keys for Amazon EC2</a>.</p>
20637
+
* </li>
20638
+
* <li>
20639
+
* <p>To get the list of API actions by service and resource, see
20640
+
* <a href="https://docs.aws.amazon.com/ec2/latest/devguide/OperationList-query.html">Actions by service</a>.</p>
20641
+
* </li>
20642
+
* <li>
20643
+
* <p>To get the alphabetical list of API actions, see
20644
+
* .</p>
20645
+
* </li>
20646
+
* <li>
20647
+
* <p>To get descriptions of the API error codes, see
20648
+
* <a href="https://docs.aws.amazon.com/ec2/latest/devguide/errors-overview.html">Error codes for the Amazon EC2 API</a>.</p>
20649
+
* </li>
20650
+
* </ul>
20651
+
* <p>Alternatively, use one of the following methods to access the Amazon EC2 API, instead of using
* <p>You can access the features of Amazon Elastic Compute Cloud (Amazon EC2) programmatically. For more information,
4531
-
* see the <a href="https://docs.aws.amazon.com/ec2/latest/devguide">Amazon EC2 Developer Guide</a>.</p>
4530
+
* <p>This is the <i>Amazon EC2 API Reference</i>. It provides descriptions, API request
4531
+
* parameters, and the XML response for each of the Amazon EC2 Query API actions. Note that the
4532
+
* Amazon EC2 API includes actions for Amazon EC2 plus additional services, such as Amazon EBS and Amazon VPC.</p>
4533
+
* <p class="title">
4534
+
* <b>Learn more</b>
4535
+
* </p>
4536
+
* <ul>
4537
+
* <li>
4538
+
* <p>To learn about using the Query API, see
4539
+
* <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-low-level-api.html">Using the API for Amazon EC2</a>.</p>
4540
+
* </li>
4541
+
* <li>
4542
+
* <p>To learn about the permissions required to call an Amazon EC2 API action, see
4543
+
* <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonec2.html">Actions, resources, and condition keys for Amazon EC2</a>.</p>
4544
+
* </li>
4545
+
* <li>
4546
+
* <p>To get the list of API actions by service and resource, see
4547
+
* <a href="https://docs.aws.amazon.com/ec2/latest/devguide/OperationList-query.html">Actions by service</a>.</p>
4548
+
* </li>
4549
+
* <li>
4550
+
* <p>To get the alphabetical list of API actions, see
4551
+
* .</p>
4552
+
* </li>
4553
+
* <li>
4554
+
* <p>To get descriptions of the API error codes, see
4555
+
* <a href="https://docs.aws.amazon.com/ec2/latest/devguide/errors-overview.html">Error codes for the Amazon EC2 API</a>.</p>
4556
+
* </li>
4557
+
* </ul>
4558
+
* <p>Alternatively, use one of the following methods to access the Amazon EC2 API, instead of using
* <p>You can access the features of Amazon Elastic Compute Cloud (Amazon EC2) programmatically. For more information,
6
-
* see the <a href="https://docs.aws.amazon.com/ec2/latest/devguide">Amazon EC2 Developer Guide</a>.</p>
5
+
* <p>This is the <i>Amazon EC2 API Reference</i>. It provides descriptions, API request
6
+
* parameters, and the XML response for each of the Amazon EC2 Query API actions. Note that the
7
+
* Amazon EC2 API includes actions for Amazon EC2 plus additional services, such as Amazon EBS and Amazon VPC.</p>
8
+
* <p class="title">
9
+
* <b>Learn more</b>
10
+
* </p>
11
+
* <ul>
12
+
* <li>
13
+
* <p>To learn about using the Query API, see
14
+
* <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-low-level-api.html">Using the API for Amazon EC2</a>.</p>
15
+
* </li>
16
+
* <li>
17
+
* <p>To learn about the permissions required to call an Amazon EC2 API action, see
18
+
* <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonec2.html">Actions, resources, and condition keys for Amazon EC2</a>.</p>
19
+
* </li>
20
+
* <li>
21
+
* <p>To get the list of API actions by service and resource, see
22
+
* <a href="https://docs.aws.amazon.com/ec2/latest/devguide/OperationList-query.html">Actions by service</a>.</p>
23
+
* </li>
24
+
* <li>
25
+
* <p>To get the alphabetical list of API actions, see
26
+
* .</p>
27
+
* </li>
28
+
* <li>
29
+
* <p>To get descriptions of the API error codes, see
30
+
* <a href="https://docs.aws.amazon.com/ec2/latest/devguide/errors-overview.html">Error codes for the Amazon EC2 API</a>.</p>
31
+
* </li>
32
+
* </ul>
33
+
* <p>Alternatively, use one of the following methods to access the Amazon EC2 API, instead of using
* <p>The public hostname type. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html">EC2 instance hostnames, DNS names, and domains</a> in the <i>Amazon EC2 User Guide</i>.</p>
9924
-
* <ul>
9925
-
* <li>
9926
-
* <p>
9927
-
* <code>public-dual-stack-dns-name</code>: A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface.</p>
9928
-
* </li>
9929
-
* <li>
9930
-
* <p>
9931
-
* <code>public-ipv4-dns-name</code>: An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface.</p>
9932
-
* </li>
9933
-
* <li>
9934
-
* <p>
9935
-
* <code>public-ipv6-dns-name</code>: An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface. </p>
9936
-
* </li>
9937
-
* </ul>
9938
-
* @public
9939
-
*/
9940
-
HostnameType: PublicIpDnsOption|undefined;
9941
-
9942
-
/**
9943
-
* <p>Checks whether you have the required permissions for the operation, without actually making the
9944
-
* request, and provides an error response. If you have the required permissions, the error response is
9945
-
* <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
0 commit comments