ZTWHHH commited on
Commit
071aea2
·
verified ·
1 Parent(s): 2d9b2d6

Add files using upload-large-folder tool

Browse files
This view is limited to 50 files because it contains too many changes.   See raw diff
Files changed (50) hide show
  1. data/lib/python3.10/site-packages/awscli/examples/ec2/accept-transit-gateway-peering-attachment.rst +29 -0
  2. data/lib/python3.10/site-packages/awscli/examples/ec2/accept-vpc-peering-connection.rst +30 -0
  3. data/lib/python3.10/site-packages/awscli/examples/ec2/assign-ipv6-addresses.rst +35 -0
  4. data/lib/python3.10/site-packages/awscli/examples/ec2/associate-transit-gateway-route-table.rst +21 -0
  5. data/lib/python3.10/site-packages/awscli/examples/ec2/cancel-capacity-reservation.rst +14 -0
  6. data/lib/python3.10/site-packages/awscli/examples/ec2/cancel-conversion-task.rst +7 -0
  7. data/lib/python3.10/site-packages/awscli/examples/ec2/cancel-export-task.rst +7 -0
  8. data/lib/python3.10/site-packages/awscli/examples/ec2/create-customer-gateway.rst +19 -0
  9. data/lib/python3.10/site-packages/awscli/examples/ec2/create-egress-only-internet-gateway.rst +21 -0
  10. data/lib/python3.10/site-packages/awscli/examples/ec2/create-fpga-image.rst +14 -0
  11. data/lib/python3.10/site-packages/awscli/examples/ec2/create-instance-export-task.rst +28 -0
  12. data/lib/python3.10/site-packages/awscli/examples/ec2/create-ipam-resource-discovery.rst +46 -0
  13. data/lib/python3.10/site-packages/awscli/examples/ec2/create-launch-template.rst +108 -0
  14. data/lib/python3.10/site-packages/awscli/examples/ec2/create-local-gateway-route-table-vpc-association.rst +19 -0
  15. data/lib/python3.10/site-packages/awscli/examples/ec2/create-traffic-mirror-filter-rule.rst +32 -0
  16. data/lib/python3.10/site-packages/awscli/examples/ec2/create-traffic-mirror-session.rst +31 -0
  17. data/lib/python3.10/site-packages/awscli/examples/ec2/create-vpn-connection.rst +170 -0
  18. data/lib/python3.10/site-packages/awscli/examples/ec2/delete-carrier-gateway.rst +20 -0
  19. data/lib/python3.10/site-packages/awscli/examples/ec2/delete-fleets.rst +45 -0
  20. data/lib/python3.10/site-packages/awscli/examples/ec2/delete-launch-template.rst +20 -0
  21. data/lib/python3.10/site-packages/awscli/examples/ec2/delete-local-gateway-route-table.rst +23 -0
  22. data/lib/python3.10/site-packages/awscli/examples/ec2/delete-security-group.rst +19 -0
  23. data/lib/python3.10/site-packages/awscli/examples/ec2/delete-snapshot.rst +7 -0
  24. data/lib/python3.10/site-packages/awscli/examples/ec2/delete-subnet-cidr-reservation.rst +20 -0
  25. data/lib/python3.10/site-packages/awscli/examples/ec2/delete-traffic-mirror-filter.rst +14 -0
  26. data/lib/python3.10/site-packages/awscli/examples/ec2/delete-transit-gateway-prefix-list-reference.rst +26 -0
  27. data/lib/python3.10/site-packages/awscli/examples/ec2/delete-verified-access-instance.rst +20 -0
  28. data/lib/python3.10/site-packages/awscli/examples/ec2/delete-vpc-endpoints.rst +13 -0
  29. data/lib/python3.10/site-packages/awscli/examples/ec2/deprovision-ipam-pool-cidr.rst +26 -0
  30. data/lib/python3.10/site-packages/awscli/examples/ec2/deregister-instance-event-notification-attributes.rst +37 -0
  31. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-capacity-reservations.rst +91 -0
  32. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-elastic-gpus.rst +5 -0
  33. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-host-reservations.rst +30 -0
  34. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-images.rst +76 -0
  35. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-instances.rst +389 -0
  36. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-local-gateway-route-table-virtual-interface-group-associations.rst +24 -0
  37. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-local-gateway-route-table-vpc-associations.rst +20 -0
  38. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-local-gateway-virtual-interface-groups.rst +24 -0
  39. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-network-insights-access-scopes.rst +22 -0
  40. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-network-insights-paths.rst +23 -0
  41. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-public-ipv4-pools.rst +25 -0
  42. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-reserved-instances.rst +74 -0
  43. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-scheduled-instance-availability.rst +43 -0
  44. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-subnets.rst +129 -0
  45. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-traffic-mirror-sessions.rst +42 -0
  46. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-transit-gateway-attachments.rst +79 -0
  47. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-transit-gateway-vpc-attachments.rst +36 -0
  48. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-vpc-endpoint-associations.rst +24 -0
  49. data/lib/python3.10/site-packages/awscli/examples/ec2/describe-vpn-connections.rst +62 -0
  50. data/lib/python3.10/site-packages/awscli/examples/ec2/detach-internet-gateway.rst +11 -0
data/lib/python3.10/site-packages/awscli/examples/ec2/accept-transit-gateway-peering-attachment.rst ADDED
@@ -0,0 +1,29 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To accept a transit gateway peering attachment**
2
+
3
+ The following ``accept-transit-gateway-peering-attachment`` example accepts the specified transit gateway peering attachment. The ``--region`` parameter specifies the Region that the accepter transit gateway is located in. ::
4
+
5
+ aws ec2 accept-transit-gateway-peering-attachment \
6
+ --transit-gateway-attachment-id tgw-attach-4455667788aabbccd \
7
+ --region us-east-2
8
+
9
+ Output::
10
+
11
+ {
12
+ "TransitGatewayPeeringAttachment": {
13
+ "TransitGatewayAttachmentId": "tgw-attach-4455667788aabbccd",
14
+ "RequesterTgwInfo": {
15
+ "TransitGatewayId": "tgw-123abc05e04123abc",
16
+ "OwnerId": "123456789012",
17
+ "Region": "us-west-2"
18
+ },
19
+ "AccepterTgwInfo": {
20
+ "TransitGatewayId": "tgw-11223344aabbcc112",
21
+ "OwnerId": "123456789012",
22
+ "Region": "us-east-2"
23
+ },
24
+ "State": "pending",
25
+ "CreationTime": "2019-12-09T11:38:31.000Z"
26
+ }
27
+ }
28
+
29
+ For more information, see `Transit Gateway Peering Attachments <https://docs.aws.amazon.com/vpc/latest/tgw/tgw-peering.html>`__ in the *Transit Gateways Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/accept-vpc-peering-connection.rst ADDED
@@ -0,0 +1,30 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To accept a VPC peering connection**
2
+
3
+ This example accepts the specified VPC peering connection request.
4
+
5
+ Command::
6
+
7
+ aws ec2 accept-vpc-peering-connection --vpc-peering-connection-id pcx-1a2b3c4d
8
+
9
+ Output::
10
+
11
+ {
12
+ "VpcPeeringConnection": {
13
+ "Status": {
14
+ "Message": "Provisioning",
15
+ "Code": "provisioning"
16
+ },
17
+ "Tags": [],
18
+ "AccepterVpcInfo": {
19
+ "OwnerId": "444455556666",
20
+ "VpcId": "vpc-44455566",
21
+ "CidrBlock": "10.0.1.0/28"
22
+ },
23
+ "VpcPeeringConnectionId": "pcx-1a2b3c4d",
24
+ "RequesterVpcInfo": {
25
+ "OwnerId": "444455556666",
26
+ "VpcId": "vpc-111abc45",
27
+ "CidrBlock": "10.0.0.0/28"
28
+ }
29
+ }
30
+ }
data/lib/python3.10/site-packages/awscli/examples/ec2/assign-ipv6-addresses.rst ADDED
@@ -0,0 +1,35 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To assign specific IPv6 addresses to a network interface**
2
+
3
+ This example assigns the specified IPv6 addresses to the specified network interface.
4
+
5
+ Command::
6
+
7
+ aws ec2 assign-ipv6-addresses --network-interface-id eni-38664473 --ipv6-addresses 2001:db8:1234:1a00:3304:8879:34cf:4071 2001:db8:1234:1a00:9691:9503:25ad:1761
8
+
9
+ Output::
10
+
11
+ {
12
+ "AssignedIpv6Addresses": [
13
+ "2001:db8:1234:1a00:3304:8879:34cf:4071",
14
+ "2001:db8:1234:1a00:9691:9503:25ad:1761"
15
+ ],
16
+ "NetworkInterfaceId": "eni-38664473"
17
+ }
18
+
19
+ **To assign IPv6 addresses that Amazon selects to a network interface**
20
+
21
+ This example assigns two IPv6 addresses to the specified network interface. Amazon automatically assigns these IPv6 addresses from the available IPv6 addresses in the IPv6 CIDR block range of the subnet.
22
+
23
+ Command::
24
+
25
+ aws ec2 assign-ipv6-addresses --network-interface-id eni-38664473 --ipv6-address-count 2
26
+
27
+ Output::
28
+
29
+ {
30
+ "AssignedIpv6Addresses": [
31
+ "2001:db8:1234:1a00:3304:8879:34cf:4071",
32
+ "2001:db8:1234:1a00:9691:9503:25ad:1761"
33
+ ],
34
+ "NetworkInterfaceId": "eni-38664473"
35
+ }
data/lib/python3.10/site-packages/awscli/examples/ec2/associate-transit-gateway-route-table.rst ADDED
@@ -0,0 +1,21 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To associate a transit gateway route table with a transit gateway attachment**
2
+
3
+ The following example associates the specified transit gateway route table with the specified VPC attachment. ::
4
+
5
+ aws ec2 associate-transit-gateway-route-table \
6
+ --transit-gateway-route-table-id tgw-rtb-002573ed1eEXAMPLE \
7
+ --transit-gateway-attachment-id tgw-attach-0b5968d3b6EXAMPLE
8
+
9
+ Output::
10
+
11
+ {
12
+ "Association": {
13
+ "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE",
14
+ "TransitGatewayAttachmentId": "tgw-attach-0b5968d3b6EXAMPLE",
15
+ "ResourceId": "vpc-0065acced4EXAMPLE",
16
+ "ResourceType": "vpc",
17
+ "State": "associating"
18
+ }
19
+ }
20
+
21
+ For more information, see `Associate a Transit Gateway Route Table <https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#associate-tgw-route-table>`__ in the *AWS Transit Gateways Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/cancel-capacity-reservation.rst ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To cancel a capacity reservation**
2
+
3
+ The following ``cancel-capacity-reservation`` example cancels the specified capacity reservation. ::
4
+
5
+ aws ec2 cancel-capacity-reservation \
6
+ --capacity-reservation-id cr-1234abcd56EXAMPLE
7
+
8
+ Output::
9
+
10
+ {
11
+ "Return": true
12
+ }
13
+
14
+ For more information, see `Cancel a Capacity Reservation <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-release.html>`__ in the *Amazon EC2 User Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/cancel-conversion-task.rst ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ **To cancel an active conversion of an instance or a volume**
2
+
3
+ This example cancels the upload associated with the task ID import-i-fh95npoc. If the command succeeds, no output is returned.
4
+
5
+ Command::
6
+
7
+ aws ec2 cancel-conversion-task --conversion-task-id import-i-fh95npoc
data/lib/python3.10/site-packages/awscli/examples/ec2/cancel-export-task.rst ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ **To cancel an active export task**
2
+
3
+ This example cancels an active export task with the task ID export-i-fgelt0i7. If the command succeeds, no output is returned.
4
+
5
+ Command::
6
+
7
+ aws ec2 cancel-export-task --export-task-id export-i-fgelt0i7
data/lib/python3.10/site-packages/awscli/examples/ec2/create-customer-gateway.rst ADDED
@@ -0,0 +1,19 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To create a customer gateway**
2
+
3
+ This example creates a customer gateway with the specified IP address for its outside interface.
4
+
5
+ Command::
6
+
7
+ aws ec2 create-customer-gateway --type ipsec.1 --public-ip 12.1.2.3 --bgp-asn 65534
8
+
9
+ Output::
10
+
11
+ {
12
+ "CustomerGateway": {
13
+ "CustomerGatewayId": "cgw-0e11f167",
14
+ "IpAddress": "12.1.2.3",
15
+ "State": "available",
16
+ "Type": "ipsec.1",
17
+ "BgpAsn": "65534"
18
+ }
19
+ }
data/lib/python3.10/site-packages/awscli/examples/ec2/create-egress-only-internet-gateway.rst ADDED
@@ -0,0 +1,21 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To create an egress-only Internet gateway**
2
+
3
+ This example creates an egress-only Internet gateway for the specified VPC.
4
+
5
+ Command::
6
+
7
+ aws ec2 create-egress-only-internet-gateway --vpc-id vpc-0c62a468
8
+
9
+ Output::
10
+
11
+ {
12
+ "EgressOnlyInternetGateway": {
13
+ "EgressOnlyInternetGatewayId": "eigw-015e0e244e24dfe8a",
14
+ "Attachments": [
15
+ {
16
+ "State": "attached",
17
+ "VpcId": "vpc-0c62a468"
18
+ }
19
+ ]
20
+ }
21
+ }
data/lib/python3.10/site-packages/awscli/examples/ec2/create-fpga-image.rst ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To create an Amazon FPGA image**
2
+
3
+ This example creates an AFI from the specified tarball in the specified bucket.
4
+
5
+ Command::
6
+
7
+ aws ec2 create-fpga-image --name my-afi --description test-afi --input-storage-location Bucket=my-fpga-bucket,Key=dcp/17_12_22-103226.Developer_CL.tar --logs-storage-location Bucket=my-fpga-bucket,Key=logs
8
+
9
+ Output::
10
+
11
+ {
12
+ "FpgaImageId": "afi-0d123e123bfc85abc",
13
+ "FpgaImageGlobalId": "agfi-123cb27b5e84a0abc"
14
+ }
data/lib/python3.10/site-packages/awscli/examples/ec2/create-instance-export-task.rst ADDED
@@ -0,0 +1,28 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To export an instance**
2
+
3
+ This example command creates a task to export the instance i-1234567890abcdef0 to the Amazon S3 bucket
4
+ myexportbucket.
5
+
6
+ Command::
7
+
8
+ aws ec2 create-instance-export-task --description "RHEL5 instance" --instance-id i-1234567890abcdef0 --target-environment vmware --export-to-s3-task DiskImageFormat=vmdk,ContainerFormat=ova,S3Bucket=myexportbucket,S3Prefix=RHEL5
9
+
10
+ Output::
11
+
12
+ {
13
+ "ExportTask": {
14
+ "State": "active",
15
+ "InstanceExportDetails": {
16
+ "InstanceId": "i-1234567890abcdef0",
17
+ "TargetEnvironment": "vmware"
18
+ },
19
+ "ExportToS3Task": {
20
+ "S3Bucket": "myexportbucket",
21
+ "S3Key": "RHEL5export-i-fh8sjjsq.ova",
22
+ "DiskImageFormat": "vmdk",
23
+ "ContainerFormat": "ova"
24
+ },
25
+ "Description": "RHEL5 instance",
26
+ "ExportTaskId": "export-i-fh8sjjsq"
27
+ }
28
+ }
data/lib/python3.10/site-packages/awscli/examples/ec2/create-ipam-resource-discovery.rst ADDED
@@ -0,0 +1,46 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To create a resource discovery**
2
+
3
+ In this example, you're a delegated IPAM admin who wants to create and share a resource discovery with the IPAM admin in another AWS Organization so that the admin in the other organization can manage and monitor the IP addresses of resources in your organization.
4
+
5
+ Important
6
+
7
+ * This example includes both the ``--region`` and ``--operating-regions`` options because, while they are optional, they must be configured in a particular way to successfully integrate a resource discovery with an IPAM.
8
+ * ``--operating-regions`` must match the Regions where you have resources that you want IPAM to discover. If there are Regions where you do not want IPAM to manage the IP addresses (for example for compliance reasons), do not include them.
9
+ * ``--region`` must match the home Region of the IPAM you want to associate it with. You must create the resource discovery in the same Region that the IPAM was created in. For example, if the IPAM you are associating with was created in us-east-1, include ``--region us-east-1`` in the request.
10
+ * Both the ``--region`` and ``--operating-regions`` options default to the Region you're running the command in if you don't specify them.
11
+
12
+ In this example, the operating Regions of the IPAM we're integrating with include ``us-west-1``, ``us-west-2``, and ``ap-south-1``. When we create the resource discovery, we want IPAM to discover the resource IP addresses in ``us-west-1`` and ``us-west-2`` but not ``ap-south-1``. So we are including only ``--operating-regions RegionName='us-west-1' RegionName='us-west-2'`` in the request.
13
+
14
+ The following ``create-ipam-resource-discovery`` example creates an IPAM resource discovery. ::
15
+
16
+ aws ec2 create-ipam-resource-discovery \
17
+ --description 'Example-resource-discovery' \
18
+ --tag-specifications 'ResourceType=ipam-resource-discovery,Tags=[{Key=cost-center,Value=cc123}]' \
19
+ --operating-regions RegionName='us-west-1' RegionName='us-west-2' \
20
+ --region us-east-1
21
+
22
+ Output::
23
+
24
+ {
25
+ "IpamResourceDiscovery":{
26
+ "OwnerId": "149977607591",
27
+ "IpamResourceDiscoveryId": "ipam-res-disco-0257046d8aa78b8bc",
28
+ "IpamResourceDiscoveryArn": "arn:aws:ec2::149977607591:ipam-resource-discovery/ipam-res-disco-0257046d8aa78b8bc",
29
+ "IpamResourceDiscoveryRegion": "us-east-1",
30
+ "Description": "'Example-resource-discovery'",
31
+ "OperatingRegions":[
32
+ {"RegionName": "us-west-1"},
33
+ {"RegionName": "us-west-2"},
34
+ {"RegionName": "us-east-1"}
35
+ ],
36
+ "IsDefault": false,
37
+ "State": "create-in-progress",
38
+ "Tags": [
39
+ {
40
+ "Key": "cost-center",
41
+ "Value": "cc123"
42
+ }
43
+ ]
44
+ }
45
+
46
+ Once you create a resource discovery, you may want to share it with another IPAM delegated admin, which you can do with `create-resource-share <https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-resource-share.html>`__. For more information, see `Integrate IPAM with accounts outside of your organization <https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam-outside-org.html>`__ in the *Amazon VPC IPAM User Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/create-launch-template.rst ADDED
@@ -0,0 +1,108 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **Example 1: To create a launch template**
2
+
3
+ The following ``create-launch-template`` example creates a launch template that specifies the subnet in which to launch the instance , assigns a public IP address and an IPv6 address to the instance, and creates a tag for the instance. ::
4
+
5
+ aws ec2 create-launch-template \
6
+ --launch-template-name TemplateForWebServer \
7
+ --version-description WebVersion1 \
8
+ --launch-template-data '{"NetworkInterfaces":[{"AssociatePublicIpAddress":true,"DeviceIndex":0,"Ipv6AddressCount":1,"SubnetId":"subnet-7b16de0c"}],"ImageId":"ami-8c1be5f6","InstanceType":"t2.small","TagSpecifications":[{"ResourceType":"instance","Tags":[{"Key":"purpose","Value":"webserver"}]}]}'
9
+
10
+ Output::
11
+
12
+ {
13
+ "LaunchTemplate": {
14
+ "LatestVersionNumber": 1,
15
+ "LaunchTemplateId": "lt-01238c059e3466abc",
16
+ "LaunchTemplateName": "TemplateForWebServer",
17
+ "DefaultVersionNumber": 1,
18
+ "CreatedBy": "arn:aws:iam::123456789012:user/Bob",
19
+ "CreateTime": "2019-01-27T09:13:24.000Z"
20
+ }
21
+ }
22
+
23
+ For more information, see `Launching an Instance from a Launch Template`_ in the *Amazon Elastic Compute Cloud User Guide*.
24
+ For information about quoting JSON-formatted parameters, see `Quoting Strings`_ in the *AWS Command Line Interface User Guide*.
25
+
26
+ **Example 2: To create a launch template for Amazon EC2 Auto Scaling**
27
+
28
+ The following ``create-launch-template`` example creates a launch template with multiple tags and a block device mapping to specify an additional EBS volume when an instance launches. Specify a value for ``Groups`` that corresponds to security groups for the VPC that your Auto Scaling group will launch instances into. Specify the VPC and subnets as properties of the Auto Scaling group. ::
29
+
30
+ aws ec2 create-launch-template \
31
+ --launch-template-name TemplateForAutoScaling \
32
+ --version-description AutoScalingVersion1 \
33
+ --launch-template-data '{"NetworkInterfaces":[{"DeviceIndex":0,"AssociatePublicIpAddress":true,"Groups":["sg-7c227019,sg-903004f8"],"DeleteOnTermination":true}],"ImageId":"ami-b42209de","InstanceType":"m4.large","TagSpecifications":[{"ResourceType":"instance","Tags":[{"Key":"environment","Value":"production"},{"Key":"purpose","Value":"webserver"}]},{"ResourceType":"volume","Tags":[{"Key":"environment","Value":"production"},{"Key":"cost-center","Value":"cc123"}]}],"BlockDeviceMappings":[{"DeviceName":"/dev/sda1","Ebs":{"VolumeSize":100}}]}' --region us-east-1
34
+
35
+ Output::
36
+
37
+ {
38
+ "LaunchTemplate": {
39
+ "LatestVersionNumber": 1,
40
+ "LaunchTemplateId": "lt-0123c79c33a54e0abc",
41
+ "LaunchTemplateName": "TemplateForAutoScaling",
42
+ "DefaultVersionNumber": 1,
43
+ "CreatedBy": "arn:aws:iam::123456789012:user/Bob",
44
+ "CreateTime": "2019-04-30T18:16:06.000Z"
45
+ }
46
+ }
47
+
48
+ For more information, see `Creating a Launch Template for an Auto Scaling Group`_ in the *Amazon EC2 Auto Scaling User Guide*.
49
+ For information about quoting JSON-formatted parameters, see `Quoting Strings`_ in the *AWS Command Line Interface User Guide*.
50
+
51
+ **Example 3: To create a launch template that specifies encryption of EBS volumes**
52
+
53
+ The following ``create-launch-template`` example creates a launch template that includes encrypted EBS volumes created from an unencrypted snapshot. It also tags the volumes during creation. If encryption by default is disabled, you must specify the ``"Encrypted"`` option as shown in the following example. If you use the ``"KmsKeyId"`` option to specify a customer managed CMK, you also must specify the ``"Encrypted"`` option even if encryption by default is enabled. ::
54
+
55
+ aws ec2 create-launch-template \
56
+ --launch-template-name TemplateForEncryption \
57
+ --launch-template-data file://config.json
58
+
59
+ Contents of ``config.json``::
60
+
61
+ {
62
+ "BlockDeviceMappings":[
63
+ {
64
+ "DeviceName":"/dev/sda1",
65
+ "Ebs":{
66
+ "VolumeType":"gp2",
67
+ "DeleteOnTermination":true,
68
+ "SnapshotId":"snap-066877671789bd71b",
69
+ "Encrypted":true,
70
+ "KmsKeyId":"arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef"
71
+ }
72
+ }
73
+ ],
74
+ "ImageId":"ami-00068cd7555f543d5",
75
+ "InstanceType":"c5.large",
76
+ "TagSpecifications":[
77
+ {
78
+ "ResourceType":"volume",
79
+ "Tags":[
80
+ {
81
+ "Key":"encrypted",
82
+ "Value":"yes"
83
+ }
84
+ ]
85
+ }
86
+ ]
87
+ }
88
+
89
+ Output::
90
+
91
+ {
92
+ "LaunchTemplate": {
93
+ "LatestVersionNumber": 1,
94
+ "LaunchTemplateId": "lt-0d5bd51bcf8530abc",
95
+ "LaunchTemplateName": "TemplateForEncryption",
96
+ "DefaultVersionNumber": 1,
97
+ "CreatedBy": "arn:aws:iam::123456789012:user/Bob",
98
+ "CreateTime": "2020-01-07T19:08:36.000Z"
99
+ }
100
+ }
101
+
102
+ For more information, see `Restoring an Amazon EBS Volume from a Snapshot`_ and `Encryption by Default`_ in the *Amazon Elastic Compute Cloud User Guide*.
103
+
104
+ .. _`Launching an Instance from a Launch Template`: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html
105
+ .. _`Creating a Launch Template for an Auto Scaling Group`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html
106
+ .. _`Quoting Strings`: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html#quoting-strings
107
+ .. _`Restoring an Amazon EBS Volume from a Snapshot`: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-restoring-volume.html
108
+ .. _`Encryption by Default`: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default
data/lib/python3.10/site-packages/awscli/examples/ec2/create-local-gateway-route-table-vpc-association.rst ADDED
@@ -0,0 +1,19 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To associate a VPC with a route table**
2
+
3
+ The following ``create-local-gateway-route-table-vpc-association`` example associates the specified VPC with the specified local gateway route table. ::
4
+
5
+ aws ec2 create-local-gateway-route-table-vpc-association \
6
+ --local-gateway-route-table-id lgw-rtb-059615ef7dEXAMPLE \
7
+ --vpc-id vpc-07ef66ac71EXAMPLE
8
+
9
+ Output::
10
+
11
+ {
12
+ "LocalGatewayRouteTableVpcAssociation": {
13
+ "LocalGatewayRouteTableVpcAssociationId": "lgw-vpc-assoc-0ee765bcc8EXAMPLE",
14
+ "LocalGatewayRouteTableId": "lgw-rtb-059615ef7dEXAMPLE",
15
+ "LocalGatewayId": "lgw-09b493aa7cEXAMPLE",
16
+ "VpcId": "vpc-07ef66ac71EXAMPLE",
17
+ "State": "associated"
18
+ }
19
+ }
data/lib/python3.10/site-packages/awscli/examples/ec2/create-traffic-mirror-filter-rule.rst ADDED
@@ -0,0 +1,32 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To create a filter rule for incoming TCP traffic**
2
+
3
+ The following ``create-traffic-mirror-filter-rule`` example creates a rule that you can use to mirror all incoming TCP traffic. Before you run this command, use ``create-traffic-mirror-filter`` to create the the traffic mirror filter. ::
4
+
5
+ aws ec2 create-traffic-mirror-filter-rule \
6
+ --description 'TCP Rule' \
7
+ --destination-cidr-block 0.0.0.0/0 \
8
+ --protocol 6 \
9
+ --rule-action accept \
10
+ --rule-number 1 \
11
+ --source-cidr-block 0.0.0.0/0 \
12
+ --traffic-direction ingress \
13
+ --traffic-mirror-filter-id tmf-04812ff784b25ae67
14
+
15
+ Output::
16
+
17
+ {
18
+ "TrafficMirrorFilterRule": {
19
+ "DestinationCidrBlock": "0.0.0.0/0",
20
+ "TrafficMirrorFilterId": "tmf-04812ff784b25ae67",
21
+ "TrafficMirrorFilterRuleId": "tmfr-02d20d996673f3732",
22
+ "SourceCidrBlock": "0.0.0.0/0",
23
+ "TrafficDirection": "ingress",
24
+ "Description": "TCP Rule",
25
+ "RuleNumber": 1,
26
+ "RuleAction": "accept",
27
+ "Protocol": 6
28
+ },
29
+ "ClientToken": "4752b573-40a6-4eac-a8a4-a72058761219"
30
+ }
31
+
32
+ For more information, see `Create a traffic mirror filter <https://docs.aws.amazon.com/vpc/latest/mirroring/create-traffic-mirroring-filter.html>`__ in the *Traffic Mirroring Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/create-traffic-mirror-session.rst ADDED
@@ -0,0 +1,31 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To create a traffic mirror session**
2
+
3
+ The following ``create-traffic-mirror-session`` command creates a traffic mirror session for the specified source and target for 25 bytes of the packet. ::
4
+
5
+ aws ec2 create-traffic-mirror-session \
6
+ --description 'example session' \
7
+ --traffic-mirror-target-id tmt-07f75d8feeEXAMPLE \
8
+ --network-interface-id eni-070203f901EXAMPLE \
9
+ --session-number 1 \
10
+ --packet-length 25 \
11
+ --traffic-mirror-filter-id tmf-04812ff784EXAMPLE
12
+
13
+ Output::
14
+
15
+ {
16
+ "TrafficMirrorSession": {
17
+ "TrafficMirrorSessionId": "tms-08a33b1214EXAMPLE",
18
+ "TrafficMirrorTargetId": "tmt-07f75d8feeEXAMPLE",
19
+ "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE",
20
+ "NetworkInterfaceId": "eni-070203f901EXAMPLE",
21
+ "OwnerId": "111122223333",
22
+ "PacketLength": 25,
23
+ "SessionNumber": 1,
24
+ "VirtualNetworkId": 7159709,
25
+ "Description": "example session",
26
+ "Tags": []
27
+ },
28
+ "ClientToken": "5236cffc-ee13-4a32-bb5b-388d9da09d96"
29
+ }
30
+
31
+ For more information, see `Create a traffic mirror session <https://docs.aws.amazon.com/vpc/latest/mirroring/create-traffic-mirroring-session.html>`__ in the *Traffic Mirroring Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/create-vpn-connection.rst ADDED
@@ -0,0 +1,170 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **Example 1: To create a VPN connection with dynamic routing**
2
+
3
+ The following ``create-vpn-connection`` example creates a VPN connection between the specified virtual private gateway and the specified customer gateway, and applies tags to the VPN connection. The output includes the configuration information for your customer gateway device, in XML format. ::
4
+
5
+ aws ec2 create-vpn-connection \
6
+ --type ipsec.1 \
7
+ --customer-gateway-id cgw-001122334455aabbc \
8
+ --vpn-gateway-id vgw-1a1a1a1a1a1a2b2b2 \
9
+ --tag-specification 'ResourceType=vpn-connection,Tags=[{Key=Name,Value=BGP-VPN}]'
10
+
11
+ Output::
12
+
13
+ {
14
+ "VpnConnection": {
15
+ "CustomerGatewayConfiguration": "...configuration information...",
16
+ "CustomerGatewayId": "cgw-001122334455aabbc",
17
+ "Category": "VPN",
18
+ "State": "pending",
19
+ "VpnConnectionId": "vpn-123123123123abcab",
20
+ "VpnGatewayId": "vgw-1a1a1a1a1a1a2b2b2",
21
+ "Options": {
22
+ "EnableAcceleration": false,
23
+ "StaticRoutesOnly": false,
24
+ "LocalIpv4NetworkCidr": "0.0.0.0/0",
25
+ "RemoteIpv4NetworkCidr": "0.0.0.0/0",
26
+ "TunnelInsideIpVersion": "ipv4",
27
+ "TunnelOptions": [
28
+ {},
29
+ {}
30
+ ]
31
+ },
32
+ "Routes": [],
33
+ "Tags": [
34
+ {
35
+ "Key": "Name",
36
+ "Value": "BGP-VPN"
37
+ }
38
+ ]
39
+ }
40
+ }
41
+
42
+ For more information, see `How AWS Site-to-Site VPN works <https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html>`__ in the *AWS Site-to-Site VPN User Guide*.
43
+
44
+ **Example 2: To create a VPN connection with static routing**
45
+
46
+ The following ``create-vpn-connection`` example creates a VPN connection between the specified virtual private gateway and the specified customer gateway. The options specify static routing. The output includes the configuration information for your customer gateway device, in XML format. ::
47
+
48
+ aws ec2 create-vpn-connection \
49
+ --type ipsec.1 \
50
+ --customer-gateway-id cgw-001122334455aabbc \
51
+ --vpn-gateway-id vgw-1a1a1a1a1a1a2b2b2 \
52
+ --options "{\"StaticRoutesOnly\":true}"
53
+
54
+ Output::
55
+
56
+ {
57
+ "VpnConnection": {
58
+ "CustomerGatewayConfiguration": "..configuration information...",
59
+ "CustomerGatewayId": "cgw-001122334455aabbc",
60
+ "Category": "VPN",
61
+ "State": "pending",
62
+ "VpnConnectionId": "vpn-123123123123abcab",
63
+ "VpnGatewayId": "vgw-1a1a1a1a1a1a2b2b2",
64
+ "Options": {
65
+ "EnableAcceleration": false,
66
+ "StaticRoutesOnly": true,
67
+ "LocalIpv4NetworkCidr": "0.0.0.0/0",
68
+ "RemoteIpv4NetworkCidr": "0.0.0.0/0",
69
+ "TunnelInsideIpVersion": "ipv4",
70
+ "TunnelOptions": [
71
+ {},
72
+ {}
73
+ ]
74
+ },
75
+ "Routes": [],
76
+ "Tags": []
77
+ }
78
+ }
79
+
80
+ For more information, see `How AWS Site-to-Site VPN works <https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html>`__ in the *AWS Site-to-Site VPN User Guide*.
81
+
82
+ **Example 3: To create a VPN connection and specify your own inside CIDR and pre-shared key**
83
+
84
+ The following ``create-vpn-connection`` example creates a VPN connection and specifies the inside IP address CIDR block and a custom pre-shared key for each tunnel. The specified values are returned in the ``CustomerGatewayConfiguration`` information. ::
85
+
86
+ aws ec2 create-vpn-connection \
87
+ --type ipsec.1 \
88
+ --customer-gateway-id cgw-001122334455aabbc \
89
+ --vpn-gateway-id vgw-1a1a1a1a1a1a2b2b2 \
90
+ --options TunnelOptions='[{TunnelInsideCidr=169.254.12.0/30,PreSharedKey=ExamplePreSharedKey1},{TunnelInsideCidr=169.254.13.0/30,PreSharedKey=ExamplePreSharedKey2}]'
91
+
92
+ Output::
93
+
94
+ {
95
+ "VpnConnection": {
96
+ "CustomerGatewayConfiguration": "..configuration information...",
97
+ "CustomerGatewayId": "cgw-001122334455aabbc",
98
+ "Category": "VPN",
99
+ "State": "pending",
100
+ "VpnConnectionId": "vpn-123123123123abcab",
101
+ "VpnGatewayId": "vgw-1a1a1a1a1a1a2b2b2",
102
+ "Options": {
103
+ "EnableAcceleration": false,
104
+ "StaticRoutesOnly": false,
105
+ "LocalIpv4NetworkCidr": "0.0.0.0/0",
106
+ "RemoteIpv4NetworkCidr": "0.0.0.0/0",
107
+ "TunnelInsideIpVersion": "ipv4",
108
+ "TunnelOptions": [
109
+ {
110
+ "OutsideIpAddress": "203.0.113.3",
111
+ "TunnelInsideCidr": "169.254.12.0/30",
112
+ "PreSharedKey": "ExamplePreSharedKey1"
113
+ },
114
+ {
115
+ "OutsideIpAddress": "203.0.113.5",
116
+ "TunnelInsideCidr": "169.254.13.0/30",
117
+ "PreSharedKey": "ExamplePreSharedKey2"
118
+ }
119
+ ]
120
+ },
121
+ "Routes": [],
122
+ "Tags": []
123
+ }
124
+ }
125
+
126
+ For more information, see `How AWS Site-to-Site VPN works <https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html>`__ in the *AWS Site-to-Site VPN User Guide*.
127
+
128
+ **Example 4: To create a VPN connection that supports IPv6 traffic**
129
+
130
+ The following ``create-vpn-connection`` example creates a VPN connection that supports IPv6 traffic between the specified transit gateway and specified customer gateway. The tunnel options for both tunnels specify that AWS must initiate the IKE negotiation. ::
131
+
132
+ aws ec2 create-vpn-connection \
133
+ --type ipsec.1 \
134
+ --transit-gateway-id tgw-12312312312312312 \
135
+ --customer-gateway-id cgw-001122334455aabbc \
136
+ --options TunnelInsideIpVersion=ipv6,TunnelOptions=[{StartupAction=start},{StartupAction=start}]
137
+
138
+ Output::
139
+
140
+ {
141
+ "VpnConnection": {
142
+ "CustomerGatewayConfiguration": "..configuration information...",
143
+ "CustomerGatewayId": "cgw-001122334455aabbc",
144
+ "Category": "VPN",
145
+ "State": "pending",
146
+ "VpnConnectionId": "vpn-11111111122222222",
147
+ "TransitGatewayId": "tgw-12312312312312312",
148
+ "Options": {
149
+ "EnableAcceleration": false,
150
+ "StaticRoutesOnly": false,
151
+ "LocalIpv6NetworkCidr": "::/0",
152
+ "RemoteIpv6NetworkCidr": "::/0",
153
+ "TunnelInsideIpVersion": "ipv6",
154
+ "TunnelOptions": [
155
+ {
156
+ "OutsideIpAddress": "203.0.113.3",
157
+ "StartupAction": "start"
158
+ },
159
+ {
160
+ "OutsideIpAddress": "203.0.113.5",
161
+ "StartupAction": "start"
162
+ }
163
+ ]
164
+ },
165
+ "Routes": [],
166
+ "Tags": []
167
+ }
168
+ }
169
+
170
+ For more information, see `How AWS Site-to-Site VPN works <https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html>`__ in the *AWS Site-to-Site VPN User Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/delete-carrier-gateway.rst ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To delete your carrier gateway**
2
+
3
+ The following ``delete-carrier-gateway`` example deletes the specified carrier gateway. ::
4
+
5
+ aws ec2 delete-carrier-gateway \
6
+ --carrier-gateway-id cagw-0465cdEXAMPLE1111
7
+
8
+ Output::
9
+
10
+ {
11
+ "CarrierGateway": {
12
+ "CarrierGatewayId": "cagw-0465cdEXAMPLE1111",
13
+ "VpcId": "vpc-0c529aEXAMPLE1111",
14
+ "State": "deleting",
15
+ "OwnerId": "123456789012"
16
+ }
17
+ }
18
+
19
+ For more information, see `Carrier gateways <https://docs.aws.amazon.com/vpc/latest/userguide/Carrier_Gateway.html>`__ in the *Amazon Virtual Private Cloud
20
+ User Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/delete-fleets.rst ADDED
@@ -0,0 +1,45 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **Example 1: To delete an EC2 Fleet and terminate the associated instances**
2
+
3
+ The following ``delete-fleets`` example deletes the specified EC2 Fleet and terminates the associated On-Demand Instances and Spot Instances. ::
4
+
5
+ aws ec2 delete-fleets \
6
+ --fleet-ids fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE \
7
+ --terminate-instances
8
+
9
+ Output::
10
+
11
+ {
12
+ "SuccessfulFleetDeletions": [
13
+ {
14
+ "CurrentFleetState": "deleted_terminating",
15
+ "PreviousFleetState": "active",
16
+ "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE"
17
+ }
18
+ ],
19
+ "UnsuccessfulFleetDeletions": []
20
+ }
21
+
22
+ For more information, see `Delete an EC2 Fleet <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#delete-fleet>`__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*.
23
+
24
+ **Example 2: To delete an EC2 Fleet without terminating the associated instances**
25
+
26
+ The following ``delete-fleets`` example deletes the specified EC2 Fleet without terminating the associated On-Demand Instances and Spot Instances. ::
27
+
28
+ aws ec2 delete-fleets \
29
+ --fleet-ids fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE \
30
+ --no-terminate-instances
31
+
32
+ Output::
33
+
34
+ {
35
+ "SuccessfulFleetDeletions": [
36
+ {
37
+ "CurrentFleetState": "deleted_running",
38
+ "PreviousFleetState": "active",
39
+ "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE"
40
+ }
41
+ ],
42
+ "UnsuccessfulFleetDeletions": []
43
+ }
44
+
45
+ For more information, see `Delete an EC2 Fleet <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#delete-fleet>`__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*.
data/lib/python3.10/site-packages/awscli/examples/ec2/delete-launch-template.rst ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To delete a launch template**
2
+
3
+ This example deletes the specified launch template.
4
+
5
+ Command::
6
+
7
+ aws ec2 delete-launch-template --launch-template-id lt-0abcd290751193123
8
+
9
+ Output::
10
+
11
+ {
12
+ "LaunchTemplate": {
13
+ "LatestVersionNumber": 2,
14
+ "LaunchTemplateId": "lt-0abcd290751193123",
15
+ "LaunchTemplateName": "TestTemplate",
16
+ "DefaultVersionNumber": 2,
17
+ "CreatedBy": "arn:aws:iam::123456789012:root",
18
+ "CreateTime": "2017-11-23T16:46:25.000Z"
19
+ }
20
+ }
data/lib/python3.10/site-packages/awscli/examples/ec2/delete-local-gateway-route-table.rst ADDED
@@ -0,0 +1,23 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To delete a local gateway route table**
2
+
3
+ The following ``delete-local-gateway-route-table`` example creates a local gateway route table with the direct VPC routing mode. ::
4
+
5
+ aws ec2 delete-local-gateway-route-table \
6
+ --local-gateway-route-table-id lgw-rtb-abcdefg1234567890
7
+
8
+ Output::
9
+
10
+ {
11
+ "LocalGatewayRouteTable": {
12
+ "LocalGatewayRouteTableId": "lgw-rtb-abcdefg1234567890",
13
+ "LocalGatewayRouteTableArn": "arn:aws:ec2:us-west-2:111122223333:local-gateway-route-table/lgw-rtb-abcdefg1234567890",
14
+ "LocalGatewayId": "lgw-1a2b3c4d5e6f7g8h9",
15
+ "OutpostArn": "arn:aws:outposts:us-west-2:111122223333:outpost/op-021345abcdef67890",
16
+ "OwnerId": "111122223333",
17
+ "State": "deleting",
18
+ "Tags": [],
19
+ "Mode": "direct-vpc-routing"
20
+ }
21
+ }
22
+
23
+ For more information, see `Local gateway route tables <https://docs.aws.amazon.com/outposts/latest/userguide/routing.html>`__ in the *AWS Outposts User Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/delete-security-group.rst ADDED
@@ -0,0 +1,19 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **[EC2-Classic] To delete a security group**
2
+
3
+ This example deletes the security group named ``MySecurityGroup``. If the command succeeds, no output is returned.
4
+
5
+ Command::
6
+
7
+ aws ec2 delete-security-group --group-name MySecurityGroup
8
+
9
+ **[EC2-VPC] To delete a security group**
10
+
11
+ This example deletes the security group with the ID ``sg-903004f8``. Note that you can't reference a security group for EC2-VPC by name. If the command succeeds, no output is returned.
12
+
13
+ Command::
14
+
15
+ aws ec2 delete-security-group --group-id sg-903004f8
16
+
17
+ For more information, see `Using Security Groups`_ in the *AWS Command Line Interface User Guide*.
18
+
19
+ .. _`Using Security Groups`: http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-sg.html
data/lib/python3.10/site-packages/awscli/examples/ec2/delete-snapshot.rst ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ **To delete a snapshot**
2
+
3
+ This example command deletes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``. If the command succeeds, no output is returned.
4
+
5
+ Command::
6
+
7
+ aws ec2 delete-snapshot --snapshot-id snap-1234567890abcdef0
data/lib/python3.10/site-packages/awscli/examples/ec2/delete-subnet-cidr-reservation.rst ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To delete a subnet CIDR reservation**
2
+
3
+ The following ``delete-subnet-cidr-reservation`` example deletes the specified subnet CIDR reservation. ::
4
+
5
+ aws ec2 delete-subnet-cidr-reservation \
6
+ --subnet-cidr-reservation-id scr-044f977c4eEXAMPLE
7
+
8
+ Output::
9
+
10
+ {
11
+ "DeletedSubnetCidrReservation": {
12
+ "SubnetCidrReservationId": "scr-044f977c4eEXAMPLE",
13
+ "SubnetId": "subnet-03c51e2e6cEXAMPLE",
14
+ "Cidr": "10.1.0.16/28",
15
+ "ReservationType": "prefix",
16
+ "OwnerId": "123456789012"
17
+ }
18
+ }
19
+
20
+ For more information, see `Subnet CIDR reservations <https://docs.aws.amazon.com/vpc/latest/userguide/subnet-cidr-reservation.html>`__ in the *Amazon VPC User Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/delete-traffic-mirror-filter.rst ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To delete a traffic mirror filter**
2
+
3
+ The following ``delete-traffic-mirror-filter`` example deletes the specified traffic mirror filter. ::
4
+
5
+ aws ec2 delete-traffic-mirror-filter \
6
+ --traffic-mirror-filter-id tmf-0be0b25fcdEXAMPLE
7
+
8
+ Output::
9
+
10
+ {
11
+ "TrafficMirrorFilterId": "tmf-0be0b25fcdEXAMPLE"
12
+ }
13
+
14
+ For more information, see `Delete a Traffic Mirror Filter <https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-filter.html#delete-traffic-mirroring-filter>`__ in the *AWS Traffic Mirroring Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/delete-transit-gateway-prefix-list-reference.rst ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To delete a prefix list reference**
2
+
3
+ The following ``delete-transit-gateway-prefix-list-reference`` example deletes the specified prefix list reference. ::
4
+
5
+ aws ec2 delete-transit-gateway-prefix-list-reference \
6
+ --transit-gateway-route-table-id tgw-rtb-0123456789abcd123 \
7
+ --prefix-list-id pl-11111122222222333
8
+
9
+ Output::
10
+
11
+ {
12
+ "TransitGatewayPrefixListReference": {
13
+ "TransitGatewayRouteTableId": "tgw-rtb-0123456789abcd123",
14
+ "PrefixListId": "pl-11111122222222333",
15
+ "PrefixListOwnerId": "123456789012",
16
+ "State": "deleting",
17
+ "Blackhole": false,
18
+ "TransitGatewayAttachment": {
19
+ "TransitGatewayAttachmentId": "tgw-attach-aabbccddaabbccaab",
20
+ "ResourceType": "vpc",
21
+ "ResourceId": "vpc-112233445566aabbc"
22
+ }
23
+ }
24
+ }
25
+
26
+ For more information, see `Prefix list references <https://docs.aws.amazon.com/vpc/latest/tgw/tgw-prefix-lists.html>`__ in the *Transit Gateways Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/delete-verified-access-instance.rst ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To delete a Verified Access instance**
2
+
3
+ The following ``delete-verified-access-instance`` example deletes the specified Verified Access instance. ::
4
+
5
+ aws ec2 delete-verified-access-instance \
6
+ --verified-access-instance-id vai-0ce000c0b7643abea
7
+
8
+ Output::
9
+
10
+ {
11
+ "VerifiedAccessInstance": {
12
+ "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea",
13
+ "Description": "Testing Verified Access",
14
+ "VerifiedAccessTrustProviders": [],
15
+ "CreationTime": "2023-08-25T18:27:56",
16
+ "LastUpdatedTime": "2023-08-26T01:00:18"
17
+ }
18
+ }
19
+
20
+ For more information, see `Verified Access instances <https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-instances.html>`__ in the *AWS Verified Access User Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/delete-vpc-endpoints.rst ADDED
@@ -0,0 +1,13 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To delete an endpoint**
2
+
3
+ This example deletes endpoints vpce-aa22bb33 and vpce-1a2b3c4d. If the command is partially successful or unsuccessful, a list of unsuccessful items is returned. If the command succeeds, the returned list is empty.
4
+
5
+ Command::
6
+
7
+ aws ec2 delete-vpc-endpoints --vpc-endpoint-ids vpce-aa22bb33 vpce-1a2b3c4d
8
+
9
+ Output::
10
+
11
+ {
12
+ "Unsuccessful": []
13
+ }
data/lib/python3.10/site-packages/awscli/examples/ec2/deprovision-ipam-pool-cidr.rst ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To deprovision an IPAM pool CIDR**
2
+
3
+ The following ``deprovision-ipam-pool-cidr`` example deprovisions a CIDR provisioned to an IPAM pool.
4
+
5
+ (Linux)::
6
+
7
+ aws ec2 deprovision-ipam-pool-cidr \
8
+ --ipam-pool-id ipam-pool-02ec043a19bbe5d08 \
9
+ --cidr 11.0.0.0/16
10
+
11
+ (Windows)::
12
+
13
+ aws ec2 deprovision-ipam-pool-cidr ^
14
+ --ipam-pool-id ipam-pool-02ec043a19bbe5d08 ^
15
+ --cidr 11.0.0.0/16
16
+
17
+ Output::
18
+
19
+ {
20
+ "IpamPoolCidr": {
21
+ "Cidr": "11.0.0.0/16",
22
+ "State": "pending-deprovision"
23
+ }
24
+ }
25
+
26
+ For more information, see `Deprovision pool CIDRs <https://docs.aws.amazon.com/vpc/latest/ipam/depro-pool-cidr-ipam.html>`__ in the *Amazon VPC IPAM User Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/deregister-instance-event-notification-attributes.rst ADDED
@@ -0,0 +1,37 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **Example 1: To remove all tags from event notifications**
2
+
3
+ The following ``deregister-instance-event-notification-attributes`` example removes ``IncludeAllTagsOfInstance=true``, which has the effect of setting ``IncludeAllTagsOfInstance`` to ``false``. ::
4
+
5
+ aws ec2 deregister-instance-event-notification-attributes \
6
+ --instance-tag-attribute IncludeAllTagsOfInstance=true
7
+
8
+ Output::
9
+
10
+ {
11
+ "InstanceTagAttribute": {
12
+ "InstanceTagKeys": [],
13
+ "IncludeAllTagsOfInstance": true
14
+ }
15
+ }
16
+
17
+ For more information, see `Scheduled events for your instances <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html>`__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*.
18
+
19
+ **Example 2: To remove specific tags from event notifications**
20
+
21
+ The following ``deregister-instance-event-notification-attributes`` example removes the specified tag from the tags included in event notifications. To describe the remaining tags included in event notifications, use ``describe-instance-event-notification-attributes``. ::
22
+
23
+ aws ec2 deregister-instance-event-notification-attributes \
24
+ --instance-tag-attribute InstanceTagKeys="tag-key2"
25
+
26
+ Output::
27
+
28
+ {
29
+ "InstanceTagAttribute": {
30
+ "InstanceTagKeys": [
31
+ "tag-key2"
32
+ ],
33
+ "IncludeAllTagsOfInstance": false
34
+ }
35
+ }
36
+
37
+ For more information, see `Scheduled events for your instances <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html>`__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*.
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-capacity-reservations.rst ADDED
@@ -0,0 +1,91 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **Example 1: To describe one or more of your capacity reservations**
2
+
3
+ The following ``describe-capacity-reservations`` example displays details about all of your capacity reservations in the current AWS Region. ::
4
+
5
+ aws ec2 describe-capacity-reservations
6
+
7
+ Output::
8
+
9
+ {
10
+ "CapacityReservations": [
11
+ {
12
+ "CapacityReservationId": "cr-1234abcd56EXAMPLE ",
13
+ "OwnerId": "123456789111",
14
+ "CapacityReservationArn": "arn:aws:ec2:us-east-1:123456789111:capacity-reservation/cr-1234abcd56EXAMPLE",
15
+ "AvailabilityZoneId": "use1-az2",
16
+ "InstanceType": "c5.large",
17
+ "InstancePlatform": "Linux/UNIX",
18
+ "AvailabilityZone": "us-east-1a",
19
+ "Tenancy": "default",
20
+ "TotalInstanceCount": 1,
21
+ "AvailableInstanceCount": 1,
22
+ "EbsOptimized": true,
23
+ "EphemeralStorage": false,
24
+ "State": "active",
25
+ "StartDate": "2024-10-23T15:00:24+00:00",
26
+ "EndDateType": "unlimited",
27
+ "InstanceMatchCriteria": "open",
28
+ "CreateDate": "2024-10-23T15:00:24+00:00",
29
+ "Tags": [],
30
+ "CapacityAllocations": []
31
+ },
32
+ {
33
+ "CapacityReservationId": "cr-abcdEXAMPLE9876ef ",
34
+ "OwnerId": "123456789111",
35
+ "CapacityReservationArn": "arn:aws:ec2:us-east-1:123456789111:capacity-reservation/cr-abcdEXAMPLE9876ef",
36
+ "AvailabilityZoneId": "use1-az2",
37
+ "InstanceType": "c4.large",
38
+ "InstancePlatform": "Linux/UNIX",
39
+ "AvailabilityZone": "us-east-1a",
40
+ "Tenancy": "default",
41
+ "TotalInstanceCount": 1,
42
+ "AvailableInstanceCount": 1,
43
+ "EbsOptimized": true,
44
+ "EphemeralStorage": false,
45
+ "State": "cancelled",
46
+ "StartDate": "2024-10-23T15:01:03+00:00",
47
+ "EndDateType": "unlimited",
48
+ "InstanceMatchCriteria": "open",
49
+ "CreateDate": "2024-10-23T15:01:02+00:00",
50
+ "Tags": [],
51
+ "CapacityAllocations": []
52
+ }
53
+ ]
54
+ }
55
+
56
+ **Example 2: To describe one or more of your capacity reservations**
57
+
58
+ The following ``describe-capacity-reservations`` example displays details about the specified capacity reservation. ::
59
+
60
+ aws ec2 describe-capacity-reservations \
61
+ --capacity-reservation-ids cr-1234abcd56EXAMPLE
62
+
63
+ Output::
64
+
65
+ {
66
+ "CapacityReservations": [
67
+ {
68
+ "CapacityReservationId": "cr-abcdEXAMPLE9876ef ",
69
+ "OwnerId": "123456789111",
70
+ "CapacityReservationArn": "arn:aws:ec2:us-east-1:123456789111:capacity-reservation/cr-abcdEXAMPLE9876ef",
71
+ "AvailabilityZoneId": "use1-az2",
72
+ "InstanceType": "c4.large",
73
+ "InstancePlatform": "Linux/UNIX",
74
+ "AvailabilityZone": "us-east-1a",
75
+ "Tenancy": "default",
76
+ "TotalInstanceCount": 1,
77
+ "AvailableInstanceCount": 1,
78
+ "EbsOptimized": true,
79
+ "EphemeralStorage": false,
80
+ "State": "active",
81
+ "StartDate": "2024-10-23T15:01:03+00:00",
82
+ "EndDateType": "unlimited",
83
+ "InstanceMatchCriteria": "open",
84
+ "CreateDate": "2024-10-23T15:01:02+00:00",
85
+ "Tags": [],
86
+ "CapacityAllocations": []
87
+ }
88
+ ]
89
+ }
90
+
91
+ For more information, see `Viewing a Capacity Reservation <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-using.html#capacity-reservations-view>`__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*.
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-elastic-gpus.rst ADDED
@@ -0,0 +1,5 @@
 
 
 
 
 
 
1
+ **To describe an Elastic GPU**
2
+
3
+ Command::
4
+
5
+ aws ec2 describe-elastic-gpus --elastic-gpu-ids egpu-12345678901234567890abcdefghijkl
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-host-reservations.rst ADDED
@@ -0,0 +1,30 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To describe Dedicated Host Reservations in your account**
2
+
3
+ This example describes the Dedicated Host Reservations in your account.
4
+
5
+ Command::
6
+
7
+ aws ec2 describe-host-reservations
8
+
9
+ Output::
10
+
11
+ {
12
+ "HostReservationSet": [
13
+ {
14
+ "Count": 1,
15
+ "End": "2019-01-10T12:14:09Z",
16
+ "HourlyPrice": "1.499",
17
+ "InstanceFamily": "m4",
18
+ "OfferingId": "hro-03f707bf363b6b324",
19
+ "PaymentOption": "NoUpfront",
20
+ "State": "active",
21
+ "HostIdSet": [
22
+ "h-013abcd2a00cbd123"
23
+ ],
24
+ "Start": "2018-01-10T12:14:09Z",
25
+ "HostReservationId": "hr-0d418a3a4ffc669ae",
26
+ "UpfrontPrice": "0.000",
27
+ "Duration": 31536000
28
+ }
29
+ ]
30
+ }
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-images.rst ADDED
@@ -0,0 +1,76 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **Example 1: To describe an AMI**
2
+
3
+ The following ``describe-images`` example describes the specified AMI in the specified Region. ::
4
+
5
+ aws ec2 describe-images \
6
+ --region us-east-1 \
7
+ --image-ids ami-1234567890EXAMPLE
8
+
9
+ Output::
10
+
11
+ {
12
+ "Images": [
13
+ {
14
+ "VirtualizationType": "hvm",
15
+ "Description": "Provided by Red Hat, Inc.",
16
+ "PlatformDetails": "Red Hat Enterprise Linux",
17
+ "EnaSupport": true,
18
+ "Hypervisor": "xen",
19
+ "State": "available",
20
+ "SriovNetSupport": "simple",
21
+ "ImageId": "ami-1234567890EXAMPLE",
22
+ "UsageOperation": "RunInstances:0010",
23
+ "BlockDeviceMappings": [
24
+ {
25
+ "DeviceName": "/dev/sda1",
26
+ "Ebs": {
27
+ "SnapshotId": "snap-111222333444aaabb",
28
+ "DeleteOnTermination": true,
29
+ "VolumeType": "gp2",
30
+ "VolumeSize": 10,
31
+ "Encrypted": false
32
+ }
33
+ }
34
+ ],
35
+ "Architecture": "x86_64",
36
+ "ImageLocation": "123456789012/RHEL-8.0.0_HVM-20190618-x86_64-1-Hourly2-GP2",
37
+ "RootDeviceType": "ebs",
38
+ "OwnerId": "123456789012",
39
+ "RootDeviceName": "/dev/sda1",
40
+ "CreationDate": "2019-05-10T13:17:12.000Z",
41
+ "Public": true,
42
+ "ImageType": "machine",
43
+ "Name": "RHEL-8.0.0_HVM-20190618-x86_64-1-Hourly2-GP2"
44
+ }
45
+ ]
46
+ }
47
+
48
+ For more information, see `Amazon Machine Images (AMI) <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html>`__ in the *Amazon EC2 User Guide*.
49
+
50
+ **Example 2: To describe AMIs based on filters**
51
+
52
+ The following ``describe-images`` example describes Windows AMIs provided by Amazon that are backed by Amazon EBS. ::
53
+
54
+ aws ec2 describe-images \
55
+ --owners amazon \
56
+ --filters "Name=platform,Values=windows" "Name=root-device-type,Values=ebs"
57
+
58
+ For an example of the output for ``describe-images``, see Example 1.
59
+
60
+ For additional examples using filters, see `Listing and filtering your resources <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI>`__ in the *Amazon EC2 User Guide*.
61
+
62
+ **Example 3: To describe AMIs based on tags**
63
+
64
+ The following ``describe-images`` example describes all AMIs that have the tag ``Type=Custom``. The example uses the ``--query`` parameter to display only the AMI IDs. ::
65
+
66
+ aws ec2 describe-images \
67
+ --filters "Name=tag:Type,Values=Custom" \
68
+ --query 'Images[*].[ImageId]' \
69
+ --output text
70
+
71
+ Output::
72
+
73
+ ami-1234567890EXAMPLE
74
+ ami-0abcdef1234567890
75
+
76
+ For additional examples using tag filters, see `Working with tags <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#Using_Tags_CLI>`__ in the *Amazon EC2 User Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-instances.rst ADDED
@@ -0,0 +1,389 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **Example 1: To describe an instance**
2
+
3
+ The following ``describe-instances`` example describes the specified instance. ::
4
+
5
+ aws ec2 describe-instances \
6
+ --instance-ids i-1234567890abcdef0
7
+
8
+ Output::
9
+
10
+ {
11
+ "Reservations": [
12
+ {
13
+ "Groups": [],
14
+ "Instances": [
15
+ {
16
+ "AmiLaunchIndex": 0,
17
+ "ImageId": "ami-0abcdef1234567890",
18
+ "InstanceId": "i-1234567890abcdef0",
19
+ "InstanceType": "t3.nano",
20
+ "KeyName": "my-key-pair",
21
+ "LaunchTime": "2022-11-15T10:48:59+00:00",
22
+ "Monitoring": {
23
+ "State": "disabled"
24
+ },
25
+ "Placement": {
26
+ "AvailabilityZone": "us-east-2a",
27
+ "GroupName": "",
28
+ "Tenancy": "default"
29
+ },
30
+ "PrivateDnsName": "ip-10-0-0-157.us-east-2.compute.internal",
31
+ "PrivateIpAddress": "10-0-0-157",
32
+ "ProductCodes": [],
33
+ "PublicDnsName": "ec2-34-253-223-13.us-east-2.compute.amazonaws.com",
34
+ "PublicIpAddress": "34.253.223.13",
35
+ "State": {
36
+ "Code": 16,
37
+ "Name": "running"
38
+ },
39
+ "StateTransitionReason": "",
40
+ "SubnetId": "subnet-04a636d18e83cfacb",
41
+ "VpcId": "vpc-1234567890abcdef0",
42
+ "Architecture": "x86_64",
43
+ "BlockDeviceMappings": [
44
+ {
45
+ "DeviceName": "/dev/xvda",
46
+ "Ebs": {
47
+ "AttachTime": "2022-11-15T10:49:00+00:00",
48
+ "DeleteOnTermination": true,
49
+ "Status": "attached",
50
+ "VolumeId": "vol-02e6ccdca7de29cf2"
51
+ }
52
+ }
53
+ ],
54
+ "ClientToken": "1234abcd-1234-abcd-1234-d46a8903e9bc",
55
+ "EbsOptimized": true,
56
+ "EnaSupport": true,
57
+ "Hypervisor": "xen",
58
+ "IamInstanceProfile": {
59
+ "Arn": "arn:aws:iam::111111111111:instance-profile/AmazonSSMRoleForInstancesQuickSetup",
60
+ "Id": "111111111111111111111"
61
+ },
62
+ "NetworkInterfaces": [
63
+ {
64
+ "Association": {
65
+ "IpOwnerId": "amazon",
66
+ "PublicDnsName": "ec2-34-253-223-13.us-east-2.compute.amazonaws.com",
67
+ "PublicIp": "34.253.223.13"
68
+ },
69
+ "Attachment": {
70
+ "AttachTime": "2022-11-15T10:48:59+00:00",
71
+ "AttachmentId": "eni-attach-1234567890abcdefg",
72
+ "DeleteOnTermination": true,
73
+ "DeviceIndex": 0,
74
+ "Status": "attached",
75
+ "NetworkCardIndex": 0
76
+ },
77
+ "Description": "",
78
+ "Groups": [
79
+ {
80
+ "GroupName": "launch-wizard-146",
81
+ "GroupId": "sg-1234567890abcdefg"
82
+ }
83
+ ],
84
+ "Ipv6Addresses": [],
85
+ "MacAddress": "00:11:22:33:44:55",
86
+ "NetworkInterfaceId": "eni-1234567890abcdefg",
87
+ "OwnerId": "104024344472",
88
+ "PrivateDnsName": "ip-10-0-0-157.us-east-2.compute.internal",
89
+ "PrivateIpAddress": "10-0-0-157",
90
+ "PrivateIpAddresses": [
91
+ {
92
+ "Association": {
93
+ "IpOwnerId": "amazon",
94
+ "PublicDnsName": "ec2-34-253-223-13.us-east-2.compute.amazonaws.com",
95
+ "PublicIp": "34.253.223.13"
96
+ },
97
+ "Primary": true,
98
+ "PrivateDnsName": "ip-10-0-0-157.us-east-2.compute.internal",
99
+ "PrivateIpAddress": "10-0-0-157"
100
+ }
101
+ ],
102
+ "SourceDestCheck": true,
103
+ "Status": "in-use",
104
+ "SubnetId": "subnet-1234567890abcdefg",
105
+ "VpcId": "vpc-1234567890abcdefg",
106
+ "InterfaceType": "interface"
107
+ }
108
+ ],
109
+ "RootDeviceName": "/dev/xvda",
110
+ "RootDeviceType": "ebs",
111
+ "SecurityGroups": [
112
+ {
113
+ "GroupName": "launch-wizard-146",
114
+ "GroupId": "sg-1234567890abcdefg"
115
+ }
116
+ ],
117
+ "SourceDestCheck": true,
118
+ "Tags": [
119
+ {
120
+ "Key": "Name",
121
+ "Value": "my-instance"
122
+ }
123
+ ],
124
+ "VirtualizationType": "hvm",
125
+ "CpuOptions": {
126
+ "CoreCount": 1,
127
+ "ThreadsPerCore": 2
128
+ },
129
+ "CapacityReservationSpecification": {
130
+ "CapacityReservationPreference": "open"
131
+ },
132
+ "HibernationOptions": {
133
+ "Configured": false
134
+ },
135
+ "MetadataOptions": {
136
+ "State": "applied",
137
+ "HttpTokens": "optional",
138
+ "HttpPutResponseHopLimit": 1,
139
+ "HttpEndpoint": "enabled",
140
+ "HttpProtocolIpv6": "disabled",
141
+ "InstanceMetadataTags": "enabled"
142
+ },
143
+ "EnclaveOptions": {
144
+ "Enabled": false
145
+ },
146
+ "PlatformDetails": "Linux/UNIX",
147
+ "UsageOperation": "RunInstances",
148
+ "UsageOperationUpdateTime": "2022-11-15T10:48:59+00:00",
149
+ "PrivateDnsNameOptions": {
150
+ "HostnameType": "ip-name",
151
+ "EnableResourceNameDnsARecord": true,
152
+ "EnableResourceNameDnsAAAARecord": false
153
+ },
154
+ "MaintenanceOptions": {
155
+ "AutoRecovery": "default"
156
+ }
157
+ }
158
+ ],
159
+ "OwnerId": "111111111111",
160
+ "ReservationId": "r-1234567890abcdefg"
161
+ }
162
+ ]
163
+ }
164
+
165
+ **Example 2: To filter for instances with the specified type**
166
+
167
+ The following ``describe-instances`` example uses filters to scope the results to instances of the specified type. ::
168
+
169
+ aws ec2 describe-instances \
170
+ --filters Name=instance-type,Values=m5.large
171
+
172
+ For example output, see Example 1.
173
+
174
+ For more information, see `List and filter using the CLI <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI>`__ in the *Amazon EC2 User Guide*.
175
+
176
+ **Example 3: To filter for instances with the specified type and Availability Zone**
177
+
178
+ The following ``describe-instances`` example uses multiple filters to scope the results to instances with the specified type that are also in the specified Availability Zone. ::
179
+
180
+ aws ec2 describe-instances \
181
+ --filters Name=instance-type,Values=t2.micro,t3.micro Name=availability-zone,Values=us-east-2c
182
+
183
+ For example output, see Example 1.
184
+
185
+ **Example 4: To filter for instances with the specified type and Availability Zone using a JSON file**
186
+
187
+ The following ``describe-instances`` example uses a JSON input file to perform the same filtering as the previous example. When filters get more complicated, they can be easier to specify in a JSON file. ::
188
+
189
+ aws ec2 describe-instances \
190
+ --filters file://filters.json
191
+
192
+ Contents of ``filters.json``::
193
+
194
+ [
195
+ {
196
+ "Name": "instance-type",
197
+ "Values": ["t2.micro", "t3.micro"]
198
+ },
199
+ {
200
+ "Name": "availability-zone",
201
+ "Values": ["us-east-2c"]
202
+ }
203
+ ]
204
+
205
+ For example output, see Example 1.
206
+
207
+ **Example 5: To filter for instances with the specified Owner tag**
208
+
209
+ The following ``describe-instances`` example uses tag filters to scope the results to instances that have a tag with the specified tag key (Owner), regardless of the tag value. ::
210
+
211
+ aws ec2 describe-instances \
212
+ --filters "Name=tag-key,Values=Owner"
213
+
214
+ For example output, see Example 1.
215
+
216
+ **Example 6: To filter for instances with the specified my-team tag value**
217
+
218
+ The following ``describe-instances`` example uses tag filters to scope the results to instances that have a tag with the specified tag value (my-team), regardless of the tag key. ::
219
+
220
+ aws ec2 describe-instances \
221
+ --filters "Name=tag-value,Values=my-team"
222
+
223
+ For example output, see Example 1.
224
+
225
+ **Example 7: To filter for instances with the specified Owner tag and my-team value**
226
+
227
+ The following ``describe-instances`` example uses tag filters to scope the results to instances that have the specified tag (Owner=my-team). ::
228
+
229
+ aws ec2 describe-instances \
230
+ --filters "Name=tag:Owner,Values=my-team"
231
+
232
+ For example output, see Example 1.
233
+
234
+ **Example 8: To display only instance and subnet IDs for all instances**
235
+
236
+ The following ``describe-instances`` examples use the ``--query`` parameter to display only the instance and subnet IDs for all instances, in JSON format.
237
+
238
+ Linux and macOS::
239
+
240
+ aws ec2 describe-instances \
241
+ --query 'Reservations[*].Instances[*].{Instance:InstanceId,Subnet:SubnetId}' \
242
+ --output json
243
+
244
+ Windows::
245
+
246
+ aws ec2 describe-instances ^
247
+ --query "Reservations[*].Instances[*].{Instance:InstanceId,Subnet:SubnetId}" ^
248
+ --output json
249
+
250
+ Output::
251
+
252
+ [
253
+ {
254
+ "Instance": "i-057750d42936e468a",
255
+ "Subnet": "subnet-069beee9b12030077"
256
+ },
257
+ {
258
+ "Instance": "i-001efd250faaa6ffa",
259
+ "Subnet": "subnet-0b715c6b7db68927a"
260
+ },
261
+ {
262
+ "Instance": "i-027552a73f021f3bd",
263
+ "Subnet": "subnet-0250c25a1f4e15235"
264
+ }
265
+ ...
266
+ ]
267
+
268
+ **Example 9: To filter instances of the specified type and only display their instance IDs**
269
+
270
+ The following ``describe-instances`` example uses filters to scope the results to instances of the specified type and the ``--query`` parameter to display only the instance IDs. ::
271
+
272
+ aws ec2 describe-instances \
273
+ --filters "Name=instance-type,Values=t2.micro" \
274
+ --query "Reservations[*].Instances[*].[InstanceId]" \
275
+ --output text
276
+
277
+ Output::
278
+
279
+ i-031c0dc19de2fb70c
280
+ i-00d8bff789a736b75
281
+ i-0b715c6b7db68927a
282
+ i-0626d4edd54f1286d
283
+ i-00b8ae04f9f99908e
284
+ i-0fc71c25d2374130c
285
+
286
+ **Example 10: To filter instances of the specified type and only display their instance IDs, Availability Zone, and the specified tag value**
287
+
288
+ The following ``describe-instances`` examples display the instance ID, Availability Zone, and the value of the ``Name`` tag for instances that have a tag with the name ``tag-key``, in table format.
289
+
290
+ Linux and macOS::
291
+
292
+ aws ec2 describe-instances \
293
+ --filters Name=tag-key,Values=Name \
294
+ --query 'Reservations[*].Instances[*].{Instance:InstanceId,AZ:Placement.AvailabilityZone,Name:Tags[?Key==`Name`]|[0].Value}' \
295
+ --output table
296
+
297
+ Windows::
298
+
299
+ aws ec2 describe-instances ^
300
+ --filters Name=tag-key,Values=Name ^
301
+ --query "Reservations[*].Instances[*].{Instance:InstanceId,AZ:Placement.AvailabilityZone,Name:Tags[?Key=='Name']|[0].Value}" ^
302
+ --output table
303
+
304
+ Output::
305
+
306
+ -------------------------------------------------------------
307
+ | DescribeInstances |
308
+ +--------------+-----------------------+--------------------+
309
+ | AZ | Instance | Name |
310
+ +--------------+-----------------------+--------------------+
311
+ | us-east-2b | i-057750d42936e468a | my-prod-server |
312
+ | us-east-2a | i-001efd250faaa6ffa | test-server-1 |
313
+ | us-east-2a | i-027552a73f021f3bd | test-server-2 |
314
+ +--------------+-----------------------+--------------------+
315
+
316
+ **Example 11: To describe instances in a partition placement group**
317
+
318
+ The following ``describe-instances`` example describes the specified instance. The output includes the placement information for the instance, which contains the placement group name and the partition number for the instance. ::
319
+
320
+ aws ec2 describe-instances \
321
+ --instance-ids i-0123a456700123456 \
322
+ --query "Reservations[*].Instances[*].Placement"
323
+
324
+ Output::
325
+
326
+ [
327
+ [
328
+ {
329
+ "AvailabilityZone": "us-east-1c",
330
+ "GroupName": "HDFS-Group-A",
331
+ "PartitionNumber": 3,
332
+ "Tenancy": "default"
333
+ }
334
+
335
+ ]
336
+ ]
337
+
338
+ For more information, see `Describing instances in a placement group <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html#describe-instance-placement>`__ in the *Amazon EC2 User Guide*.
339
+
340
+ **Example 12: To filter to instances with the specified placement group and partition number**
341
+
342
+ The following ``describe-instances`` example filters the results to only those instances with the specified placement group and partition number. ::
343
+
344
+ aws ec2 describe-instances \
345
+ --filters "Name=placement-group-name,Values=HDFS-Group-A" "Name=placement-partition-number,Values=7"
346
+
347
+ The following shows only the relevant information from the output. ::
348
+
349
+ "Instances": [
350
+ {
351
+ "InstanceId": "i-0123a456700123456",
352
+ "InstanceType": "r4.large",
353
+ "Placement": {
354
+ "AvailabilityZone": "us-east-1c",
355
+ "GroupName": "HDFS-Group-A",
356
+ "PartitionNumber": 7,
357
+ "Tenancy": "default"
358
+ }
359
+ },
360
+ {
361
+ "InstanceId": "i-9876a543210987654",
362
+ "InstanceType": "r4.large",
363
+ "Placement": {
364
+ "AvailabilityZone": "us-east-1c",
365
+ "GroupName": "HDFS-Group-A",
366
+ "PartitionNumber": 7,
367
+ "Tenancy": "default"
368
+ }
369
+ ],
370
+
371
+ For more information, see `Describing instances in a placement group <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html#describe-instance-placement>`__ in the *Amazon EC2 User Guide*.
372
+
373
+ **Example 13: To filter to instances that are configured to allow access to tags from instance metadata**
374
+
375
+ The following ``describe-instances`` example filters the results to only those instances that are configured to allow access to instance tags from instance metadata. ::
376
+
377
+ aws ec2 describe-instances \
378
+ --filters "Name=metadata-options.instance-metadata-tags,Values=enabled" \
379
+ --query "Reservations[*].Instances[*].InstanceId" \
380
+ --output text
381
+
382
+ The following shows the expected output. ::
383
+
384
+ i-1234567890abcdefg
385
+ i-abcdefg1234567890
386
+ i-11111111aaaaaaaaa
387
+ i-aaaaaaaa111111111
388
+
389
+ For more information, see `Work with instance tags in instance metadata <https://docs.aws.amazon.com/en_us/AWSEC2/latest/UserGuide/Using_Tags.html#view-access-to-tags-in-IMDS>`__ in the *Amazon EC2 User Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-local-gateway-route-table-virtual-interface-group-associations.rst ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To describe associations between virtual interface groups and local gateway route tables**
2
+
3
+ The following ``describe-local-gateway-route-table-virtual-interface-group-associations`` example describes the associations between virtual interface groups and local gateway route tables in your AWS account. ::
4
+
5
+ aws ec2 describe-local-gateway-route-table-virtual-interface-group-associations
6
+
7
+ Output::
8
+
9
+ {
10
+ "LocalGatewayRouteTableVirtualInterfaceGroupAssociations": [
11
+ {
12
+ "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": "lgw-vif-grp-assoc-07145b276bEXAMPLE",
13
+ "LocalGatewayVirtualInterfaceGroupId": "lgw-vif-grp-07145b276bEXAMPLE",
14
+ "LocalGatewayId": "lgw-0ab1c23d4eEXAMPLE",
15
+ "LocalGatewayRouteTableId": "lgw-rtb-059615ef7dEXAMPLE",
16
+ "LocalGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:local-gateway-route-table/lgw-rtb-059615ef7dEXAMPLE",
17
+ "OwnerId": "123456789012",
18
+ "State": "associated",
19
+ "Tags": []
20
+ }
21
+ ]
22
+ }
23
+
24
+ For more information, see `Working with local gateways <https://docs.aws.amazon.com/outposts/latest/userguide/outposts-local-gateways.html>`__ in the *AWS Outposts User Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-local-gateway-route-table-vpc-associations.rst ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To describe the associations between VPCs and local gateway route tables**
2
+
3
+ The following ``describe-local-gateway-route-table-vpc-associations`` example displays information about the specified association between VPCs and local gateway route tables. ::
4
+
5
+ aws ec2 describe-local-gateway-route-table-vpc-associations \
6
+ --local-gateway-route-table-vpc-association-ids lgw-vpc-assoc-0e0f27af15EXAMPLE
7
+
8
+ Output::
9
+
10
+ {
11
+ "LocalGatewayRouteTableVpcAssociation": {
12
+ "LocalGatewayRouteTableVpcAssociationId": "lgw-vpc-assoc-0e0f27af1EXAMPLE",
13
+ "LocalGatewayRouteTableId": "lgw-rtb-059615ef7dEXAMPLE",
14
+ "LocalGatewayId": "lgw-09b493aa7cEXAMPLE",
15
+ "VpcId": "vpc-0efe9bde08EXAMPLE",
16
+ "State": "associated"
17
+ }
18
+ }
19
+
20
+ For more information, see `Local gateway route tables <https://docs.aws.amazon.com/outposts/latest/userguide/routing.html>`__ in the *Outposts User Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-local-gateway-virtual-interface-groups.rst ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To describe local gateway virtual interface groups**
2
+
3
+ The following ``describe-local-gateway-virtual-interface-groups`` example describes the local gateway virtual interface groups in your AWS account. ::
4
+
5
+ aws ec2 describe-local-gateway-virtual-interface-groups
6
+
7
+ Output::
8
+
9
+ {
10
+ "LocalGatewayVirtualInterfaceGroups": [
11
+ {
12
+ "LocalGatewayVirtualInterfaceGroupId": "lgw-vif-grp-07145b276bEXAMPLE",
13
+ "LocalGatewayVirtualInterfaceIds": [
14
+ "lgw-vif-01a23bc4d5EXAMPLE",
15
+ "lgw-vif-543ab21012EXAMPLE"
16
+ ],
17
+ "LocalGatewayId": "lgw-0ab1c23d4eEXAMPLE",
18
+ "OwnerId": "123456789012",
19
+ "Tags": []
20
+ }
21
+ ]
22
+ }
23
+
24
+ For more information, see `Working with local gateways <https://docs.aws.amazon.com/outposts/latest/userguide/outposts-local-gateways.html>`__ in the *AWS Outposts User Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-network-insights-access-scopes.rst ADDED
@@ -0,0 +1,22 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To describe Network Insights access scopes**
2
+
3
+ The following ``describe-network-insights-access-scopes`` example describes the access-scope analyses in your AWS account. ::
4
+
5
+ aws ec2 describe-network-insights-access-scopes \
6
+ --region us-east-1
7
+
8
+ Output::
9
+
10
+ {
11
+ "NetworkInsightsAccessScopes": [
12
+ {
13
+ "NetworkInsightsAccessScopeId": "nis-123456789111",
14
+ "NetworkInsightsAccessScopeArn": "arn:aws:ec2:us-east-1:123456789012:network-insights-access-scope/nis-123456789111",
15
+ "CreatedDate": "2021-11-29T21:12:41.416000+00:00",
16
+ "UpdatedDate": "2021-11-29T21:12:41.416000+00:00",
17
+ "Tags": []
18
+ }
19
+ ]
20
+ }
21
+
22
+ For more information, see `Getting started with Network Access Analyzer using the AWS CLI <https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli-naa.html>`__ in the *Network Access Analyzer Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-network-insights-paths.rst ADDED
@@ -0,0 +1,23 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To describe a path**
2
+
3
+ The following ``describe-network-insights-paths`` example describes the specified path. ::
4
+
5
+ aws ec2 describe-network-insights-paths \
6
+ --network-insights-path-ids nip-0b26f224f1d131fa8
7
+
8
+ Output::
9
+
10
+ {
11
+ "NetworkInsightsPaths": [
12
+ {
13
+ "NetworkInsightsPathId": "nip-0b26f224f1d131fa8",
14
+ "NetworkInsightsPathArn": "arn:aws:ec2:us-east-1:123456789012:network-insights-path/nip-0b26f224f1d131fa8",
15
+ "CreatedDate": "2021-01-20T22:43:46.933Z",
16
+ "Source": "igw-0797cccdc9d73b0e5",
17
+ "Destination": "i-0495d385ad28331c7",
18
+ "Protocol": "tcp"
19
+ }
20
+ ]
21
+ }
22
+
23
+ For more information, see `Getting started using the AWS CLI <https://docs.aws.amazon.com/vpc/latest/reachability/getting-started-cli.html>`__ in the *Reachability Analyzer Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-public-ipv4-pools.rst ADDED
@@ -0,0 +1,25 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To describe your public IPv4 address pools**
2
+
3
+ The following ``describe-public-ipv4-pools`` example displays details about the address pools that were created when you provisioned public IPv4 address ranges using Bring Your Own IP Addresses (BYOIP). ::
4
+
5
+ aws ec2 describe-public-ipv4-pools
6
+
7
+ Output::
8
+
9
+ {
10
+ "PublicIpv4Pools": [
11
+ {
12
+ "PoolId": "ipv4pool-ec2-1234567890abcdef0",
13
+ "PoolAddressRanges": [
14
+ {
15
+ "FirstAddress": "203.0.113.0",
16
+ "LastAddress": "203.0.113.255",
17
+ "AddressCount": 256,
18
+ "AvailableAddressCount": 256
19
+ }
20
+ ],
21
+ "TotalAddressCount": 256,
22
+ "TotalAvailableAddressCount": 256
23
+ }
24
+ ]
25
+ }
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-reserved-instances.rst ADDED
@@ -0,0 +1,74 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To describe your Reserved Instances**
2
+
3
+ This example command describes the Reserved Instances that you own.
4
+
5
+ Command::
6
+
7
+ aws ec2 describe-reserved-instances
8
+
9
+ Output::
10
+
11
+ {
12
+ "ReservedInstances": [
13
+ {
14
+ "ReservedInstancesId": "b847fa93-e282-4f55-b59a-1342fexample",
15
+ "OfferingType": "No Upfront",
16
+ "AvailabilityZone": "us-west-1c",
17
+ "End": "2016-08-14T21:34:34.000Z",
18
+ "ProductDescription": "Linux/UNIX",
19
+ "UsagePrice": 0.00,
20
+ "RecurringCharges": [
21
+ {
22
+ "Amount": 0.104,
23
+ "Frequency": "Hourly"
24
+ }
25
+ ],
26
+ "Start": "2015-08-15T21:34:35.086Z",
27
+ "State": "active",
28
+ "FixedPrice": 0.0,
29
+ "CurrencyCode": "USD",
30
+ "Duration": 31536000,
31
+ "InstanceTenancy": "default",
32
+ "InstanceType": "m3.medium",
33
+ "InstanceCount": 2
34
+ },
35
+ ...
36
+ ]
37
+ }
38
+
39
+ **To describe your Reserved Instances using filters**
40
+
41
+ This example filters the response to include only three-year, t2.micro Linux/UNIX Reserved Instances in us-west-1c.
42
+
43
+ Command::
44
+
45
+ aws ec2 describe-reserved-instances --filters Name=duration,Values=94608000 Name=instance-type,Values=t2.micro Name=product-description,Values=Linux/UNIX Name=availability-zone,Values=us-east-1e
46
+
47
+ Output::
48
+
49
+ {
50
+ "ReservedInstances": [
51
+ {
52
+ "ReservedInstancesId": "f127bd27-edb7-44c9-a0eb-0d7e09259af0",
53
+ "OfferingType": "All Upfront",
54
+ "AvailabilityZone": "us-east-1e",
55
+ "End": "2018-03-26T21:34:34.000Z",
56
+ "ProductDescription": "Linux/UNIX",
57
+ "UsagePrice": 0.00,
58
+ "RecurringCharges": [],
59
+ "Start": "2015-03-27T21:34:35.848Z",
60
+ "State": "active",
61
+ "FixedPrice": 151.0,
62
+ "CurrencyCode": "USD",
63
+ "Duration": 94608000,
64
+ "InstanceTenancy": "default",
65
+ "InstanceType": "t2.micro",
66
+ "InstanceCount": 1
67
+ }
68
+ ]
69
+ }
70
+
71
+ For more information, see `Using Amazon EC2 Instances`_ in the *AWS Command Line Interface User Guide*.
72
+
73
+ .. _`Using Amazon EC2 Instances`: http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-launch.html
74
+
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-scheduled-instance-availability.rst ADDED
@@ -0,0 +1,43 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To describe an available schedule**
2
+
3
+ This example describes a schedule that occurs every week on Sunday, starting on the specified date.
4
+
5
+ Command::
6
+
7
+ aws ec2 describe-scheduled-instance-availability --recurrence Frequency=Weekly,Interval=1,OccurrenceDays=[1] --first-slot-start-time-range EarliestTime=2016-01-31T00:00:00Z,LatestTime=2016-01-31T04:00:00Z
8
+
9
+ Output::
10
+
11
+ {
12
+ "ScheduledInstanceAvailabilitySet": [
13
+ {
14
+ "AvailabilityZone": "us-west-2b",
15
+ "TotalScheduledInstanceHours": 1219,
16
+ "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi...",
17
+ "MinTermDurationInDays": 366,
18
+ "AvailableInstanceCount": 20,
19
+ "Recurrence": {
20
+ "OccurrenceDaySet": [
21
+ 1
22
+ ],
23
+ "Interval": 1,
24
+ "Frequency": "Weekly",
25
+ "OccurrenceRelativeToEnd": false
26
+ },
27
+ "Platform": "Linux/UNIX",
28
+ "FirstSlotStartTime": "2016-01-31T00:00:00Z",
29
+ "MaxTermDurationInDays": 366,
30
+ "SlotDurationInHours": 23,
31
+ "NetworkPlatform": "EC2-VPC",
32
+ "InstanceType": "c4.large",
33
+ "HourlyPrice": "0.095"
34
+ },
35
+ ...
36
+ ]
37
+ }
38
+
39
+ To narrow the results, you can add filters that specify the operating system, network, and instance type.
40
+
41
+ Command:
42
+
43
+ --filters Name=platform,Values=Linux/UNIX Name=network-platform,Values=EC2-VPC Name=instance-type,Values=c4.large
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-subnets.rst ADDED
@@ -0,0 +1,129 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **Example 1: To describe all your subnets**
2
+
3
+ The following ``describe-subnets`` example displays the details of your subnets. ::
4
+
5
+ aws ec2 describe-subnets
6
+
7
+ Output::
8
+
9
+ {
10
+ "Subnets": [
11
+ {
12
+ "AvailabilityZone": "us-east-1d",
13
+ "AvailabilityZoneId": "use1-az2",
14
+ "AvailableIpAddressCount": 4089,
15
+ "CidrBlock": "172.31.80.0/20",
16
+ "DefaultForAz": true,
17
+ "MapPublicIpOnLaunch": false,
18
+ "MapCustomerOwnedIpOnLaunch": true,
19
+ "State": "available",
20
+ "SubnetId": "subnet-0bb1c79de3EXAMPLE",
21
+ "VpcId": "vpc-0ee975135dEXAMPLE",
22
+ "OwnerId": "111122223333",
23
+ "AssignIpv6AddressOnCreation": false,
24
+ "Ipv6CidrBlockAssociationSet": [],
25
+ "CustomerOwnedIpv4Pool:": 'pool-2EXAMPLE',
26
+ "SubnetArn": "arn:aws:ec2:us-east-2:111122223333:subnet/subnet-0bb1c79de3EXAMPLE",
27
+ "EnableDns64": false,
28
+ "Ipv6Native": false,
29
+ "PrivateDnsNameOptionsOnLaunch": {
30
+ "HostnameType": "ip-name",
31
+ "EnableResourceNameDnsARecord": false,
32
+ "EnableResourceNameDnsAAAARecord": false
33
+ }
34
+ },
35
+ {
36
+ "AvailabilityZone": "us-east-1d",
37
+ "AvailabilityZoneId": "use1-az2",
38
+ "AvailableIpAddressCount": 4089,
39
+ "CidrBlock": "172.31.80.0/20",
40
+ "DefaultForAz": true,
41
+ "MapPublicIpOnLaunch": true,
42
+ "MapCustomerOwnedIpOnLaunch": false,
43
+ "State": "available",
44
+ "SubnetId": "subnet-8EXAMPLE",
45
+ "VpcId": "vpc-3EXAMPLE",
46
+ "OwnerId": "1111222233333",
47
+ "AssignIpv6AddressOnCreation": false,
48
+ "Ipv6CidrBlockAssociationSet": [],
49
+ "Tags": [
50
+ {
51
+ "Key": "Name",
52
+ "Value": "MySubnet"
53
+ }
54
+ ],
55
+ "SubnetArn": "arn:aws:ec2:us-east-1:111122223333:subnet/subnet-8EXAMPLE",
56
+ "EnableDns64": false,
57
+ "Ipv6Native": false,
58
+ "PrivateDnsNameOptionsOnLaunch": {
59
+ "HostnameType": "ip-name",
60
+ "EnableResourceNameDnsARecord": false,
61
+ "EnableResourceNameDnsAAAARecord": false
62
+ }
63
+ }
64
+ ]
65
+ }
66
+
67
+ For more information, see `Working with VPCs and Subnets <https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html>`__ in the *AWS VPC User Guide*.
68
+
69
+ **Example 2: To describe the subnets of a specific VPC**
70
+
71
+ The following ``describe-subnets`` example uses a filter to retrieve details for the subnets of the specified VPC. ::
72
+
73
+ aws ec2 describe-subnets \
74
+ --filters "Name=vpc-id,Values=vpc-3EXAMPLE"
75
+
76
+ Output::
77
+
78
+ {
79
+ "Subnets": [
80
+ {
81
+ "AvailabilityZone": "us-east-1d",
82
+ "AvailabilityZoneId": "use1-az2",
83
+ "AvailableIpAddressCount": 4089,
84
+ "CidrBlock": "172.31.80.0/20",
85
+ "DefaultForAz": true,
86
+ "MapPublicIpOnLaunch": true,
87
+ "MapCustomerOwnedIpOnLaunch": false,
88
+ "State": "available",
89
+ "SubnetId": "subnet-8EXAMPLE",
90
+ "VpcId": "vpc-3EXAMPLE",
91
+ "OwnerId": "1111222233333",
92
+ "AssignIpv6AddressOnCreation": false,
93
+ "Ipv6CidrBlockAssociationSet": [],
94
+ "Tags": [
95
+ {
96
+ "Key": "Name",
97
+ "Value": "MySubnet"
98
+ }
99
+ ],
100
+ "SubnetArn": "arn:aws:ec2:us-east-1:111122223333:subnet/subnet-8EXAMPLE",
101
+ "EnableDns64": false,
102
+ "Ipv6Native": false,
103
+ "PrivateDnsNameOptionsOnLaunch": {
104
+ "HostnameType": "ip-name",
105
+ "EnableResourceNameDnsARecord": false,
106
+ "EnableResourceNameDnsAAAARecord": false
107
+ }
108
+ }
109
+ ]
110
+ }
111
+
112
+ For more information, see `Working with VPCs and Subnets <https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html>`__ in the *AWS VPC User Guide*.
113
+
114
+ **Example 3: To describe the subnets with a specific tag**
115
+
116
+ The following ``describe-subnets`` example uses a filter to retrieve the details of those subnets with the tag ``CostCenter=123`` and the ``--query`` parameter to display the subnet IDs of the subnets with this tag. ::
117
+
118
+ aws ec2 describe-subnets \
119
+ --filters "Name=tag:CostCenter,Values=123" \
120
+ --query "Subnets[*].SubnetId" \
121
+ --output text
122
+
123
+ Output::
124
+
125
+ subnet-0987a87c8b37348ef
126
+ subnet-02a95061c45f372ee
127
+ subnet-03f720e7de2788d73
128
+
129
+ For more information, see `Working with VPCs and Subnets <https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html>`__ in the *Amazon VPC User Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-traffic-mirror-sessions.rst ADDED
@@ -0,0 +1,42 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To describe a Traffic Mirror Session**
2
+
3
+ The following ``describe-traffic-mirror-sessions`` example displays details of the your Traffic Mirror sessions. ::
4
+
5
+ aws ec2 describe-traffic-mirror-sessions
6
+
7
+ Output::
8
+
9
+ {
10
+ "TrafficMirrorSessions": [
11
+ {
12
+ "Tags": [],
13
+ "VirtualNetworkId": 42,
14
+ "OwnerId": "111122223333",
15
+ "Description": "TCP Session",
16
+ "NetworkInterfaceId": "eni-0a471a5cf3EXAMPLE",
17
+ "TrafficMirrorTargetId": "tmt-0dabe9b0a6EXAMPLE",
18
+ "TrafficMirrorFilterId": "tmf-083e18f985EXAMPLE",
19
+ "PacketLength": 20,
20
+ "SessionNumber": 1,
21
+ "TrafficMirrorSessionId": "tms-0567a4c684EXAMPLE"
22
+ },
23
+ {
24
+ "Tags": [
25
+ {
26
+ "Key": "Name",
27
+ "Value": "tag test"
28
+ }
29
+ ],
30
+ "VirtualNetworkId": 13314501,
31
+ "OwnerId": "111122223333",
32
+ "Description": "TCP Session",
33
+ "NetworkInterfaceId": "eni-0a471a5cf3EXAMPLE",
34
+ "TrafficMirrorTargetId": "tmt-03665551cbEXAMPLE",
35
+ "TrafficMirrorFilterId": "tmf-06c787846cEXAMPLE",
36
+ "SessionNumber": 2,
37
+ "TrafficMirrorSessionId": "tms-0060101cf8EXAMPLE"
38
+ }
39
+ ]
40
+ }
41
+
42
+ For more information, see `View Traffic Mirror Session Details <https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-session.html#view-traffic-mirroring-session>`__ in the *AWS Traffic Mirroring Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-transit-gateway-attachments.rst ADDED
@@ -0,0 +1,79 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To view your transit gateway attachments**
2
+
3
+ The following ``describe-transit-gateway-attachments`` example displays details for your transit gateway attachments. ::
4
+
5
+ aws ec2 describe-transit-gateway-attachments
6
+
7
+ Output::
8
+
9
+ {
10
+ "TransitGatewayAttachments": [
11
+ {
12
+ "TransitGatewayAttachmentId": "tgw-attach-01f8100bc7EXAMPLE",
13
+ "TransitGatewayId": "tgw-02f776b1a7EXAMPLE",
14
+ "TransitGatewayOwnerId": "123456789012",
15
+ "ResourceOwnerId": "123456789012",
16
+ "ResourceType": "vpc",
17
+ "ResourceId": "vpc-3EXAMPLE",
18
+ "State": "available",
19
+ "Association": {
20
+ "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE",
21
+ "State": "associated"
22
+ },
23
+ "CreationTime": "2019-08-26T14:59:25.000Z",
24
+ "Tags": [
25
+ {
26
+ "Key": "Name",
27
+ "Value": "Example"
28
+ }
29
+ ]
30
+ },
31
+ {
32
+ "TransitGatewayAttachmentId": "tgw-attach-0b5968d3b6EXAMPLE",
33
+ "TransitGatewayId": "tgw-02f776b1a7EXAMPLE",
34
+ "TransitGatewayOwnerId": "123456789012",
35
+ "ResourceOwnerId": "123456789012",
36
+ "ResourceType": "vpc",
37
+ "ResourceId": "vpc-0065acced4EXAMPLE",
38
+ "State": "available",
39
+ "Association": {
40
+ "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE",
41
+ "State": "associated"
42
+ },
43
+ "CreationTime": "2019-08-07T17:03:07.000Z",
44
+ "Tags": []
45
+ },
46
+ {
47
+ "TransitGatewayAttachmentId": "tgw-attach-08e0bc912cEXAMPLE",
48
+ "TransitGatewayId": "tgw-02f776b1a7EXAMPLE",
49
+ "TransitGatewayOwnerId": "123456789012",
50
+ "ResourceOwnerId": "123456789012",
51
+ "ResourceType": "direct-connect-gateway",
52
+ "ResourceId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE",
53
+ "State": "available",
54
+ "Association": {
55
+ "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE",
56
+ "State": "associated"
57
+ },
58
+ "CreationTime": "2019-08-14T20:27:44.000Z",
59
+ "Tags": []
60
+ },
61
+ {
62
+ "TransitGatewayAttachmentId": "tgw-attach-0a89069f57EXAMPLE",
63
+ "TransitGatewayId": "tgw-02f776b1a7EXAMPLE",
64
+ "TransitGatewayOwnerId": "123456789012",
65
+ "ResourceOwnerId": "123456789012",
66
+ "ResourceType": "direct-connect-gateway",
67
+ "ResourceId": "8384da05-13ce-4a91-aada-5a1baEXAMPLE",
68
+ "State": "available",
69
+ "Association": {
70
+ "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE",
71
+ "State": "associated"
72
+ },
73
+ "CreationTime": "2019-08-14T20:33:02.000Z",
74
+ "Tags": []
75
+ }
76
+ ]
77
+ }
78
+
79
+ For more information, see `Work with transit gateways <https://docs.aws.amazon.com/vpc/latest/tgw/working-with-transit-gateways.html>`__ in the *Transit Gateways Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-transit-gateway-vpc-attachments.rst ADDED
@@ -0,0 +1,36 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To describe your transit gateway VPC attachments**
2
+
3
+ The following ``describe-transit-gateway-vpc-attachments`` example displays details for your transit gateway VPC attachments. ::
4
+
5
+ aws ec2 describe-transit-gateway-vpc-attachments
6
+
7
+ Output::
8
+
9
+ {
10
+ "TransitGatewayVpcAttachments": [
11
+ {
12
+ "TransitGatewayAttachmentId": "tgw-attach-0a08e88308EXAMPLE",
13
+ "TransitGatewayId": "tgw-0043d72bb4EXAMPLE",
14
+ "VpcId": "vpc-0f501f7ee8EXAMPLE",
15
+ "VpcOwnerId": "111122223333",
16
+ "State": "available",
17
+ "SubnetIds": [
18
+ "subnet-045d586432EXAMPLE",
19
+ "subnet-0a0ad478a6EXAMPLE"
20
+ ],
21
+ "CreationTime": "2019-02-13T11:04:02.000Z",
22
+ "Options": {
23
+ "DnsSupport": "enable",
24
+ "Ipv6Support": "disable"
25
+ },
26
+ "Tags": [
27
+ {
28
+ "Key": "Name",
29
+ "Value": "attachment name"
30
+ }
31
+ ]
32
+ }
33
+ ]
34
+ }
35
+
36
+ For more information, see `View your VPC attachments <https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html#view-vpc-attachment>`__ in the *Transit Gateways Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-vpc-endpoint-associations.rst ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To describe VPC endpoint associations**
2
+
3
+ The following ``describe-vpc-endpoint-associations`` example describes your VPC endpoint associations. ::
4
+
5
+ aws ec2 describe-vpc-endpoint-associations
6
+
7
+ Output::
8
+
9
+ {
10
+ "VpcEndpointAssociations": [
11
+ {
12
+ "Id": "vpce-rsc-asc-0a810ca6ac8866bf9",
13
+ "VpcEndpointId": "vpce-019b90d6f16d4f958",
14
+ "AssociatedResourceAccessibility": "Accessible",
15
+ "DnsEntry": {
16
+ "DnsName": "vpce-019b90d6f16d4f958.rcfg-07129f3acded87625.4232ccc.vpc-lattice-rsc.us-east-2.on.aws",
17
+ "HostedZoneId": "Z03265862FOUNWMZOKUF4"
18
+ },
19
+ "AssociatedResourceArn": "arn:aws:vpc-lattice:us-east-1:123456789012:resourceconfiguration/rcfg-07129f3acded87625"
20
+ }
21
+ ]
22
+ }
23
+
24
+ For more information, see `Manage VPC endpoint associations <https://docs.aws.amazon.com/vpc/latest/privatelink/resource-configuration-associations.html#resource-config-manage-ep-association>`__ in the *AWS PrivateLink User Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/describe-vpn-connections.rst ADDED
@@ -0,0 +1,62 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **Example 1: To describe your VPN connections**
2
+
3
+ The following ``describe-vpn-connections`` example describes all of your Site-to-Site VPN connections. ::
4
+
5
+ aws ec2 describe-vpn-connections
6
+
7
+ Output::
8
+
9
+ {
10
+ "VpnConnections": [
11
+ {
12
+ "CustomerGatewayConfiguration": "...configuration information...",
13
+ "CustomerGatewayId": "cgw-01234567abcde1234",
14
+ "Category": "VPN",
15
+ "State": "available",
16
+ "Type": "ipsec.1",
17
+ "VpnConnectionId": "vpn-1122334455aabbccd",
18
+ "TransitGatewayId": "tgw-00112233445566aab",
19
+ "Options": {
20
+ "EnableAcceleration": false,
21
+ "StaticRoutesOnly": true,
22
+ "LocalIpv4NetworkCidr": "0.0.0.0/0",
23
+ "RemoteIpv4NetworkCidr": "0.0.0.0/0",
24
+ "TunnelInsideIpVersion": "ipv4"
25
+ },
26
+ "Routes": [],
27
+ "Tags": [
28
+ {
29
+ "Key": "Name",
30
+ "Value": "CanadaVPN"
31
+ }
32
+ ],
33
+ "VgwTelemetry": [
34
+ {
35
+ "AcceptedRouteCount": 0,
36
+ "LastStatusChange": "2020-07-29T10:35:11.000Z",
37
+ "OutsideIpAddress": "203.0.113.3",
38
+ "Status": "DOWN",
39
+ "StatusMessage": ""
40
+ },
41
+ {
42
+ "AcceptedRouteCount": 0,
43
+ "LastStatusChange": "2020-09-02T09:09:33.000Z",
44
+ "OutsideIpAddress": "203.0.113.5",
45
+ "Status": "UP",
46
+ "StatusMessage": ""
47
+ }
48
+ ]
49
+ }
50
+ ]
51
+ }
52
+
53
+ For more information, see `How AWS Site-to-Site VPN works <https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html>`__ in the *AWS Site-to-Site VPN User Guide*.
54
+
55
+ **Example 2: To describe your available VPN connections**
56
+
57
+ The following ``describe-vpn-connections`` example describes your Site-to-Site VPN connections with a state of ``available``. ::
58
+
59
+ aws ec2 describe-vpn-connections \
60
+ --filters "Name=state,Values=available"
61
+
62
+ For more information, see `How AWS Site-to-Site VPN works <https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html>`__ in the *AWS Site-to-Site VPN User Guide*.
data/lib/python3.10/site-packages/awscli/examples/ec2/detach-internet-gateway.rst ADDED
@@ -0,0 +1,11 @@
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **To detach an internet gateway from your VPC**
2
+
3
+ The following ``detach-internet-gateway`` example detaches the specified internet gateway from the specific VPC. ::
4
+
5
+ aws ec2 detach-internet-gateway \
6
+ --internet-gateway-id igw-0d0fb496b3EXAMPLE \
7
+ --vpc-id vpc-0a60eb65b4EXAMPLE
8
+
9
+ This command produces no output.
10
+
11
+ For more information, see `Internet gateways <https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html>`__ in the *Amazon VPC User Guide*.