awscli 1.36.33__py3-none-any.whl → 1.36.35__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 (41) hide show
  1. awscli/__init__.py +1 -1
  2. awscli/customizations/s3/subcommands.py +37 -3
  3. {awscli-1.36.33.dist-info → awscli-1.36.35.dist-info}/METADATA +2 -2
  4. {awscli-1.36.33.dist-info → awscli-1.36.35.dist-info}/RECORD +12 -41
  5. awscli/examples/iot1click-devices/claim-devices-by-claim-code.rst +0 -15
  6. awscli/examples/iot1click-devices/describe-device.rst +0 -27
  7. awscli/examples/iot1click-devices/finalize-device-claim.rst +0 -14
  8. awscli/examples/iot1click-devices/get-device-methods.rst +0 -30
  9. awscli/examples/iot1click-devices/initiate-device-claim.rst +0 -14
  10. awscli/examples/iot1click-devices/invoke-device-method.rst +0 -24
  11. awscli/examples/iot1click-devices/list-device-events.rst +0 -32
  12. awscli/examples/iot1click-devices/list-devices.rst +0 -26
  13. awscli/examples/iot1click-devices/list-tags-for-resource.rst +0 -17
  14. awscli/examples/iot1click-devices/tag-resource.rst +0 -20
  15. awscli/examples/iot1click-devices/unclaim-device.rst +0 -14
  16. awscli/examples/iot1click-devices/untag-resource.rst +0 -12
  17. awscli/examples/iot1click-devices/update-device-state.rst +0 -11
  18. awscli/examples/iot1click-projects/associate-device-with-placement.rst +0 -13
  19. awscli/examples/iot1click-projects/create-placement.rst +0 -12
  20. awscli/examples/iot1click-projects/create-project.rst +0 -27
  21. awscli/examples/iot1click-projects/delete-placement.rst +0 -11
  22. awscli/examples/iot1click-projects/delete-project.rst +0 -10
  23. awscli/examples/iot1click-projects/describe-placement.rst +0 -24
  24. awscli/examples/iot1click-projects/describe-project.rst +0 -32
  25. awscli/examples/iot1click-projects/disassociate-device-from-placement.rst +0 -12
  26. awscli/examples/iot1click-projects/get-devices-in-placement.rst +0 -17
  27. awscli/examples/iot1click-projects/list-placements.rst +0 -21
  28. awscli/examples/iot1click-projects/list-projects.rst +0 -21
  29. awscli/examples/iot1click-projects/list-tags-for-resource.rst +0 -17
  30. awscli/examples/iot1click-projects/tag-resource.rst +0 -20
  31. awscli/examples/iot1click-projects/untag-resource.rst +0 -11
  32. awscli/examples/iot1click-projects/update-placement.rst +0 -21
  33. awscli/examples/iot1click-projects/update-project.rst +0 -11
  34. {awscli-1.36.33.data → awscli-1.36.35.data}/scripts/aws +0 -0
  35. {awscli-1.36.33.data → awscli-1.36.35.data}/scripts/aws.cmd +0 -0
  36. {awscli-1.36.33.data → awscli-1.36.35.data}/scripts/aws_bash_completer +0 -0
  37. {awscli-1.36.33.data → awscli-1.36.35.data}/scripts/aws_completer +0 -0
  38. {awscli-1.36.33.data → awscli-1.36.35.data}/scripts/aws_zsh_completer.sh +0 -0
  39. {awscli-1.36.33.dist-info → awscli-1.36.35.dist-info}/LICENSE.txt +0 -0
  40. {awscli-1.36.33.dist-info → awscli-1.36.35.dist-info}/WHEEL +0 -0
  41. {awscli-1.36.33.dist-info → awscli-1.36.35.dist-info}/top_level.txt +0 -0
awscli/__init__.py CHANGED
@@ -18,7 +18,7 @@ A Universal Command Line Environment for Amazon Web Services.
18
18
 
19
19
  import os
20
20
 
21
- __version__ = '1.36.33'
21
+ __version__ = '1.36.35'
22
22
 
23
23
  #
24
24
  # Get our data path to be added to botocore's search path
@@ -462,6 +462,26 @@ CHECKSUM_ALGORITHM = {
462
462
  'help_text': 'Indicates the algorithm used to create the checksum for the object.'
463
463
  }
464
464
 
465
+ BUCKET_NAME_PREFIX = {
466
+ 'name': 'bucket-name-prefix',
467
+ 'help_text': (
468
+ 'Limits the response to bucket names that begin with the specified '
469
+ 'bucket name prefix.'
470
+ )
471
+ }
472
+
473
+ BUCKET_REGION = {
474
+ 'name': 'bucket-region',
475
+ 'help_text': (
476
+ 'Limits the response to buckets that are located in the specified '
477
+ 'Amazon Web Services Region. The Amazon Web Services Region must be '
478
+ 'expressed according to the Amazon Web Services Region code, such as '
479
+ 'us-west-2 for the US West (Oregon) Region. For a list of the valid '
480
+ 'values for all of the Amazon Web Services Regions, see '
481
+ 'https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region'
482
+ )
483
+ }
484
+
465
485
  TRANSFER_ARGS = [DRYRUN, QUIET, INCLUDE, EXCLUDE, ACL,
466
486
  FOLLOW_SYMLINKS, NO_FOLLOW_SYMLINKS, NO_GUESS_MIME_TYPE,
467
487
  SSE, SSE_C, SSE_C_KEY, SSE_KMS_KEY_ID, SSE_C_COPY_SOURCE,
@@ -494,7 +514,8 @@ class ListCommand(S3Command):
494
514
  USAGE = "<S3Uri> or NONE"
495
515
  ARG_TABLE = [{'name': 'paths', 'nargs': '?', 'default': 's3://',
496
516
  'positional_arg': True, 'synopsis': USAGE}, RECURSIVE,
497
- PAGE_SIZE, HUMAN_READABLE, SUMMARIZE, REQUEST_PAYER]
517
+ PAGE_SIZE, HUMAN_READABLE, SUMMARIZE, REQUEST_PAYER,
518
+ BUCKET_NAME_PREFIX, BUCKET_REGION]
498
519
 
499
520
  def _run_main(self, parsed_args, parsed_globals):
500
521
  super(ListCommand, self)._run_main(parsed_args, parsed_globals)
@@ -508,7 +529,11 @@ class ListCommand(S3Command):
508
529
  path = path[5:]
509
530
  bucket, key = find_bucket_key(path)
510
531
  if not bucket:
511
- self._list_all_buckets(parsed_args.page_size)
532
+ self._list_all_buckets(
533
+ parsed_args.page_size,
534
+ parsed_args.bucket_name_prefix,
535
+ parsed_args.bucket_region,
536
+ )
512
537
  elif parsed_args.dir_op:
513
538
  # Then --recursive was specified.
514
539
  self._list_all_objects_recursive(
@@ -572,11 +597,20 @@ class ListCommand(S3Command):
572
597
  uni_print(print_str)
573
598
  self._at_first_page = False
574
599
 
575
- def _list_all_buckets(self, page_size=None):
600
+ def _list_all_buckets(
601
+ self,
602
+ page_size=None,
603
+ prefix=None,
604
+ bucket_region=None,
605
+ ):
576
606
  paginator = self.client.get_paginator('list_buckets')
577
607
  paging_args = {
578
608
  'PaginationConfig': {'PageSize': page_size}
579
609
  }
610
+ if prefix:
611
+ paging_args['Prefix'] = prefix
612
+ if bucket_region:
613
+ paging_args['BucketRegion'] = bucket_region
580
614
 
581
615
  iterator = paginator.paginate(**paging_args)
582
616
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: awscli
3
- Version: 1.36.33
3
+ Version: 1.36.35
4
4
  Summary: Universal Command Line Environment for AWS.
5
5
  Home-page: http://aws.amazon.com/cli/
6
6
  Author: Amazon Web Services
@@ -23,7 +23,7 @@ Classifier: Programming Language :: Python :: 3.11
23
23
  Classifier: Programming Language :: Python :: 3.12
24
24
  Requires-Python: >= 3.8
25
25
  License-File: LICENSE.txt
26
- Requires-Dist: botocore (==1.35.92)
26
+ Requires-Dist: botocore (==1.35.94)
27
27
  Requires-Dist: docutils (<0.17,>=0.10)
28
28
  Requires-Dist: s3transfer (<0.11.0,>=0.10.0)
29
29
  Requires-Dist: PyYAML (<6.1,>=3.10)
@@ -1,4 +1,4 @@
1
- awscli/__init__.py,sha256=Xg3HK4OT0AfcvthWVexRXIh-hjzFRuj2d5Q6xQatJqg,1534
1
+ awscli/__init__.py,sha256=amz3SrS3ItcL54kVP403d8dlg2hChQVrjrSpj0fXb0s,1534
2
2
  awscli/__main__.py,sha256=iBjOg0tBxNlhzTi_tyc1G0SMGBvHMVvBJzX3JqYaooY,662
3
3
  awscli/alias.py,sha256=Us9pvP8Zplbr1W4N3rE5gxicWLqlRG3l_9VPskxafgs,11313
4
4
  awscli/argparser.py,sha256=3Pxx-vWytdV985Y6MIl9DeutUXyehIvACIs_PDby8GI,7650
@@ -198,7 +198,7 @@ awscli/customizations/s3/filters.py,sha256=OuQUr6XAMkS1i6GO65_L7NbL7kwgmKT2ghWhv
198
198
  awscli/customizations/s3/results.py,sha256=L19gi3CtJYeHqWIWuIVcbj82Dshw2g5jNX8PFidcC2U,26625
199
199
  awscli/customizations/s3/s3.py,sha256=Igwsn89G7i9M4nShjzcFmwlCVXvpfgmoyEf9wpNLXdk,2739
200
200
  awscli/customizations/s3/s3handler.py,sha256=FSeCyMRi2EwNDNR329geVV8vZpap1OiSscNS-3sCCP0,23299
201
- awscli/customizations/s3/subcommands.py,sha256=oz_85AnDfeBlodJi077LZsJr564XC1crFSiBz37hVfM,62167
201
+ awscli/customizations/s3/subcommands.py,sha256=Mv8XKvnrAQXqASFoHO92ZIn-qSmV7gHF2DVxSBx8NIM,63294
202
202
  awscli/customizations/s3/transferconfig.py,sha256=7MW4hi90N5mLeQBlmVxs9J5ixRjejp1F4uPmGGF3TME,4472
203
203
  awscli/customizations/s3/utils.py,sha256=Wcnx32I2P5E7A2Qh0ONG6IXWvnmz3NxNBtGUrGI61VQ,34213
204
204
  awscli/customizations/s3/syncstrategy/__init__.py,sha256=BFJ0dbdWkUBgJ2qav1Jhz06SddTMIeahxSaW_H0vop0,565
@@ -3480,35 +3480,6 @@ awscli/examples/iot-jobs-data/describe-job-execution.rst,sha256=J-XJnsItY62Ublc5
3480
3480
  awscli/examples/iot-jobs-data/get-pending-job-executions.rst,sha256=M51Ehv4QBHANq_qdyovwQceoVzQrtSrn2AAD0GuEP1g,877
3481
3481
  awscli/examples/iot-jobs-data/start-next-pending-job-execution.rst,sha256=huAMWlFHSyEoj3QeL73t48iOkeSVLksYuCP7NiiHpUs,988
3482
3482
  awscli/examples/iot-jobs-data/update-job-execution.rst,sha256=f1_rOy6bItHJ1mfae3a4resdn5BOK-ULER0SPn6PoCg,646
3483
- awscli/examples/iot1click-devices/claim-devices-by-claim-code.rst,sha256=NdmL4tSHPutmQnnWRSImO07bmwVLrB_-Qe85GfN_6xU,574
3484
- awscli/examples/iot1click-devices/describe-device.rst,sha256=K3Jc61AjJFhTf0rdRR12_bBOVv4HZiFpRJrXqQ7g05Q,926
3485
- awscli/examples/iot1click-devices/finalize-device-claim.rst,sha256=S82om9aExZqB3lq4pQKGRRlJRQoiLHOTzI9kmuu3gXU,574
3486
- awscli/examples/iot1click-devices/get-device-methods.rst,sha256=ZCOiltxY2rQwlVhjWqDt2LfHKAn0vQTIKQopJK1j3N8,905
3487
- awscli/examples/iot1click-devices/initiate-device-claim.rst,sha256=nMOlYXTSq_ejUKamKVhCI3DYYrPsM8O4cpjCD_2howk,582
3488
- awscli/examples/iot1click-devices/invoke-device-method.rst,sha256=74abvH35XR2KrsxhPi4y24PE70ZdMnDMEEwSeOXtVkU,735
3489
- awscli/examples/iot1click-devices/list-device-events.rst,sha256=b6rKbmuMaeqNkNjDf_ma4x2PoK2am_JZGdx-teDIRJk,1496
3490
- awscli/examples/iot1click-devices/list-devices.rst,sha256=pp7jSO0hMPSX53OiLl7fxtYXiJB1r9r_HJVWa8DUxHU,817
3491
- awscli/examples/iot1click-devices/list-tags-for-resource.rst,sha256=d5Eg55goQgNsWN8to4sLKb2_yzPEJOnUuqBNTOC82mg,593
3492
- awscli/examples/iot1click-devices/tag-resource.rst,sha256=xNyeFwsWkeGeZGTlrqOT2Q9FJcLrfbY8ALZ2urWEG8c,709
3493
- awscli/examples/iot1click-devices/unclaim-device.rst,sha256=52O1RJP7skKpjfFW-SUfcx4gDUJ97QBECEv1BZGyjgQ,496
3494
- awscli/examples/iot1click-devices/untag-resource.rst,sha256=WBDhu-Vizt84opqkungU5OY2hDqZD1Juk6ddlERSbJI,599
3495
- awscli/examples/iot1click-devices/update-device-state.rst,sha256=VHjJh_sO6ThqL0-3PLqasfTrqd1l9BZZBmf55juxCOU,478
3496
- awscli/examples/iot1click-projects/associate-device-with-placement.rst,sha256=h4Y31mrfSNp2_jJ_uHmHy1o2Kyp3DB5wbmDAhV9plDg,670
3497
- awscli/examples/iot1click-projects/create-placement.rst,sha256=pq6YOArgl1g84IIIEAQJfcwaEmUVb3UF4PRR-l7Nm9w,620
3498
- awscli/examples/iot1click-projects/create-project.rst,sha256=tbF4ApzE8WAcVgyVnBDg34CaCFhG7Np3ocDUHi1nkKw,935
3499
- awscli/examples/iot1click-projects/delete-placement.rst,sha256=ZpHA9TfSH12Kr1fwsWbN7i7j_psVN_WfgDAAOMZIKcA,488
3500
- awscli/examples/iot1click-projects/delete-project.rst,sha256=AezykpnaQV1wDbUXib4jhc1epqnU6tITj8y9uOSmkX4,455
3501
- awscli/examples/iot1click-projects/describe-placement.rst,sha256=lbVGGa50S9PLFTEW8W7-nGT_roYYHSn5QxpiWASL_ag,820
3502
- awscli/examples/iot1click-projects/describe-project.rst,sha256=xE57J4bv9DQdcdjSC7JYnODitSnsxEM5wB0UrCbtEcA,1143
3503
- awscli/examples/iot1click-projects/disassociate-device-from-placement.rst,sha256=ck8llSGavseXA8igu30muOhkZK7z5SaUJZ1hVtRhLvI,590
3504
- awscli/examples/iot1click-projects/get-devices-in-placement.rst,sha256=2nK3Kkjo4sEgs7AomlkWFuVqAYFlbQ_bbxXUxjWD7hY,637
3505
- awscli/examples/iot1click-projects/list-placements.rst,sha256=FEwCQdkSJA8Cet7N36JdNgTvEPmfkVdL58Mw5LKilO4,714
3506
- awscli/examples/iot1click-projects/list-projects.rst,sha256=ofJFmgpxr1pNlfc9XzO9oi04N3RuuomSYN_OfYOlh08,710
3507
- awscli/examples/iot1click-projects/list-tags-for-resource.rst,sha256=9KEu0QdtOFvzMVIeX1cW7O5ycUB3jWOPWlbOBpGGllg,600
3508
- awscli/examples/iot1click-projects/tag-resource.rst,sha256=9Q3xvWPTxTN5lefZe9FQUWqoWvt2EWj6MlQDYtN78XI,705
3509
- awscli/examples/iot1click-projects/untag-resource.rst,sha256=Cazssn3W5LxJfM6Ud4pfIIvDvJ6lrQX3YLZANUeFFbc,556
3510
- awscli/examples/iot1click-projects/update-placement.rst,sha256=89g11ID7KGR04dIW82-xZgDsOpwwrJADMTPFIujtkS8,760
3511
- awscli/examples/iot1click-projects/update-project.rst,sha256=0D5OQJQYDdeJIb17qfe3HElr3O8frQEhBp3eU9Mpf-I,528
3512
3483
  awscli/examples/iotanalytics/batch-put-message.rst,sha256=AnFBaGXfdte2FDPWI-lPnQ2PURa0Ph4PMipW1ku58cQ,758
3513
3484
  awscli/examples/iotanalytics/cancel-pipeline-reprocessing.rst,sha256=RrHi59ONKvBNLnm35GS0J6noq4ioubGRp5OXrAkZPi4,570
3514
3485
  awscli/examples/iotanalytics/create-channel.rst,sha256=3Dr3oKHXjHLsWbr14Ym_HcROP1c9qNZrsOufUpAWzA4,1018
@@ -6021,13 +5992,13 @@ awscli/topics/return-codes.rst,sha256=d9lpNFZwD75IiYcDEADQzu-4QiR8P28UPHkrNwPV5J
6021
5992
  awscli/topics/s3-config.rst,sha256=FwwCczTylrSLwELuDQ-VA8sCI7ruwV9PEJJrqxjUeG0,11502
6022
5993
  awscli/topics/s3-faq.rst,sha256=sS5jKHF_7X5eiGwpUg7aTqQt2zCRN-m_xXOcE0Bme0Q,1899
6023
5994
  awscli/topics/topic-tags.json,sha256=6lUSrs3FKCZNRSQMnjcXNgWyRNGjZIeur1988a4IO5o,1577
6024
- awscli-1.36.33.data/scripts/aws,sha256=r24FExgs0-JjILTQ3XZAqXBYE4SV6UMTtALkLGAj86g,805
6025
- awscli-1.36.33.data/scripts/aws.cmd,sha256=s46DkC6LNgX63CIkzxxbPnFMJ6DRDBkvc88GnWa8Pvg,1432
6026
- awscli-1.36.33.data/scripts/aws_bash_completer,sha256=RRpoEGJRagRzyHZKZZOwpltuVYv2EoiZsdXhmyWPZ54,204
6027
- awscli-1.36.33.data/scripts/aws_completer,sha256=oC9kuMDlWE47dWk_4xjPde2PQvN-M0vND0J4YSLabVQ,1126
6028
- awscli-1.36.33.data/scripts/aws_zsh_completer.sh,sha256=Qm6Z8ejNAMzpJjaT0pzqxbSDT2zxdmzVe5haRA7qLoc,1808
6029
- awscli-1.36.33.dist-info/LICENSE.txt,sha256=o5XhFlwu0OK_BBrijlKCRa7dQAm36UrUB3gCV_cEr8E,549
6030
- awscli-1.36.33.dist-info/METADATA,sha256=81XgITz5NqIHkxi8s1kHXYL9HETPalfrixSqgojItdY,11331
6031
- awscli-1.36.33.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
6032
- awscli-1.36.33.dist-info/top_level.txt,sha256=vt9wXFr1_nGYK6abhJgt6zY3fULe4JSZedm_5XOM9S0,7
6033
- awscli-1.36.33.dist-info/RECORD,,
5995
+ awscli-1.36.35.data/scripts/aws,sha256=r24FExgs0-JjILTQ3XZAqXBYE4SV6UMTtALkLGAj86g,805
5996
+ awscli-1.36.35.data/scripts/aws.cmd,sha256=s46DkC6LNgX63CIkzxxbPnFMJ6DRDBkvc88GnWa8Pvg,1432
5997
+ awscli-1.36.35.data/scripts/aws_bash_completer,sha256=RRpoEGJRagRzyHZKZZOwpltuVYv2EoiZsdXhmyWPZ54,204
5998
+ awscli-1.36.35.data/scripts/aws_completer,sha256=oC9kuMDlWE47dWk_4xjPde2PQvN-M0vND0J4YSLabVQ,1126
5999
+ awscli-1.36.35.data/scripts/aws_zsh_completer.sh,sha256=Qm6Z8ejNAMzpJjaT0pzqxbSDT2zxdmzVe5haRA7qLoc,1808
6000
+ awscli-1.36.35.dist-info/LICENSE.txt,sha256=o5XhFlwu0OK_BBrijlKCRa7dQAm36UrUB3gCV_cEr8E,549
6001
+ awscli-1.36.35.dist-info/METADATA,sha256=DGKnevJKBmALw1xRIiqoQd6kv_0ZOW9j0JauGCBiu9A,11331
6002
+ awscli-1.36.35.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
6003
+ awscli-1.36.35.dist-info/top_level.txt,sha256=vt9wXFr1_nGYK6abhJgt6zY3fULe4JSZedm_5XOM9S0,7
6004
+ awscli-1.36.35.dist-info/RECORD,,
@@ -1,15 +0,0 @@
1
- **To claim one or more AWS IoT 1-Click devices using a claim code**
2
-
3
- The following ``claim-devices-by-claim-code`` example claims the specified AWS IoT 1-Click device using a claim code (instead of a device ID). ::
4
-
5
- aws iot1click-devices claim-devices-by-claim-code \
6
- --claim-code C-123EXAMPLE
7
-
8
- Output::
9
-
10
- {
11
- "Total": 9
12
- "ClaimCode": "C-123EXAMPLE"
13
- }
14
-
15
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,27 +0,0 @@
1
- **To describe a device**
2
-
3
- The following ``describe-device`` example describes the specified device. ::
4
-
5
- aws iot1click-devices describe-device \
6
- --device-id G030PM0123456789
7
-
8
- Output::
9
-
10
- {
11
- "DeviceDescription": {
12
- "Arn": "arn:aws:iot1click:us-west-2:012345678901:devices/G030PM0123456789",
13
- "Attributes": {
14
- "projectRegion": "us-west-2",
15
- "projectName": "AnytownDumpsters",
16
- "placementName": "customer217",
17
- "deviceTemplateName": "empty-dumpster-request"
18
- },
19
- "DeviceId": "G030PM0123456789",
20
- "Enabled": false,
21
- "RemainingLife": 99.9,
22
- "Type": "button",
23
- "Tags": {}
24
- }
25
- }
26
-
27
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,14 +0,0 @@
1
- **To finalize a claim request for an AWS IoT 1-Click device using a device ID**
2
-
3
- The following ``finalize-device-claim`` example finalizes a claim request for the specified AWS IoT 1-Click device using a device ID (instead of a claim code). ::
4
-
5
- aws iot1click-devices finalize-device-claim \
6
- --device-id G030PM0123456789
7
-
8
- Output::
9
-
10
- {
11
- "State": "CLAIMED"
12
- }
13
-
14
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,30 +0,0 @@
1
- **To list the available methods for a device**
2
-
3
- The following ``get-device-methods`` example lists the available methods for a device. ::
4
-
5
- aws iot1click-devices get-device-methods \
6
- --device-id G030PM0123456789
7
-
8
- Output::
9
-
10
- {
11
- "DeviceMethods": [
12
- {
13
- "MethodName": "getDeviceHealthParameters"
14
- },
15
- {
16
- "MethodName": "setDeviceHealthMonitorCallback"
17
- },
18
- {
19
- "MethodName": "getDeviceHealthMonitorCallback"
20
- },
21
- {
22
- "MethodName": "setOnClickCallback"
23
- },
24
- {
25
- "MethodName": "getOnClickCallback"
26
- }
27
- ]
28
- }
29
-
30
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,14 +0,0 @@
1
- **To initiate a claim request for an AWS IoT 1-Click device using a device ID**
2
-
3
- The following ``initiate-device-claim`` example initiates a claim request for the specified AWS IoT 1-Click device using a device ID (instead of a claim code). ::
4
-
5
- aws iot1click-devices initiate-device-claim \
6
- --device-id G030PM0123456789
7
-
8
- Output::
9
-
10
- {
11
- "State": "CLAIM_INITIATED"
12
- }
13
-
14
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,24 +0,0 @@
1
- **To invoke a device method on a device**
2
-
3
- The following ``invoke-device-method`` example invokes the specified method on a device. ::
4
-
5
- aws iot1click-devices invoke-device-method \
6
- --cli-input-json file://invoke-device-method.json
7
-
8
- Contents of ``invoke-device-method.json``::
9
-
10
- {
11
- "DeviceId": "G030PM0123456789",
12
- "DeviceMethod": {
13
- "DeviceType": "device",
14
- "MethodName": "getDeviceHealthParameters"
15
- }
16
- }
17
-
18
- Output::
19
-
20
- {
21
- "DeviceMethodResponse": "{\"remainingLife\": 99.8}"
22
- }
23
-
24
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,32 +0,0 @@
1
- **To list a device's events for a specified time range**
2
-
3
- The following ``list-device-events`` example lists the specified device's events for the specified time range. ::
4
-
5
- aws iot1click-devices list-device-events \
6
- --device-id G030PM0123456789 \
7
- --from-time-stamp 2019-07-17T15:45:12.880Z --to-time-stamp 2019-07-19T15:45:12.880Z
8
-
9
- Output::
10
-
11
- {
12
- "Events": [
13
- {
14
- "Device": {
15
- "Attributes": {},
16
- "DeviceId": "G030PM0123456789",
17
- "Type": "button"
18
- },
19
- "StdEvent": "{\"clickType\": \"SINGLE\", \"reportedTime\": \"2019-07-18T23:47:55.015Z\", \"certificateId\": \"fe8798a6c97c62ef8756b80eeefdcf2280f3352f82faa8080c74cc4f4a4d1811\", \"remainingLife\": 99.85000000000001, \"testMode\": false}"
20
- },
21
- {
22
- "Device": {
23
- "Attributes": {},
24
- "DeviceId": "G030PM0123456789",
25
- "Type": "button"
26
- },
27
- "StdEvent": "{\"clickType\": \"DOUBLE\", \"reportedTime\": \"2019-07-19T00:14:41.353Z\", \"certificateId\": \"fe8798a6c97c62ef8756b80eeefdcf2280f3352f82faa8080c74cc4f4a4d1811\", \"remainingLife\": 99.8, \"testMode\": false}"
28
- }
29
- ]
30
- }
31
-
32
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,26 +0,0 @@
1
- **To list the devices of a specified type**
2
-
3
- The following ``list-devices`` example lists the devices of a specified type. ::
4
-
5
- aws iot1click-devices list-devices \
6
- --device-type button
7
-
8
- This command produces no output.
9
-
10
- Output::
11
-
12
- {
13
- "Devices": [
14
- {
15
- "remainingLife": 99.9,
16
- "attributes": {
17
- "arn": "arn:aws:iot1click:us-west-2:123456789012:devices/G030PM0123456789",
18
- "type": "button",
19
- "deviceId": "G030PM0123456789",
20
- "enabled": false
21
- }
22
- }
23
- ]
24
- }
25
-
26
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,17 +0,0 @@
1
- **To list the tags for a device**
2
-
3
- The following ``list-tags-for-resource`` example list the tags for the specified device. ::
4
-
5
- aws iot1click-devices list-tags-for-resource \
6
- --resource-arn "arn:aws:iot1click:us-west-2:012345678901:devices/G030PM0123456789"
7
-
8
- Output::
9
-
10
- {
11
- "Tags": {
12
- "Driver Phone": "123-555-0199",
13
- "Driver": "Jorge Souza"
14
- }
15
- }
16
-
17
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,20 +0,0 @@
1
- **To add tags to a device AWS resource**
2
-
3
- The following ``tag-resource`` example adds two tags to the specified resource. ::
4
-
5
- aws iot1click-devices tag-resource \
6
- --cli-input-json file://devices-tag-resource.json
7
-
8
- Contents of ``devices-tag-resource.json``::
9
-
10
- {
11
- "ResourceArn": "arn:aws:iot1click:us-west-2:123456789012:devices/G030PM0123456789",
12
- "Tags": {
13
- "Driver": "Jorge Souza",
14
- "Driver Phone": "123-555-0199"
15
- }
16
- }
17
-
18
- This command produces no output.
19
-
20
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,14 +0,0 @@
1
- **To unclaim (deregister) a device from your AWS account**
2
-
3
- The following ``unclaim-device`` example unclaims (deregisters) the specified device from your AWS account. ::
4
-
5
- aws iot1click-devices unclaim-device \
6
- --device-id G030PM0123456789
7
-
8
- Output::
9
-
10
- {
11
- "State": "UNCLAIMED"
12
- }
13
-
14
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,12 +0,0 @@
1
- **To remove tags from a device AWS resource**
2
-
3
- The following ``untag-resource`` example removes the tags with the names ``Driver Phone`` and ``Driver`` from the specified device resource. ::
4
-
5
- aws iot1click-devices untag-resource \
6
- --resource-arn "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters" \
7
- --tag-keys "Driver Phone" "Driver"
8
-
9
-
10
- This command produces no output.
11
-
12
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,11 +0,0 @@
1
- **To update the ``enabled`` state for a device**
2
-
3
- The following ``update-device-state`` sets the state of the specified device to ``enabled``. ::
4
-
5
- aws iot1click-devices update-device-state \
6
- --device-id G030PM0123456789 \
7
- --enabled
8
-
9
- This command produces no output.
10
-
11
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,13 +0,0 @@
1
- **To associate an AWS IoT 1-Click device with an existing placement**
2
-
3
- The following ``associate-device-with-placement`` example associates the specified AWS IoT 1-Click device with an existing placement. ::
4
-
5
- aws iot1click-projects associate-device-with-placement \
6
- --project-name AnytownDumpsters \
7
- --placement-name customer217 \
8
- --device-template-name empty-dumpster-request \
9
- --device-id G030PM0123456789
10
-
11
- This command produces no output.
12
-
13
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,12 +0,0 @@
1
- **To create an AWS IoT 1-Click placement for a project**
2
-
3
- The following ``create-placement`` example create an AWS IoT 1-Click placement for the specified project. ::
4
-
5
- aws iot1click-projects create-placement \
6
- --project-name AnytownDumpsters \
7
- --placement-name customer217 \
8
- --attributes "{"location": "123 Any Street Anytown, USA 10001", "phone": "123-456-7890"}"
9
-
10
- This command produces no output.
11
-
12
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,27 +0,0 @@
1
- **To create an AWS IoT 1-Click project for zero or more placements**
2
-
3
- The following ``create-project`` example creates an AWS IoT 1-Click project for a placement.
4
-
5
- aws iot1click-projects create-project \
6
- --cli-input-json file://create-project.json
7
-
8
- Contents of ``create-project.json``::
9
-
10
- {
11
- "projectName": "AnytownDumpsters",
12
- "description": "All dumpsters in the Anytown region.",
13
- "placementTemplate": {
14
- "defaultAttributes": {
15
- "City" : "Anytown"
16
- },
17
- "deviceTemplates": {
18
- "empty-dumpster-request" : {
19
- "deviceType": "button"
20
- }
21
- }
22
- }
23
- }
24
-
25
- This command produces no output.
26
-
27
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,11 +0,0 @@
1
- **To delete a placement from a project**
2
-
3
- The following ``delete-placement`` example deletes the specified placement from a project. ::
4
-
5
- aws iot1click-projects delete-placement \
6
- --project-name AnytownDumpsters \
7
- --placement-name customer217
8
-
9
- This command produces no output.
10
-
11
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,10 +0,0 @@
1
- **To delete a project from your AWS account**
2
-
3
- The following ``delete-project`` example deletes the specified project from your AWS account. ::
4
-
5
- aws iot1click-projects delete-project \
6
- --project-name AnytownDumpsters
7
-
8
- This command produces no output.
9
-
10
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,24 +0,0 @@
1
- **To describe a placement for a project**
2
-
3
- The following ``describe-placement`` example describes a placement for the specified project. ::
4
-
5
- aws iot1click-projects describe-placement \
6
- --project-name AnytownDumpsters \
7
- --placement-name customer217
8
-
9
- Output::
10
-
11
- {
12
- "placement": {
13
- "projectName": "AnytownDumpsters",
14
- "placementName": "customer217",
15
- "attributes": {
16
- "phone": "123-555-0110",
17
- "location": "123 Any Street Anytown, USA 10001"
18
- },
19
- "createdDate": 1563488454,
20
- "updatedDate": 1563488454
21
- }
22
- }
23
-
24
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,32 +0,0 @@
1
- **To describe an AWS IoT 1-Click project**
2
-
3
- The following ``describe-project`` example describes the specified AWS IoT 1-Click project. ::
4
-
5
- aws iot1click-projects describe-project \
6
- --project-name AnytownDumpsters
7
-
8
- Output::
9
-
10
- {
11
- "project": {
12
- "arn": "arn:aws:iot1click:us-west-2:012345678901:projects/AnytownDumpsters",
13
- "projectName": "AnytownDumpsters",
14
- "description": "All dumpsters in the Anytown region.",
15
- "createdDate": 1563483100,
16
- "updatedDate": 1563483100,
17
- "placementTemplate": {
18
- "defaultAttributes": {
19
- "City": "Anytown"
20
- },
21
- "deviceTemplates": {
22
- "empty-dumpster-request": {
23
- "deviceType": "button",
24
- "callbackOverrides": {}
25
- }
26
- }
27
- },
28
- "tags": {}
29
- }
30
- }
31
-
32
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,12 +0,0 @@
1
- **To disassociate a device from a placement**
2
-
3
- The following ``disassociate-device-from-placement`` example disassociates the specified device from a placement. ::
4
-
5
- aws iot1click-projects disassociate-device-from-placement \
6
- --project-name AnytownDumpsters \
7
- --placement-name customer217 \
8
- --device-template-name empty-dumpster-request
9
-
10
- This command produces no output.
11
-
12
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,17 +0,0 @@
1
- **To list all devices in a placement contained in a project**
2
-
3
- The following ``get-devices-in-placement`` example lists all devices in a the specified placement contained in the specified project. ::
4
-
5
- aws iot1click-projects get-devices-in-placement \
6
- --project-name AnytownDumpsters \
7
- --placement-name customer217
8
-
9
- Output::
10
-
11
- {
12
- "devices": {
13
- "empty-dumpster-request": "G030PM0123456789"
14
- }
15
- }
16
-
17
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,21 +0,0 @@
1
- **To list all AWS IoT 1-Click placements for a project**
2
-
3
- The following ``list-placements`` example lists all AWS IoT 1-Click placements for the specified project. ::
4
-
5
- aws iot1click-projects list-placements \
6
- --project-name AnytownDumpsters
7
-
8
- Output::
9
-
10
- {
11
- "placements": [
12
- {
13
- "projectName": "AnytownDumpsters",
14
- "placementName": "customer217",
15
- "createdDate": 1563488454,
16
- "updatedDate": 1563488454
17
- }
18
- ]
19
- }
20
-
21
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,21 +0,0 @@
1
- **To list all AWS IoT 1-Click projects**
2
-
3
- The following ``list-projects`` example list all AWS IoT 1-Click projects in your account. ::
4
-
5
- aws iot1click-projects list-projects
6
-
7
- Output::
8
-
9
- {
10
- "projects": [
11
- {
12
- "arn": "arn:aws:iot1click:us-west-2:012345678901:projects/AnytownDumpsters",
13
- "projectName": "AnytownDumpsters",
14
- "createdDate": 1563483100,
15
- "updatedDate": 1563483100,
16
- "tags": {}
17
- }
18
- ]
19
- }
20
-
21
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,17 +0,0 @@
1
- **To list the tags for a project resource**
2
-
3
- The following ``list-tags-for-resource`` example list the tags for the specified project resource. ::
4
-
5
- aws iot1click-projects list-tags-for-resource \
6
- --resource-arn "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters"
7
-
8
- Output::
9
-
10
- {
11
- "tags": {
12
- "Manager": "Li Juan",
13
- "Account": "45215"
14
- }
15
- }
16
-
17
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,20 +0,0 @@
1
- **To add tags to a project resource**
2
-
3
- The following ``tag-resource`` example adds two tags to the specified project resource. ::
4
-
5
- aws iot1click-projects tag-resource \
6
- --cli-input-json file://devices-tag-resource.json
7
-
8
- Contents of ``devices-tag-resource.json``::
9
-
10
- {
11
- "resourceArn": "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters",
12
- "tags": {
13
- "Account": "45215",
14
- "Manager": "Li Juan"
15
- }
16
- }
17
-
18
- This command produces no output.
19
-
20
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,11 +0,0 @@
1
- **To remove tags from a project resource**
2
-
3
- The following ``untag-resource`` example removes the tag with the key name ``Manager`` from the specified project. ::
4
-
5
- aws iot1click-projects untag-resource \
6
- --resource-arn "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters" \
7
- --tag-keys "Manager"
8
-
9
- This command produces no output.
10
-
11
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,21 +0,0 @@
1
- **To update the "attributes" key-value pairs of a placement**
2
-
3
- The following ``update-placement`` example update the "attributes" key-value pairs of a placement. ::
4
-
5
- aws iot1click-projects update-placement \
6
- --cli-input-json file://update-placement.json
7
-
8
- Contents of ``update-placement.json``::
9
-
10
- {
11
- "projectName": "AnytownDumpsters",
12
- "placementName": "customer217",
13
- "attributes": {
14
- "phone": "123-456-7890",
15
- "location": "123 Any Street Anytown, USA 10001"
16
- }
17
- }
18
-
19
- This command produces no output.
20
-
21
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
@@ -1,11 +0,0 @@
1
- **To update settings for a project**
2
-
3
- The following ``update-project`` example updates the description for a project. ::
4
-
5
- aws iot1click-projects update-project \
6
- --project-name AnytownDumpsters \
7
- --description "All dumpsters (yard waste, recycling, garbage) in the Anytown region."
8
-
9
- This command produces no output.
10
-
11
- For more information, see `Using AWS IoT 1-Click with the AWS CLI <https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-cli.html>`__ in the *AWS IoT 1-Click Developer Guide*.
File without changes