awscli 1.37.3__py3-none-any.whl → 1.37.5__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of awscli might be problematic. Click here for more details.

Files changed (160) hide show
  1. awscli/__init__.py +1 -1
  2. awscli/examples/cloudfront/create-distribution-with-tags.rst +9 -13
  3. awscli/examples/cloudfront/get-distribution.rst +6 -10
  4. awscli/examples/cloudtrail/create-subscription.rst +29 -26
  5. awscli/examples/cloudtrail/create-trail.rst +13 -11
  6. awscli/examples/cloudtrail/describe-trails.rst +30 -29
  7. awscli/examples/cloudtrail/put-event-selectors.rst +9 -9
  8. awscli/examples/cloudtrail/update-subscription.rst +25 -22
  9. awscli/examples/cloudtrail/update-trail.rst +12 -10
  10. awscli/examples/codebuild/create-report-group.rst +2 -2
  11. awscli/examples/datapipeline/get-pipeline-definition.rst +1 -1
  12. awscli/examples/deploy/batch-get-deployments.rst +2 -2
  13. awscli/examples/deploy/create-deployment.rst +1 -1
  14. awscli/examples/deploy/get-application-revision.rst +2 -2
  15. awscli/examples/deploy/get-deployment.rst +1 -1
  16. awscli/examples/deploy/list-application-revisions.rst +3 -3
  17. awscli/examples/deploy/push.rst +2 -2
  18. awscli/examples/deploy/register-application-revision.rst +1 -1
  19. awscli/examples/ds-data/add-group-member.rst +12 -0
  20. awscli/examples/ds-data/create-group.rst +17 -0
  21. awscli/examples/ds-data/create-user.rst +17 -0
  22. awscli/examples/ds-data/delete-group.rst +11 -0
  23. awscli/examples/ds-data/delete-user.rst +11 -0
  24. awscli/examples/ds-data/describe-group.rst +21 -0
  25. awscli/examples/ds-data/describe-user.rst +21 -0
  26. awscli/examples/ds-data/disable-directory-data-access.rst +10 -0
  27. awscli/examples/ds-data/disable-user.rst +11 -0
  28. awscli/examples/ds-data/enable-directory-data-access.rst +10 -0
  29. awscli/examples/ds-data/list-group-members.rst +29 -0
  30. awscli/examples/ds-data/list-groups-for-member.rst +25 -0
  31. awscli/examples/ds-data/list-groups.rst +503 -0
  32. awscli/examples/ds-data/list-users.rst +57 -0
  33. awscli/examples/ds-data/remove-group-member.rst +12 -0
  34. awscli/examples/ds-data/reset-user-password.rst +12 -0
  35. awscli/examples/ds-data/search-groups.rst +25 -0
  36. awscli/examples/ds-data/search-users.rst +24 -0
  37. awscli/examples/ds-data/update-group.rst +13 -0
  38. awscli/examples/ds-data/update-user.rst +13 -0
  39. awscli/examples/ec2/accept-address-transfer.rst +1 -1
  40. awscli/examples/ec2/allocate-hosts.rst +55 -55
  41. awscli/examples/ec2/associate-address.rst +44 -35
  42. awscli/examples/ec2/authorize-security-group-egress.rst +56 -23
  43. awscli/examples/ec2/authorize-security-group-ingress.rst +15 -15
  44. awscli/examples/ec2/cancel-capacity-reservation.rst +14 -14
  45. awscli/examples/ec2/cancel-spot-fleet-requests.rst +43 -46
  46. awscli/examples/ec2/copy-snapshot.rst +2 -4
  47. awscli/examples/ec2/create-capacity-reservation.rst +95 -95
  48. awscli/examples/ec2/create-replace-root-volume-task.rst +1 -3
  49. awscli/examples/ec2/create-restore-image-task.rst +2 -2
  50. awscli/examples/ec2/create-spot-datafeed-subscription.rst +1 -1
  51. awscli/examples/ec2/create-tags.rst +43 -43
  52. awscli/examples/ec2/create-traffic-mirror-filter-rule.rst +32 -32
  53. awscli/examples/ec2/create-traffic-mirror-filter.rst +22 -12
  54. awscli/examples/ec2/create-traffic-mirror-session.rst +31 -31
  55. awscli/examples/ec2/create-traffic-mirror-target.rst +45 -35
  56. awscli/examples/ec2/create-transit-gateway-prefix-list-reference.rst +27 -27
  57. awscli/examples/ec2/create-verified-access-endpoint.rst +1 -1
  58. awscli/examples/ec2/create-vpc-endpoint-service-configuration.rst +67 -65
  59. awscli/examples/ec2/create-vpc-endpoint.rst +4 -4
  60. awscli/examples/ec2/describe-capacity-reservations.rst +46 -31
  61. awscli/examples/ec2/describe-instance-image-metadata.rst +186 -0
  62. awscli/examples/ec2/describe-spot-datafeed-subscription.rst +1 -1
  63. awscli/examples/ec2/describe-vpc-endpoint-service-configurations.rst +62 -62
  64. awscli/examples/ec2/describe-vpc-endpoint-services.rst +132 -134
  65. awscli/examples/ec2/describe-vpc-endpoints.rst +89 -89
  66. awscli/examples/ec2/register-image.rst +32 -32
  67. awscli/examples/ecr-public/get-registry-catalog-data.rst +14 -0
  68. awscli/examples/ecr-public/get-repository-catalog-data.rst +29 -0
  69. awscli/examples/ecr-public/list-tags-for-resource.rst +28 -0
  70. awscli/examples/ecr-public/put-registry-catalog-data.rst +15 -0
  71. awscli/examples/ecr-public/put-repository-catalog-data.rst +5 -4
  72. awscli/examples/ecr-public/tag-resource.rst +21 -0
  73. awscli/examples/ecr-public/untag-resource.rst +12 -0
  74. awscli/examples/ecs/describe-service-deployments.rst +54 -0
  75. awscli/examples/ecs/describe-service-revisions.rst +60 -0
  76. awscli/examples/ecs/list-service-deployments.rst +25 -0
  77. awscli/examples/eks/describe-cluster.rst +1 -1
  78. awscli/examples/emr/create-cluster-examples.rst +4 -4
  79. awscli/examples/emr/schedule-hbase-backup.rst +23 -23
  80. awscli/examples/importexport/create-job.rst +2 -2
  81. awscli/examples/importexport/get-shipping-label.rst +1 -1
  82. awscli/examples/importexport/get-status.rst +1 -1
  83. awscli/examples/ivs-realtime/create-storage-configuration.rst +20 -20
  84. awscli/examples/ivs-realtime/get-storage-configuration.rst +20 -20
  85. awscli/examples/ivs-realtime/list-storage-configurations.rst +29 -29
  86. awscli/examples/kendra/create-data-source.rst +23 -23
  87. awscli/examples/kendra/describe-data-source.rst +83 -83
  88. awscli/examples/kendra/update-data-source.rst +18 -18
  89. awscli/examples/macie2/describe-buckets.rst +13 -11
  90. awscli/examples/oam/create-link.rst +24 -0
  91. awscli/examples/oam/create-sink.rst +17 -0
  92. awscli/examples/oam/delete-link.rst +10 -0
  93. awscli/examples/oam/delete-sink.rst +10 -0
  94. awscli/examples/oam/get-link.rst +22 -0
  95. awscli/examples/oam/get-sink-policy.rst +16 -0
  96. awscli/examples/oam/get-sink.rst +17 -0
  97. awscli/examples/oam/list-attached-links.rst +23 -0
  98. awscli/examples/oam/list-links.rst +21 -0
  99. awscli/examples/oam/list-sinks.rst +19 -0
  100. awscli/examples/oam/list-tags-for-resource.rst +16 -0
  101. awscli/examples/oam/put-sink-policy.rst +17 -0
  102. awscli/examples/oam/tag-resource.rst +11 -0
  103. awscli/examples/oam/untag-resource.rst +11 -0
  104. awscli/examples/oam/update-link.rst +24 -0
  105. awscli/examples/polly/get-speech-synthesis-task.rst +23 -23
  106. awscli/examples/polly/list-speech-synthesis-tasks.rst +25 -25
  107. awscli/examples/polly/start-speech-synthesis-task.rst +27 -27
  108. awscli/examples/qldb/describe-journal-s3-export.rst +1 -1
  109. awscli/examples/qldb/export-journal-to-s3.rst +1 -1
  110. awscli/examples/qldb/list-journal-s3-exports-for-ledger.rst +1 -1
  111. awscli/examples/qldb/list-journal-s3-exports.rst +2 -2
  112. awscli/examples/rds/download-db-log-file-portion.rst +7 -3
  113. awscli/examples/resourcegroupstaggingapi/untag-resources.rst +1 -1
  114. awscli/examples/s3/cp.rst +7 -7
  115. awscli/examples/s3/ls.rst +2 -2
  116. awscli/examples/s3/mv.rst +5 -5
  117. awscli/examples/s3/sync.rst +5 -5
  118. awscli/examples/s3api/put-bucket-acl.rst +1 -1
  119. awscli/examples/s3api/put-bucket-cors.rst +1 -1
  120. awscli/examples/s3api/put-bucket-logging.rst +10 -10
  121. awscli/examples/s3api/put-bucket-policy.rst +5 -5
  122. awscli/examples/s3api/put-object-acl.rst +1 -1
  123. awscli/examples/securitylake/create-subscriber.rst +83 -0
  124. awscli/examples/synthetics/associate-resource.rst +11 -0
  125. awscli/examples/synthetics/create-canary.rst +48 -0
  126. awscli/examples/synthetics/create-group.rst +21 -0
  127. awscli/examples/synthetics/delete-canary.rst +10 -0
  128. awscli/examples/synthetics/delete-group.rst +10 -0
  129. awscli/examples/synthetics/describe-canaries-last-run.rst +31 -0
  130. awscli/examples/synthetics/describe-canaries.rst +48 -0
  131. awscli/examples/synthetics/describe-runtime-versions.rst +74 -0
  132. awscli/examples/synthetics/disassociate-resource.rst +11 -0
  133. awscli/examples/synthetics/get-canary-runs.rst +29 -0
  134. awscli/examples/synthetics/get-canary.rst +47 -0
  135. awscli/examples/synthetics/get-group.rst +21 -0
  136. awscli/examples/synthetics/list-associated-groups.rst +20 -0
  137. awscli/examples/synthetics/list-group-resources.rst +16 -0
  138. awscli/examples/synthetics/list-groups.rst +19 -0
  139. awscli/examples/synthetics/list-tags-for-resource.rst +31 -0
  140. awscli/examples/synthetics/start-canary.rst +10 -0
  141. awscli/examples/synthetics/stop-canary.rst +10 -0
  142. awscli/examples/synthetics/tag-resource.rst +21 -0
  143. awscli/examples/synthetics/untag-resource.rst +21 -0
  144. awscli/examples/synthetics/update-canary.rst +11 -0
  145. {awscli-1.37.3.dist-info → awscli-1.37.5.dist-info}/METADATA +2 -2
  146. {awscli-1.37.3.dist-info → awscli-1.37.5.dist-info}/RECORD +158 -93
  147. awscli/examples/securitylake/create-subscriber-data-access.rst +0 -41
  148. awscli/examples/securitylake/create-subscriber-query-access.rst +0 -41
  149. /awscli/examples/securitylake/{create-aws-logsource.rst → create-aws-log-source.rst} +0 -0
  150. /awscli/examples/securitylake/{create-custom-logsource.rst → create-custom-log-source.rst} +0 -0
  151. /awscli/examples/securitylake/{delete-aws-logsource.rst → delete-aws-log-source.rst} +0 -0
  152. /awscli/examples/securitylake/{delete-custom-logsource.rst → delete-custom-log-source.rst} +0 -0
  153. {awscli-1.37.3.data → awscli-1.37.5.data}/scripts/aws +0 -0
  154. {awscli-1.37.3.data → awscli-1.37.5.data}/scripts/aws.cmd +0 -0
  155. {awscli-1.37.3.data → awscli-1.37.5.data}/scripts/aws_bash_completer +0 -0
  156. {awscli-1.37.3.data → awscli-1.37.5.data}/scripts/aws_completer +0 -0
  157. {awscli-1.37.3.data → awscli-1.37.5.data}/scripts/aws_zsh_completer.sh +0 -0
  158. {awscli-1.37.3.dist-info → awscli-1.37.5.dist-info}/LICENSE.txt +0 -0
  159. {awscli-1.37.3.dist-info → awscli-1.37.5.dist-info}/WHEEL +0 -0
  160. {awscli-1.37.3.dist-info → awscli-1.37.5.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,57 @@
1
+ **To list a directory's users**
2
+
3
+ The following ``list-users`` example lists users in the specified directory. ::
4
+
5
+ aws ds-data list-users \
6
+ --directory-id d-1234567890
7
+
8
+ Output::
9
+
10
+ {
11
+ "Users": [
12
+ {
13
+ "Enabled": true,
14
+ "SAMAccountName": "Administrator",
15
+ "SID": "S-1-2-34-5678910123-4567895012-3456789012-345"
16
+ },
17
+ {
18
+ "Enabled": false,
19
+ "SAMAccountName": "Guest",
20
+ "SID": "S-1-2-34-5678910123-4567895012-3456789012-345"
21
+ },
22
+ {
23
+ "Enabled": false,
24
+ "SAMAccountName": "krbtgt",
25
+ "SID": "S-1-2-34-5678910123-4567895012-3456789012-346"
26
+ },
27
+ {
28
+ "Enabled": true,
29
+ "SAMAccountName": "Admin",
30
+ "SID": "S-1-2-34-5678910123-4567895012-3456789012-347"
31
+ },
32
+ {
33
+ "Enabled": true,
34
+ "SAMAccountName": "Richard Roe",
35
+ "SID": "S-1-2-34-5678910123-4567895012-3456789012-348"
36
+ },
37
+ {
38
+ "Enabled": true,
39
+ "SAMAccountName": "Jane Doe",
40
+ "SID": "S-1-2-34-5678910123-4567895012-3456789012-349"
41
+ },
42
+ {
43
+ "Enabled": true,
44
+ "SAMAccountName": "AWS_WGnzYlN6YyY",
45
+ "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567"
46
+ },
47
+ {
48
+ "Enabled": true,
49
+ "SAMAccountName": "john.doe",
50
+ "SID": "S-1-2-34-5678901234-5678901234-5678910123-4568"
51
+ }
52
+ ],
53
+ "DirectoryId": "d-1234567890",
54
+ "Realm": "corp.example.com"
55
+ }
56
+
57
+ For more information, see `Viewing and updating an AWS Managed Microsoft AD user <https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html>`__ in the *AWS Directory Service Administration Guide*.
@@ -0,0 +1,12 @@
1
+ **To remove a group member from a directory**
2
+
3
+ The following ``remove-group-member`` example removes the specified group member from the specified group in the specified directory. ::
4
+
5
+ aws ds-data remove-group-member \
6
+ --directory-id d-1234567890 \
7
+ --group-name 'sales' \
8
+ --member-name 'john.doe'
9
+
10
+ This command produces no output.
11
+
12
+ For more information, see `Adding and removing AWS Managed Microsoft AD members to groups and groups to groups <https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_add_remove_user_group.html>`__ in the *AWS Directory Service Administration Guide*.
@@ -0,0 +1,12 @@
1
+ **To reset a user password in a directory**
2
+
3
+ The following ``reset-user-password`` example resets and enables the specified user in the specified directory. ::
4
+
5
+ aws ds reset-user-password \
6
+ --directory-id d-1234567890 \
7
+ --user-name 'john.doe' \
8
+ --new-password 'password'
9
+
10
+ This command produces no output.
11
+
12
+ For more information, see `Resetting and enabling an AWS Managed Microsoft AD user's password <https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_reset_user_pswd.html>`__ in the *AWS Directory Service Administration Guide*.
@@ -0,0 +1,25 @@
1
+ **To search for a group in a directory**
2
+
3
+ The following ``search-groups`` example searches for the specified group in the specified directory. ::
4
+
5
+ aws ds-data search-groups \
6
+ --directory-id d-1234567890 \
7
+ --search-attributes 'SamAccountName' \
8
+ --search-string 'sales'
9
+
10
+ Output::
11
+
12
+ {
13
+ "Groups": [
14
+ {
15
+ "GroupScope": "Global",
16
+ "GroupType": "Distribution",
17
+ "SAMAccountName": "sales",
18
+ "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567"
19
+ }
20
+ ],
21
+ "DirectoryId": "d-1234567890",
22
+ "Realm": "corp.example.com"
23
+ }
24
+
25
+ For more information, see `Viewing and updating an AWS Managed Microsoft AD group's details <https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_group.html>`__ in the *AWS Directory Service Administration Guide*.
@@ -0,0 +1,24 @@
1
+ **To search for a user in a directory**
2
+
3
+ The following ``search-users`` example searches for the specified user in the specified directory. ::
4
+
5
+ aws ds-data search-users \
6
+ --directory-id d-1234567890 \
7
+ --search-attributes 'SamAccountName' \
8
+ --Search-string 'john.doe'
9
+
10
+ Output::
11
+
12
+ {
13
+ "Users": [
14
+ {
15
+ "Enabled": true,
16
+ "SAMAccountName": "john.doe",
17
+ "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567"
18
+ }
19
+ ],
20
+ "DirectoryId": "d-1234567890",
21
+ "Realm": "corp.example.com"
22
+ }
23
+
24
+ For more information, see `Viewing and updating an AWS Managed Microsoft AD user <https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html>`__ in the *AWS Directory Service Administration Guide*.
@@ -0,0 +1,13 @@
1
+ **To update a group's attribute in a directory**
2
+
3
+ The following ``update-group`` example updates the specified attribute for the specified group in the specified directory. ::
4
+
5
+ aws ds-data update-group \
6
+ --directory-id d-1234567890 \
7
+ --sam-account-name 'sales' \
8
+ --update-type 'REPLACE' \
9
+ --group-type 'Distribution'
10
+
11
+ This command produces no output.
12
+
13
+ For more information, see `Viewing and updating an AWS Managed Microsoft AD group's details <https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_group.html>`__ in the *AWS Directory Service Administration Guide*.
@@ -0,0 +1,13 @@
1
+ **To update a user's attribute in a directory**
2
+
3
+ The following ``update-user`` example updates the specified attribute for the specified user in the specified directory. ::
4
+
5
+ aws ds-data update-user \
6
+ --directory-id d-1234567890 \
7
+ --sam-account-name 'john.doe' \
8
+ --update-type 'ADD' \
9
+ --email-address 'example.corp.com'
10
+
11
+ This command produces no output.
12
+
13
+ For more information, see `Viewing and updating an AWS Managed Microsoft AD user <https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html>`__ in the *AWS Directory Service Administration Guide*.
@@ -18,4 +18,4 @@ Output::
18
18
  }
19
19
  }
20
20
 
21
- For more information, see `Transfer Elastic IP addresses <https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro>`__ in the *Amazon VPC User Guide*.
21
+ For more information, see `Transfer Elastic IP addresses <https://docs.aws.amazon.com/vpc/latest/userguide/WorkWithEIPs.html#transfer-EIPs-intro>`__ in the *Amazon VPC User Guide*.
@@ -1,55 +1,55 @@
1
- **Example 1: To allocate a Dedicated Host**
2
-
3
- The following ``allocate-hosts`` example allocates a single Dedicated Host in the ``eu-west-1a`` Availability Zone, onto which you can launch ``m5.large`` instances. By default, the Dedicated Host accepts only target instance launches, and does not support host recovery. ::
4
-
5
- aws ec2 allocate-hosts \
6
- --instance-type m5.large \
7
- --availability-zone eu-west-1a \
8
- --quantity 1
9
-
10
- Output::
11
-
12
- {
13
- "HostIds": [
14
- "h-07879acf49EXAMPLE"
15
- ]
16
- }
17
-
18
- **Example 2: To allocate a Dedicated Host with auto-placement and host recovery enabled**
19
-
20
- The following ``allocate-hosts`` example allocates a single Dedicated Host in the ``eu-west-1a`` Availability Zone with auto-placement and host recovery enabled. ::
21
-
22
- aws ec2 allocate-hosts \
23
- --instance-type m5.large \
24
- --availability-zone eu-west-1a \
25
- --auto-placement on \
26
- --host-recovery on \
27
- --quantity 1
28
-
29
- Output::
30
-
31
- {
32
- "HostIds": [
33
- "h-07879acf49EXAMPLE"
34
- ]
35
- }
36
-
37
- **Example 3: To allocate a Dedicated Host with tags**
38
-
39
- The following ``allocate-hosts`` example allocates a single Dedicated Host and applies a tag with a key named ``purpose`` and a value of ``production``. ::
40
-
41
- aws ec2 allocate-hosts \
42
- --instance-type m5.large \
43
- --availability-zone eu-west-1a \
44
- --quantity 1 \
45
- --tag-specifications 'ResourceType=dedicated-host,Tags={Key=purpose,Value=production}'
46
-
47
- Output::
48
-
49
- {
50
- "HostIds": [
51
- "h-07879acf49EXAMPLE"
52
- ]
53
- }
54
-
55
- For more information, see `Allocating Dedicated Hosts <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-allocating>`__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*.
1
+ **Example 1: To allocate a Dedicated Host**
2
+
3
+ The following ``allocate-hosts`` example allocates a single Dedicated Host in the ``eu-west-1a`` Availability Zone, onto which you can launch ``m5.large`` instances. By default, the Dedicated Host accepts only target instance launches, and does not support host recovery. ::
4
+
5
+ aws ec2 allocate-hosts \
6
+ --instance-type m5.large \
7
+ --availability-zone eu-west-1a \
8
+ --quantity 1
9
+
10
+ Output::
11
+
12
+ {
13
+ "HostIds": [
14
+ "h-07879acf49EXAMPLE"
15
+ ]
16
+ }
17
+
18
+ **Example 2: To allocate a Dedicated Host with auto-placement and host recovery enabled**
19
+
20
+ The following ``allocate-hosts`` example allocates a single Dedicated Host in the ``eu-west-1a`` Availability Zone with auto-placement and host recovery enabled. ::
21
+
22
+ aws ec2 allocate-hosts \
23
+ --instance-type m5.large \
24
+ --availability-zone eu-west-1a \
25
+ --auto-placement on \
26
+ --host-recovery on \
27
+ --quantity 1
28
+
29
+ Output::
30
+
31
+ {
32
+ "HostIds": [
33
+ "h-07879acf49EXAMPLE"
34
+ ]
35
+ }
36
+
37
+ **Example 3: To allocate a Dedicated Host with tags**
38
+
39
+ The following ``allocate-hosts`` example allocates a single Dedicated Host and applies a tag with a key named ``purpose`` and a value of ``production``. ::
40
+
41
+ aws ec2 allocate-hosts \
42
+ --instance-type m5.large \
43
+ --availability-zone eu-west-1a \
44
+ --quantity 1 \
45
+ --tag-specifications 'ResourceType=dedicated-host,Tags={Key=purpose,Value=production}'
46
+
47
+ Output::
48
+
49
+ {
50
+ "HostIds": [
51
+ "h-07879acf49EXAMPLE"
52
+ ]
53
+ }
54
+
55
+ For more information, see `Allocate a Dedicated Host <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-allocating.html>`__ in the *Amazon EC2 User Guide*.
@@ -1,35 +1,44 @@
1
- **To associate an Elastic IP addresses in EC2-Classic**
2
-
3
- This example associates an Elastic IP address with an instance in EC2-Classic. If the command succeeds, no output is returned.
4
-
5
- Command::
6
-
7
- aws ec2 associate-address --instance-id i-07ffe74c7330ebf53 --public-ip 198.51.100.0
8
-
9
- **To associate an Elastic IP address in EC2-VPC**
10
-
11
- This example associates an Elastic IP address with an instance in a VPC.
12
-
13
- Command::
14
-
15
- aws ec2 associate-address --instance-id i-0b263919b6498b123 --allocation-id eipalloc-64d5890a
16
-
17
- Output::
18
-
19
- {
20
- "AssociationId": "eipassoc-2bebb745"
21
- }
22
-
23
- This example associates an Elastic IP address with a network interface.
24
-
25
- Command::
26
-
27
- aws ec2 associate-address --allocation-id eipalloc-64d5890a --network-interface-id eni-1a2b3c4d
28
-
29
- This example associates an Elastic IP with a private IP address that's associated with a network interface.
30
-
31
- Command::
32
-
33
- aws ec2 associate-address --allocation-id eipalloc-64d5890a --network-interface-id eni-1a2b3c4d --private-ip-address 10.0.0.85
34
-
35
-
1
+ **Example 1: To associate an Elastic IP address with an instance**
2
+
3
+ The following ``associate-address`` example associates an Elastic IP address with the specified EC2 instance. ::
4
+
5
+ aws ec2 associate-address \
6
+ --instance-id i-0b263919b6498b123 \
7
+ --allocation-id eipalloc-64d5890a
8
+
9
+ Output::
10
+
11
+ {
12
+ "AssociationId": "eipassoc-2bebb745"
13
+ }
14
+
15
+ **Example 2: To associate an Elastic IP address with a network interface**
16
+
17
+ The following ``associate-address`` example associates the specified Elastic IP address with the specified network interface. ::
18
+
19
+ aws ec2 associate-address
20
+ --allocation-id eipalloc-64d5890a \
21
+ --network-interface-id eni-1a2b3c4d
22
+
23
+ Output::
24
+
25
+ {
26
+ "AssociationId": "eipassoc-2bebb745"
27
+ }
28
+
29
+ **Example 3: To associate an Elastic IP address with a private IP address**
30
+
31
+ The following ``associate-address`` example associates the specified Elastic IP address with the specified private IP address in the specified network interface. ::
32
+
33
+ aws ec2 associate-address \
34
+ --allocation-id eipalloc-64d5890a \
35
+ --network-interface-id eni-1a2b3c4d \
36
+ --private-ip-address 10.0.0.85
37
+
38
+ Output::
39
+
40
+ {
41
+ "AssociationId": "eipassoc-2bebb745"
42
+ }
43
+
44
+ For more information, see `Elastic IP addresses <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html>`__ in the *Amazon EC2 User Guide*.
@@ -1,23 +1,56 @@
1
- **To add a rule that allows outbound traffic to a specific address range**
2
-
3
- This example command adds a rule that grants access to the specified address ranges on TCP port 80.
4
-
5
- Command (Linux)::
6
-
7
- aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions IpProtocol=tcp,FromPort=80,ToPort=80,IpRanges='[{CidrIp=10.0.0.0/16}]'
8
-
9
- Command (Windows)::
10
-
11
- aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions IpProtocol=tcp,FromPort=80,ToPort=80,IpRanges=[{CidrIp=10.0.0.0/16}]
12
-
13
- **To add a rule that allows outbound traffic to a specific security group**
14
-
15
- This example command adds a rule that grants access to the specified security group on TCP port 80.
16
-
17
- Command (Linux)::
18
-
19
- aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions IpProtocol=tcp,FromPort=80,ToPort=80,UserIdGroupPairs='[{GroupId=sg-4b51a32f}]'
20
-
21
- Command (Windows)::
22
-
23
- aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions IpProtocol=tcp,FromPort=80,ToPort=80,UserIdGroupPairs=[{GroupId=sg-4b51a32f}]
1
+ **Example 1: To add a rule that allows outbound traffic to a specific address range**
2
+
3
+ The following ``authorize-security-group-egress`` example adds a rule that grants access to the specified address ranges on TCP port 80. ::
4
+
5
+ aws ec2 authorize-security-group-egress \
6
+ --group-id sg-1234567890abcdef0 \
7
+ --ip-permissions 'IpProtocol=tcp,FromPort=80,ToPort=80,IpRanges=[{CidrIp=10.0.0.0/16}]'
8
+
9
+ Output::
10
+
11
+ {
12
+ "Return": true,
13
+ "SecurityGroupRules": [
14
+ {
15
+ "SecurityGroupRuleId": "sgr-0b15794cdb17bf29c",
16
+ "GroupId": "sg-1234567890abcdef0",
17
+ "GroupOwnerId": "123456789012",
18
+ "IsEgress": true,
19
+ "IpProtocol": "tcp",
20
+ "FromPort": 80,
21
+ "ToPort": 80,
22
+ "CidrIpv4": "10.0.0.0/16"
23
+ }
24
+ ]
25
+ }
26
+
27
+ **Example 2: To add a rule that allows outbound traffic to a specific security group**
28
+
29
+ The following ``authorize-security-group-egress`` example adds a rule that grants access to the specified security group on TCP port 80. ::
30
+
31
+ aws ec2 authorize-security-group-egress \
32
+ --group-id sg-1234567890abcdef0 \
33
+ --ip-permissions 'IpProtocol=tcp,FromPort=80,ToPort=80,UserIdGroupPairs=[{GroupId=sg-0aad1c26bbeec5c22}]'
34
+
35
+ Output::
36
+
37
+ {
38
+ "Return": true,
39
+ "SecurityGroupRules": [
40
+ {
41
+ "SecurityGroupRuleId": "sgr-0b5dd815afcea9cc3",
42
+ "GroupId": "sg-1234567890abcdef0",
43
+ "GroupOwnerId": "123456789012",
44
+ "IsEgress": true,
45
+ "IpProtocol": "tcp",
46
+ "FromPort": 80,
47
+ "ToPort": 80,
48
+ "ReferencedGroupInfo": {
49
+ "GroupId": "sg-0aad1c26bbeec5c22",
50
+ "UserId": "123456789012"
51
+ }
52
+ }
53
+ ]
54
+ }
55
+
56
+ For more information, see `Security groups <https://docs.aws.amazon.com/vpc/latest/userguide/vpc-security-groups.html>`__ in the *Amazon VPC User Guide*.
@@ -59,11 +59,11 @@ Output::
59
59
 
60
60
  **Example 3: To add multiple rules in the same call**
61
61
 
62
- The following ``authorize-security-group-ingress`` example uses the ``ip-permissions`` parameter to add two inbound rules, one that enables inbound access on TCP port 3389 (RDP) and the other that enables ping/ICMP.
62
+ The following ``authorize-security-group-ingress`` example uses the ``ip-permissions`` parameter to add two inbound rules, one that enables inbound access on TCP port 3389 (RDP) and the other that enables ping/ICMP. ::
63
63
 
64
64
  aws ec2 authorize-security-group-ingress \
65
65
  --group-id sg-1234567890abcdef0 \
66
- --ip-permissions IpProtocol=tcp,FromPort=3389,ToPort=3389,IpRanges="[{CidrIp=172.31.0.0/16}]" IpProtocol=icmp,FromPort=-1,ToPort=-1,IpRanges="[{CidrIp=172.31.0.0/16}]"
66
+ --ip-permissions 'IpProtocol=tcp,FromPort=3389,ToPort=3389,IpRanges=[{CidrIp=172.31.0.0/16}]" "IpProtocol=icmp,FromPort=-1,ToPort=-1,IpRanges=[{CidrIp=172.31.0.0/16}]'
67
67
 
68
68
  Output::
69
69
 
@@ -92,14 +92,14 @@ Output::
92
92
  }
93
93
  ]
94
94
  }
95
-
95
+
96
96
  **Example 4: To add a rule for ICMP traffic**
97
97
 
98
- The following ``authorize-security-group-ingress`` example uses the ``ip-permissions`` parameter to add an inbound rule that allows the ICMP message ``Destination Unreachable: Fragmentation Needed and Don't Fragment was Set`` (Type 3, Code 4) from anywhere.
98
+ The following ``authorize-security-group-ingress`` example uses the ``ip-permissions`` parameter to add an inbound rule that allows the ICMP message ``Destination Unreachable: Fragmentation Needed and Don't Fragment was Set`` (Type 3, Code 4) from anywhere. ::
99
99
 
100
100
  aws ec2 authorize-security-group-ingress \
101
101
  --group-id sg-1234567890abcdef0 \
102
- --ip-permissions IpProtocol=icmp,FromPort=3,ToPort=4,IpRanges="[{CidrIp=0.0.0.0/0}]"
102
+ --ip-permissions 'IpProtocol=icmp,FromPort=3,ToPort=4,IpRanges=[{CidrIp=0.0.0.0/0}]'
103
103
 
104
104
  Output::
105
105
 
@@ -121,11 +121,11 @@ Output::
121
121
 
122
122
  **Example 5: To add a rule for IPv6 traffic**
123
123
 
124
- The following ``authorize-security-group-ingress`` example uses the ``ip-permissions`` parameter to add an inbound rule that allows SSH access (port 22) from the IPv6 range ``2001:db8:1234:1a00::/64``.
124
+ The following ``authorize-security-group-ingress`` example uses the ``ip-permissions`` parameter to add an inbound rule that allows SSH access (port 22) from the IPv6 range ``2001:db8:1234:1a00::/64``. ::
125
125
 
126
126
  aws ec2 authorize-security-group-ingress \
127
127
  --group-id sg-1234567890abcdef0 \
128
- --ip-permissions IpProtocol=tcp,FromPort=22,ToPort=22,Ipv6Ranges="[{CidrIpv6=2001:db8:1234:1a00::/64}]"
128
+ --ip-permissions 'IpProtocol=tcp,FromPort=22,ToPort=22,Ipv6Ranges=[{CidrIpv6=2001:db8:1234:1a00::/64}]'
129
129
 
130
130
  Output::
131
131
 
@@ -147,12 +147,12 @@ Output::
147
147
 
148
148
  **Example 6: To add a rule for ICMPv6 traffic**
149
149
 
150
- The following ``authorize-security-group-ingress`` example uses the ``ip-permissions`` parameter to add an inbound rule that allows ICMPv6 traffic from anywhere.
150
+ The following ``authorize-security-group-ingress`` example uses the ``ip-permissions`` parameter to add an inbound rule that allows ICMPv6 traffic from anywhere. ::
151
151
 
152
152
  aws ec2 authorize-security-group-ingress \
153
153
  --group-id sg-1234567890abcdef0 \
154
- --ip-permissions IpProtocol=icmpv6,Ipv6Ranges="[{CidrIpv6=::/0}]"
155
-
154
+ --ip-permissions 'IpProtocol=icmpv6,Ipv6Ranges=[{CidrIpv6=::/0}]'
155
+
156
156
  Output::
157
157
 
158
158
  {
@@ -173,11 +173,11 @@ Output::
173
173
 
174
174
  **Example 7: Add a rule with a description**
175
175
 
176
- The following ``authorize-security-group-ingress`` example uses the ``ip-permissions`` parameter to add an inbound rule that allows RDP traffic from the specified IPv4 address range. The rule includes a description to help you identify it later.
176
+ The following ``authorize-security-group-ingress`` example uses the ``ip-permissions`` parameter to add an inbound rule that allows RDP traffic from the specified IPv4 address range. The rule includes a description to help you identify it later. ::
177
177
 
178
178
  aws ec2 authorize-security-group-ingress \
179
179
  --group-id sg-1234567890abcdef0 \
180
- --ip-permissions IpProtocol=tcp,FromPort=3389,ToPort=3389,IpRanges="[{CidrIp=203.0.113.0/24,Description='RDP access from NY office'}]"
180
+ --ip-permissions 'IpProtocol=tcp,FromPort=3389,ToPort=3389,IpRanges=[{CidrIp=203.0.113.0/24,Description='RDP access from NY office'}]'
181
181
 
182
182
  Output::
183
183
 
@@ -200,11 +200,11 @@ Output::
200
200
 
201
201
  **Example 8: To add an inbound rule that uses a prefix list**
202
202
 
203
- The following ``authorize-security-group-ingress`` example uses the ``ip-permissions`` parameter to add an inbound rule that allows all traffic for the CIDR ranges in the specified prefix list.
203
+ The following ``authorize-security-group-ingress`` example uses the ``ip-permissions`` parameter to add an inbound rule that allows all traffic for the CIDR ranges in the specified prefix list. ::
204
204
 
205
205
  aws ec2 authorize-security-group-ingress \
206
206
  --group-id sg-04a351bfe432d4e71 \
207
- --ip-permissions IpProtocol=all,PrefixListIds="[{PrefixListId=pl-002dc3ec097de1514}]"
207
+ --ip-permissions 'IpProtocol=all,PrefixListIds=[{PrefixListId=pl-002dc3ec097de1514}]'
208
208
 
209
209
  Output::
210
210
 
@@ -224,4 +224,4 @@ Output::
224
224
  ]
225
225
  }
226
226
 
227
- For more information, see `Security groups <https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html>`__ in the *Amazon VPC User Guide*.
227
+ For more information, see `Security groups <https://docs.aws.amazon.com/vpc/latest/userguide/vpc-security-groups.html>`__ in the *Amazon VPC User Guide*.
@@ -1,14 +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 `Canceling a Capacity Reservation <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-using.html#capacity-reservations-release>`__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*.
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*.