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
@@ -1,25 +1,25 @@
1
- **To list your speech synthesis tasks**
2
-
3
- The following ``list-speech-synthesis-tasks`` example lists your speech synthesis tasks. ::
4
-
5
- aws polly list-speech-synthesis-tasks
6
-
7
- Output::
8
-
9
- {
10
- "SynthesisTasks": [
11
- {
12
- "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9",
13
- "TaskStatus": "completed",
14
- "OutputUri": "https://s3.us-west-2.amazonaws.com/my-s3-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3",
15
- "CreationTime": 1603911042.689,
16
- "RequestCharacters": 1311,
17
- "OutputFormat": "mp3",
18
- "TextType": "text",
19
- "VoiceId": "Joanna"
20
- }
21
- ]
22
- }
23
-
24
- For more information, see `Creating long audio files <https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html>`__ in the *Amazon Polly Developer Guide*.
25
-
1
+ **To list your speech synthesis tasks**
2
+
3
+ The following ``list-speech-synthesis-tasks`` example lists your speech synthesis tasks. ::
4
+
5
+ aws polly list-speech-synthesis-tasks
6
+
7
+ Output::
8
+
9
+ {
10
+ "SynthesisTasks": [
11
+ {
12
+ "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9",
13
+ "TaskStatus": "completed",
14
+ "OutputUri": "https://s3.us-west-2.amazonaws.com/amzn-s3-demo-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3",
15
+ "CreationTime": 1603911042.689,
16
+ "RequestCharacters": 1311,
17
+ "OutputFormat": "mp3",
18
+ "TextType": "text",
19
+ "VoiceId": "Joanna"
20
+ }
21
+ ]
22
+ }
23
+
24
+ For more information, see `Creating long audio files <https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html>`__ in the *Amazon Polly Developer Guide*.
25
+
@@ -1,27 +1,27 @@
1
- **To synthesize text**
2
-
3
- The following ``start-speech-synthesis-task`` example synthesizes the text in ``text_file.txt`` and stores the resulting MP3 file in the specified bucket. ::
4
-
5
- aws polly start-speech-synthesis-task \
6
- --output-format mp3 \
7
- --output-s3-bucket-name my-s3-bucket \
8
- --text file://text_file.txt \
9
- --voice-id Joanna
10
-
11
- Output::
12
-
13
- {
14
- "SynthesisTask": {
15
- "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9",
16
- "TaskStatus": "scheduled",
17
- "OutputUri": "https://s3.us-east-2.amazonaws.com/my-s3-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3",
18
- "CreationTime": 1603911042.689,
19
- "RequestCharacters": 1311,
20
- "OutputFormat": "mp3",
21
- "TextType": "text",
22
- "VoiceId": "Joanna"
23
- }
24
- }
25
-
26
- For more information, see `Creating long audio files <https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html>`__ in the *Amazon Polly Developer Guide*.
27
-
1
+ **To synthesize text**
2
+
3
+ The following ``start-speech-synthesis-task`` example synthesizes the text in ``text_file.txt`` and stores the resulting MP3 file in the specified bucket. ::
4
+
5
+ aws polly start-speech-synthesis-task \
6
+ --output-format mp3 \
7
+ --output-s3-bucket-name amzn-s3-demo-bucket \
8
+ --text file://text_file.txt \
9
+ --voice-id Joanna
10
+
11
+ Output::
12
+
13
+ {
14
+ "SynthesisTask": {
15
+ "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9",
16
+ "TaskStatus": "scheduled",
17
+ "OutputUri": "https://s3.us-east-2.amazonaws.com/amzn-s3-demo-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3",
18
+ "CreationTime": 1603911042.689,
19
+ "RequestCharacters": 1311,
20
+ "OutputFormat": "mp3",
21
+ "TextType": "text",
22
+ "VoiceId": "Joanna"
23
+ }
24
+ }
25
+
26
+ For more information, see `Creating long audio files <https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html>`__ in the *Amazon Polly Developer Guide*.
27
+
@@ -11,7 +11,7 @@ Output::
11
11
  {
12
12
  "ExportDescription": {
13
13
  "S3ExportConfiguration": {
14
- "Bucket": "awsExampleBucket",
14
+ "Bucket": "amzn-s3-demo-bucket",
15
15
  "Prefix": "ledgerexport1/",
16
16
  "EncryptionConfiguration": {
17
17
  "ObjectEncryptionType": "SSE_S3"
@@ -12,7 +12,7 @@ The following ``export-journal-to-s3`` example creates an export job for journal
12
12
  Contents of ``my-s3-export-config.json``::
13
13
 
14
14
  {
15
- "Bucket": "awsExampleBucket",
15
+ "Bucket": "amzn-s3-demo-bucket",
16
16
  "Prefix": "ledgerexport1/",
17
17
  "EncryptionConfiguration": {
18
18
  "ObjectEncryptionType": "SSE_S3"
@@ -14,7 +14,7 @@ Output::
14
14
  "ExclusiveEndTime": 1568847599.0,
15
15
  "ExportCreationTime": 1568847801.418,
16
16
  "S3ExportConfiguration": {
17
- "Bucket": "awsExampleBucket",
17
+ "Bucket": "amzn-s3-demo-bucket",
18
18
  "Prefix": "ledgerexport1/",
19
19
  "EncryptionConfiguration": {
20
20
  "ObjectEncryptionType": "SSE_S3"
@@ -15,7 +15,7 @@ Output::
15
15
  "EncryptionConfiguration": {
16
16
  "ObjectEncryptionType": "SSE_S3"
17
17
  },
18
- "Bucket": "awsExampleBucket",
18
+ "Bucket": "amzn-s3-demo-bucket",
19
19
  "Prefix": "ledgerexport1/"
20
20
  },
21
21
  "RoleArn": "arn:aws:iam::123456789012:role/my-s3-export-role",
@@ -31,7 +31,7 @@ Output::
31
31
  "EncryptionConfiguration": {
32
32
  "ObjectEncryptionType": "SSE_S3"
33
33
  },
34
- "Bucket": "awsExampleBucket",
34
+ "Bucket": "amzn-s3-demo-bucket",
35
35
  "Prefix": "ledgerexport1/"
36
36
  },
37
37
  "RoleArn": "arn:aws:iam::123456789012:role/my-s3-export-role",
@@ -1,4 +1,4 @@
1
- **To download a DB log file**
1
+ **Example 1: To download the latest part of a DB log file**
2
2
 
3
3
  The following ``download-db-log-file-portion`` example downloads only the latest part of your log file, saving it to a local file named ``tail.txt``. ::
4
4
 
@@ -7,7 +7,11 @@ The following ``download-db-log-file-portion`` example downloads only the latest
7
7
  --log-file-name log.txt \
8
8
  --output text > tail.txt
9
9
 
10
- To download the entire file, you need to include the ``--starting-token 0`` parameter. The following example saves the output to a local file named ``full.txt``. ::
10
+ The saved file might contain blank lines. They appear at the end of each part of the log file while being downloaded.
11
+
12
+ **Example 2: To download an entire DB log file**
13
+
14
+ The following ``download-db-log-file-portion`` example downloads the entire log file, using the ``--starting-token 0`` parameter, and saves the output to a local file named ``full.txt``. ::
11
15
 
12
16
  aws rds download-db-log-file-portion \
13
17
  --db-instance-identifier test-instance \
@@ -15,4 +19,4 @@ To download the entire file, you need to include the ``--starting-token 0`` para
15
19
  --starting-token 0 \
16
20
  --output text > full.txt
17
21
 
18
- The saved file might contain blank lines. They appear at the end of each part of the log file while being downloaded. This generally doesn't cause any trouble in your log file analysis.
22
+ The saved file might contain blank lines. They appear at the end of each part of the log file while being downloaded.
@@ -3,7 +3,7 @@
3
3
  The following ``untag-resources`` example removes the specified tag keys and any associated values from the specified resource. ::
4
4
 
5
5
  aws resourcegroupstaggingapi untag-resources \
6
- --resource-arn-list arn:aws:s3:::awsexamplebucket \
6
+ --resource-arn-list arn:aws:s3:::amzn-s3-demo-bucket \
7
7
  --tag-keys Environment CostCenter
8
8
 
9
9
  Output::
awscli/examples/s3/cp.rst CHANGED
@@ -45,11 +45,11 @@ Output::
45
45
 
46
46
  The following ``cp`` command copies a single object to a specified bucket while retaining its original name::
47
47
 
48
- aws s3 cp s3://mybucket/test.txt s3://mybucket2/
48
+ aws s3 cp s3://mybucket/test.txt s3://amzn-s3-demo-bucket2/
49
49
 
50
50
  Output::
51
51
 
52
- copy: s3://mybucket/test.txt to s3://mybucket2/test.txt
52
+ copy: s3://mybucket/test.txt to s3://amzn-s3-demo-bucket2/test.txt
53
53
 
54
54
  **Example 6: Recursively copying S3 objects to a local directory**
55
55
 
@@ -85,25 +85,25 @@ When passed with the parameter ``--recursive``, the following ``cp`` command rec
85
85
  specified bucket to another bucket while excluding some objects by using an ``--exclude`` parameter. In this example,
86
86
  the bucket ``mybucket`` has the objects ``test1.txt`` and ``another/test1.txt``::
87
87
 
88
- aws s3 cp s3://mybucket/ s3://mybucket2/ \
88
+ aws s3 cp s3://mybucket/ s3://amzn-s3-demo-bucket2/ \
89
89
  --recursive \
90
90
  --exclude "another/*"
91
91
 
92
92
  Output::
93
93
 
94
- copy: s3://mybucket/test1.txt to s3://mybucket2/test1.txt
94
+ copy: s3://mybucket/test1.txt to s3://amzn-s3-demo-bucket2/test1.txt
95
95
 
96
96
  You can combine ``--exclude`` and ``--include`` options to copy only objects that match a pattern, excluding all others::
97
97
 
98
- aws s3 cp s3://mybucket/logs/ s3://mybucket2/logs/ \
98
+ aws s3 cp s3://mybucket/logs/ s3://amzn-s3-demo-bucket2/logs/ \
99
99
  --recursive \
100
100
  --exclude "*" \
101
101
  --include "*.log"
102
102
 
103
103
  Output::
104
104
 
105
- copy: s3://mybucket/logs/test/test.log to s3://mybucket2/logs/test/test.log
106
- copy: s3://mybucket/logs/test3.log to s3://mybucket2/logs/test3.log
105
+ copy: s3://mybucket/logs/test/test.log to s3://amzn-s3-demo-bucket2/logs/test/test.log
106
+ copy: s3://mybucket/logs/test3.log to s3://amzn-s3-demo-bucket2/logs/test3.log
107
107
 
108
108
  **Example 9: Setting the Access Control List (ACL) while copying an S3 object**
109
109
 
awscli/examples/s3/ls.rst CHANGED
@@ -1,13 +1,13 @@
1
1
  **Example 1: Listing all user owned buckets**
2
2
 
3
- The following ``ls`` command lists all of the bucket owned by the user. In this example, the user owns the buckets ``mybucket`` and ``mybucket2``. The timestamp is the date the bucket was created, shown in your machine's time zone. This date can change when making changes to your bucket, such as editing its bucket policy. Note if ``s3://`` is used for the path argument ``<S3Uri>``, it will list all of the buckets as well. ::
3
+ The following ``ls`` command lists all of the bucket owned by the user. In this example, the user owns the buckets ``mybucket`` and ``amzn-s3-demo-bucket2``. The timestamp is the date the bucket was created, shown in your machine's time zone. This date can change when making changes to your bucket, such as editing its bucket policy. Note if ``s3://`` is used for the path argument ``<S3Uri>``, it will list all of the buckets as well. ::
4
4
 
5
5
  aws s3 ls
6
6
 
7
7
  Output::
8
8
 
9
9
  2013-07-11 17:08:50 mybucket
10
- 2013-07-24 14:55:44 mybucket2
10
+ 2013-07-24 14:55:44 amzn-s3-demo-bucket2
11
11
 
12
12
  **Example 2: Listing all prefixes and objects in a bucket**
13
13
 
awscli/examples/s3/mv.rst CHANGED
@@ -32,11 +32,11 @@ Output::
32
32
 
33
33
  The following ``mv`` command moves a single object to a specified bucket while retaining its original name::
34
34
 
35
- aws s3 mv s3://mybucket/test.txt s3://mybucket2/
35
+ aws s3 mv s3://mybucket/test.txt s3://amzn-s3-demo-bucket2/
36
36
 
37
37
  Output::
38
38
 
39
- move: s3://mybucket/test.txt to s3://mybucket2/test.txt
39
+ move: s3://mybucket/test.txt to s3://amzn-s3-demo-bucket2/test.txt
40
40
 
41
41
  **Example 5: Move all objects and prefixes in a bucket to the local directory**
42
42
 
@@ -64,7 +64,7 @@ this example, the directory ``myDir`` has the files ``test1.txt`` and ``test2.jp
64
64
 
65
65
  Output::
66
66
 
67
- move: myDir/test1.txt to s3://mybucket2/test1.txt
67
+ move: myDir/test1.txt to s3://amzn-s3-demo-bucket2/test1.txt
68
68
 
69
69
  **Example 7: Move all objects and prefixes in a bucket to the local directory, except specified prefix**
70
70
 
@@ -72,13 +72,13 @@ When passed with the parameter ``--recursive``, the following ``mv`` command rec
72
72
  specified bucket to another bucket while excluding some objects by using an ``--exclude`` parameter. In this example,
73
73
  the bucket ``mybucket`` has the objects ``test1.txt`` and ``another/test1.txt``. ::
74
74
 
75
- aws s3 mv s3://mybucket/ s3://mybucket2/ \
75
+ aws s3 mv s3://mybucket/ s3://amzn-s3-demo-bucket2/ \
76
76
  --recursive \
77
77
  --exclude "mybucket/another/*"
78
78
 
79
79
  Output::
80
80
 
81
- move: s3://mybucket/test1.txt to s3://mybucket2/test1.txt
81
+ move: s3://mybucket/test1.txt to s3://amzn-s3-demo-bucket2/test1.txt
82
82
 
83
83
  **Example 8: Move an object to the specified bucket and set the ACL**
84
84
 
@@ -21,15 +21,15 @@ prefix and bucket by copying S3 objects. An S3 object will require copying if th
21
21
  the last modified time of the source is newer than the last modified time of the destination, or the S3 object does not
22
22
  exist under the specified bucket and prefix destination.
23
23
 
24
- In this example, the user syncs the bucket ``mybucket`` to the bucket ``mybucket2``. The bucket ``mybucket`` contains the objects ``test.txt`` and ``test2.txt``. The bucket
25
- ``mybucket2`` contains no objects::
24
+ In this example, the user syncs the bucket ``mybucket`` to the bucket ``amzn-s3-demo-bucket2``. The bucket ``mybucket`` contains the objects ``test.txt`` and ``test2.txt``. The bucket
25
+ ``amzn-s3-demo-bucket2`` contains no objects::
26
26
 
27
- aws s3 sync s3://mybucket s3://mybucket2
27
+ aws s3 sync s3://mybucket s3://amzn-s3-demo-bucket2
28
28
 
29
29
  Output::
30
30
 
31
- copy: s3://mybucket/test.txt to s3://mybucket2/test.txt
32
- copy: s3://mybucket/test2.txt to s3://mybucket2/test2.txt
31
+ copy: s3://mybucket/test.txt to s3://amzn-s3-demo-bucket2/test.txt
32
+ copy: s3://mybucket/test2.txt to s3://amzn-s3-demo-bucket2/test2.txt
33
33
 
34
34
  **Example 3: Sync all S3 objects from the specified S3 bucket to the local directory**
35
35
 
@@ -1,7 +1,7 @@
1
1
  This example grants ``full control`` to two AWS users (*user1@example.com* and *user2@example.com*) and ``read``
2
2
  permission to everyone::
3
3
 
4
- aws s3api put-bucket-acl --bucket MyBucket --grant-full-control emailaddress=user1@example.com,emailaddress=user2@example.com --grant-read uri=http://acs.amazonaws.com/groups/global/AllUsers
4
+ aws s3api put-bucket-acl --bucket amzn-s3-demo-bucket --grant-full-control emailaddress=user1@example.com,emailaddress=user2@example.com --grant-read uri=http://acs.amazonaws.com/groups/global/AllUsers
5
5
 
6
6
  See http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTacl.html for details on custom ACLs (the s3api ACL
7
7
  commands, such as ``put-bucket-acl``, use the same shorthand argument notation).
@@ -1,7 +1,7 @@
1
1
  The following example enables ``PUT``, ``POST``, and ``DELETE`` requests from *www.example.com*, and enables ``GET``
2
2
  requests from any domain::
3
3
 
4
- aws s3api put-bucket-cors --bucket MyBucket --cors-configuration file://cors.json
4
+ aws s3api put-bucket-cors --bucket amzn-s3-demo-bucket --cors-configuration file://cors.json
5
5
 
6
6
  cors.json:
7
7
  {
@@ -1,9 +1,9 @@
1
1
  **Example 1: To set bucket policy logging**
2
2
 
3
- The following ``put-bucket-logging`` example sets the logging policy for *MyBucket*. First, grant the logging service principal permission in your bucket policy using the ``put-bucket-policy`` command. ::
3
+ The following ``put-bucket-logging`` example sets the logging policy for *amzn-s3-demo-bucket*. First, grant the logging service principal permission in your bucket policy using the ``put-bucket-policy`` command. ::
4
4
 
5
5
  aws s3api put-bucket-policy \
6
- --bucket MyBucket \
6
+ --bucket amzn-s3-demo-bucket \
7
7
  --policy file://policy.json
8
8
 
9
9
  Contents of ``policy.json``::
@@ -16,7 +16,7 @@ Contents of ``policy.json``::
16
16
  "Effect": "Allow",
17
17
  "Principal": {"Service": "logging.s3.amazonaws.com"},
18
18
  "Action": "s3:PutObject",
19
- "Resource": "arn:aws:s3:::MyBucket/Logs/*",
19
+ "Resource": "arn:aws:s3:::amzn-s3-demo-bucket/Logs/*",
20
20
  "Condition": {
21
21
  "ArnLike": {"aws:SourceARN": "arn:aws:s3:::SOURCE-BUCKET-NAME"},
22
22
  "StringEquals": {"aws:SourceAccount": "SOURCE-AWS-ACCOUNT-ID"}
@@ -28,14 +28,14 @@ Contents of ``policy.json``::
28
28
  To apply the logging policy, use ``put-bucket-logging``. ::
29
29
 
30
30
  aws s3api put-bucket-logging \
31
- --bucket MyBucket \
31
+ --bucket amzn-s3-demo-bucket \
32
32
  --bucket-logging-status file://logging.json
33
33
 
34
34
  Contents of ``logging.json``::
35
35
 
36
36
  {
37
37
  "LoggingEnabled": {
38
- "TargetBucket": "MyBucket",
38
+ "TargetBucket": "amzn-s3-demo-bucket",
39
39
  "TargetPrefix": "Logs/"
40
40
  }
41
41
  }
@@ -46,26 +46,26 @@ For more information, see `Amazon S3 Server Access Logging <https://docs.aws.ama
46
46
 
47
47
  **Example 2: To set a bucket policy for logging access to only a single user**
48
48
 
49
- The following ``put-bucket-logging`` example sets the logging policy for *MyBucket*. The AWS user *bob@example.com* will have full control over
49
+ The following ``put-bucket-logging`` example sets the logging policy for *amzn-s3-demo-bucket*. The AWS user *bob@example.com* will have full control over
50
50
  the log files, and no one else has any access. First, grant S3 permission with ``put-bucket-acl``. ::
51
51
 
52
52
  aws s3api put-bucket-acl \
53
- --bucket MyBucket \
53
+ --bucket amzn-s3-demo-bucket \
54
54
  --grant-write URI=http://acs.amazonaws.com/groups/s3/LogDelivery \
55
55
  --grant-read-acp URI=http://acs.amazonaws.com/groups/s3/LogDelivery
56
56
 
57
57
  Then apply the logging policy using ``put-bucket-logging``. ::
58
58
 
59
59
  aws s3api put-bucket-logging \
60
- --bucket MyBucket \
60
+ --bucket amzn-s3-demo-bucket \
61
61
  --bucket-logging-status file://logging.json
62
62
 
63
63
  Contents of ``logging.json``::
64
64
 
65
65
  {
66
66
  "LoggingEnabled": {
67
- "TargetBucket": "MyBucket",
68
- "TargetPrefix": "MyBucketLogs/",
67
+ "TargetBucket": "amzn-s3-demo-bucket",
68
+ "TargetPrefix": "amzn-s3-demo-bucket-logs/",
69
69
  "TargetGrants": [
70
70
  {
71
71
  "Grantee": {
@@ -1,7 +1,7 @@
1
- This example allows all users to retrieve any object in *MyBucket* except those in the *MySecretFolder*. It also
1
+ This example allows all users to retrieve any object in *amzn-s3-demo-bucket* except those in the *MySecretFolder*. It also
2
2
  grants ``put`` and ``delete`` permission to the root user of the AWS account ``1234-5678-9012``::
3
3
 
4
- aws s3api put-bucket-policy --bucket MyBucket --policy file://policy.json
4
+ aws s3api put-bucket-policy --bucket amzn-s3-demo-bucket --policy file://policy.json
5
5
 
6
6
  policy.json:
7
7
  {
@@ -10,13 +10,13 @@ grants ``put`` and ``delete`` permission to the root user of the AWS account ``1
10
10
  "Effect": "Allow",
11
11
  "Principal": "*",
12
12
  "Action": "s3:GetObject",
13
- "Resource": "arn:aws:s3:::MyBucket/*"
13
+ "Resource": "arn:aws:s3:::amzn-s3-demo-bucket/*"
14
14
  },
15
15
  {
16
16
  "Effect": "Deny",
17
17
  "Principal": "*",
18
18
  "Action": "s3:GetObject",
19
- "Resource": "arn:aws:s3:::MyBucket/MySecretFolder/*"
19
+ "Resource": "arn:aws:s3:::amzn-s3-demo-bucket/MySecretFolder/*"
20
20
  },
21
21
  {
22
22
  "Effect": "Allow",
@@ -27,7 +27,7 @@ grants ``put`` and ``delete`` permission to the root user of the AWS account ``1
27
27
  "s3:DeleteObject",
28
28
  "s3:PutObject"
29
29
  ],
30
- "Resource": "arn:aws:s3:::MyBucket/*"
30
+ "Resource": "arn:aws:s3:::amzn-s3-demo-bucket/*"
31
31
  }
32
32
  ]
33
33
  }
@@ -1,7 +1,7 @@
1
1
  The following command grants ``full control`` to two AWS users (*user1@example.com* and *user2@example.com*) and ``read``
2
2
  permission to everyone::
3
3
 
4
- aws s3api put-object-acl --bucket MyBucket --key file.txt --grant-full-control emailaddress=user1@example.com,emailaddress=user2@example.com --grant-read uri=http://acs.amazonaws.com/groups/global/AllUsers
4
+ aws s3api put-object-acl --bucket amzn-s3-demo-bucket --key file.txt --grant-full-control emailaddress=user1@example.com,emailaddress=user2@example.com --grant-read uri=http://acs.amazonaws.com/groups/global/AllUsers
5
5
 
6
6
  See http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTacl.html for details on custom ACLs (the s3api ACL
7
7
  commands, such as ``put-object-acl``, use the same shorthand argument notation).
@@ -0,0 +1,83 @@
1
+ **Example 1: To create a subscriber with data access**
2
+
3
+ The following ``create-subscriber`` example creates a subscriber in Security Lake with access to data in the current AWS Region for the specified subscriber identity for an AWS source. ::
4
+
5
+ aws securitylake create-subscriber \
6
+ --access-types "S3" \
7
+ --sources '[{"awsLogSource": {"sourceName": "VPC_FLOW","sourceVersion": "2.0"}}]' \
8
+ --subscriber-name 'opensearch-s3' \
9
+ --subscriber-identity '{"principal": "029189416600","externalId": "123456789012"}'
10
+
11
+ Output::
12
+
13
+ {
14
+ "subscriber": {
15
+ "accessTypes": [
16
+ "S3"
17
+ ],
18
+ "createdAt": "2024-07-17T19:08:26.787000+00:00",
19
+ "roleArn": "arn:aws:iam::773172568199:role/AmazonSecurityLake-896f218b-cfba-40be-a255-8b49a65d0407",
20
+ "s3BucketArn": "arn:aws:s3:::aws-security-data-lake-us-east-1-um632ufwpvxkyz0bc5hkb64atycnf3",
21
+ "sources": [
22
+ {
23
+ "awsLogSource": {
24
+ "sourceName": "VPC_FLOW",
25
+ "sourceVersion": "2.0"
26
+ }
27
+ }
28
+ ],
29
+ "subscriberArn": "arn:aws:securitylake:us-east-1:773172568199:subscriber/896f218b-cfba-40be-a255-8b49a65d0407",
30
+ "subscriberId": "896f218b-cfba-40be-a255-8b49a65d0407",
31
+ "subscriberIdentity": {
32
+ "externalId": "123456789012",
33
+ "principal": "029189416600"
34
+ },
35
+ "subscriberName": "opensearch-s3",
36
+ "subscriberStatus": "ACTIVE",
37
+ "updatedAt": "2024-07-17T19:08:27.133000+00:00"
38
+ }
39
+ }
40
+
41
+ For more information, see `Creating a subscriber with data access <https://docs.aws.amazon.com/security-lake/latest/userguide/subscriber-data-access.html#create-subscriber-data-access>`__ in the *Amazon Security Lake User Guide*.
42
+
43
+ **Example 2: To create a subscriber with query access**
44
+
45
+ The following ``create-subscriber`` example creates a subscriber in Security Lake with query access in the current AWS Region for the specified subscriber identity. ::
46
+
47
+ aws securitylake create-subscriber \
48
+ --access-types "LAKEFORMATION" \
49
+ --sources '[{"awsLogSource": {"sourceName": "VPC_FLOW","sourceVersion": "2.0"}}]' \
50
+ --subscriber-name 'opensearch-s3' \
51
+ --subscriber-identity '{"principal": "029189416600","externalId": "123456789012"}'
52
+
53
+ Output::
54
+
55
+ {
56
+ "subscriber": {
57
+ "accessTypes": [
58
+ "LAKEFORMATION"
59
+ ],
60
+ "createdAt": "2024-07-18T01:05:55.853000+00:00",
61
+ "resourceShareArn": "arn:aws:ram:us-east-1:123456789012:resource-share/8c31da49-c224-4f1e-bb12-37ab756d6d8a",
62
+ "resourceShareName": "LakeFormation-V2-NAMENAMENA-123456789012",
63
+ "sources": [
64
+ {
65
+ "awsLogSource": {
66
+ "sourceName": "VPC_FLOW",
67
+ "sourceVersion": "2.0"
68
+ }
69
+ }
70
+ ],
71
+ "subscriberArn": "arn:aws:securitylake:us-east-1:123456789012:subscriber/e762aabb-ce3d-4585-beab-63474597845d",
72
+ "subscriberId": "e762aabb-ce3d-4585-beab-63474597845d",
73
+ "subscriberIdentity": {
74
+ "externalId": "123456789012",
75
+ "principal": "029189416600"
76
+ },
77
+ "subscriberName": "opensearch-s3",
78
+ "subscriberStatus": "ACTIVE",
79
+ "updatedAt": "2024-07-18T01:05:58.393000+00:00"
80
+ }
81
+ }
82
+
83
+ For more information, see `Creating a subscriber with query access <https://docs.aws.amazon.com/security-lake/latest/userguide/subscriber-query-access.html#create-query-subscriber-procedures>`__ in the *Amazon Security Lake User Guide*.
@@ -0,0 +1,11 @@
1
+ **To associate a canary with a group**
2
+
3
+ The following ``associate-resource`` example associates a canary with a group named ``demo_group``. ::
4
+
5
+ aws synthetics associate-resource \
6
+ --group-identifier demo_group \
7
+ --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary
8
+
9
+ This command produces no output.
10
+
11
+ For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.
@@ -0,0 +1,48 @@
1
+ **To create a canary**
2
+
3
+ The following ``create-canary`` example creates a canary named ``demo_canary``. ::
4
+
5
+ aws synthetics create-canary \
6
+ --name demo_canary \
7
+ --code '{"S3Bucket": "artifacts3bucket", "S3Key":"demo_canary.zip", "Handler": "index.lambda_handler"}' \
8
+ --artifact-s3-location s3://amzn-s3-demo-bucket/demo_canary.zip \
9
+ --execution-role-arn arn:aws:iam::123456789012:role/demo_canary_role \
10
+ --schedule Expression="rate(10 minutes)" \
11
+ --runtime-version syn-nodejs-puppeteer-9.1
12
+
13
+ Output::
14
+
15
+ {
16
+ "Canary": {
17
+ "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
18
+ "Name": "demo_canary",
19
+ "Code": {
20
+ "Handler": "index.lambda_handler"
21
+ },
22
+ "ExecutionRoleArn": "arn:aws:iam::123456789012:role/demo_canary_role",
23
+ "Schedule": {
24
+ "Expression": "rate(10 minutes)",
25
+ "DurationInSeconds": 0
26
+ },
27
+ "RunConfig": {
28
+ "TimeoutInSeconds": 600,
29
+ "MemoryInMB": 1000,
30
+ "ActiveTracing": false
31
+ },
32
+ "SuccessRetentionPeriodInDays": 31,
33
+ "FailureRetentionPeriodInDays": 31,
34
+ "Status": {
35
+ "State": "CREATING",
36
+ "StateReasonCode": "CREATE_PENDING"
37
+ },
38
+ "Timeline": {
39
+ "Created": "2024-10-15T19:03:08.826000+05:30",
40
+ "LastModified": "2024-10-15T19:03:08.826000+05:30"
41
+ },
42
+ "ArtifactS3Location": "amzn-s3-demo-bucket/demo_canary.zip",
43
+ "RuntimeVersion": "syn-nodejs-puppeteer-9.1",
44
+ "Tags": {}
45
+ }
46
+ }
47
+
48
+ For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.
@@ -0,0 +1,21 @@
1
+ **To create a group**
2
+
3
+ The following ``create-group`` example creates a group named ``demo_group``. ::
4
+
5
+ aws synthetics create-group \
6
+ --name demo_group
7
+
8
+ Output::
9
+
10
+ {
11
+ "Group": {
12
+ "Id": "example123",
13
+ "Name": "demo_group",
14
+ "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123",
15
+ "Tags": {},
16
+ "CreatedTime": "2024-10-15T14:47:23.811000+05:30",
17
+ "LastModifiedTime": "2024-10-15T14:47:23.811000+05:30"
18
+ }
19
+ }
20
+
21
+ For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.
@@ -0,0 +1,10 @@
1
+ **To permanently delete a canary**
2
+
3
+ The following ``delete-canary`` example deletes a canary named ``demo_canary``. ::
4
+
5
+ aws synthetics delete-canary \
6
+ --name demo_canary
7
+
8
+ This command produces no output.
9
+
10
+ For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.
@@ -0,0 +1,10 @@
1
+ **To delete a group**
2
+
3
+ The following ``delete-group`` example deletes a group named ``demo_group``. ::
4
+
5
+ aws synthetics delete-group \
6
+ --group-identifier demo_group
7
+
8
+ This command produces no output.
9
+
10
+ For more information, see `Synthetic monitoring (canaries) <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html>`__ in the *Amazon CloudWatch User Guide*.