From ed38b5570b2c8b6f514a8c8a438ab313e417680c Mon Sep 17 00:00:00 2001 From: Elysa Hall Date: Tue, 7 Jan 2025 16:43:33 +0000 Subject: [PATCH] Examples for ec2 --- ...ciate-transit-gateway-multicast-domain.rst | 2 +- .../ec2/delete-verified-access-endpoint.rst | 2 +- .../describe-verified-access-endpoints.rst | 4 +- .../examples/ec2/disable-address-transfer.rst | 2 +- ...etwork-performance-metric-subscription.rst | 2 +- awscli/examples/ec2/disable-fast-launch.rst | 4 +- .../ec2/disable-image-block-public-access.rst | 2 +- .../ec2/disable-image-deprecation.rst | 2 +- ...ciate-transit-gateway-multicast-domain.rst | 2 +- .../examples/ec2/enable-address-transfer.rst | 2 +- awscli/examples/ec2/enable-fast-launch.rst | 4 +- .../examples/ec2/enable-image-deprecation.rst | 6 +- ...export-client-vpn-client-configuration.rst | 86 +++++----- .../ec2/get-aws-network-performance-data.rst | 2 +- .../ec2/get-capacity-reservation-usage.rst | 48 +++--- awscli/examples/ec2/get-coip-pool-usage.rst | 2 +- .../get-groups-for-capacity-reservation.rst | 2 +- ...nsights-access-scope-analysis-findings.rst | 120 +++++++------- ...-network-insights-access-scope-content.rst | 70 ++++---- ...-gateway-multicast-domain-associations.rst | 2 +- ...transit-gateway-prefix-list-references.rst | 56 +++---- .../ec2/list-images-in-recycle-bin.rst | 2 +- .../ec2/list-snapshots-in-recycle-bin.rst | 2 +- .../ec2/modify-availability-zone-group.rst | 2 +- .../ec2/modify-capacity-reservation.rst | 50 +++--- awscli/examples/ec2/modify-fleet.rst | 2 +- awscli/examples/ec2/modify-hosts.rst | 72 ++++---- ...stance-capacity-reservation-attributes.rst | 60 +++---- .../modify-instance-maintenance-options.rst | 4 +- .../ec2/modify-instance-metadata-options.rst | 10 +- .../ec2/modify-instance-placement.rst | 156 +++++++++--------- awscli/examples/ec2/modify-snapshot-tier.rst | 8 +- ...-transit-gateway-prefix-list-reference.rst | 54 +++--- .../ec2/modify-verified-access-endpoint.rst | 4 +- ...instance-event-notification-attributes.rst | 4 +- ...ransit-gateway-multicast-group-members.rst | 2 +- ...ransit-gateway-multicast-group-sources.rst | 2 +- .../ec2/restore-image-from-recycle-bin.rst | 2 +- .../ec2/restore-snapshot-from-recycle-bin.rst | 2 +- awscli/examples/ec2/restore-snapshot-tier.rst | 8 +- ...earch-transit-gateway-multicast-groups.rst | 2 +- ...network-insights-access-scope-analysis.rst | 42 ++--- 42 files changed, 456 insertions(+), 456 deletions(-) diff --git a/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst b/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst index 43aeead45180..d68563864798 100755 --- a/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst +++ b/awscli/examples/ec2/associate-transit-gateway-multicast-domain.rst @@ -25,4 +25,4 @@ Output:: } } -For more information, see `Managing multicast domains `__ in the *Transit Gateways Guide*. \ No newline at end of file +For more information, see `Multicast domains `__ in the *Transit Gateways Guide*. diff --git a/awscli/examples/ec2/delete-verified-access-endpoint.rst b/awscli/examples/ec2/delete-verified-access-endpoint.rst index caed2b0be502..958fbe118c1c 100644 --- a/awscli/examples/ec2/delete-verified-access-endpoint.rst +++ b/awscli/examples/ec2/delete-verified-access-endpoint.rst @@ -34,4 +34,4 @@ Output:: } } -For more information, see `Verified Access endpoints `__ in the *AWS Verified Access User Guide*. +For more information, see `Verified Access endpoints `__ in the *AWS Verified Access User Guide*. diff --git a/awscli/examples/ec2/describe-verified-access-endpoints.rst b/awscli/examples/ec2/describe-verified-access-endpoints.rst index 8f15d97f2cf4..65926683bc12 100644 --- a/awscli/examples/ec2/describe-verified-access-endpoints.rst +++ b/awscli/examples/ec2/describe-verified-access-endpoints.rst @@ -1,6 +1,6 @@ **To describe a Verified Access endpoint** -The following ``delete-verified-access-endpoints`` example describes the specified Verified Access endpoint. :: +The following ``describe-verified-access-endpoints`` example describes the specified Verified Access endpoint. :: aws ec2 describe-verified-access-endpoints \ --verified-access-endpoint-ids vae-066fac616d4d546f2 @@ -42,4 +42,4 @@ Output:: ] } -For more information, see `Verified Access endpoints `__ in the *AWS Verified Access User Guide*. +For more information, see `Verified Access endpoints `__ in the *AWS Verified Access User Guide*. diff --git a/awscli/examples/ec2/disable-address-transfer.rst b/awscli/examples/ec2/disable-address-transfer.rst index dafbeb514a69..0653c3a383d3 100644 --- a/awscli/examples/ec2/disable-address-transfer.rst +++ b/awscli/examples/ec2/disable-address-transfer.rst @@ -15,4 +15,4 @@ Output:: } } -For more information, see `Transfer Elastic IP addresses `__ in the *Amazon VPC User Guide*. +For more information, see `Transfer Elastic IP addresses `__ in the *Amazon VPC User Guide*. diff --git a/awscli/examples/ec2/disable-aws-network-performance-metric-subscription.rst b/awscli/examples/ec2/disable-aws-network-performance-metric-subscription.rst index acc29262a982..b70677e4a5c2 100644 --- a/awscli/examples/ec2/disable-aws-network-performance-metric-subscription.rst +++ b/awscli/examples/ec2/disable-aws-network-performance-metric-subscription.rst @@ -14,4 +14,4 @@ Output:: "Output": true } -For more information, see `Manage subscriptions `__ in the *Infrastructure Performance User Guide*. \ No newline at end of file +For more information, see `Manage CloudWatch subscriptions using the CLI `__ in the *Infrastructure Performance User Guide*. diff --git a/awscli/examples/ec2/disable-fast-launch.rst b/awscli/examples/ec2/disable-fast-launch.rst index 00f576b138ce..28b9b204687f 100644 --- a/awscli/examples/ec2/disable-fast-launch.rst +++ b/awscli/examples/ec2/disable-fast-launch.rst @@ -1,6 +1,6 @@ **To discontinue fast launching for an image** -The following ``disable-fast-launch`` example discontinues fast launching on the specified AMI, and cleans up existing pre-provisioned snapshots. :: +The following ``disable-fast-launch`` example discontinues Fast Launch for the specified AMI, and cleans up existing pre-provisioned snapshots. :: aws ec2 disable-fast-launch \ --image-id ami-01234567890abcedf @@ -23,4 +23,4 @@ Output:: "StateTransitionTime": "2022-01-27T22:47:29.265000+00:00" } -For more information about configuring a Windows AMI for faster launching, see `Configure your AMI for faster launching `__ in the *Amazon EC2 User Guide*. \ No newline at end of file +For more information, see `Configure EC2 Fast Launch settings for your Windows AMI `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/ec2/disable-image-block-public-access.rst b/awscli/examples/ec2/disable-image-block-public-access.rst index 9b6f1e3f44ae..83e765900eff 100644 --- a/awscli/examples/ec2/disable-image-block-public-access.rst +++ b/awscli/examples/ec2/disable-image-block-public-access.rst @@ -11,4 +11,4 @@ Output:: "ImageBlockPublicAccessState": "unblocked" } -For more information, see `Block public access to your AMIs `__ in the *Amazon EC2 User Guide*. +For more information, see `Block public access to your AMIs `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/ec2/disable-image-deprecation.rst b/awscli/examples/ec2/disable-image-deprecation.rst index b1e916e42370..ad137bb3d558 100644 --- a/awscli/examples/ec2/disable-image-deprecation.rst +++ b/awscli/examples/ec2/disable-image-deprecation.rst @@ -12,4 +12,4 @@ Output:: "Return": "true" } -For more information, see `Deprecate an AMI ` in the *Amazon EC2 User Guide*. \ No newline at end of file +For more information, see `Deprecate an AMI `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst b/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst index f8283f72e225..21620d965145 100755 --- a/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst +++ b/awscli/examples/ec2/disassociate-transit-gateway-multicast-domain.rst @@ -24,4 +24,4 @@ Output:: } } -For more information, see `Working with multicast `__ in the *Transit Gateways Guide*'. \ No newline at end of file +For more information, see `Multicast domains `__ in the *Transit Gateways Guide*'. diff --git a/awscli/examples/ec2/enable-address-transfer.rst b/awscli/examples/ec2/enable-address-transfer.rst index 43abe389e37b..e35d3d5c8aa6 100644 --- a/awscli/examples/ec2/enable-address-transfer.rst +++ b/awscli/examples/ec2/enable-address-transfer.rst @@ -18,4 +18,4 @@ Output:: } } -For more information, see `Transfer Elastic IP addresses `__ in the *Amazon VPC User Guide*. +For more information, see `Transfer Elastic IP addresses `__ in the *Amazon VPC User Guide*. diff --git a/awscli/examples/ec2/enable-fast-launch.rst b/awscli/examples/ec2/enable-fast-launch.rst index 0f903f39ed3c..5b3ba2af9b20 100644 --- a/awscli/examples/ec2/enable-fast-launch.rst +++ b/awscli/examples/ec2/enable-fast-launch.rst @@ -1,6 +1,6 @@ **To start fast launching for an image** -The following ``enable-fast-launch`` example starts fast launching on the specified AMI and sets the maximum number of parallel instances to launch to 6. The type of resource to use to pre-provision the AMI is set to ``snapshot``, which is also the default value. :: +The following ``enable-fast-launch`` example configures the specified AMI for Fast Launch and sets the maximum number of parallel instances to launch to 6. The type of resource to use to pre-provision the AMI is set to ``snapshot``, which is also the default value. :: aws ec2 enable-fast-launch \ --image-id ami-01234567890abcedf \ @@ -23,4 +23,4 @@ Output:: "StateTransitionTime": "2022-01-27T22:16:03.199000+00:00" } -For more information about configuring a Windows AMI for faster launching, see `Configure your AMI for faster launching `__ in the *Amazon EC2 User Guide*. \ No newline at end of file +For more information, see `Configure EC2 Fast Launch settings for your Windows AMI `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/ec2/enable-image-deprecation.rst b/awscli/examples/ec2/enable-image-deprecation.rst index 6d1066b52bc2..4f1580634490 100644 --- a/awscli/examples/ec2/enable-image-deprecation.rst +++ b/awscli/examples/ec2/enable-image-deprecation.rst @@ -1,10 +1,10 @@ -**Example 1: To deprecate an AMI** +**To deprecate an AMI** The following ``enable-image-deprecation`` example deprecates an AMI on a specific date and time. If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute. You must be the AMI owner to perform this procedure. :: aws ec2 enable-image-deprecation \ --image-id ami-1234567890abcdef0 \ - --deprecate-at "2022-10-15T13:17:12.000Z" + --deprecate-at '2022-10-15T13:17:12.000Z' Output:: @@ -13,4 +13,4 @@ Output:: "Return": "true" } -For more information, see `Deprecate an AMI ` in the *Amazon EC2 User Guide*. \ No newline at end of file +For more information, see `Deprecate an AMI `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/ec2/export-client-vpn-client-configuration.rst b/awscli/examples/ec2/export-client-vpn-client-configuration.rst index 697cd9069726..3aef880d2ebe 100644 --- a/awscli/examples/ec2/export-client-vpn-client-configuration.rst +++ b/awscli/examples/ec2/export-client-vpn-client-configuration.rst @@ -1,43 +1,43 @@ -**To export the client configuration** - -The following ``export-client-vpn-client-configuration`` example exports the client configuration for the specified Client VPN endpoint. In this example, the output is returned in text format to make it easier to read. :: - - aws ec2 export-client-vpn-client-configuration \ - --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ - --output text - -Output:: - - client - dev tun - proto udp - remote cvpn-endpoint-123456789123abcde.prod.clientvpn.ap-south-1.amazonaws.com 443 - remote-random-hostname - resolv-retry infinite - nobind - persist-key - persist-tun - remote-cert-tls server - cipher AES-256-GCM - verb 3 - - -----BEGIN CERTIFICATE----- - MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC - VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 - b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd - BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN - MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD - VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z - b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt - YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ - 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T - rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE - Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 - nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb - FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb - NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= - -----END CERTIFICATE----- - - reneg-sec 0 - -For more information, see `Client VPN Endpoints `__ in the *AWS Client VPN Administrator Guide*. +**To export the client configuration** + +The following ``export-client-vpn-client-configuration`` example exports the client configuration for the specified Client VPN endpoint. In this example, the output is returned in text format to make it easier to read. :: + + aws ec2 export-client-vpn-client-configuration \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ + --output text + +Output:: + + client + dev tun + proto udp + remote cvpn-endpoint-123456789123abcde.prod.clientvpn.ap-south-1.amazonaws.com 443 + remote-random-hostname + resolv-retry infinite + nobind + persist-key + persist-tun + remote-cert-tls server + cipher AES-256-GCM + verb 3 + + -----BEGIN CERTIFICATE----- + MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC + VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD + VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z + b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt + YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ + 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T + rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE + Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 + nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= + -----END CERTIFICATE----- + + reneg-sec 0 + +For more information, see `Client VPN endpoint configuration file export `__ in the *AWS Client VPN Administrator Guide*. diff --git a/awscli/examples/ec2/get-aws-network-performance-data.rst b/awscli/examples/ec2/get-aws-network-performance-data.rst index 8b6408bd701b..4462587d4e80 100644 --- a/awscli/examples/ec2/get-aws-network-performance-data.rst +++ b/awscli/examples/ec2/get-aws-network-performance-data.rst @@ -66,4 +66,4 @@ Output:: ] } -For more information, see `Monitor network performance `__ in the *Infrastructure Performance User Guide*. \ No newline at end of file +For more information, see `Monitor network performance `__ in the *Infrastructure Performance User Guide*. diff --git a/awscli/examples/ec2/get-capacity-reservation-usage.rst b/awscli/examples/ec2/get-capacity-reservation-usage.rst index 15dcffe3c6cc..579a3203ee8e 100644 --- a/awscli/examples/ec2/get-capacity-reservation-usage.rst +++ b/awscli/examples/ec2/get-capacity-reservation-usage.rst @@ -1,24 +1,24 @@ -**To view capacity reservation usage across AWS accounts** - -The following ``get-capacity-reservation-usage`` example displays usage information for the specified capacity reservation. :: - - aws ec2 get-capacity-reservation-usage \ - --capacity-reservation-id cr-1234abcd56EXAMPLE - -Output:: - - { - "CapacityReservationId": "cr-1234abcd56EXAMPLE ", - "InstanceUsages": [ - { - "UsedInstanceCount": 1, - "AccountId": "123456789012" - } - ], - "AvailableInstanceCount": 4, - "TotalInstanceCount": 5, - "State": "active", - "InstanceType": "t2.medium" - } - -For more information, see `Viewing Shared Capacity Reservation Usage `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. +**To view capacity reservation usage across AWS accounts** + +The following ``get-capacity-reservation-usage`` example displays usage information for the specified capacity reservation. :: + + aws ec2 get-capacity-reservation-usage \ + --capacity-reservation-id cr-1234abcd56EXAMPLE + +Output:: + + { + "CapacityReservationId": "cr-1234abcd56EXAMPLE ", + "InstanceUsages": [ + { + "UsedInstanceCount": 1, + "AccountId": "123456789012" + } + ], + "AvailableInstanceCount": 4, + "TotalInstanceCount": 5, + "State": "active", + "InstanceType": "t2.medium" + } + +For more information, see `Shared Capacity Reservations `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/ec2/get-coip-pool-usage.rst b/awscli/examples/ec2/get-coip-pool-usage.rst index 51d2c6978cda..7daf8cea7c67 100644 --- a/awscli/examples/ec2/get-coip-pool-usage.rst +++ b/awscli/examples/ec2/get-coip-pool-usage.rst @@ -27,4 +27,4 @@ Output:: "LocalGatewayRouteTableId": "lgw-rtb-059615ef7dEXAMPLE" } -For more information, see `Customer-owned IP addresses `__ in the *AWS Outposts User Guide*. +For more information, see `Customer-owned IP addresses `__ in the *AWS Outposts User Guide for Outposts racks*. diff --git a/awscli/examples/ec2/get-groups-for-capacity-reservation.rst b/awscli/examples/ec2/get-groups-for-capacity-reservation.rst index e8a4d1d38f36..cdb4cb509e08 100644 --- a/awscli/examples/ec2/get-groups-for-capacity-reservation.rst +++ b/awscli/examples/ec2/get-groups-for-capacity-reservation.rst @@ -16,4 +16,4 @@ Output:: ] } -For more information, see `Working with Capacity Reservations `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. \ No newline at end of file +For more information, see `Capacity Reservation groups `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/ec2/get-network-insights-access-scope-analysis-findings.rst b/awscli/examples/ec2/get-network-insights-access-scope-analysis-findings.rst index e5c4d8bdba74..c1d2d1f12eb1 100644 --- a/awscli/examples/ec2/get-network-insights-access-scope-analysis-findings.rst +++ b/awscli/examples/ec2/get-network-insights-access-scope-analysis-findings.rst @@ -1,60 +1,60 @@ -**To get the findings of Network Insights access scope analysis** - -The following ``get-network-insights-access-scope-analysis-findings`` example gets the selected scope analysis findings in your AWS account. :: - - aws ec2 get-network-insights-access-scope-analysis-findings \ - --region us-east-1 \ - --network-insights-access-scope-analysis-id nis \ - --nis-123456789111 - -Output:: - - { - "NetworkInsightsAccessScopeAnalysisId": "nisa-123456789222", - "AnalysisFindings": [ - { - "NetworkInsightsAccessScopeAnalysisId": "nisa-123456789222", - "NetworkInsightsAccessScopeId": "nis-123456789111", - "FindingComponents": [ - { - "SequenceNumber": 1, - "Component": { - "Id": "eni-02e3d42d5cceca67d", - "Arn": "arn:aws:ec2:us-east-1:936459623503:network-interface/eni-02e3d32d9cceca17d" - }, - "OutboundHeader": { - "DestinationAddresses": [ - "0.0.0.0/5", - "11.0.0.0/8", - "12.0.0.0/6", - "128.0.0.0/3", - "16.0.0.0/4", - "160.0.0.0/5", - "168.0.0.0/6", - "172.0.0.0/12" - "8.0.0.0/7" - ], - "DestinationPortRanges": [ - { - "From": 0, - "To": 65535 - } - ], - "Protocol": "6", - "SourceAddresses": [ - "10.0.2.253/32" - ], - "SourcePortRanges": [ - { - "From": 0, - "To": 65535 - } - ] - }, [etc] - ] - } - } - ] - } - -For more information, see `Getting started with Network Access Analyzer using the AWS CLI `__ in the *Network Access Analyzer Guide*. \ No newline at end of file +**To get the findings of Network Insights access scope analysis** + +The following ``get-network-insights-access-scope-analysis-findings`` example gets the selected scope analysis findings in your AWS account. :: + + aws ec2 get-network-insights-access-scope-analysis-findings \ + --region us-east-1 \ + --network-insights-access-scope-analysis-id nis \ + --nis-123456789111 + +Output:: + + { + "NetworkInsightsAccessScopeAnalysisId": "nisa-123456789222", + "AnalysisFindings": [ + { + "NetworkInsightsAccessScopeAnalysisId": "nisa-123456789222", + "NetworkInsightsAccessScopeId": "nis-123456789111", + "FindingComponents": [ + { + "SequenceNumber": 1, + "Component": { + "Id": "eni-02e3d42d5cceca67d", + "Arn": "arn:aws:ec2:us-east-1:936459623503:network-interface/eni-02e3d32d9cceca17d" + }, + "OutboundHeader": { + "DestinationAddresses": [ + "0.0.0.0/5", + "11.0.0.0/8", + "12.0.0.0/6", + "128.0.0.0/3", + "16.0.0.0/4", + "160.0.0.0/5", + "168.0.0.0/6", + "172.0.0.0/12" + "8.0.0.0/7" + ], + "DestinationPortRanges": [ + { + "From": 0, + "To": 65535 + } + ], + "Protocol": "6", + "SourceAddresses": [ + "10.0.2.253/32" + ], + "SourcePortRanges": [ + { + "From": 0, + "To": 65535 + } + ] + }, [etc] + ] + } + } + ] + } + +For more information, see `Getting started with Network Access Analyzer using the AWS CLI `__ in the *Network Access Analyzer Guide*. diff --git a/awscli/examples/ec2/get-network-insights-access-scope-content.rst b/awscli/examples/ec2/get-network-insights-access-scope-content.rst index 713984a042b6..f5a0013cd57a 100644 --- a/awscli/examples/ec2/get-network-insights-access-scope-content.rst +++ b/awscli/examples/ec2/get-network-insights-access-scope-content.rst @@ -1,35 +1,35 @@ -**To get Network Insights access scope content** - -The following ``get-network-insights-access-scope-content`` example gets the content of the selected scope analysis ID in your AWS account. :: - - aws ec2 get-network-insights-access-scope-content \ - --region us-east-1 \ - --network-insights-access-scope-id nis-123456789222 - -Output:: - - { - "NetworkInsightsAccessScopeContent": { - "NetworkInsightsAccessScopeId": "nis-123456789222", - "MatchPaths": [ - { - "Source": { - "ResourceStatement": { - "ResourceTypes": [ - "AWS::EC2::NetworkInterface" - ] - } - }, - "Destination": { - "ResourceStatement": { - "ResourceTypes": [ - "AWS::EC2::InternetGateway" - ] - } - } - } - ] - } - } - -For more information, see `Getting started with Network Access Analyzer using the AWS CLI `__ in the *Network Access Analyzer Guide*. \ No newline at end of file +**To get Network Insights access scope content** + +The following ``get-network-insights-access-scope-content`` example gets the content of the selected scope analysis ID in your AWS account. :: + + aws ec2 get-network-insights-access-scope-content \ + --region us-east-1 \ + --network-insights-access-scope-id nis-123456789222 + +Output:: + + { + "NetworkInsightsAccessScopeContent": { + "NetworkInsightsAccessScopeId": "nis-123456789222", + "MatchPaths": [ + { + "Source": { + "ResourceStatement": { + "ResourceTypes": [ + "AWS::EC2::NetworkInterface" + ] + } + }, + "Destination": { + "ResourceStatement": { + "ResourceTypes": [ + "AWS::EC2::InternetGateway" + ] + } + } + } + ] + } + } + +For more information, see `Getting started with Network Access Analyzer using the AWS CLI `__ in the *Network Access Analyzer Guide*. diff --git a/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst b/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst index 08e3c8ab8def..90ddbbe1c2cb 100755 --- a/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst +++ b/awscli/examples/ec2/get-transit-gateway-multicast-domain-associations.rst @@ -57,4 +57,4 @@ Output:: ] } -For more information, see `Managing multicast domains `__ in the *Transit Gateways Guide*. \ No newline at end of file +For more information, see `Multicast domains `__ in the *Transit Gateways Guide*. diff --git a/awscli/examples/ec2/get-transit-gateway-prefix-list-references.rst b/awscli/examples/ec2/get-transit-gateway-prefix-list-references.rst index f3c695898eb1..2a73a6e20ad1 100644 --- a/awscli/examples/ec2/get-transit-gateway-prefix-list-references.rst +++ b/awscli/examples/ec2/get-transit-gateway-prefix-list-references.rst @@ -1,28 +1,28 @@ -**To get prefix list references in a transit gateway route table** - -The following ``get-transit-gateway-prefix-list-references`` example gets the prefix list references for the specified transit gateway route table, and filters by the ID of a specific prefix list. :: - - aws ec2 get-transit-gateway-prefix-list-references \ - --transit-gateway-route-table-id tgw-rtb-0123456789abcd123 \ - --filters Name=prefix-list-id,Values=pl-11111122222222333 - -Output:: - - { - "TransitGatewayPrefixListReferences": [ - { - "TransitGatewayRouteTableId": "tgw-rtb-0123456789abcd123", - "PrefixListId": "pl-11111122222222333", - "PrefixListOwnerId": "123456789012", - "State": "available", - "Blackhole": false, - "TransitGatewayAttachment": { - "TransitGatewayAttachmentId": "tgw-attach-aabbccddaabbccaab", - "ResourceType": "vpc", - "ResourceId": "vpc-112233445566aabbc" - } - } - ] - } - -For more information, see `Prefix list references `__ in the *Transit Gateways Guide*. +**To get prefix list references in a transit gateway route table** + +The following ``get-transit-gateway-prefix-list-references`` example gets the prefix list references for the specified transit gateway route table, and filters by the ID of a specific prefix list. :: + + aws ec2 get-transit-gateway-prefix-list-references \ + --transit-gateway-route-table-id tgw-rtb-0123456789abcd123 \ + --filters Name=prefix-list-id,Values=pl-11111122222222333 + +Output:: + + { + "TransitGatewayPrefixListReferences": [ + { + "TransitGatewayRouteTableId": "tgw-rtb-0123456789abcd123", + "PrefixListId": "pl-11111122222222333", + "PrefixListOwnerId": "123456789012", + "State": "available", + "Blackhole": false, + "TransitGatewayAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-aabbccddaabbccaab", + "ResourceType": "vpc", + "ResourceId": "vpc-112233445566aabbc" + } + } + ] + } + +For more information, see `Prefix list references `__ in the *Transit Gateways Guide*. diff --git a/awscli/examples/ec2/list-images-in-recycle-bin.rst b/awscli/examples/ec2/list-images-in-recycle-bin.rst index b375b8cde15c..ceee4b13566f 100644 --- a/awscli/examples/ec2/list-images-in-recycle-bin.rst +++ b/awscli/examples/ec2/list-images-in-recycle-bin.rst @@ -18,4 +18,4 @@ Output:: ] } -For more information, see `Recover AMIs from the Recycle Bin `__ in the *Amazon Elastic Compute Cloud User Guide*. \ No newline at end of file +For more information, see `Recover deleted AMIs from the Recycle Bin `__ in the *Amazon EBS User Guide*. diff --git a/awscli/examples/ec2/list-snapshots-in-recycle-bin.rst b/awscli/examples/ec2/list-snapshots-in-recycle-bin.rst index c4a8d6b7436d..9abe1fb74f5e 100644 --- a/awscli/examples/ec2/list-snapshots-in-recycle-bin.rst +++ b/awscli/examples/ec2/list-snapshots-in-recycle-bin.rst @@ -19,4 +19,4 @@ Output:: ] } -For more information about Recycle Bin for Amazon EBS, see `Recover snapshots from the Recycle Bin `__ in the *Amazon EC2 User Guide*. \ No newline at end of file +For more information about Recycle Bin, see `Recover deleted snapshots from the Recycle Bin `__ in the *Amazon EBS User Guide*. diff --git a/awscli/examples/ec2/modify-availability-zone-group.rst b/awscli/examples/ec2/modify-availability-zone-group.rst index c6e79c72ae0a..c9315139869c 100644 --- a/awscli/examples/ec2/modify-availability-zone-group.rst +++ b/awscli/examples/ec2/modify-availability-zone-group.rst @@ -12,4 +12,4 @@ Output:: "Return": true } -For more information, see `Regions and Zones `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. \ No newline at end of file +For more information, see `Regions and Zones `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/ec2/modify-capacity-reservation.rst b/awscli/examples/ec2/modify-capacity-reservation.rst index e1306bca5efa..4668040d76d1 100644 --- a/awscli/examples/ec2/modify-capacity-reservation.rst +++ b/awscli/examples/ec2/modify-capacity-reservation.rst @@ -1,24 +1,26 @@ -**Example 1: To change the number of instances reserved by an existing capacity reservation** - -The following ``modify-capacity-reservation`` example changes the number of instances for which the capacity reservation reserves capacity. :: - - aws ec2 modify-capacity-reservation \ - --capacity-reservation-id cr-1234abcd56EXAMPLE \ - --instance-count 5 - -Output:: - - { - "Return": true - } - -**Example 2: To change the end date and time for an existing capacity reservation** - -The following ``modify-capacity-reservation`` example modifies an existing capacity reservation to end at the specified date and time. :: - - aws ec2 modify-capacity-reservation \ - --capacity-reservation-id cr-1234abcd56EXAMPLE \ - --end-date-type limited \ - --end-date 2019-08-31T23:59:59Z - -For more information, see `Modifying a Capacity Reservation `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. +**Example 1: To change the number of instances reserved by an existing capacity reservation** + +The following ``modify-capacity-reservation`` example changes the number of instances for which the capacity reservation reserves capacity. :: + + aws ec2 modify-capacity-reservation \ + --capacity-reservation-id cr-1234abcd56EXAMPLE \ + --instance-count 5 + +Output:: + + { + "Return": true + } + +For more information, see `Modify a Capacity Reservation `__ in the *Amazon EC2 User Guide*. + +**Example 2: To change the end date and time for an existing capacity reservation** + +The following ``modify-capacity-reservation`` example modifies an existing capacity reservation to end at the specified date and time. :: + + aws ec2 modify-capacity-reservation \ + --capacity-reservation-id cr-1234abcd56EXAMPLE \ + --end-date-type limited \ + --end-date 2019-08-31T23:59:59Z + +For more information, see `Modify a Capacity Reservation `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/ec2/modify-fleet.rst b/awscli/examples/ec2/modify-fleet.rst index 4bc309a86497..922dca1f4f19 100644 --- a/awscli/examples/ec2/modify-fleet.rst +++ b/awscli/examples/ec2/modify-fleet.rst @@ -12,4 +12,4 @@ Output:: "Return": true } -For more information, see `Managing an EC2 Fleet `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. \ No newline at end of file +For more information, see `Manage an EC2 Fleet `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/ec2/modify-hosts.rst b/awscli/examples/ec2/modify-hosts.rst index 737457d77f2c..952e9483c23f 100644 --- a/awscli/examples/ec2/modify-hosts.rst +++ b/awscli/examples/ec2/modify-hosts.rst @@ -1,35 +1,37 @@ -**Example 1: To enable auto-placement for a Dedicated Host** - -The following ``modify-hosts`` example enables auto-placement for a Dedicated Host so that it accepts any untargeted instance launches that match its instance type configuration. :: - - aws ec2 modify-hosts \ - --host-id h-06c2f189b4EXAMPLE \ - --auto-placement on - -Output:: - - { - "Successful": [ - "h-06c2f189b4EXAMPLE" - ], - "Unsuccessful": [] - } - -**Example 2: To enable host recovery for a Dedicated Host** - -The following ``modify-hosts`` example enables host recovery for the specified Dedicated Host. :: - - aws ec2 modify-hosts \ - --host-id h-06c2f189b4EXAMPLE \ - --host-recovery on - -Output:: - - { - "Successful": [ - "h-06c2f189b4EXAMPLE" - ], - "Unsuccessful": [] - } - -For more information, see `Modifying Dedicated Host Auto-Placement `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. +**Example 1: To enable auto-placement for a Dedicated Host** + +The following ``modify-hosts`` example enables auto-placement for a Dedicated Host so that it accepts any untargeted instance launches that match its instance type configuration. :: + + aws ec2 modify-hosts \ + --host-id h-06c2f189b4EXAMPLE \ + --auto-placement on + +Output:: + + { + "Successful": [ + "h-06c2f189b4EXAMPLE" + ], + "Unsuccessful": [] + } + +For more information, see `Modify the auto-placement setting for a Dedicated Host `__ in the *Amazon EC2 User Guide*. + +**Example 2: To enable host recovery for a Dedicated Host** + +The following ``modify-hosts`` example enables host recovery for the specified Dedicated Host. :: + + aws ec2 modify-hosts \ + --host-id h-06c2f189b4EXAMPLE \ + --host-recovery on + +Output:: + + { + "Successful": [ + "h-06c2f189b4EXAMPLE" + ], + "Unsuccessful": [] + } + +For more information, see `Modify the auto-placement setting for a Dedicated Host `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/ec2/modify-instance-capacity-reservation-attributes.rst b/awscli/examples/ec2/modify-instance-capacity-reservation-attributes.rst index 7d08f5857870..821dcc50e30b 100644 --- a/awscli/examples/ec2/modify-instance-capacity-reservation-attributes.rst +++ b/awscli/examples/ec2/modify-instance-capacity-reservation-attributes.rst @@ -1,29 +1,31 @@ -**Example 1: To modify an instance's capacity reservation targeting settings** - -The following ``modify-instance-capacity-reservation-attributes`` example modifies a stopped instance to target a specific capacity reservation. :: - - aws ec2 modify-instance-capacity-reservation-attributes \ - --instance-id i-EXAMPLE8765abcd4e \ - --capacity-reservation-specification 'CapacityReservationTarget={CapacityReservationId= cr-1234abcd56EXAMPLE }' - -Output:: - - { - "Return": true - } - -**Example 2: To modify an instance's capacity reservation targeting settings** - -The following ``modify-instance-capacity-reservation-attributes`` example modifies a stopped instance that targets the specified capacity reservation to launch in any capacity reservation that has matching attributes (instance type, platform, Availability Zone) and that has open instance matching criteria. :: - - aws ec2 modify-instance-capacity-reservation-attributes \ - --instance-id i-EXAMPLE8765abcd4e \ - --capacity-reservation-specification 'CapacityReservationPreference=open' - -Output:: - - { - "Return": true - } - -For more information, see `Modifying an Instance's Capacity Reservation Settings `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. +**Example 1: To modify an instance's capacity reservation targeting settings** + +The following ``modify-instance-capacity-reservation-attributes`` example modifies a stopped instance to target a specific capacity reservation. :: + + aws ec2 modify-instance-capacity-reservation-attributes \ + --instance-id i-EXAMPLE8765abcd4e \ + --capacity-reservation-specification 'CapacityReservationTarget={CapacityReservationId= cr-1234abcd56EXAMPLE }' + +Output:: + + { + "Return": true + } + +For more information, see `Modify the Capacity Reservation settings of your instance `__ in the *Amazon EC2 User Guide*. + +**Example 2: To modify an instance's capacity reservation targeting settings** + +The following ``modify-instance-capacity-reservation-attributes`` example modifies a stopped instance that targets the specified capacity reservation to launch in any capacity reservation that has matching attributes (instance type, platform, Availability Zone) and that has open instance matching criteria. :: + + aws ec2 modify-instance-capacity-reservation-attributes \ + --instance-id i-EXAMPLE8765abcd4e \ + --capacity-reservation-specification 'CapacityReservationPreference=open' + +Output:: + + { + "Return": true + } + +For more information, see `Modify the Capacity Reservation settings of your instance `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/ec2/modify-instance-maintenance-options.rst b/awscli/examples/ec2/modify-instance-maintenance-options.rst index d3615befa19a..ffb974d38e2b 100644 --- a/awscli/examples/ec2/modify-instance-maintenance-options.rst +++ b/awscli/examples/ec2/modify-instance-maintenance-options.rst @@ -13,7 +13,7 @@ Output:: "AutoRecovery": "disabled" } -For more information, see `Recover your instance `__ in the *Amazon EC2 User Guide for Linux Instances*. +For more information, see `Configure simplified automatic recovery `__ in the *Amazon EC2 User Guide*. **Example 2: To set the recovery behavior of an instance to default** @@ -30,4 +30,4 @@ Output:: "AutoRecovery": "default" } -For more information, see `Recover your instance `__ in the *Amazon EC2 User Guide for Linux Instances*. +For more information, see `Configure simplified automatic recovery `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/ec2/modify-instance-metadata-options.rst b/awscli/examples/ec2/modify-instance-metadata-options.rst index 951d8181849a..d48be5aa7765 100644 --- a/awscli/examples/ec2/modify-instance-metadata-options.rst +++ b/awscli/examples/ec2/modify-instance-metadata-options.rst @@ -19,8 +19,8 @@ Output:: } } -For more information, see `Instance metadata and user data `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. - +For more information, see `Instance metadata `__ in the *Amazon EC2 User Guide*. + **Example 2: To disable instance metadata** The following ``modify-instance-metadata-options`` example disables the use of all versions of instance metadata on the specified instance. :: @@ -41,11 +41,11 @@ Output:: } } -For more information, see `Instance metadata and user data `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. +For more information, see `Instance metadata `__ in the *Amazon EC2 User Guide*. **Example 3: To enable instance metadata IPv6 endpoint for your instance** -The following ``modify-instance-metadata-options`` example shows you how to turn on the IPv6 endpoint for the instance metadata service. :: +The following ``modify-instance-metadata-options`` example shows you how to turn on the IPv6 endpoint for the instance metadata service. By default, the IPv6 endpoint is disabled. This is true even if you have launched an instance into an IPv6-only subnet. The IPv6 endpoint for IMDS is only accessible on instances built on the Nitro System. :: aws ec2 modify-instance-metadata-options \ --instance-id i-1234567898abcdef0 \ @@ -65,4 +65,4 @@ Output:: } } -By default, the IPv6 endpoint is disabled. This is true even if you have launched an instance into an IPv6-only subnet. The IPv6 endpoint for IMDS is only accessible on instances built on the Nitro System. For more information, see `Instance metadata and user data `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. \ No newline at end of file +For more information, see `Instance metadata `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/ec2/modify-instance-placement.rst b/awscli/examples/ec2/modify-instance-placement.rst index cd55c72eaeb9..4c356c2e1bb9 100644 --- a/awscli/examples/ec2/modify-instance-placement.rst +++ b/awscli/examples/ec2/modify-instance-placement.rst @@ -1,80 +1,76 @@ -**Example 1: To remove an instance's affinity with a Dedicated Host** - -The following ``modify-instance-placement`` example removes an instance's affinity with a Dedicated Host and enables it to launch on any available Dedicated Host in your account that supports its instance type. :: - - aws ec2 modify-instance-placement \ - --instance-id i-0e6ddf6187EXAMPLE \ - --affinity default - -Output:: - - { - "Return": true - } - -**Example 2: To establish affinity between an instance and the specified Dedicated Host** - -The following ``modify-instance-placement`` example establishes a launch relationship between an instance and a Dedicated Host. The instance is only able to run on the specified Dedicated Host. :: - - aws ec2 modify-instance-placement \ - --instance-id i-0e6ddf6187EXAMPLE \ - --affinity host \ - --host-id i-0e6ddf6187EXAMPLE - -Output:: - - { - "Return": true - } - -For more information, see `Modifying Instance Tenancy and Affinity `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. - -**Example 3: To move an instance to a placement group** - -The following ``modify-instance-placement`` example moves an instance to a placement group, stop the instance, modify the instance placement, and then restart the instance. :: - - aws ec2 stop-instances \ - --instance-ids i-0123a456700123456 - - aws ec2 modify-instance-placement \ - --instance-id i-0123a456700123456 \ - --group-name MySpreadGroup - - aws ec2 start-instances \ - --instance-ids i-0123a456700123456 - -For more information, see `Changing the Placement Group for an Instance `__ in the *Amazon Elastic Compute Cloud Users Guide*. - -**Example 4: To remove an instance from a placement group** - -The following ``modify-instance-placement`` example removes an instance from a placement group by stopping the instance, modifying the instance placement, and then restarting the instance. The following example specifies an empty string ("") for the placement group name to indicate that the instance is not to be located in a placement group. - -Stop the instance:: - - aws ec2 stop-instances \ - --instance-ids i-0123a456700123456 - -Modify the placement (Windows Command Prompt, Linux, and macOS):: - - aws ec2 modify-instance-placement \ - --instance-id i-0123a456700123456 \ - --group-name "" - -Modify the placement (Windows PowerShell):: - - aws ec2 modify-instance-placement ` - --instance-id i-0123a456700123456 ` - --group-name """" - -Restart the instance:: - - aws ec2 start-instances \ - --instance-ids i-0123a456700123456 - -Output:: - - { - "Return": true - } - -For more information, see `Modifying Instance Tenancy and Affinity `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. \ No newline at end of file +**Example 1: To remove an instance's affinity with a Dedicated Host** + +The following ``modify-instance-placement`` example removes an instance's affinity with a Dedicated Host and enables it to launch on any available Dedicated Host in your account that supports its instance type. :: + + aws ec2 modify-instance-placement \ + --instance-id i-0e6ddf6187EXAMPLE \ + --affinity default + +Output:: + + { + "Return": true + } + +**Example 2: To establish affinity between an instance and the specified Dedicated Host** + +The following ``modify-instance-placement`` example establishes a launch relationship between an instance and a Dedicated Host. The instance is only able to run on the specified Dedicated Host. :: + + aws ec2 modify-instance-placement \ + --instance-id i-0e6ddf6187EXAMPLE \ + --affinity host \ + --host-id i-0e6ddf6187EXAMPLE + +Output:: + + { + "Return": true + } + +**Example 3: To move an instance to a placement group** + +The following ``modify-instance-placement`` example moves an instance to a placement group, stop the instance, modify the instance placement, and then restart the instance. :: + + aws ec2 stop-instances \ + --instance-ids i-0123a456700123456 + + aws ec2 modify-instance-placement \ + --instance-id i-0123a456700123456 \ + --group-name MySpreadGroup + + aws ec2 start-instances \ + --instance-ids i-0123a456700123456 + +**Example 4: To remove an instance from a placement group** + +The following ``modify-instance-placement`` example removes an instance from a placement group by stopping the instance, modifying the instance placement, and then restarting the instance. The following example specifies an empty string ("") for the placement group name to indicate that the instance is not to be located in a placement group. + +Stop the instance:: + + aws ec2 stop-instances \ + --instance-ids i-0123a456700123456 + +Modify the placement (Windows Command Prompt):: + + aws ec2 modify-instance-placement \ + --instance-id i-0123a456700123456 \ + --group-name "" + +Modify the placement (Windows PowerShell, Linux, and macOS):: + + aws ec2 modify-instance-placement ` + --instance-id i-0123a456700123456 ` + --group-name '' + +Restart the instance:: + + aws ec2 start-instances \ + --instance-ids i-0123a456700123456 + +Output:: + + { + "Return": true + } + +For more information, see `Modify Dedicated Host tenancy and affinity `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/ec2/modify-snapshot-tier.rst b/awscli/examples/ec2/modify-snapshot-tier.rst index 89f7b5549020..d00059ed4bac 100644 --- a/awscli/examples/ec2/modify-snapshot-tier.rst +++ b/awscli/examples/ec2/modify-snapshot-tier.rst @@ -1,6 +1,6 @@ -**Example 1: To archive a snapshot** +**To archive a snapshot** -The following ``modify-snapshot-tier`` example archives the specified snapshot. :: +The following ``modify-snapshot-tier`` example archives the specified snapshot. The ``TieringStartTime`` response parameter indicates the date and time at which the archive process was started, in UTC time format (YYYY-MM-DDTHH:MM:SSZ). :: aws ec2 modify-snapshot-tier \ --snapshot-id snap-01234567890abcedf \ @@ -13,6 +13,4 @@ Output:: "TieringStartTime": "2021-09-15T16:44:37.574Z" } -The ``TieringStartTime`` response parameter indicates the date and time at which the archive process was started, in UTC time format (YYYY-MM-DDTHH:MM:SSZ). - -For more information about snapshot archiving, see `Archive Amazon EBS snapshots `__ in the *Amazon EC2 User Guide*. \ No newline at end of file +For more information about snapshot archiving, see `Archive Amazon EBS snapshots `__ in the *Amazon EBS User Guide*. diff --git a/awscli/examples/ec2/modify-transit-gateway-prefix-list-reference.rst b/awscli/examples/ec2/modify-transit-gateway-prefix-list-reference.rst index b4719a323560..4af295a7029d 100644 --- a/awscli/examples/ec2/modify-transit-gateway-prefix-list-reference.rst +++ b/awscli/examples/ec2/modify-transit-gateway-prefix-list-reference.rst @@ -1,27 +1,27 @@ -**To modify a reference to a prefix list** - -The following ``modify-transit-gateway-prefix-list-reference`` example modifies the prefix list reference in the specified route table by changing the attachment to which traffic is routed. :: - - aws ec2 modify-transit-gateway-prefix-list-reference \ - --transit-gateway-route-table-id tgw-rtb-0123456789abcd123 \ - --prefix-list-id pl-11111122222222333 \ - --transit-gateway-attachment-id tgw-attach-aabbccddaabbccaab - -Output:: - - { - "TransitGatewayPrefixListReference": { - "TransitGatewayRouteTableId": "tgw-rtb-0123456789abcd123", - "PrefixListId": "pl-11111122222222333", - "PrefixListOwnerId": "123456789012", - "State": "modifying", - "Blackhole": false, - "TransitGatewayAttachment": { - "TransitGatewayAttachmentId": "tgw-attach-aabbccddaabbccaab", - "ResourceType": "vpc", - "ResourceId": "vpc-112233445566aabbc" - } - } - } - -For more information, see `Prefix list references `__ in the *Transit Gateways Guide*. +**To modify a reference to a prefix list** + +The following ``modify-transit-gateway-prefix-list-reference`` example modifies the prefix list reference in the specified route table by changing the attachment to which traffic is routed. :: + + aws ec2 modify-transit-gateway-prefix-list-reference \ + --transit-gateway-route-table-id tgw-rtb-0123456789abcd123 \ + --prefix-list-id pl-11111122222222333 \ + --transit-gateway-attachment-id tgw-attach-aabbccddaabbccaab + +Output:: + + { + "TransitGatewayPrefixListReference": { + "TransitGatewayRouteTableId": "tgw-rtb-0123456789abcd123", + "PrefixListId": "pl-11111122222222333", + "PrefixListOwnerId": "123456789012", + "State": "modifying", + "Blackhole": false, + "TransitGatewayAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-aabbccddaabbccaab", + "ResourceType": "vpc", + "ResourceId": "vpc-112233445566aabbc" + } + } + } + +For more information, see `Prefix list references `__ in the *Transit Gateways Guide*. diff --git a/awscli/examples/ec2/modify-verified-access-endpoint.rst b/awscli/examples/ec2/modify-verified-access-endpoint.rst index 4158acfc610c..d21e2cf5a5da 100644 --- a/awscli/examples/ec2/modify-verified-access-endpoint.rst +++ b/awscli/examples/ec2/modify-verified-access-endpoint.rst @@ -4,7 +4,7 @@ The following ``modify-verified-access-endpoint`` example adds the specified des aws ec2 modify-verified-access-endpoint \ --verified-access-endpoint-id vae-066fac616d4d546f2 \ - --description "Testing Verified Access" + --description 'Testing Verified Access' Output:: @@ -35,4 +35,4 @@ Output:: } } -For more information, see `Verified Access endpoints `__ in the *AWS Verified Access User Guide*. +For more information, see `Verified Access endpoints `__ in the *AWS Verified Access User Guide*. diff --git a/awscli/examples/ec2/register-instance-event-notification-attributes.rst b/awscli/examples/ec2/register-instance-event-notification-attributes.rst index b47c7aaf4316..db45a4dfacc1 100644 --- a/awscli/examples/ec2/register-instance-event-notification-attributes.rst +++ b/awscli/examples/ec2/register-instance-event-notification-attributes.rst @@ -14,7 +14,7 @@ Output:: } } -For more information, see `Scheduled events for your instances `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. +For more information, see `Scheduled events for your instances `__ in the *Amazon EC2 User Guide*. **Example 2: To include specific tags in event notifications** @@ -35,4 +35,4 @@ Output:: } } -For more information, see `Scheduled events for your instances `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. \ No newline at end of file +For more information, see `Scheduled events for your instances `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst b/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst index 46ddf85f5cf6..bbb74add71e2 100755 --- a/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst +++ b/awscli/examples/ec2/register-transit-gateway-multicast-group-members.rst @@ -19,4 +19,4 @@ Output:: } } -For more information, see `Managing multicast domains `__ in the *Transit Gateways User Guide*. \ No newline at end of file +For more information, see `Multicast domains `__ in the *Transit Gateways User Guide*. diff --git a/awscli/examples/ec2/register-transit-gateway-multicast-group-sources.rst b/awscli/examples/ec2/register-transit-gateway-multicast-group-sources.rst index c8b67bfe69ff..545087ca7928 100644 --- a/awscli/examples/ec2/register-transit-gateway-multicast-group-sources.rst +++ b/awscli/examples/ec2/register-transit-gateway-multicast-group-sources.rst @@ -19,4 +19,4 @@ Output:: } } -For more information, see `Managing multicast domains `__ in the *Transit Gateways Guide*. \ No newline at end of file +For more information, see `Multicast domains `__ in the *Transit Gateways Guide*. diff --git a/awscli/examples/ec2/restore-image-from-recycle-bin.rst b/awscli/examples/ec2/restore-image-from-recycle-bin.rst index f3bc9224486d..97f5b47b7315 100644 --- a/awscli/examples/ec2/restore-image-from-recycle-bin.rst +++ b/awscli/examples/ec2/restore-image-from-recycle-bin.rst @@ -11,4 +11,4 @@ Output:: "Return": true } -For more information, see `Recover AMIs from the Recycle Bin `__ in the *Amazon Elastic Compute Cloud User Guide*. \ No newline at end of file +For more information, see `Recover deleted AMIs from the Recycle Bin `__ in the *Amazon EBS User Guide*. diff --git a/awscli/examples/ec2/restore-snapshot-from-recycle-bin.rst b/awscli/examples/ec2/restore-snapshot-from-recycle-bin.rst index 901823578b61..89970d86c142 100644 --- a/awscli/examples/ec2/restore-snapshot-from-recycle-bin.rst +++ b/awscli/examples/ec2/restore-snapshot-from-recycle-bin.rst @@ -7,4 +7,4 @@ The following ``restore-snapshot-from-recycle-bin`` example restores a snapshot This command produces no output. -For more information about Recycle Bin for Amazon EBS, see `Recover snapshots from the Recycle Bin `__ in the *Amazon EC2 User Guide*. \ No newline at end of file +For more information about Recycle Bin, see `Recover deleted snapshots from the Recycle Bin `__ in the *Amazon EBS User Guide*. diff --git a/awscli/examples/ec2/restore-snapshot-tier.rst b/awscli/examples/ec2/restore-snapshot-tier.rst index e62a70a856c9..f0c6cd206e69 100644 --- a/awscli/examples/ec2/restore-snapshot-tier.rst +++ b/awscli/examples/ec2/restore-snapshot-tier.rst @@ -13,7 +13,7 @@ Output:: "IsPermanentRestore": true } -For more information about snapshot archiving, see `Archive Amazon EBS snapshots ` in the *Amazon EC2 User Guide*. +For more information about snapshot archiving, see `Archive Amazon EBS snapshots `__ in the *Amazon EBS User Guide*. **Example 2: To temporarily restore an archived snapshot** @@ -31,7 +31,7 @@ Output:: "IsPermanentRestore": false } -For more information about snapshot archiving, see `Archive Amazon EBS snapshots ` in the *Amazon EC2 User Guide*. +For more information about snapshot archiving, see `Archive Amazon EBS snapshots `__ in the *Amazon EBS User Guide*. **Example 3: To modify the restore period** @@ -49,7 +49,7 @@ Output:: "IsPermanentRestore": false } -For more information about snapshot archiving, see `Archive Amazon EBS snapshots ` in the *Amazon EC2 User Guide*. +For more information about snapshot archiving, see `Archive Amazon EBS snapshots `__ in the *Amazon EBS User Guide*. **Example 4: To modify the restore type** @@ -66,4 +66,4 @@ Output:: "IsPermanentRestore": true } -For more information about snapshot archiving, see `Archive Amazon EBS snapshots ` in the *Amazon EC2 User Guide*. \ No newline at end of file +For more information about snapshot archiving, see `Archive Amazon EBS snapshots `__ in the *Amazon EBS User Guide*. diff --git a/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst b/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst index 0f801b40a60c..09adac09a4a3 100755 --- a/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst +++ b/awscli/examples/ec2/search-transit-gateway-multicast-groups.rst @@ -23,4 +23,4 @@ Output:: ] } -For more information, see `Managing multicast groups `__ in the *Transit Gateways Guide*. \ No newline at end of file +For more information, see `Multicast on transit gateways `__ in the *Transit Gateways Guide*. diff --git a/awscli/examples/ec2/start-network-insights-access-scope-analysis.rst b/awscli/examples/ec2/start-network-insights-access-scope-analysis.rst index 90bddfc0b94a..4903f56b8bea 100644 --- a/awscli/examples/ec2/start-network-insights-access-scope-analysis.rst +++ b/awscli/examples/ec2/start-network-insights-access-scope-analysis.rst @@ -1,21 +1,21 @@ -**To start a Network Insights access scope analysis** - -The following ``start-network-insights-access-scope-analysis`` example starts the scope analysis in your AWS account. :: - - aws ec2 start-network-insights-access-scope-analysis \ - --region us-east-1 \ - --network-insights-access-scope-id nis-123456789111 - -Output:: - - { - "NetworkInsightsAccessScopeAnalysis": { - "NetworkInsightsAccessScopeAnalysisId": "nisa-123456789222", - "NetworkInsightsAccessScopeAnalysisArn": "arn:aws:ec2:us-east-1:123456789012:network-insights-access-scope-analysis/nisa-123456789222", - "NetworkInsightsAccessScopeId": "nis-123456789111", - "Status": "running", - "StartDate": "2022-01-26T00:47:06.814000+00:00" - } - } - -For more information, see `Getting started with Network Access Analyzer using the AWS CLI `__ in the *Network Access Analyzer Guide*. \ No newline at end of file +**To start a Network Insights access scope analysis** + +The following ``start-network-insights-access-scope-analysis`` example starts the scope analysis in your AWS account. :: + + aws ec2 start-network-insights-access-scope-analysis \ + --region us-east-1 \ + --network-insights-access-scope-id nis-123456789111 + +Output:: + + { + "NetworkInsightsAccessScopeAnalysis": { + "NetworkInsightsAccessScopeAnalysisId": "nisa-123456789222", + "NetworkInsightsAccessScopeAnalysisArn": "arn:aws:ec2:us-east-1:123456789012:network-insights-access-scope-analysis/nisa-123456789222", + "NetworkInsightsAccessScopeId": "nis-123456789111", + "Status": "running", + "StartDate": "2022-01-26T00:47:06.814000+00:00" + } + } + +For more information, see `Getting started with Network Access Analyzer using the AWS CLI `__ in the *Network Access Analyzer Guide*.