aws-sdk-iot 1.71.0 → 1.75.0
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iot/client.rb +1899 -131
- data/lib/aws-sdk-iot/client_api.rb +238 -0
- data/lib/aws-sdk-iot/types.rb +771 -127
- data/lib/aws-sdk-iot.rb +1 -1
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 777563bcee47aa617cefbd8f7453e813f6ca0b35f2a77e7854e27456a7a377dc
|
4
|
+
data.tar.gz: 363748251c5a7b07da78a6e78a2efee5a2a194b94e60fa16475c903320a8b412
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 63d8281c51e6f14b7a62615c038140ecf219a50937b5b4cc9739861f714d99584b38be7a40563b52a29492a9cbd3f295f7615b6ef0660d9559acd0a14f34a00b
|
7
|
+
data.tar.gz: 7126c9ad606ac911cc0ad2f0ba8edb43800f1c39aa3860ad434978c632786fe2940c9b4fa3ea0d3c312ee59ff7eff9789a0a73bb1abc1c10f50fe07bba211061
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.75.0 (2021-09-13)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - AWS IoT Rules Engine adds OpenSearch action. The OpenSearch rule action lets you stream data from IoT sensors and applications to Amazon OpenSearch Service which is a successor to Amazon Elasticsearch Service.
|
8
|
+
|
9
|
+
1.74.0 (2021-09-01)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.73.0 (2021-08-31)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Added Create/Update/Delete/Describe/List APIs for a new IoT resource named FleetMetric. Added a new Fleet Indexing query API named GetBucketsAggregation. Added a new field named DisconnectedReason in Fleet Indexing query response. Updated their related documentations.
|
18
|
+
|
19
|
+
1.72.0 (2021-07-30)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.71.0 (2021-07-29)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.75.0
|
data/lib/aws-sdk-iot/client.rb
CHANGED
@@ -333,6 +333,13 @@ module Aws::IoT
|
|
333
333
|
# To check for pending certificate transfers, call ListCertificates to
|
334
334
|
# enumerate your certificates.
|
335
335
|
#
|
336
|
+
# Requires permission to access the [AcceptCertificateTransfer][1]
|
337
|
+
# action.
|
338
|
+
#
|
339
|
+
#
|
340
|
+
#
|
341
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
342
|
+
#
|
336
343
|
# @option params [required, String] :certificate_id
|
337
344
|
# The ID of the certificate. (The last part of the certificate ARN
|
338
345
|
# contains the certificate ID.)
|
@@ -358,6 +365,12 @@ module Aws::IoT
|
|
358
365
|
|
359
366
|
# Adds a thing to a billing group.
|
360
367
|
#
|
368
|
+
# Requires permission to access the [AddThingToBillingGroup][1] action.
|
369
|
+
#
|
370
|
+
#
|
371
|
+
#
|
372
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
373
|
+
#
|
361
374
|
# @option params [String] :billing_group_name
|
362
375
|
# The name of the billing group.
|
363
376
|
#
|
@@ -390,6 +403,12 @@ module Aws::IoT
|
|
390
403
|
|
391
404
|
# Adds a thing to a thing group.
|
392
405
|
#
|
406
|
+
# Requires permission to access the [AddThingToThingGroup][1] action.
|
407
|
+
#
|
408
|
+
#
|
409
|
+
#
|
410
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
411
|
+
#
|
393
412
|
# @option params [String] :thing_group_name
|
394
413
|
# The name of the group to which you are adding a thing.
|
395
414
|
#
|
@@ -438,6 +457,12 @@ module Aws::IoT
|
|
438
457
|
# * The total number of targets associated with a job must not exceed
|
439
458
|
# 100.
|
440
459
|
#
|
460
|
+
# Requires permission to access the [AssociateTargetsWithJob][1] action.
|
461
|
+
#
|
462
|
+
#
|
463
|
+
#
|
464
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
465
|
+
#
|
441
466
|
# @option params [required, Array<String>] :targets
|
442
467
|
# A list of thing group ARNs that define the targets of the job.
|
443
468
|
#
|
@@ -451,9 +476,9 @@ module Aws::IoT
|
|
451
476
|
# @option params [String] :namespace_id
|
452
477
|
# The namespace used to indicate that a job is a customer-managed job.
|
453
478
|
#
|
454
|
-
# When you specify a value for this parameter,
|
455
|
-
# notifications to MQTT topics that contain the value in
|
456
|
-
# format.
|
479
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
480
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
481
|
+
# the following format.
|
457
482
|
#
|
458
483
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
459
484
|
#
|
@@ -492,6 +517,12 @@ module Aws::IoT
|
|
492
517
|
# Attaches the specified policy to the specified principal (certificate
|
493
518
|
# or other credential).
|
494
519
|
#
|
520
|
+
# Requires permission to access the [AttachPolicy][1] action.
|
521
|
+
#
|
522
|
+
#
|
523
|
+
#
|
524
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
525
|
+
#
|
495
526
|
# @option params [required, String] :policy_name
|
496
527
|
# The name of the policy to attach.
|
497
528
|
#
|
@@ -522,7 +553,13 @@ module Aws::IoT
|
|
522
553
|
# Attaches the specified policy to the specified principal (certificate
|
523
554
|
# or other credential).
|
524
555
|
#
|
525
|
-
# **Note:** This
|
556
|
+
# **Note:** This action is deprecated. Please use AttachPolicy instead.
|
557
|
+
#
|
558
|
+
# Requires permission to access the [AttachPrincipalPolicy][1] action.
|
559
|
+
#
|
560
|
+
#
|
561
|
+
#
|
562
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
526
563
|
#
|
527
564
|
# @option params [required, String] :policy_name
|
528
565
|
# The policy name.
|
@@ -551,6 +588,12 @@ module Aws::IoT
|
|
551
588
|
# this account. Each thing group or account can have up to five security
|
552
589
|
# profiles associated with it.
|
553
590
|
#
|
591
|
+
# Requires permission to access the [AttachSecurityProfile][1] action.
|
592
|
+
#
|
593
|
+
#
|
594
|
+
#
|
595
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
596
|
+
#
|
554
597
|
# @option params [required, String] :security_profile_name
|
555
598
|
# The security profile that is attached.
|
556
599
|
#
|
@@ -578,6 +621,12 @@ module Aws::IoT
|
|
578
621
|
# can be X.509 certificates, IAM users, groups, and roles, Amazon
|
579
622
|
# Cognito identities or federated identities.
|
580
623
|
#
|
624
|
+
# Requires permission to access the [AttachThingPrincipal][1] action.
|
625
|
+
#
|
626
|
+
#
|
627
|
+
#
|
628
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
629
|
+
#
|
581
630
|
# @option params [required, String] :thing_name
|
582
631
|
# The name of the thing.
|
583
632
|
#
|
@@ -604,6 +653,13 @@ module Aws::IoT
|
|
604
653
|
# Cancels a mitigation action task that is in progress. If the task is
|
605
654
|
# not in progress, an InvalidRequestException occurs.
|
606
655
|
#
|
656
|
+
# Requires permission to access the
|
657
|
+
# [CancelAuditMitigationActionsTask][1] action.
|
658
|
+
#
|
659
|
+
#
|
660
|
+
#
|
661
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
662
|
+
#
|
607
663
|
# @option params [required, String] :task_id
|
608
664
|
# The unique identifier for the task that you want to cancel.
|
609
665
|
#
|
@@ -626,6 +682,12 @@ module Aws::IoT
|
|
626
682
|
# scheduled or on demand. If the audit isn't in progress, an
|
627
683
|
# "InvalidRequestException" occurs.
|
628
684
|
#
|
685
|
+
# Requires permission to access the [CancelAuditTask][1] action.
|
686
|
+
#
|
687
|
+
#
|
688
|
+
#
|
689
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
690
|
+
#
|
629
691
|
# @option params [required, String] :task_id
|
630
692
|
# The ID of the audit you want to cancel. You can only cancel an audit
|
631
693
|
# that is "IN\_PROGRESS".
|
@@ -649,14 +711,21 @@ module Aws::IoT
|
|
649
711
|
#
|
650
712
|
# **Note** Only the transfer source account can use this operation to
|
651
713
|
# cancel a transfer. (Transfer destinations can use
|
652
|
-
# RejectCertificateTransfer instead.) After transfer,
|
653
|
-
#
|
714
|
+
# RejectCertificateTransfer instead.) After transfer, IoT returns the
|
715
|
+
# certificate to the source account in the INACTIVE state. After the
|
654
716
|
# destination account has accepted the transfer, the transfer cannot be
|
655
717
|
# cancelled.
|
656
718
|
#
|
657
719
|
# After a certificate transfer is cancelled, the status of the
|
658
720
|
# certificate changes from PENDING\_TRANSFER to INACTIVE.
|
659
721
|
#
|
722
|
+
# Requires permission to access the [CancelCertificateTransfer][1]
|
723
|
+
# action.
|
724
|
+
#
|
725
|
+
#
|
726
|
+
#
|
727
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
728
|
+
#
|
660
729
|
# @option params [required, String] :certificate_id
|
661
730
|
# The ID of the certificate. (The last part of the certificate ARN
|
662
731
|
# contains the certificate ID.)
|
@@ -678,6 +747,13 @@ module Aws::IoT
|
|
678
747
|
|
679
748
|
# Cancels a Device Defender ML Detect mitigation action.
|
680
749
|
#
|
750
|
+
# Requires permission to access the
|
751
|
+
# [CancelDetectMitigationActionsTask][1] action.
|
752
|
+
#
|
753
|
+
#
|
754
|
+
#
|
755
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
756
|
+
#
|
681
757
|
# @option params [required, String] :task_id
|
682
758
|
# The unique identifier of the task.
|
683
759
|
#
|
@@ -698,6 +774,12 @@ module Aws::IoT
|
|
698
774
|
|
699
775
|
# Cancels a job.
|
700
776
|
#
|
777
|
+
# Requires permission to access the [CancelJob][1] action.
|
778
|
+
#
|
779
|
+
#
|
780
|
+
#
|
781
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
782
|
+
#
|
701
783
|
# @option params [required, String] :job_id
|
702
784
|
# The unique identifier you assigned to this job when it was created.
|
703
785
|
#
|
@@ -747,6 +829,12 @@ module Aws::IoT
|
|
747
829
|
|
748
830
|
# Cancels the execution of a job for a given thing.
|
749
831
|
#
|
832
|
+
# Requires permission to access the [CancelJobExecution][1] action.
|
833
|
+
#
|
834
|
+
#
|
835
|
+
#
|
836
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
837
|
+
#
|
750
838
|
# @option params [required, String] :job_id
|
751
839
|
# The ID of the job to be canceled.
|
752
840
|
#
|
@@ -802,6 +890,12 @@ module Aws::IoT
|
|
802
890
|
|
803
891
|
# Clears the default authorizer.
|
804
892
|
#
|
893
|
+
# Requires permission to access the [ClearDefaultAuthorizer][1] action.
|
894
|
+
#
|
895
|
+
#
|
896
|
+
#
|
897
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
898
|
+
#
|
805
899
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
806
900
|
#
|
807
901
|
# @overload clear_default_authorizer(params = {})
|
@@ -812,10 +906,17 @@ module Aws::IoT
|
|
812
906
|
end
|
813
907
|
|
814
908
|
# Confirms a topic rule destination. When you create a rule requiring a
|
815
|
-
# destination,
|
816
|
-
#
|
817
|
-
#
|
818
|
-
#
|
909
|
+
# destination, IoT sends a confirmation message to the endpoint or base
|
910
|
+
# address you specify. The message includes a token which you pass back
|
911
|
+
# when calling `ConfirmTopicRuleDestination` to confirm that you own or
|
912
|
+
# have access to the endpoint.
|
913
|
+
#
|
914
|
+
# Requires permission to access the [ConfirmTopicRuleDestination][1]
|
915
|
+
# action.
|
916
|
+
#
|
917
|
+
#
|
918
|
+
#
|
919
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
819
920
|
#
|
820
921
|
# @option params [required, String] :confirmation_token
|
821
922
|
# The token used to confirm ownership or access to the topic rule
|
@@ -838,6 +939,12 @@ module Aws::IoT
|
|
838
939
|
|
839
940
|
# Creates a Device Defender audit suppression.
|
840
941
|
#
|
942
|
+
# Requires permission to access the [CreateAuditSuppression][1] action.
|
943
|
+
#
|
944
|
+
#
|
945
|
+
#
|
946
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
947
|
+
#
|
841
948
|
# @option params [required, String] :check_name
|
842
949
|
# An audit check name. Checks must be enabled for your account. (Use
|
843
950
|
# `DescribeAccountAuditConfiguration` to see the list of all checks,
|
@@ -896,6 +1003,12 @@ module Aws::IoT
|
|
896
1003
|
|
897
1004
|
# Creates an authorizer.
|
898
1005
|
#
|
1006
|
+
# Requires permission to access the [CreateAuthorizer][1] action.
|
1007
|
+
#
|
1008
|
+
#
|
1009
|
+
#
|
1010
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1011
|
+
#
|
899
1012
|
# @option params [required, String] :authorizer_name
|
900
1013
|
# The authorizer name.
|
901
1014
|
#
|
@@ -928,7 +1041,7 @@ module Aws::IoT
|
|
928
1041
|
# </note>
|
929
1042
|
#
|
930
1043
|
# @option params [Boolean] :signing_disabled
|
931
|
-
# Specifies whether
|
1044
|
+
# Specifies whether IoT validates the token signature in an
|
932
1045
|
# authorization request.
|
933
1046
|
#
|
934
1047
|
# @return [Types::CreateAuthorizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -969,6 +1082,12 @@ module Aws::IoT
|
|
969
1082
|
|
970
1083
|
# Creates a billing group.
|
971
1084
|
#
|
1085
|
+
# Requires permission to access the [CreateBillingGroup][1] action.
|
1086
|
+
#
|
1087
|
+
#
|
1088
|
+
#
|
1089
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1090
|
+
#
|
972
1091
|
# @option params [required, String] :billing_group_name
|
973
1092
|
# The name you wish to give to the billing group.
|
974
1093
|
#
|
@@ -1022,6 +1141,9 @@ module Aws::IoT
|
|
1022
1141
|
# **Note:** Reusing the same certificate signing request (CSR) results
|
1023
1142
|
# in a distinct certificate.
|
1024
1143
|
#
|
1144
|
+
# Requires permission to access the [CreateCertificateFromCsr][1]
|
1145
|
+
# action.
|
1146
|
+
#
|
1025
1147
|
# You can create multiple certificates in a batch by creating a
|
1026
1148
|
# directory, copying multiple .csr files into that directory, and then
|
1027
1149
|
# specifying that directory on the command line. The following commands
|
@@ -1037,8 +1159,9 @@ module Aws::IoT
|
|
1037
1159
|
# file://my-csr-directory/\\\{\\}
|
1038
1160
|
#
|
1039
1161
|
# This command lists all of the CSRs in my-csr-directory and pipes each
|
1040
|
-
# CSR file name to the aws iot create-certificate-from-csr
|
1041
|
-
# command to create a certificate for the corresponding
|
1162
|
+
# CSR file name to the aws iot create-certificate-from-csr Amazon Web
|
1163
|
+
# Services CLI command to create a certificate for the corresponding
|
1164
|
+
# CSR.
|
1042
1165
|
#
|
1043
1166
|
# The aws iot create-certificate-from-csr part of the command can also
|
1044
1167
|
# be run in parallel to speed up the certificate creation process:
|
@@ -1061,6 +1184,10 @@ module Aws::IoT
|
|
1061
1184
|
# create-certificate-from-csr --certificate-signing-request
|
1062
1185
|
# file://@path"
|
1063
1186
|
#
|
1187
|
+
#
|
1188
|
+
#
|
1189
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1190
|
+
#
|
1064
1191
|
# @option params [required, String] :certificate_signing_request
|
1065
1192
|
# The certificate signing request (CSR).
|
1066
1193
|
#
|
@@ -1096,6 +1223,12 @@ module Aws::IoT
|
|
1096
1223
|
# Use this API to define a Custom Metric published by your devices to
|
1097
1224
|
# Device Defender.
|
1098
1225
|
#
|
1226
|
+
# Requires permission to access the [CreateCustomMetric][1] action.
|
1227
|
+
#
|
1228
|
+
#
|
1229
|
+
#
|
1230
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1231
|
+
#
|
1099
1232
|
# @option params [required, String] :metric_name
|
1100
1233
|
# The name of the custom metric. This will be used in the metric report
|
1101
1234
|
# submitted from the device/thing. Shouldn't begin with `aws:`. Cannot
|
@@ -1116,8 +1249,8 @@ module Aws::IoT
|
|
1116
1249
|
# @option params [required, String] :client_request_token
|
1117
1250
|
# Each custom metric must have a unique client request token. If you try
|
1118
1251
|
# to create a new custom metric that already exists with a different
|
1119
|
-
# token, an exception occurs. If you omit this value,
|
1120
|
-
# automatically generate a unique client request.
|
1252
|
+
# token, an exception occurs. If you omit this value, Amazon Web
|
1253
|
+
# Services SDKs will automatically generate a unique client request.
|
1121
1254
|
#
|
1122
1255
|
# **A suitable default value is auto-generated.** You should normally
|
1123
1256
|
# not need to pass this option.**
|
@@ -1155,11 +1288,17 @@ module Aws::IoT
|
|
1155
1288
|
end
|
1156
1289
|
|
1157
1290
|
# Create a dimension that you can use to limit the scope of a metric
|
1158
|
-
# used in a security profile for
|
1159
|
-
#
|
1291
|
+
# used in a security profile for IoT Device Defender. For example, using
|
1292
|
+
# a `TOPIC_FILTER` dimension, you can narrow down the scope of the
|
1160
1293
|
# metric only to MQTT topics whose name match the pattern specified in
|
1161
1294
|
# the dimension.
|
1162
1295
|
#
|
1296
|
+
# Requires permission to access the [CreateDimension][1] action.
|
1297
|
+
#
|
1298
|
+
#
|
1299
|
+
#
|
1300
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1301
|
+
#
|
1163
1302
|
# @option params [required, String] :name
|
1164
1303
|
# A unique identifier for the dimension. Choose something that describes
|
1165
1304
|
# the type and value to make it easy to remember what it does.
|
@@ -1178,8 +1317,8 @@ module Aws::IoT
|
|
1178
1317
|
# @option params [required, String] :client_request_token
|
1179
1318
|
# Each dimension must have a unique client request token. If you try to
|
1180
1319
|
# create a new dimension with the same token as a dimension that already
|
1181
|
-
# exists, an exception occurs. If you omit this value,
|
1182
|
-
# automatically generate a unique client request.
|
1320
|
+
# exists, an exception occurs. If you omit this value, Amazon Web
|
1321
|
+
# Services SDKs will automatically generate a unique client request.
|
1183
1322
|
#
|
1184
1323
|
# **A suitable default value is auto-generated.** You should normally
|
1185
1324
|
# not need to pass this option.**
|
@@ -1218,6 +1357,13 @@ module Aws::IoT
|
|
1218
1357
|
|
1219
1358
|
# Creates a domain configuration.
|
1220
1359
|
#
|
1360
|
+
# Requires permission to access the [CreateDomainConfiguration][1]
|
1361
|
+
# action.
|
1362
|
+
#
|
1363
|
+
#
|
1364
|
+
#
|
1365
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1366
|
+
#
|
1221
1367
|
# @option params [required, String] :domain_configuration_name
|
1222
1368
|
# The name of the domain configuration. This value must be unique to a
|
1223
1369
|
# region.
|
@@ -1226,15 +1372,15 @@ module Aws::IoT
|
|
1226
1372
|
# The name of the domain.
|
1227
1373
|
#
|
1228
1374
|
# @option params [Array<String>] :server_certificate_arns
|
1229
|
-
# The ARNs of the certificates that
|
1230
|
-
#
|
1231
|
-
# This value is not required for
|
1375
|
+
# The ARNs of the certificates that IoT passes to the device during the
|
1376
|
+
# TLS handshake. Currently you can specify only one certificate ARN.
|
1377
|
+
# This value is not required for Amazon Web Services-managed domains.
|
1232
1378
|
#
|
1233
1379
|
# @option params [String] :validation_certificate_arn
|
1234
1380
|
# The certificate used to validate the server certificate and prove
|
1235
1381
|
# domain name ownership. This certificate must be signed by a public
|
1236
|
-
# certificate authority. This value is not required for
|
1237
|
-
# domains.
|
1382
|
+
# certificate authority. This value is not required for Amazon Web
|
1383
|
+
# Services-managed domains.
|
1238
1384
|
#
|
1239
1385
|
# @option params [Types::AuthorizerConfig] :authorizer_config
|
1240
1386
|
# An object that specifies the authorization service for a domain.
|
@@ -1242,7 +1388,8 @@ module Aws::IoT
|
|
1242
1388
|
# @option params [String] :service_type
|
1243
1389
|
# The type of service delivered by the endpoint.
|
1244
1390
|
#
|
1245
|
-
# <note markdown="1">
|
1391
|
+
# <note markdown="1"> Amazon Web Services IoT Core currently supports only the `DATA`
|
1392
|
+
# service type.
|
1246
1393
|
#
|
1247
1394
|
# </note>
|
1248
1395
|
#
|
@@ -1299,6 +1446,12 @@ module Aws::IoT
|
|
1299
1446
|
|
1300
1447
|
# Creates a dynamic thing group.
|
1301
1448
|
#
|
1449
|
+
# Requires permission to access the [CreateDynamicThingGroup][1] action.
|
1450
|
+
#
|
1451
|
+
#
|
1452
|
+
#
|
1453
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1454
|
+
#
|
1302
1455
|
# @option params [required, String] :thing_group_name
|
1303
1456
|
# The dynamic thing group name to create.
|
1304
1457
|
#
|
@@ -1308,7 +1461,7 @@ module Aws::IoT
|
|
1308
1461
|
# @option params [String] :index_name
|
1309
1462
|
# The dynamic thing group index name.
|
1310
1463
|
#
|
1311
|
-
# <note markdown="1"> Currently one index is supported:
|
1464
|
+
# <note markdown="1"> Currently one index is supported: `AWS_Things`.
|
1312
1465
|
#
|
1313
1466
|
# </note>
|
1314
1467
|
#
|
@@ -1381,12 +1534,102 @@ module Aws::IoT
|
|
1381
1534
|
req.send_request(options)
|
1382
1535
|
end
|
1383
1536
|
|
1537
|
+
# Creates a fleet metric.
|
1538
|
+
#
|
1539
|
+
# Requires permission to access the [CreateFleetMetric][1] action.
|
1540
|
+
#
|
1541
|
+
#
|
1542
|
+
#
|
1543
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1544
|
+
#
|
1545
|
+
# @option params [required, String] :metric_name
|
1546
|
+
# The name of the fleet metric to create.
|
1547
|
+
#
|
1548
|
+
# @option params [required, String] :query_string
|
1549
|
+
# The search query string.
|
1550
|
+
#
|
1551
|
+
# @option params [required, Types::AggregationType] :aggregation_type
|
1552
|
+
# The type of the aggregation query.
|
1553
|
+
#
|
1554
|
+
# @option params [required, Integer] :period
|
1555
|
+
# The time in seconds between fleet metric emissions. Range \[60(1 min),
|
1556
|
+
# 86400(1 day)\] and must be multiple of 60.
|
1557
|
+
#
|
1558
|
+
# @option params [required, String] :aggregation_field
|
1559
|
+
# The field to aggregate.
|
1560
|
+
#
|
1561
|
+
# @option params [String] :description
|
1562
|
+
# The fleet metric description.
|
1563
|
+
#
|
1564
|
+
# @option params [String] :query_version
|
1565
|
+
# The query version.
|
1566
|
+
#
|
1567
|
+
# @option params [String] :index_name
|
1568
|
+
# The name of the index to search.
|
1569
|
+
#
|
1570
|
+
# @option params [String] :unit
|
1571
|
+
# Used to support unit transformation such as milliseconds to seconds.
|
1572
|
+
# The unit must be supported by [CW metric][1]. Default to null.
|
1573
|
+
#
|
1574
|
+
#
|
1575
|
+
#
|
1576
|
+
# [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
|
1577
|
+
#
|
1578
|
+
# @option params [Array<Types::Tag>] :tags
|
1579
|
+
# Metadata, which can be used to manage the fleet metric.
|
1580
|
+
#
|
1581
|
+
# @return [Types::CreateFleetMetricResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1582
|
+
#
|
1583
|
+
# * {Types::CreateFleetMetricResponse#metric_name #metric_name} => String
|
1584
|
+
# * {Types::CreateFleetMetricResponse#metric_arn #metric_arn} => String
|
1585
|
+
#
|
1586
|
+
# @example Request syntax with placeholder values
|
1587
|
+
#
|
1588
|
+
# resp = client.create_fleet_metric({
|
1589
|
+
# metric_name: "FleetMetricName", # required
|
1590
|
+
# query_string: "QueryString", # required
|
1591
|
+
# aggregation_type: { # required
|
1592
|
+
# name: "Statistics", # required, accepts Statistics, Percentiles, Cardinality
|
1593
|
+
# values: ["AggregationTypeValue"],
|
1594
|
+
# },
|
1595
|
+
# period: 1, # required
|
1596
|
+
# aggregation_field: "AggregationField", # required
|
1597
|
+
# description: "FleetMetricDescription",
|
1598
|
+
# query_version: "QueryVersion",
|
1599
|
+
# index_name: "IndexName",
|
1600
|
+
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
1601
|
+
# tags: [
|
1602
|
+
# {
|
1603
|
+
# key: "TagKey", # required
|
1604
|
+
# value: "TagValue",
|
1605
|
+
# },
|
1606
|
+
# ],
|
1607
|
+
# })
|
1608
|
+
#
|
1609
|
+
# @example Response structure
|
1610
|
+
#
|
1611
|
+
# resp.metric_name #=> String
|
1612
|
+
# resp.metric_arn #=> String
|
1613
|
+
#
|
1614
|
+
# @overload create_fleet_metric(params = {})
|
1615
|
+
# @param [Hash] params ({})
|
1616
|
+
def create_fleet_metric(params = {}, options = {})
|
1617
|
+
req = build_request(:create_fleet_metric, params)
|
1618
|
+
req.send_request(options)
|
1619
|
+
end
|
1620
|
+
|
1384
1621
|
# Creates a job.
|
1385
1622
|
#
|
1623
|
+
# Requires permission to access the [CreateJob][1] action.
|
1624
|
+
#
|
1625
|
+
#
|
1626
|
+
#
|
1627
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1628
|
+
#
|
1386
1629
|
# @option params [required, String] :job_id
|
1387
|
-
# A job identifier which must be unique for your
|
1388
|
-
# recommend using a UUID. Alpha-numeric characters, "-"
|
1389
|
-
# valid for use here.
|
1630
|
+
# A job identifier which must be unique for your Amazon Web Services
|
1631
|
+
# account. We recommend using a UUID. Alpha-numeric characters, "-"
|
1632
|
+
# and "\_" are valid for use here.
|
1390
1633
|
#
|
1391
1634
|
# @option params [required, Array<String>] :targets
|
1392
1635
|
# A list of things and thing groups to which the job should be sent.
|
@@ -1444,9 +1687,9 @@ module Aws::IoT
|
|
1444
1687
|
# @option params [String] :namespace_id
|
1445
1688
|
# The namespace used to indicate that a job is a customer-managed job.
|
1446
1689
|
#
|
1447
|
-
# When you specify a value for this parameter,
|
1448
|
-
# notifications to MQTT topics that contain the value in
|
1449
|
-
# format.
|
1690
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
1691
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
1692
|
+
# the following format.
|
1450
1693
|
#
|
1451
1694
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
1452
1695
|
#
|
@@ -1525,6 +1768,12 @@ module Aws::IoT
|
|
1525
1768
|
|
1526
1769
|
# Creates a job template.
|
1527
1770
|
#
|
1771
|
+
# Requires permission to access the [CreateJobTemplate][1] action.
|
1772
|
+
#
|
1773
|
+
#
|
1774
|
+
#
|
1775
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1776
|
+
#
|
1528
1777
|
# @option params [required, String] :job_template_id
|
1529
1778
|
# A unique identifier for the job template. We recommend using a UUID.
|
1530
1779
|
# Alpha-numeric characters, "-", and "\_" are valid for use here.
|
@@ -1640,12 +1889,16 @@ module Aws::IoT
|
|
1640
1889
|
# over MQTT from a device, for more information, see [Provisioning MQTT
|
1641
1890
|
# API][1].
|
1642
1891
|
#
|
1643
|
-
# **Note** This is the only time
|
1892
|
+
# **Note** This is the only time IoT issues the private key for this
|
1644
1893
|
# certificate, so it is important to keep it in a secure location.
|
1645
1894
|
#
|
1895
|
+
# Requires permission to access the [CreateKeysAndCertificate][2]
|
1896
|
+
# action.
|
1897
|
+
#
|
1646
1898
|
#
|
1647
1899
|
#
|
1648
1900
|
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#provision-mqtt-api
|
1901
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1649
1902
|
#
|
1650
1903
|
# @option params [Boolean] :set_as_active
|
1651
1904
|
# Specifies whether the certificate is active.
|
@@ -1684,9 +1937,12 @@ module Aws::IoT
|
|
1684
1937
|
# see [Mitigation actions][1]. Each mitigation action can apply only one
|
1685
1938
|
# type of change.
|
1686
1939
|
#
|
1940
|
+
# Requires permission to access the [CreateMitigationAction][2] action.
|
1941
|
+
#
|
1687
1942
|
#
|
1688
1943
|
#
|
1689
1944
|
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-mitigation-actions.html
|
1945
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1690
1946
|
#
|
1691
1947
|
# @option params [required, String] :action_name
|
1692
1948
|
# A friendly name for the action. Choose a friendly name that accurately
|
@@ -1753,7 +2009,13 @@ module Aws::IoT
|
|
1753
2009
|
req.send_request(options)
|
1754
2010
|
end
|
1755
2011
|
|
1756
|
-
# Creates an
|
2012
|
+
# Creates an IoT OTA update on a target group of things or groups.
|
2013
|
+
#
|
2014
|
+
# Requires permission to access the [CreateOTAUpdate][1] action.
|
2015
|
+
#
|
2016
|
+
#
|
2017
|
+
#
|
2018
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1757
2019
|
#
|
1758
2020
|
# @option params [required, String] :ota_update_id
|
1759
2021
|
# The ID of the OTA update to be created.
|
@@ -1798,8 +2060,9 @@ module Aws::IoT
|
|
1798
2060
|
# The files to be streamed by the OTA update.
|
1799
2061
|
#
|
1800
2062
|
# @option params [required, String] :role_arn
|
1801
|
-
# The IAM role that grants
|
1802
|
-
# and
|
2063
|
+
# The IAM role that grants Amazon Web Services IoT Core access to the
|
2064
|
+
# Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to
|
2065
|
+
# create an OTA update job.
|
1803
2066
|
#
|
1804
2067
|
# @option params [Hash<String,String>] :additional_parameters
|
1805
2068
|
# A list of additional OTA update parameters which are name-value pairs.
|
@@ -1926,12 +2189,18 @@ module Aws::IoT
|
|
1926
2189
|
req.send_request(options)
|
1927
2190
|
end
|
1928
2191
|
|
1929
|
-
# Creates an
|
2192
|
+
# Creates an IoT policy.
|
1930
2193
|
#
|
1931
2194
|
# The created policy is the default version for the policy. This
|
1932
2195
|
# operation creates a policy version with a version identifier of **1**
|
1933
2196
|
# and sets **1** as the policy's default version.
|
1934
2197
|
#
|
2198
|
+
# Requires permission to access the [CreatePolicy][1] action.
|
2199
|
+
#
|
2200
|
+
#
|
2201
|
+
#
|
2202
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2203
|
+
#
|
1935
2204
|
# @option params [required, String] :policy_name
|
1936
2205
|
# The policy name.
|
1937
2206
|
#
|
@@ -1988,9 +2257,9 @@ module Aws::IoT
|
|
1988
2257
|
req.send_request(options)
|
1989
2258
|
end
|
1990
2259
|
|
1991
|
-
# Creates a new version of the specified
|
1992
|
-
#
|
1993
|
-
#
|
2260
|
+
# Creates a new version of the specified IoT policy. To update a policy,
|
2261
|
+
# create a new policy version. A managed policy can have up to five
|
2262
|
+
# versions. If the policy has five versions, you must use
|
1994
2263
|
# DeletePolicyVersion to delete an existing version before you create a
|
1995
2264
|
# new one.
|
1996
2265
|
#
|
@@ -1999,6 +2268,12 @@ module Aws::IoT
|
|
1999
2268
|
# version that is in effect for the certificates to which the policy is
|
2000
2269
|
# attached).
|
2001
2270
|
#
|
2271
|
+
# Requires permission to access the [CreatePolicyVersion][1] action.
|
2272
|
+
#
|
2273
|
+
#
|
2274
|
+
#
|
2275
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2276
|
+
#
|
2002
2277
|
# @option params [required, String] :policy_name
|
2003
2278
|
# The policy name.
|
2004
2279
|
#
|
@@ -2043,6 +2318,12 @@ module Aws::IoT
|
|
2043
2318
|
|
2044
2319
|
# Creates a provisioning claim.
|
2045
2320
|
#
|
2321
|
+
# Requires permission to access the [CreateProvisioningClaim][1] action.
|
2322
|
+
#
|
2323
|
+
#
|
2324
|
+
#
|
2325
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2326
|
+
#
|
2046
2327
|
# @option params [required, String] :template_name
|
2047
2328
|
# The name of the provisioning template to use.
|
2048
2329
|
#
|
@@ -2076,6 +2357,13 @@ module Aws::IoT
|
|
2076
2357
|
|
2077
2358
|
# Creates a fleet provisioning template.
|
2078
2359
|
#
|
2360
|
+
# Requires permission to access the [CreateProvisioningTemplate][1]
|
2361
|
+
# action.
|
2362
|
+
#
|
2363
|
+
#
|
2364
|
+
#
|
2365
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2366
|
+
#
|
2079
2367
|
# @option params [required, String] :template_name
|
2080
2368
|
# The name of the fleet provisioning template.
|
2081
2369
|
#
|
@@ -2150,6 +2438,13 @@ module Aws::IoT
|
|
2150
2438
|
|
2151
2439
|
# Creates a new version of a fleet provisioning template.
|
2152
2440
|
#
|
2441
|
+
# Requires permission to access the
|
2442
|
+
# [CreateProvisioningTemplateVersion][1] action.
|
2443
|
+
#
|
2444
|
+
#
|
2445
|
+
#
|
2446
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2447
|
+
#
|
2153
2448
|
# @option params [required, String] :template_name
|
2154
2449
|
# The name of the fleet provisioning template.
|
2155
2450
|
#
|
@@ -2190,6 +2485,12 @@ module Aws::IoT
|
|
2190
2485
|
|
2191
2486
|
# Creates a role alias.
|
2192
2487
|
#
|
2488
|
+
# Requires permission to access the [CreateRoleAlias][1] action.
|
2489
|
+
#
|
2490
|
+
#
|
2491
|
+
#
|
2492
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2493
|
+
#
|
2193
2494
|
# @option params [required, String] :role_alias
|
2194
2495
|
# The role alias that points to a role ARN. This allows you to change
|
2195
2496
|
# the role without having to update the device.
|
@@ -2198,7 +2499,8 @@ module Aws::IoT
|
|
2198
2499
|
# The role ARN.
|
2199
2500
|
#
|
2200
2501
|
# @option params [Integer] :credential_duration_seconds
|
2201
|
-
# How long (in seconds) the credentials will be valid.
|
2502
|
+
# How long (in seconds) the credentials will be valid. The default value
|
2503
|
+
# is 3,600 seconds.
|
2202
2504
|
#
|
2203
2505
|
# @option params [Array<Types::Tag>] :tags
|
2204
2506
|
# Metadata which can be used to manage the role alias.
|
@@ -2247,6 +2549,12 @@ module Aws::IoT
|
|
2247
2549
|
|
2248
2550
|
# Creates a scheduled audit that is run at a specified time interval.
|
2249
2551
|
#
|
2552
|
+
# Requires permission to access the [CreateScheduledAudit][1] action.
|
2553
|
+
#
|
2554
|
+
#
|
2555
|
+
#
|
2556
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2557
|
+
#
|
2250
2558
|
# @option params [required, String] :frequency
|
2251
2559
|
# How often the scheduled audit takes place, either `DAILY`, `WEEKLY`,
|
2252
2560
|
# `BIWEEKLY` or `MONTHLY`. The start time of each audit is determined by
|
@@ -2310,6 +2618,12 @@ module Aws::IoT
|
|
2310
2618
|
|
2311
2619
|
# Creates a Device Defender security profile.
|
2312
2620
|
#
|
2621
|
+
# Requires permission to access the [CreateSecurityProfile][1] action.
|
2622
|
+
#
|
2623
|
+
#
|
2624
|
+
#
|
2625
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2626
|
+
#
|
2313
2627
|
# @option params [required, String] :security_profile_name
|
2314
2628
|
# The name you are giving to the security profile.
|
2315
2629
|
#
|
@@ -2425,6 +2739,12 @@ module Aws::IoT
|
|
2425
2739
|
# MQTT messages from a source like S3. You can have one or more files
|
2426
2740
|
# associated with a stream.
|
2427
2741
|
#
|
2742
|
+
# Requires permission to access the [CreateStream][1] action.
|
2743
|
+
#
|
2744
|
+
#
|
2745
|
+
#
|
2746
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2747
|
+
#
|
2428
2748
|
# @option params [required, String] :stream_id
|
2429
2749
|
# The stream ID.
|
2430
2750
|
#
|
@@ -2496,9 +2816,12 @@ module Aws::IoT
|
|
2496
2816
|
#
|
2497
2817
|
# </note>
|
2498
2818
|
#
|
2819
|
+
# Requires permission to access the [CreateThing][2] action.
|
2820
|
+
#
|
2499
2821
|
#
|
2500
2822
|
#
|
2501
2823
|
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html
|
2824
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2502
2825
|
#
|
2503
2826
|
# @option params [required, String] :thing_name
|
2504
2827
|
# The name of the thing to create.
|
@@ -2559,9 +2882,12 @@ module Aws::IoT
|
|
2559
2882
|
#
|
2560
2883
|
# </note>
|
2561
2884
|
#
|
2885
|
+
# Requires permission to access the [CreateThingGroup][2] action.
|
2886
|
+
#
|
2562
2887
|
#
|
2563
2888
|
#
|
2564
2889
|
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html
|
2890
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2565
2891
|
#
|
2566
2892
|
# @option params [required, String] :thing_group_name
|
2567
2893
|
# The thing group name to create.
|
@@ -2618,6 +2944,12 @@ module Aws::IoT
|
|
2618
2944
|
|
2619
2945
|
# Creates a new thing type.
|
2620
2946
|
#
|
2947
|
+
# Requires permission to access the [CreateThingType][1] action.
|
2948
|
+
#
|
2949
|
+
#
|
2950
|
+
#
|
2951
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2952
|
+
#
|
2621
2953
|
# @option params [required, String] :thing_type_name
|
2622
2954
|
# The name of the thing type.
|
2623
2955
|
#
|
@@ -2668,6 +3000,12 @@ module Aws::IoT
|
|
2668
3000
|
# user who has permission to create rules will be able to access data
|
2669
3001
|
# processed by the rule.
|
2670
3002
|
#
|
3003
|
+
# Requires permission to access the [CreateTopicRule][1] action.
|
3004
|
+
#
|
3005
|
+
#
|
3006
|
+
#
|
3007
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3008
|
+
#
|
2671
3009
|
# @option params [required, String] :rule_name
|
2672
3010
|
# The name of the rule.
|
2673
3011
|
#
|
@@ -2865,6 +3203,13 @@ module Aws::IoT
|
|
2865
3203
|
# "String" => "String",
|
2866
3204
|
# },
|
2867
3205
|
# },
|
3206
|
+
# open_search: {
|
3207
|
+
# role_arn: "AwsArn", # required
|
3208
|
+
# endpoint: "ElasticsearchEndpoint", # required
|
3209
|
+
# index: "ElasticsearchIndex", # required
|
3210
|
+
# type: "ElasticsearchType", # required
|
3211
|
+
# id: "ElasticsearchId", # required
|
3212
|
+
# },
|
2868
3213
|
# },
|
2869
3214
|
# ],
|
2870
3215
|
# rule_disabled: false,
|
@@ -3036,6 +3381,13 @@ module Aws::IoT
|
|
3036
3381
|
# "String" => "String",
|
3037
3382
|
# },
|
3038
3383
|
# },
|
3384
|
+
# open_search: {
|
3385
|
+
# role_arn: "AwsArn", # required
|
3386
|
+
# endpoint: "ElasticsearchEndpoint", # required
|
3387
|
+
# index: "ElasticsearchIndex", # required
|
3388
|
+
# type: "ElasticsearchType", # required
|
3389
|
+
# id: "ElasticsearchId", # required
|
3390
|
+
# },
|
3039
3391
|
# },
|
3040
3392
|
# },
|
3041
3393
|
# tags: "String",
|
@@ -3051,6 +3403,13 @@ module Aws::IoT
|
|
3051
3403
|
# Creates a topic rule destination. The destination must be confirmed
|
3052
3404
|
# prior to use.
|
3053
3405
|
#
|
3406
|
+
# Requires permission to access the [CreateTopicRuleDestination][1]
|
3407
|
+
# action.
|
3408
|
+
#
|
3409
|
+
#
|
3410
|
+
#
|
3411
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3412
|
+
#
|
3054
3413
|
# @option params [required, Types::TopicRuleDestinationConfiguration] :destination_configuration
|
3055
3414
|
# The topic rule destination configuration.
|
3056
3415
|
#
|
@@ -3100,6 +3459,13 @@ module Aws::IoT
|
|
3100
3459
|
# account. Any configuration data you entered is deleted and all audit
|
3101
3460
|
# checks are reset to disabled.
|
3102
3461
|
#
|
3462
|
+
# Requires permission to access the [DeleteAccountAuditConfiguration][1]
|
3463
|
+
# action.
|
3464
|
+
#
|
3465
|
+
#
|
3466
|
+
#
|
3467
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3468
|
+
#
|
3103
3469
|
# @option params [Boolean] :delete_scheduled_audits
|
3104
3470
|
# If true, all scheduled audits are deleted.
|
3105
3471
|
#
|
@@ -3120,6 +3486,12 @@ module Aws::IoT
|
|
3120
3486
|
|
3121
3487
|
# Deletes a Device Defender audit suppression.
|
3122
3488
|
#
|
3489
|
+
# Requires permission to access the [DeleteAuditSuppression][1] action.
|
3490
|
+
#
|
3491
|
+
#
|
3492
|
+
#
|
3493
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3494
|
+
#
|
3123
3495
|
# @option params [required, String] :check_name
|
3124
3496
|
# An audit check name. Checks must be enabled for your account. (Use
|
3125
3497
|
# `DescribeAccountAuditConfiguration` to see the list of all checks,
|
@@ -3159,6 +3531,12 @@ module Aws::IoT
|
|
3159
3531
|
|
3160
3532
|
# Deletes an authorizer.
|
3161
3533
|
#
|
3534
|
+
# Requires permission to access the [DeleteAuthorizer][1] action.
|
3535
|
+
#
|
3536
|
+
#
|
3537
|
+
#
|
3538
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3539
|
+
#
|
3162
3540
|
# @option params [required, String] :authorizer_name
|
3163
3541
|
# The name of the authorizer to delete.
|
3164
3542
|
#
|
@@ -3179,6 +3557,12 @@ module Aws::IoT
|
|
3179
3557
|
|
3180
3558
|
# Deletes the billing group.
|
3181
3559
|
#
|
3560
|
+
# Requires permission to access the [DeleteBillingGroup][1] action.
|
3561
|
+
#
|
3562
|
+
#
|
3563
|
+
#
|
3564
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3565
|
+
#
|
3182
3566
|
# @option params [required, String] :billing_group_name
|
3183
3567
|
# The name of the billing group.
|
3184
3568
|
#
|
@@ -3206,6 +3590,12 @@ module Aws::IoT
|
|
3206
3590
|
|
3207
3591
|
# Deletes a registered CA certificate.
|
3208
3592
|
#
|
3593
|
+
# Requires permission to access the [DeleteCACertificate][1] action.
|
3594
|
+
#
|
3595
|
+
#
|
3596
|
+
#
|
3597
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3598
|
+
#
|
3209
3599
|
# @option params [required, String] :certificate_id
|
3210
3600
|
# The ID of the certificate to delete. (The last part of the certificate
|
3211
3601
|
# ARN contains the certificate ID.)
|
@@ -3229,9 +3619,15 @@ module Aws::IoT
|
|
3229
3619
|
#
|
3230
3620
|
# A certificate cannot be deleted if it has a policy or IoT thing
|
3231
3621
|
# attached to it or if its status is set to ACTIVE. To delete a
|
3232
|
-
# certificate, first use the
|
3233
|
-
#
|
3234
|
-
#
|
3622
|
+
# certificate, first use the DetachPolicy action to detach all policies.
|
3623
|
+
# Next, use the UpdateCertificate action to set the certificate to the
|
3624
|
+
# INACTIVE status.
|
3625
|
+
#
|
3626
|
+
# Requires permission to access the [DeleteCertificate][1] action.
|
3627
|
+
#
|
3628
|
+
#
|
3629
|
+
#
|
3630
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3235
3631
|
#
|
3236
3632
|
# @option params [required, String] :certificate_id
|
3237
3633
|
# The ID of the certificate. (The last part of the certificate ARN
|
@@ -3257,19 +3653,22 @@ module Aws::IoT
|
|
3257
3653
|
req.send_request(options)
|
3258
3654
|
end
|
3259
3655
|
|
3656
|
+
# Deletes a Device Defender detect custom metric.
|
3657
|
+
#
|
3658
|
+
# Requires permission to access the [DeleteCustomMetric][1] action.
|
3659
|
+
#
|
3260
3660
|
# <note markdown="1"> Before you can delete a custom metric, you must first remove the
|
3261
3661
|
# custom metric from all security profiles it's a part of. The security
|
3262
3662
|
# profile associated with the custom metric can be found using the
|
3263
|
-
# [ListSecurityProfiles][
|
3663
|
+
# [ListSecurityProfiles][2] API with `metricName` set to your custom
|
3264
3664
|
# metric name.
|
3265
3665
|
#
|
3266
3666
|
# </note>
|
3267
3667
|
#
|
3268
|
-
# Deletes a Device Defender detect custom metric.
|
3269
|
-
#
|
3270
3668
|
#
|
3271
3669
|
#
|
3272
|
-
# [1]: https://docs.aws.amazon.com/
|
3670
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3671
|
+
# [2]: https://docs.aws.amazon.com/iot/latest/apireference/API_ListSecurityProfiles.html
|
3273
3672
|
#
|
3274
3673
|
# @option params [required, String] :metric_name
|
3275
3674
|
# The name of the custom metric.
|
@@ -3289,10 +3688,17 @@ module Aws::IoT
|
|
3289
3688
|
req.send_request(options)
|
3290
3689
|
end
|
3291
3690
|
|
3292
|
-
# Removes the specified dimension from your
|
3691
|
+
# Removes the specified dimension from your Amazon Web Services
|
3692
|
+
# accounts.
|
3293
3693
|
#
|
3294
|
-
#
|
3295
|
-
#
|
3694
|
+
# Requires permission to access the [DeleteDimension][1] action.
|
3695
|
+
#
|
3696
|
+
#
|
3697
|
+
#
|
3698
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3699
|
+
#
|
3700
|
+
# @option params [required, String] :name
|
3701
|
+
# The unique identifier for the dimension that you want to delete.
|
3296
3702
|
#
|
3297
3703
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3298
3704
|
#
|
@@ -3311,6 +3717,13 @@ module Aws::IoT
|
|
3311
3717
|
|
3312
3718
|
# Deletes the specified domain configuration.
|
3313
3719
|
#
|
3720
|
+
# Requires permission to access the [DeleteDomainConfiguration][1]
|
3721
|
+
# action.
|
3722
|
+
#
|
3723
|
+
#
|
3724
|
+
#
|
3725
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3726
|
+
#
|
3314
3727
|
# @option params [required, String] :domain_configuration_name
|
3315
3728
|
# The name of the domain configuration to be deleted.
|
3316
3729
|
#
|
@@ -3331,6 +3744,12 @@ module Aws::IoT
|
|
3331
3744
|
|
3332
3745
|
# Deletes a dynamic thing group.
|
3333
3746
|
#
|
3747
|
+
# Requires permission to access the [DeleteDynamicThingGroup][1] action.
|
3748
|
+
#
|
3749
|
+
#
|
3750
|
+
#
|
3751
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3752
|
+
#
|
3334
3753
|
# @option params [required, String] :thing_group_name
|
3335
3754
|
# The name of the dynamic thing group to delete.
|
3336
3755
|
#
|
@@ -3353,6 +3772,38 @@ module Aws::IoT
|
|
3353
3772
|
req.send_request(options)
|
3354
3773
|
end
|
3355
3774
|
|
3775
|
+
# Deletes the specified fleet metric. Returns successfully with no error
|
3776
|
+
# if the deletion is successful or you specify a fleet metric that
|
3777
|
+
# doesn't exist.
|
3778
|
+
#
|
3779
|
+
# Requires permission to access the [DeleteFleetMetric][1] action.
|
3780
|
+
#
|
3781
|
+
#
|
3782
|
+
#
|
3783
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3784
|
+
#
|
3785
|
+
# @option params [required, String] :metric_name
|
3786
|
+
# The name of the fleet metric to delete.
|
3787
|
+
#
|
3788
|
+
# @option params [Integer] :expected_version
|
3789
|
+
# The expected version of the fleet metric to delete.
|
3790
|
+
#
|
3791
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3792
|
+
#
|
3793
|
+
# @example Request syntax with placeholder values
|
3794
|
+
#
|
3795
|
+
# resp = client.delete_fleet_metric({
|
3796
|
+
# metric_name: "FleetMetricName", # required
|
3797
|
+
# expected_version: 1,
|
3798
|
+
# })
|
3799
|
+
#
|
3800
|
+
# @overload delete_fleet_metric(params = {})
|
3801
|
+
# @param [Hash] params ({})
|
3802
|
+
def delete_fleet_metric(params = {}, options = {})
|
3803
|
+
req = build_request(:delete_fleet_metric, params)
|
3804
|
+
req.send_request(options)
|
3805
|
+
end
|
3806
|
+
|
3356
3807
|
# Deletes a job and its related job executions.
|
3357
3808
|
#
|
3358
3809
|
# Deleting a job may take time, depending on the number of job
|
@@ -3364,6 +3815,12 @@ module Aws::IoT
|
|
3364
3815
|
# Only 10 jobs may have status "DELETION\_IN\_PROGRESS" at the same
|
3365
3816
|
# time, or a LimitExceededException will occur.
|
3366
3817
|
#
|
3818
|
+
# Requires permission to access the [DeleteJob][1] action.
|
3819
|
+
#
|
3820
|
+
#
|
3821
|
+
#
|
3822
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3823
|
+
#
|
3367
3824
|
# @option params [required, String] :job_id
|
3368
3825
|
# The ID of the job to be deleted.
|
3369
3826
|
#
|
@@ -3388,9 +3845,9 @@ module Aws::IoT
|
|
3388
3845
|
# @option params [String] :namespace_id
|
3389
3846
|
# The namespace used to indicate that a job is a customer-managed job.
|
3390
3847
|
#
|
3391
|
-
# When you specify a value for this parameter,
|
3392
|
-
# notifications to MQTT topics that contain the value in
|
3393
|
-
# format.
|
3848
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
3849
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
3850
|
+
# the following format.
|
3394
3851
|
#
|
3395
3852
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
3396
3853
|
#
|
@@ -3417,6 +3874,12 @@ module Aws::IoT
|
|
3417
3874
|
|
3418
3875
|
# Deletes a job execution.
|
3419
3876
|
#
|
3877
|
+
# Requires permission to access the [DeleteJobExecution][1] action.
|
3878
|
+
#
|
3879
|
+
#
|
3880
|
+
#
|
3881
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3882
|
+
#
|
3420
3883
|
# @option params [required, String] :job_id
|
3421
3884
|
# The ID of the job whose execution on a particular device will be
|
3422
3885
|
# deleted.
|
@@ -3448,9 +3911,9 @@ module Aws::IoT
|
|
3448
3911
|
# @option params [String] :namespace_id
|
3449
3912
|
# The namespace used to indicate that a job is a customer-managed job.
|
3450
3913
|
#
|
3451
|
-
# When you specify a value for this parameter,
|
3452
|
-
# notifications to MQTT topics that contain the value in
|
3453
|
-
# format.
|
3914
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
3915
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
3916
|
+
# the following format.
|
3454
3917
|
#
|
3455
3918
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
3456
3919
|
#
|
@@ -3497,7 +3960,14 @@ module Aws::IoT
|
|
3497
3960
|
req.send_request(options)
|
3498
3961
|
end
|
3499
3962
|
|
3500
|
-
# Deletes a defined mitigation action from your
|
3963
|
+
# Deletes a defined mitigation action from your Amazon Web Services
|
3964
|
+
# accounts.
|
3965
|
+
#
|
3966
|
+
# Requires permission to access the [DeleteMitigationAction][1] action.
|
3967
|
+
#
|
3968
|
+
#
|
3969
|
+
#
|
3970
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3501
3971
|
#
|
3502
3972
|
# @option params [required, String] :action_name
|
3503
3973
|
# The name of the mitigation action that you want to delete.
|
@@ -3519,6 +3989,12 @@ module Aws::IoT
|
|
3519
3989
|
|
3520
3990
|
# Delete an OTA update.
|
3521
3991
|
#
|
3992
|
+
# Requires permission to access the [DeleteOTAUpdate][1] action.
|
3993
|
+
#
|
3994
|
+
#
|
3995
|
+
#
|
3996
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3997
|
+
#
|
3522
3998
|
# @option params [required, String] :ota_update_id
|
3523
3999
|
# The ID of the OTA update to delete.
|
3524
4000
|
#
|
@@ -3528,7 +4004,7 @@ module Aws::IoT
|
|
3528
4004
|
# OTAUpdate is supplied by the user.
|
3529
4005
|
#
|
3530
4006
|
# @option params [Boolean] :force_delete_aws_job
|
3531
|
-
# When true, deletes the
|
4007
|
+
# When true, deletes the IoT job created by the OTAUpdate process even
|
3532
4008
|
# if it is "IN\_PROGRESS". Otherwise, if the job is not in a terminal
|
3533
4009
|
# state ("COMPLETED" or "CANCELED") an exception will occur. The
|
3534
4010
|
# default is false.
|
@@ -3555,14 +4031,26 @@ module Aws::IoT
|
|
3555
4031
|
# A policy cannot be deleted if it has non-default versions or it is
|
3556
4032
|
# attached to any certificate.
|
3557
4033
|
#
|
3558
|
-
# To delete a policy, use the DeletePolicyVersion
|
3559
|
-
# non-default versions of the policy; use the
|
3560
|
-
#
|
3561
|
-
#
|
4034
|
+
# To delete a policy, use the DeletePolicyVersion action to delete all
|
4035
|
+
# non-default versions of the policy; use the DetachPolicy action to
|
4036
|
+
# detach the policy from any certificate; and then use the DeletePolicy
|
4037
|
+
# action to delete the policy.
|
3562
4038
|
#
|
3563
4039
|
# When a policy is deleted using DeletePolicy, its default version is
|
3564
4040
|
# deleted with it.
|
3565
4041
|
#
|
4042
|
+
# <note markdown="1"> Because of the distributed nature of Amazon Web Services, it can take
|
4043
|
+
# up to five minutes after a policy is detached before it's ready to be
|
4044
|
+
# deleted.
|
4045
|
+
#
|
4046
|
+
# </note>
|
4047
|
+
#
|
4048
|
+
# Requires permission to access the [DeletePolicy][1] action.
|
4049
|
+
#
|
4050
|
+
#
|
4051
|
+
#
|
4052
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4053
|
+
#
|
3566
4054
|
# @option params [required, String] :policy_name
|
3567
4055
|
# The name of the policy to delete.
|
3568
4056
|
#
|
@@ -3582,11 +4070,17 @@ module Aws::IoT
|
|
3582
4070
|
end
|
3583
4071
|
|
3584
4072
|
# Deletes the specified version of the specified policy. You cannot
|
3585
|
-
# delete the default version of a policy using this
|
3586
|
-
# default version of a policy, use DeletePolicy. To find out which
|
4073
|
+
# delete the default version of a policy using this action. To delete
|
4074
|
+
# the default version of a policy, use DeletePolicy. To find out which
|
3587
4075
|
# version of a policy is marked as the default version, use
|
3588
4076
|
# ListPolicyVersions.
|
3589
4077
|
#
|
4078
|
+
# Requires permission to access the [DeletePolicyVersion][1] action.
|
4079
|
+
#
|
4080
|
+
#
|
4081
|
+
#
|
4082
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4083
|
+
#
|
3590
4084
|
# @option params [required, String] :policy_name
|
3591
4085
|
# The name of the policy.
|
3592
4086
|
#
|
@@ -3611,6 +4105,13 @@ module Aws::IoT
|
|
3611
4105
|
|
3612
4106
|
# Deletes a fleet provisioning template.
|
3613
4107
|
#
|
4108
|
+
# Requires permission to access the [DeleteProvisioningTemplate][1]
|
4109
|
+
# action.
|
4110
|
+
#
|
4111
|
+
#
|
4112
|
+
#
|
4113
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4114
|
+
#
|
3614
4115
|
# @option params [required, String] :template_name
|
3615
4116
|
# The name of the fleet provision template to delete.
|
3616
4117
|
#
|
@@ -3631,6 +4132,13 @@ module Aws::IoT
|
|
3631
4132
|
|
3632
4133
|
# Deletes a fleet provisioning template version.
|
3633
4134
|
#
|
4135
|
+
# Requires permission to access the
|
4136
|
+
# [DeleteProvisioningTemplateVersion][1] action.
|
4137
|
+
#
|
4138
|
+
#
|
4139
|
+
#
|
4140
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4141
|
+
#
|
3634
4142
|
# @option params [required, String] :template_name
|
3635
4143
|
# The name of the fleet provisioning template version to delete.
|
3636
4144
|
#
|
@@ -3655,6 +4163,12 @@ module Aws::IoT
|
|
3655
4163
|
|
3656
4164
|
# Deletes a CA certificate registration code.
|
3657
4165
|
#
|
4166
|
+
# Requires permission to access the [DeleteRegistrationCode][1] action.
|
4167
|
+
#
|
4168
|
+
#
|
4169
|
+
#
|
4170
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4171
|
+
#
|
3658
4172
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3659
4173
|
#
|
3660
4174
|
# @overload delete_registration_code(params = {})
|
@@ -3666,6 +4180,12 @@ module Aws::IoT
|
|
3666
4180
|
|
3667
4181
|
# Deletes a role alias
|
3668
4182
|
#
|
4183
|
+
# Requires permission to access the [DeleteRoleAlias][1] action.
|
4184
|
+
#
|
4185
|
+
#
|
4186
|
+
#
|
4187
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4188
|
+
#
|
3669
4189
|
# @option params [required, String] :role_alias
|
3670
4190
|
# The role alias to delete.
|
3671
4191
|
#
|
@@ -3686,6 +4206,12 @@ module Aws::IoT
|
|
3686
4206
|
|
3687
4207
|
# Deletes a scheduled audit.
|
3688
4208
|
#
|
4209
|
+
# Requires permission to access the [DeleteScheduledAudit][1] action.
|
4210
|
+
#
|
4211
|
+
#
|
4212
|
+
#
|
4213
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4214
|
+
#
|
3689
4215
|
# @option params [required, String] :scheduled_audit_name
|
3690
4216
|
# The name of the scheduled audit you want to delete.
|
3691
4217
|
#
|
@@ -3706,6 +4232,12 @@ module Aws::IoT
|
|
3706
4232
|
|
3707
4233
|
# Deletes a Device Defender security profile.
|
3708
4234
|
#
|
4235
|
+
# Requires permission to access the [DeleteSecurityProfile][1] action.
|
4236
|
+
#
|
4237
|
+
#
|
4238
|
+
#
|
4239
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4240
|
+
#
|
3709
4241
|
# @option params [required, String] :security_profile_name
|
3710
4242
|
# The name of the security profile to be deleted.
|
3711
4243
|
#
|
@@ -3733,6 +4265,12 @@ module Aws::IoT
|
|
3733
4265
|
|
3734
4266
|
# Deletes a stream.
|
3735
4267
|
#
|
4268
|
+
# Requires permission to access the [DeleteStream][1] action.
|
4269
|
+
#
|
4270
|
+
#
|
4271
|
+
#
|
4272
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4273
|
+
#
|
3736
4274
|
# @option params [required, String] :stream_id
|
3737
4275
|
# The stream ID.
|
3738
4276
|
#
|
@@ -3754,6 +4292,12 @@ module Aws::IoT
|
|
3754
4292
|
# Deletes the specified thing. Returns successfully with no error if the
|
3755
4293
|
# deletion is successful or you specify a thing that doesn't exist.
|
3756
4294
|
#
|
4295
|
+
# Requires permission to access the [DeleteThing][1] action.
|
4296
|
+
#
|
4297
|
+
#
|
4298
|
+
#
|
4299
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4300
|
+
#
|
3757
4301
|
# @option params [required, String] :thing_name
|
3758
4302
|
# The name of the thing to delete.
|
3759
4303
|
#
|
@@ -3781,6 +4325,12 @@ module Aws::IoT
|
|
3781
4325
|
|
3782
4326
|
# Deletes a thing group.
|
3783
4327
|
#
|
4328
|
+
# Requires permission to access the [DeleteThingGroup][1] action.
|
4329
|
+
#
|
4330
|
+
#
|
4331
|
+
#
|
4332
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4333
|
+
#
|
3784
4334
|
# @option params [required, String] :thing_group_name
|
3785
4335
|
# The name of the thing group to delete.
|
3786
4336
|
#
|
@@ -3810,6 +4360,12 @@ module Aws::IoT
|
|
3810
4360
|
# any associated thing, and finally use DeleteThingType to delete the
|
3811
4361
|
# thing type.
|
3812
4362
|
#
|
4363
|
+
# Requires permission to access the [DeleteThingType][1] action.
|
4364
|
+
#
|
4365
|
+
#
|
4366
|
+
#
|
4367
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4368
|
+
#
|
3813
4369
|
# @option params [required, String] :thing_type_name
|
3814
4370
|
# The name of the thing type.
|
3815
4371
|
#
|
@@ -3830,6 +4386,12 @@ module Aws::IoT
|
|
3830
4386
|
|
3831
4387
|
# Deletes the rule.
|
3832
4388
|
#
|
4389
|
+
# Requires permission to access the [DeleteTopicRule][1] action.
|
4390
|
+
#
|
4391
|
+
#
|
4392
|
+
#
|
4393
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4394
|
+
#
|
3833
4395
|
# @option params [required, String] :rule_name
|
3834
4396
|
# The name of the rule.
|
3835
4397
|
#
|
@@ -3850,6 +4412,13 @@ module Aws::IoT
|
|
3850
4412
|
|
3851
4413
|
# Deletes a topic rule destination.
|
3852
4414
|
#
|
4415
|
+
# Requires permission to access the [DeleteTopicRuleDestination][1]
|
4416
|
+
# action.
|
4417
|
+
#
|
4418
|
+
#
|
4419
|
+
#
|
4420
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4421
|
+
#
|
3853
4422
|
# @option params [required, String] :arn
|
3854
4423
|
# The ARN of the topic rule destination to delete.
|
3855
4424
|
#
|
@@ -3870,6 +4439,12 @@ module Aws::IoT
|
|
3870
4439
|
|
3871
4440
|
# Deletes a logging level.
|
3872
4441
|
#
|
4442
|
+
# Requires permission to access the [DeleteV2LoggingLevel][1] action.
|
4443
|
+
#
|
4444
|
+
#
|
4445
|
+
#
|
4446
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4447
|
+
#
|
3873
4448
|
# @option params [required, String] :target_type
|
3874
4449
|
# The type of resource for which you are configuring logging. Must be
|
3875
4450
|
# `THING_Group`.
|
@@ -3896,6 +4471,12 @@ module Aws::IoT
|
|
3896
4471
|
# Deprecates a thing type. You can not associate new things with
|
3897
4472
|
# deprecated thing type.
|
3898
4473
|
#
|
4474
|
+
# Requires permission to access the [DeprecateThingType][1] action.
|
4475
|
+
#
|
4476
|
+
#
|
4477
|
+
#
|
4478
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4479
|
+
#
|
3899
4480
|
# @option params [required, String] :thing_type_name
|
3900
4481
|
# The name of the thing type to deprecate.
|
3901
4482
|
#
|
@@ -3924,6 +4505,13 @@ module Aws::IoT
|
|
3924
4505
|
# account. Settings include how audit notifications are sent and which
|
3925
4506
|
# audit checks are enabled or disabled.
|
3926
4507
|
#
|
4508
|
+
# Requires permission to access the
|
4509
|
+
# [DescribeAccountAuditConfiguration][1] action.
|
4510
|
+
#
|
4511
|
+
#
|
4512
|
+
#
|
4513
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4514
|
+
#
|
3927
4515
|
# @return [Types::DescribeAccountAuditConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3928
4516
|
#
|
3929
4517
|
# * {Types::DescribeAccountAuditConfigurationResponse#role_arn #role_arn} => String
|
@@ -3951,6 +4539,12 @@ module Aws::IoT
|
|
3951
4539
|
# reason for noncompliance, the severity of the issue, and the start
|
3952
4540
|
# time when the audit that returned the finding.
|
3953
4541
|
#
|
4542
|
+
# Requires permission to access the [DescribeAuditFinding][1] action.
|
4543
|
+
#
|
4544
|
+
#
|
4545
|
+
#
|
4546
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4547
|
+
#
|
3954
4548
|
# @option params [required, String] :finding_id
|
3955
4549
|
# A unique identifier for a single audit finding. You can use this
|
3956
4550
|
# identifier to apply mitigation actions to the finding.
|
@@ -4137,6 +4731,12 @@ module Aws::IoT
|
|
4137
4731
|
|
4138
4732
|
# Gets information about a Device Defender audit.
|
4139
4733
|
#
|
4734
|
+
# Requires permission to access the [DescribeAuditTask][1] action.
|
4735
|
+
#
|
4736
|
+
#
|
4737
|
+
#
|
4738
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4739
|
+
#
|
4140
4740
|
# @option params [required, String] :task_id
|
4141
4741
|
# The ID of the audit whose information you want to get.
|
4142
4742
|
#
|
@@ -4186,6 +4786,12 @@ module Aws::IoT
|
|
4186
4786
|
|
4187
4787
|
# Describes an authorizer.
|
4188
4788
|
#
|
4789
|
+
# Requires permission to access the [DescribeAuthorizer][1] action.
|
4790
|
+
#
|
4791
|
+
#
|
4792
|
+
#
|
4793
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4794
|
+
#
|
4189
4795
|
# @option params [required, String] :authorizer_name
|
4190
4796
|
# The name of the authorizer to describe.
|
4191
4797
|
#
|
@@ -4221,6 +4827,12 @@ module Aws::IoT
|
|
4221
4827
|
|
4222
4828
|
# Returns information about a billing group.
|
4223
4829
|
#
|
4830
|
+
# Requires permission to access the [DescribeBillingGroup][1] action.
|
4831
|
+
#
|
4832
|
+
#
|
4833
|
+
#
|
4834
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4835
|
+
#
|
4224
4836
|
# @option params [required, String] :billing_group_name
|
4225
4837
|
# The name of the billing group.
|
4226
4838
|
#
|
@@ -4257,6 +4869,12 @@ module Aws::IoT
|
|
4257
4869
|
|
4258
4870
|
# Describes a registered CA certificate.
|
4259
4871
|
#
|
4872
|
+
# Requires permission to access the [DescribeCACertificate][1] action.
|
4873
|
+
#
|
4874
|
+
#
|
4875
|
+
#
|
4876
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4877
|
+
#
|
4260
4878
|
# @option params [required, String] :certificate_id
|
4261
4879
|
# The CA certificate identifier.
|
4262
4880
|
#
|
@@ -4297,6 +4915,12 @@ module Aws::IoT
|
|
4297
4915
|
|
4298
4916
|
# Gets information about the specified certificate.
|
4299
4917
|
#
|
4918
|
+
# Requires permission to access the [DescribeCertificate][1] action.
|
4919
|
+
#
|
4920
|
+
#
|
4921
|
+
#
|
4922
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4923
|
+
#
|
4300
4924
|
# @option params [required, String] :certificate_id
|
4301
4925
|
# The ID of the certificate. (The last part of the certificate ARN
|
4302
4926
|
# contains the certificate ID.)
|
@@ -4342,6 +4966,12 @@ module Aws::IoT
|
|
4342
4966
|
|
4343
4967
|
# Gets information about a Device Defender detect custom metric.
|
4344
4968
|
#
|
4969
|
+
# Requires permission to access the [DescribeCustomMetric][1] action.
|
4970
|
+
#
|
4971
|
+
#
|
4972
|
+
#
|
4973
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4974
|
+
#
|
4345
4975
|
# @option params [required, String] :metric_name
|
4346
4976
|
# The name of the custom metric.
|
4347
4977
|
#
|
@@ -4378,6 +5008,13 @@ module Aws::IoT
|
|
4378
5008
|
|
4379
5009
|
# Describes the default authorizer.
|
4380
5010
|
#
|
5011
|
+
# Requires permission to access the [DescribeDefaultAuthorizer][1]
|
5012
|
+
# action.
|
5013
|
+
#
|
5014
|
+
#
|
5015
|
+
#
|
5016
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5017
|
+
#
|
4381
5018
|
# @return [Types::DescribeDefaultAuthorizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4382
5019
|
#
|
4383
5020
|
# * {Types::DescribeDefaultAuthorizerResponse#authorizer_description #authorizer_description} => Types::AuthorizerDescription
|
@@ -4404,6 +5041,13 @@ module Aws::IoT
|
|
4404
5041
|
|
4405
5042
|
# Gets information about a Device Defender ML Detect mitigation action.
|
4406
5043
|
#
|
5044
|
+
# Requires permission to access the
|
5045
|
+
# [DescribeDetectMitigationActionsTask][1] action.
|
5046
|
+
#
|
5047
|
+
#
|
5048
|
+
#
|
5049
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5050
|
+
#
|
4407
5051
|
# @option params [required, String] :task_id
|
4408
5052
|
# The unique identifier of the task.
|
4409
5053
|
#
|
@@ -4455,8 +5099,14 @@ module Aws::IoT
|
|
4455
5099
|
req.send_request(options)
|
4456
5100
|
end
|
4457
5101
|
|
4458
|
-
# Provides details about a dimension that is defined in your
|
4459
|
-
#
|
5102
|
+
# Provides details about a dimension that is defined in your Amazon Web
|
5103
|
+
# Services accounts.
|
5104
|
+
#
|
5105
|
+
# Requires permission to access the [DescribeDimension][1] action.
|
5106
|
+
#
|
5107
|
+
#
|
5108
|
+
#
|
5109
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4460
5110
|
#
|
4461
5111
|
# @option params [required, String] :name
|
4462
5112
|
# The unique identifier for the dimension.
|
@@ -4495,6 +5145,13 @@ module Aws::IoT
|
|
4495
5145
|
|
4496
5146
|
# Gets summary information about a domain configuration.
|
4497
5147
|
#
|
5148
|
+
# Requires permission to access the [DescribeDomainConfiguration][1]
|
5149
|
+
# action.
|
5150
|
+
#
|
5151
|
+
#
|
5152
|
+
#
|
5153
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5154
|
+
#
|
4498
5155
|
# @option params [required, String] :domain_configuration_name
|
4499
5156
|
# The name of the domain configuration.
|
4500
5157
|
#
|
@@ -4539,7 +5196,14 @@ module Aws::IoT
|
|
4539
5196
|
req.send_request(options)
|
4540
5197
|
end
|
4541
5198
|
|
4542
|
-
# Returns a unique endpoint specific to the
|
5199
|
+
# Returns a unique endpoint specific to the Amazon Web Services account
|
5200
|
+
# making the call.
|
5201
|
+
#
|
5202
|
+
# Requires permission to access the [DescribeEndpoint][1] action.
|
5203
|
+
#
|
5204
|
+
#
|
5205
|
+
#
|
5206
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4543
5207
|
#
|
4544
5208
|
# @option params [String] :endpoint_type
|
4545
5209
|
# The endpoint type. Valid endpoint types include:
|
@@ -4554,13 +5218,13 @@ module Aws::IoT
|
|
4554
5218
|
# ^
|
4555
5219
|
# ^
|
4556
5220
|
#
|
4557
|
-
# * `iot:CredentialProvider` - Returns an
|
4558
|
-
#
|
5221
|
+
# * `iot:CredentialProvider` - Returns an IoT credentials provider API
|
5222
|
+
# endpoint.
|
4559
5223
|
#
|
4560
5224
|
# ^
|
4561
5225
|
# ^
|
4562
5226
|
#
|
4563
|
-
# * `iot:Jobs` - Returns an
|
5227
|
+
# * `iot:Jobs` - Returns an IoT device management Jobs API endpoint.
|
4564
5228
|
#
|
4565
5229
|
# ^
|
4566
5230
|
#
|
@@ -4591,6 +5255,13 @@ module Aws::IoT
|
|
4591
5255
|
|
4592
5256
|
# Describes event configurations.
|
4593
5257
|
#
|
5258
|
+
# Requires permission to access the [DescribeEventConfigurations][1]
|
5259
|
+
# action.
|
5260
|
+
#
|
5261
|
+
#
|
5262
|
+
#
|
5263
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5264
|
+
#
|
4594
5265
|
# @return [Types::DescribeEventConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4595
5266
|
#
|
4596
5267
|
# * {Types::DescribeEventConfigurationsResponse#event_configurations #event_configurations} => Hash<String,Types::Configuration>
|
@@ -4611,8 +5282,72 @@ module Aws::IoT
|
|
4611
5282
|
req.send_request(options)
|
4612
5283
|
end
|
4613
5284
|
|
5285
|
+
# Gets information about the specified fleet metric.
|
5286
|
+
#
|
5287
|
+
# Requires permission to access the [DescribeFleetMetric][1] action.
|
5288
|
+
#
|
5289
|
+
#
|
5290
|
+
#
|
5291
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5292
|
+
#
|
5293
|
+
# @option params [required, String] :metric_name
|
5294
|
+
# The name of the fleet metric to describe.
|
5295
|
+
#
|
5296
|
+
# @return [Types::DescribeFleetMetricResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5297
|
+
#
|
5298
|
+
# * {Types::DescribeFleetMetricResponse#metric_name #metric_name} => String
|
5299
|
+
# * {Types::DescribeFleetMetricResponse#query_string #query_string} => String
|
5300
|
+
# * {Types::DescribeFleetMetricResponse#aggregation_type #aggregation_type} => Types::AggregationType
|
5301
|
+
# * {Types::DescribeFleetMetricResponse#period #period} => Integer
|
5302
|
+
# * {Types::DescribeFleetMetricResponse#aggregation_field #aggregation_field} => String
|
5303
|
+
# * {Types::DescribeFleetMetricResponse#description #description} => String
|
5304
|
+
# * {Types::DescribeFleetMetricResponse#query_version #query_version} => String
|
5305
|
+
# * {Types::DescribeFleetMetricResponse#index_name #index_name} => String
|
5306
|
+
# * {Types::DescribeFleetMetricResponse#creation_date #creation_date} => Time
|
5307
|
+
# * {Types::DescribeFleetMetricResponse#last_modified_date #last_modified_date} => Time
|
5308
|
+
# * {Types::DescribeFleetMetricResponse#unit #unit} => String
|
5309
|
+
# * {Types::DescribeFleetMetricResponse#version #version} => Integer
|
5310
|
+
# * {Types::DescribeFleetMetricResponse#metric_arn #metric_arn} => String
|
5311
|
+
#
|
5312
|
+
# @example Request syntax with placeholder values
|
5313
|
+
#
|
5314
|
+
# resp = client.describe_fleet_metric({
|
5315
|
+
# metric_name: "FleetMetricName", # required
|
5316
|
+
# })
|
5317
|
+
#
|
5318
|
+
# @example Response structure
|
5319
|
+
#
|
5320
|
+
# resp.metric_name #=> String
|
5321
|
+
# resp.query_string #=> String
|
5322
|
+
# resp.aggregation_type.name #=> String, one of "Statistics", "Percentiles", "Cardinality"
|
5323
|
+
# resp.aggregation_type.values #=> Array
|
5324
|
+
# resp.aggregation_type.values[0] #=> String
|
5325
|
+
# resp.period #=> Integer
|
5326
|
+
# resp.aggregation_field #=> String
|
5327
|
+
# resp.description #=> String
|
5328
|
+
# resp.query_version #=> String
|
5329
|
+
# resp.index_name #=> String
|
5330
|
+
# resp.creation_date #=> Time
|
5331
|
+
# resp.last_modified_date #=> Time
|
5332
|
+
# resp.unit #=> String, one of "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
|
5333
|
+
# resp.version #=> Integer
|
5334
|
+
# resp.metric_arn #=> String
|
5335
|
+
#
|
5336
|
+
# @overload describe_fleet_metric(params = {})
|
5337
|
+
# @param [Hash] params ({})
|
5338
|
+
def describe_fleet_metric(params = {}, options = {})
|
5339
|
+
req = build_request(:describe_fleet_metric, params)
|
5340
|
+
req.send_request(options)
|
5341
|
+
end
|
5342
|
+
|
4614
5343
|
# Describes a search index.
|
4615
5344
|
#
|
5345
|
+
# Requires permission to access the [DescribeIndex][1] action.
|
5346
|
+
#
|
5347
|
+
#
|
5348
|
+
#
|
5349
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5350
|
+
#
|
4616
5351
|
# @option params [required, String] :index_name
|
4617
5352
|
# The index name.
|
4618
5353
|
#
|
@@ -4643,6 +5378,12 @@ module Aws::IoT
|
|
4643
5378
|
|
4644
5379
|
# Describes a job.
|
4645
5380
|
#
|
5381
|
+
# Requires permission to access the [DescribeJob][1] action.
|
5382
|
+
#
|
5383
|
+
#
|
5384
|
+
#
|
5385
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5386
|
+
#
|
4646
5387
|
# @option params [required, String] :job_id
|
4647
5388
|
# The unique identifier you assigned to this job when it was created.
|
4648
5389
|
#
|
@@ -4708,6 +5449,12 @@ module Aws::IoT
|
|
4708
5449
|
|
4709
5450
|
# Describes a job execution.
|
4710
5451
|
#
|
5452
|
+
# Requires permission to access the [DescribeJobExecution][1] action.
|
5453
|
+
#
|
5454
|
+
#
|
5455
|
+
#
|
5456
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5457
|
+
#
|
4711
5458
|
# @option params [required, String] :job_id
|
4712
5459
|
# The unique identifier you assigned to this job when it was created.
|
4713
5460
|
#
|
@@ -4807,6 +5554,13 @@ module Aws::IoT
|
|
4807
5554
|
|
4808
5555
|
# Gets information about a mitigation action.
|
4809
5556
|
#
|
5557
|
+
# Requires permission to access the [DescribeMitigationAction][1]
|
5558
|
+
# action.
|
5559
|
+
#
|
5560
|
+
#
|
5561
|
+
#
|
5562
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5563
|
+
#
|
4810
5564
|
# @option params [required, String] :action_name
|
4811
5565
|
# The friendly name that uniquely identifies the mitigation action.
|
4812
5566
|
#
|
@@ -4855,6 +5609,13 @@ module Aws::IoT
|
|
4855
5609
|
|
4856
5610
|
# Returns information about a fleet provisioning template.
|
4857
5611
|
#
|
5612
|
+
# Requires permission to access the [DescribeProvisioningTemplate][1]
|
5613
|
+
# action.
|
5614
|
+
#
|
5615
|
+
#
|
5616
|
+
#
|
5617
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5618
|
+
#
|
4858
5619
|
# @option params [required, String] :template_name
|
4859
5620
|
# The name of the fleet provisioning template.
|
4860
5621
|
#
|
@@ -4900,6 +5661,13 @@ module Aws::IoT
|
|
4900
5661
|
|
4901
5662
|
# Returns information about a fleet provisioning template version.
|
4902
5663
|
#
|
5664
|
+
# Requires permission to access the
|
5665
|
+
# [DescribeProvisioningTemplateVersion][1] action.
|
5666
|
+
#
|
5667
|
+
#
|
5668
|
+
#
|
5669
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5670
|
+
#
|
4903
5671
|
# @option params [required, String] :template_name
|
4904
5672
|
# The template name.
|
4905
5673
|
#
|
@@ -4936,6 +5704,12 @@ module Aws::IoT
|
|
4936
5704
|
|
4937
5705
|
# Describes a role alias.
|
4938
5706
|
#
|
5707
|
+
# Requires permission to access the [DescribeRoleAlias][1] action.
|
5708
|
+
#
|
5709
|
+
#
|
5710
|
+
#
|
5711
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5712
|
+
#
|
4939
5713
|
# @option params [required, String] :role_alias
|
4940
5714
|
# The role alias to describe.
|
4941
5715
|
#
|
@@ -4968,6 +5742,12 @@ module Aws::IoT
|
|
4968
5742
|
|
4969
5743
|
# Gets information about a scheduled audit.
|
4970
5744
|
#
|
5745
|
+
# Requires permission to access the [DescribeScheduledAudit][1] action.
|
5746
|
+
#
|
5747
|
+
#
|
5748
|
+
#
|
5749
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5750
|
+
#
|
4971
5751
|
# @option params [required, String] :scheduled_audit_name
|
4972
5752
|
# The name of the scheduled audit whose information you want to get.
|
4973
5753
|
#
|
@@ -5005,6 +5785,12 @@ module Aws::IoT
|
|
5005
5785
|
|
5006
5786
|
# Gets information about a Device Defender security profile.
|
5007
5787
|
#
|
5788
|
+
# Requires permission to access the [DescribeSecurityProfile][1] action.
|
5789
|
+
#
|
5790
|
+
#
|
5791
|
+
#
|
5792
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5793
|
+
#
|
5008
5794
|
# @option params [required, String] :security_profile_name
|
5009
5795
|
# The name of the security profile whose information you want to get.
|
5010
5796
|
#
|
@@ -5076,6 +5862,12 @@ module Aws::IoT
|
|
5076
5862
|
|
5077
5863
|
# Gets information about a stream.
|
5078
5864
|
#
|
5865
|
+
# Requires permission to access the [DescribeStream][1] action.
|
5866
|
+
#
|
5867
|
+
#
|
5868
|
+
#
|
5869
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5870
|
+
#
|
5079
5871
|
# @option params [required, String] :stream_id
|
5080
5872
|
# The stream ID.
|
5081
5873
|
#
|
@@ -5113,6 +5905,12 @@ module Aws::IoT
|
|
5113
5905
|
|
5114
5906
|
# Gets information about the specified thing.
|
5115
5907
|
#
|
5908
|
+
# Requires permission to access the [DescribeThing][1] action.
|
5909
|
+
#
|
5910
|
+
#
|
5911
|
+
#
|
5912
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5913
|
+
#
|
5116
5914
|
# @option params [required, String] :thing_name
|
5117
5915
|
# The name of the thing.
|
5118
5916
|
#
|
@@ -5154,6 +5952,12 @@ module Aws::IoT
|
|
5154
5952
|
|
5155
5953
|
# Describe a thing group.
|
5156
5954
|
#
|
5955
|
+
# Requires permission to access the [DescribeThingGroup][1] action.
|
5956
|
+
#
|
5957
|
+
#
|
5958
|
+
#
|
5959
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5960
|
+
#
|
5157
5961
|
# @option params [required, String] :thing_group_name
|
5158
5962
|
# The name of the thing group.
|
5159
5963
|
#
|
@@ -5205,6 +6009,13 @@ module Aws::IoT
|
|
5205
6009
|
|
5206
6010
|
# Describes a bulk thing provisioning task.
|
5207
6011
|
#
|
6012
|
+
# Requires permission to access the [DescribeThingRegistrationTask][1]
|
6013
|
+
# action.
|
6014
|
+
#
|
6015
|
+
#
|
6016
|
+
#
|
6017
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6018
|
+
#
|
5208
6019
|
# @option params [required, String] :task_id
|
5209
6020
|
# The task ID.
|
5210
6021
|
#
|
@@ -5253,6 +6064,12 @@ module Aws::IoT
|
|
5253
6064
|
|
5254
6065
|
# Gets information about the specified thing type.
|
5255
6066
|
#
|
6067
|
+
# Requires permission to access the [DescribeThingType][1] action.
|
6068
|
+
#
|
6069
|
+
#
|
6070
|
+
#
|
6071
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6072
|
+
#
|
5256
6073
|
# @option params [required, String] :thing_type_name
|
5257
6074
|
# The name of the thing type.
|
5258
6075
|
#
|
@@ -5291,6 +6108,18 @@ module Aws::IoT
|
|
5291
6108
|
|
5292
6109
|
# Detaches a policy from the specified target.
|
5293
6110
|
#
|
6111
|
+
# <note markdown="1"> Because of the distributed nature of Amazon Web Services, it can take
|
6112
|
+
# up to five minutes after a policy is detached before it's ready to be
|
6113
|
+
# deleted.
|
6114
|
+
#
|
6115
|
+
# </note>
|
6116
|
+
#
|
6117
|
+
# Requires permission to access the [DetachPolicy][1] action.
|
6118
|
+
#
|
6119
|
+
#
|
6120
|
+
#
|
6121
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6122
|
+
#
|
5294
6123
|
# @option params [required, String] :policy_name
|
5295
6124
|
# The policy to detach.
|
5296
6125
|
#
|
@@ -5315,7 +6144,15 @@ module Aws::IoT
|
|
5315
6144
|
|
5316
6145
|
# Removes the specified policy from the specified certificate.
|
5317
6146
|
#
|
5318
|
-
#
|
6147
|
+
# <note markdown="1"> This action is deprecated. Please use DetachPolicy instead.
|
6148
|
+
#
|
6149
|
+
# </note>
|
6150
|
+
#
|
6151
|
+
# Requires permission to access the [DetachPrincipalPolicy][1] action.
|
6152
|
+
#
|
6153
|
+
#
|
6154
|
+
#
|
6155
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5319
6156
|
#
|
5320
6157
|
# @option params [required, String] :policy_name
|
5321
6158
|
# The name of the policy to detach.
|
@@ -5348,6 +6185,12 @@ module Aws::IoT
|
|
5348
6185
|
# Disassociates a Device Defender security profile from a thing group or
|
5349
6186
|
# from this account.
|
5350
6187
|
#
|
6188
|
+
# Requires permission to access the [DetachSecurityProfile][1] action.
|
6189
|
+
#
|
6190
|
+
#
|
6191
|
+
#
|
6192
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6193
|
+
#
|
5351
6194
|
# @option params [required, String] :security_profile_name
|
5352
6195
|
# The security profile that is detached.
|
5353
6196
|
#
|
@@ -5380,6 +6223,12 @@ module Aws::IoT
|
|
5380
6223
|
#
|
5381
6224
|
# </note>
|
5382
6225
|
#
|
6226
|
+
# Requires permission to access the [DetachThingPrincipal][1] action.
|
6227
|
+
#
|
6228
|
+
#
|
6229
|
+
#
|
6230
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6231
|
+
#
|
5383
6232
|
# @option params [required, String] :thing_name
|
5384
6233
|
# The name of the thing.
|
5385
6234
|
#
|
@@ -5406,6 +6255,12 @@ module Aws::IoT
|
|
5406
6255
|
|
5407
6256
|
# Disables the rule.
|
5408
6257
|
#
|
6258
|
+
# Requires permission to access the [DisableTopicRule][1] action.
|
6259
|
+
#
|
6260
|
+
#
|
6261
|
+
#
|
6262
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6263
|
+
#
|
5409
6264
|
# @option params [required, String] :rule_name
|
5410
6265
|
# The name of the rule to disable.
|
5411
6266
|
#
|
@@ -5426,6 +6281,12 @@ module Aws::IoT
|
|
5426
6281
|
|
5427
6282
|
# Enables the rule.
|
5428
6283
|
#
|
6284
|
+
# Requires permission to access the [EnableTopicRule][1] action.
|
6285
|
+
#
|
6286
|
+
#
|
6287
|
+
#
|
6288
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6289
|
+
#
|
5429
6290
|
# @option params [required, String] :rule_name
|
5430
6291
|
# The name of the topic rule to enable.
|
5431
6292
|
#
|
@@ -5447,6 +6308,13 @@ module Aws::IoT
|
|
5447
6308
|
# Returns a Device Defender's ML Detect Security Profile training
|
5448
6309
|
# model's status.
|
5449
6310
|
#
|
6311
|
+
# Requires permission to access the
|
6312
|
+
# [GetBehaviorModelTrainingSummaries][1] action.
|
6313
|
+
#
|
6314
|
+
#
|
6315
|
+
#
|
6316
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6317
|
+
#
|
5450
6318
|
# @option params [String] :security_profile_name
|
5451
6319
|
# The name of the security profile.
|
5452
6320
|
#
|
@@ -5490,13 +6358,77 @@ module Aws::IoT
|
|
5490
6358
|
req.send_request(options)
|
5491
6359
|
end
|
5492
6360
|
|
6361
|
+
# Aggregates on indexed data with search queries pertaining to
|
6362
|
+
# particular fields.
|
6363
|
+
#
|
6364
|
+
# Requires permission to access the [GetBucketsAggregation][1] action.
|
6365
|
+
#
|
6366
|
+
#
|
6367
|
+
#
|
6368
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6369
|
+
#
|
6370
|
+
# @option params [String] :index_name
|
6371
|
+
# The name of the index to search.
|
6372
|
+
#
|
6373
|
+
# @option params [required, String] :query_string
|
6374
|
+
# The search query string.
|
6375
|
+
#
|
6376
|
+
# @option params [required, String] :aggregation_field
|
6377
|
+
# The aggregation field.
|
6378
|
+
#
|
6379
|
+
# @option params [String] :query_version
|
6380
|
+
# The version of the query.
|
6381
|
+
#
|
6382
|
+
# @option params [required, Types::BucketsAggregationType] :buckets_aggregation_type
|
6383
|
+
# The basic control of the response shape and the bucket aggregation
|
6384
|
+
# type to perform.
|
6385
|
+
#
|
6386
|
+
# @return [Types::GetBucketsAggregationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6387
|
+
#
|
6388
|
+
# * {Types::GetBucketsAggregationResponse#total_count #total_count} => Integer
|
6389
|
+
# * {Types::GetBucketsAggregationResponse#buckets #buckets} => Array<Types::Bucket>
|
6390
|
+
#
|
6391
|
+
# @example Request syntax with placeholder values
|
6392
|
+
#
|
6393
|
+
# resp = client.get_buckets_aggregation({
|
6394
|
+
# index_name: "IndexName",
|
6395
|
+
# query_string: "QueryString", # required
|
6396
|
+
# aggregation_field: "AggregationField", # required
|
6397
|
+
# query_version: "QueryVersion",
|
6398
|
+
# buckets_aggregation_type: { # required
|
6399
|
+
# terms_aggregation: {
|
6400
|
+
# max_buckets: 1,
|
6401
|
+
# },
|
6402
|
+
# },
|
6403
|
+
# })
|
6404
|
+
#
|
6405
|
+
# @example Response structure
|
6406
|
+
#
|
6407
|
+
# resp.total_count #=> Integer
|
6408
|
+
# resp.buckets #=> Array
|
6409
|
+
# resp.buckets[0].key_value #=> String
|
6410
|
+
# resp.buckets[0].count #=> Integer
|
6411
|
+
#
|
6412
|
+
# @overload get_buckets_aggregation(params = {})
|
6413
|
+
# @param [Hash] params ({})
|
6414
|
+
def get_buckets_aggregation(params = {}, options = {})
|
6415
|
+
req = build_request(:get_buckets_aggregation, params)
|
6416
|
+
req.send_request(options)
|
6417
|
+
end
|
6418
|
+
|
5493
6419
|
# Returns the approximate count of unique values that match the query.
|
5494
6420
|
#
|
6421
|
+
# Requires permission to access the [GetCardinality][1] action.
|
6422
|
+
#
|
6423
|
+
#
|
6424
|
+
#
|
6425
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6426
|
+
#
|
5495
6427
|
# @option params [String] :index_name
|
5496
6428
|
# The name of the index to search.
|
5497
6429
|
#
|
5498
6430
|
# @option params [required, String] :query_string
|
5499
|
-
# The search query.
|
6431
|
+
# The search query string.
|
5500
6432
|
#
|
5501
6433
|
# @option params [String] :aggregation_field
|
5502
6434
|
# The field to aggregate.
|
@@ -5529,8 +6461,14 @@ module Aws::IoT
|
|
5529
6461
|
end
|
5530
6462
|
|
5531
6463
|
# Gets a list of the policies that have an effect on the authorization
|
5532
|
-
# behavior of the specified device when it connects to the
|
5533
|
-
#
|
6464
|
+
# behavior of the specified device when it connects to the IoT device
|
6465
|
+
# gateway.
|
6466
|
+
#
|
6467
|
+
# Requires permission to access the [GetEffectivePolicies][1] action.
|
6468
|
+
#
|
6469
|
+
#
|
6470
|
+
#
|
6471
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5534
6472
|
#
|
5535
6473
|
# @option params [String] :principal
|
5536
6474
|
# The principal. Valid principals are CertificateArn
|
@@ -5573,6 +6511,13 @@ module Aws::IoT
|
|
5573
6511
|
|
5574
6512
|
# Gets the indexing configuration.
|
5575
6513
|
#
|
6514
|
+
# Requires permission to access the [GetIndexingConfiguration][1]
|
6515
|
+
# action.
|
6516
|
+
#
|
6517
|
+
#
|
6518
|
+
#
|
6519
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6520
|
+
#
|
5576
6521
|
# @return [Types::GetIndexingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5577
6522
|
#
|
5578
6523
|
# * {Types::GetIndexingConfigurationResponse#thing_indexing_configuration #thing_indexing_configuration} => Types::ThingIndexingConfiguration
|
@@ -5605,6 +6550,12 @@ module Aws::IoT
|
|
5605
6550
|
|
5606
6551
|
# Gets a job document.
|
5607
6552
|
#
|
6553
|
+
# Requires permission to access the [GetJobDocument][1] action.
|
6554
|
+
#
|
6555
|
+
#
|
6556
|
+
#
|
6557
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6558
|
+
#
|
5608
6559
|
# @option params [required, String] :job_id
|
5609
6560
|
# The unique identifier you assigned to this job when it was created.
|
5610
6561
|
#
|
@@ -5634,6 +6585,12 @@ module Aws::IoT
|
|
5634
6585
|
# NOTE: use of this command is not recommended. Use
|
5635
6586
|
# `GetV2LoggingOptions` instead.
|
5636
6587
|
#
|
6588
|
+
# Requires permission to access the [GetLoggingOptions][1] action.
|
6589
|
+
#
|
6590
|
+
#
|
6591
|
+
#
|
6592
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6593
|
+
#
|
5637
6594
|
# @return [Types::GetLoggingOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5638
6595
|
#
|
5639
6596
|
# * {Types::GetLoggingOptionsResponse#role_arn #role_arn} => String
|
@@ -5653,6 +6610,12 @@ module Aws::IoT
|
|
5653
6610
|
|
5654
6611
|
# Gets an OTA update.
|
5655
6612
|
#
|
6613
|
+
# Requires permission to access the [GetOTAUpdate][1] action.
|
6614
|
+
#
|
6615
|
+
#
|
6616
|
+
#
|
6617
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6618
|
+
#
|
5656
6619
|
# @option params [required, String] :ota_update_id
|
5657
6620
|
# The OTA update ID.
|
5658
6621
|
#
|
@@ -5734,11 +6697,17 @@ module Aws::IoT
|
|
5734
6697
|
# approximation, the more values that match the query, the more accurate
|
5735
6698
|
# the percentile values.
|
5736
6699
|
#
|
6700
|
+
# Requires permission to access the [GetPercentiles][1] action.
|
6701
|
+
#
|
6702
|
+
#
|
6703
|
+
#
|
6704
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6705
|
+
#
|
5737
6706
|
# @option params [String] :index_name
|
5738
6707
|
# The name of the index to search.
|
5739
6708
|
#
|
5740
6709
|
# @option params [required, String] :query_string
|
5741
|
-
# The query string.
|
6710
|
+
# The search query string.
|
5742
6711
|
#
|
5743
6712
|
# @option params [String] :aggregation_field
|
5744
6713
|
# The field to aggregate.
|
@@ -5779,6 +6748,12 @@ module Aws::IoT
|
|
5779
6748
|
# Gets information about the specified policy with the policy document
|
5780
6749
|
# of the default version.
|
5781
6750
|
#
|
6751
|
+
# Requires permission to access the [GetPolicy][1] action.
|
6752
|
+
#
|
6753
|
+
#
|
6754
|
+
#
|
6755
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6756
|
+
#
|
5782
6757
|
# @option params [required, String] :policy_name
|
5783
6758
|
# The name of the policy.
|
5784
6759
|
#
|
@@ -5817,6 +6792,12 @@ module Aws::IoT
|
|
5817
6792
|
|
5818
6793
|
# Gets information about the specified policy version.
|
5819
6794
|
#
|
6795
|
+
# Requires permission to access the [GetPolicyVersion][1] action.
|
6796
|
+
#
|
6797
|
+
#
|
6798
|
+
#
|
6799
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6800
|
+
#
|
5820
6801
|
# @option params [required, String] :policy_name
|
5821
6802
|
# The name of the policy.
|
5822
6803
|
#
|
@@ -5859,8 +6840,13 @@ module Aws::IoT
|
|
5859
6840
|
req.send_request(options)
|
5860
6841
|
end
|
5861
6842
|
|
5862
|
-
# Gets a registration code used to register a CA certificate with
|
5863
|
-
#
|
6843
|
+
# Gets a registration code used to register a CA certificate with IoT.
|
6844
|
+
#
|
6845
|
+
# Requires permission to access the [GetRegistrationCode][1] action.
|
6846
|
+
#
|
6847
|
+
#
|
6848
|
+
#
|
6849
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5864
6850
|
#
|
5865
6851
|
# @return [Types::GetRegistrationCodeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5866
6852
|
#
|
@@ -5882,12 +6868,19 @@ module Aws::IoT
|
|
5882
6868
|
# If the aggregation field is of type `String`, only the count statistic
|
5883
6869
|
# is returned.
|
5884
6870
|
#
|
6871
|
+
# Requires permission to access the [GetStatistics][1] action.
|
6872
|
+
#
|
6873
|
+
#
|
6874
|
+
#
|
6875
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6876
|
+
#
|
5885
6877
|
# @option params [String] :index_name
|
5886
6878
|
# The name of the index to search. The default value is `AWS_Things`.
|
5887
6879
|
#
|
5888
6880
|
# @option params [required, String] :query_string
|
5889
6881
|
# The query used to search. You can specify "*" for the query string
|
5890
|
-
# to get the count of all indexed things in your
|
6882
|
+
# to get the count of all indexed things in your Amazon Web Services
|
6883
|
+
# account.
|
5891
6884
|
#
|
5892
6885
|
# @option params [String] :aggregation_field
|
5893
6886
|
# The aggregation field name.
|
@@ -5928,6 +6921,12 @@ module Aws::IoT
|
|
5928
6921
|
|
5929
6922
|
# Gets information about the rule.
|
5930
6923
|
#
|
6924
|
+
# Requires permission to access the [GetTopicRule][1] action.
|
6925
|
+
#
|
6926
|
+
#
|
6927
|
+
#
|
6928
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6929
|
+
#
|
5931
6930
|
# @option params [required, String] :rule_name
|
5932
6931
|
# The name of the rule.
|
5933
6932
|
#
|
@@ -6049,6 +7048,11 @@ module Aws::IoT
|
|
6049
7048
|
# resp.rule.actions[0].kafka.partition #=> String
|
6050
7049
|
# resp.rule.actions[0].kafka.client_properties #=> Hash
|
6051
7050
|
# resp.rule.actions[0].kafka.client_properties["String"] #=> String
|
7051
|
+
# resp.rule.actions[0].open_search.role_arn #=> String
|
7052
|
+
# resp.rule.actions[0].open_search.endpoint #=> String
|
7053
|
+
# resp.rule.actions[0].open_search.index #=> String
|
7054
|
+
# resp.rule.actions[0].open_search.type #=> String
|
7055
|
+
# resp.rule.actions[0].open_search.id #=> String
|
6052
7056
|
# resp.rule.rule_disabled #=> Boolean
|
6053
7057
|
# resp.rule.aws_iot_sql_version #=> String
|
6054
7058
|
# resp.rule.error_action.dynamo_db.table_name #=> String
|
@@ -6150,6 +7154,11 @@ module Aws::IoT
|
|
6150
7154
|
# resp.rule.error_action.kafka.partition #=> String
|
6151
7155
|
# resp.rule.error_action.kafka.client_properties #=> Hash
|
6152
7156
|
# resp.rule.error_action.kafka.client_properties["String"] #=> String
|
7157
|
+
# resp.rule.error_action.open_search.role_arn #=> String
|
7158
|
+
# resp.rule.error_action.open_search.endpoint #=> String
|
7159
|
+
# resp.rule.error_action.open_search.index #=> String
|
7160
|
+
# resp.rule.error_action.open_search.type #=> String
|
7161
|
+
# resp.rule.error_action.open_search.id #=> String
|
6153
7162
|
#
|
6154
7163
|
# @overload get_topic_rule(params = {})
|
6155
7164
|
# @param [Hash] params ({})
|
@@ -6160,6 +7169,12 @@ module Aws::IoT
|
|
6160
7169
|
|
6161
7170
|
# Gets information about a topic rule destination.
|
6162
7171
|
#
|
7172
|
+
# Requires permission to access the [GetTopicRuleDestination][1] action.
|
7173
|
+
#
|
7174
|
+
#
|
7175
|
+
#
|
7176
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7177
|
+
#
|
6163
7178
|
# @option params [required, String] :arn
|
6164
7179
|
# The ARN of the topic rule destination.
|
6165
7180
|
#
|
@@ -6197,6 +7212,12 @@ module Aws::IoT
|
|
6197
7212
|
|
6198
7213
|
# Gets the fine grained logging options.
|
6199
7214
|
#
|
7215
|
+
# Requires permission to access the [GetV2LoggingOptions][1] action.
|
7216
|
+
#
|
7217
|
+
#
|
7218
|
+
#
|
7219
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7220
|
+
#
|
6200
7221
|
# @return [Types::GetV2LoggingOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6201
7222
|
#
|
6202
7223
|
# * {Types::GetV2LoggingOptionsResponse#role_arn #role_arn} => String
|
@@ -6219,6 +7240,12 @@ module Aws::IoT
|
|
6219
7240
|
# Lists the active violations for a given Device Defender security
|
6220
7241
|
# profile.
|
6221
7242
|
#
|
7243
|
+
# Requires permission to access the [ListActiveViolations][1] action.
|
7244
|
+
#
|
7245
|
+
#
|
7246
|
+
#
|
7247
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7248
|
+
#
|
6222
7249
|
# @option params [String] :thing_name
|
6223
7250
|
# The name of the thing whose active violations are listed.
|
6224
7251
|
#
|
@@ -6307,6 +7334,12 @@ module Aws::IoT
|
|
6307
7334
|
|
6308
7335
|
# Lists the policies attached to the specified thing group.
|
6309
7336
|
#
|
7337
|
+
# Requires permission to access the [ListAttachedPolicies][1] action.
|
7338
|
+
#
|
7339
|
+
#
|
7340
|
+
#
|
7341
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7342
|
+
#
|
6310
7343
|
# @option params [required, String] :target
|
6311
7344
|
# The group or principal for which the policies will be listed. Valid
|
6312
7345
|
# principals are CertificateArn
|
@@ -6358,6 +7391,12 @@ module Aws::IoT
|
|
6358
7391
|
# audits performed during a specified time period. (Findings are
|
6359
7392
|
# retained for 90 days.)
|
6360
7393
|
#
|
7394
|
+
# Requires permission to access the [ListAuditFindings][1] action.
|
7395
|
+
#
|
7396
|
+
#
|
7397
|
+
#
|
7398
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7399
|
+
#
|
6361
7400
|
# @option params [String] :task_id
|
6362
7401
|
# A filter to limit results to the audit with the specified ID. You must
|
6363
7402
|
# specify either the taskId or the startTime and endTime, but not both.
|
@@ -6472,6 +7511,13 @@ module Aws::IoT
|
|
6472
7511
|
|
6473
7512
|
# Gets the status of audit mitigation action tasks that were executed.
|
6474
7513
|
#
|
7514
|
+
# Requires permission to access the
|
7515
|
+
# [ListAuditMitigationActionsExecutions][1] action.
|
7516
|
+
#
|
7517
|
+
#
|
7518
|
+
#
|
7519
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7520
|
+
#
|
6475
7521
|
# @option params [required, String] :task_id
|
6476
7522
|
# Specify this filter to limit results to actions for a specific audit
|
6477
7523
|
# mitigation actions task.
|
@@ -6531,6 +7577,13 @@ module Aws::IoT
|
|
6531
7577
|
# Gets a list of audit mitigation action tasks that match the specified
|
6532
7578
|
# filters.
|
6533
7579
|
#
|
7580
|
+
# Requires permission to access the [ListAuditMitigationActionsTasks][1]
|
7581
|
+
# action.
|
7582
|
+
#
|
7583
|
+
#
|
7584
|
+
#
|
7585
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7586
|
+
#
|
6534
7587
|
# @option params [String] :audit_task_id
|
6535
7588
|
# Specify this filter to limit results to tasks that were applied to
|
6536
7589
|
# results for a specific audit.
|
@@ -6594,6 +7647,12 @@ module Aws::IoT
|
|
6594
7647
|
|
6595
7648
|
# Lists your Device Defender audit listings.
|
6596
7649
|
#
|
7650
|
+
# Requires permission to access the [ListAuditSuppressions][1] action.
|
7651
|
+
#
|
7652
|
+
#
|
7653
|
+
#
|
7654
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7655
|
+
#
|
6597
7656
|
# @option params [String] :check_name
|
6598
7657
|
# An audit check name. Checks must be enabled for your account. (Use
|
6599
7658
|
# `DescribeAccountAuditConfiguration` to see the list of all checks,
|
@@ -6672,6 +7731,12 @@ module Aws::IoT
|
|
6672
7731
|
# Lists the Device Defender audits that have been performed during a
|
6673
7732
|
# given time period.
|
6674
7733
|
#
|
7734
|
+
# Requires permission to access the [ListAuditTasks][1] action.
|
7735
|
+
#
|
7736
|
+
#
|
7737
|
+
#
|
7738
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7739
|
+
#
|
6675
7740
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
6676
7741
|
# The beginning of the time period. Audit information is retained for a
|
6677
7742
|
# limited time (90 days). Requesting a start time prior to what is
|
@@ -6731,6 +7796,12 @@ module Aws::IoT
|
|
6731
7796
|
|
6732
7797
|
# Lists the authorizers registered in your account.
|
6733
7798
|
#
|
7799
|
+
# Requires permission to access the [ListAuthorizers][1] action.
|
7800
|
+
#
|
7801
|
+
#
|
7802
|
+
#
|
7803
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7804
|
+
#
|
6734
7805
|
# @option params [Integer] :page_size
|
6735
7806
|
# The maximum number of results to return at one time.
|
6736
7807
|
#
|
@@ -6775,6 +7846,12 @@ module Aws::IoT
|
|
6775
7846
|
|
6776
7847
|
# Lists the billing groups you have created.
|
6777
7848
|
#
|
7849
|
+
# Requires permission to access the [ListBillingGroups][1] action.
|
7850
|
+
#
|
7851
|
+
#
|
7852
|
+
#
|
7853
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7854
|
+
#
|
6778
7855
|
# @option params [String] :next_token
|
6779
7856
|
# To retrieve the next set of results, the `nextToken` value from a
|
6780
7857
|
# previous response; otherwise **null** to receive the first set of
|
@@ -6815,11 +7892,18 @@ module Aws::IoT
|
|
6815
7892
|
req.send_request(options)
|
6816
7893
|
end
|
6817
7894
|
|
6818
|
-
# Lists the CA certificates registered for your
|
7895
|
+
# Lists the CA certificates registered for your Amazon Web Services
|
7896
|
+
# account.
|
6819
7897
|
#
|
6820
7898
|
# The results are paginated with a default page size of 25. You can use
|
6821
7899
|
# the returned marker to retrieve additional results.
|
6822
7900
|
#
|
7901
|
+
# Requires permission to access the [ListCACertificates][1] action.
|
7902
|
+
#
|
7903
|
+
#
|
7904
|
+
#
|
7905
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7906
|
+
#
|
6823
7907
|
# @option params [Integer] :page_size
|
6824
7908
|
# The result page size.
|
6825
7909
|
#
|
@@ -6860,11 +7944,17 @@ module Aws::IoT
|
|
6860
7944
|
req.send_request(options)
|
6861
7945
|
end
|
6862
7946
|
|
6863
|
-
# Lists the certificates registered in your
|
7947
|
+
# Lists the certificates registered in your Amazon Web Services account.
|
6864
7948
|
#
|
6865
7949
|
# The results are paginated with a default page size of 25. You can use
|
6866
7950
|
# the returned marker to retrieve additional results.
|
6867
7951
|
#
|
7952
|
+
# Requires permission to access the [ListCertificates][1] action.
|
7953
|
+
#
|
7954
|
+
#
|
7955
|
+
#
|
7956
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7957
|
+
#
|
6868
7958
|
# @option params [Integer] :page_size
|
6869
7959
|
# The result page size.
|
6870
7960
|
#
|
@@ -6909,6 +7999,12 @@ module Aws::IoT
|
|
6909
7999
|
|
6910
8000
|
# List the device certificates signed by the specified CA certificate.
|
6911
8001
|
#
|
8002
|
+
# Requires permission to access the [ListCertificatesByCA][1] action.
|
8003
|
+
#
|
8004
|
+
#
|
8005
|
+
#
|
8006
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8007
|
+
#
|
6912
8008
|
# @option params [required, String] :ca_certificate_id
|
6913
8009
|
# The ID of the CA certificate. This operation will list all registered
|
6914
8010
|
# device certificate that were signed by this CA certificate.
|
@@ -6958,6 +8054,12 @@ module Aws::IoT
|
|
6958
8054
|
|
6959
8055
|
# Lists your Device Defender detect custom metrics.
|
6960
8056
|
#
|
8057
|
+
# Requires permission to access the [ListCustomMetrics][1] action.
|
8058
|
+
#
|
8059
|
+
#
|
8060
|
+
#
|
8061
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8062
|
+
#
|
6961
8063
|
# @option params [String] :next_token
|
6962
8064
|
# The token for the next set of results.
|
6963
8065
|
#
|
@@ -6995,6 +8097,13 @@ module Aws::IoT
|
|
6995
8097
|
# Lists mitigation actions executions for a Device Defender ML Detect
|
6996
8098
|
# Security Profile.
|
6997
8099
|
#
|
8100
|
+
# Requires permission to access the
|
8101
|
+
# [ListDetectMitigationActionsExecutions][1] action.
|
8102
|
+
#
|
8103
|
+
#
|
8104
|
+
#
|
8105
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8106
|
+
#
|
6998
8107
|
# @option params [String] :task_id
|
6999
8108
|
# The unique identifier of the task.
|
7000
8109
|
#
|
@@ -7062,6 +8171,13 @@ module Aws::IoT
|
|
7062
8171
|
|
7063
8172
|
# List of Device Defender ML Detect mitigation actions tasks.
|
7064
8173
|
#
|
8174
|
+
# Requires permission to access the
|
8175
|
+
# [ListDetectMitigationActionsTasks][1] action.
|
8176
|
+
#
|
8177
|
+
#
|
8178
|
+
#
|
8179
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8180
|
+
#
|
7065
8181
|
# @option params [Integer] :max_results
|
7066
8182
|
# The maximum number of results to return at one time. The default is
|
7067
8183
|
# 25.
|
@@ -7134,7 +8250,14 @@ module Aws::IoT
|
|
7134
8250
|
req.send_request(options)
|
7135
8251
|
end
|
7136
8252
|
|
7137
|
-
# List the set of dimensions that are defined for your
|
8253
|
+
# List the set of dimensions that are defined for your Amazon Web
|
8254
|
+
# Services accounts.
|
8255
|
+
#
|
8256
|
+
# Requires permission to access the [ListDimensions][1] action.
|
8257
|
+
#
|
8258
|
+
#
|
8259
|
+
#
|
8260
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7138
8261
|
#
|
7139
8262
|
# @option params [String] :next_token
|
7140
8263
|
# The token for the next set of results.
|
@@ -7172,6 +8295,13 @@ module Aws::IoT
|
|
7172
8295
|
# Gets a list of domain configurations for the user. This list is sorted
|
7173
8296
|
# alphabetically by domain configuration name.
|
7174
8297
|
#
|
8298
|
+
# Requires permission to access the [ListDomainConfigurations][1]
|
8299
|
+
# action.
|
8300
|
+
#
|
8301
|
+
#
|
8302
|
+
#
|
8303
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8304
|
+
#
|
7175
8305
|
# @option params [String] :marker
|
7176
8306
|
# The marker for the next set of results.
|
7177
8307
|
#
|
@@ -7211,8 +8341,58 @@ module Aws::IoT
|
|
7211
8341
|
req.send_request(options)
|
7212
8342
|
end
|
7213
8343
|
|
8344
|
+
# Lists all your fleet metrics.
|
8345
|
+
#
|
8346
|
+
# Requires permission to access the [ListFleetMetrics][1] action.
|
8347
|
+
#
|
8348
|
+
#
|
8349
|
+
#
|
8350
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8351
|
+
#
|
8352
|
+
# @option params [String] :next_token
|
8353
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
8354
|
+
# previous response; otherwise `null` to receive the first set of
|
8355
|
+
# results.
|
8356
|
+
#
|
8357
|
+
# @option params [Integer] :max_results
|
8358
|
+
# The maximum number of results to return in this operation.
|
8359
|
+
#
|
8360
|
+
# @return [Types::ListFleetMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8361
|
+
#
|
8362
|
+
# * {Types::ListFleetMetricsResponse#fleet_metrics #fleet_metrics} => Array<Types::FleetMetricNameAndArn>
|
8363
|
+
# * {Types::ListFleetMetricsResponse#next_token #next_token} => String
|
8364
|
+
#
|
8365
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8366
|
+
#
|
8367
|
+
# @example Request syntax with placeholder values
|
8368
|
+
#
|
8369
|
+
# resp = client.list_fleet_metrics({
|
8370
|
+
# next_token: "NextToken",
|
8371
|
+
# max_results: 1,
|
8372
|
+
# })
|
8373
|
+
#
|
8374
|
+
# @example Response structure
|
8375
|
+
#
|
8376
|
+
# resp.fleet_metrics #=> Array
|
8377
|
+
# resp.fleet_metrics[0].metric_name #=> String
|
8378
|
+
# resp.fleet_metrics[0].metric_arn #=> String
|
8379
|
+
# resp.next_token #=> String
|
8380
|
+
#
|
8381
|
+
# @overload list_fleet_metrics(params = {})
|
8382
|
+
# @param [Hash] params ({})
|
8383
|
+
def list_fleet_metrics(params = {}, options = {})
|
8384
|
+
req = build_request(:list_fleet_metrics, params)
|
8385
|
+
req.send_request(options)
|
8386
|
+
end
|
8387
|
+
|
7214
8388
|
# Lists the search indices.
|
7215
8389
|
#
|
8390
|
+
# Requires permission to access the [ListIndices][1] action.
|
8391
|
+
#
|
8392
|
+
#
|
8393
|
+
#
|
8394
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8395
|
+
#
|
7216
8396
|
# @option params [String] :next_token
|
7217
8397
|
# The token used to get the next set of results, or `null` if there are
|
7218
8398
|
# no additional results.
|
@@ -7249,6 +8429,12 @@ module Aws::IoT
|
|
7249
8429
|
|
7250
8430
|
# Lists the job executions for a job.
|
7251
8431
|
#
|
8432
|
+
# Requires permission to access the [ListJobExecutionsForJob][1] action.
|
8433
|
+
#
|
8434
|
+
#
|
8435
|
+
#
|
8436
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8437
|
+
#
|
7252
8438
|
# @option params [required, String] :job_id
|
7253
8439
|
# The unique identifier you assigned to this job when it was created.
|
7254
8440
|
#
|
@@ -7297,6 +8483,13 @@ module Aws::IoT
|
|
7297
8483
|
|
7298
8484
|
# Lists the job executions for the specified thing.
|
7299
8485
|
#
|
8486
|
+
# Requires permission to access the [ListJobExecutionsForThing][1]
|
8487
|
+
# action.
|
8488
|
+
#
|
8489
|
+
#
|
8490
|
+
#
|
8491
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8492
|
+
#
|
7300
8493
|
# @option params [required, String] :thing_name
|
7301
8494
|
# The thing name.
|
7302
8495
|
#
|
@@ -7307,9 +8500,9 @@ module Aws::IoT
|
|
7307
8500
|
# @option params [String] :namespace_id
|
7308
8501
|
# The namespace used to indicate that a job is a customer-managed job.
|
7309
8502
|
#
|
7310
|
-
# When you specify a value for this parameter,
|
7311
|
-
# notifications to MQTT topics that contain the value in
|
7312
|
-
# format.
|
8503
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
8504
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
8505
|
+
# the following format.
|
7313
8506
|
#
|
7314
8507
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
7315
8508
|
#
|
@@ -7360,6 +8553,12 @@ module Aws::IoT
|
|
7360
8553
|
|
7361
8554
|
# Returns a list of job templates.
|
7362
8555
|
#
|
8556
|
+
# Requires permission to access the [ListJobTemplates][1] action.
|
8557
|
+
#
|
8558
|
+
#
|
8559
|
+
#
|
8560
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8561
|
+
#
|
7363
8562
|
# @option params [Integer] :max_results
|
7364
8563
|
# The maximum number of results to return in the list.
|
7365
8564
|
#
|
@@ -7371,6 +8570,8 @@ module Aws::IoT
|
|
7371
8570
|
# * {Types::ListJobTemplatesResponse#job_templates #job_templates} => Array<Types::JobTemplateSummary>
|
7372
8571
|
# * {Types::ListJobTemplatesResponse#next_token #next_token} => String
|
7373
8572
|
#
|
8573
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8574
|
+
#
|
7374
8575
|
# @example Request syntax with placeholder values
|
7375
8576
|
#
|
7376
8577
|
# resp = client.list_job_templates({
|
@@ -7396,6 +8597,12 @@ module Aws::IoT
|
|
7396
8597
|
|
7397
8598
|
# Lists jobs.
|
7398
8599
|
#
|
8600
|
+
# Requires permission to access the [ListJobs][1] action.
|
8601
|
+
#
|
8602
|
+
#
|
8603
|
+
#
|
8604
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8605
|
+
#
|
7399
8606
|
# @option params [String] :status
|
7400
8607
|
# An optional filter that lets you search for jobs that have the
|
7401
8608
|
# specified status.
|
@@ -7425,9 +8632,9 @@ module Aws::IoT
|
|
7425
8632
|
# @option params [String] :namespace_id
|
7426
8633
|
# The namespace used to indicate that a job is a customer-managed job.
|
7427
8634
|
#
|
7428
|
-
# When you specify a value for this parameter,
|
7429
|
-
# notifications to MQTT topics that contain the value in
|
7430
|
-
# format.
|
8635
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
8636
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
8637
|
+
# the following format.
|
7431
8638
|
#
|
7432
8639
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
7433
8640
|
#
|
@@ -7477,6 +8684,12 @@ module Aws::IoT
|
|
7477
8684
|
# Gets a list of all mitigation actions that match the specified filter
|
7478
8685
|
# criteria.
|
7479
8686
|
#
|
8687
|
+
# Requires permission to access the [ListMitigationActions][1] action.
|
8688
|
+
#
|
8689
|
+
#
|
8690
|
+
#
|
8691
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8692
|
+
#
|
7480
8693
|
# @option params [String] :action_type
|
7481
8694
|
# Specify a value to limit the result to mitigation actions with a
|
7482
8695
|
# specific action type.
|
@@ -7520,6 +8733,12 @@ module Aws::IoT
|
|
7520
8733
|
|
7521
8734
|
# Lists OTA updates.
|
7522
8735
|
#
|
8736
|
+
# Requires permission to access the [ListOTAUpdates][1] action.
|
8737
|
+
#
|
8738
|
+
#
|
8739
|
+
#
|
8740
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8741
|
+
#
|
7523
8742
|
# @option params [Integer] :max_results
|
7524
8743
|
# The maximum number of results to return at one time.
|
7525
8744
|
#
|
@@ -7561,6 +8780,13 @@ module Aws::IoT
|
|
7561
8780
|
|
7562
8781
|
# Lists certificates that are being transferred but not yet accepted.
|
7563
8782
|
#
|
8783
|
+
# Requires permission to access the [ListOutgoingCertificates][1]
|
8784
|
+
# action.
|
8785
|
+
#
|
8786
|
+
#
|
8787
|
+
#
|
8788
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8789
|
+
#
|
7564
8790
|
# @option params [Integer] :page_size
|
7565
8791
|
# The result page size.
|
7566
8792
|
#
|
@@ -7606,6 +8832,12 @@ module Aws::IoT
|
|
7606
8832
|
|
7607
8833
|
# Lists your policies.
|
7608
8834
|
#
|
8835
|
+
# Requires permission to access the [ListPolicies][1] action.
|
8836
|
+
#
|
8837
|
+
#
|
8838
|
+
#
|
8839
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8840
|
+
#
|
7609
8841
|
# @option params [String] :marker
|
7610
8842
|
# The marker for the next set of results.
|
7611
8843
|
#
|
@@ -7647,9 +8879,15 @@ module Aws::IoT
|
|
7647
8879
|
|
7648
8880
|
# Lists the principals associated with the specified policy.
|
7649
8881
|
#
|
7650
|
-
# **Note:** This
|
8882
|
+
# **Note:** This action is deprecated. Please use ListTargetsForPolicy
|
7651
8883
|
# instead.
|
7652
8884
|
#
|
8885
|
+
# Requires permission to access the [ListPolicyPrincipals][1] action.
|
8886
|
+
#
|
8887
|
+
#
|
8888
|
+
#
|
8889
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8890
|
+
#
|
7653
8891
|
# @option params [required, String] :policy_name
|
7654
8892
|
# The policy name.
|
7655
8893
|
#
|
@@ -7695,6 +8933,12 @@ module Aws::IoT
|
|
7695
8933
|
# Lists the versions of the specified policy and identifies the default
|
7696
8934
|
# version.
|
7697
8935
|
#
|
8936
|
+
# Requires permission to access the [ListPolicyVersions][1] action.
|
8937
|
+
#
|
8938
|
+
#
|
8939
|
+
#
|
8940
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8941
|
+
#
|
7698
8942
|
# @option params [required, String] :policy_name
|
7699
8943
|
# The policy name.
|
7700
8944
|
#
|
@@ -7726,12 +8970,15 @@ module Aws::IoT
|
|
7726
8970
|
# Cognito identity, the ID must be in [AmazonCognito Identity
|
7727
8971
|
# format][1].
|
7728
8972
|
#
|
7729
|
-
# **Note:** This
|
8973
|
+
# **Note:** This action is deprecated. Please use ListAttachedPolicies
|
7730
8974
|
# instead.
|
7731
8975
|
#
|
8976
|
+
# Requires permission to access the [ListPrincipalPolicies][2] action.
|
8977
|
+
#
|
7732
8978
|
#
|
7733
8979
|
#
|
7734
8980
|
# [1]: https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html#API_GetCredentialsForIdentity_RequestSyntax
|
8981
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7735
8982
|
#
|
7736
8983
|
# @option params [required, String] :principal
|
7737
8984
|
# The principal. Valid principals are CertificateArn
|
@@ -7784,6 +9031,12 @@ module Aws::IoT
|
|
7784
9031
|
# can be X.509 certificates, IAM users, groups, and roles, Amazon
|
7785
9032
|
# Cognito identities or federated identities.
|
7786
9033
|
#
|
9034
|
+
# Requires permission to access the [ListPrincipalThings][1] action.
|
9035
|
+
#
|
9036
|
+
#
|
9037
|
+
#
|
9038
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9039
|
+
#
|
7787
9040
|
# @option params [String] :next_token
|
7788
9041
|
# To retrieve the next set of results, the `nextToken` value from a
|
7789
9042
|
# previous response; otherwise **null** to receive the first set of
|
@@ -7825,6 +9078,13 @@ module Aws::IoT
|
|
7825
9078
|
|
7826
9079
|
# A list of fleet provisioning template versions.
|
7827
9080
|
#
|
9081
|
+
# Requires permission to access the
|
9082
|
+
# [ListProvisioningTemplateVersions][1] action.
|
9083
|
+
#
|
9084
|
+
#
|
9085
|
+
#
|
9086
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9087
|
+
#
|
7828
9088
|
# @option params [required, String] :template_name
|
7829
9089
|
# The name of the fleet provisioning template.
|
7830
9090
|
#
|
@@ -7864,7 +9124,15 @@ module Aws::IoT
|
|
7864
9124
|
req.send_request(options)
|
7865
9125
|
end
|
7866
9126
|
|
7867
|
-
# Lists the fleet provisioning templates in your
|
9127
|
+
# Lists the fleet provisioning templates in your Amazon Web Services
|
9128
|
+
# account.
|
9129
|
+
#
|
9130
|
+
# Requires permission to access the [ListProvisioningTemplates][1]
|
9131
|
+
# action.
|
9132
|
+
#
|
9133
|
+
#
|
9134
|
+
#
|
9135
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7868
9136
|
#
|
7869
9137
|
# @option params [Integer] :max_results
|
7870
9138
|
# The maximum number of results to return at one time.
|
@@ -7906,6 +9174,12 @@ module Aws::IoT
|
|
7906
9174
|
|
7907
9175
|
# Lists the role aliases registered in your account.
|
7908
9176
|
#
|
9177
|
+
# Requires permission to access the [ListRoleAliases][1] action.
|
9178
|
+
#
|
9179
|
+
#
|
9180
|
+
#
|
9181
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9182
|
+
#
|
7909
9183
|
# @option params [Integer] :page_size
|
7910
9184
|
# The maximum number of results to return at one time.
|
7911
9185
|
#
|
@@ -7945,6 +9219,12 @@ module Aws::IoT
|
|
7945
9219
|
|
7946
9220
|
# Lists all of your scheduled audits.
|
7947
9221
|
#
|
9222
|
+
# Requires permission to access the [ListScheduledAudits][1] action.
|
9223
|
+
#
|
9224
|
+
#
|
9225
|
+
#
|
9226
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9227
|
+
#
|
7948
9228
|
# @option params [String] :next_token
|
7949
9229
|
# The token for the next set of results.
|
7950
9230
|
#
|
@@ -7986,10 +9266,16 @@ module Aws::IoT
|
|
7986
9266
|
# Lists the Device Defender security profiles you've created. You can
|
7987
9267
|
# filter security profiles by dimension or custom metric.
|
7988
9268
|
#
|
9269
|
+
# Requires permission to access the [ListSecurityProfiles][1] action.
|
9270
|
+
#
|
7989
9271
|
# <note markdown="1"> `dimensionName` and `metricName` cannot be used in the same request.
|
7990
9272
|
#
|
7991
9273
|
# </note>
|
7992
9274
|
#
|
9275
|
+
#
|
9276
|
+
#
|
9277
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9278
|
+
#
|
7993
9279
|
# @option params [String] :next_token
|
7994
9280
|
# The token for the next set of results.
|
7995
9281
|
#
|
@@ -8036,6 +9322,13 @@ module Aws::IoT
|
|
8036
9322
|
# Lists the Device Defender security profiles attached to a target
|
8037
9323
|
# (thing group).
|
8038
9324
|
#
|
9325
|
+
# Requires permission to access the [ListSecurityProfilesForTarget][1]
|
9326
|
+
# action.
|
9327
|
+
#
|
9328
|
+
#
|
9329
|
+
#
|
9330
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9331
|
+
#
|
8039
9332
|
# @option params [String] :next_token
|
8040
9333
|
# The token for the next set of results.
|
8041
9334
|
#
|
@@ -8080,7 +9373,13 @@ module Aws::IoT
|
|
8080
9373
|
req.send_request(options)
|
8081
9374
|
end
|
8082
9375
|
|
8083
|
-
# Lists all of the streams in your
|
9376
|
+
# Lists all of the streams in your Amazon Web Services account.
|
9377
|
+
#
|
9378
|
+
# Requires permission to access the [ListStreams][1] action.
|
9379
|
+
#
|
9380
|
+
#
|
9381
|
+
#
|
9382
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8084
9383
|
#
|
8085
9384
|
# @option params [Integer] :max_results
|
8086
9385
|
# The maximum number of results to return at a time.
|
@@ -8124,6 +9423,12 @@ module Aws::IoT
|
|
8124
9423
|
|
8125
9424
|
# Lists the tags (metadata) you have assigned to the resource.
|
8126
9425
|
#
|
9426
|
+
# Requires permission to access the [ListTagsForResource][1] action.
|
9427
|
+
#
|
9428
|
+
#
|
9429
|
+
#
|
9430
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9431
|
+
#
|
8127
9432
|
# @option params [required, String] :resource_arn
|
8128
9433
|
# The ARN of the resource.
|
8129
9434
|
#
|
@@ -8162,6 +9467,12 @@ module Aws::IoT
|
|
8162
9467
|
|
8163
9468
|
# List targets for the specified policy.
|
8164
9469
|
#
|
9470
|
+
# Requires permission to access the [ListTargetsForPolicy][1] action.
|
9471
|
+
#
|
9472
|
+
#
|
9473
|
+
#
|
9474
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9475
|
+
#
|
8165
9476
|
# @option params [required, String] :policy_name
|
8166
9477
|
# The policy name.
|
8167
9478
|
#
|
@@ -8202,6 +9513,13 @@ module Aws::IoT
|
|
8202
9513
|
# Lists the targets (thing groups) associated with a given Device
|
8203
9514
|
# Defender security profile.
|
8204
9515
|
#
|
9516
|
+
# Requires permission to access the [ListTargetsForSecurityProfile][1]
|
9517
|
+
# action.
|
9518
|
+
#
|
9519
|
+
#
|
9520
|
+
#
|
9521
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9522
|
+
#
|
8205
9523
|
# @option params [required, String] :security_profile_name
|
8206
9524
|
# The security profile.
|
8207
9525
|
#
|
@@ -8241,6 +9559,12 @@ module Aws::IoT
|
|
8241
9559
|
|
8242
9560
|
# List the thing groups in your account.
|
8243
9561
|
#
|
9562
|
+
# Requires permission to access the [ListThingGroups][1] action.
|
9563
|
+
#
|
9564
|
+
#
|
9565
|
+
#
|
9566
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9567
|
+
#
|
8244
9568
|
# @option params [String] :next_token
|
8245
9569
|
# To retrieve the next set of results, the `nextToken` value from a
|
8246
9570
|
# previous response; otherwise **null** to receive the first set of
|
@@ -8293,6 +9617,12 @@ module Aws::IoT
|
|
8293
9617
|
|
8294
9618
|
# List the thing groups to which the specified thing belongs.
|
8295
9619
|
#
|
9620
|
+
# Requires permission to access the [ListThingGroupsForThing][1] action.
|
9621
|
+
#
|
9622
|
+
#
|
9623
|
+
#
|
9624
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9625
|
+
#
|
8296
9626
|
# @option params [required, String] :thing_name
|
8297
9627
|
# The thing name.
|
8298
9628
|
#
|
@@ -8337,6 +9667,12 @@ module Aws::IoT
|
|
8337
9667
|
# can be X.509 certificates, IAM users, groups, and roles, Amazon
|
8338
9668
|
# Cognito identities or federated identities.
|
8339
9669
|
#
|
9670
|
+
# Requires permission to access the [ListThingPrincipals][1] action.
|
9671
|
+
#
|
9672
|
+
#
|
9673
|
+
#
|
9674
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9675
|
+
#
|
8340
9676
|
# @option params [String] :next_token
|
8341
9677
|
# To retrieve the next set of results, the `nextToken` value from a
|
8342
9678
|
# previous response; otherwise **null** to receive the first set of
|
@@ -8425,6 +9761,13 @@ module Aws::IoT
|
|
8425
9761
|
|
8426
9762
|
# List bulk thing provisioning tasks.
|
8427
9763
|
#
|
9764
|
+
# Requires permission to access the [ListThingRegistrationTasks][1]
|
9765
|
+
# action.
|
9766
|
+
#
|
9767
|
+
#
|
9768
|
+
#
|
9769
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9770
|
+
#
|
8428
9771
|
# @option params [String] :next_token
|
8429
9772
|
# To retrieve the next set of results, the `nextToken` value from a
|
8430
9773
|
# previous response; otherwise **null** to receive the first set of
|
@@ -8466,6 +9809,12 @@ module Aws::IoT
|
|
8466
9809
|
|
8467
9810
|
# Lists the existing thing types.
|
8468
9811
|
#
|
9812
|
+
# Requires permission to access the [ListThingTypes][1] action.
|
9813
|
+
#
|
9814
|
+
#
|
9815
|
+
#
|
9816
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9817
|
+
#
|
8469
9818
|
# @option params [String] :next_token
|
8470
9819
|
# To retrieve the next set of results, the `nextToken` value from a
|
8471
9820
|
# previous response; otherwise **null** to receive the first set of
|
@@ -8518,6 +9867,8 @@ module Aws::IoT
|
|
8518
9867
|
# in the registry that contain an attribute **Color** with the value
|
8519
9868
|
# **Red**.
|
8520
9869
|
#
|
9870
|
+
# Requires permission to access the [ListThings][1] action.
|
9871
|
+
#
|
8521
9872
|
# <note markdown="1"> You will not be charged for calling this API if an `Access denied`
|
8522
9873
|
# error is returned. You will also not be charged if no attributes or
|
8523
9874
|
# pagination token was provided in request and no pagination token and
|
@@ -8525,6 +9876,10 @@ module Aws::IoT
|
|
8525
9876
|
#
|
8526
9877
|
# </note>
|
8527
9878
|
#
|
9879
|
+
#
|
9880
|
+
#
|
9881
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9882
|
+
#
|
8528
9883
|
# @option params [String] :next_token
|
8529
9884
|
# To retrieve the next set of results, the `nextToken` value from a
|
8530
9885
|
# previous response; otherwise **null** to receive the first set of
|
@@ -8588,6 +9943,13 @@ module Aws::IoT
|
|
8588
9943
|
|
8589
9944
|
# Lists the things you have added to the given billing group.
|
8590
9945
|
#
|
9946
|
+
# Requires permission to access the [ListThingsInBillingGroup][1]
|
9947
|
+
# action.
|
9948
|
+
#
|
9949
|
+
#
|
9950
|
+
#
|
9951
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9952
|
+
#
|
8591
9953
|
# @option params [required, String] :billing_group_name
|
8592
9954
|
# The name of the billing group.
|
8593
9955
|
#
|
@@ -8629,6 +9991,12 @@ module Aws::IoT
|
|
8629
9991
|
|
8630
9992
|
# Lists the things in the specified group.
|
8631
9993
|
#
|
9994
|
+
# Requires permission to access the [ListThingsInThingGroup][1] action.
|
9995
|
+
#
|
9996
|
+
#
|
9997
|
+
#
|
9998
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9999
|
+
#
|
8632
10000
|
# @option params [required, String] :thing_group_name
|
8633
10001
|
# The thing group name.
|
8634
10002
|
#
|
@@ -8673,7 +10041,15 @@ module Aws::IoT
|
|
8673
10041
|
req.send_request(options)
|
8674
10042
|
end
|
8675
10043
|
|
8676
|
-
# Lists all the topic rule destinations in your
|
10044
|
+
# Lists all the topic rule destinations in your Amazon Web Services
|
10045
|
+
# account.
|
10046
|
+
#
|
10047
|
+
# Requires permission to access the [ListTopicRuleDestinations][1]
|
10048
|
+
# action.
|
10049
|
+
#
|
10050
|
+
#
|
10051
|
+
#
|
10052
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8677
10053
|
#
|
8678
10054
|
# @option params [Integer] :max_results
|
8679
10055
|
# The maximum number of results to return at one time.
|
@@ -8723,6 +10099,12 @@ module Aws::IoT
|
|
8723
10099
|
|
8724
10100
|
# Lists the rules for the specific topic.
|
8725
10101
|
#
|
10102
|
+
# Requires permission to access the [ListTopicRules][1] action.
|
10103
|
+
#
|
10104
|
+
#
|
10105
|
+
#
|
10106
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10107
|
+
#
|
8726
10108
|
# @option params [String] :topic
|
8727
10109
|
# The topic.
|
8728
10110
|
#
|
@@ -8772,6 +10154,12 @@ module Aws::IoT
|
|
8772
10154
|
|
8773
10155
|
# Lists logging levels.
|
8774
10156
|
#
|
10157
|
+
# Requires permission to access the [ListV2LoggingLevels][1] action.
|
10158
|
+
#
|
10159
|
+
#
|
10160
|
+
#
|
10161
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10162
|
+
#
|
8775
10163
|
# @option params [String] :target_type
|
8776
10164
|
# The type of resource for which you are configuring logging. Must be
|
8777
10165
|
# `THING_Group`.
|
@@ -8819,6 +10207,12 @@ module Aws::IoT
|
|
8819
10207
|
# to those alerts issued for a particular security profile, behavior, or
|
8820
10208
|
# thing (device).
|
8821
10209
|
#
|
10210
|
+
# Requires permission to access the [ListViolationEvents][1] action.
|
10211
|
+
#
|
10212
|
+
#
|
10213
|
+
#
|
10214
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10215
|
+
#
|
8822
10216
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
8823
10217
|
# The start time for the alerts to be listed.
|
8824
10218
|
#
|
@@ -8914,14 +10308,20 @@ module Aws::IoT
|
|
8914
10308
|
req.send_request(options)
|
8915
10309
|
end
|
8916
10310
|
|
8917
|
-
# Registers a CA certificate with
|
8918
|
-
#
|
8919
|
-
#
|
8920
|
-
# that have the same subject field. This enables you to have up
|
8921
|
-
# certificate authorities sign your device certificates. If you
|
8922
|
-
# more than one CA certificate registered, make sure you pass the
|
8923
|
-
# certificate when you register your device certificates with the
|
8924
|
-
# RegisterCertificate
|
10311
|
+
# Registers a CA certificate with IoT. This CA certificate can then be
|
10312
|
+
# used to sign device certificates, which can be then registered with
|
10313
|
+
# IoT. You can register up to 10 CA certificates per Amazon Web Services
|
10314
|
+
# account that have the same subject field. This enables you to have up
|
10315
|
+
# to 10 certificate authorities sign your device certificates. If you
|
10316
|
+
# have more than one CA certificate registered, make sure you pass the
|
10317
|
+
# CA certificate when you register your device certificates with the
|
10318
|
+
# RegisterCertificate action.
|
10319
|
+
#
|
10320
|
+
# Requires permission to access the [RegisterCACertificate][1] action.
|
10321
|
+
#
|
10322
|
+
#
|
10323
|
+
#
|
10324
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8925
10325
|
#
|
8926
10326
|
# @option params [required, String] :ca_certificate
|
8927
10327
|
# The CA certificate.
|
@@ -8989,11 +10389,17 @@ module Aws::IoT
|
|
8989
10389
|
req.send_request(options)
|
8990
10390
|
end
|
8991
10391
|
|
8992
|
-
# Registers a device certificate with
|
8993
|
-
#
|
8994
|
-
#
|
10392
|
+
# Registers a device certificate with IoT. If you have more than one CA
|
10393
|
+
# certificate that has the same subject field, you must specify the CA
|
10394
|
+
# certificate that was used to sign the device certificate being
|
8995
10395
|
# registered.
|
8996
10396
|
#
|
10397
|
+
# Requires permission to access the [RegisterCertificate][1] action.
|
10398
|
+
#
|
10399
|
+
#
|
10400
|
+
#
|
10401
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10402
|
+
#
|
8997
10403
|
# @option params [required, String] :certificate_pem
|
8998
10404
|
# The certificate data, in PEM format.
|
8999
10405
|
#
|
@@ -9067,15 +10473,18 @@ module Aws::IoT
|
|
9067
10473
|
end
|
9068
10474
|
|
9069
10475
|
# Provisions a thing in the device registry. RegisterThing calls other
|
9070
|
-
#
|
9071
|
-
#
|
9072
|
-
#
|
10476
|
+
# IoT control plane APIs. These calls might exceed your account level [
|
10477
|
+
# IoT Throttling Limits][1] and cause throttle errors. Please contact
|
10478
|
+
# [Amazon Web Services Customer Support][2] to raise your throttling
|
9073
10479
|
# limits if necessary.
|
9074
10480
|
#
|
10481
|
+
# Requires permission to access the [RegisterThing][3] action.
|
10482
|
+
#
|
9075
10483
|
#
|
9076
10484
|
#
|
9077
10485
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_iot
|
9078
10486
|
# [2]: https://console.aws.amazon.com/support/home
|
10487
|
+
# [3]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9079
10488
|
#
|
9080
10489
|
# @option params [required, String] :template_body
|
9081
10490
|
# The provisioning template. See [Provisioning Devices That Have Device
|
@@ -9120,7 +10529,7 @@ module Aws::IoT
|
|
9120
10529
|
req.send_request(options)
|
9121
10530
|
end
|
9122
10531
|
|
9123
|
-
# Rejects a pending certificate transfer. After
|
10532
|
+
# Rejects a pending certificate transfer. After IoT rejects a
|
9124
10533
|
# certificate transfer, the certificate status changes from
|
9125
10534
|
# **PENDING\_TRANSFER** to **INACTIVE**.
|
9126
10535
|
#
|
@@ -9131,6 +10540,13 @@ module Aws::IoT
|
|
9131
10540
|
# it is called, the certificate will be returned to the source's
|
9132
10541
|
# account in the INACTIVE state.
|
9133
10542
|
#
|
10543
|
+
# Requires permission to access the [RejectCertificateTransfer][1]
|
10544
|
+
# action.
|
10545
|
+
#
|
10546
|
+
#
|
10547
|
+
#
|
10548
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10549
|
+
#
|
9134
10550
|
# @option params [required, String] :certificate_id
|
9135
10551
|
# The ID of the certificate. (The last part of the certificate ARN
|
9136
10552
|
# contains the certificate ID.)
|
@@ -9156,6 +10572,13 @@ module Aws::IoT
|
|
9156
10572
|
|
9157
10573
|
# Removes the given thing from the billing group.
|
9158
10574
|
#
|
10575
|
+
# Requires permission to access the [RemoveThingFromBillingGroup][1]
|
10576
|
+
# action.
|
10577
|
+
#
|
10578
|
+
#
|
10579
|
+
#
|
10580
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10581
|
+
#
|
9159
10582
|
# @option params [String] :billing_group_name
|
9160
10583
|
# The name of the billing group.
|
9161
10584
|
#
|
@@ -9192,6 +10615,13 @@ module Aws::IoT
|
|
9192
10615
|
# identify the thing group and either a `thingArn` or a `thingName` to
|
9193
10616
|
# identify the thing to remove from the thing group.
|
9194
10617
|
#
|
10618
|
+
# Requires permission to access the [RemoveThingFromThingGroup][1]
|
10619
|
+
# action.
|
10620
|
+
#
|
10621
|
+
#
|
10622
|
+
#
|
10623
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10624
|
+
#
|
9195
10625
|
# @option params [String] :thing_group_name
|
9196
10626
|
# The group name.
|
9197
10627
|
#
|
@@ -9227,6 +10657,12 @@ module Aws::IoT
|
|
9227
10657
|
# permission to create rules will be able to access data processed by
|
9228
10658
|
# the rule.
|
9229
10659
|
#
|
10660
|
+
# Requires permission to access the [ReplaceTopicRule][1] action.
|
10661
|
+
#
|
10662
|
+
#
|
10663
|
+
#
|
10664
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10665
|
+
#
|
9230
10666
|
# @option params [required, String] :rule_name
|
9231
10667
|
# The name of the rule.
|
9232
10668
|
#
|
@@ -9410,6 +10846,13 @@ module Aws::IoT
|
|
9410
10846
|
# "String" => "String",
|
9411
10847
|
# },
|
9412
10848
|
# },
|
10849
|
+
# open_search: {
|
10850
|
+
# role_arn: "AwsArn", # required
|
10851
|
+
# endpoint: "ElasticsearchEndpoint", # required
|
10852
|
+
# index: "ElasticsearchIndex", # required
|
10853
|
+
# type: "ElasticsearchType", # required
|
10854
|
+
# id: "ElasticsearchId", # required
|
10855
|
+
# },
|
9413
10856
|
# },
|
9414
10857
|
# ],
|
9415
10858
|
# rule_disabled: false,
|
@@ -9581,6 +11024,13 @@ module Aws::IoT
|
|
9581
11024
|
# "String" => "String",
|
9582
11025
|
# },
|
9583
11026
|
# },
|
11027
|
+
# open_search: {
|
11028
|
+
# role_arn: "AwsArn", # required
|
11029
|
+
# endpoint: "ElasticsearchEndpoint", # required
|
11030
|
+
# index: "ElasticsearchIndex", # required
|
11031
|
+
# type: "ElasticsearchType", # required
|
11032
|
+
# id: "ElasticsearchId", # required
|
11033
|
+
# },
|
9584
11034
|
# },
|
9585
11035
|
# },
|
9586
11036
|
# })
|
@@ -9594,6 +11044,12 @@ module Aws::IoT
|
|
9594
11044
|
|
9595
11045
|
# The query search index.
|
9596
11046
|
#
|
11047
|
+
# Requires permission to access the [SearchIndex][1] action.
|
11048
|
+
#
|
11049
|
+
#
|
11050
|
+
#
|
11051
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11052
|
+
#
|
9597
11053
|
# @option params [String] :index_name
|
9598
11054
|
# The search index name.
|
9599
11055
|
#
|
@@ -9640,6 +11096,7 @@ module Aws::IoT
|
|
9640
11096
|
# resp.things[0].shadow #=> String
|
9641
11097
|
# resp.things[0].connectivity.connected #=> Boolean
|
9642
11098
|
# resp.things[0].connectivity.timestamp #=> Integer
|
11099
|
+
# resp.things[0].connectivity.disconnect_reason #=> String
|
9643
11100
|
# resp.thing_groups #=> Array
|
9644
11101
|
# resp.thing_groups[0].thing_group_name #=> String
|
9645
11102
|
# resp.thing_groups[0].thing_group_id #=> String
|
@@ -9659,6 +11116,12 @@ module Aws::IoT
|
|
9659
11116
|
# Sets the default authorizer. This will be used if a websocket
|
9660
11117
|
# connection is made without specifying an authorizer.
|
9661
11118
|
#
|
11119
|
+
# Requires permission to access the [SetDefaultAuthorizer][1] action.
|
11120
|
+
#
|
11121
|
+
#
|
11122
|
+
#
|
11123
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11124
|
+
#
|
9662
11125
|
# @option params [required, String] :authorizer_name
|
9663
11126
|
# The authorizer name.
|
9664
11127
|
#
|
@@ -9688,7 +11151,13 @@ module Aws::IoT
|
|
9688
11151
|
# Sets the specified version of the specified policy as the policy's
|
9689
11152
|
# default (operative) version. This action affects all certificates to
|
9690
11153
|
# which the policy is attached. To list the principals the policy is
|
9691
|
-
# attached to, use the
|
11154
|
+
# attached to, use the ListPrincipalPolicies action.
|
11155
|
+
#
|
11156
|
+
# Requires permission to access the [SetDefaultPolicyVersion][1] action.
|
11157
|
+
#
|
11158
|
+
#
|
11159
|
+
#
|
11160
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9692
11161
|
#
|
9693
11162
|
# @option params [required, String] :policy_name
|
9694
11163
|
# The policy name.
|
@@ -9717,6 +11186,12 @@ module Aws::IoT
|
|
9717
11186
|
# NOTE: use of this command is not recommended. Use
|
9718
11187
|
# `SetV2LoggingOptions` instead.
|
9719
11188
|
#
|
11189
|
+
# Requires permission to access the [SetLoggingOptions][1] action.
|
11190
|
+
#
|
11191
|
+
#
|
11192
|
+
#
|
11193
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11194
|
+
#
|
9720
11195
|
# @option params [required, Types::LoggingOptionsPayload] :logging_options_payload
|
9721
11196
|
# The logging options payload.
|
9722
11197
|
#
|
@@ -9740,6 +11215,12 @@ module Aws::IoT
|
|
9740
11215
|
|
9741
11216
|
# Sets the logging level.
|
9742
11217
|
#
|
11218
|
+
# Requires permission to access the [SetV2LoggingLevel][1] action.
|
11219
|
+
#
|
11220
|
+
#
|
11221
|
+
#
|
11222
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11223
|
+
#
|
9743
11224
|
# @option params [required, Types::LogTarget] :log_target
|
9744
11225
|
# The log target.
|
9745
11226
|
#
|
@@ -9767,6 +11248,12 @@ module Aws::IoT
|
|
9767
11248
|
|
9768
11249
|
# Sets the logging options for the V2 logging service.
|
9769
11250
|
#
|
11251
|
+
# Requires permission to access the [SetV2LoggingOptions][1] action.
|
11252
|
+
#
|
11253
|
+
#
|
11254
|
+
#
|
11255
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11256
|
+
#
|
9770
11257
|
# @option params [String] :role_arn
|
9771
11258
|
# The ARN of the role that allows IoT to write to Cloudwatch logs.
|
9772
11259
|
#
|
@@ -9796,6 +11283,13 @@ module Aws::IoT
|
|
9796
11283
|
# Starts a task that applies a set of mitigation actions to the
|
9797
11284
|
# specified target.
|
9798
11285
|
#
|
11286
|
+
# Requires permission to access the [StartAuditMitigationActionsTask][1]
|
11287
|
+
# action.
|
11288
|
+
#
|
11289
|
+
#
|
11290
|
+
#
|
11291
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11292
|
+
#
|
9799
11293
|
# @option params [required, String] :task_id
|
9800
11294
|
# A unique identifier for the task. You can use this identifier to check
|
9801
11295
|
# the status of the task or to cancel it.
|
@@ -9807,7 +11301,7 @@ module Aws::IoT
|
|
9807
11301
|
#
|
9808
11302
|
# @option params [required, Hash<String,Array>] :audit_check_to_actions_mapping
|
9809
11303
|
# For an audit check, specifies which mitigation actions to apply. Those
|
9810
|
-
# actions must be defined in your
|
11304
|
+
# actions must be defined in your Amazon Web Services accounts.
|
9811
11305
|
#
|
9812
11306
|
# @option params [required, String] :client_request_token
|
9813
11307
|
# Each audit mitigation task must have a unique client request token. If
|
@@ -9852,6 +11346,13 @@ module Aws::IoT
|
|
9852
11346
|
|
9853
11347
|
# Starts a Device Defender ML Detect mitigation actions task.
|
9854
11348
|
#
|
11349
|
+
# Requires permission to access the
|
11350
|
+
# [StartDetectMitigationActionsTask][1] action.
|
11351
|
+
#
|
11352
|
+
#
|
11353
|
+
#
|
11354
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11355
|
+
#
|
9855
11356
|
# @option params [required, String] :task_id
|
9856
11357
|
# The unique identifier of the task.
|
9857
11358
|
#
|
@@ -9874,8 +11375,8 @@ module Aws::IoT
|
|
9874
11375
|
# @option params [required, String] :client_request_token
|
9875
11376
|
# Each mitigation action task must have a unique client request token.
|
9876
11377
|
# If you try to create a new task with the same token as a task that
|
9877
|
-
# already exists, an exception occurs. If you omit this value,
|
9878
|
-
# will automatically generate a unique client request.
|
11378
|
+
# already exists, an exception occurs. If you omit this value, Amazon
|
11379
|
+
# Web Services SDKs will automatically generate a unique client request.
|
9879
11380
|
#
|
9880
11381
|
# **A suitable default value is auto-generated.** You should normally
|
9881
11382
|
# not need to pass this option.**
|
@@ -9916,6 +11417,12 @@ module Aws::IoT
|
|
9916
11417
|
|
9917
11418
|
# Starts an on-demand Device Defender audit.
|
9918
11419
|
#
|
11420
|
+
# Requires permission to access the [StartOnDemandAuditTask][1] action.
|
11421
|
+
#
|
11422
|
+
#
|
11423
|
+
#
|
11424
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11425
|
+
#
|
9919
11426
|
# @option params [required, Array<String>] :target_check_names
|
9920
11427
|
# Which checks are performed during the audit. The checks you specify
|
9921
11428
|
# must be enabled for your account or an exception occurs. Use
|
@@ -9946,6 +11453,13 @@ module Aws::IoT
|
|
9946
11453
|
|
9947
11454
|
# Creates a bulk thing provisioning task.
|
9948
11455
|
#
|
11456
|
+
# Requires permission to access the [StartThingRegistrationTask][1]
|
11457
|
+
# action.
|
11458
|
+
#
|
11459
|
+
#
|
11460
|
+
#
|
11461
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11462
|
+
#
|
9949
11463
|
# @option params [required, String] :template_body
|
9950
11464
|
# The provisioning template.
|
9951
11465
|
#
|
@@ -9986,6 +11500,13 @@ module Aws::IoT
|
|
9986
11500
|
|
9987
11501
|
# Cancels a bulk thing provisioning task.
|
9988
11502
|
#
|
11503
|
+
# Requires permission to access the [StopThingRegistrationTask][1]
|
11504
|
+
# action.
|
11505
|
+
#
|
11506
|
+
#
|
11507
|
+
#
|
11508
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11509
|
+
#
|
9989
11510
|
# @option params [required, String] :task_id
|
9990
11511
|
# The bulk thing provisioning task ID.
|
9991
11512
|
#
|
@@ -10007,6 +11528,12 @@ module Aws::IoT
|
|
10007
11528
|
# Adds to or modifies the tags of the given resource. Tags are metadata
|
10008
11529
|
# which can be used to manage a resource.
|
10009
11530
|
#
|
11531
|
+
# Requires permission to access the [TagResource][1] action.
|
11532
|
+
#
|
11533
|
+
#
|
11534
|
+
#
|
11535
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11536
|
+
#
|
10010
11537
|
# @option params [required, String] :resource_arn
|
10011
11538
|
# The ARN of the resource.
|
10012
11539
|
#
|
@@ -10034,10 +11561,15 @@ module Aws::IoT
|
|
10034
11561
|
req.send_request(options)
|
10035
11562
|
end
|
10036
11563
|
|
10037
|
-
# Tests if a specified principal is authorized to perform an
|
10038
|
-
#
|
10039
|
-
#
|
10040
|
-
#
|
11564
|
+
# Tests if a specified principal is authorized to perform an IoT action
|
11565
|
+
# on a specified resource. Use this to test and debug the authorization
|
11566
|
+
# behavior of devices that connect to the IoT device gateway.
|
11567
|
+
#
|
11568
|
+
# Requires permission to access the [TestAuthorization][1] action.
|
11569
|
+
#
|
11570
|
+
#
|
11571
|
+
#
|
11572
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10041
11573
|
#
|
10042
11574
|
# @option params [String] :principal
|
10043
11575
|
# The principal. Valid principals are CertificateArn
|
@@ -10112,7 +11644,13 @@ module Aws::IoT
|
|
10112
11644
|
|
10113
11645
|
# Tests a custom authorization behavior by invoking a specified custom
|
10114
11646
|
# authorizer. Use this to test and debug the custom authorization
|
10115
|
-
# behavior of devices that connect to the
|
11647
|
+
# behavior of devices that connect to the IoT device gateway.
|
11648
|
+
#
|
11649
|
+
# Requires permission to access the [TestInvokeAuthorizer][1] action.
|
11650
|
+
#
|
11651
|
+
#
|
11652
|
+
#
|
11653
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10116
11654
|
#
|
10117
11655
|
# @option params [required, String] :authorizer_name
|
10118
11656
|
# The custom authorizer name.
|
@@ -10179,7 +11717,10 @@ module Aws::IoT
|
|
10179
11717
|
req.send_request(options)
|
10180
11718
|
end
|
10181
11719
|
|
10182
|
-
# Transfers the specified certificate to the specified
|
11720
|
+
# Transfers the specified certificate to the specified Amazon Web
|
11721
|
+
# Services account.
|
11722
|
+
#
|
11723
|
+
# Requires permission to access the [TransferCertificate][1] action.
|
10183
11724
|
#
|
10184
11725
|
# You can cancel the transfer until it is acknowledged by the recipient.
|
10185
11726
|
#
|
@@ -10187,17 +11728,21 @@ module Aws::IoT
|
|
10187
11728
|
# up to the caller to notify the transfer target.
|
10188
11729
|
#
|
10189
11730
|
# The certificate being transferred must not be in the ACTIVE state. You
|
10190
|
-
# can use the UpdateCertificate
|
11731
|
+
# can use the UpdateCertificate action to deactivate it.
|
10191
11732
|
#
|
10192
11733
|
# The certificate must not have any policies attached to it. You can use
|
10193
|
-
# the
|
11734
|
+
# the DetachPolicy action to detach them.
|
11735
|
+
#
|
11736
|
+
#
|
11737
|
+
#
|
11738
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10194
11739
|
#
|
10195
11740
|
# @option params [required, String] :certificate_id
|
10196
11741
|
# The ID of the certificate. (The last part of the certificate ARN
|
10197
11742
|
# contains the certificate ID.)
|
10198
11743
|
#
|
10199
11744
|
# @option params [required, String] :target_aws_account
|
10200
|
-
# The
|
11745
|
+
# The Amazon Web Services account.
|
10201
11746
|
#
|
10202
11747
|
# @option params [String] :transfer_message
|
10203
11748
|
# The transfer message.
|
@@ -10227,6 +11772,12 @@ module Aws::IoT
|
|
10227
11772
|
|
10228
11773
|
# Removes the given tags (metadata) from the resource.
|
10229
11774
|
#
|
11775
|
+
# Requires permission to access the [UntagResource][1] action.
|
11776
|
+
#
|
11777
|
+
#
|
11778
|
+
#
|
11779
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11780
|
+
#
|
10230
11781
|
# @option params [required, String] :resource_arn
|
10231
11782
|
# The ARN of the resource.
|
10232
11783
|
#
|
@@ -10253,10 +11804,17 @@ module Aws::IoT
|
|
10253
11804
|
# account. Settings include how audit notifications are sent and which
|
10254
11805
|
# audit checks are enabled or disabled.
|
10255
11806
|
#
|
11807
|
+
# Requires permission to access the [UpdateAccountAuditConfiguration][1]
|
11808
|
+
# action.
|
11809
|
+
#
|
11810
|
+
#
|
11811
|
+
#
|
11812
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11813
|
+
#
|
10256
11814
|
# @option params [String] :role_arn
|
10257
11815
|
# The Amazon Resource Name (ARN) of the role that grants permission to
|
10258
|
-
#
|
10259
|
-
#
|
11816
|
+
# IoT to access information about your devices, policies, certificates,
|
11817
|
+
# and other items as required when performing an audit.
|
10260
11818
|
#
|
10261
11819
|
# @option params [Hash<String,Types::AuditNotificationTarget>] :audit_notification_target_configurations
|
10262
11820
|
# Information about the targets to which audit notifications are sent.
|
@@ -10358,6 +11916,12 @@ module Aws::IoT
|
|
10358
11916
|
|
10359
11917
|
# Updates an authorizer.
|
10360
11918
|
#
|
11919
|
+
# Requires permission to access the [UpdateAuthorizer][1] action.
|
11920
|
+
#
|
11921
|
+
#
|
11922
|
+
#
|
11923
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11924
|
+
#
|
10361
11925
|
# @option params [required, String] :authorizer_name
|
10362
11926
|
# The authorizer name.
|
10363
11927
|
#
|
@@ -10404,6 +11968,12 @@ module Aws::IoT
|
|
10404
11968
|
|
10405
11969
|
# Updates information about the billing group.
|
10406
11970
|
#
|
11971
|
+
# Requires permission to access the [UpdateBillingGroup][1] action.
|
11972
|
+
#
|
11973
|
+
#
|
11974
|
+
#
|
11975
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11976
|
+
#
|
10407
11977
|
# @option params [required, String] :billing_group_name
|
10408
11978
|
# The name of the billing group.
|
10409
11979
|
#
|
@@ -10443,6 +12013,12 @@ module Aws::IoT
|
|
10443
12013
|
|
10444
12014
|
# Updates a registered CA certificate.
|
10445
12015
|
#
|
12016
|
+
# Requires permission to access the [UpdateCACertificate][1] action.
|
12017
|
+
#
|
12018
|
+
#
|
12019
|
+
#
|
12020
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12021
|
+
#
|
10446
12022
|
# @option params [required, String] :certificate_id
|
10447
12023
|
# The CA certificate identifier.
|
10448
12024
|
#
|
@@ -10487,14 +12063,20 @@ module Aws::IoT
|
|
10487
12063
|
# Updates the status of the specified certificate. This operation is
|
10488
12064
|
# idempotent.
|
10489
12065
|
#
|
12066
|
+
# Requires permission to access the [UpdateCertificate][1] action.
|
12067
|
+
#
|
10490
12068
|
# Certificates must be in the ACTIVE state to authenticate devices that
|
10491
|
-
# use a certificate to connect to
|
12069
|
+
# use a certificate to connect to IoT.
|
10492
12070
|
#
|
10493
12071
|
# Within a few minutes of updating a certificate from the ACTIVE state
|
10494
|
-
# to any other state,
|
12072
|
+
# to any other state, IoT disconnects all devices that used that
|
10495
12073
|
# certificate to connect. Devices cannot use a certificate that is not
|
10496
12074
|
# in the ACTIVE state to reconnect.
|
10497
12075
|
#
|
12076
|
+
#
|
12077
|
+
#
|
12078
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12079
|
+
#
|
10498
12080
|
# @option params [required, String] :certificate_id
|
10499
12081
|
# The ID of the certificate. (The last part of the certificate ARN
|
10500
12082
|
# contains the certificate ID.)
|
@@ -10505,7 +12087,7 @@ module Aws::IoT
|
|
10505
12087
|
# **Note:** Setting the status to PENDING\_TRANSFER or
|
10506
12088
|
# PENDING\_ACTIVATION will result in an exception being thrown.
|
10507
12089
|
# PENDING\_TRANSFER and PENDING\_ACTIVATION are statuses used internally
|
10508
|
-
# by
|
12090
|
+
# by IoT. They are not intended for developer use.
|
10509
12091
|
#
|
10510
12092
|
# **Note:** The status value REGISTER\_INACTIVE is deprecated and should
|
10511
12093
|
# not be used.
|
@@ -10528,6 +12110,12 @@ module Aws::IoT
|
|
10528
12110
|
|
10529
12111
|
# Updates a Device Defender detect custom metric.
|
10530
12112
|
#
|
12113
|
+
# Requires permission to access the [UpdateCustomMetric][1] action.
|
12114
|
+
#
|
12115
|
+
#
|
12116
|
+
#
|
12117
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12118
|
+
#
|
10531
12119
|
# @option params [required, String] :metric_name
|
10532
12120
|
# The name of the custom metric. Cannot be updated.
|
10533
12121
|
#
|
@@ -10571,6 +12159,12 @@ module Aws::IoT
|
|
10571
12159
|
# Updates the definition for a dimension. You cannot change the type of
|
10572
12160
|
# a dimension after it is created (you can delete it and recreate it).
|
10573
12161
|
#
|
12162
|
+
# Requires permission to access the [UpdateDimension][1] action.
|
12163
|
+
#
|
12164
|
+
#
|
12165
|
+
#
|
12166
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12167
|
+
#
|
10574
12168
|
# @option params [required, String] :name
|
10575
12169
|
# A unique identifier for the dimension. Choose something that describes
|
10576
12170
|
# the type and value to make it easy to remember what it does.
|
@@ -10616,6 +12210,13 @@ module Aws::IoT
|
|
10616
12210
|
# Updates values stored in the domain configuration. Domain
|
10617
12211
|
# configurations for default endpoints can't be updated.
|
10618
12212
|
#
|
12213
|
+
# Requires permission to access the [UpdateDomainConfiguration][1]
|
12214
|
+
# action.
|
12215
|
+
#
|
12216
|
+
#
|
12217
|
+
#
|
12218
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12219
|
+
#
|
10619
12220
|
# @option params [required, String] :domain_configuration_name
|
10620
12221
|
# The name of the domain configuration to be updated.
|
10621
12222
|
#
|
@@ -10659,6 +12260,12 @@ module Aws::IoT
|
|
10659
12260
|
|
10660
12261
|
# Updates a dynamic thing group.
|
10661
12262
|
#
|
12263
|
+
# Requires permission to access the [UpdateDynamicThingGroup][1] action.
|
12264
|
+
#
|
12265
|
+
#
|
12266
|
+
#
|
12267
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12268
|
+
#
|
10662
12269
|
# @option params [required, String] :thing_group_name
|
10663
12270
|
# The name of the dynamic thing group to update.
|
10664
12271
|
#
|
@@ -10671,7 +12278,7 @@ module Aws::IoT
|
|
10671
12278
|
# @option params [String] :index_name
|
10672
12279
|
# The dynamic thing group index to update.
|
10673
12280
|
#
|
10674
|
-
# <note markdown="1"> Currently one index is supported:
|
12281
|
+
# <note markdown="1"> Currently one index is supported: `AWS_Things`.
|
10675
12282
|
#
|
10676
12283
|
# </note>
|
10677
12284
|
#
|
@@ -10722,6 +12329,13 @@ module Aws::IoT
|
|
10722
12329
|
|
10723
12330
|
# Updates the event configurations.
|
10724
12331
|
#
|
12332
|
+
# Requires permission to access the [UpdateEventConfigurations][1]
|
12333
|
+
# action.
|
12334
|
+
#
|
12335
|
+
#
|
12336
|
+
#
|
12337
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12338
|
+
#
|
10725
12339
|
# @option params [Hash<String,Types::Configuration>] :event_configurations
|
10726
12340
|
# The new event configuration values.
|
10727
12341
|
#
|
@@ -10744,8 +12358,86 @@ module Aws::IoT
|
|
10744
12358
|
req.send_request(options)
|
10745
12359
|
end
|
10746
12360
|
|
12361
|
+
# Updates the data for a fleet metric.
|
12362
|
+
#
|
12363
|
+
# Requires permission to access the [UpdateFleetMetric][1] action.
|
12364
|
+
#
|
12365
|
+
#
|
12366
|
+
#
|
12367
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12368
|
+
#
|
12369
|
+
# @option params [required, String] :metric_name
|
12370
|
+
# The name of the fleet metric to update.
|
12371
|
+
#
|
12372
|
+
# @option params [String] :query_string
|
12373
|
+
# The search query string.
|
12374
|
+
#
|
12375
|
+
# @option params [Types::AggregationType] :aggregation_type
|
12376
|
+
# The type of the aggregation query.
|
12377
|
+
#
|
12378
|
+
# @option params [Integer] :period
|
12379
|
+
# The time in seconds between fleet metric emissions. Range \[60(1 min),
|
12380
|
+
# 86400(1 day)\] and must be multiple of 60.
|
12381
|
+
#
|
12382
|
+
# @option params [String] :aggregation_field
|
12383
|
+
# The field to aggregate.
|
12384
|
+
#
|
12385
|
+
# @option params [String] :description
|
12386
|
+
# The description of the fleet metric.
|
12387
|
+
#
|
12388
|
+
# @option params [String] :query_version
|
12389
|
+
# The version of the query.
|
12390
|
+
#
|
12391
|
+
# @option params [required, String] :index_name
|
12392
|
+
# The name of the index to search.
|
12393
|
+
#
|
12394
|
+
# @option params [String] :unit
|
12395
|
+
# Used to support unit transformation such as milliseconds to seconds.
|
12396
|
+
# The unit must be supported by [CW metric][1].
|
12397
|
+
#
|
12398
|
+
#
|
12399
|
+
#
|
12400
|
+
# [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
|
12401
|
+
#
|
12402
|
+
# @option params [Integer] :expected_version
|
12403
|
+
# The expected version of the fleet metric record in the registry.
|
12404
|
+
#
|
12405
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
12406
|
+
#
|
12407
|
+
# @example Request syntax with placeholder values
|
12408
|
+
#
|
12409
|
+
# resp = client.update_fleet_metric({
|
12410
|
+
# metric_name: "FleetMetricName", # required
|
12411
|
+
# query_string: "QueryString",
|
12412
|
+
# aggregation_type: {
|
12413
|
+
# name: "Statistics", # required, accepts Statistics, Percentiles, Cardinality
|
12414
|
+
# values: ["AggregationTypeValue"],
|
12415
|
+
# },
|
12416
|
+
# period: 1,
|
12417
|
+
# aggregation_field: "AggregationField",
|
12418
|
+
# description: "FleetMetricDescription",
|
12419
|
+
# query_version: "QueryVersion",
|
12420
|
+
# index_name: "IndexName", # required
|
12421
|
+
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
12422
|
+
# expected_version: 1,
|
12423
|
+
# })
|
12424
|
+
#
|
12425
|
+
# @overload update_fleet_metric(params = {})
|
12426
|
+
# @param [Hash] params ({})
|
12427
|
+
def update_fleet_metric(params = {}, options = {})
|
12428
|
+
req = build_request(:update_fleet_metric, params)
|
12429
|
+
req.send_request(options)
|
12430
|
+
end
|
12431
|
+
|
10747
12432
|
# Updates the search configuration.
|
10748
12433
|
#
|
12434
|
+
# Requires permission to access the [UpdateIndexingConfiguration][1]
|
12435
|
+
# action.
|
12436
|
+
#
|
12437
|
+
#
|
12438
|
+
#
|
12439
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12440
|
+
#
|
10749
12441
|
# @option params [Types::ThingIndexingConfiguration] :thing_indexing_configuration
|
10750
12442
|
# Thing indexing configuration.
|
10751
12443
|
#
|
@@ -10799,6 +12491,12 @@ module Aws::IoT
|
|
10799
12491
|
|
10800
12492
|
# Updates supported fields of the specified job.
|
10801
12493
|
#
|
12494
|
+
# Requires permission to access the [UpdateJob][1] action.
|
12495
|
+
#
|
12496
|
+
#
|
12497
|
+
#
|
12498
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12499
|
+
#
|
10802
12500
|
# @option params [required, String] :job_id
|
10803
12501
|
# The ID of the job to be updated.
|
10804
12502
|
#
|
@@ -10824,9 +12522,9 @@ module Aws::IoT
|
|
10824
12522
|
# @option params [String] :namespace_id
|
10825
12523
|
# The namespace used to indicate that a job is a customer-managed job.
|
10826
12524
|
#
|
10827
|
-
# When you specify a value for this parameter,
|
10828
|
-
# notifications to MQTT topics that contain the value in
|
10829
|
-
# format.
|
12525
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
12526
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
12527
|
+
# the following format.
|
10830
12528
|
#
|
10831
12529
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
10832
12530
|
#
|
@@ -10881,6 +12579,12 @@ module Aws::IoT
|
|
10881
12579
|
|
10882
12580
|
# Updates the definition for the specified mitigation action.
|
10883
12581
|
#
|
12582
|
+
# Requires permission to access the [UpdateMitigationAction][1] action.
|
12583
|
+
#
|
12584
|
+
#
|
12585
|
+
#
|
12586
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12587
|
+
#
|
10884
12588
|
# @option params [required, String] :action_name
|
10885
12589
|
# The friendly name for the mitigation action. You cannot change the
|
10886
12590
|
# name by using `UpdateMitigationAction`. Instead, you must delete and
|
@@ -10940,6 +12644,13 @@ module Aws::IoT
|
|
10940
12644
|
|
10941
12645
|
# Updates a fleet provisioning template.
|
10942
12646
|
#
|
12647
|
+
# Requires permission to access the [UpdateProvisioningTemplate][1]
|
12648
|
+
# action.
|
12649
|
+
#
|
12650
|
+
#
|
12651
|
+
#
|
12652
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12653
|
+
#
|
10943
12654
|
# @option params [required, String] :template_name
|
10944
12655
|
# The name of the fleet provisioning template.
|
10945
12656
|
#
|
@@ -10988,6 +12699,12 @@ module Aws::IoT
|
|
10988
12699
|
|
10989
12700
|
# Updates a role alias.
|
10990
12701
|
#
|
12702
|
+
# Requires permission to access the [UpdateRoleAlias][1] action.
|
12703
|
+
#
|
12704
|
+
#
|
12705
|
+
#
|
12706
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12707
|
+
#
|
10991
12708
|
# @option params [required, String] :role_alias
|
10992
12709
|
# The role alias to update.
|
10993
12710
|
#
|
@@ -11025,6 +12742,12 @@ module Aws::IoT
|
|
11025
12742
|
# Updates a scheduled audit, including which checks are performed and
|
11026
12743
|
# how often the audit takes place.
|
11027
12744
|
#
|
12745
|
+
# Requires permission to access the [UpdateScheduledAudit][1] action.
|
12746
|
+
#
|
12747
|
+
#
|
12748
|
+
#
|
12749
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12750
|
+
#
|
11028
12751
|
# @option params [String] :frequency
|
11029
12752
|
# How often the scheduled audit takes place, either `DAILY`, `WEEKLY`,
|
11030
12753
|
# `BIWEEKLY`, or `MONTHLY`. The start time of each audit is determined
|
@@ -11079,6 +12802,12 @@ module Aws::IoT
|
|
11079
12802
|
|
11080
12803
|
# Updates a Device Defender security profile.
|
11081
12804
|
#
|
12805
|
+
# Requires permission to access the [UpdateSecurityProfile][1] action.
|
12806
|
+
#
|
12807
|
+
#
|
12808
|
+
#
|
12809
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12810
|
+
#
|
11082
12811
|
# @option params [required, String] :security_profile_name
|
11083
12812
|
# The name of the security profile you want to update.
|
11084
12813
|
#
|
@@ -11249,6 +12978,12 @@ module Aws::IoT
|
|
11249
12978
|
# Updates an existing stream. The stream version will be incremented by
|
11250
12979
|
# one.
|
11251
12980
|
#
|
12981
|
+
# Requires permission to access the [UpdateStream][1] action.
|
12982
|
+
#
|
12983
|
+
#
|
12984
|
+
#
|
12985
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12986
|
+
#
|
11252
12987
|
# @option params [required, String] :stream_id
|
11253
12988
|
# The stream ID.
|
11254
12989
|
#
|
@@ -11303,6 +13038,12 @@ module Aws::IoT
|
|
11303
13038
|
|
11304
13039
|
# Updates the data for a thing.
|
11305
13040
|
#
|
13041
|
+
# Requires permission to access the [UpdateThing][1] action.
|
13042
|
+
#
|
13043
|
+
#
|
13044
|
+
#
|
13045
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13046
|
+
#
|
11306
13047
|
# @option params [required, String] :thing_name
|
11307
13048
|
# The name of the thing to update.
|
11308
13049
|
#
|
@@ -11357,6 +13098,12 @@ module Aws::IoT
|
|
11357
13098
|
|
11358
13099
|
# Update a thing group.
|
11359
13100
|
#
|
13101
|
+
# Requires permission to access the [UpdateThingGroup][1] action.
|
13102
|
+
#
|
13103
|
+
#
|
13104
|
+
#
|
13105
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13106
|
+
#
|
11360
13107
|
# @option params [required, String] :thing_group_name
|
11361
13108
|
# The thing group to update.
|
11362
13109
|
#
|
@@ -11400,6 +13147,13 @@ module Aws::IoT
|
|
11400
13147
|
|
11401
13148
|
# Updates the groups to which the thing belongs.
|
11402
13149
|
#
|
13150
|
+
# Requires permission to access the [UpdateThingGroupsForThing][1]
|
13151
|
+
# action.
|
13152
|
+
#
|
13153
|
+
#
|
13154
|
+
#
|
13155
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13156
|
+
#
|
11403
13157
|
# @option params [String] :thing_name
|
11404
13158
|
# The thing whose group memberships will be updated.
|
11405
13159
|
#
|
@@ -11436,6 +13190,13 @@ module Aws::IoT
|
|
11436
13190
|
# Updates a topic rule destination. You use this to change the status,
|
11437
13191
|
# endpoint URL, or confirmation URL of the destination.
|
11438
13192
|
#
|
13193
|
+
# Requires permission to access the [UpdateTopicRuleDestination][1]
|
13194
|
+
# action.
|
13195
|
+
#
|
13196
|
+
#
|
13197
|
+
#
|
13198
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13199
|
+
#
|
11439
13200
|
# @option params [required, String] :arn
|
11440
13201
|
# The ARN of the topic rule destination.
|
11441
13202
|
#
|
@@ -11489,6 +13250,13 @@ module Aws::IoT
|
|
11489
13250
|
|
11490
13251
|
# Validates a Device Defender security profile behaviors specification.
|
11491
13252
|
#
|
13253
|
+
# Requires permission to access the
|
13254
|
+
# [ValidateSecurityProfileBehaviors][1] action.
|
13255
|
+
#
|
13256
|
+
#
|
13257
|
+
#
|
13258
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13259
|
+
#
|
11492
13260
|
# @option params [required, Array<Types::Behavior>] :behaviors
|
11493
13261
|
# Specifies the behaviors that, when violated by a device (thing), cause
|
11494
13262
|
# an alert.
|
@@ -11560,7 +13328,7 @@ module Aws::IoT
|
|
11560
13328
|
params: params,
|
11561
13329
|
config: config)
|
11562
13330
|
context[:gem_name] = 'aws-sdk-iot'
|
11563
|
-
context[:gem_version] = '1.
|
13331
|
+
context[:gem_version] = '1.75.0'
|
11564
13332
|
Seahorse::Client::Request.new(handlers, context)
|
11565
13333
|
end
|
11566
13334
|
|