aws-sdk-iot 1.72.0 → 1.73.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iot/client.rb +1861 -131
- data/lib/aws-sdk-iot/client_api.rb +229 -0
- data/lib/aws-sdk-iot/types.rb +654 -126
- data/lib/aws-sdk-iot.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: df943e8f0ebb7e7fac1534c073c7d5b0f297418b410e4f21170aa3a498320f28
|
4
|
+
data.tar.gz: a4926fc854b918ea1257d943ce98892a04923e1cc63ae180b22e572a668345bf
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e1f85a5707d40a475d0677fc61d8e5be2c8bef37d23e6232f9da1aeef6553f8e14b744991285731a572e7663b4966395aa018d19a613b36614764cf14bd68195
|
7
|
+
data.tar.gz: 45d9233ce57d066f352068164912d3e9a6117e03c2d6dbba87b78c32655917bd30303c7f877770de408db6aa7cb1ddebe7ed3946402c0106f2deb155ca6f3041
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.73.0 (2021-08-31)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* 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.
|
8
|
+
|
4
9
|
1.72.0 (2021-07-30)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.73.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
|
#
|
@@ -3051,6 +3389,13 @@ module Aws::IoT
|
|
3051
3389
|
# Creates a topic rule destination. The destination must be confirmed
|
3052
3390
|
# prior to use.
|
3053
3391
|
#
|
3392
|
+
# Requires permission to access the [CreateTopicRuleDestination][1]
|
3393
|
+
# action.
|
3394
|
+
#
|
3395
|
+
#
|
3396
|
+
#
|
3397
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3398
|
+
#
|
3054
3399
|
# @option params [required, Types::TopicRuleDestinationConfiguration] :destination_configuration
|
3055
3400
|
# The topic rule destination configuration.
|
3056
3401
|
#
|
@@ -3100,6 +3445,13 @@ module Aws::IoT
|
|
3100
3445
|
# account. Any configuration data you entered is deleted and all audit
|
3101
3446
|
# checks are reset to disabled.
|
3102
3447
|
#
|
3448
|
+
# Requires permission to access the [DeleteAccountAuditConfiguration][1]
|
3449
|
+
# action.
|
3450
|
+
#
|
3451
|
+
#
|
3452
|
+
#
|
3453
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3454
|
+
#
|
3103
3455
|
# @option params [Boolean] :delete_scheduled_audits
|
3104
3456
|
# If true, all scheduled audits are deleted.
|
3105
3457
|
#
|
@@ -3120,6 +3472,12 @@ module Aws::IoT
|
|
3120
3472
|
|
3121
3473
|
# Deletes a Device Defender audit suppression.
|
3122
3474
|
#
|
3475
|
+
# Requires permission to access the [DeleteAuditSuppression][1] action.
|
3476
|
+
#
|
3477
|
+
#
|
3478
|
+
#
|
3479
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3480
|
+
#
|
3123
3481
|
# @option params [required, String] :check_name
|
3124
3482
|
# An audit check name. Checks must be enabled for your account. (Use
|
3125
3483
|
# `DescribeAccountAuditConfiguration` to see the list of all checks,
|
@@ -3159,6 +3517,12 @@ module Aws::IoT
|
|
3159
3517
|
|
3160
3518
|
# Deletes an authorizer.
|
3161
3519
|
#
|
3520
|
+
# Requires permission to access the [DeleteAuthorizer][1] action.
|
3521
|
+
#
|
3522
|
+
#
|
3523
|
+
#
|
3524
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3525
|
+
#
|
3162
3526
|
# @option params [required, String] :authorizer_name
|
3163
3527
|
# The name of the authorizer to delete.
|
3164
3528
|
#
|
@@ -3179,6 +3543,12 @@ module Aws::IoT
|
|
3179
3543
|
|
3180
3544
|
# Deletes the billing group.
|
3181
3545
|
#
|
3546
|
+
# Requires permission to access the [DeleteBillingGroup][1] action.
|
3547
|
+
#
|
3548
|
+
#
|
3549
|
+
#
|
3550
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3551
|
+
#
|
3182
3552
|
# @option params [required, String] :billing_group_name
|
3183
3553
|
# The name of the billing group.
|
3184
3554
|
#
|
@@ -3206,6 +3576,12 @@ module Aws::IoT
|
|
3206
3576
|
|
3207
3577
|
# Deletes a registered CA certificate.
|
3208
3578
|
#
|
3579
|
+
# Requires permission to access the [DeleteCACertificate][1] action.
|
3580
|
+
#
|
3581
|
+
#
|
3582
|
+
#
|
3583
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3584
|
+
#
|
3209
3585
|
# @option params [required, String] :certificate_id
|
3210
3586
|
# The ID of the certificate to delete. (The last part of the certificate
|
3211
3587
|
# ARN contains the certificate ID.)
|
@@ -3229,9 +3605,15 @@ module Aws::IoT
|
|
3229
3605
|
#
|
3230
3606
|
# A certificate cannot be deleted if it has a policy or IoT thing
|
3231
3607
|
# attached to it or if its status is set to ACTIVE. To delete a
|
3232
|
-
# certificate, first use the
|
3233
|
-
#
|
3234
|
-
#
|
3608
|
+
# certificate, first use the DetachPolicy action to detach all policies.
|
3609
|
+
# Next, use the UpdateCertificate action to set the certificate to the
|
3610
|
+
# INACTIVE status.
|
3611
|
+
#
|
3612
|
+
# Requires permission to access the [DeleteCertificate][1] action.
|
3613
|
+
#
|
3614
|
+
#
|
3615
|
+
#
|
3616
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3235
3617
|
#
|
3236
3618
|
# @option params [required, String] :certificate_id
|
3237
3619
|
# The ID of the certificate. (The last part of the certificate ARN
|
@@ -3257,19 +3639,22 @@ module Aws::IoT
|
|
3257
3639
|
req.send_request(options)
|
3258
3640
|
end
|
3259
3641
|
|
3642
|
+
# Deletes a Device Defender detect custom metric.
|
3643
|
+
#
|
3644
|
+
# Requires permission to access the [DeleteCustomMetric][1] action.
|
3645
|
+
#
|
3260
3646
|
# <note markdown="1"> Before you can delete a custom metric, you must first remove the
|
3261
3647
|
# custom metric from all security profiles it's a part of. The security
|
3262
3648
|
# profile associated with the custom metric can be found using the
|
3263
|
-
# [ListSecurityProfiles][
|
3649
|
+
# [ListSecurityProfiles][2] API with `metricName` set to your custom
|
3264
3650
|
# metric name.
|
3265
3651
|
#
|
3266
3652
|
# </note>
|
3267
3653
|
#
|
3268
|
-
# Deletes a Device Defender detect custom metric.
|
3269
|
-
#
|
3270
3654
|
#
|
3271
3655
|
#
|
3272
|
-
# [1]: https://docs.aws.amazon.com/
|
3656
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3657
|
+
# [2]: https://docs.aws.amazon.com/iot/latest/apireference/API_ListSecurityProfiles.html
|
3273
3658
|
#
|
3274
3659
|
# @option params [required, String] :metric_name
|
3275
3660
|
# The name of the custom metric.
|
@@ -3289,7 +3674,14 @@ module Aws::IoT
|
|
3289
3674
|
req.send_request(options)
|
3290
3675
|
end
|
3291
3676
|
|
3292
|
-
# Removes the specified dimension from your
|
3677
|
+
# Removes the specified dimension from your Amazon Web Services
|
3678
|
+
# accounts.
|
3679
|
+
#
|
3680
|
+
# Requires permission to access the [DeleteDimension][1] action.
|
3681
|
+
#
|
3682
|
+
#
|
3683
|
+
#
|
3684
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3293
3685
|
#
|
3294
3686
|
# @option params [required, String] :name
|
3295
3687
|
# The unique identifier for the dimension that you want to delete.
|
@@ -3311,6 +3703,13 @@ module Aws::IoT
|
|
3311
3703
|
|
3312
3704
|
# Deletes the specified domain configuration.
|
3313
3705
|
#
|
3706
|
+
# Requires permission to access the [DeleteDomainConfiguration][1]
|
3707
|
+
# action.
|
3708
|
+
#
|
3709
|
+
#
|
3710
|
+
#
|
3711
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3712
|
+
#
|
3314
3713
|
# @option params [required, String] :domain_configuration_name
|
3315
3714
|
# The name of the domain configuration to be deleted.
|
3316
3715
|
#
|
@@ -3331,6 +3730,12 @@ module Aws::IoT
|
|
3331
3730
|
|
3332
3731
|
# Deletes a dynamic thing group.
|
3333
3732
|
#
|
3733
|
+
# Requires permission to access the [DeleteDynamicThingGroup][1] action.
|
3734
|
+
#
|
3735
|
+
#
|
3736
|
+
#
|
3737
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3738
|
+
#
|
3334
3739
|
# @option params [required, String] :thing_group_name
|
3335
3740
|
# The name of the dynamic thing group to delete.
|
3336
3741
|
#
|
@@ -3353,9 +3758,41 @@ module Aws::IoT
|
|
3353
3758
|
req.send_request(options)
|
3354
3759
|
end
|
3355
3760
|
|
3356
|
-
# Deletes
|
3761
|
+
# Deletes the specified fleet metric. Returns successfully with no error
|
3762
|
+
# if the deletion is successful or you specify a fleet metric that
|
3763
|
+
# doesn't exist.
|
3357
3764
|
#
|
3358
|
-
#
|
3765
|
+
# Requires permission to access the [DeleteFleetMetric][1] action.
|
3766
|
+
#
|
3767
|
+
#
|
3768
|
+
#
|
3769
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3770
|
+
#
|
3771
|
+
# @option params [required, String] :metric_name
|
3772
|
+
# The name of the fleet metric to delete.
|
3773
|
+
#
|
3774
|
+
# @option params [Integer] :expected_version
|
3775
|
+
# The expected version of the fleet metric to delete.
|
3776
|
+
#
|
3777
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3778
|
+
#
|
3779
|
+
# @example Request syntax with placeholder values
|
3780
|
+
#
|
3781
|
+
# resp = client.delete_fleet_metric({
|
3782
|
+
# metric_name: "FleetMetricName", # required
|
3783
|
+
# expected_version: 1,
|
3784
|
+
# })
|
3785
|
+
#
|
3786
|
+
# @overload delete_fleet_metric(params = {})
|
3787
|
+
# @param [Hash] params ({})
|
3788
|
+
def delete_fleet_metric(params = {}, options = {})
|
3789
|
+
req = build_request(:delete_fleet_metric, params)
|
3790
|
+
req.send_request(options)
|
3791
|
+
end
|
3792
|
+
|
3793
|
+
# Deletes a job and its related job executions.
|
3794
|
+
#
|
3795
|
+
# Deleting a job may take time, depending on the number of job
|
3359
3796
|
# executions created for the job and various other factors. While the
|
3360
3797
|
# job is being deleted, the status of the job will be shown as
|
3361
3798
|
# "DELETION\_IN\_PROGRESS". Attempting to delete or cancel a job whose
|
@@ -3364,6 +3801,12 @@ module Aws::IoT
|
|
3364
3801
|
# Only 10 jobs may have status "DELETION\_IN\_PROGRESS" at the same
|
3365
3802
|
# time, or a LimitExceededException will occur.
|
3366
3803
|
#
|
3804
|
+
# Requires permission to access the [DeleteJob][1] action.
|
3805
|
+
#
|
3806
|
+
#
|
3807
|
+
#
|
3808
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3809
|
+
#
|
3367
3810
|
# @option params [required, String] :job_id
|
3368
3811
|
# The ID of the job to be deleted.
|
3369
3812
|
#
|
@@ -3388,9 +3831,9 @@ module Aws::IoT
|
|
3388
3831
|
# @option params [String] :namespace_id
|
3389
3832
|
# The namespace used to indicate that a job is a customer-managed job.
|
3390
3833
|
#
|
3391
|
-
# When you specify a value for this parameter,
|
3392
|
-
# notifications to MQTT topics that contain the value in
|
3393
|
-
# format.
|
3834
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
3835
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
3836
|
+
# the following format.
|
3394
3837
|
#
|
3395
3838
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
3396
3839
|
#
|
@@ -3417,6 +3860,12 @@ module Aws::IoT
|
|
3417
3860
|
|
3418
3861
|
# Deletes a job execution.
|
3419
3862
|
#
|
3863
|
+
# Requires permission to access the [DeleteJobExecution][1] action.
|
3864
|
+
#
|
3865
|
+
#
|
3866
|
+
#
|
3867
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3868
|
+
#
|
3420
3869
|
# @option params [required, String] :job_id
|
3421
3870
|
# The ID of the job whose execution on a particular device will be
|
3422
3871
|
# deleted.
|
@@ -3448,9 +3897,9 @@ module Aws::IoT
|
|
3448
3897
|
# @option params [String] :namespace_id
|
3449
3898
|
# The namespace used to indicate that a job is a customer-managed job.
|
3450
3899
|
#
|
3451
|
-
# When you specify a value for this parameter,
|
3452
|
-
# notifications to MQTT topics that contain the value in
|
3453
|
-
# format.
|
3900
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
3901
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
3902
|
+
# the following format.
|
3454
3903
|
#
|
3455
3904
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
3456
3905
|
#
|
@@ -3497,7 +3946,14 @@ module Aws::IoT
|
|
3497
3946
|
req.send_request(options)
|
3498
3947
|
end
|
3499
3948
|
|
3500
|
-
# Deletes a defined mitigation action from your
|
3949
|
+
# Deletes a defined mitigation action from your Amazon Web Services
|
3950
|
+
# accounts.
|
3951
|
+
#
|
3952
|
+
# Requires permission to access the [DeleteMitigationAction][1] action.
|
3953
|
+
#
|
3954
|
+
#
|
3955
|
+
#
|
3956
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3501
3957
|
#
|
3502
3958
|
# @option params [required, String] :action_name
|
3503
3959
|
# The name of the mitigation action that you want to delete.
|
@@ -3519,6 +3975,12 @@ module Aws::IoT
|
|
3519
3975
|
|
3520
3976
|
# Delete an OTA update.
|
3521
3977
|
#
|
3978
|
+
# Requires permission to access the [DeleteOTAUpdate][1] action.
|
3979
|
+
#
|
3980
|
+
#
|
3981
|
+
#
|
3982
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3983
|
+
#
|
3522
3984
|
# @option params [required, String] :ota_update_id
|
3523
3985
|
# The ID of the OTA update to delete.
|
3524
3986
|
#
|
@@ -3528,7 +3990,7 @@ module Aws::IoT
|
|
3528
3990
|
# OTAUpdate is supplied by the user.
|
3529
3991
|
#
|
3530
3992
|
# @option params [Boolean] :force_delete_aws_job
|
3531
|
-
# When true, deletes the
|
3993
|
+
# When true, deletes the IoT job created by the OTAUpdate process even
|
3532
3994
|
# if it is "IN\_PROGRESS". Otherwise, if the job is not in a terminal
|
3533
3995
|
# state ("COMPLETED" or "CANCELED") an exception will occur. The
|
3534
3996
|
# default is false.
|
@@ -3555,14 +4017,26 @@ module Aws::IoT
|
|
3555
4017
|
# A policy cannot be deleted if it has non-default versions or it is
|
3556
4018
|
# attached to any certificate.
|
3557
4019
|
#
|
3558
|
-
# To delete a policy, use the DeletePolicyVersion
|
3559
|
-
# non-default versions of the policy; use the
|
3560
|
-
#
|
3561
|
-
#
|
4020
|
+
# To delete a policy, use the DeletePolicyVersion action to delete all
|
4021
|
+
# non-default versions of the policy; use the DetachPolicy action to
|
4022
|
+
# detach the policy from any certificate; and then use the DeletePolicy
|
4023
|
+
# action to delete the policy.
|
3562
4024
|
#
|
3563
4025
|
# When a policy is deleted using DeletePolicy, its default version is
|
3564
4026
|
# deleted with it.
|
3565
4027
|
#
|
4028
|
+
# <note markdown="1"> Because of the distributed nature of Amazon Web Services, it can take
|
4029
|
+
# up to five minutes after a policy is detached before it's ready to be
|
4030
|
+
# deleted.
|
4031
|
+
#
|
4032
|
+
# </note>
|
4033
|
+
#
|
4034
|
+
# Requires permission to access the [DeletePolicy][1] action.
|
4035
|
+
#
|
4036
|
+
#
|
4037
|
+
#
|
4038
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4039
|
+
#
|
3566
4040
|
# @option params [required, String] :policy_name
|
3567
4041
|
# The name of the policy to delete.
|
3568
4042
|
#
|
@@ -3582,11 +4056,17 @@ module Aws::IoT
|
|
3582
4056
|
end
|
3583
4057
|
|
3584
4058
|
# 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
|
4059
|
+
# delete the default version of a policy using this action. To delete
|
4060
|
+
# the default version of a policy, use DeletePolicy. To find out which
|
3587
4061
|
# version of a policy is marked as the default version, use
|
3588
4062
|
# ListPolicyVersions.
|
3589
4063
|
#
|
4064
|
+
# Requires permission to access the [DeletePolicyVersion][1] action.
|
4065
|
+
#
|
4066
|
+
#
|
4067
|
+
#
|
4068
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4069
|
+
#
|
3590
4070
|
# @option params [required, String] :policy_name
|
3591
4071
|
# The name of the policy.
|
3592
4072
|
#
|
@@ -3611,6 +4091,13 @@ module Aws::IoT
|
|
3611
4091
|
|
3612
4092
|
# Deletes a fleet provisioning template.
|
3613
4093
|
#
|
4094
|
+
# Requires permission to access the [DeleteProvisioningTemplate][1]
|
4095
|
+
# action.
|
4096
|
+
#
|
4097
|
+
#
|
4098
|
+
#
|
4099
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4100
|
+
#
|
3614
4101
|
# @option params [required, String] :template_name
|
3615
4102
|
# The name of the fleet provision template to delete.
|
3616
4103
|
#
|
@@ -3631,6 +4118,13 @@ module Aws::IoT
|
|
3631
4118
|
|
3632
4119
|
# Deletes a fleet provisioning template version.
|
3633
4120
|
#
|
4121
|
+
# Requires permission to access the
|
4122
|
+
# [DeleteProvisioningTemplateVersion][1] action.
|
4123
|
+
#
|
4124
|
+
#
|
4125
|
+
#
|
4126
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4127
|
+
#
|
3634
4128
|
# @option params [required, String] :template_name
|
3635
4129
|
# The name of the fleet provisioning template version to delete.
|
3636
4130
|
#
|
@@ -3655,6 +4149,12 @@ module Aws::IoT
|
|
3655
4149
|
|
3656
4150
|
# Deletes a CA certificate registration code.
|
3657
4151
|
#
|
4152
|
+
# Requires permission to access the [DeleteRegistrationCode][1] action.
|
4153
|
+
#
|
4154
|
+
#
|
4155
|
+
#
|
4156
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4157
|
+
#
|
3658
4158
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3659
4159
|
#
|
3660
4160
|
# @overload delete_registration_code(params = {})
|
@@ -3666,6 +4166,12 @@ module Aws::IoT
|
|
3666
4166
|
|
3667
4167
|
# Deletes a role alias
|
3668
4168
|
#
|
4169
|
+
# Requires permission to access the [DeleteRoleAlias][1] action.
|
4170
|
+
#
|
4171
|
+
#
|
4172
|
+
#
|
4173
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4174
|
+
#
|
3669
4175
|
# @option params [required, String] :role_alias
|
3670
4176
|
# The role alias to delete.
|
3671
4177
|
#
|
@@ -3686,6 +4192,12 @@ module Aws::IoT
|
|
3686
4192
|
|
3687
4193
|
# Deletes a scheduled audit.
|
3688
4194
|
#
|
4195
|
+
# Requires permission to access the [DeleteScheduledAudit][1] action.
|
4196
|
+
#
|
4197
|
+
#
|
4198
|
+
#
|
4199
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4200
|
+
#
|
3689
4201
|
# @option params [required, String] :scheduled_audit_name
|
3690
4202
|
# The name of the scheduled audit you want to delete.
|
3691
4203
|
#
|
@@ -3706,6 +4218,12 @@ module Aws::IoT
|
|
3706
4218
|
|
3707
4219
|
# Deletes a Device Defender security profile.
|
3708
4220
|
#
|
4221
|
+
# Requires permission to access the [DeleteSecurityProfile][1] action.
|
4222
|
+
#
|
4223
|
+
#
|
4224
|
+
#
|
4225
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4226
|
+
#
|
3709
4227
|
# @option params [required, String] :security_profile_name
|
3710
4228
|
# The name of the security profile to be deleted.
|
3711
4229
|
#
|
@@ -3733,6 +4251,12 @@ module Aws::IoT
|
|
3733
4251
|
|
3734
4252
|
# Deletes a stream.
|
3735
4253
|
#
|
4254
|
+
# Requires permission to access the [DeleteStream][1] action.
|
4255
|
+
#
|
4256
|
+
#
|
4257
|
+
#
|
4258
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4259
|
+
#
|
3736
4260
|
# @option params [required, String] :stream_id
|
3737
4261
|
# The stream ID.
|
3738
4262
|
#
|
@@ -3754,6 +4278,12 @@ module Aws::IoT
|
|
3754
4278
|
# Deletes the specified thing. Returns successfully with no error if the
|
3755
4279
|
# deletion is successful or you specify a thing that doesn't exist.
|
3756
4280
|
#
|
4281
|
+
# Requires permission to access the [DeleteThing][1] action.
|
4282
|
+
#
|
4283
|
+
#
|
4284
|
+
#
|
4285
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4286
|
+
#
|
3757
4287
|
# @option params [required, String] :thing_name
|
3758
4288
|
# The name of the thing to delete.
|
3759
4289
|
#
|
@@ -3781,6 +4311,12 @@ module Aws::IoT
|
|
3781
4311
|
|
3782
4312
|
# Deletes a thing group.
|
3783
4313
|
#
|
4314
|
+
# Requires permission to access the [DeleteThingGroup][1] action.
|
4315
|
+
#
|
4316
|
+
#
|
4317
|
+
#
|
4318
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4319
|
+
#
|
3784
4320
|
# @option params [required, String] :thing_group_name
|
3785
4321
|
# The name of the thing group to delete.
|
3786
4322
|
#
|
@@ -3810,6 +4346,12 @@ module Aws::IoT
|
|
3810
4346
|
# any associated thing, and finally use DeleteThingType to delete the
|
3811
4347
|
# thing type.
|
3812
4348
|
#
|
4349
|
+
# Requires permission to access the [DeleteThingType][1] action.
|
4350
|
+
#
|
4351
|
+
#
|
4352
|
+
#
|
4353
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4354
|
+
#
|
3813
4355
|
# @option params [required, String] :thing_type_name
|
3814
4356
|
# The name of the thing type.
|
3815
4357
|
#
|
@@ -3830,6 +4372,12 @@ module Aws::IoT
|
|
3830
4372
|
|
3831
4373
|
# Deletes the rule.
|
3832
4374
|
#
|
4375
|
+
# Requires permission to access the [DeleteTopicRule][1] action.
|
4376
|
+
#
|
4377
|
+
#
|
4378
|
+
#
|
4379
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4380
|
+
#
|
3833
4381
|
# @option params [required, String] :rule_name
|
3834
4382
|
# The name of the rule.
|
3835
4383
|
#
|
@@ -3850,6 +4398,13 @@ module Aws::IoT
|
|
3850
4398
|
|
3851
4399
|
# Deletes a topic rule destination.
|
3852
4400
|
#
|
4401
|
+
# Requires permission to access the [DeleteTopicRuleDestination][1]
|
4402
|
+
# action.
|
4403
|
+
#
|
4404
|
+
#
|
4405
|
+
#
|
4406
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4407
|
+
#
|
3853
4408
|
# @option params [required, String] :arn
|
3854
4409
|
# The ARN of the topic rule destination to delete.
|
3855
4410
|
#
|
@@ -3870,6 +4425,12 @@ module Aws::IoT
|
|
3870
4425
|
|
3871
4426
|
# Deletes a logging level.
|
3872
4427
|
#
|
4428
|
+
# Requires permission to access the [DeleteV2LoggingLevel][1] action.
|
4429
|
+
#
|
4430
|
+
#
|
4431
|
+
#
|
4432
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4433
|
+
#
|
3873
4434
|
# @option params [required, String] :target_type
|
3874
4435
|
# The type of resource for which you are configuring logging. Must be
|
3875
4436
|
# `THING_Group`.
|
@@ -3896,6 +4457,12 @@ module Aws::IoT
|
|
3896
4457
|
# Deprecates a thing type. You can not associate new things with
|
3897
4458
|
# deprecated thing type.
|
3898
4459
|
#
|
4460
|
+
# Requires permission to access the [DeprecateThingType][1] action.
|
4461
|
+
#
|
4462
|
+
#
|
4463
|
+
#
|
4464
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4465
|
+
#
|
3899
4466
|
# @option params [required, String] :thing_type_name
|
3900
4467
|
# The name of the thing type to deprecate.
|
3901
4468
|
#
|
@@ -3924,6 +4491,13 @@ module Aws::IoT
|
|
3924
4491
|
# account. Settings include how audit notifications are sent and which
|
3925
4492
|
# audit checks are enabled or disabled.
|
3926
4493
|
#
|
4494
|
+
# Requires permission to access the
|
4495
|
+
# [DescribeAccountAuditConfiguration][1] action.
|
4496
|
+
#
|
4497
|
+
#
|
4498
|
+
#
|
4499
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4500
|
+
#
|
3927
4501
|
# @return [Types::DescribeAccountAuditConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3928
4502
|
#
|
3929
4503
|
# * {Types::DescribeAccountAuditConfigurationResponse#role_arn #role_arn} => String
|
@@ -3951,6 +4525,12 @@ module Aws::IoT
|
|
3951
4525
|
# reason for noncompliance, the severity of the issue, and the start
|
3952
4526
|
# time when the audit that returned the finding.
|
3953
4527
|
#
|
4528
|
+
# Requires permission to access the [DescribeAuditFinding][1] action.
|
4529
|
+
#
|
4530
|
+
#
|
4531
|
+
#
|
4532
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4533
|
+
#
|
3954
4534
|
# @option params [required, String] :finding_id
|
3955
4535
|
# A unique identifier for a single audit finding. You can use this
|
3956
4536
|
# identifier to apply mitigation actions to the finding.
|
@@ -4137,6 +4717,12 @@ module Aws::IoT
|
|
4137
4717
|
|
4138
4718
|
# Gets information about a Device Defender audit.
|
4139
4719
|
#
|
4720
|
+
# Requires permission to access the [DescribeAuditTask][1] action.
|
4721
|
+
#
|
4722
|
+
#
|
4723
|
+
#
|
4724
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4725
|
+
#
|
4140
4726
|
# @option params [required, String] :task_id
|
4141
4727
|
# The ID of the audit whose information you want to get.
|
4142
4728
|
#
|
@@ -4186,6 +4772,12 @@ module Aws::IoT
|
|
4186
4772
|
|
4187
4773
|
# Describes an authorizer.
|
4188
4774
|
#
|
4775
|
+
# Requires permission to access the [DescribeAuthorizer][1] action.
|
4776
|
+
#
|
4777
|
+
#
|
4778
|
+
#
|
4779
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4780
|
+
#
|
4189
4781
|
# @option params [required, String] :authorizer_name
|
4190
4782
|
# The name of the authorizer to describe.
|
4191
4783
|
#
|
@@ -4221,6 +4813,12 @@ module Aws::IoT
|
|
4221
4813
|
|
4222
4814
|
# Returns information about a billing group.
|
4223
4815
|
#
|
4816
|
+
# Requires permission to access the [DescribeBillingGroup][1] action.
|
4817
|
+
#
|
4818
|
+
#
|
4819
|
+
#
|
4820
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4821
|
+
#
|
4224
4822
|
# @option params [required, String] :billing_group_name
|
4225
4823
|
# The name of the billing group.
|
4226
4824
|
#
|
@@ -4257,6 +4855,12 @@ module Aws::IoT
|
|
4257
4855
|
|
4258
4856
|
# Describes a registered CA certificate.
|
4259
4857
|
#
|
4858
|
+
# Requires permission to access the [DescribeCACertificate][1] action.
|
4859
|
+
#
|
4860
|
+
#
|
4861
|
+
#
|
4862
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4863
|
+
#
|
4260
4864
|
# @option params [required, String] :certificate_id
|
4261
4865
|
# The CA certificate identifier.
|
4262
4866
|
#
|
@@ -4297,6 +4901,12 @@ module Aws::IoT
|
|
4297
4901
|
|
4298
4902
|
# Gets information about the specified certificate.
|
4299
4903
|
#
|
4904
|
+
# Requires permission to access the [DescribeCertificate][1] action.
|
4905
|
+
#
|
4906
|
+
#
|
4907
|
+
#
|
4908
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4909
|
+
#
|
4300
4910
|
# @option params [required, String] :certificate_id
|
4301
4911
|
# The ID of the certificate. (The last part of the certificate ARN
|
4302
4912
|
# contains the certificate ID.)
|
@@ -4342,6 +4952,12 @@ module Aws::IoT
|
|
4342
4952
|
|
4343
4953
|
# Gets information about a Device Defender detect custom metric.
|
4344
4954
|
#
|
4955
|
+
# Requires permission to access the [DescribeCustomMetric][1] action.
|
4956
|
+
#
|
4957
|
+
#
|
4958
|
+
#
|
4959
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4960
|
+
#
|
4345
4961
|
# @option params [required, String] :metric_name
|
4346
4962
|
# The name of the custom metric.
|
4347
4963
|
#
|
@@ -4378,6 +4994,13 @@ module Aws::IoT
|
|
4378
4994
|
|
4379
4995
|
# Describes the default authorizer.
|
4380
4996
|
#
|
4997
|
+
# Requires permission to access the [DescribeDefaultAuthorizer][1]
|
4998
|
+
# action.
|
4999
|
+
#
|
5000
|
+
#
|
5001
|
+
#
|
5002
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5003
|
+
#
|
4381
5004
|
# @return [Types::DescribeDefaultAuthorizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4382
5005
|
#
|
4383
5006
|
# * {Types::DescribeDefaultAuthorizerResponse#authorizer_description #authorizer_description} => Types::AuthorizerDescription
|
@@ -4404,6 +5027,13 @@ module Aws::IoT
|
|
4404
5027
|
|
4405
5028
|
# Gets information about a Device Defender ML Detect mitigation action.
|
4406
5029
|
#
|
5030
|
+
# Requires permission to access the
|
5031
|
+
# [DescribeDetectMitigationActionsTask][1] action.
|
5032
|
+
#
|
5033
|
+
#
|
5034
|
+
#
|
5035
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5036
|
+
#
|
4407
5037
|
# @option params [required, String] :task_id
|
4408
5038
|
# The unique identifier of the task.
|
4409
5039
|
#
|
@@ -4455,8 +5085,14 @@ module Aws::IoT
|
|
4455
5085
|
req.send_request(options)
|
4456
5086
|
end
|
4457
5087
|
|
4458
|
-
# Provides details about a dimension that is defined in your
|
4459
|
-
#
|
5088
|
+
# Provides details about a dimension that is defined in your Amazon Web
|
5089
|
+
# Services accounts.
|
5090
|
+
#
|
5091
|
+
# Requires permission to access the [DescribeDimension][1] action.
|
5092
|
+
#
|
5093
|
+
#
|
5094
|
+
#
|
5095
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4460
5096
|
#
|
4461
5097
|
# @option params [required, String] :name
|
4462
5098
|
# The unique identifier for the dimension.
|
@@ -4495,6 +5131,13 @@ module Aws::IoT
|
|
4495
5131
|
|
4496
5132
|
# Gets summary information about a domain configuration.
|
4497
5133
|
#
|
5134
|
+
# Requires permission to access the [DescribeDomainConfiguration][1]
|
5135
|
+
# action.
|
5136
|
+
#
|
5137
|
+
#
|
5138
|
+
#
|
5139
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5140
|
+
#
|
4498
5141
|
# @option params [required, String] :domain_configuration_name
|
4499
5142
|
# The name of the domain configuration.
|
4500
5143
|
#
|
@@ -4539,7 +5182,14 @@ module Aws::IoT
|
|
4539
5182
|
req.send_request(options)
|
4540
5183
|
end
|
4541
5184
|
|
4542
|
-
# Returns a unique endpoint specific to the
|
5185
|
+
# Returns a unique endpoint specific to the Amazon Web Services account
|
5186
|
+
# making the call.
|
5187
|
+
#
|
5188
|
+
# Requires permission to access the [DescribeEndpoint][1] action.
|
5189
|
+
#
|
5190
|
+
#
|
5191
|
+
#
|
5192
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4543
5193
|
#
|
4544
5194
|
# @option params [String] :endpoint_type
|
4545
5195
|
# The endpoint type. Valid endpoint types include:
|
@@ -4554,13 +5204,13 @@ module Aws::IoT
|
|
4554
5204
|
# ^
|
4555
5205
|
# ^
|
4556
5206
|
#
|
4557
|
-
# * `iot:CredentialProvider` - Returns an
|
4558
|
-
#
|
5207
|
+
# * `iot:CredentialProvider` - Returns an IoT credentials provider API
|
5208
|
+
# endpoint.
|
4559
5209
|
#
|
4560
5210
|
# ^
|
4561
5211
|
# ^
|
4562
5212
|
#
|
4563
|
-
# * `iot:Jobs` - Returns an
|
5213
|
+
# * `iot:Jobs` - Returns an IoT device management Jobs API endpoint.
|
4564
5214
|
#
|
4565
5215
|
# ^
|
4566
5216
|
#
|
@@ -4591,6 +5241,13 @@ module Aws::IoT
|
|
4591
5241
|
|
4592
5242
|
# Describes event configurations.
|
4593
5243
|
#
|
5244
|
+
# Requires permission to access the [DescribeEventConfigurations][1]
|
5245
|
+
# action.
|
5246
|
+
#
|
5247
|
+
#
|
5248
|
+
#
|
5249
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5250
|
+
#
|
4594
5251
|
# @return [Types::DescribeEventConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4595
5252
|
#
|
4596
5253
|
# * {Types::DescribeEventConfigurationsResponse#event_configurations #event_configurations} => Hash<String,Types::Configuration>
|
@@ -4611,8 +5268,72 @@ module Aws::IoT
|
|
4611
5268
|
req.send_request(options)
|
4612
5269
|
end
|
4613
5270
|
|
5271
|
+
# Gets information about the specified fleet metric.
|
5272
|
+
#
|
5273
|
+
# Requires permission to access the [DescribeFleetMetric][1] action.
|
5274
|
+
#
|
5275
|
+
#
|
5276
|
+
#
|
5277
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5278
|
+
#
|
5279
|
+
# @option params [required, String] :metric_name
|
5280
|
+
# The name of the fleet metric to describe.
|
5281
|
+
#
|
5282
|
+
# @return [Types::DescribeFleetMetricResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5283
|
+
#
|
5284
|
+
# * {Types::DescribeFleetMetricResponse#metric_name #metric_name} => String
|
5285
|
+
# * {Types::DescribeFleetMetricResponse#query_string #query_string} => String
|
5286
|
+
# * {Types::DescribeFleetMetricResponse#aggregation_type #aggregation_type} => Types::AggregationType
|
5287
|
+
# * {Types::DescribeFleetMetricResponse#period #period} => Integer
|
5288
|
+
# * {Types::DescribeFleetMetricResponse#aggregation_field #aggregation_field} => String
|
5289
|
+
# * {Types::DescribeFleetMetricResponse#description #description} => String
|
5290
|
+
# * {Types::DescribeFleetMetricResponse#query_version #query_version} => String
|
5291
|
+
# * {Types::DescribeFleetMetricResponse#index_name #index_name} => String
|
5292
|
+
# * {Types::DescribeFleetMetricResponse#creation_date #creation_date} => Time
|
5293
|
+
# * {Types::DescribeFleetMetricResponse#last_modified_date #last_modified_date} => Time
|
5294
|
+
# * {Types::DescribeFleetMetricResponse#unit #unit} => String
|
5295
|
+
# * {Types::DescribeFleetMetricResponse#version #version} => Integer
|
5296
|
+
# * {Types::DescribeFleetMetricResponse#metric_arn #metric_arn} => String
|
5297
|
+
#
|
5298
|
+
# @example Request syntax with placeholder values
|
5299
|
+
#
|
5300
|
+
# resp = client.describe_fleet_metric({
|
5301
|
+
# metric_name: "FleetMetricName", # required
|
5302
|
+
# })
|
5303
|
+
#
|
5304
|
+
# @example Response structure
|
5305
|
+
#
|
5306
|
+
# resp.metric_name #=> String
|
5307
|
+
# resp.query_string #=> String
|
5308
|
+
# resp.aggregation_type.name #=> String, one of "Statistics", "Percentiles", "Cardinality"
|
5309
|
+
# resp.aggregation_type.values #=> Array
|
5310
|
+
# resp.aggregation_type.values[0] #=> String
|
5311
|
+
# resp.period #=> Integer
|
5312
|
+
# resp.aggregation_field #=> String
|
5313
|
+
# resp.description #=> String
|
5314
|
+
# resp.query_version #=> String
|
5315
|
+
# resp.index_name #=> String
|
5316
|
+
# resp.creation_date #=> Time
|
5317
|
+
# resp.last_modified_date #=> Time
|
5318
|
+
# 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"
|
5319
|
+
# resp.version #=> Integer
|
5320
|
+
# resp.metric_arn #=> String
|
5321
|
+
#
|
5322
|
+
# @overload describe_fleet_metric(params = {})
|
5323
|
+
# @param [Hash] params ({})
|
5324
|
+
def describe_fleet_metric(params = {}, options = {})
|
5325
|
+
req = build_request(:describe_fleet_metric, params)
|
5326
|
+
req.send_request(options)
|
5327
|
+
end
|
5328
|
+
|
4614
5329
|
# Describes a search index.
|
4615
5330
|
#
|
5331
|
+
# Requires permission to access the [DescribeIndex][1] action.
|
5332
|
+
#
|
5333
|
+
#
|
5334
|
+
#
|
5335
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5336
|
+
#
|
4616
5337
|
# @option params [required, String] :index_name
|
4617
5338
|
# The index name.
|
4618
5339
|
#
|
@@ -4643,6 +5364,12 @@ module Aws::IoT
|
|
4643
5364
|
|
4644
5365
|
# Describes a job.
|
4645
5366
|
#
|
5367
|
+
# Requires permission to access the [DescribeJob][1] action.
|
5368
|
+
#
|
5369
|
+
#
|
5370
|
+
#
|
5371
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5372
|
+
#
|
4646
5373
|
# @option params [required, String] :job_id
|
4647
5374
|
# The unique identifier you assigned to this job when it was created.
|
4648
5375
|
#
|
@@ -4708,6 +5435,12 @@ module Aws::IoT
|
|
4708
5435
|
|
4709
5436
|
# Describes a job execution.
|
4710
5437
|
#
|
5438
|
+
# Requires permission to access the [DescribeJobExecution][1] action.
|
5439
|
+
#
|
5440
|
+
#
|
5441
|
+
#
|
5442
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5443
|
+
#
|
4711
5444
|
# @option params [required, String] :job_id
|
4712
5445
|
# The unique identifier you assigned to this job when it was created.
|
4713
5446
|
#
|
@@ -4807,6 +5540,13 @@ module Aws::IoT
|
|
4807
5540
|
|
4808
5541
|
# Gets information about a mitigation action.
|
4809
5542
|
#
|
5543
|
+
# Requires permission to access the [DescribeMitigationAction][1]
|
5544
|
+
# action.
|
5545
|
+
#
|
5546
|
+
#
|
5547
|
+
#
|
5548
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5549
|
+
#
|
4810
5550
|
# @option params [required, String] :action_name
|
4811
5551
|
# The friendly name that uniquely identifies the mitigation action.
|
4812
5552
|
#
|
@@ -4855,6 +5595,13 @@ module Aws::IoT
|
|
4855
5595
|
|
4856
5596
|
# Returns information about a fleet provisioning template.
|
4857
5597
|
#
|
5598
|
+
# Requires permission to access the [DescribeProvisioningTemplate][1]
|
5599
|
+
# action.
|
5600
|
+
#
|
5601
|
+
#
|
5602
|
+
#
|
5603
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5604
|
+
#
|
4858
5605
|
# @option params [required, String] :template_name
|
4859
5606
|
# The name of the fleet provisioning template.
|
4860
5607
|
#
|
@@ -4900,6 +5647,13 @@ module Aws::IoT
|
|
4900
5647
|
|
4901
5648
|
# Returns information about a fleet provisioning template version.
|
4902
5649
|
#
|
5650
|
+
# Requires permission to access the
|
5651
|
+
# [DescribeProvisioningTemplateVersion][1] action.
|
5652
|
+
#
|
5653
|
+
#
|
5654
|
+
#
|
5655
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5656
|
+
#
|
4903
5657
|
# @option params [required, String] :template_name
|
4904
5658
|
# The template name.
|
4905
5659
|
#
|
@@ -4936,6 +5690,12 @@ module Aws::IoT
|
|
4936
5690
|
|
4937
5691
|
# Describes a role alias.
|
4938
5692
|
#
|
5693
|
+
# Requires permission to access the [DescribeRoleAlias][1] action.
|
5694
|
+
#
|
5695
|
+
#
|
5696
|
+
#
|
5697
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5698
|
+
#
|
4939
5699
|
# @option params [required, String] :role_alias
|
4940
5700
|
# The role alias to describe.
|
4941
5701
|
#
|
@@ -4968,6 +5728,12 @@ module Aws::IoT
|
|
4968
5728
|
|
4969
5729
|
# Gets information about a scheduled audit.
|
4970
5730
|
#
|
5731
|
+
# Requires permission to access the [DescribeScheduledAudit][1] action.
|
5732
|
+
#
|
5733
|
+
#
|
5734
|
+
#
|
5735
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5736
|
+
#
|
4971
5737
|
# @option params [required, String] :scheduled_audit_name
|
4972
5738
|
# The name of the scheduled audit whose information you want to get.
|
4973
5739
|
#
|
@@ -5005,6 +5771,12 @@ module Aws::IoT
|
|
5005
5771
|
|
5006
5772
|
# Gets information about a Device Defender security profile.
|
5007
5773
|
#
|
5774
|
+
# Requires permission to access the [DescribeSecurityProfile][1] action.
|
5775
|
+
#
|
5776
|
+
#
|
5777
|
+
#
|
5778
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5779
|
+
#
|
5008
5780
|
# @option params [required, String] :security_profile_name
|
5009
5781
|
# The name of the security profile whose information you want to get.
|
5010
5782
|
#
|
@@ -5076,6 +5848,12 @@ module Aws::IoT
|
|
5076
5848
|
|
5077
5849
|
# Gets information about a stream.
|
5078
5850
|
#
|
5851
|
+
# Requires permission to access the [DescribeStream][1] action.
|
5852
|
+
#
|
5853
|
+
#
|
5854
|
+
#
|
5855
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5856
|
+
#
|
5079
5857
|
# @option params [required, String] :stream_id
|
5080
5858
|
# The stream ID.
|
5081
5859
|
#
|
@@ -5113,6 +5891,12 @@ module Aws::IoT
|
|
5113
5891
|
|
5114
5892
|
# Gets information about the specified thing.
|
5115
5893
|
#
|
5894
|
+
# Requires permission to access the [DescribeThing][1] action.
|
5895
|
+
#
|
5896
|
+
#
|
5897
|
+
#
|
5898
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5899
|
+
#
|
5116
5900
|
# @option params [required, String] :thing_name
|
5117
5901
|
# The name of the thing.
|
5118
5902
|
#
|
@@ -5154,6 +5938,12 @@ module Aws::IoT
|
|
5154
5938
|
|
5155
5939
|
# Describe a thing group.
|
5156
5940
|
#
|
5941
|
+
# Requires permission to access the [DescribeThingGroup][1] action.
|
5942
|
+
#
|
5943
|
+
#
|
5944
|
+
#
|
5945
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5946
|
+
#
|
5157
5947
|
# @option params [required, String] :thing_group_name
|
5158
5948
|
# The name of the thing group.
|
5159
5949
|
#
|
@@ -5205,6 +5995,13 @@ module Aws::IoT
|
|
5205
5995
|
|
5206
5996
|
# Describes a bulk thing provisioning task.
|
5207
5997
|
#
|
5998
|
+
# Requires permission to access the [DescribeThingRegistrationTask][1]
|
5999
|
+
# action.
|
6000
|
+
#
|
6001
|
+
#
|
6002
|
+
#
|
6003
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6004
|
+
#
|
5208
6005
|
# @option params [required, String] :task_id
|
5209
6006
|
# The task ID.
|
5210
6007
|
#
|
@@ -5253,6 +6050,12 @@ module Aws::IoT
|
|
5253
6050
|
|
5254
6051
|
# Gets information about the specified thing type.
|
5255
6052
|
#
|
6053
|
+
# Requires permission to access the [DescribeThingType][1] action.
|
6054
|
+
#
|
6055
|
+
#
|
6056
|
+
#
|
6057
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6058
|
+
#
|
5256
6059
|
# @option params [required, String] :thing_type_name
|
5257
6060
|
# The name of the thing type.
|
5258
6061
|
#
|
@@ -5291,6 +6094,18 @@ module Aws::IoT
|
|
5291
6094
|
|
5292
6095
|
# Detaches a policy from the specified target.
|
5293
6096
|
#
|
6097
|
+
# <note markdown="1"> Because of the distributed nature of Amazon Web Services, it can take
|
6098
|
+
# up to five minutes after a policy is detached before it's ready to be
|
6099
|
+
# deleted.
|
6100
|
+
#
|
6101
|
+
# </note>
|
6102
|
+
#
|
6103
|
+
# Requires permission to access the [DetachPolicy][1] action.
|
6104
|
+
#
|
6105
|
+
#
|
6106
|
+
#
|
6107
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6108
|
+
#
|
5294
6109
|
# @option params [required, String] :policy_name
|
5295
6110
|
# The policy to detach.
|
5296
6111
|
#
|
@@ -5315,7 +6130,15 @@ module Aws::IoT
|
|
5315
6130
|
|
5316
6131
|
# Removes the specified policy from the specified certificate.
|
5317
6132
|
#
|
5318
|
-
#
|
6133
|
+
# <note markdown="1"> This action is deprecated. Please use DetachPolicy instead.
|
6134
|
+
#
|
6135
|
+
# </note>
|
6136
|
+
#
|
6137
|
+
# Requires permission to access the [DetachPrincipalPolicy][1] action.
|
6138
|
+
#
|
6139
|
+
#
|
6140
|
+
#
|
6141
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5319
6142
|
#
|
5320
6143
|
# @option params [required, String] :policy_name
|
5321
6144
|
# The name of the policy to detach.
|
@@ -5348,6 +6171,12 @@ module Aws::IoT
|
|
5348
6171
|
# Disassociates a Device Defender security profile from a thing group or
|
5349
6172
|
# from this account.
|
5350
6173
|
#
|
6174
|
+
# Requires permission to access the [DetachSecurityProfile][1] action.
|
6175
|
+
#
|
6176
|
+
#
|
6177
|
+
#
|
6178
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6179
|
+
#
|
5351
6180
|
# @option params [required, String] :security_profile_name
|
5352
6181
|
# The security profile that is detached.
|
5353
6182
|
#
|
@@ -5380,6 +6209,12 @@ module Aws::IoT
|
|
5380
6209
|
#
|
5381
6210
|
# </note>
|
5382
6211
|
#
|
6212
|
+
# Requires permission to access the [DetachThingPrincipal][1] action.
|
6213
|
+
#
|
6214
|
+
#
|
6215
|
+
#
|
6216
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6217
|
+
#
|
5383
6218
|
# @option params [required, String] :thing_name
|
5384
6219
|
# The name of the thing.
|
5385
6220
|
#
|
@@ -5406,6 +6241,12 @@ module Aws::IoT
|
|
5406
6241
|
|
5407
6242
|
# Disables the rule.
|
5408
6243
|
#
|
6244
|
+
# Requires permission to access the [DisableTopicRule][1] action.
|
6245
|
+
#
|
6246
|
+
#
|
6247
|
+
#
|
6248
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6249
|
+
#
|
5409
6250
|
# @option params [required, String] :rule_name
|
5410
6251
|
# The name of the rule to disable.
|
5411
6252
|
#
|
@@ -5426,6 +6267,12 @@ module Aws::IoT
|
|
5426
6267
|
|
5427
6268
|
# Enables the rule.
|
5428
6269
|
#
|
6270
|
+
# Requires permission to access the [EnableTopicRule][1] action.
|
6271
|
+
#
|
6272
|
+
#
|
6273
|
+
#
|
6274
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6275
|
+
#
|
5429
6276
|
# @option params [required, String] :rule_name
|
5430
6277
|
# The name of the topic rule to enable.
|
5431
6278
|
#
|
@@ -5447,6 +6294,13 @@ module Aws::IoT
|
|
5447
6294
|
# Returns a Device Defender's ML Detect Security Profile training
|
5448
6295
|
# model's status.
|
5449
6296
|
#
|
6297
|
+
# Requires permission to access the
|
6298
|
+
# [GetBehaviorModelTrainingSummaries][1] action.
|
6299
|
+
#
|
6300
|
+
#
|
6301
|
+
#
|
6302
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6303
|
+
#
|
5450
6304
|
# @option params [String] :security_profile_name
|
5451
6305
|
# The name of the security profile.
|
5452
6306
|
#
|
@@ -5490,13 +6344,77 @@ module Aws::IoT
|
|
5490
6344
|
req.send_request(options)
|
5491
6345
|
end
|
5492
6346
|
|
6347
|
+
# Aggregates on indexed data with search queries pertaining to
|
6348
|
+
# particular fields.
|
6349
|
+
#
|
6350
|
+
# Requires permission to access the [GetBucketsAggregation][1] action.
|
6351
|
+
#
|
6352
|
+
#
|
6353
|
+
#
|
6354
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6355
|
+
#
|
6356
|
+
# @option params [String] :index_name
|
6357
|
+
# The name of the index to search.
|
6358
|
+
#
|
6359
|
+
# @option params [required, String] :query_string
|
6360
|
+
# The search query string.
|
6361
|
+
#
|
6362
|
+
# @option params [required, String] :aggregation_field
|
6363
|
+
# The aggregation field.
|
6364
|
+
#
|
6365
|
+
# @option params [String] :query_version
|
6366
|
+
# The version of the query.
|
6367
|
+
#
|
6368
|
+
# @option params [required, Types::BucketsAggregationType] :buckets_aggregation_type
|
6369
|
+
# The basic control of the response shape and the bucket aggregation
|
6370
|
+
# type to perform.
|
6371
|
+
#
|
6372
|
+
# @return [Types::GetBucketsAggregationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6373
|
+
#
|
6374
|
+
# * {Types::GetBucketsAggregationResponse#total_count #total_count} => Integer
|
6375
|
+
# * {Types::GetBucketsAggregationResponse#buckets #buckets} => Array<Types::Bucket>
|
6376
|
+
#
|
6377
|
+
# @example Request syntax with placeholder values
|
6378
|
+
#
|
6379
|
+
# resp = client.get_buckets_aggregation({
|
6380
|
+
# index_name: "IndexName",
|
6381
|
+
# query_string: "QueryString", # required
|
6382
|
+
# aggregation_field: "AggregationField", # required
|
6383
|
+
# query_version: "QueryVersion",
|
6384
|
+
# buckets_aggregation_type: { # required
|
6385
|
+
# terms_aggregation: {
|
6386
|
+
# max_buckets: 1,
|
6387
|
+
# },
|
6388
|
+
# },
|
6389
|
+
# })
|
6390
|
+
#
|
6391
|
+
# @example Response structure
|
6392
|
+
#
|
6393
|
+
# resp.total_count #=> Integer
|
6394
|
+
# resp.buckets #=> Array
|
6395
|
+
# resp.buckets[0].key_value #=> String
|
6396
|
+
# resp.buckets[0].count #=> Integer
|
6397
|
+
#
|
6398
|
+
# @overload get_buckets_aggregation(params = {})
|
6399
|
+
# @param [Hash] params ({})
|
6400
|
+
def get_buckets_aggregation(params = {}, options = {})
|
6401
|
+
req = build_request(:get_buckets_aggregation, params)
|
6402
|
+
req.send_request(options)
|
6403
|
+
end
|
6404
|
+
|
5493
6405
|
# Returns the approximate count of unique values that match the query.
|
5494
6406
|
#
|
6407
|
+
# Requires permission to access the [GetCardinality][1] action.
|
6408
|
+
#
|
6409
|
+
#
|
6410
|
+
#
|
6411
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6412
|
+
#
|
5495
6413
|
# @option params [String] :index_name
|
5496
6414
|
# The name of the index to search.
|
5497
6415
|
#
|
5498
6416
|
# @option params [required, String] :query_string
|
5499
|
-
# The search query.
|
6417
|
+
# The search query string.
|
5500
6418
|
#
|
5501
6419
|
# @option params [String] :aggregation_field
|
5502
6420
|
# The field to aggregate.
|
@@ -5529,8 +6447,14 @@ module Aws::IoT
|
|
5529
6447
|
end
|
5530
6448
|
|
5531
6449
|
# 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
|
-
#
|
6450
|
+
# behavior of the specified device when it connects to the IoT device
|
6451
|
+
# gateway.
|
6452
|
+
#
|
6453
|
+
# Requires permission to access the [GetEffectivePolicies][1] action.
|
6454
|
+
#
|
6455
|
+
#
|
6456
|
+
#
|
6457
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5534
6458
|
#
|
5535
6459
|
# @option params [String] :principal
|
5536
6460
|
# The principal. Valid principals are CertificateArn
|
@@ -5573,6 +6497,13 @@ module Aws::IoT
|
|
5573
6497
|
|
5574
6498
|
# Gets the indexing configuration.
|
5575
6499
|
#
|
6500
|
+
# Requires permission to access the [GetIndexingConfiguration][1]
|
6501
|
+
# action.
|
6502
|
+
#
|
6503
|
+
#
|
6504
|
+
#
|
6505
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6506
|
+
#
|
5576
6507
|
# @return [Types::GetIndexingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5577
6508
|
#
|
5578
6509
|
# * {Types::GetIndexingConfigurationResponse#thing_indexing_configuration #thing_indexing_configuration} => Types::ThingIndexingConfiguration
|
@@ -5605,6 +6536,12 @@ module Aws::IoT
|
|
5605
6536
|
|
5606
6537
|
# Gets a job document.
|
5607
6538
|
#
|
6539
|
+
# Requires permission to access the [GetJobDocument][1] action.
|
6540
|
+
#
|
6541
|
+
#
|
6542
|
+
#
|
6543
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6544
|
+
#
|
5608
6545
|
# @option params [required, String] :job_id
|
5609
6546
|
# The unique identifier you assigned to this job when it was created.
|
5610
6547
|
#
|
@@ -5634,6 +6571,12 @@ module Aws::IoT
|
|
5634
6571
|
# NOTE: use of this command is not recommended. Use
|
5635
6572
|
# `GetV2LoggingOptions` instead.
|
5636
6573
|
#
|
6574
|
+
# Requires permission to access the [GetLoggingOptions][1] action.
|
6575
|
+
#
|
6576
|
+
#
|
6577
|
+
#
|
6578
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6579
|
+
#
|
5637
6580
|
# @return [Types::GetLoggingOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5638
6581
|
#
|
5639
6582
|
# * {Types::GetLoggingOptionsResponse#role_arn #role_arn} => String
|
@@ -5653,6 +6596,12 @@ module Aws::IoT
|
|
5653
6596
|
|
5654
6597
|
# Gets an OTA update.
|
5655
6598
|
#
|
6599
|
+
# Requires permission to access the [GetOTAUpdate][1] action.
|
6600
|
+
#
|
6601
|
+
#
|
6602
|
+
#
|
6603
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6604
|
+
#
|
5656
6605
|
# @option params [required, String] :ota_update_id
|
5657
6606
|
# The OTA update ID.
|
5658
6607
|
#
|
@@ -5734,11 +6683,17 @@ module Aws::IoT
|
|
5734
6683
|
# approximation, the more values that match the query, the more accurate
|
5735
6684
|
# the percentile values.
|
5736
6685
|
#
|
6686
|
+
# Requires permission to access the [GetPercentiles][1] action.
|
6687
|
+
#
|
6688
|
+
#
|
6689
|
+
#
|
6690
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6691
|
+
#
|
5737
6692
|
# @option params [String] :index_name
|
5738
6693
|
# The name of the index to search.
|
5739
6694
|
#
|
5740
6695
|
# @option params [required, String] :query_string
|
5741
|
-
# The query string.
|
6696
|
+
# The search query string.
|
5742
6697
|
#
|
5743
6698
|
# @option params [String] :aggregation_field
|
5744
6699
|
# The field to aggregate.
|
@@ -5779,6 +6734,12 @@ module Aws::IoT
|
|
5779
6734
|
# Gets information about the specified policy with the policy document
|
5780
6735
|
# of the default version.
|
5781
6736
|
#
|
6737
|
+
# Requires permission to access the [GetPolicy][1] action.
|
6738
|
+
#
|
6739
|
+
#
|
6740
|
+
#
|
6741
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6742
|
+
#
|
5782
6743
|
# @option params [required, String] :policy_name
|
5783
6744
|
# The name of the policy.
|
5784
6745
|
#
|
@@ -5817,6 +6778,12 @@ module Aws::IoT
|
|
5817
6778
|
|
5818
6779
|
# Gets information about the specified policy version.
|
5819
6780
|
#
|
6781
|
+
# Requires permission to access the [GetPolicyVersion][1] action.
|
6782
|
+
#
|
6783
|
+
#
|
6784
|
+
#
|
6785
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6786
|
+
#
|
5820
6787
|
# @option params [required, String] :policy_name
|
5821
6788
|
# The name of the policy.
|
5822
6789
|
#
|
@@ -5859,8 +6826,13 @@ module Aws::IoT
|
|
5859
6826
|
req.send_request(options)
|
5860
6827
|
end
|
5861
6828
|
|
5862
|
-
# Gets a registration code used to register a CA certificate with
|
5863
|
-
#
|
6829
|
+
# Gets a registration code used to register a CA certificate with IoT.
|
6830
|
+
#
|
6831
|
+
# Requires permission to access the [GetRegistrationCode][1] action.
|
6832
|
+
#
|
6833
|
+
#
|
6834
|
+
#
|
6835
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5864
6836
|
#
|
5865
6837
|
# @return [Types::GetRegistrationCodeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5866
6838
|
#
|
@@ -5882,12 +6854,19 @@ module Aws::IoT
|
|
5882
6854
|
# If the aggregation field is of type `String`, only the count statistic
|
5883
6855
|
# is returned.
|
5884
6856
|
#
|
6857
|
+
# Requires permission to access the [GetStatistics][1] action.
|
6858
|
+
#
|
6859
|
+
#
|
6860
|
+
#
|
6861
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6862
|
+
#
|
5885
6863
|
# @option params [String] :index_name
|
5886
6864
|
# The name of the index to search. The default value is `AWS_Things`.
|
5887
6865
|
#
|
5888
6866
|
# @option params [required, String] :query_string
|
5889
6867
|
# The query used to search. You can specify "*" for the query string
|
5890
|
-
# to get the count of all indexed things in your
|
6868
|
+
# to get the count of all indexed things in your Amazon Web Services
|
6869
|
+
# account.
|
5891
6870
|
#
|
5892
6871
|
# @option params [String] :aggregation_field
|
5893
6872
|
# The aggregation field name.
|
@@ -5928,6 +6907,12 @@ module Aws::IoT
|
|
5928
6907
|
|
5929
6908
|
# Gets information about the rule.
|
5930
6909
|
#
|
6910
|
+
# Requires permission to access the [GetTopicRule][1] action.
|
6911
|
+
#
|
6912
|
+
#
|
6913
|
+
#
|
6914
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6915
|
+
#
|
5931
6916
|
# @option params [required, String] :rule_name
|
5932
6917
|
# The name of the rule.
|
5933
6918
|
#
|
@@ -6160,6 +7145,12 @@ module Aws::IoT
|
|
6160
7145
|
|
6161
7146
|
# Gets information about a topic rule destination.
|
6162
7147
|
#
|
7148
|
+
# Requires permission to access the [GetTopicRuleDestination][1] action.
|
7149
|
+
#
|
7150
|
+
#
|
7151
|
+
#
|
7152
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7153
|
+
#
|
6163
7154
|
# @option params [required, String] :arn
|
6164
7155
|
# The ARN of the topic rule destination.
|
6165
7156
|
#
|
@@ -6197,6 +7188,12 @@ module Aws::IoT
|
|
6197
7188
|
|
6198
7189
|
# Gets the fine grained logging options.
|
6199
7190
|
#
|
7191
|
+
# Requires permission to access the [GetV2LoggingOptions][1] action.
|
7192
|
+
#
|
7193
|
+
#
|
7194
|
+
#
|
7195
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7196
|
+
#
|
6200
7197
|
# @return [Types::GetV2LoggingOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6201
7198
|
#
|
6202
7199
|
# * {Types::GetV2LoggingOptionsResponse#role_arn #role_arn} => String
|
@@ -6219,6 +7216,12 @@ module Aws::IoT
|
|
6219
7216
|
# Lists the active violations for a given Device Defender security
|
6220
7217
|
# profile.
|
6221
7218
|
#
|
7219
|
+
# Requires permission to access the [ListActiveViolations][1] action.
|
7220
|
+
#
|
7221
|
+
#
|
7222
|
+
#
|
7223
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7224
|
+
#
|
6222
7225
|
# @option params [String] :thing_name
|
6223
7226
|
# The name of the thing whose active violations are listed.
|
6224
7227
|
#
|
@@ -6307,6 +7310,12 @@ module Aws::IoT
|
|
6307
7310
|
|
6308
7311
|
# Lists the policies attached to the specified thing group.
|
6309
7312
|
#
|
7313
|
+
# Requires permission to access the [ListAttachedPolicies][1] action.
|
7314
|
+
#
|
7315
|
+
#
|
7316
|
+
#
|
7317
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7318
|
+
#
|
6310
7319
|
# @option params [required, String] :target
|
6311
7320
|
# The group or principal for which the policies will be listed. Valid
|
6312
7321
|
# principals are CertificateArn
|
@@ -6358,6 +7367,12 @@ module Aws::IoT
|
|
6358
7367
|
# audits performed during a specified time period. (Findings are
|
6359
7368
|
# retained for 90 days.)
|
6360
7369
|
#
|
7370
|
+
# Requires permission to access the [ListAuditFindings][1] action.
|
7371
|
+
#
|
7372
|
+
#
|
7373
|
+
#
|
7374
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7375
|
+
#
|
6361
7376
|
# @option params [String] :task_id
|
6362
7377
|
# A filter to limit results to the audit with the specified ID. You must
|
6363
7378
|
# specify either the taskId or the startTime and endTime, but not both.
|
@@ -6472,6 +7487,13 @@ module Aws::IoT
|
|
6472
7487
|
|
6473
7488
|
# Gets the status of audit mitigation action tasks that were executed.
|
6474
7489
|
#
|
7490
|
+
# Requires permission to access the
|
7491
|
+
# [ListAuditMitigationActionsExecutions][1] action.
|
7492
|
+
#
|
7493
|
+
#
|
7494
|
+
#
|
7495
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7496
|
+
#
|
6475
7497
|
# @option params [required, String] :task_id
|
6476
7498
|
# Specify this filter to limit results to actions for a specific audit
|
6477
7499
|
# mitigation actions task.
|
@@ -6531,6 +7553,13 @@ module Aws::IoT
|
|
6531
7553
|
# Gets a list of audit mitigation action tasks that match the specified
|
6532
7554
|
# filters.
|
6533
7555
|
#
|
7556
|
+
# Requires permission to access the [ListAuditMitigationActionsTasks][1]
|
7557
|
+
# action.
|
7558
|
+
#
|
7559
|
+
#
|
7560
|
+
#
|
7561
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7562
|
+
#
|
6534
7563
|
# @option params [String] :audit_task_id
|
6535
7564
|
# Specify this filter to limit results to tasks that were applied to
|
6536
7565
|
# results for a specific audit.
|
@@ -6594,6 +7623,12 @@ module Aws::IoT
|
|
6594
7623
|
|
6595
7624
|
# Lists your Device Defender audit listings.
|
6596
7625
|
#
|
7626
|
+
# Requires permission to access the [ListAuditSuppressions][1] action.
|
7627
|
+
#
|
7628
|
+
#
|
7629
|
+
#
|
7630
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7631
|
+
#
|
6597
7632
|
# @option params [String] :check_name
|
6598
7633
|
# An audit check name. Checks must be enabled for your account. (Use
|
6599
7634
|
# `DescribeAccountAuditConfiguration` to see the list of all checks,
|
@@ -6672,6 +7707,12 @@ module Aws::IoT
|
|
6672
7707
|
# Lists the Device Defender audits that have been performed during a
|
6673
7708
|
# given time period.
|
6674
7709
|
#
|
7710
|
+
# Requires permission to access the [ListAuditTasks][1] action.
|
7711
|
+
#
|
7712
|
+
#
|
7713
|
+
#
|
7714
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7715
|
+
#
|
6675
7716
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
6676
7717
|
# The beginning of the time period. Audit information is retained for a
|
6677
7718
|
# limited time (90 days). Requesting a start time prior to what is
|
@@ -6731,6 +7772,12 @@ module Aws::IoT
|
|
6731
7772
|
|
6732
7773
|
# Lists the authorizers registered in your account.
|
6733
7774
|
#
|
7775
|
+
# Requires permission to access the [ListAuthorizers][1] action.
|
7776
|
+
#
|
7777
|
+
#
|
7778
|
+
#
|
7779
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7780
|
+
#
|
6734
7781
|
# @option params [Integer] :page_size
|
6735
7782
|
# The maximum number of results to return at one time.
|
6736
7783
|
#
|
@@ -6775,6 +7822,12 @@ module Aws::IoT
|
|
6775
7822
|
|
6776
7823
|
# Lists the billing groups you have created.
|
6777
7824
|
#
|
7825
|
+
# Requires permission to access the [ListBillingGroups][1] action.
|
7826
|
+
#
|
7827
|
+
#
|
7828
|
+
#
|
7829
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7830
|
+
#
|
6778
7831
|
# @option params [String] :next_token
|
6779
7832
|
# To retrieve the next set of results, the `nextToken` value from a
|
6780
7833
|
# previous response; otherwise **null** to receive the first set of
|
@@ -6815,11 +7868,18 @@ module Aws::IoT
|
|
6815
7868
|
req.send_request(options)
|
6816
7869
|
end
|
6817
7870
|
|
6818
|
-
# Lists the CA certificates registered for your
|
7871
|
+
# Lists the CA certificates registered for your Amazon Web Services
|
7872
|
+
# account.
|
6819
7873
|
#
|
6820
7874
|
# The results are paginated with a default page size of 25. You can use
|
6821
7875
|
# the returned marker to retrieve additional results.
|
6822
7876
|
#
|
7877
|
+
# Requires permission to access the [ListCACertificates][1] action.
|
7878
|
+
#
|
7879
|
+
#
|
7880
|
+
#
|
7881
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7882
|
+
#
|
6823
7883
|
# @option params [Integer] :page_size
|
6824
7884
|
# The result page size.
|
6825
7885
|
#
|
@@ -6860,11 +7920,17 @@ module Aws::IoT
|
|
6860
7920
|
req.send_request(options)
|
6861
7921
|
end
|
6862
7922
|
|
6863
|
-
# Lists the certificates registered in your
|
7923
|
+
# Lists the certificates registered in your Amazon Web Services account.
|
6864
7924
|
#
|
6865
7925
|
# The results are paginated with a default page size of 25. You can use
|
6866
7926
|
# the returned marker to retrieve additional results.
|
6867
7927
|
#
|
7928
|
+
# Requires permission to access the [ListCertificates][1] action.
|
7929
|
+
#
|
7930
|
+
#
|
7931
|
+
#
|
7932
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7933
|
+
#
|
6868
7934
|
# @option params [Integer] :page_size
|
6869
7935
|
# The result page size.
|
6870
7936
|
#
|
@@ -6909,6 +7975,12 @@ module Aws::IoT
|
|
6909
7975
|
|
6910
7976
|
# List the device certificates signed by the specified CA certificate.
|
6911
7977
|
#
|
7978
|
+
# Requires permission to access the [ListCertificatesByCA][1] action.
|
7979
|
+
#
|
7980
|
+
#
|
7981
|
+
#
|
7982
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7983
|
+
#
|
6912
7984
|
# @option params [required, String] :ca_certificate_id
|
6913
7985
|
# The ID of the CA certificate. This operation will list all registered
|
6914
7986
|
# device certificate that were signed by this CA certificate.
|
@@ -6958,6 +8030,12 @@ module Aws::IoT
|
|
6958
8030
|
|
6959
8031
|
# Lists your Device Defender detect custom metrics.
|
6960
8032
|
#
|
8033
|
+
# Requires permission to access the [ListCustomMetrics][1] action.
|
8034
|
+
#
|
8035
|
+
#
|
8036
|
+
#
|
8037
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8038
|
+
#
|
6961
8039
|
# @option params [String] :next_token
|
6962
8040
|
# The token for the next set of results.
|
6963
8041
|
#
|
@@ -6995,6 +8073,13 @@ module Aws::IoT
|
|
6995
8073
|
# Lists mitigation actions executions for a Device Defender ML Detect
|
6996
8074
|
# Security Profile.
|
6997
8075
|
#
|
8076
|
+
# Requires permission to access the
|
8077
|
+
# [ListDetectMitigationActionsExecutions][1] action.
|
8078
|
+
#
|
8079
|
+
#
|
8080
|
+
#
|
8081
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8082
|
+
#
|
6998
8083
|
# @option params [String] :task_id
|
6999
8084
|
# The unique identifier of the task.
|
7000
8085
|
#
|
@@ -7062,6 +8147,13 @@ module Aws::IoT
|
|
7062
8147
|
|
7063
8148
|
# List of Device Defender ML Detect mitigation actions tasks.
|
7064
8149
|
#
|
8150
|
+
# Requires permission to access the
|
8151
|
+
# [ListDetectMitigationActionsTasks][1] action.
|
8152
|
+
#
|
8153
|
+
#
|
8154
|
+
#
|
8155
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8156
|
+
#
|
7065
8157
|
# @option params [Integer] :max_results
|
7066
8158
|
# The maximum number of results to return at one time. The default is
|
7067
8159
|
# 25.
|
@@ -7134,7 +8226,14 @@ module Aws::IoT
|
|
7134
8226
|
req.send_request(options)
|
7135
8227
|
end
|
7136
8228
|
|
7137
|
-
# List the set of dimensions that are defined for your
|
8229
|
+
# List the set of dimensions that are defined for your Amazon Web
|
8230
|
+
# Services accounts.
|
8231
|
+
#
|
8232
|
+
# Requires permission to access the [ListDimensions][1] action.
|
8233
|
+
#
|
8234
|
+
#
|
8235
|
+
#
|
8236
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7138
8237
|
#
|
7139
8238
|
# @option params [String] :next_token
|
7140
8239
|
# The token for the next set of results.
|
@@ -7172,6 +8271,13 @@ module Aws::IoT
|
|
7172
8271
|
# Gets a list of domain configurations for the user. This list is sorted
|
7173
8272
|
# alphabetically by domain configuration name.
|
7174
8273
|
#
|
8274
|
+
# Requires permission to access the [ListDomainConfigurations][1]
|
8275
|
+
# action.
|
8276
|
+
#
|
8277
|
+
#
|
8278
|
+
#
|
8279
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8280
|
+
#
|
7175
8281
|
# @option params [String] :marker
|
7176
8282
|
# The marker for the next set of results.
|
7177
8283
|
#
|
@@ -7211,8 +8317,58 @@ module Aws::IoT
|
|
7211
8317
|
req.send_request(options)
|
7212
8318
|
end
|
7213
8319
|
|
8320
|
+
# Lists all your fleet metrics.
|
8321
|
+
#
|
8322
|
+
# Requires permission to access the [ListFleetMetrics][1] action.
|
8323
|
+
#
|
8324
|
+
#
|
8325
|
+
#
|
8326
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8327
|
+
#
|
8328
|
+
# @option params [String] :next_token
|
8329
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
8330
|
+
# previous response; otherwise `null` to receive the first set of
|
8331
|
+
# results.
|
8332
|
+
#
|
8333
|
+
# @option params [Integer] :max_results
|
8334
|
+
# The maximum number of results to return in this operation.
|
8335
|
+
#
|
8336
|
+
# @return [Types::ListFleetMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8337
|
+
#
|
8338
|
+
# * {Types::ListFleetMetricsResponse#fleet_metrics #fleet_metrics} => Array<Types::FleetMetricNameAndArn>
|
8339
|
+
# * {Types::ListFleetMetricsResponse#next_token #next_token} => String
|
8340
|
+
#
|
8341
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8342
|
+
#
|
8343
|
+
# @example Request syntax with placeholder values
|
8344
|
+
#
|
8345
|
+
# resp = client.list_fleet_metrics({
|
8346
|
+
# next_token: "NextToken",
|
8347
|
+
# max_results: 1,
|
8348
|
+
# })
|
8349
|
+
#
|
8350
|
+
# @example Response structure
|
8351
|
+
#
|
8352
|
+
# resp.fleet_metrics #=> Array
|
8353
|
+
# resp.fleet_metrics[0].metric_name #=> String
|
8354
|
+
# resp.fleet_metrics[0].metric_arn #=> String
|
8355
|
+
# resp.next_token #=> String
|
8356
|
+
#
|
8357
|
+
# @overload list_fleet_metrics(params = {})
|
8358
|
+
# @param [Hash] params ({})
|
8359
|
+
def list_fleet_metrics(params = {}, options = {})
|
8360
|
+
req = build_request(:list_fleet_metrics, params)
|
8361
|
+
req.send_request(options)
|
8362
|
+
end
|
8363
|
+
|
7214
8364
|
# Lists the search indices.
|
7215
8365
|
#
|
8366
|
+
# Requires permission to access the [ListIndices][1] action.
|
8367
|
+
#
|
8368
|
+
#
|
8369
|
+
#
|
8370
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8371
|
+
#
|
7216
8372
|
# @option params [String] :next_token
|
7217
8373
|
# The token used to get the next set of results, or `null` if there are
|
7218
8374
|
# no additional results.
|
@@ -7249,6 +8405,12 @@ module Aws::IoT
|
|
7249
8405
|
|
7250
8406
|
# Lists the job executions for a job.
|
7251
8407
|
#
|
8408
|
+
# Requires permission to access the [ListJobExecutionsForJob][1] action.
|
8409
|
+
#
|
8410
|
+
#
|
8411
|
+
#
|
8412
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8413
|
+
#
|
7252
8414
|
# @option params [required, String] :job_id
|
7253
8415
|
# The unique identifier you assigned to this job when it was created.
|
7254
8416
|
#
|
@@ -7297,6 +8459,13 @@ module Aws::IoT
|
|
7297
8459
|
|
7298
8460
|
# Lists the job executions for the specified thing.
|
7299
8461
|
#
|
8462
|
+
# Requires permission to access the [ListJobExecutionsForThing][1]
|
8463
|
+
# action.
|
8464
|
+
#
|
8465
|
+
#
|
8466
|
+
#
|
8467
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8468
|
+
#
|
7300
8469
|
# @option params [required, String] :thing_name
|
7301
8470
|
# The thing name.
|
7302
8471
|
#
|
@@ -7307,9 +8476,9 @@ module Aws::IoT
|
|
7307
8476
|
# @option params [String] :namespace_id
|
7308
8477
|
# The namespace used to indicate that a job is a customer-managed job.
|
7309
8478
|
#
|
7310
|
-
# When you specify a value for this parameter,
|
7311
|
-
# notifications to MQTT topics that contain the value in
|
7312
|
-
# format.
|
8479
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
8480
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
8481
|
+
# the following format.
|
7313
8482
|
#
|
7314
8483
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
7315
8484
|
#
|
@@ -7360,6 +8529,12 @@ module Aws::IoT
|
|
7360
8529
|
|
7361
8530
|
# Returns a list of job templates.
|
7362
8531
|
#
|
8532
|
+
# Requires permission to access the [ListJobTemplates][1] action.
|
8533
|
+
#
|
8534
|
+
#
|
8535
|
+
#
|
8536
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8537
|
+
#
|
7363
8538
|
# @option params [Integer] :max_results
|
7364
8539
|
# The maximum number of results to return in the list.
|
7365
8540
|
#
|
@@ -7371,6 +8546,8 @@ module Aws::IoT
|
|
7371
8546
|
# * {Types::ListJobTemplatesResponse#job_templates #job_templates} => Array<Types::JobTemplateSummary>
|
7372
8547
|
# * {Types::ListJobTemplatesResponse#next_token #next_token} => String
|
7373
8548
|
#
|
8549
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8550
|
+
#
|
7374
8551
|
# @example Request syntax with placeholder values
|
7375
8552
|
#
|
7376
8553
|
# resp = client.list_job_templates({
|
@@ -7396,6 +8573,12 @@ module Aws::IoT
|
|
7396
8573
|
|
7397
8574
|
# Lists jobs.
|
7398
8575
|
#
|
8576
|
+
# Requires permission to access the [ListJobs][1] action.
|
8577
|
+
#
|
8578
|
+
#
|
8579
|
+
#
|
8580
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8581
|
+
#
|
7399
8582
|
# @option params [String] :status
|
7400
8583
|
# An optional filter that lets you search for jobs that have the
|
7401
8584
|
# specified status.
|
@@ -7425,9 +8608,9 @@ module Aws::IoT
|
|
7425
8608
|
# @option params [String] :namespace_id
|
7426
8609
|
# The namespace used to indicate that a job is a customer-managed job.
|
7427
8610
|
#
|
7428
|
-
# When you specify a value for this parameter,
|
7429
|
-
# notifications to MQTT topics that contain the value in
|
7430
|
-
# format.
|
8611
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
8612
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
8613
|
+
# the following format.
|
7431
8614
|
#
|
7432
8615
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
7433
8616
|
#
|
@@ -7477,6 +8660,12 @@ module Aws::IoT
|
|
7477
8660
|
# Gets a list of all mitigation actions that match the specified filter
|
7478
8661
|
# criteria.
|
7479
8662
|
#
|
8663
|
+
# Requires permission to access the [ListMitigationActions][1] action.
|
8664
|
+
#
|
8665
|
+
#
|
8666
|
+
#
|
8667
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8668
|
+
#
|
7480
8669
|
# @option params [String] :action_type
|
7481
8670
|
# Specify a value to limit the result to mitigation actions with a
|
7482
8671
|
# specific action type.
|
@@ -7520,6 +8709,12 @@ module Aws::IoT
|
|
7520
8709
|
|
7521
8710
|
# Lists OTA updates.
|
7522
8711
|
#
|
8712
|
+
# Requires permission to access the [ListOTAUpdates][1] action.
|
8713
|
+
#
|
8714
|
+
#
|
8715
|
+
#
|
8716
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8717
|
+
#
|
7523
8718
|
# @option params [Integer] :max_results
|
7524
8719
|
# The maximum number of results to return at one time.
|
7525
8720
|
#
|
@@ -7561,6 +8756,13 @@ module Aws::IoT
|
|
7561
8756
|
|
7562
8757
|
# Lists certificates that are being transferred but not yet accepted.
|
7563
8758
|
#
|
8759
|
+
# Requires permission to access the [ListOutgoingCertificates][1]
|
8760
|
+
# action.
|
8761
|
+
#
|
8762
|
+
#
|
8763
|
+
#
|
8764
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8765
|
+
#
|
7564
8766
|
# @option params [Integer] :page_size
|
7565
8767
|
# The result page size.
|
7566
8768
|
#
|
@@ -7606,6 +8808,12 @@ module Aws::IoT
|
|
7606
8808
|
|
7607
8809
|
# Lists your policies.
|
7608
8810
|
#
|
8811
|
+
# Requires permission to access the [ListPolicies][1] action.
|
8812
|
+
#
|
8813
|
+
#
|
8814
|
+
#
|
8815
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8816
|
+
#
|
7609
8817
|
# @option params [String] :marker
|
7610
8818
|
# The marker for the next set of results.
|
7611
8819
|
#
|
@@ -7647,9 +8855,15 @@ module Aws::IoT
|
|
7647
8855
|
|
7648
8856
|
# Lists the principals associated with the specified policy.
|
7649
8857
|
#
|
7650
|
-
# **Note:** This
|
8858
|
+
# **Note:** This action is deprecated. Please use ListTargetsForPolicy
|
7651
8859
|
# instead.
|
7652
8860
|
#
|
8861
|
+
# Requires permission to access the [ListPolicyPrincipals][1] action.
|
8862
|
+
#
|
8863
|
+
#
|
8864
|
+
#
|
8865
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8866
|
+
#
|
7653
8867
|
# @option params [required, String] :policy_name
|
7654
8868
|
# The policy name.
|
7655
8869
|
#
|
@@ -7695,6 +8909,12 @@ module Aws::IoT
|
|
7695
8909
|
# Lists the versions of the specified policy and identifies the default
|
7696
8910
|
# version.
|
7697
8911
|
#
|
8912
|
+
# Requires permission to access the [ListPolicyVersions][1] action.
|
8913
|
+
#
|
8914
|
+
#
|
8915
|
+
#
|
8916
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8917
|
+
#
|
7698
8918
|
# @option params [required, String] :policy_name
|
7699
8919
|
# The policy name.
|
7700
8920
|
#
|
@@ -7726,12 +8946,15 @@ module Aws::IoT
|
|
7726
8946
|
# Cognito identity, the ID must be in [AmazonCognito Identity
|
7727
8947
|
# format][1].
|
7728
8948
|
#
|
7729
|
-
# **Note:** This
|
8949
|
+
# **Note:** This action is deprecated. Please use ListAttachedPolicies
|
7730
8950
|
# instead.
|
7731
8951
|
#
|
8952
|
+
# Requires permission to access the [ListPrincipalPolicies][2] action.
|
8953
|
+
#
|
7732
8954
|
#
|
7733
8955
|
#
|
7734
8956
|
# [1]: https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html#API_GetCredentialsForIdentity_RequestSyntax
|
8957
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7735
8958
|
#
|
7736
8959
|
# @option params [required, String] :principal
|
7737
8960
|
# The principal. Valid principals are CertificateArn
|
@@ -7784,6 +9007,12 @@ module Aws::IoT
|
|
7784
9007
|
# can be X.509 certificates, IAM users, groups, and roles, Amazon
|
7785
9008
|
# Cognito identities or federated identities.
|
7786
9009
|
#
|
9010
|
+
# Requires permission to access the [ListPrincipalThings][1] action.
|
9011
|
+
#
|
9012
|
+
#
|
9013
|
+
#
|
9014
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9015
|
+
#
|
7787
9016
|
# @option params [String] :next_token
|
7788
9017
|
# To retrieve the next set of results, the `nextToken` value from a
|
7789
9018
|
# previous response; otherwise **null** to receive the first set of
|
@@ -7825,6 +9054,13 @@ module Aws::IoT
|
|
7825
9054
|
|
7826
9055
|
# A list of fleet provisioning template versions.
|
7827
9056
|
#
|
9057
|
+
# Requires permission to access the
|
9058
|
+
# [ListProvisioningTemplateVersions][1] action.
|
9059
|
+
#
|
9060
|
+
#
|
9061
|
+
#
|
9062
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9063
|
+
#
|
7828
9064
|
# @option params [required, String] :template_name
|
7829
9065
|
# The name of the fleet provisioning template.
|
7830
9066
|
#
|
@@ -7864,7 +9100,15 @@ module Aws::IoT
|
|
7864
9100
|
req.send_request(options)
|
7865
9101
|
end
|
7866
9102
|
|
7867
|
-
# Lists the fleet provisioning templates in your
|
9103
|
+
# Lists the fleet provisioning templates in your Amazon Web Services
|
9104
|
+
# account.
|
9105
|
+
#
|
9106
|
+
# Requires permission to access the [ListProvisioningTemplates][1]
|
9107
|
+
# action.
|
9108
|
+
#
|
9109
|
+
#
|
9110
|
+
#
|
9111
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7868
9112
|
#
|
7869
9113
|
# @option params [Integer] :max_results
|
7870
9114
|
# The maximum number of results to return at one time.
|
@@ -7906,6 +9150,12 @@ module Aws::IoT
|
|
7906
9150
|
|
7907
9151
|
# Lists the role aliases registered in your account.
|
7908
9152
|
#
|
9153
|
+
# Requires permission to access the [ListRoleAliases][1] action.
|
9154
|
+
#
|
9155
|
+
#
|
9156
|
+
#
|
9157
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9158
|
+
#
|
7909
9159
|
# @option params [Integer] :page_size
|
7910
9160
|
# The maximum number of results to return at one time.
|
7911
9161
|
#
|
@@ -7945,6 +9195,12 @@ module Aws::IoT
|
|
7945
9195
|
|
7946
9196
|
# Lists all of your scheduled audits.
|
7947
9197
|
#
|
9198
|
+
# Requires permission to access the [ListScheduledAudits][1] action.
|
9199
|
+
#
|
9200
|
+
#
|
9201
|
+
#
|
9202
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9203
|
+
#
|
7948
9204
|
# @option params [String] :next_token
|
7949
9205
|
# The token for the next set of results.
|
7950
9206
|
#
|
@@ -7986,10 +9242,16 @@ module Aws::IoT
|
|
7986
9242
|
# Lists the Device Defender security profiles you've created. You can
|
7987
9243
|
# filter security profiles by dimension or custom metric.
|
7988
9244
|
#
|
9245
|
+
# Requires permission to access the [ListSecurityProfiles][1] action.
|
9246
|
+
#
|
7989
9247
|
# <note markdown="1"> `dimensionName` and `metricName` cannot be used in the same request.
|
7990
9248
|
#
|
7991
9249
|
# </note>
|
7992
9250
|
#
|
9251
|
+
#
|
9252
|
+
#
|
9253
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9254
|
+
#
|
7993
9255
|
# @option params [String] :next_token
|
7994
9256
|
# The token for the next set of results.
|
7995
9257
|
#
|
@@ -8036,6 +9298,13 @@ module Aws::IoT
|
|
8036
9298
|
# Lists the Device Defender security profiles attached to a target
|
8037
9299
|
# (thing group).
|
8038
9300
|
#
|
9301
|
+
# Requires permission to access the [ListSecurityProfilesForTarget][1]
|
9302
|
+
# action.
|
9303
|
+
#
|
9304
|
+
#
|
9305
|
+
#
|
9306
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9307
|
+
#
|
8039
9308
|
# @option params [String] :next_token
|
8040
9309
|
# The token for the next set of results.
|
8041
9310
|
#
|
@@ -8080,7 +9349,13 @@ module Aws::IoT
|
|
8080
9349
|
req.send_request(options)
|
8081
9350
|
end
|
8082
9351
|
|
8083
|
-
# Lists all of the streams in your
|
9352
|
+
# Lists all of the streams in your Amazon Web Services account.
|
9353
|
+
#
|
9354
|
+
# Requires permission to access the [ListStreams][1] action.
|
9355
|
+
#
|
9356
|
+
#
|
9357
|
+
#
|
9358
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8084
9359
|
#
|
8085
9360
|
# @option params [Integer] :max_results
|
8086
9361
|
# The maximum number of results to return at a time.
|
@@ -8124,6 +9399,12 @@ module Aws::IoT
|
|
8124
9399
|
|
8125
9400
|
# Lists the tags (metadata) you have assigned to the resource.
|
8126
9401
|
#
|
9402
|
+
# Requires permission to access the [ListTagsForResource][1] action.
|
9403
|
+
#
|
9404
|
+
#
|
9405
|
+
#
|
9406
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9407
|
+
#
|
8127
9408
|
# @option params [required, String] :resource_arn
|
8128
9409
|
# The ARN of the resource.
|
8129
9410
|
#
|
@@ -8162,6 +9443,12 @@ module Aws::IoT
|
|
8162
9443
|
|
8163
9444
|
# List targets for the specified policy.
|
8164
9445
|
#
|
9446
|
+
# Requires permission to access the [ListTargetsForPolicy][1] action.
|
9447
|
+
#
|
9448
|
+
#
|
9449
|
+
#
|
9450
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9451
|
+
#
|
8165
9452
|
# @option params [required, String] :policy_name
|
8166
9453
|
# The policy name.
|
8167
9454
|
#
|
@@ -8202,6 +9489,13 @@ module Aws::IoT
|
|
8202
9489
|
# Lists the targets (thing groups) associated with a given Device
|
8203
9490
|
# Defender security profile.
|
8204
9491
|
#
|
9492
|
+
# Requires permission to access the [ListTargetsForSecurityProfile][1]
|
9493
|
+
# action.
|
9494
|
+
#
|
9495
|
+
#
|
9496
|
+
#
|
9497
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9498
|
+
#
|
8205
9499
|
# @option params [required, String] :security_profile_name
|
8206
9500
|
# The security profile.
|
8207
9501
|
#
|
@@ -8241,6 +9535,12 @@ module Aws::IoT
|
|
8241
9535
|
|
8242
9536
|
# List the thing groups in your account.
|
8243
9537
|
#
|
9538
|
+
# Requires permission to access the [ListThingGroups][1] action.
|
9539
|
+
#
|
9540
|
+
#
|
9541
|
+
#
|
9542
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9543
|
+
#
|
8244
9544
|
# @option params [String] :next_token
|
8245
9545
|
# To retrieve the next set of results, the `nextToken` value from a
|
8246
9546
|
# previous response; otherwise **null** to receive the first set of
|
@@ -8293,6 +9593,12 @@ module Aws::IoT
|
|
8293
9593
|
|
8294
9594
|
# List the thing groups to which the specified thing belongs.
|
8295
9595
|
#
|
9596
|
+
# Requires permission to access the [ListThingGroupsForThing][1] action.
|
9597
|
+
#
|
9598
|
+
#
|
9599
|
+
#
|
9600
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9601
|
+
#
|
8296
9602
|
# @option params [required, String] :thing_name
|
8297
9603
|
# The thing name.
|
8298
9604
|
#
|
@@ -8337,6 +9643,12 @@ module Aws::IoT
|
|
8337
9643
|
# can be X.509 certificates, IAM users, groups, and roles, Amazon
|
8338
9644
|
# Cognito identities or federated identities.
|
8339
9645
|
#
|
9646
|
+
# Requires permission to access the [ListThingPrincipals][1] action.
|
9647
|
+
#
|
9648
|
+
#
|
9649
|
+
#
|
9650
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9651
|
+
#
|
8340
9652
|
# @option params [String] :next_token
|
8341
9653
|
# To retrieve the next set of results, the `nextToken` value from a
|
8342
9654
|
# previous response; otherwise **null** to receive the first set of
|
@@ -8425,6 +9737,13 @@ module Aws::IoT
|
|
8425
9737
|
|
8426
9738
|
# List bulk thing provisioning tasks.
|
8427
9739
|
#
|
9740
|
+
# Requires permission to access the [ListThingRegistrationTasks][1]
|
9741
|
+
# action.
|
9742
|
+
#
|
9743
|
+
#
|
9744
|
+
#
|
9745
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9746
|
+
#
|
8428
9747
|
# @option params [String] :next_token
|
8429
9748
|
# To retrieve the next set of results, the `nextToken` value from a
|
8430
9749
|
# previous response; otherwise **null** to receive the first set of
|
@@ -8466,6 +9785,12 @@ module Aws::IoT
|
|
8466
9785
|
|
8467
9786
|
# Lists the existing thing types.
|
8468
9787
|
#
|
9788
|
+
# Requires permission to access the [ListThingTypes][1] action.
|
9789
|
+
#
|
9790
|
+
#
|
9791
|
+
#
|
9792
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9793
|
+
#
|
8469
9794
|
# @option params [String] :next_token
|
8470
9795
|
# To retrieve the next set of results, the `nextToken` value from a
|
8471
9796
|
# previous response; otherwise **null** to receive the first set of
|
@@ -8518,6 +9843,8 @@ module Aws::IoT
|
|
8518
9843
|
# in the registry that contain an attribute **Color** with the value
|
8519
9844
|
# **Red**.
|
8520
9845
|
#
|
9846
|
+
# Requires permission to access the [ListThings][1] action.
|
9847
|
+
#
|
8521
9848
|
# <note markdown="1"> You will not be charged for calling this API if an `Access denied`
|
8522
9849
|
# error is returned. You will also not be charged if no attributes or
|
8523
9850
|
# pagination token was provided in request and no pagination token and
|
@@ -8525,6 +9852,10 @@ module Aws::IoT
|
|
8525
9852
|
#
|
8526
9853
|
# </note>
|
8527
9854
|
#
|
9855
|
+
#
|
9856
|
+
#
|
9857
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9858
|
+
#
|
8528
9859
|
# @option params [String] :next_token
|
8529
9860
|
# To retrieve the next set of results, the `nextToken` value from a
|
8530
9861
|
# previous response; otherwise **null** to receive the first set of
|
@@ -8588,6 +9919,13 @@ module Aws::IoT
|
|
8588
9919
|
|
8589
9920
|
# Lists the things you have added to the given billing group.
|
8590
9921
|
#
|
9922
|
+
# Requires permission to access the [ListThingsInBillingGroup][1]
|
9923
|
+
# action.
|
9924
|
+
#
|
9925
|
+
#
|
9926
|
+
#
|
9927
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9928
|
+
#
|
8591
9929
|
# @option params [required, String] :billing_group_name
|
8592
9930
|
# The name of the billing group.
|
8593
9931
|
#
|
@@ -8629,6 +9967,12 @@ module Aws::IoT
|
|
8629
9967
|
|
8630
9968
|
# Lists the things in the specified group.
|
8631
9969
|
#
|
9970
|
+
# Requires permission to access the [ListThingsInThingGroup][1] action.
|
9971
|
+
#
|
9972
|
+
#
|
9973
|
+
#
|
9974
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9975
|
+
#
|
8632
9976
|
# @option params [required, String] :thing_group_name
|
8633
9977
|
# The thing group name.
|
8634
9978
|
#
|
@@ -8673,7 +10017,15 @@ module Aws::IoT
|
|
8673
10017
|
req.send_request(options)
|
8674
10018
|
end
|
8675
10019
|
|
8676
|
-
# Lists all the topic rule destinations in your
|
10020
|
+
# Lists all the topic rule destinations in your Amazon Web Services
|
10021
|
+
# account.
|
10022
|
+
#
|
10023
|
+
# Requires permission to access the [ListTopicRuleDestinations][1]
|
10024
|
+
# action.
|
10025
|
+
#
|
10026
|
+
#
|
10027
|
+
#
|
10028
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8677
10029
|
#
|
8678
10030
|
# @option params [Integer] :max_results
|
8679
10031
|
# The maximum number of results to return at one time.
|
@@ -8723,6 +10075,12 @@ module Aws::IoT
|
|
8723
10075
|
|
8724
10076
|
# Lists the rules for the specific topic.
|
8725
10077
|
#
|
10078
|
+
# Requires permission to access the [ListTopicRules][1] action.
|
10079
|
+
#
|
10080
|
+
#
|
10081
|
+
#
|
10082
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10083
|
+
#
|
8726
10084
|
# @option params [String] :topic
|
8727
10085
|
# The topic.
|
8728
10086
|
#
|
@@ -8772,6 +10130,12 @@ module Aws::IoT
|
|
8772
10130
|
|
8773
10131
|
# Lists logging levels.
|
8774
10132
|
#
|
10133
|
+
# Requires permission to access the [ListV2LoggingLevels][1] action.
|
10134
|
+
#
|
10135
|
+
#
|
10136
|
+
#
|
10137
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10138
|
+
#
|
8775
10139
|
# @option params [String] :target_type
|
8776
10140
|
# The type of resource for which you are configuring logging. Must be
|
8777
10141
|
# `THING_Group`.
|
@@ -8819,6 +10183,12 @@ module Aws::IoT
|
|
8819
10183
|
# to those alerts issued for a particular security profile, behavior, or
|
8820
10184
|
# thing (device).
|
8821
10185
|
#
|
10186
|
+
# Requires permission to access the [ListViolationEvents][1] action.
|
10187
|
+
#
|
10188
|
+
#
|
10189
|
+
#
|
10190
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10191
|
+
#
|
8822
10192
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
8823
10193
|
# The start time for the alerts to be listed.
|
8824
10194
|
#
|
@@ -8914,14 +10284,20 @@ module Aws::IoT
|
|
8914
10284
|
req.send_request(options)
|
8915
10285
|
end
|
8916
10286
|
|
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
|
10287
|
+
# Registers a CA certificate with IoT. This CA certificate can then be
|
10288
|
+
# used to sign device certificates, which can be then registered with
|
10289
|
+
# IoT. You can register up to 10 CA certificates per Amazon Web Services
|
10290
|
+
# account that have the same subject field. This enables you to have up
|
10291
|
+
# to 10 certificate authorities sign your device certificates. If you
|
10292
|
+
# have more than one CA certificate registered, make sure you pass the
|
10293
|
+
# CA certificate when you register your device certificates with the
|
10294
|
+
# RegisterCertificate action.
|
10295
|
+
#
|
10296
|
+
# Requires permission to access the [RegisterCACertificate][1] action.
|
10297
|
+
#
|
10298
|
+
#
|
10299
|
+
#
|
10300
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8925
10301
|
#
|
8926
10302
|
# @option params [required, String] :ca_certificate
|
8927
10303
|
# The CA certificate.
|
@@ -8989,11 +10365,17 @@ module Aws::IoT
|
|
8989
10365
|
req.send_request(options)
|
8990
10366
|
end
|
8991
10367
|
|
8992
|
-
# Registers a device certificate with
|
8993
|
-
#
|
8994
|
-
#
|
10368
|
+
# Registers a device certificate with IoT. If you have more than one CA
|
10369
|
+
# certificate that has the same subject field, you must specify the CA
|
10370
|
+
# certificate that was used to sign the device certificate being
|
8995
10371
|
# registered.
|
8996
10372
|
#
|
10373
|
+
# Requires permission to access the [RegisterCertificate][1] action.
|
10374
|
+
#
|
10375
|
+
#
|
10376
|
+
#
|
10377
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10378
|
+
#
|
8997
10379
|
# @option params [required, String] :certificate_pem
|
8998
10380
|
# The certificate data, in PEM format.
|
8999
10381
|
#
|
@@ -9067,15 +10449,18 @@ module Aws::IoT
|
|
9067
10449
|
end
|
9068
10450
|
|
9069
10451
|
# Provisions a thing in the device registry. RegisterThing calls other
|
9070
|
-
#
|
9071
|
-
#
|
9072
|
-
#
|
10452
|
+
# IoT control plane APIs. These calls might exceed your account level [
|
10453
|
+
# IoT Throttling Limits][1] and cause throttle errors. Please contact
|
10454
|
+
# [Amazon Web Services Customer Support][2] to raise your throttling
|
9073
10455
|
# limits if necessary.
|
9074
10456
|
#
|
10457
|
+
# Requires permission to access the [RegisterThing][3] action.
|
10458
|
+
#
|
9075
10459
|
#
|
9076
10460
|
#
|
9077
10461
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_iot
|
9078
10462
|
# [2]: https://console.aws.amazon.com/support/home
|
10463
|
+
# [3]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9079
10464
|
#
|
9080
10465
|
# @option params [required, String] :template_body
|
9081
10466
|
# The provisioning template. See [Provisioning Devices That Have Device
|
@@ -9120,7 +10505,7 @@ module Aws::IoT
|
|
9120
10505
|
req.send_request(options)
|
9121
10506
|
end
|
9122
10507
|
|
9123
|
-
# Rejects a pending certificate transfer. After
|
10508
|
+
# Rejects a pending certificate transfer. After IoT rejects a
|
9124
10509
|
# certificate transfer, the certificate status changes from
|
9125
10510
|
# **PENDING\_TRANSFER** to **INACTIVE**.
|
9126
10511
|
#
|
@@ -9131,6 +10516,13 @@ module Aws::IoT
|
|
9131
10516
|
# it is called, the certificate will be returned to the source's
|
9132
10517
|
# account in the INACTIVE state.
|
9133
10518
|
#
|
10519
|
+
# Requires permission to access the [RejectCertificateTransfer][1]
|
10520
|
+
# action.
|
10521
|
+
#
|
10522
|
+
#
|
10523
|
+
#
|
10524
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10525
|
+
#
|
9134
10526
|
# @option params [required, String] :certificate_id
|
9135
10527
|
# The ID of the certificate. (The last part of the certificate ARN
|
9136
10528
|
# contains the certificate ID.)
|
@@ -9156,6 +10548,13 @@ module Aws::IoT
|
|
9156
10548
|
|
9157
10549
|
# Removes the given thing from the billing group.
|
9158
10550
|
#
|
10551
|
+
# Requires permission to access the [RemoveThingFromBillingGroup][1]
|
10552
|
+
# action.
|
10553
|
+
#
|
10554
|
+
#
|
10555
|
+
#
|
10556
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10557
|
+
#
|
9159
10558
|
# @option params [String] :billing_group_name
|
9160
10559
|
# The name of the billing group.
|
9161
10560
|
#
|
@@ -9192,6 +10591,13 @@ module Aws::IoT
|
|
9192
10591
|
# identify the thing group and either a `thingArn` or a `thingName` to
|
9193
10592
|
# identify the thing to remove from the thing group.
|
9194
10593
|
#
|
10594
|
+
# Requires permission to access the [RemoveThingFromThingGroup][1]
|
10595
|
+
# action.
|
10596
|
+
#
|
10597
|
+
#
|
10598
|
+
#
|
10599
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10600
|
+
#
|
9195
10601
|
# @option params [String] :thing_group_name
|
9196
10602
|
# The group name.
|
9197
10603
|
#
|
@@ -9227,6 +10633,12 @@ module Aws::IoT
|
|
9227
10633
|
# permission to create rules will be able to access data processed by
|
9228
10634
|
# the rule.
|
9229
10635
|
#
|
10636
|
+
# Requires permission to access the [ReplaceTopicRule][1] action.
|
10637
|
+
#
|
10638
|
+
#
|
10639
|
+
#
|
10640
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10641
|
+
#
|
9230
10642
|
# @option params [required, String] :rule_name
|
9231
10643
|
# The name of the rule.
|
9232
10644
|
#
|
@@ -9594,6 +11006,12 @@ module Aws::IoT
|
|
9594
11006
|
|
9595
11007
|
# The query search index.
|
9596
11008
|
#
|
11009
|
+
# Requires permission to access the [SearchIndex][1] action.
|
11010
|
+
#
|
11011
|
+
#
|
11012
|
+
#
|
11013
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11014
|
+
#
|
9597
11015
|
# @option params [String] :index_name
|
9598
11016
|
# The search index name.
|
9599
11017
|
#
|
@@ -9640,6 +11058,7 @@ module Aws::IoT
|
|
9640
11058
|
# resp.things[0].shadow #=> String
|
9641
11059
|
# resp.things[0].connectivity.connected #=> Boolean
|
9642
11060
|
# resp.things[0].connectivity.timestamp #=> Integer
|
11061
|
+
# resp.things[0].connectivity.disconnect_reason #=> String
|
9643
11062
|
# resp.thing_groups #=> Array
|
9644
11063
|
# resp.thing_groups[0].thing_group_name #=> String
|
9645
11064
|
# resp.thing_groups[0].thing_group_id #=> String
|
@@ -9659,6 +11078,12 @@ module Aws::IoT
|
|
9659
11078
|
# Sets the default authorizer. This will be used if a websocket
|
9660
11079
|
# connection is made without specifying an authorizer.
|
9661
11080
|
#
|
11081
|
+
# Requires permission to access the [SetDefaultAuthorizer][1] action.
|
11082
|
+
#
|
11083
|
+
#
|
11084
|
+
#
|
11085
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11086
|
+
#
|
9662
11087
|
# @option params [required, String] :authorizer_name
|
9663
11088
|
# The authorizer name.
|
9664
11089
|
#
|
@@ -9688,7 +11113,13 @@ module Aws::IoT
|
|
9688
11113
|
# Sets the specified version of the specified policy as the policy's
|
9689
11114
|
# default (operative) version. This action affects all certificates to
|
9690
11115
|
# which the policy is attached. To list the principals the policy is
|
9691
|
-
# attached to, use the
|
11116
|
+
# attached to, use the ListPrincipalPolicies action.
|
11117
|
+
#
|
11118
|
+
# Requires permission to access the [SetDefaultPolicyVersion][1] action.
|
11119
|
+
#
|
11120
|
+
#
|
11121
|
+
#
|
11122
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9692
11123
|
#
|
9693
11124
|
# @option params [required, String] :policy_name
|
9694
11125
|
# The policy name.
|
@@ -9717,6 +11148,12 @@ module Aws::IoT
|
|
9717
11148
|
# NOTE: use of this command is not recommended. Use
|
9718
11149
|
# `SetV2LoggingOptions` instead.
|
9719
11150
|
#
|
11151
|
+
# Requires permission to access the [SetLoggingOptions][1] action.
|
11152
|
+
#
|
11153
|
+
#
|
11154
|
+
#
|
11155
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11156
|
+
#
|
9720
11157
|
# @option params [required, Types::LoggingOptionsPayload] :logging_options_payload
|
9721
11158
|
# The logging options payload.
|
9722
11159
|
#
|
@@ -9740,6 +11177,12 @@ module Aws::IoT
|
|
9740
11177
|
|
9741
11178
|
# Sets the logging level.
|
9742
11179
|
#
|
11180
|
+
# Requires permission to access the [SetV2LoggingLevel][1] action.
|
11181
|
+
#
|
11182
|
+
#
|
11183
|
+
#
|
11184
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11185
|
+
#
|
9743
11186
|
# @option params [required, Types::LogTarget] :log_target
|
9744
11187
|
# The log target.
|
9745
11188
|
#
|
@@ -9767,6 +11210,12 @@ module Aws::IoT
|
|
9767
11210
|
|
9768
11211
|
# Sets the logging options for the V2 logging service.
|
9769
11212
|
#
|
11213
|
+
# Requires permission to access the [SetV2LoggingOptions][1] action.
|
11214
|
+
#
|
11215
|
+
#
|
11216
|
+
#
|
11217
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11218
|
+
#
|
9770
11219
|
# @option params [String] :role_arn
|
9771
11220
|
# The ARN of the role that allows IoT to write to Cloudwatch logs.
|
9772
11221
|
#
|
@@ -9796,6 +11245,13 @@ module Aws::IoT
|
|
9796
11245
|
# Starts a task that applies a set of mitigation actions to the
|
9797
11246
|
# specified target.
|
9798
11247
|
#
|
11248
|
+
# Requires permission to access the [StartAuditMitigationActionsTask][1]
|
11249
|
+
# action.
|
11250
|
+
#
|
11251
|
+
#
|
11252
|
+
#
|
11253
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11254
|
+
#
|
9799
11255
|
# @option params [required, String] :task_id
|
9800
11256
|
# A unique identifier for the task. You can use this identifier to check
|
9801
11257
|
# the status of the task or to cancel it.
|
@@ -9807,7 +11263,7 @@ module Aws::IoT
|
|
9807
11263
|
#
|
9808
11264
|
# @option params [required, Hash<String,Array>] :audit_check_to_actions_mapping
|
9809
11265
|
# For an audit check, specifies which mitigation actions to apply. Those
|
9810
|
-
# actions must be defined in your
|
11266
|
+
# actions must be defined in your Amazon Web Services accounts.
|
9811
11267
|
#
|
9812
11268
|
# @option params [required, String] :client_request_token
|
9813
11269
|
# Each audit mitigation task must have a unique client request token. If
|
@@ -9852,6 +11308,13 @@ module Aws::IoT
|
|
9852
11308
|
|
9853
11309
|
# Starts a Device Defender ML Detect mitigation actions task.
|
9854
11310
|
#
|
11311
|
+
# Requires permission to access the
|
11312
|
+
# [StartDetectMitigationActionsTask][1] action.
|
11313
|
+
#
|
11314
|
+
#
|
11315
|
+
#
|
11316
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11317
|
+
#
|
9855
11318
|
# @option params [required, String] :task_id
|
9856
11319
|
# The unique identifier of the task.
|
9857
11320
|
#
|
@@ -9874,8 +11337,8 @@ module Aws::IoT
|
|
9874
11337
|
# @option params [required, String] :client_request_token
|
9875
11338
|
# Each mitigation action task must have a unique client request token.
|
9876
11339
|
# 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.
|
11340
|
+
# already exists, an exception occurs. If you omit this value, Amazon
|
11341
|
+
# Web Services SDKs will automatically generate a unique client request.
|
9879
11342
|
#
|
9880
11343
|
# **A suitable default value is auto-generated.** You should normally
|
9881
11344
|
# not need to pass this option.**
|
@@ -9916,6 +11379,12 @@ module Aws::IoT
|
|
9916
11379
|
|
9917
11380
|
# Starts an on-demand Device Defender audit.
|
9918
11381
|
#
|
11382
|
+
# Requires permission to access the [StartOnDemandAuditTask][1] action.
|
11383
|
+
#
|
11384
|
+
#
|
11385
|
+
#
|
11386
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11387
|
+
#
|
9919
11388
|
# @option params [required, Array<String>] :target_check_names
|
9920
11389
|
# Which checks are performed during the audit. The checks you specify
|
9921
11390
|
# must be enabled for your account or an exception occurs. Use
|
@@ -9946,6 +11415,13 @@ module Aws::IoT
|
|
9946
11415
|
|
9947
11416
|
# Creates a bulk thing provisioning task.
|
9948
11417
|
#
|
11418
|
+
# Requires permission to access the [StartThingRegistrationTask][1]
|
11419
|
+
# action.
|
11420
|
+
#
|
11421
|
+
#
|
11422
|
+
#
|
11423
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11424
|
+
#
|
9949
11425
|
# @option params [required, String] :template_body
|
9950
11426
|
# The provisioning template.
|
9951
11427
|
#
|
@@ -9986,6 +11462,13 @@ module Aws::IoT
|
|
9986
11462
|
|
9987
11463
|
# Cancels a bulk thing provisioning task.
|
9988
11464
|
#
|
11465
|
+
# Requires permission to access the [StopThingRegistrationTask][1]
|
11466
|
+
# action.
|
11467
|
+
#
|
11468
|
+
#
|
11469
|
+
#
|
11470
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11471
|
+
#
|
9989
11472
|
# @option params [required, String] :task_id
|
9990
11473
|
# The bulk thing provisioning task ID.
|
9991
11474
|
#
|
@@ -10007,6 +11490,12 @@ module Aws::IoT
|
|
10007
11490
|
# Adds to or modifies the tags of the given resource. Tags are metadata
|
10008
11491
|
# which can be used to manage a resource.
|
10009
11492
|
#
|
11493
|
+
# Requires permission to access the [TagResource][1] action.
|
11494
|
+
#
|
11495
|
+
#
|
11496
|
+
#
|
11497
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11498
|
+
#
|
10010
11499
|
# @option params [required, String] :resource_arn
|
10011
11500
|
# The ARN of the resource.
|
10012
11501
|
#
|
@@ -10034,10 +11523,15 @@ module Aws::IoT
|
|
10034
11523
|
req.send_request(options)
|
10035
11524
|
end
|
10036
11525
|
|
10037
|
-
# Tests if a specified principal is authorized to perform an
|
10038
|
-
#
|
10039
|
-
#
|
10040
|
-
#
|
11526
|
+
# Tests if a specified principal is authorized to perform an IoT action
|
11527
|
+
# on a specified resource. Use this to test and debug the authorization
|
11528
|
+
# behavior of devices that connect to the IoT device gateway.
|
11529
|
+
#
|
11530
|
+
# Requires permission to access the [TestAuthorization][1] action.
|
11531
|
+
#
|
11532
|
+
#
|
11533
|
+
#
|
11534
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10041
11535
|
#
|
10042
11536
|
# @option params [String] :principal
|
10043
11537
|
# The principal. Valid principals are CertificateArn
|
@@ -10112,7 +11606,13 @@ module Aws::IoT
|
|
10112
11606
|
|
10113
11607
|
# Tests a custom authorization behavior by invoking a specified custom
|
10114
11608
|
# authorizer. Use this to test and debug the custom authorization
|
10115
|
-
# behavior of devices that connect to the
|
11609
|
+
# behavior of devices that connect to the IoT device gateway.
|
11610
|
+
#
|
11611
|
+
# Requires permission to access the [TestInvokeAuthorizer][1] action.
|
11612
|
+
#
|
11613
|
+
#
|
11614
|
+
#
|
11615
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10116
11616
|
#
|
10117
11617
|
# @option params [required, String] :authorizer_name
|
10118
11618
|
# The custom authorizer name.
|
@@ -10179,7 +11679,10 @@ module Aws::IoT
|
|
10179
11679
|
req.send_request(options)
|
10180
11680
|
end
|
10181
11681
|
|
10182
|
-
# Transfers the specified certificate to the specified
|
11682
|
+
# Transfers the specified certificate to the specified Amazon Web
|
11683
|
+
# Services account.
|
11684
|
+
#
|
11685
|
+
# Requires permission to access the [TransferCertificate][1] action.
|
10183
11686
|
#
|
10184
11687
|
# You can cancel the transfer until it is acknowledged by the recipient.
|
10185
11688
|
#
|
@@ -10187,17 +11690,21 @@ module Aws::IoT
|
|
10187
11690
|
# up to the caller to notify the transfer target.
|
10188
11691
|
#
|
10189
11692
|
# The certificate being transferred must not be in the ACTIVE state. You
|
10190
|
-
# can use the UpdateCertificate
|
11693
|
+
# can use the UpdateCertificate action to deactivate it.
|
10191
11694
|
#
|
10192
11695
|
# The certificate must not have any policies attached to it. You can use
|
10193
|
-
# the
|
11696
|
+
# the DetachPolicy action to detach them.
|
11697
|
+
#
|
11698
|
+
#
|
11699
|
+
#
|
11700
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10194
11701
|
#
|
10195
11702
|
# @option params [required, String] :certificate_id
|
10196
11703
|
# The ID of the certificate. (The last part of the certificate ARN
|
10197
11704
|
# contains the certificate ID.)
|
10198
11705
|
#
|
10199
11706
|
# @option params [required, String] :target_aws_account
|
10200
|
-
# The
|
11707
|
+
# The Amazon Web Services account.
|
10201
11708
|
#
|
10202
11709
|
# @option params [String] :transfer_message
|
10203
11710
|
# The transfer message.
|
@@ -10227,6 +11734,12 @@ module Aws::IoT
|
|
10227
11734
|
|
10228
11735
|
# Removes the given tags (metadata) from the resource.
|
10229
11736
|
#
|
11737
|
+
# Requires permission to access the [UntagResource][1] action.
|
11738
|
+
#
|
11739
|
+
#
|
11740
|
+
#
|
11741
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11742
|
+
#
|
10230
11743
|
# @option params [required, String] :resource_arn
|
10231
11744
|
# The ARN of the resource.
|
10232
11745
|
#
|
@@ -10253,10 +11766,17 @@ module Aws::IoT
|
|
10253
11766
|
# account. Settings include how audit notifications are sent and which
|
10254
11767
|
# audit checks are enabled or disabled.
|
10255
11768
|
#
|
11769
|
+
# Requires permission to access the [UpdateAccountAuditConfiguration][1]
|
11770
|
+
# action.
|
11771
|
+
#
|
11772
|
+
#
|
11773
|
+
#
|
11774
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11775
|
+
#
|
10256
11776
|
# @option params [String] :role_arn
|
10257
11777
|
# The Amazon Resource Name (ARN) of the role that grants permission to
|
10258
|
-
#
|
10259
|
-
#
|
11778
|
+
# IoT to access information about your devices, policies, certificates,
|
11779
|
+
# and other items as required when performing an audit.
|
10260
11780
|
#
|
10261
11781
|
# @option params [Hash<String,Types::AuditNotificationTarget>] :audit_notification_target_configurations
|
10262
11782
|
# Information about the targets to which audit notifications are sent.
|
@@ -10358,6 +11878,12 @@ module Aws::IoT
|
|
10358
11878
|
|
10359
11879
|
# Updates an authorizer.
|
10360
11880
|
#
|
11881
|
+
# Requires permission to access the [UpdateAuthorizer][1] action.
|
11882
|
+
#
|
11883
|
+
#
|
11884
|
+
#
|
11885
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11886
|
+
#
|
10361
11887
|
# @option params [required, String] :authorizer_name
|
10362
11888
|
# The authorizer name.
|
10363
11889
|
#
|
@@ -10404,6 +11930,12 @@ module Aws::IoT
|
|
10404
11930
|
|
10405
11931
|
# Updates information about the billing group.
|
10406
11932
|
#
|
11933
|
+
# Requires permission to access the [UpdateBillingGroup][1] action.
|
11934
|
+
#
|
11935
|
+
#
|
11936
|
+
#
|
11937
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11938
|
+
#
|
10407
11939
|
# @option params [required, String] :billing_group_name
|
10408
11940
|
# The name of the billing group.
|
10409
11941
|
#
|
@@ -10443,6 +11975,12 @@ module Aws::IoT
|
|
10443
11975
|
|
10444
11976
|
# Updates a registered CA certificate.
|
10445
11977
|
#
|
11978
|
+
# Requires permission to access the [UpdateCACertificate][1] action.
|
11979
|
+
#
|
11980
|
+
#
|
11981
|
+
#
|
11982
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11983
|
+
#
|
10446
11984
|
# @option params [required, String] :certificate_id
|
10447
11985
|
# The CA certificate identifier.
|
10448
11986
|
#
|
@@ -10487,14 +12025,20 @@ module Aws::IoT
|
|
10487
12025
|
# Updates the status of the specified certificate. This operation is
|
10488
12026
|
# idempotent.
|
10489
12027
|
#
|
12028
|
+
# Requires permission to access the [UpdateCertificate][1] action.
|
12029
|
+
#
|
10490
12030
|
# Certificates must be in the ACTIVE state to authenticate devices that
|
10491
|
-
# use a certificate to connect to
|
12031
|
+
# use a certificate to connect to IoT.
|
10492
12032
|
#
|
10493
12033
|
# Within a few minutes of updating a certificate from the ACTIVE state
|
10494
|
-
# to any other state,
|
12034
|
+
# to any other state, IoT disconnects all devices that used that
|
10495
12035
|
# certificate to connect. Devices cannot use a certificate that is not
|
10496
12036
|
# in the ACTIVE state to reconnect.
|
10497
12037
|
#
|
12038
|
+
#
|
12039
|
+
#
|
12040
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12041
|
+
#
|
10498
12042
|
# @option params [required, String] :certificate_id
|
10499
12043
|
# The ID of the certificate. (The last part of the certificate ARN
|
10500
12044
|
# contains the certificate ID.)
|
@@ -10505,7 +12049,7 @@ module Aws::IoT
|
|
10505
12049
|
# **Note:** Setting the status to PENDING\_TRANSFER or
|
10506
12050
|
# PENDING\_ACTIVATION will result in an exception being thrown.
|
10507
12051
|
# PENDING\_TRANSFER and PENDING\_ACTIVATION are statuses used internally
|
10508
|
-
# by
|
12052
|
+
# by IoT. They are not intended for developer use.
|
10509
12053
|
#
|
10510
12054
|
# **Note:** The status value REGISTER\_INACTIVE is deprecated and should
|
10511
12055
|
# not be used.
|
@@ -10528,6 +12072,12 @@ module Aws::IoT
|
|
10528
12072
|
|
10529
12073
|
# Updates a Device Defender detect custom metric.
|
10530
12074
|
#
|
12075
|
+
# Requires permission to access the [UpdateCustomMetric][1] action.
|
12076
|
+
#
|
12077
|
+
#
|
12078
|
+
#
|
12079
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12080
|
+
#
|
10531
12081
|
# @option params [required, String] :metric_name
|
10532
12082
|
# The name of the custom metric. Cannot be updated.
|
10533
12083
|
#
|
@@ -10571,6 +12121,12 @@ module Aws::IoT
|
|
10571
12121
|
# Updates the definition for a dimension. You cannot change the type of
|
10572
12122
|
# a dimension after it is created (you can delete it and recreate it).
|
10573
12123
|
#
|
12124
|
+
# Requires permission to access the [UpdateDimension][1] action.
|
12125
|
+
#
|
12126
|
+
#
|
12127
|
+
#
|
12128
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12129
|
+
#
|
10574
12130
|
# @option params [required, String] :name
|
10575
12131
|
# A unique identifier for the dimension. Choose something that describes
|
10576
12132
|
# the type and value to make it easy to remember what it does.
|
@@ -10616,6 +12172,13 @@ module Aws::IoT
|
|
10616
12172
|
# Updates values stored in the domain configuration. Domain
|
10617
12173
|
# configurations for default endpoints can't be updated.
|
10618
12174
|
#
|
12175
|
+
# Requires permission to access the [UpdateDomainConfiguration][1]
|
12176
|
+
# action.
|
12177
|
+
#
|
12178
|
+
#
|
12179
|
+
#
|
12180
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12181
|
+
#
|
10619
12182
|
# @option params [required, String] :domain_configuration_name
|
10620
12183
|
# The name of the domain configuration to be updated.
|
10621
12184
|
#
|
@@ -10659,6 +12222,12 @@ module Aws::IoT
|
|
10659
12222
|
|
10660
12223
|
# Updates a dynamic thing group.
|
10661
12224
|
#
|
12225
|
+
# Requires permission to access the [UpdateDynamicThingGroup][1] action.
|
12226
|
+
#
|
12227
|
+
#
|
12228
|
+
#
|
12229
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12230
|
+
#
|
10662
12231
|
# @option params [required, String] :thing_group_name
|
10663
12232
|
# The name of the dynamic thing group to update.
|
10664
12233
|
#
|
@@ -10671,7 +12240,7 @@ module Aws::IoT
|
|
10671
12240
|
# @option params [String] :index_name
|
10672
12241
|
# The dynamic thing group index to update.
|
10673
12242
|
#
|
10674
|
-
# <note markdown="1"> Currently one index is supported:
|
12243
|
+
# <note markdown="1"> Currently one index is supported: `AWS_Things`.
|
10675
12244
|
#
|
10676
12245
|
# </note>
|
10677
12246
|
#
|
@@ -10722,6 +12291,13 @@ module Aws::IoT
|
|
10722
12291
|
|
10723
12292
|
# Updates the event configurations.
|
10724
12293
|
#
|
12294
|
+
# Requires permission to access the [UpdateEventConfigurations][1]
|
12295
|
+
# action.
|
12296
|
+
#
|
12297
|
+
#
|
12298
|
+
#
|
12299
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12300
|
+
#
|
10725
12301
|
# @option params [Hash<String,Types::Configuration>] :event_configurations
|
10726
12302
|
# The new event configuration values.
|
10727
12303
|
#
|
@@ -10744,8 +12320,86 @@ module Aws::IoT
|
|
10744
12320
|
req.send_request(options)
|
10745
12321
|
end
|
10746
12322
|
|
12323
|
+
# Updates the data for a fleet metric.
|
12324
|
+
#
|
12325
|
+
# Requires permission to access the [UpdateFleetMetric][1] action.
|
12326
|
+
#
|
12327
|
+
#
|
12328
|
+
#
|
12329
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12330
|
+
#
|
12331
|
+
# @option params [required, String] :metric_name
|
12332
|
+
# The name of the fleet metric to update.
|
12333
|
+
#
|
12334
|
+
# @option params [String] :query_string
|
12335
|
+
# The search query string.
|
12336
|
+
#
|
12337
|
+
# @option params [Types::AggregationType] :aggregation_type
|
12338
|
+
# The type of the aggregation query.
|
12339
|
+
#
|
12340
|
+
# @option params [Integer] :period
|
12341
|
+
# The time in seconds between fleet metric emissions. Range \[60(1 min),
|
12342
|
+
# 86400(1 day)\] and must be multiple of 60.
|
12343
|
+
#
|
12344
|
+
# @option params [String] :aggregation_field
|
12345
|
+
# The field to aggregate.
|
12346
|
+
#
|
12347
|
+
# @option params [String] :description
|
12348
|
+
# The description of the fleet metric.
|
12349
|
+
#
|
12350
|
+
# @option params [String] :query_version
|
12351
|
+
# The version of the query.
|
12352
|
+
#
|
12353
|
+
# @option params [required, String] :index_name
|
12354
|
+
# The name of the index to search.
|
12355
|
+
#
|
12356
|
+
# @option params [String] :unit
|
12357
|
+
# Used to support unit transformation such as milliseconds to seconds.
|
12358
|
+
# The unit must be supported by [CW metric][1].
|
12359
|
+
#
|
12360
|
+
#
|
12361
|
+
#
|
12362
|
+
# [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
|
12363
|
+
#
|
12364
|
+
# @option params [Integer] :expected_version
|
12365
|
+
# The expected version of the fleet metric record in the registry.
|
12366
|
+
#
|
12367
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
12368
|
+
#
|
12369
|
+
# @example Request syntax with placeholder values
|
12370
|
+
#
|
12371
|
+
# resp = client.update_fleet_metric({
|
12372
|
+
# metric_name: "FleetMetricName", # required
|
12373
|
+
# query_string: "QueryString",
|
12374
|
+
# aggregation_type: {
|
12375
|
+
# name: "Statistics", # required, accepts Statistics, Percentiles, Cardinality
|
12376
|
+
# values: ["AggregationTypeValue"],
|
12377
|
+
# },
|
12378
|
+
# period: 1,
|
12379
|
+
# aggregation_field: "AggregationField",
|
12380
|
+
# description: "FleetMetricDescription",
|
12381
|
+
# query_version: "QueryVersion",
|
12382
|
+
# index_name: "IndexName", # required
|
12383
|
+
# 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
|
12384
|
+
# expected_version: 1,
|
12385
|
+
# })
|
12386
|
+
#
|
12387
|
+
# @overload update_fleet_metric(params = {})
|
12388
|
+
# @param [Hash] params ({})
|
12389
|
+
def update_fleet_metric(params = {}, options = {})
|
12390
|
+
req = build_request(:update_fleet_metric, params)
|
12391
|
+
req.send_request(options)
|
12392
|
+
end
|
12393
|
+
|
10747
12394
|
# Updates the search configuration.
|
10748
12395
|
#
|
12396
|
+
# Requires permission to access the [UpdateIndexingConfiguration][1]
|
12397
|
+
# action.
|
12398
|
+
#
|
12399
|
+
#
|
12400
|
+
#
|
12401
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12402
|
+
#
|
10749
12403
|
# @option params [Types::ThingIndexingConfiguration] :thing_indexing_configuration
|
10750
12404
|
# Thing indexing configuration.
|
10751
12405
|
#
|
@@ -10799,6 +12453,12 @@ module Aws::IoT
|
|
10799
12453
|
|
10800
12454
|
# Updates supported fields of the specified job.
|
10801
12455
|
#
|
12456
|
+
# Requires permission to access the [UpdateJob][1] action.
|
12457
|
+
#
|
12458
|
+
#
|
12459
|
+
#
|
12460
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12461
|
+
#
|
10802
12462
|
# @option params [required, String] :job_id
|
10803
12463
|
# The ID of the job to be updated.
|
10804
12464
|
#
|
@@ -10824,9 +12484,9 @@ module Aws::IoT
|
|
10824
12484
|
# @option params [String] :namespace_id
|
10825
12485
|
# The namespace used to indicate that a job is a customer-managed job.
|
10826
12486
|
#
|
10827
|
-
# When you specify a value for this parameter,
|
10828
|
-
# notifications to MQTT topics that contain the value in
|
10829
|
-
# format.
|
12487
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
12488
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
12489
|
+
# the following format.
|
10830
12490
|
#
|
10831
12491
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
10832
12492
|
#
|
@@ -10881,6 +12541,12 @@ module Aws::IoT
|
|
10881
12541
|
|
10882
12542
|
# Updates the definition for the specified mitigation action.
|
10883
12543
|
#
|
12544
|
+
# Requires permission to access the [UpdateMitigationAction][1] action.
|
12545
|
+
#
|
12546
|
+
#
|
12547
|
+
#
|
12548
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12549
|
+
#
|
10884
12550
|
# @option params [required, String] :action_name
|
10885
12551
|
# The friendly name for the mitigation action. You cannot change the
|
10886
12552
|
# name by using `UpdateMitigationAction`. Instead, you must delete and
|
@@ -10940,6 +12606,13 @@ module Aws::IoT
|
|
10940
12606
|
|
10941
12607
|
# Updates a fleet provisioning template.
|
10942
12608
|
#
|
12609
|
+
# Requires permission to access the [UpdateProvisioningTemplate][1]
|
12610
|
+
# action.
|
12611
|
+
#
|
12612
|
+
#
|
12613
|
+
#
|
12614
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12615
|
+
#
|
10943
12616
|
# @option params [required, String] :template_name
|
10944
12617
|
# The name of the fleet provisioning template.
|
10945
12618
|
#
|
@@ -10988,6 +12661,12 @@ module Aws::IoT
|
|
10988
12661
|
|
10989
12662
|
# Updates a role alias.
|
10990
12663
|
#
|
12664
|
+
# Requires permission to access the [UpdateRoleAlias][1] action.
|
12665
|
+
#
|
12666
|
+
#
|
12667
|
+
#
|
12668
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12669
|
+
#
|
10991
12670
|
# @option params [required, String] :role_alias
|
10992
12671
|
# The role alias to update.
|
10993
12672
|
#
|
@@ -11025,6 +12704,12 @@ module Aws::IoT
|
|
11025
12704
|
# Updates a scheduled audit, including which checks are performed and
|
11026
12705
|
# how often the audit takes place.
|
11027
12706
|
#
|
12707
|
+
# Requires permission to access the [UpdateScheduledAudit][1] action.
|
12708
|
+
#
|
12709
|
+
#
|
12710
|
+
#
|
12711
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12712
|
+
#
|
11028
12713
|
# @option params [String] :frequency
|
11029
12714
|
# How often the scheduled audit takes place, either `DAILY`, `WEEKLY`,
|
11030
12715
|
# `BIWEEKLY`, or `MONTHLY`. The start time of each audit is determined
|
@@ -11079,6 +12764,12 @@ module Aws::IoT
|
|
11079
12764
|
|
11080
12765
|
# Updates a Device Defender security profile.
|
11081
12766
|
#
|
12767
|
+
# Requires permission to access the [UpdateSecurityProfile][1] action.
|
12768
|
+
#
|
12769
|
+
#
|
12770
|
+
#
|
12771
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12772
|
+
#
|
11082
12773
|
# @option params [required, String] :security_profile_name
|
11083
12774
|
# The name of the security profile you want to update.
|
11084
12775
|
#
|
@@ -11249,6 +12940,12 @@ module Aws::IoT
|
|
11249
12940
|
# Updates an existing stream. The stream version will be incremented by
|
11250
12941
|
# one.
|
11251
12942
|
#
|
12943
|
+
# Requires permission to access the [UpdateStream][1] action.
|
12944
|
+
#
|
12945
|
+
#
|
12946
|
+
#
|
12947
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12948
|
+
#
|
11252
12949
|
# @option params [required, String] :stream_id
|
11253
12950
|
# The stream ID.
|
11254
12951
|
#
|
@@ -11303,6 +13000,12 @@ module Aws::IoT
|
|
11303
13000
|
|
11304
13001
|
# Updates the data for a thing.
|
11305
13002
|
#
|
13003
|
+
# Requires permission to access the [UpdateThing][1] action.
|
13004
|
+
#
|
13005
|
+
#
|
13006
|
+
#
|
13007
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13008
|
+
#
|
11306
13009
|
# @option params [required, String] :thing_name
|
11307
13010
|
# The name of the thing to update.
|
11308
13011
|
#
|
@@ -11357,6 +13060,12 @@ module Aws::IoT
|
|
11357
13060
|
|
11358
13061
|
# Update a thing group.
|
11359
13062
|
#
|
13063
|
+
# Requires permission to access the [UpdateThingGroup][1] action.
|
13064
|
+
#
|
13065
|
+
#
|
13066
|
+
#
|
13067
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13068
|
+
#
|
11360
13069
|
# @option params [required, String] :thing_group_name
|
11361
13070
|
# The thing group to update.
|
11362
13071
|
#
|
@@ -11400,6 +13109,13 @@ module Aws::IoT
|
|
11400
13109
|
|
11401
13110
|
# Updates the groups to which the thing belongs.
|
11402
13111
|
#
|
13112
|
+
# Requires permission to access the [UpdateThingGroupsForThing][1]
|
13113
|
+
# action.
|
13114
|
+
#
|
13115
|
+
#
|
13116
|
+
#
|
13117
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13118
|
+
#
|
11403
13119
|
# @option params [String] :thing_name
|
11404
13120
|
# The thing whose group memberships will be updated.
|
11405
13121
|
#
|
@@ -11436,6 +13152,13 @@ module Aws::IoT
|
|
11436
13152
|
# Updates a topic rule destination. You use this to change the status,
|
11437
13153
|
# endpoint URL, or confirmation URL of the destination.
|
11438
13154
|
#
|
13155
|
+
# Requires permission to access the [UpdateTopicRuleDestination][1]
|
13156
|
+
# action.
|
13157
|
+
#
|
13158
|
+
#
|
13159
|
+
#
|
13160
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13161
|
+
#
|
11439
13162
|
# @option params [required, String] :arn
|
11440
13163
|
# The ARN of the topic rule destination.
|
11441
13164
|
#
|
@@ -11489,6 +13212,13 @@ module Aws::IoT
|
|
11489
13212
|
|
11490
13213
|
# Validates a Device Defender security profile behaviors specification.
|
11491
13214
|
#
|
13215
|
+
# Requires permission to access the
|
13216
|
+
# [ValidateSecurityProfileBehaviors][1] action.
|
13217
|
+
#
|
13218
|
+
#
|
13219
|
+
#
|
13220
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13221
|
+
#
|
11492
13222
|
# @option params [required, Array<Types::Behavior>] :behaviors
|
11493
13223
|
# Specifies the behaviors that, when violated by a device (thing), cause
|
11494
13224
|
# an alert.
|
@@ -11560,7 +13290,7 @@ module Aws::IoT
|
|
11560
13290
|
params: params,
|
11561
13291
|
config: config)
|
11562
13292
|
context[:gem_name] = 'aws-sdk-iot'
|
11563
|
-
context[:gem_version] = '1.
|
13293
|
+
context[:gem_version] = '1.73.0'
|
11564
13294
|
Seahorse::Client::Request.new(handlers, context)
|
11565
13295
|
end
|
11566
13296
|
|