aws-sdk-iot 1.72.0 → 1.76.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iot/client.rb +1944 -131
- data/lib/aws-sdk-iot/client_api.rb +266 -0
- data/lib/aws-sdk-iot/types.rb +852 -134
- data/lib/aws-sdk-iot.rb +1 -1
- metadata +5 -5
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,
|
@@ -857,7 +964,10 @@ module Aws::IoT
|
|
857
964
|
# The description of the audit suppression.
|
858
965
|
#
|
859
966
|
# @option params [required, String] :client_request_token
|
860
|
-
#
|
967
|
+
# Each audit supression must have a unique client request token. If you
|
968
|
+
# try to create a new audit suppression with the same token as one that
|
969
|
+
# already exists, an exception occurs. If you omit this value, Amazon
|
970
|
+
# Web Services SDKs will automatically generate a unique client request.
|
861
971
|
#
|
862
972
|
# **A suitable default value is auto-generated.** You should normally
|
863
973
|
# not need to pass this option.**
|
@@ -896,6 +1006,12 @@ module Aws::IoT
|
|
896
1006
|
|
897
1007
|
# Creates an authorizer.
|
898
1008
|
#
|
1009
|
+
# Requires permission to access the [CreateAuthorizer][1] action.
|
1010
|
+
#
|
1011
|
+
#
|
1012
|
+
#
|
1013
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1014
|
+
#
|
899
1015
|
# @option params [required, String] :authorizer_name
|
900
1016
|
# The authorizer name.
|
901
1017
|
#
|
@@ -928,7 +1044,7 @@ module Aws::IoT
|
|
928
1044
|
# </note>
|
929
1045
|
#
|
930
1046
|
# @option params [Boolean] :signing_disabled
|
931
|
-
# Specifies whether
|
1047
|
+
# Specifies whether IoT validates the token signature in an
|
932
1048
|
# authorization request.
|
933
1049
|
#
|
934
1050
|
# @return [Types::CreateAuthorizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -969,6 +1085,12 @@ module Aws::IoT
|
|
969
1085
|
|
970
1086
|
# Creates a billing group.
|
971
1087
|
#
|
1088
|
+
# Requires permission to access the [CreateBillingGroup][1] action.
|
1089
|
+
#
|
1090
|
+
#
|
1091
|
+
#
|
1092
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1093
|
+
#
|
972
1094
|
# @option params [required, String] :billing_group_name
|
973
1095
|
# The name you wish to give to the billing group.
|
974
1096
|
#
|
@@ -1022,6 +1144,9 @@ module Aws::IoT
|
|
1022
1144
|
# **Note:** Reusing the same certificate signing request (CSR) results
|
1023
1145
|
# in a distinct certificate.
|
1024
1146
|
#
|
1147
|
+
# Requires permission to access the [CreateCertificateFromCsr][1]
|
1148
|
+
# action.
|
1149
|
+
#
|
1025
1150
|
# You can create multiple certificates in a batch by creating a
|
1026
1151
|
# directory, copying multiple .csr files into that directory, and then
|
1027
1152
|
# specifying that directory on the command line. The following commands
|
@@ -1037,8 +1162,9 @@ module Aws::IoT
|
|
1037
1162
|
# file://my-csr-directory/\\\{\\}
|
1038
1163
|
#
|
1039
1164
|
# 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
|
1165
|
+
# CSR file name to the aws iot create-certificate-from-csr Amazon Web
|
1166
|
+
# Services CLI command to create a certificate for the corresponding
|
1167
|
+
# CSR.
|
1042
1168
|
#
|
1043
1169
|
# The aws iot create-certificate-from-csr part of the command can also
|
1044
1170
|
# be run in parallel to speed up the certificate creation process:
|
@@ -1061,6 +1187,10 @@ module Aws::IoT
|
|
1061
1187
|
# create-certificate-from-csr --certificate-signing-request
|
1062
1188
|
# file://@path"
|
1063
1189
|
#
|
1190
|
+
#
|
1191
|
+
#
|
1192
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1193
|
+
#
|
1064
1194
|
# @option params [required, String] :certificate_signing_request
|
1065
1195
|
# The certificate signing request (CSR).
|
1066
1196
|
#
|
@@ -1096,6 +1226,12 @@ module Aws::IoT
|
|
1096
1226
|
# Use this API to define a Custom Metric published by your devices to
|
1097
1227
|
# Device Defender.
|
1098
1228
|
#
|
1229
|
+
# Requires permission to access the [CreateCustomMetric][1] action.
|
1230
|
+
#
|
1231
|
+
#
|
1232
|
+
#
|
1233
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1234
|
+
#
|
1099
1235
|
# @option params [required, String] :metric_name
|
1100
1236
|
# The name of the custom metric. This will be used in the metric report
|
1101
1237
|
# submitted from the device/thing. Shouldn't begin with `aws:`. Cannot
|
@@ -1116,8 +1252,8 @@ module Aws::IoT
|
|
1116
1252
|
# @option params [required, String] :client_request_token
|
1117
1253
|
# Each custom metric must have a unique client request token. If you try
|
1118
1254
|
# 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.
|
1255
|
+
# token, an exception occurs. If you omit this value, Amazon Web
|
1256
|
+
# Services SDKs will automatically generate a unique client request.
|
1121
1257
|
#
|
1122
1258
|
# **A suitable default value is auto-generated.** You should normally
|
1123
1259
|
# not need to pass this option.**
|
@@ -1155,11 +1291,17 @@ module Aws::IoT
|
|
1155
1291
|
end
|
1156
1292
|
|
1157
1293
|
# Create a dimension that you can use to limit the scope of a metric
|
1158
|
-
# used in a security profile for
|
1159
|
-
#
|
1294
|
+
# used in a security profile for IoT Device Defender. For example, using
|
1295
|
+
# a `TOPIC_FILTER` dimension, you can narrow down the scope of the
|
1160
1296
|
# metric only to MQTT topics whose name match the pattern specified in
|
1161
1297
|
# the dimension.
|
1162
1298
|
#
|
1299
|
+
# Requires permission to access the [CreateDimension][1] action.
|
1300
|
+
#
|
1301
|
+
#
|
1302
|
+
#
|
1303
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1304
|
+
#
|
1163
1305
|
# @option params [required, String] :name
|
1164
1306
|
# A unique identifier for the dimension. Choose something that describes
|
1165
1307
|
# the type and value to make it easy to remember what it does.
|
@@ -1178,8 +1320,8 @@ module Aws::IoT
|
|
1178
1320
|
# @option params [required, String] :client_request_token
|
1179
1321
|
# Each dimension must have a unique client request token. If you try to
|
1180
1322
|
# 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.
|
1323
|
+
# exists, an exception occurs. If you omit this value, Amazon Web
|
1324
|
+
# Services SDKs will automatically generate a unique client request.
|
1183
1325
|
#
|
1184
1326
|
# **A suitable default value is auto-generated.** You should normally
|
1185
1327
|
# not need to pass this option.**
|
@@ -1218,6 +1360,13 @@ module Aws::IoT
|
|
1218
1360
|
|
1219
1361
|
# Creates a domain configuration.
|
1220
1362
|
#
|
1363
|
+
# Requires permission to access the [CreateDomainConfiguration][1]
|
1364
|
+
# action.
|
1365
|
+
#
|
1366
|
+
#
|
1367
|
+
#
|
1368
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1369
|
+
#
|
1221
1370
|
# @option params [required, String] :domain_configuration_name
|
1222
1371
|
# The name of the domain configuration. This value must be unique to a
|
1223
1372
|
# region.
|
@@ -1226,15 +1375,15 @@ module Aws::IoT
|
|
1226
1375
|
# The name of the domain.
|
1227
1376
|
#
|
1228
1377
|
# @option params [Array<String>] :server_certificate_arns
|
1229
|
-
# The ARNs of the certificates that
|
1230
|
-
#
|
1231
|
-
# This value is not required for
|
1378
|
+
# The ARNs of the certificates that IoT passes to the device during the
|
1379
|
+
# TLS handshake. Currently you can specify only one certificate ARN.
|
1380
|
+
# This value is not required for Amazon Web Services-managed domains.
|
1232
1381
|
#
|
1233
1382
|
# @option params [String] :validation_certificate_arn
|
1234
1383
|
# The certificate used to validate the server certificate and prove
|
1235
1384
|
# domain name ownership. This certificate must be signed by a public
|
1236
|
-
# certificate authority. This value is not required for
|
1237
|
-
# domains.
|
1385
|
+
# certificate authority. This value is not required for Amazon Web
|
1386
|
+
# Services-managed domains.
|
1238
1387
|
#
|
1239
1388
|
# @option params [Types::AuthorizerConfig] :authorizer_config
|
1240
1389
|
# An object that specifies the authorization service for a domain.
|
@@ -1242,7 +1391,8 @@ module Aws::IoT
|
|
1242
1391
|
# @option params [String] :service_type
|
1243
1392
|
# The type of service delivered by the endpoint.
|
1244
1393
|
#
|
1245
|
-
# <note markdown="1">
|
1394
|
+
# <note markdown="1"> Amazon Web Services IoT Core currently supports only the `DATA`
|
1395
|
+
# service type.
|
1246
1396
|
#
|
1247
1397
|
# </note>
|
1248
1398
|
#
|
@@ -1299,6 +1449,12 @@ module Aws::IoT
|
|
1299
1449
|
|
1300
1450
|
# Creates a dynamic thing group.
|
1301
1451
|
#
|
1452
|
+
# Requires permission to access the [CreateDynamicThingGroup][1] action.
|
1453
|
+
#
|
1454
|
+
#
|
1455
|
+
#
|
1456
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1457
|
+
#
|
1302
1458
|
# @option params [required, String] :thing_group_name
|
1303
1459
|
# The dynamic thing group name to create.
|
1304
1460
|
#
|
@@ -1308,7 +1464,7 @@ module Aws::IoT
|
|
1308
1464
|
# @option params [String] :index_name
|
1309
1465
|
# The dynamic thing group index name.
|
1310
1466
|
#
|
1311
|
-
# <note markdown="1"> Currently one index is supported:
|
1467
|
+
# <note markdown="1"> Currently one index is supported: `AWS_Things`.
|
1312
1468
|
#
|
1313
1469
|
# </note>
|
1314
1470
|
#
|
@@ -1381,12 +1537,102 @@ module Aws::IoT
|
|
1381
1537
|
req.send_request(options)
|
1382
1538
|
end
|
1383
1539
|
|
1540
|
+
# Creates a fleet metric.
|
1541
|
+
#
|
1542
|
+
# Requires permission to access the [CreateFleetMetric][1] action.
|
1543
|
+
#
|
1544
|
+
#
|
1545
|
+
#
|
1546
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1547
|
+
#
|
1548
|
+
# @option params [required, String] :metric_name
|
1549
|
+
# The name of the fleet metric to create.
|
1550
|
+
#
|
1551
|
+
# @option params [required, String] :query_string
|
1552
|
+
# The search query string.
|
1553
|
+
#
|
1554
|
+
# @option params [required, Types::AggregationType] :aggregation_type
|
1555
|
+
# The type of the aggregation query.
|
1556
|
+
#
|
1557
|
+
# @option params [required, Integer] :period
|
1558
|
+
# The time in seconds between fleet metric emissions. Range \[60(1 min),
|
1559
|
+
# 86400(1 day)\] and must be multiple of 60.
|
1560
|
+
#
|
1561
|
+
# @option params [required, String] :aggregation_field
|
1562
|
+
# The field to aggregate.
|
1563
|
+
#
|
1564
|
+
# @option params [String] :description
|
1565
|
+
# The fleet metric description.
|
1566
|
+
#
|
1567
|
+
# @option params [String] :query_version
|
1568
|
+
# The query version.
|
1569
|
+
#
|
1570
|
+
# @option params [String] :index_name
|
1571
|
+
# The name of the index to search.
|
1572
|
+
#
|
1573
|
+
# @option params [String] :unit
|
1574
|
+
# Used to support unit transformation such as milliseconds to seconds.
|
1575
|
+
# The unit must be supported by [CW metric][1]. Default to null.
|
1576
|
+
#
|
1577
|
+
#
|
1578
|
+
#
|
1579
|
+
# [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
|
1580
|
+
#
|
1581
|
+
# @option params [Array<Types::Tag>] :tags
|
1582
|
+
# Metadata, which can be used to manage the fleet metric.
|
1583
|
+
#
|
1584
|
+
# @return [Types::CreateFleetMetricResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1585
|
+
#
|
1586
|
+
# * {Types::CreateFleetMetricResponse#metric_name #metric_name} => String
|
1587
|
+
# * {Types::CreateFleetMetricResponse#metric_arn #metric_arn} => String
|
1588
|
+
#
|
1589
|
+
# @example Request syntax with placeholder values
|
1590
|
+
#
|
1591
|
+
# resp = client.create_fleet_metric({
|
1592
|
+
# metric_name: "FleetMetricName", # required
|
1593
|
+
# query_string: "QueryString", # required
|
1594
|
+
# aggregation_type: { # required
|
1595
|
+
# name: "Statistics", # required, accepts Statistics, Percentiles, Cardinality
|
1596
|
+
# values: ["AggregationTypeValue"],
|
1597
|
+
# },
|
1598
|
+
# period: 1, # required
|
1599
|
+
# aggregation_field: "AggregationField", # required
|
1600
|
+
# description: "FleetMetricDescription",
|
1601
|
+
# query_version: "QueryVersion",
|
1602
|
+
# index_name: "IndexName",
|
1603
|
+
# 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
|
1604
|
+
# tags: [
|
1605
|
+
# {
|
1606
|
+
# key: "TagKey", # required
|
1607
|
+
# value: "TagValue",
|
1608
|
+
# },
|
1609
|
+
# ],
|
1610
|
+
# })
|
1611
|
+
#
|
1612
|
+
# @example Response structure
|
1613
|
+
#
|
1614
|
+
# resp.metric_name #=> String
|
1615
|
+
# resp.metric_arn #=> String
|
1616
|
+
#
|
1617
|
+
# @overload create_fleet_metric(params = {})
|
1618
|
+
# @param [Hash] params ({})
|
1619
|
+
def create_fleet_metric(params = {}, options = {})
|
1620
|
+
req = build_request(:create_fleet_metric, params)
|
1621
|
+
req.send_request(options)
|
1622
|
+
end
|
1623
|
+
|
1384
1624
|
# Creates a job.
|
1385
1625
|
#
|
1626
|
+
# Requires permission to access the [CreateJob][1] action.
|
1627
|
+
#
|
1628
|
+
#
|
1629
|
+
#
|
1630
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1631
|
+
#
|
1386
1632
|
# @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.
|
1633
|
+
# A job identifier which must be unique for your Amazon Web Services
|
1634
|
+
# account. We recommend using a UUID. Alpha-numeric characters, "-"
|
1635
|
+
# and "\_" are valid for use here.
|
1390
1636
|
#
|
1391
1637
|
# @option params [required, Array<String>] :targets
|
1392
1638
|
# A list of things and thing groups to which the job should be sent.
|
@@ -1444,9 +1690,9 @@ module Aws::IoT
|
|
1444
1690
|
# @option params [String] :namespace_id
|
1445
1691
|
# The namespace used to indicate that a job is a customer-managed job.
|
1446
1692
|
#
|
1447
|
-
# When you specify a value for this parameter,
|
1448
|
-
# notifications to MQTT topics that contain the value in
|
1449
|
-
# format.
|
1693
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
1694
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
1695
|
+
# the following format.
|
1450
1696
|
#
|
1451
1697
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
1452
1698
|
#
|
@@ -1525,6 +1771,12 @@ module Aws::IoT
|
|
1525
1771
|
|
1526
1772
|
# Creates a job template.
|
1527
1773
|
#
|
1774
|
+
# Requires permission to access the [CreateJobTemplate][1] action.
|
1775
|
+
#
|
1776
|
+
#
|
1777
|
+
#
|
1778
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1779
|
+
#
|
1528
1780
|
# @option params [required, String] :job_template_id
|
1529
1781
|
# A unique identifier for the job template. We recommend using a UUID.
|
1530
1782
|
# Alpha-numeric characters, "-", and "\_" are valid for use here.
|
@@ -1640,12 +1892,16 @@ module Aws::IoT
|
|
1640
1892
|
# over MQTT from a device, for more information, see [Provisioning MQTT
|
1641
1893
|
# API][1].
|
1642
1894
|
#
|
1643
|
-
# **Note** This is the only time
|
1895
|
+
# **Note** This is the only time IoT issues the private key for this
|
1644
1896
|
# certificate, so it is important to keep it in a secure location.
|
1645
1897
|
#
|
1898
|
+
# Requires permission to access the [CreateKeysAndCertificate][2]
|
1899
|
+
# action.
|
1900
|
+
#
|
1646
1901
|
#
|
1647
1902
|
#
|
1648
1903
|
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#provision-mqtt-api
|
1904
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1649
1905
|
#
|
1650
1906
|
# @option params [Boolean] :set_as_active
|
1651
1907
|
# Specifies whether the certificate is active.
|
@@ -1684,9 +1940,12 @@ module Aws::IoT
|
|
1684
1940
|
# see [Mitigation actions][1]. Each mitigation action can apply only one
|
1685
1941
|
# type of change.
|
1686
1942
|
#
|
1943
|
+
# Requires permission to access the [CreateMitigationAction][2] action.
|
1944
|
+
#
|
1687
1945
|
#
|
1688
1946
|
#
|
1689
1947
|
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-mitigation-actions.html
|
1948
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1690
1949
|
#
|
1691
1950
|
# @option params [required, String] :action_name
|
1692
1951
|
# A friendly name for the action. Choose a friendly name that accurately
|
@@ -1753,7 +2012,13 @@ module Aws::IoT
|
|
1753
2012
|
req.send_request(options)
|
1754
2013
|
end
|
1755
2014
|
|
1756
|
-
# Creates an
|
2015
|
+
# Creates an IoT OTA update on a target group of things or groups.
|
2016
|
+
#
|
2017
|
+
# Requires permission to access the [CreateOTAUpdate][1] action.
|
2018
|
+
#
|
2019
|
+
#
|
2020
|
+
#
|
2021
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
1757
2022
|
#
|
1758
2023
|
# @option params [required, String] :ota_update_id
|
1759
2024
|
# The ID of the OTA update to be created.
|
@@ -1798,8 +2063,9 @@ module Aws::IoT
|
|
1798
2063
|
# The files to be streamed by the OTA update.
|
1799
2064
|
#
|
1800
2065
|
# @option params [required, String] :role_arn
|
1801
|
-
# The IAM role that grants
|
1802
|
-
# and
|
2066
|
+
# The IAM role that grants Amazon Web Services IoT Core access to the
|
2067
|
+
# Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to
|
2068
|
+
# create an OTA update job.
|
1803
2069
|
#
|
1804
2070
|
# @option params [Hash<String,String>] :additional_parameters
|
1805
2071
|
# A list of additional OTA update parameters which are name-value pairs.
|
@@ -1926,12 +2192,18 @@ module Aws::IoT
|
|
1926
2192
|
req.send_request(options)
|
1927
2193
|
end
|
1928
2194
|
|
1929
|
-
# Creates an
|
2195
|
+
# Creates an IoT policy.
|
1930
2196
|
#
|
1931
2197
|
# The created policy is the default version for the policy. This
|
1932
2198
|
# operation creates a policy version with a version identifier of **1**
|
1933
2199
|
# and sets **1** as the policy's default version.
|
1934
2200
|
#
|
2201
|
+
# Requires permission to access the [CreatePolicy][1] action.
|
2202
|
+
#
|
2203
|
+
#
|
2204
|
+
#
|
2205
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2206
|
+
#
|
1935
2207
|
# @option params [required, String] :policy_name
|
1936
2208
|
# The policy name.
|
1937
2209
|
#
|
@@ -1988,9 +2260,9 @@ module Aws::IoT
|
|
1988
2260
|
req.send_request(options)
|
1989
2261
|
end
|
1990
2262
|
|
1991
|
-
# Creates a new version of the specified
|
1992
|
-
#
|
1993
|
-
#
|
2263
|
+
# Creates a new version of the specified IoT policy. To update a policy,
|
2264
|
+
# create a new policy version. A managed policy can have up to five
|
2265
|
+
# versions. If the policy has five versions, you must use
|
1994
2266
|
# DeletePolicyVersion to delete an existing version before you create a
|
1995
2267
|
# new one.
|
1996
2268
|
#
|
@@ -1999,6 +2271,12 @@ module Aws::IoT
|
|
1999
2271
|
# version that is in effect for the certificates to which the policy is
|
2000
2272
|
# attached).
|
2001
2273
|
#
|
2274
|
+
# Requires permission to access the [CreatePolicyVersion][1] action.
|
2275
|
+
#
|
2276
|
+
#
|
2277
|
+
#
|
2278
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2279
|
+
#
|
2002
2280
|
# @option params [required, String] :policy_name
|
2003
2281
|
# The policy name.
|
2004
2282
|
#
|
@@ -2043,6 +2321,12 @@ module Aws::IoT
|
|
2043
2321
|
|
2044
2322
|
# Creates a provisioning claim.
|
2045
2323
|
#
|
2324
|
+
# Requires permission to access the [CreateProvisioningClaim][1] action.
|
2325
|
+
#
|
2326
|
+
#
|
2327
|
+
#
|
2328
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2329
|
+
#
|
2046
2330
|
# @option params [required, String] :template_name
|
2047
2331
|
# The name of the provisioning template to use.
|
2048
2332
|
#
|
@@ -2076,6 +2360,13 @@ module Aws::IoT
|
|
2076
2360
|
|
2077
2361
|
# Creates a fleet provisioning template.
|
2078
2362
|
#
|
2363
|
+
# Requires permission to access the [CreateProvisioningTemplate][1]
|
2364
|
+
# action.
|
2365
|
+
#
|
2366
|
+
#
|
2367
|
+
#
|
2368
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2369
|
+
#
|
2079
2370
|
# @option params [required, String] :template_name
|
2080
2371
|
# The name of the fleet provisioning template.
|
2081
2372
|
#
|
@@ -2150,6 +2441,13 @@ module Aws::IoT
|
|
2150
2441
|
|
2151
2442
|
# Creates a new version of a fleet provisioning template.
|
2152
2443
|
#
|
2444
|
+
# Requires permission to access the
|
2445
|
+
# [CreateProvisioningTemplateVersion][1] action.
|
2446
|
+
#
|
2447
|
+
#
|
2448
|
+
#
|
2449
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2450
|
+
#
|
2153
2451
|
# @option params [required, String] :template_name
|
2154
2452
|
# The name of the fleet provisioning template.
|
2155
2453
|
#
|
@@ -2190,6 +2488,12 @@ module Aws::IoT
|
|
2190
2488
|
|
2191
2489
|
# Creates a role alias.
|
2192
2490
|
#
|
2491
|
+
# Requires permission to access the [CreateRoleAlias][1] action.
|
2492
|
+
#
|
2493
|
+
#
|
2494
|
+
#
|
2495
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2496
|
+
#
|
2193
2497
|
# @option params [required, String] :role_alias
|
2194
2498
|
# The role alias that points to a role ARN. This allows you to change
|
2195
2499
|
# the role without having to update the device.
|
@@ -2198,7 +2502,8 @@ module Aws::IoT
|
|
2198
2502
|
# The role ARN.
|
2199
2503
|
#
|
2200
2504
|
# @option params [Integer] :credential_duration_seconds
|
2201
|
-
# How long (in seconds) the credentials will be valid.
|
2505
|
+
# How long (in seconds) the credentials will be valid. The default value
|
2506
|
+
# is 3,600 seconds.
|
2202
2507
|
#
|
2203
2508
|
# @option params [Array<Types::Tag>] :tags
|
2204
2509
|
# Metadata which can be used to manage the role alias.
|
@@ -2247,6 +2552,12 @@ module Aws::IoT
|
|
2247
2552
|
|
2248
2553
|
# Creates a scheduled audit that is run at a specified time interval.
|
2249
2554
|
#
|
2555
|
+
# Requires permission to access the [CreateScheduledAudit][1] action.
|
2556
|
+
#
|
2557
|
+
#
|
2558
|
+
#
|
2559
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2560
|
+
#
|
2250
2561
|
# @option params [required, String] :frequency
|
2251
2562
|
# How often the scheduled audit takes place, either `DAILY`, `WEEKLY`,
|
2252
2563
|
# `BIWEEKLY` or `MONTHLY`. The start time of each audit is determined by
|
@@ -2310,6 +2621,12 @@ module Aws::IoT
|
|
2310
2621
|
|
2311
2622
|
# Creates a Device Defender security profile.
|
2312
2623
|
#
|
2624
|
+
# Requires permission to access the [CreateSecurityProfile][1] action.
|
2625
|
+
#
|
2626
|
+
#
|
2627
|
+
#
|
2628
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2629
|
+
#
|
2313
2630
|
# @option params [required, String] :security_profile_name
|
2314
2631
|
# The name you are giving to the security profile.
|
2315
2632
|
#
|
@@ -2425,6 +2742,12 @@ module Aws::IoT
|
|
2425
2742
|
# MQTT messages from a source like S3. You can have one or more files
|
2426
2743
|
# associated with a stream.
|
2427
2744
|
#
|
2745
|
+
# Requires permission to access the [CreateStream][1] action.
|
2746
|
+
#
|
2747
|
+
#
|
2748
|
+
#
|
2749
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2750
|
+
#
|
2428
2751
|
# @option params [required, String] :stream_id
|
2429
2752
|
# The stream ID.
|
2430
2753
|
#
|
@@ -2496,9 +2819,12 @@ module Aws::IoT
|
|
2496
2819
|
#
|
2497
2820
|
# </note>
|
2498
2821
|
#
|
2822
|
+
# Requires permission to access the [CreateThing][2] action.
|
2823
|
+
#
|
2499
2824
|
#
|
2500
2825
|
#
|
2501
2826
|
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html
|
2827
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2502
2828
|
#
|
2503
2829
|
# @option params [required, String] :thing_name
|
2504
2830
|
# The name of the thing to create.
|
@@ -2559,9 +2885,12 @@ module Aws::IoT
|
|
2559
2885
|
#
|
2560
2886
|
# </note>
|
2561
2887
|
#
|
2888
|
+
# Requires permission to access the [CreateThingGroup][2] action.
|
2889
|
+
#
|
2562
2890
|
#
|
2563
2891
|
#
|
2564
2892
|
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html
|
2893
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2565
2894
|
#
|
2566
2895
|
# @option params [required, String] :thing_group_name
|
2567
2896
|
# The thing group name to create.
|
@@ -2618,6 +2947,12 @@ module Aws::IoT
|
|
2618
2947
|
|
2619
2948
|
# Creates a new thing type.
|
2620
2949
|
#
|
2950
|
+
# Requires permission to access the [CreateThingType][1] action.
|
2951
|
+
#
|
2952
|
+
#
|
2953
|
+
#
|
2954
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2955
|
+
#
|
2621
2956
|
# @option params [required, String] :thing_type_name
|
2622
2957
|
# The name of the thing type.
|
2623
2958
|
#
|
@@ -2668,6 +3003,12 @@ module Aws::IoT
|
|
2668
3003
|
# user who has permission to create rules will be able to access data
|
2669
3004
|
# processed by the rule.
|
2670
3005
|
#
|
3006
|
+
# Requires permission to access the [CreateTopicRule][1] action.
|
3007
|
+
#
|
3008
|
+
#
|
3009
|
+
#
|
3010
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3011
|
+
#
|
2671
3012
|
# @option params [required, String] :rule_name
|
2672
3013
|
# The name of the rule.
|
2673
3014
|
#
|
@@ -2865,6 +3206,13 @@ module Aws::IoT
|
|
2865
3206
|
# "String" => "String",
|
2866
3207
|
# },
|
2867
3208
|
# },
|
3209
|
+
# open_search: {
|
3210
|
+
# role_arn: "AwsArn", # required
|
3211
|
+
# endpoint: "ElasticsearchEndpoint", # required
|
3212
|
+
# index: "ElasticsearchIndex", # required
|
3213
|
+
# type: "ElasticsearchType", # required
|
3214
|
+
# id: "ElasticsearchId", # required
|
3215
|
+
# },
|
2868
3216
|
# },
|
2869
3217
|
# ],
|
2870
3218
|
# rule_disabled: false,
|
@@ -3036,6 +3384,13 @@ module Aws::IoT
|
|
3036
3384
|
# "String" => "String",
|
3037
3385
|
# },
|
3038
3386
|
# },
|
3387
|
+
# open_search: {
|
3388
|
+
# role_arn: "AwsArn", # required
|
3389
|
+
# endpoint: "ElasticsearchEndpoint", # required
|
3390
|
+
# index: "ElasticsearchIndex", # required
|
3391
|
+
# type: "ElasticsearchType", # required
|
3392
|
+
# id: "ElasticsearchId", # required
|
3393
|
+
# },
|
3039
3394
|
# },
|
3040
3395
|
# },
|
3041
3396
|
# tags: "String",
|
@@ -3051,6 +3406,13 @@ module Aws::IoT
|
|
3051
3406
|
# Creates a topic rule destination. The destination must be confirmed
|
3052
3407
|
# prior to use.
|
3053
3408
|
#
|
3409
|
+
# Requires permission to access the [CreateTopicRuleDestination][1]
|
3410
|
+
# action.
|
3411
|
+
#
|
3412
|
+
#
|
3413
|
+
#
|
3414
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3415
|
+
#
|
3054
3416
|
# @option params [required, Types::TopicRuleDestinationConfiguration] :destination_configuration
|
3055
3417
|
# The topic rule destination configuration.
|
3056
3418
|
#
|
@@ -3100,6 +3462,13 @@ module Aws::IoT
|
|
3100
3462
|
# account. Any configuration data you entered is deleted and all audit
|
3101
3463
|
# checks are reset to disabled.
|
3102
3464
|
#
|
3465
|
+
# Requires permission to access the [DeleteAccountAuditConfiguration][1]
|
3466
|
+
# action.
|
3467
|
+
#
|
3468
|
+
#
|
3469
|
+
#
|
3470
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3471
|
+
#
|
3103
3472
|
# @option params [Boolean] :delete_scheduled_audits
|
3104
3473
|
# If true, all scheduled audits are deleted.
|
3105
3474
|
#
|
@@ -3120,6 +3489,12 @@ module Aws::IoT
|
|
3120
3489
|
|
3121
3490
|
# Deletes a Device Defender audit suppression.
|
3122
3491
|
#
|
3492
|
+
# Requires permission to access the [DeleteAuditSuppression][1] action.
|
3493
|
+
#
|
3494
|
+
#
|
3495
|
+
#
|
3496
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3497
|
+
#
|
3123
3498
|
# @option params [required, String] :check_name
|
3124
3499
|
# An audit check name. Checks must be enabled for your account. (Use
|
3125
3500
|
# `DescribeAccountAuditConfiguration` to see the list of all checks,
|
@@ -3159,6 +3534,12 @@ module Aws::IoT
|
|
3159
3534
|
|
3160
3535
|
# Deletes an authorizer.
|
3161
3536
|
#
|
3537
|
+
# Requires permission to access the [DeleteAuthorizer][1] action.
|
3538
|
+
#
|
3539
|
+
#
|
3540
|
+
#
|
3541
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3542
|
+
#
|
3162
3543
|
# @option params [required, String] :authorizer_name
|
3163
3544
|
# The name of the authorizer to delete.
|
3164
3545
|
#
|
@@ -3179,6 +3560,12 @@ module Aws::IoT
|
|
3179
3560
|
|
3180
3561
|
# Deletes the billing group.
|
3181
3562
|
#
|
3563
|
+
# Requires permission to access the [DeleteBillingGroup][1] action.
|
3564
|
+
#
|
3565
|
+
#
|
3566
|
+
#
|
3567
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3568
|
+
#
|
3182
3569
|
# @option params [required, String] :billing_group_name
|
3183
3570
|
# The name of the billing group.
|
3184
3571
|
#
|
@@ -3206,6 +3593,12 @@ module Aws::IoT
|
|
3206
3593
|
|
3207
3594
|
# Deletes a registered CA certificate.
|
3208
3595
|
#
|
3596
|
+
# Requires permission to access the [DeleteCACertificate][1] action.
|
3597
|
+
#
|
3598
|
+
#
|
3599
|
+
#
|
3600
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3601
|
+
#
|
3209
3602
|
# @option params [required, String] :certificate_id
|
3210
3603
|
# The ID of the certificate to delete. (The last part of the certificate
|
3211
3604
|
# ARN contains the certificate ID.)
|
@@ -3229,9 +3622,15 @@ module Aws::IoT
|
|
3229
3622
|
#
|
3230
3623
|
# A certificate cannot be deleted if it has a policy or IoT thing
|
3231
3624
|
# attached to it or if its status is set to ACTIVE. To delete a
|
3232
|
-
# certificate, first use the
|
3233
|
-
#
|
3234
|
-
#
|
3625
|
+
# certificate, first use the DetachPolicy action to detach all policies.
|
3626
|
+
# Next, use the UpdateCertificate action to set the certificate to the
|
3627
|
+
# INACTIVE status.
|
3628
|
+
#
|
3629
|
+
# Requires permission to access the [DeleteCertificate][1] action.
|
3630
|
+
#
|
3631
|
+
#
|
3632
|
+
#
|
3633
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3235
3634
|
#
|
3236
3635
|
# @option params [required, String] :certificate_id
|
3237
3636
|
# The ID of the certificate. (The last part of the certificate ARN
|
@@ -3257,19 +3656,22 @@ module Aws::IoT
|
|
3257
3656
|
req.send_request(options)
|
3258
3657
|
end
|
3259
3658
|
|
3659
|
+
# Deletes a Device Defender detect custom metric.
|
3660
|
+
#
|
3661
|
+
# Requires permission to access the [DeleteCustomMetric][1] action.
|
3662
|
+
#
|
3260
3663
|
# <note markdown="1"> Before you can delete a custom metric, you must first remove the
|
3261
3664
|
# custom metric from all security profiles it's a part of. The security
|
3262
3665
|
# profile associated with the custom metric can be found using the
|
3263
|
-
# [ListSecurityProfiles][
|
3666
|
+
# [ListSecurityProfiles][2] API with `metricName` set to your custom
|
3264
3667
|
# metric name.
|
3265
3668
|
#
|
3266
3669
|
# </note>
|
3267
3670
|
#
|
3268
|
-
# Deletes a Device Defender detect custom metric.
|
3269
|
-
#
|
3270
3671
|
#
|
3271
3672
|
#
|
3272
|
-
# [1]: https://docs.aws.amazon.com/
|
3673
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3674
|
+
# [2]: https://docs.aws.amazon.com/iot/latest/apireference/API_ListSecurityProfiles.html
|
3273
3675
|
#
|
3274
3676
|
# @option params [required, String] :metric_name
|
3275
3677
|
# The name of the custom metric.
|
@@ -3289,9 +3691,16 @@ module Aws::IoT
|
|
3289
3691
|
req.send_request(options)
|
3290
3692
|
end
|
3291
3693
|
|
3292
|
-
# Removes the specified dimension from your
|
3694
|
+
# Removes the specified dimension from your Amazon Web Services
|
3695
|
+
# accounts.
|
3293
3696
|
#
|
3294
|
-
#
|
3697
|
+
# Requires permission to access the [DeleteDimension][1] action.
|
3698
|
+
#
|
3699
|
+
#
|
3700
|
+
#
|
3701
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3702
|
+
#
|
3703
|
+
# @option params [required, String] :name
|
3295
3704
|
# The unique identifier for the dimension that you want to delete.
|
3296
3705
|
#
|
3297
3706
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -3311,6 +3720,13 @@ module Aws::IoT
|
|
3311
3720
|
|
3312
3721
|
# Deletes the specified domain configuration.
|
3313
3722
|
#
|
3723
|
+
# Requires permission to access the [DeleteDomainConfiguration][1]
|
3724
|
+
# action.
|
3725
|
+
#
|
3726
|
+
#
|
3727
|
+
#
|
3728
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3729
|
+
#
|
3314
3730
|
# @option params [required, String] :domain_configuration_name
|
3315
3731
|
# The name of the domain configuration to be deleted.
|
3316
3732
|
#
|
@@ -3331,6 +3747,12 @@ module Aws::IoT
|
|
3331
3747
|
|
3332
3748
|
# Deletes a dynamic thing group.
|
3333
3749
|
#
|
3750
|
+
# Requires permission to access the [DeleteDynamicThingGroup][1] action.
|
3751
|
+
#
|
3752
|
+
#
|
3753
|
+
#
|
3754
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3755
|
+
#
|
3334
3756
|
# @option params [required, String] :thing_group_name
|
3335
3757
|
# The name of the dynamic thing group to delete.
|
3336
3758
|
#
|
@@ -3353,6 +3775,38 @@ module Aws::IoT
|
|
3353
3775
|
req.send_request(options)
|
3354
3776
|
end
|
3355
3777
|
|
3778
|
+
# Deletes the specified fleet metric. Returns successfully with no error
|
3779
|
+
# if the deletion is successful or you specify a fleet metric that
|
3780
|
+
# doesn't exist.
|
3781
|
+
#
|
3782
|
+
# Requires permission to access the [DeleteFleetMetric][1] action.
|
3783
|
+
#
|
3784
|
+
#
|
3785
|
+
#
|
3786
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3787
|
+
#
|
3788
|
+
# @option params [required, String] :metric_name
|
3789
|
+
# The name of the fleet metric to delete.
|
3790
|
+
#
|
3791
|
+
# @option params [Integer] :expected_version
|
3792
|
+
# The expected version of the fleet metric to delete.
|
3793
|
+
#
|
3794
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3795
|
+
#
|
3796
|
+
# @example Request syntax with placeholder values
|
3797
|
+
#
|
3798
|
+
# resp = client.delete_fleet_metric({
|
3799
|
+
# metric_name: "FleetMetricName", # required
|
3800
|
+
# expected_version: 1,
|
3801
|
+
# })
|
3802
|
+
#
|
3803
|
+
# @overload delete_fleet_metric(params = {})
|
3804
|
+
# @param [Hash] params ({})
|
3805
|
+
def delete_fleet_metric(params = {}, options = {})
|
3806
|
+
req = build_request(:delete_fleet_metric, params)
|
3807
|
+
req.send_request(options)
|
3808
|
+
end
|
3809
|
+
|
3356
3810
|
# Deletes a job and its related job executions.
|
3357
3811
|
#
|
3358
3812
|
# Deleting a job may take time, depending on the number of job
|
@@ -3364,6 +3818,12 @@ module Aws::IoT
|
|
3364
3818
|
# Only 10 jobs may have status "DELETION\_IN\_PROGRESS" at the same
|
3365
3819
|
# time, or a LimitExceededException will occur.
|
3366
3820
|
#
|
3821
|
+
# Requires permission to access the [DeleteJob][1] action.
|
3822
|
+
#
|
3823
|
+
#
|
3824
|
+
#
|
3825
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3826
|
+
#
|
3367
3827
|
# @option params [required, String] :job_id
|
3368
3828
|
# The ID of the job to be deleted.
|
3369
3829
|
#
|
@@ -3388,9 +3848,9 @@ module Aws::IoT
|
|
3388
3848
|
# @option params [String] :namespace_id
|
3389
3849
|
# The namespace used to indicate that a job is a customer-managed job.
|
3390
3850
|
#
|
3391
|
-
# When you specify a value for this parameter,
|
3392
|
-
# notifications to MQTT topics that contain the value in
|
3393
|
-
# format.
|
3851
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
3852
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
3853
|
+
# the following format.
|
3394
3854
|
#
|
3395
3855
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
3396
3856
|
#
|
@@ -3417,6 +3877,12 @@ module Aws::IoT
|
|
3417
3877
|
|
3418
3878
|
# Deletes a job execution.
|
3419
3879
|
#
|
3880
|
+
# Requires permission to access the [DeleteJobExecution][1] action.
|
3881
|
+
#
|
3882
|
+
#
|
3883
|
+
#
|
3884
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3885
|
+
#
|
3420
3886
|
# @option params [required, String] :job_id
|
3421
3887
|
# The ID of the job whose execution on a particular device will be
|
3422
3888
|
# deleted.
|
@@ -3448,9 +3914,9 @@ module Aws::IoT
|
|
3448
3914
|
# @option params [String] :namespace_id
|
3449
3915
|
# The namespace used to indicate that a job is a customer-managed job.
|
3450
3916
|
#
|
3451
|
-
# When you specify a value for this parameter,
|
3452
|
-
# notifications to MQTT topics that contain the value in
|
3453
|
-
# format.
|
3917
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
3918
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
3919
|
+
# the following format.
|
3454
3920
|
#
|
3455
3921
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
3456
3922
|
#
|
@@ -3497,7 +3963,14 @@ module Aws::IoT
|
|
3497
3963
|
req.send_request(options)
|
3498
3964
|
end
|
3499
3965
|
|
3500
|
-
# Deletes a defined mitigation action from your
|
3966
|
+
# Deletes a defined mitigation action from your Amazon Web Services
|
3967
|
+
# accounts.
|
3968
|
+
#
|
3969
|
+
# Requires permission to access the [DeleteMitigationAction][1] action.
|
3970
|
+
#
|
3971
|
+
#
|
3972
|
+
#
|
3973
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
3501
3974
|
#
|
3502
3975
|
# @option params [required, String] :action_name
|
3503
3976
|
# The name of the mitigation action that you want to delete.
|
@@ -3519,6 +3992,12 @@ module Aws::IoT
|
|
3519
3992
|
|
3520
3993
|
# Delete an OTA update.
|
3521
3994
|
#
|
3995
|
+
# Requires permission to access the [DeleteOTAUpdate][1] action.
|
3996
|
+
#
|
3997
|
+
#
|
3998
|
+
#
|
3999
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4000
|
+
#
|
3522
4001
|
# @option params [required, String] :ota_update_id
|
3523
4002
|
# The ID of the OTA update to delete.
|
3524
4003
|
#
|
@@ -3528,7 +4007,7 @@ module Aws::IoT
|
|
3528
4007
|
# OTAUpdate is supplied by the user.
|
3529
4008
|
#
|
3530
4009
|
# @option params [Boolean] :force_delete_aws_job
|
3531
|
-
# When true, deletes the
|
4010
|
+
# When true, deletes the IoT job created by the OTAUpdate process even
|
3532
4011
|
# if it is "IN\_PROGRESS". Otherwise, if the job is not in a terminal
|
3533
4012
|
# state ("COMPLETED" or "CANCELED") an exception will occur. The
|
3534
4013
|
# default is false.
|
@@ -3555,14 +4034,26 @@ module Aws::IoT
|
|
3555
4034
|
# A policy cannot be deleted if it has non-default versions or it is
|
3556
4035
|
# attached to any certificate.
|
3557
4036
|
#
|
3558
|
-
# To delete a policy, use the DeletePolicyVersion
|
3559
|
-
# non-default versions of the policy; use the
|
3560
|
-
#
|
3561
|
-
#
|
4037
|
+
# To delete a policy, use the DeletePolicyVersion action to delete all
|
4038
|
+
# non-default versions of the policy; use the DetachPolicy action to
|
4039
|
+
# detach the policy from any certificate; and then use the DeletePolicy
|
4040
|
+
# action to delete the policy.
|
3562
4041
|
#
|
3563
4042
|
# When a policy is deleted using DeletePolicy, its default version is
|
3564
4043
|
# deleted with it.
|
3565
4044
|
#
|
4045
|
+
# <note markdown="1"> Because of the distributed nature of Amazon Web Services, it can take
|
4046
|
+
# up to five minutes after a policy is detached before it's ready to be
|
4047
|
+
# deleted.
|
4048
|
+
#
|
4049
|
+
# </note>
|
4050
|
+
#
|
4051
|
+
# Requires permission to access the [DeletePolicy][1] action.
|
4052
|
+
#
|
4053
|
+
#
|
4054
|
+
#
|
4055
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4056
|
+
#
|
3566
4057
|
# @option params [required, String] :policy_name
|
3567
4058
|
# The name of the policy to delete.
|
3568
4059
|
#
|
@@ -3582,11 +4073,17 @@ module Aws::IoT
|
|
3582
4073
|
end
|
3583
4074
|
|
3584
4075
|
# 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
|
4076
|
+
# delete the default version of a policy using this action. To delete
|
4077
|
+
# the default version of a policy, use DeletePolicy. To find out which
|
3587
4078
|
# version of a policy is marked as the default version, use
|
3588
4079
|
# ListPolicyVersions.
|
3589
4080
|
#
|
4081
|
+
# Requires permission to access the [DeletePolicyVersion][1] action.
|
4082
|
+
#
|
4083
|
+
#
|
4084
|
+
#
|
4085
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4086
|
+
#
|
3590
4087
|
# @option params [required, String] :policy_name
|
3591
4088
|
# The name of the policy.
|
3592
4089
|
#
|
@@ -3611,6 +4108,13 @@ module Aws::IoT
|
|
3611
4108
|
|
3612
4109
|
# Deletes a fleet provisioning template.
|
3613
4110
|
#
|
4111
|
+
# Requires permission to access the [DeleteProvisioningTemplate][1]
|
4112
|
+
# action.
|
4113
|
+
#
|
4114
|
+
#
|
4115
|
+
#
|
4116
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4117
|
+
#
|
3614
4118
|
# @option params [required, String] :template_name
|
3615
4119
|
# The name of the fleet provision template to delete.
|
3616
4120
|
#
|
@@ -3631,6 +4135,13 @@ module Aws::IoT
|
|
3631
4135
|
|
3632
4136
|
# Deletes a fleet provisioning template version.
|
3633
4137
|
#
|
4138
|
+
# Requires permission to access the
|
4139
|
+
# [DeleteProvisioningTemplateVersion][1] action.
|
4140
|
+
#
|
4141
|
+
#
|
4142
|
+
#
|
4143
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4144
|
+
#
|
3634
4145
|
# @option params [required, String] :template_name
|
3635
4146
|
# The name of the fleet provisioning template version to delete.
|
3636
4147
|
#
|
@@ -3655,6 +4166,12 @@ module Aws::IoT
|
|
3655
4166
|
|
3656
4167
|
# Deletes a CA certificate registration code.
|
3657
4168
|
#
|
4169
|
+
# Requires permission to access the [DeleteRegistrationCode][1] action.
|
4170
|
+
#
|
4171
|
+
#
|
4172
|
+
#
|
4173
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4174
|
+
#
|
3658
4175
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3659
4176
|
#
|
3660
4177
|
# @overload delete_registration_code(params = {})
|
@@ -3666,6 +4183,12 @@ module Aws::IoT
|
|
3666
4183
|
|
3667
4184
|
# Deletes a role alias
|
3668
4185
|
#
|
4186
|
+
# Requires permission to access the [DeleteRoleAlias][1] action.
|
4187
|
+
#
|
4188
|
+
#
|
4189
|
+
#
|
4190
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4191
|
+
#
|
3669
4192
|
# @option params [required, String] :role_alias
|
3670
4193
|
# The role alias to delete.
|
3671
4194
|
#
|
@@ -3686,6 +4209,12 @@ module Aws::IoT
|
|
3686
4209
|
|
3687
4210
|
# Deletes a scheduled audit.
|
3688
4211
|
#
|
4212
|
+
# Requires permission to access the [DeleteScheduledAudit][1] action.
|
4213
|
+
#
|
4214
|
+
#
|
4215
|
+
#
|
4216
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4217
|
+
#
|
3689
4218
|
# @option params [required, String] :scheduled_audit_name
|
3690
4219
|
# The name of the scheduled audit you want to delete.
|
3691
4220
|
#
|
@@ -3706,6 +4235,12 @@ module Aws::IoT
|
|
3706
4235
|
|
3707
4236
|
# Deletes a Device Defender security profile.
|
3708
4237
|
#
|
4238
|
+
# Requires permission to access the [DeleteSecurityProfile][1] action.
|
4239
|
+
#
|
4240
|
+
#
|
4241
|
+
#
|
4242
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4243
|
+
#
|
3709
4244
|
# @option params [required, String] :security_profile_name
|
3710
4245
|
# The name of the security profile to be deleted.
|
3711
4246
|
#
|
@@ -3733,6 +4268,12 @@ module Aws::IoT
|
|
3733
4268
|
|
3734
4269
|
# Deletes a stream.
|
3735
4270
|
#
|
4271
|
+
# Requires permission to access the [DeleteStream][1] action.
|
4272
|
+
#
|
4273
|
+
#
|
4274
|
+
#
|
4275
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4276
|
+
#
|
3736
4277
|
# @option params [required, String] :stream_id
|
3737
4278
|
# The stream ID.
|
3738
4279
|
#
|
@@ -3754,6 +4295,12 @@ module Aws::IoT
|
|
3754
4295
|
# Deletes the specified thing. Returns successfully with no error if the
|
3755
4296
|
# deletion is successful or you specify a thing that doesn't exist.
|
3756
4297
|
#
|
4298
|
+
# Requires permission to access the [DeleteThing][1] action.
|
4299
|
+
#
|
4300
|
+
#
|
4301
|
+
#
|
4302
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4303
|
+
#
|
3757
4304
|
# @option params [required, String] :thing_name
|
3758
4305
|
# The name of the thing to delete.
|
3759
4306
|
#
|
@@ -3781,6 +4328,12 @@ module Aws::IoT
|
|
3781
4328
|
|
3782
4329
|
# Deletes a thing group.
|
3783
4330
|
#
|
4331
|
+
# Requires permission to access the [DeleteThingGroup][1] action.
|
4332
|
+
#
|
4333
|
+
#
|
4334
|
+
#
|
4335
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4336
|
+
#
|
3784
4337
|
# @option params [required, String] :thing_group_name
|
3785
4338
|
# The name of the thing group to delete.
|
3786
4339
|
#
|
@@ -3810,6 +4363,12 @@ module Aws::IoT
|
|
3810
4363
|
# any associated thing, and finally use DeleteThingType to delete the
|
3811
4364
|
# thing type.
|
3812
4365
|
#
|
4366
|
+
# Requires permission to access the [DeleteThingType][1] action.
|
4367
|
+
#
|
4368
|
+
#
|
4369
|
+
#
|
4370
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4371
|
+
#
|
3813
4372
|
# @option params [required, String] :thing_type_name
|
3814
4373
|
# The name of the thing type.
|
3815
4374
|
#
|
@@ -3830,6 +4389,12 @@ module Aws::IoT
|
|
3830
4389
|
|
3831
4390
|
# Deletes the rule.
|
3832
4391
|
#
|
4392
|
+
# Requires permission to access the [DeleteTopicRule][1] action.
|
4393
|
+
#
|
4394
|
+
#
|
4395
|
+
#
|
4396
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4397
|
+
#
|
3833
4398
|
# @option params [required, String] :rule_name
|
3834
4399
|
# The name of the rule.
|
3835
4400
|
#
|
@@ -3850,6 +4415,13 @@ module Aws::IoT
|
|
3850
4415
|
|
3851
4416
|
# Deletes a topic rule destination.
|
3852
4417
|
#
|
4418
|
+
# Requires permission to access the [DeleteTopicRuleDestination][1]
|
4419
|
+
# action.
|
4420
|
+
#
|
4421
|
+
#
|
4422
|
+
#
|
4423
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4424
|
+
#
|
3853
4425
|
# @option params [required, String] :arn
|
3854
4426
|
# The ARN of the topic rule destination to delete.
|
3855
4427
|
#
|
@@ -3870,6 +4442,12 @@ module Aws::IoT
|
|
3870
4442
|
|
3871
4443
|
# Deletes a logging level.
|
3872
4444
|
#
|
4445
|
+
# Requires permission to access the [DeleteV2LoggingLevel][1] action.
|
4446
|
+
#
|
4447
|
+
#
|
4448
|
+
#
|
4449
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4450
|
+
#
|
3873
4451
|
# @option params [required, String] :target_type
|
3874
4452
|
# The type of resource for which you are configuring logging. Must be
|
3875
4453
|
# `THING_Group`.
|
@@ -3896,6 +4474,12 @@ module Aws::IoT
|
|
3896
4474
|
# Deprecates a thing type. You can not associate new things with
|
3897
4475
|
# deprecated thing type.
|
3898
4476
|
#
|
4477
|
+
# Requires permission to access the [DeprecateThingType][1] action.
|
4478
|
+
#
|
4479
|
+
#
|
4480
|
+
#
|
4481
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4482
|
+
#
|
3899
4483
|
# @option params [required, String] :thing_type_name
|
3900
4484
|
# The name of the thing type to deprecate.
|
3901
4485
|
#
|
@@ -3924,6 +4508,13 @@ module Aws::IoT
|
|
3924
4508
|
# account. Settings include how audit notifications are sent and which
|
3925
4509
|
# audit checks are enabled or disabled.
|
3926
4510
|
#
|
4511
|
+
# Requires permission to access the
|
4512
|
+
# [DescribeAccountAuditConfiguration][1] action.
|
4513
|
+
#
|
4514
|
+
#
|
4515
|
+
#
|
4516
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4517
|
+
#
|
3927
4518
|
# @return [Types::DescribeAccountAuditConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3928
4519
|
#
|
3929
4520
|
# * {Types::DescribeAccountAuditConfigurationResponse#role_arn #role_arn} => String
|
@@ -3951,6 +4542,12 @@ module Aws::IoT
|
|
3951
4542
|
# reason for noncompliance, the severity of the issue, and the start
|
3952
4543
|
# time when the audit that returned the finding.
|
3953
4544
|
#
|
4545
|
+
# Requires permission to access the [DescribeAuditFinding][1] action.
|
4546
|
+
#
|
4547
|
+
#
|
4548
|
+
#
|
4549
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4550
|
+
#
|
3954
4551
|
# @option params [required, String] :finding_id
|
3955
4552
|
# A unique identifier for a single audit finding. You can use this
|
3956
4553
|
# identifier to apply mitigation actions to the finding.
|
@@ -4137,6 +4734,12 @@ module Aws::IoT
|
|
4137
4734
|
|
4138
4735
|
# Gets information about a Device Defender audit.
|
4139
4736
|
#
|
4737
|
+
# Requires permission to access the [DescribeAuditTask][1] action.
|
4738
|
+
#
|
4739
|
+
#
|
4740
|
+
#
|
4741
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4742
|
+
#
|
4140
4743
|
# @option params [required, String] :task_id
|
4141
4744
|
# The ID of the audit whose information you want to get.
|
4142
4745
|
#
|
@@ -4186,6 +4789,12 @@ module Aws::IoT
|
|
4186
4789
|
|
4187
4790
|
# Describes an authorizer.
|
4188
4791
|
#
|
4792
|
+
# Requires permission to access the [DescribeAuthorizer][1] action.
|
4793
|
+
#
|
4794
|
+
#
|
4795
|
+
#
|
4796
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4797
|
+
#
|
4189
4798
|
# @option params [required, String] :authorizer_name
|
4190
4799
|
# The name of the authorizer to describe.
|
4191
4800
|
#
|
@@ -4221,6 +4830,12 @@ module Aws::IoT
|
|
4221
4830
|
|
4222
4831
|
# Returns information about a billing group.
|
4223
4832
|
#
|
4833
|
+
# Requires permission to access the [DescribeBillingGroup][1] action.
|
4834
|
+
#
|
4835
|
+
#
|
4836
|
+
#
|
4837
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4838
|
+
#
|
4224
4839
|
# @option params [required, String] :billing_group_name
|
4225
4840
|
# The name of the billing group.
|
4226
4841
|
#
|
@@ -4257,6 +4872,12 @@ module Aws::IoT
|
|
4257
4872
|
|
4258
4873
|
# Describes a registered CA certificate.
|
4259
4874
|
#
|
4875
|
+
# Requires permission to access the [DescribeCACertificate][1] action.
|
4876
|
+
#
|
4877
|
+
#
|
4878
|
+
#
|
4879
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4880
|
+
#
|
4260
4881
|
# @option params [required, String] :certificate_id
|
4261
4882
|
# The CA certificate identifier.
|
4262
4883
|
#
|
@@ -4297,6 +4918,12 @@ module Aws::IoT
|
|
4297
4918
|
|
4298
4919
|
# Gets information about the specified certificate.
|
4299
4920
|
#
|
4921
|
+
# Requires permission to access the [DescribeCertificate][1] action.
|
4922
|
+
#
|
4923
|
+
#
|
4924
|
+
#
|
4925
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4926
|
+
#
|
4300
4927
|
# @option params [required, String] :certificate_id
|
4301
4928
|
# The ID of the certificate. (The last part of the certificate ARN
|
4302
4929
|
# contains the certificate ID.)
|
@@ -4342,6 +4969,12 @@ module Aws::IoT
|
|
4342
4969
|
|
4343
4970
|
# Gets information about a Device Defender detect custom metric.
|
4344
4971
|
#
|
4972
|
+
# Requires permission to access the [DescribeCustomMetric][1] action.
|
4973
|
+
#
|
4974
|
+
#
|
4975
|
+
#
|
4976
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4977
|
+
#
|
4345
4978
|
# @option params [required, String] :metric_name
|
4346
4979
|
# The name of the custom metric.
|
4347
4980
|
#
|
@@ -4378,6 +5011,13 @@ module Aws::IoT
|
|
4378
5011
|
|
4379
5012
|
# Describes the default authorizer.
|
4380
5013
|
#
|
5014
|
+
# Requires permission to access the [DescribeDefaultAuthorizer][1]
|
5015
|
+
# action.
|
5016
|
+
#
|
5017
|
+
#
|
5018
|
+
#
|
5019
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5020
|
+
#
|
4381
5021
|
# @return [Types::DescribeDefaultAuthorizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4382
5022
|
#
|
4383
5023
|
# * {Types::DescribeDefaultAuthorizerResponse#authorizer_description #authorizer_description} => Types::AuthorizerDescription
|
@@ -4404,6 +5044,13 @@ module Aws::IoT
|
|
4404
5044
|
|
4405
5045
|
# Gets information about a Device Defender ML Detect mitigation action.
|
4406
5046
|
#
|
5047
|
+
# Requires permission to access the
|
5048
|
+
# [DescribeDetectMitigationActionsTask][1] action.
|
5049
|
+
#
|
5050
|
+
#
|
5051
|
+
#
|
5052
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5053
|
+
#
|
4407
5054
|
# @option params [required, String] :task_id
|
4408
5055
|
# The unique identifier of the task.
|
4409
5056
|
#
|
@@ -4455,8 +5102,14 @@ module Aws::IoT
|
|
4455
5102
|
req.send_request(options)
|
4456
5103
|
end
|
4457
5104
|
|
4458
|
-
# Provides details about a dimension that is defined in your
|
4459
|
-
#
|
5105
|
+
# Provides details about a dimension that is defined in your Amazon Web
|
5106
|
+
# Services accounts.
|
5107
|
+
#
|
5108
|
+
# Requires permission to access the [DescribeDimension][1] action.
|
5109
|
+
#
|
5110
|
+
#
|
5111
|
+
#
|
5112
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4460
5113
|
#
|
4461
5114
|
# @option params [required, String] :name
|
4462
5115
|
# The unique identifier for the dimension.
|
@@ -4495,6 +5148,13 @@ module Aws::IoT
|
|
4495
5148
|
|
4496
5149
|
# Gets summary information about a domain configuration.
|
4497
5150
|
#
|
5151
|
+
# Requires permission to access the [DescribeDomainConfiguration][1]
|
5152
|
+
# action.
|
5153
|
+
#
|
5154
|
+
#
|
5155
|
+
#
|
5156
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5157
|
+
#
|
4498
5158
|
# @option params [required, String] :domain_configuration_name
|
4499
5159
|
# The name of the domain configuration.
|
4500
5160
|
#
|
@@ -4539,7 +5199,14 @@ module Aws::IoT
|
|
4539
5199
|
req.send_request(options)
|
4540
5200
|
end
|
4541
5201
|
|
4542
|
-
# Returns a unique endpoint specific to the
|
5202
|
+
# Returns a unique endpoint specific to the Amazon Web Services account
|
5203
|
+
# making the call.
|
5204
|
+
#
|
5205
|
+
# Requires permission to access the [DescribeEndpoint][1] action.
|
5206
|
+
#
|
5207
|
+
#
|
5208
|
+
#
|
5209
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4543
5210
|
#
|
4544
5211
|
# @option params [String] :endpoint_type
|
4545
5212
|
# The endpoint type. Valid endpoint types include:
|
@@ -4554,13 +5221,13 @@ module Aws::IoT
|
|
4554
5221
|
# ^
|
4555
5222
|
# ^
|
4556
5223
|
#
|
4557
|
-
# * `iot:CredentialProvider` - Returns an
|
4558
|
-
#
|
5224
|
+
# * `iot:CredentialProvider` - Returns an IoT credentials provider API
|
5225
|
+
# endpoint.
|
4559
5226
|
#
|
4560
5227
|
# ^
|
4561
5228
|
# ^
|
4562
5229
|
#
|
4563
|
-
# * `iot:Jobs` - Returns an
|
5230
|
+
# * `iot:Jobs` - Returns an IoT device management Jobs API endpoint.
|
4564
5231
|
#
|
4565
5232
|
# ^
|
4566
5233
|
#
|
@@ -4591,6 +5258,13 @@ module Aws::IoT
|
|
4591
5258
|
|
4592
5259
|
# Describes event configurations.
|
4593
5260
|
#
|
5261
|
+
# Requires permission to access the [DescribeEventConfigurations][1]
|
5262
|
+
# action.
|
5263
|
+
#
|
5264
|
+
#
|
5265
|
+
#
|
5266
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5267
|
+
#
|
4594
5268
|
# @return [Types::DescribeEventConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4595
5269
|
#
|
4596
5270
|
# * {Types::DescribeEventConfigurationsResponse#event_configurations #event_configurations} => Hash<String,Types::Configuration>
|
@@ -4611,8 +5285,72 @@ module Aws::IoT
|
|
4611
5285
|
req.send_request(options)
|
4612
5286
|
end
|
4613
5287
|
|
5288
|
+
# Gets information about the specified fleet metric.
|
5289
|
+
#
|
5290
|
+
# Requires permission to access the [DescribeFleetMetric][1] action.
|
5291
|
+
#
|
5292
|
+
#
|
5293
|
+
#
|
5294
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5295
|
+
#
|
5296
|
+
# @option params [required, String] :metric_name
|
5297
|
+
# The name of the fleet metric to describe.
|
5298
|
+
#
|
5299
|
+
# @return [Types::DescribeFleetMetricResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5300
|
+
#
|
5301
|
+
# * {Types::DescribeFleetMetricResponse#metric_name #metric_name} => String
|
5302
|
+
# * {Types::DescribeFleetMetricResponse#query_string #query_string} => String
|
5303
|
+
# * {Types::DescribeFleetMetricResponse#aggregation_type #aggregation_type} => Types::AggregationType
|
5304
|
+
# * {Types::DescribeFleetMetricResponse#period #period} => Integer
|
5305
|
+
# * {Types::DescribeFleetMetricResponse#aggregation_field #aggregation_field} => String
|
5306
|
+
# * {Types::DescribeFleetMetricResponse#description #description} => String
|
5307
|
+
# * {Types::DescribeFleetMetricResponse#query_version #query_version} => String
|
5308
|
+
# * {Types::DescribeFleetMetricResponse#index_name #index_name} => String
|
5309
|
+
# * {Types::DescribeFleetMetricResponse#creation_date #creation_date} => Time
|
5310
|
+
# * {Types::DescribeFleetMetricResponse#last_modified_date #last_modified_date} => Time
|
5311
|
+
# * {Types::DescribeFleetMetricResponse#unit #unit} => String
|
5312
|
+
# * {Types::DescribeFleetMetricResponse#version #version} => Integer
|
5313
|
+
# * {Types::DescribeFleetMetricResponse#metric_arn #metric_arn} => String
|
5314
|
+
#
|
5315
|
+
# @example Request syntax with placeholder values
|
5316
|
+
#
|
5317
|
+
# resp = client.describe_fleet_metric({
|
5318
|
+
# metric_name: "FleetMetricName", # required
|
5319
|
+
# })
|
5320
|
+
#
|
5321
|
+
# @example Response structure
|
5322
|
+
#
|
5323
|
+
# resp.metric_name #=> String
|
5324
|
+
# resp.query_string #=> String
|
5325
|
+
# resp.aggregation_type.name #=> String, one of "Statistics", "Percentiles", "Cardinality"
|
5326
|
+
# resp.aggregation_type.values #=> Array
|
5327
|
+
# resp.aggregation_type.values[0] #=> String
|
5328
|
+
# resp.period #=> Integer
|
5329
|
+
# resp.aggregation_field #=> String
|
5330
|
+
# resp.description #=> String
|
5331
|
+
# resp.query_version #=> String
|
5332
|
+
# resp.index_name #=> String
|
5333
|
+
# resp.creation_date #=> Time
|
5334
|
+
# resp.last_modified_date #=> Time
|
5335
|
+
# 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"
|
5336
|
+
# resp.version #=> Integer
|
5337
|
+
# resp.metric_arn #=> String
|
5338
|
+
#
|
5339
|
+
# @overload describe_fleet_metric(params = {})
|
5340
|
+
# @param [Hash] params ({})
|
5341
|
+
def describe_fleet_metric(params = {}, options = {})
|
5342
|
+
req = build_request(:describe_fleet_metric, params)
|
5343
|
+
req.send_request(options)
|
5344
|
+
end
|
5345
|
+
|
4614
5346
|
# Describes a search index.
|
4615
5347
|
#
|
5348
|
+
# Requires permission to access the [DescribeIndex][1] action.
|
5349
|
+
#
|
5350
|
+
#
|
5351
|
+
#
|
5352
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5353
|
+
#
|
4616
5354
|
# @option params [required, String] :index_name
|
4617
5355
|
# The index name.
|
4618
5356
|
#
|
@@ -4643,6 +5381,12 @@ module Aws::IoT
|
|
4643
5381
|
|
4644
5382
|
# Describes a job.
|
4645
5383
|
#
|
5384
|
+
# Requires permission to access the [DescribeJob][1] action.
|
5385
|
+
#
|
5386
|
+
#
|
5387
|
+
#
|
5388
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5389
|
+
#
|
4646
5390
|
# @option params [required, String] :job_id
|
4647
5391
|
# The unique identifier you assigned to this job when it was created.
|
4648
5392
|
#
|
@@ -4708,6 +5452,12 @@ module Aws::IoT
|
|
4708
5452
|
|
4709
5453
|
# Describes a job execution.
|
4710
5454
|
#
|
5455
|
+
# Requires permission to access the [DescribeJobExecution][1] action.
|
5456
|
+
#
|
5457
|
+
#
|
5458
|
+
#
|
5459
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5460
|
+
#
|
4711
5461
|
# @option params [required, String] :job_id
|
4712
5462
|
# The unique identifier you assigned to this job when it was created.
|
4713
5463
|
#
|
@@ -4807,6 +5557,13 @@ module Aws::IoT
|
|
4807
5557
|
|
4808
5558
|
# Gets information about a mitigation action.
|
4809
5559
|
#
|
5560
|
+
# Requires permission to access the [DescribeMitigationAction][1]
|
5561
|
+
# action.
|
5562
|
+
#
|
5563
|
+
#
|
5564
|
+
#
|
5565
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5566
|
+
#
|
4810
5567
|
# @option params [required, String] :action_name
|
4811
5568
|
# The friendly name that uniquely identifies the mitigation action.
|
4812
5569
|
#
|
@@ -4855,6 +5612,13 @@ module Aws::IoT
|
|
4855
5612
|
|
4856
5613
|
# Returns information about a fleet provisioning template.
|
4857
5614
|
#
|
5615
|
+
# Requires permission to access the [DescribeProvisioningTemplate][1]
|
5616
|
+
# action.
|
5617
|
+
#
|
5618
|
+
#
|
5619
|
+
#
|
5620
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5621
|
+
#
|
4858
5622
|
# @option params [required, String] :template_name
|
4859
5623
|
# The name of the fleet provisioning template.
|
4860
5624
|
#
|
@@ -4900,6 +5664,13 @@ module Aws::IoT
|
|
4900
5664
|
|
4901
5665
|
# Returns information about a fleet provisioning template version.
|
4902
5666
|
#
|
5667
|
+
# Requires permission to access the
|
5668
|
+
# [DescribeProvisioningTemplateVersion][1] action.
|
5669
|
+
#
|
5670
|
+
#
|
5671
|
+
#
|
5672
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5673
|
+
#
|
4903
5674
|
# @option params [required, String] :template_name
|
4904
5675
|
# The template name.
|
4905
5676
|
#
|
@@ -4936,6 +5707,12 @@ module Aws::IoT
|
|
4936
5707
|
|
4937
5708
|
# Describes a role alias.
|
4938
5709
|
#
|
5710
|
+
# Requires permission to access the [DescribeRoleAlias][1] action.
|
5711
|
+
#
|
5712
|
+
#
|
5713
|
+
#
|
5714
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5715
|
+
#
|
4939
5716
|
# @option params [required, String] :role_alias
|
4940
5717
|
# The role alias to describe.
|
4941
5718
|
#
|
@@ -4968,6 +5745,12 @@ module Aws::IoT
|
|
4968
5745
|
|
4969
5746
|
# Gets information about a scheduled audit.
|
4970
5747
|
#
|
5748
|
+
# Requires permission to access the [DescribeScheduledAudit][1] action.
|
5749
|
+
#
|
5750
|
+
#
|
5751
|
+
#
|
5752
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5753
|
+
#
|
4971
5754
|
# @option params [required, String] :scheduled_audit_name
|
4972
5755
|
# The name of the scheduled audit whose information you want to get.
|
4973
5756
|
#
|
@@ -5005,6 +5788,12 @@ module Aws::IoT
|
|
5005
5788
|
|
5006
5789
|
# Gets information about a Device Defender security profile.
|
5007
5790
|
#
|
5791
|
+
# Requires permission to access the [DescribeSecurityProfile][1] action.
|
5792
|
+
#
|
5793
|
+
#
|
5794
|
+
#
|
5795
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5796
|
+
#
|
5008
5797
|
# @option params [required, String] :security_profile_name
|
5009
5798
|
# The name of the security profile whose information you want to get.
|
5010
5799
|
#
|
@@ -5076,6 +5865,12 @@ module Aws::IoT
|
|
5076
5865
|
|
5077
5866
|
# Gets information about a stream.
|
5078
5867
|
#
|
5868
|
+
# Requires permission to access the [DescribeStream][1] action.
|
5869
|
+
#
|
5870
|
+
#
|
5871
|
+
#
|
5872
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5873
|
+
#
|
5079
5874
|
# @option params [required, String] :stream_id
|
5080
5875
|
# The stream ID.
|
5081
5876
|
#
|
@@ -5113,6 +5908,12 @@ module Aws::IoT
|
|
5113
5908
|
|
5114
5909
|
# Gets information about the specified thing.
|
5115
5910
|
#
|
5911
|
+
# Requires permission to access the [DescribeThing][1] action.
|
5912
|
+
#
|
5913
|
+
#
|
5914
|
+
#
|
5915
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5916
|
+
#
|
5116
5917
|
# @option params [required, String] :thing_name
|
5117
5918
|
# The name of the thing.
|
5118
5919
|
#
|
@@ -5154,6 +5955,12 @@ module Aws::IoT
|
|
5154
5955
|
|
5155
5956
|
# Describe a thing group.
|
5156
5957
|
#
|
5958
|
+
# Requires permission to access the [DescribeThingGroup][1] action.
|
5959
|
+
#
|
5960
|
+
#
|
5961
|
+
#
|
5962
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5963
|
+
#
|
5157
5964
|
# @option params [required, String] :thing_group_name
|
5158
5965
|
# The name of the thing group.
|
5159
5966
|
#
|
@@ -5205,6 +6012,13 @@ module Aws::IoT
|
|
5205
6012
|
|
5206
6013
|
# Describes a bulk thing provisioning task.
|
5207
6014
|
#
|
6015
|
+
# Requires permission to access the [DescribeThingRegistrationTask][1]
|
6016
|
+
# action.
|
6017
|
+
#
|
6018
|
+
#
|
6019
|
+
#
|
6020
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6021
|
+
#
|
5208
6022
|
# @option params [required, String] :task_id
|
5209
6023
|
# The task ID.
|
5210
6024
|
#
|
@@ -5253,6 +6067,12 @@ module Aws::IoT
|
|
5253
6067
|
|
5254
6068
|
# Gets information about the specified thing type.
|
5255
6069
|
#
|
6070
|
+
# Requires permission to access the [DescribeThingType][1] action.
|
6071
|
+
#
|
6072
|
+
#
|
6073
|
+
#
|
6074
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6075
|
+
#
|
5256
6076
|
# @option params [required, String] :thing_type_name
|
5257
6077
|
# The name of the thing type.
|
5258
6078
|
#
|
@@ -5291,6 +6111,18 @@ module Aws::IoT
|
|
5291
6111
|
|
5292
6112
|
# Detaches a policy from the specified target.
|
5293
6113
|
#
|
6114
|
+
# <note markdown="1"> Because of the distributed nature of Amazon Web Services, it can take
|
6115
|
+
# up to five minutes after a policy is detached before it's ready to be
|
6116
|
+
# deleted.
|
6117
|
+
#
|
6118
|
+
# </note>
|
6119
|
+
#
|
6120
|
+
# Requires permission to access the [DetachPolicy][1] action.
|
6121
|
+
#
|
6122
|
+
#
|
6123
|
+
#
|
6124
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6125
|
+
#
|
5294
6126
|
# @option params [required, String] :policy_name
|
5295
6127
|
# The policy to detach.
|
5296
6128
|
#
|
@@ -5315,7 +6147,15 @@ module Aws::IoT
|
|
5315
6147
|
|
5316
6148
|
# Removes the specified policy from the specified certificate.
|
5317
6149
|
#
|
5318
|
-
#
|
6150
|
+
# <note markdown="1"> This action is deprecated. Please use DetachPolicy instead.
|
6151
|
+
#
|
6152
|
+
# </note>
|
6153
|
+
#
|
6154
|
+
# Requires permission to access the [DetachPrincipalPolicy][1] action.
|
6155
|
+
#
|
6156
|
+
#
|
6157
|
+
#
|
6158
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5319
6159
|
#
|
5320
6160
|
# @option params [required, String] :policy_name
|
5321
6161
|
# The name of the policy to detach.
|
@@ -5348,6 +6188,12 @@ module Aws::IoT
|
|
5348
6188
|
# Disassociates a Device Defender security profile from a thing group or
|
5349
6189
|
# from this account.
|
5350
6190
|
#
|
6191
|
+
# Requires permission to access the [DetachSecurityProfile][1] action.
|
6192
|
+
#
|
6193
|
+
#
|
6194
|
+
#
|
6195
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6196
|
+
#
|
5351
6197
|
# @option params [required, String] :security_profile_name
|
5352
6198
|
# The security profile that is detached.
|
5353
6199
|
#
|
@@ -5380,6 +6226,12 @@ module Aws::IoT
|
|
5380
6226
|
#
|
5381
6227
|
# </note>
|
5382
6228
|
#
|
6229
|
+
# Requires permission to access the [DetachThingPrincipal][1] action.
|
6230
|
+
#
|
6231
|
+
#
|
6232
|
+
#
|
6233
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6234
|
+
#
|
5383
6235
|
# @option params [required, String] :thing_name
|
5384
6236
|
# The name of the thing.
|
5385
6237
|
#
|
@@ -5406,6 +6258,12 @@ module Aws::IoT
|
|
5406
6258
|
|
5407
6259
|
# Disables the rule.
|
5408
6260
|
#
|
6261
|
+
# Requires permission to access the [DisableTopicRule][1] action.
|
6262
|
+
#
|
6263
|
+
#
|
6264
|
+
#
|
6265
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6266
|
+
#
|
5409
6267
|
# @option params [required, String] :rule_name
|
5410
6268
|
# The name of the rule to disable.
|
5411
6269
|
#
|
@@ -5426,6 +6284,12 @@ module Aws::IoT
|
|
5426
6284
|
|
5427
6285
|
# Enables the rule.
|
5428
6286
|
#
|
6287
|
+
# Requires permission to access the [EnableTopicRule][1] action.
|
6288
|
+
#
|
6289
|
+
#
|
6290
|
+
#
|
6291
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6292
|
+
#
|
5429
6293
|
# @option params [required, String] :rule_name
|
5430
6294
|
# The name of the topic rule to enable.
|
5431
6295
|
#
|
@@ -5447,6 +6311,13 @@ module Aws::IoT
|
|
5447
6311
|
# Returns a Device Defender's ML Detect Security Profile training
|
5448
6312
|
# model's status.
|
5449
6313
|
#
|
6314
|
+
# Requires permission to access the
|
6315
|
+
# [GetBehaviorModelTrainingSummaries][1] action.
|
6316
|
+
#
|
6317
|
+
#
|
6318
|
+
#
|
6319
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6320
|
+
#
|
5450
6321
|
# @option params [String] :security_profile_name
|
5451
6322
|
# The name of the security profile.
|
5452
6323
|
#
|
@@ -5490,13 +6361,77 @@ module Aws::IoT
|
|
5490
6361
|
req.send_request(options)
|
5491
6362
|
end
|
5492
6363
|
|
6364
|
+
# Aggregates on indexed data with search queries pertaining to
|
6365
|
+
# particular fields.
|
6366
|
+
#
|
6367
|
+
# Requires permission to access the [GetBucketsAggregation][1] action.
|
6368
|
+
#
|
6369
|
+
#
|
6370
|
+
#
|
6371
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6372
|
+
#
|
6373
|
+
# @option params [String] :index_name
|
6374
|
+
# The name of the index to search.
|
6375
|
+
#
|
6376
|
+
# @option params [required, String] :query_string
|
6377
|
+
# The search query string.
|
6378
|
+
#
|
6379
|
+
# @option params [required, String] :aggregation_field
|
6380
|
+
# The aggregation field.
|
6381
|
+
#
|
6382
|
+
# @option params [String] :query_version
|
6383
|
+
# The version of the query.
|
6384
|
+
#
|
6385
|
+
# @option params [required, Types::BucketsAggregationType] :buckets_aggregation_type
|
6386
|
+
# The basic control of the response shape and the bucket aggregation
|
6387
|
+
# type to perform.
|
6388
|
+
#
|
6389
|
+
# @return [Types::GetBucketsAggregationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6390
|
+
#
|
6391
|
+
# * {Types::GetBucketsAggregationResponse#total_count #total_count} => Integer
|
6392
|
+
# * {Types::GetBucketsAggregationResponse#buckets #buckets} => Array<Types::Bucket>
|
6393
|
+
#
|
6394
|
+
# @example Request syntax with placeholder values
|
6395
|
+
#
|
6396
|
+
# resp = client.get_buckets_aggregation({
|
6397
|
+
# index_name: "IndexName",
|
6398
|
+
# query_string: "QueryString", # required
|
6399
|
+
# aggregation_field: "AggregationField", # required
|
6400
|
+
# query_version: "QueryVersion",
|
6401
|
+
# buckets_aggregation_type: { # required
|
6402
|
+
# terms_aggregation: {
|
6403
|
+
# max_buckets: 1,
|
6404
|
+
# },
|
6405
|
+
# },
|
6406
|
+
# })
|
6407
|
+
#
|
6408
|
+
# @example Response structure
|
6409
|
+
#
|
6410
|
+
# resp.total_count #=> Integer
|
6411
|
+
# resp.buckets #=> Array
|
6412
|
+
# resp.buckets[0].key_value #=> String
|
6413
|
+
# resp.buckets[0].count #=> Integer
|
6414
|
+
#
|
6415
|
+
# @overload get_buckets_aggregation(params = {})
|
6416
|
+
# @param [Hash] params ({})
|
6417
|
+
def get_buckets_aggregation(params = {}, options = {})
|
6418
|
+
req = build_request(:get_buckets_aggregation, params)
|
6419
|
+
req.send_request(options)
|
6420
|
+
end
|
6421
|
+
|
5493
6422
|
# Returns the approximate count of unique values that match the query.
|
5494
6423
|
#
|
6424
|
+
# Requires permission to access the [GetCardinality][1] action.
|
6425
|
+
#
|
6426
|
+
#
|
6427
|
+
#
|
6428
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6429
|
+
#
|
5495
6430
|
# @option params [String] :index_name
|
5496
6431
|
# The name of the index to search.
|
5497
6432
|
#
|
5498
6433
|
# @option params [required, String] :query_string
|
5499
|
-
# The search query.
|
6434
|
+
# The search query string.
|
5500
6435
|
#
|
5501
6436
|
# @option params [String] :aggregation_field
|
5502
6437
|
# The field to aggregate.
|
@@ -5529,8 +6464,14 @@ module Aws::IoT
|
|
5529
6464
|
end
|
5530
6465
|
|
5531
6466
|
# 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
|
-
#
|
6467
|
+
# behavior of the specified device when it connects to the IoT device
|
6468
|
+
# gateway.
|
6469
|
+
#
|
6470
|
+
# Requires permission to access the [GetEffectivePolicies][1] action.
|
6471
|
+
#
|
6472
|
+
#
|
6473
|
+
#
|
6474
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5534
6475
|
#
|
5535
6476
|
# @option params [String] :principal
|
5536
6477
|
# The principal. Valid principals are CertificateArn
|
@@ -5573,6 +6514,13 @@ module Aws::IoT
|
|
5573
6514
|
|
5574
6515
|
# Gets the indexing configuration.
|
5575
6516
|
#
|
6517
|
+
# Requires permission to access the [GetIndexingConfiguration][1]
|
6518
|
+
# action.
|
6519
|
+
#
|
6520
|
+
#
|
6521
|
+
#
|
6522
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6523
|
+
#
|
5576
6524
|
# @return [Types::GetIndexingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5577
6525
|
#
|
5578
6526
|
# * {Types::GetIndexingConfigurationResponse#thing_indexing_configuration #thing_indexing_configuration} => Types::ThingIndexingConfiguration
|
@@ -5605,6 +6553,12 @@ module Aws::IoT
|
|
5605
6553
|
|
5606
6554
|
# Gets a job document.
|
5607
6555
|
#
|
6556
|
+
# Requires permission to access the [GetJobDocument][1] action.
|
6557
|
+
#
|
6558
|
+
#
|
6559
|
+
#
|
6560
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6561
|
+
#
|
5608
6562
|
# @option params [required, String] :job_id
|
5609
6563
|
# The unique identifier you assigned to this job when it was created.
|
5610
6564
|
#
|
@@ -5634,6 +6588,12 @@ module Aws::IoT
|
|
5634
6588
|
# NOTE: use of this command is not recommended. Use
|
5635
6589
|
# `GetV2LoggingOptions` instead.
|
5636
6590
|
#
|
6591
|
+
# Requires permission to access the [GetLoggingOptions][1] action.
|
6592
|
+
#
|
6593
|
+
#
|
6594
|
+
#
|
6595
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6596
|
+
#
|
5637
6597
|
# @return [Types::GetLoggingOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5638
6598
|
#
|
5639
6599
|
# * {Types::GetLoggingOptionsResponse#role_arn #role_arn} => String
|
@@ -5653,6 +6613,12 @@ module Aws::IoT
|
|
5653
6613
|
|
5654
6614
|
# Gets an OTA update.
|
5655
6615
|
#
|
6616
|
+
# Requires permission to access the [GetOTAUpdate][1] action.
|
6617
|
+
#
|
6618
|
+
#
|
6619
|
+
#
|
6620
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6621
|
+
#
|
5656
6622
|
# @option params [required, String] :ota_update_id
|
5657
6623
|
# The OTA update ID.
|
5658
6624
|
#
|
@@ -5734,11 +6700,17 @@ module Aws::IoT
|
|
5734
6700
|
# approximation, the more values that match the query, the more accurate
|
5735
6701
|
# the percentile values.
|
5736
6702
|
#
|
6703
|
+
# Requires permission to access the [GetPercentiles][1] action.
|
6704
|
+
#
|
6705
|
+
#
|
6706
|
+
#
|
6707
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6708
|
+
#
|
5737
6709
|
# @option params [String] :index_name
|
5738
6710
|
# The name of the index to search.
|
5739
6711
|
#
|
5740
6712
|
# @option params [required, String] :query_string
|
5741
|
-
# The query string.
|
6713
|
+
# The search query string.
|
5742
6714
|
#
|
5743
6715
|
# @option params [String] :aggregation_field
|
5744
6716
|
# The field to aggregate.
|
@@ -5779,6 +6751,12 @@ module Aws::IoT
|
|
5779
6751
|
# Gets information about the specified policy with the policy document
|
5780
6752
|
# of the default version.
|
5781
6753
|
#
|
6754
|
+
# Requires permission to access the [GetPolicy][1] action.
|
6755
|
+
#
|
6756
|
+
#
|
6757
|
+
#
|
6758
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6759
|
+
#
|
5782
6760
|
# @option params [required, String] :policy_name
|
5783
6761
|
# The name of the policy.
|
5784
6762
|
#
|
@@ -5817,6 +6795,12 @@ module Aws::IoT
|
|
5817
6795
|
|
5818
6796
|
# Gets information about the specified policy version.
|
5819
6797
|
#
|
6798
|
+
# Requires permission to access the [GetPolicyVersion][1] action.
|
6799
|
+
#
|
6800
|
+
#
|
6801
|
+
#
|
6802
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6803
|
+
#
|
5820
6804
|
# @option params [required, String] :policy_name
|
5821
6805
|
# The name of the policy.
|
5822
6806
|
#
|
@@ -5859,8 +6843,13 @@ module Aws::IoT
|
|
5859
6843
|
req.send_request(options)
|
5860
6844
|
end
|
5861
6845
|
|
5862
|
-
# Gets a registration code used to register a CA certificate with
|
5863
|
-
#
|
6846
|
+
# Gets a registration code used to register a CA certificate with IoT.
|
6847
|
+
#
|
6848
|
+
# Requires permission to access the [GetRegistrationCode][1] action.
|
6849
|
+
#
|
6850
|
+
#
|
6851
|
+
#
|
6852
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
5864
6853
|
#
|
5865
6854
|
# @return [Types::GetRegistrationCodeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5866
6855
|
#
|
@@ -5882,12 +6871,19 @@ module Aws::IoT
|
|
5882
6871
|
# If the aggregation field is of type `String`, only the count statistic
|
5883
6872
|
# is returned.
|
5884
6873
|
#
|
6874
|
+
# Requires permission to access the [GetStatistics][1] action.
|
6875
|
+
#
|
6876
|
+
#
|
6877
|
+
#
|
6878
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6879
|
+
#
|
5885
6880
|
# @option params [String] :index_name
|
5886
6881
|
# The name of the index to search. The default value is `AWS_Things`.
|
5887
6882
|
#
|
5888
6883
|
# @option params [required, String] :query_string
|
5889
6884
|
# The query used to search. You can specify "*" for the query string
|
5890
|
-
# to get the count of all indexed things in your
|
6885
|
+
# to get the count of all indexed things in your Amazon Web Services
|
6886
|
+
# account.
|
5891
6887
|
#
|
5892
6888
|
# @option params [String] :aggregation_field
|
5893
6889
|
# The aggregation field name.
|
@@ -5928,6 +6924,12 @@ module Aws::IoT
|
|
5928
6924
|
|
5929
6925
|
# Gets information about the rule.
|
5930
6926
|
#
|
6927
|
+
# Requires permission to access the [GetTopicRule][1] action.
|
6928
|
+
#
|
6929
|
+
#
|
6930
|
+
#
|
6931
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
6932
|
+
#
|
5931
6933
|
# @option params [required, String] :rule_name
|
5932
6934
|
# The name of the rule.
|
5933
6935
|
#
|
@@ -6049,6 +7051,11 @@ module Aws::IoT
|
|
6049
7051
|
# resp.rule.actions[0].kafka.partition #=> String
|
6050
7052
|
# resp.rule.actions[0].kafka.client_properties #=> Hash
|
6051
7053
|
# resp.rule.actions[0].kafka.client_properties["String"] #=> String
|
7054
|
+
# resp.rule.actions[0].open_search.role_arn #=> String
|
7055
|
+
# resp.rule.actions[0].open_search.endpoint #=> String
|
7056
|
+
# resp.rule.actions[0].open_search.index #=> String
|
7057
|
+
# resp.rule.actions[0].open_search.type #=> String
|
7058
|
+
# resp.rule.actions[0].open_search.id #=> String
|
6052
7059
|
# resp.rule.rule_disabled #=> Boolean
|
6053
7060
|
# resp.rule.aws_iot_sql_version #=> String
|
6054
7061
|
# resp.rule.error_action.dynamo_db.table_name #=> String
|
@@ -6150,6 +7157,11 @@ module Aws::IoT
|
|
6150
7157
|
# resp.rule.error_action.kafka.partition #=> String
|
6151
7158
|
# resp.rule.error_action.kafka.client_properties #=> Hash
|
6152
7159
|
# resp.rule.error_action.kafka.client_properties["String"] #=> String
|
7160
|
+
# resp.rule.error_action.open_search.role_arn #=> String
|
7161
|
+
# resp.rule.error_action.open_search.endpoint #=> String
|
7162
|
+
# resp.rule.error_action.open_search.index #=> String
|
7163
|
+
# resp.rule.error_action.open_search.type #=> String
|
7164
|
+
# resp.rule.error_action.open_search.id #=> String
|
6153
7165
|
#
|
6154
7166
|
# @overload get_topic_rule(params = {})
|
6155
7167
|
# @param [Hash] params ({})
|
@@ -6160,6 +7172,12 @@ module Aws::IoT
|
|
6160
7172
|
|
6161
7173
|
# Gets information about a topic rule destination.
|
6162
7174
|
#
|
7175
|
+
# Requires permission to access the [GetTopicRuleDestination][1] action.
|
7176
|
+
#
|
7177
|
+
#
|
7178
|
+
#
|
7179
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7180
|
+
#
|
6163
7181
|
# @option params [required, String] :arn
|
6164
7182
|
# The ARN of the topic rule destination.
|
6165
7183
|
#
|
@@ -6197,6 +7215,12 @@ module Aws::IoT
|
|
6197
7215
|
|
6198
7216
|
# Gets the fine grained logging options.
|
6199
7217
|
#
|
7218
|
+
# Requires permission to access the [GetV2LoggingOptions][1] action.
|
7219
|
+
#
|
7220
|
+
#
|
7221
|
+
#
|
7222
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7223
|
+
#
|
6200
7224
|
# @return [Types::GetV2LoggingOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6201
7225
|
#
|
6202
7226
|
# * {Types::GetV2LoggingOptionsResponse#role_arn #role_arn} => String
|
@@ -6219,6 +7243,12 @@ module Aws::IoT
|
|
6219
7243
|
# Lists the active violations for a given Device Defender security
|
6220
7244
|
# profile.
|
6221
7245
|
#
|
7246
|
+
# Requires permission to access the [ListActiveViolations][1] action.
|
7247
|
+
#
|
7248
|
+
#
|
7249
|
+
#
|
7250
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7251
|
+
#
|
6222
7252
|
# @option params [String] :thing_name
|
6223
7253
|
# The name of the thing whose active violations are listed.
|
6224
7254
|
#
|
@@ -6232,6 +7262,9 @@ module Aws::IoT
|
|
6232
7262
|
# @option params [Boolean] :list_suppressed_alerts
|
6233
7263
|
# A list of all suppressed alerts.
|
6234
7264
|
#
|
7265
|
+
# @option params [String] :verification_state
|
7266
|
+
# The verification state of the violation (detect alarm).
|
7267
|
+
#
|
6235
7268
|
# @option params [String] :next_token
|
6236
7269
|
# The token for the next set of results.
|
6237
7270
|
#
|
@@ -6252,6 +7285,7 @@ module Aws::IoT
|
|
6252
7285
|
# security_profile_name: "SecurityProfileName",
|
6253
7286
|
# behavior_criteria_type: "STATIC", # accepts STATIC, STATISTICAL, MACHINE_LEARNING
|
6254
7287
|
# list_suppressed_alerts: false,
|
7288
|
+
# verification_state: "FALSE_POSITIVE", # accepts FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN
|
6255
7289
|
# next_token: "NextToken",
|
6256
7290
|
# max_results: 1,
|
6257
7291
|
# })
|
@@ -6294,6 +7328,8 @@ module Aws::IoT
|
|
6294
7328
|
# resp.active_violations[0].last_violation_value.strings #=> Array
|
6295
7329
|
# resp.active_violations[0].last_violation_value.strings[0] #=> String
|
6296
7330
|
# resp.active_violations[0].violation_event_additional_info.confidence_level #=> String, one of "LOW", "MEDIUM", "HIGH"
|
7331
|
+
# resp.active_violations[0].verification_state #=> String, one of "FALSE_POSITIVE", "BENIGN_POSITIVE", "TRUE_POSITIVE", "UNKNOWN"
|
7332
|
+
# resp.active_violations[0].verification_state_description #=> String
|
6297
7333
|
# resp.active_violations[0].last_violation_time #=> Time
|
6298
7334
|
# resp.active_violations[0].violation_start_time #=> Time
|
6299
7335
|
# resp.next_token #=> String
|
@@ -6307,6 +7343,12 @@ module Aws::IoT
|
|
6307
7343
|
|
6308
7344
|
# Lists the policies attached to the specified thing group.
|
6309
7345
|
#
|
7346
|
+
# Requires permission to access the [ListAttachedPolicies][1] action.
|
7347
|
+
#
|
7348
|
+
#
|
7349
|
+
#
|
7350
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7351
|
+
#
|
6310
7352
|
# @option params [required, String] :target
|
6311
7353
|
# The group or principal for which the policies will be listed. Valid
|
6312
7354
|
# principals are CertificateArn
|
@@ -6358,6 +7400,12 @@ module Aws::IoT
|
|
6358
7400
|
# audits performed during a specified time period. (Findings are
|
6359
7401
|
# retained for 90 days.)
|
6360
7402
|
#
|
7403
|
+
# Requires permission to access the [ListAuditFindings][1] action.
|
7404
|
+
#
|
7405
|
+
#
|
7406
|
+
#
|
7407
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7408
|
+
#
|
6361
7409
|
# @option params [String] :task_id
|
6362
7410
|
# A filter to limit results to the audit with the specified ID. You must
|
6363
7411
|
# specify either the taskId or the startTime and endTime, but not both.
|
@@ -6472,6 +7520,13 @@ module Aws::IoT
|
|
6472
7520
|
|
6473
7521
|
# Gets the status of audit mitigation action tasks that were executed.
|
6474
7522
|
#
|
7523
|
+
# Requires permission to access the
|
7524
|
+
# [ListAuditMitigationActionsExecutions][1] action.
|
7525
|
+
#
|
7526
|
+
#
|
7527
|
+
#
|
7528
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7529
|
+
#
|
6475
7530
|
# @option params [required, String] :task_id
|
6476
7531
|
# Specify this filter to limit results to actions for a specific audit
|
6477
7532
|
# mitigation actions task.
|
@@ -6531,6 +7586,13 @@ module Aws::IoT
|
|
6531
7586
|
# Gets a list of audit mitigation action tasks that match the specified
|
6532
7587
|
# filters.
|
6533
7588
|
#
|
7589
|
+
# Requires permission to access the [ListAuditMitigationActionsTasks][1]
|
7590
|
+
# action.
|
7591
|
+
#
|
7592
|
+
#
|
7593
|
+
#
|
7594
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7595
|
+
#
|
6534
7596
|
# @option params [String] :audit_task_id
|
6535
7597
|
# Specify this filter to limit results to tasks that were applied to
|
6536
7598
|
# results for a specific audit.
|
@@ -6594,6 +7656,12 @@ module Aws::IoT
|
|
6594
7656
|
|
6595
7657
|
# Lists your Device Defender audit listings.
|
6596
7658
|
#
|
7659
|
+
# Requires permission to access the [ListAuditSuppressions][1] action.
|
7660
|
+
#
|
7661
|
+
#
|
7662
|
+
#
|
7663
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7664
|
+
#
|
6597
7665
|
# @option params [String] :check_name
|
6598
7666
|
# An audit check name. Checks must be enabled for your account. (Use
|
6599
7667
|
# `DescribeAccountAuditConfiguration` to see the list of all checks,
|
@@ -6672,6 +7740,12 @@ module Aws::IoT
|
|
6672
7740
|
# Lists the Device Defender audits that have been performed during a
|
6673
7741
|
# given time period.
|
6674
7742
|
#
|
7743
|
+
# Requires permission to access the [ListAuditTasks][1] action.
|
7744
|
+
#
|
7745
|
+
#
|
7746
|
+
#
|
7747
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7748
|
+
#
|
6675
7749
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
6676
7750
|
# The beginning of the time period. Audit information is retained for a
|
6677
7751
|
# limited time (90 days). Requesting a start time prior to what is
|
@@ -6731,6 +7805,12 @@ module Aws::IoT
|
|
6731
7805
|
|
6732
7806
|
# Lists the authorizers registered in your account.
|
6733
7807
|
#
|
7808
|
+
# Requires permission to access the [ListAuthorizers][1] action.
|
7809
|
+
#
|
7810
|
+
#
|
7811
|
+
#
|
7812
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7813
|
+
#
|
6734
7814
|
# @option params [Integer] :page_size
|
6735
7815
|
# The maximum number of results to return at one time.
|
6736
7816
|
#
|
@@ -6775,6 +7855,12 @@ module Aws::IoT
|
|
6775
7855
|
|
6776
7856
|
# Lists the billing groups you have created.
|
6777
7857
|
#
|
7858
|
+
# Requires permission to access the [ListBillingGroups][1] action.
|
7859
|
+
#
|
7860
|
+
#
|
7861
|
+
#
|
7862
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7863
|
+
#
|
6778
7864
|
# @option params [String] :next_token
|
6779
7865
|
# To retrieve the next set of results, the `nextToken` value from a
|
6780
7866
|
# previous response; otherwise **null** to receive the first set of
|
@@ -6815,11 +7901,18 @@ module Aws::IoT
|
|
6815
7901
|
req.send_request(options)
|
6816
7902
|
end
|
6817
7903
|
|
6818
|
-
# Lists the CA certificates registered for your
|
7904
|
+
# Lists the CA certificates registered for your Amazon Web Services
|
7905
|
+
# account.
|
6819
7906
|
#
|
6820
7907
|
# The results are paginated with a default page size of 25. You can use
|
6821
7908
|
# the returned marker to retrieve additional results.
|
6822
7909
|
#
|
7910
|
+
# Requires permission to access the [ListCACertificates][1] action.
|
7911
|
+
#
|
7912
|
+
#
|
7913
|
+
#
|
7914
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7915
|
+
#
|
6823
7916
|
# @option params [Integer] :page_size
|
6824
7917
|
# The result page size.
|
6825
7918
|
#
|
@@ -6860,11 +7953,17 @@ module Aws::IoT
|
|
6860
7953
|
req.send_request(options)
|
6861
7954
|
end
|
6862
7955
|
|
6863
|
-
# Lists the certificates registered in your
|
7956
|
+
# Lists the certificates registered in your Amazon Web Services account.
|
6864
7957
|
#
|
6865
7958
|
# The results are paginated with a default page size of 25. You can use
|
6866
7959
|
# the returned marker to retrieve additional results.
|
6867
7960
|
#
|
7961
|
+
# Requires permission to access the [ListCertificates][1] action.
|
7962
|
+
#
|
7963
|
+
#
|
7964
|
+
#
|
7965
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7966
|
+
#
|
6868
7967
|
# @option params [Integer] :page_size
|
6869
7968
|
# The result page size.
|
6870
7969
|
#
|
@@ -6909,6 +8008,12 @@ module Aws::IoT
|
|
6909
8008
|
|
6910
8009
|
# List the device certificates signed by the specified CA certificate.
|
6911
8010
|
#
|
8011
|
+
# Requires permission to access the [ListCertificatesByCA][1] action.
|
8012
|
+
#
|
8013
|
+
#
|
8014
|
+
#
|
8015
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8016
|
+
#
|
6912
8017
|
# @option params [required, String] :ca_certificate_id
|
6913
8018
|
# The ID of the CA certificate. This operation will list all registered
|
6914
8019
|
# device certificate that were signed by this CA certificate.
|
@@ -6958,6 +8063,12 @@ module Aws::IoT
|
|
6958
8063
|
|
6959
8064
|
# Lists your Device Defender detect custom metrics.
|
6960
8065
|
#
|
8066
|
+
# Requires permission to access the [ListCustomMetrics][1] action.
|
8067
|
+
#
|
8068
|
+
#
|
8069
|
+
#
|
8070
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8071
|
+
#
|
6961
8072
|
# @option params [String] :next_token
|
6962
8073
|
# The token for the next set of results.
|
6963
8074
|
#
|
@@ -6995,6 +8106,13 @@ module Aws::IoT
|
|
6995
8106
|
# Lists mitigation actions executions for a Device Defender ML Detect
|
6996
8107
|
# Security Profile.
|
6997
8108
|
#
|
8109
|
+
# Requires permission to access the
|
8110
|
+
# [ListDetectMitigationActionsExecutions][1] action.
|
8111
|
+
#
|
8112
|
+
#
|
8113
|
+
#
|
8114
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8115
|
+
#
|
6998
8116
|
# @option params [String] :task_id
|
6999
8117
|
# The unique identifier of the task.
|
7000
8118
|
#
|
@@ -7062,6 +8180,13 @@ module Aws::IoT
|
|
7062
8180
|
|
7063
8181
|
# List of Device Defender ML Detect mitigation actions tasks.
|
7064
8182
|
#
|
8183
|
+
# Requires permission to access the
|
8184
|
+
# [ListDetectMitigationActionsTasks][1] action.
|
8185
|
+
#
|
8186
|
+
#
|
8187
|
+
#
|
8188
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8189
|
+
#
|
7065
8190
|
# @option params [Integer] :max_results
|
7066
8191
|
# The maximum number of results to return at one time. The default is
|
7067
8192
|
# 25.
|
@@ -7134,7 +8259,14 @@ module Aws::IoT
|
|
7134
8259
|
req.send_request(options)
|
7135
8260
|
end
|
7136
8261
|
|
7137
|
-
# List the set of dimensions that are defined for your
|
8262
|
+
# List the set of dimensions that are defined for your Amazon Web
|
8263
|
+
# Services accounts.
|
8264
|
+
#
|
8265
|
+
# Requires permission to access the [ListDimensions][1] action.
|
8266
|
+
#
|
8267
|
+
#
|
8268
|
+
#
|
8269
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7138
8270
|
#
|
7139
8271
|
# @option params [String] :next_token
|
7140
8272
|
# The token for the next set of results.
|
@@ -7172,6 +8304,13 @@ module Aws::IoT
|
|
7172
8304
|
# Gets a list of domain configurations for the user. This list is sorted
|
7173
8305
|
# alphabetically by domain configuration name.
|
7174
8306
|
#
|
8307
|
+
# Requires permission to access the [ListDomainConfigurations][1]
|
8308
|
+
# action.
|
8309
|
+
#
|
8310
|
+
#
|
8311
|
+
#
|
8312
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8313
|
+
#
|
7175
8314
|
# @option params [String] :marker
|
7176
8315
|
# The marker for the next set of results.
|
7177
8316
|
#
|
@@ -7211,8 +8350,58 @@ module Aws::IoT
|
|
7211
8350
|
req.send_request(options)
|
7212
8351
|
end
|
7213
8352
|
|
8353
|
+
# Lists all your fleet metrics.
|
8354
|
+
#
|
8355
|
+
# Requires permission to access the [ListFleetMetrics][1] action.
|
8356
|
+
#
|
8357
|
+
#
|
8358
|
+
#
|
8359
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8360
|
+
#
|
8361
|
+
# @option params [String] :next_token
|
8362
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
8363
|
+
# previous response; otherwise `null` to receive the first set of
|
8364
|
+
# results.
|
8365
|
+
#
|
8366
|
+
# @option params [Integer] :max_results
|
8367
|
+
# The maximum number of results to return in this operation.
|
8368
|
+
#
|
8369
|
+
# @return [Types::ListFleetMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8370
|
+
#
|
8371
|
+
# * {Types::ListFleetMetricsResponse#fleet_metrics #fleet_metrics} => Array<Types::FleetMetricNameAndArn>
|
8372
|
+
# * {Types::ListFleetMetricsResponse#next_token #next_token} => String
|
8373
|
+
#
|
8374
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8375
|
+
#
|
8376
|
+
# @example Request syntax with placeholder values
|
8377
|
+
#
|
8378
|
+
# resp = client.list_fleet_metrics({
|
8379
|
+
# next_token: "NextToken",
|
8380
|
+
# max_results: 1,
|
8381
|
+
# })
|
8382
|
+
#
|
8383
|
+
# @example Response structure
|
8384
|
+
#
|
8385
|
+
# resp.fleet_metrics #=> Array
|
8386
|
+
# resp.fleet_metrics[0].metric_name #=> String
|
8387
|
+
# resp.fleet_metrics[0].metric_arn #=> String
|
8388
|
+
# resp.next_token #=> String
|
8389
|
+
#
|
8390
|
+
# @overload list_fleet_metrics(params = {})
|
8391
|
+
# @param [Hash] params ({})
|
8392
|
+
def list_fleet_metrics(params = {}, options = {})
|
8393
|
+
req = build_request(:list_fleet_metrics, params)
|
8394
|
+
req.send_request(options)
|
8395
|
+
end
|
8396
|
+
|
7214
8397
|
# Lists the search indices.
|
7215
8398
|
#
|
8399
|
+
# Requires permission to access the [ListIndices][1] action.
|
8400
|
+
#
|
8401
|
+
#
|
8402
|
+
#
|
8403
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8404
|
+
#
|
7216
8405
|
# @option params [String] :next_token
|
7217
8406
|
# The token used to get the next set of results, or `null` if there are
|
7218
8407
|
# no additional results.
|
@@ -7249,6 +8438,12 @@ module Aws::IoT
|
|
7249
8438
|
|
7250
8439
|
# Lists the job executions for a job.
|
7251
8440
|
#
|
8441
|
+
# Requires permission to access the [ListJobExecutionsForJob][1] action.
|
8442
|
+
#
|
8443
|
+
#
|
8444
|
+
#
|
8445
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8446
|
+
#
|
7252
8447
|
# @option params [required, String] :job_id
|
7253
8448
|
# The unique identifier you assigned to this job when it was created.
|
7254
8449
|
#
|
@@ -7297,6 +8492,13 @@ module Aws::IoT
|
|
7297
8492
|
|
7298
8493
|
# Lists the job executions for the specified thing.
|
7299
8494
|
#
|
8495
|
+
# Requires permission to access the [ListJobExecutionsForThing][1]
|
8496
|
+
# action.
|
8497
|
+
#
|
8498
|
+
#
|
8499
|
+
#
|
8500
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8501
|
+
#
|
7300
8502
|
# @option params [required, String] :thing_name
|
7301
8503
|
# The thing name.
|
7302
8504
|
#
|
@@ -7307,9 +8509,9 @@ module Aws::IoT
|
|
7307
8509
|
# @option params [String] :namespace_id
|
7308
8510
|
# The namespace used to indicate that a job is a customer-managed job.
|
7309
8511
|
#
|
7310
|
-
# When you specify a value for this parameter,
|
7311
|
-
# notifications to MQTT topics that contain the value in
|
7312
|
-
# format.
|
8512
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
8513
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
8514
|
+
# the following format.
|
7313
8515
|
#
|
7314
8516
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
7315
8517
|
#
|
@@ -7360,6 +8562,12 @@ module Aws::IoT
|
|
7360
8562
|
|
7361
8563
|
# Returns a list of job templates.
|
7362
8564
|
#
|
8565
|
+
# Requires permission to access the [ListJobTemplates][1] action.
|
8566
|
+
#
|
8567
|
+
#
|
8568
|
+
#
|
8569
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8570
|
+
#
|
7363
8571
|
# @option params [Integer] :max_results
|
7364
8572
|
# The maximum number of results to return in the list.
|
7365
8573
|
#
|
@@ -7371,6 +8579,8 @@ module Aws::IoT
|
|
7371
8579
|
# * {Types::ListJobTemplatesResponse#job_templates #job_templates} => Array<Types::JobTemplateSummary>
|
7372
8580
|
# * {Types::ListJobTemplatesResponse#next_token #next_token} => String
|
7373
8581
|
#
|
8582
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8583
|
+
#
|
7374
8584
|
# @example Request syntax with placeholder values
|
7375
8585
|
#
|
7376
8586
|
# resp = client.list_job_templates({
|
@@ -7396,6 +8606,12 @@ module Aws::IoT
|
|
7396
8606
|
|
7397
8607
|
# Lists jobs.
|
7398
8608
|
#
|
8609
|
+
# Requires permission to access the [ListJobs][1] action.
|
8610
|
+
#
|
8611
|
+
#
|
8612
|
+
#
|
8613
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8614
|
+
#
|
7399
8615
|
# @option params [String] :status
|
7400
8616
|
# An optional filter that lets you search for jobs that have the
|
7401
8617
|
# specified status.
|
@@ -7425,9 +8641,9 @@ module Aws::IoT
|
|
7425
8641
|
# @option params [String] :namespace_id
|
7426
8642
|
# The namespace used to indicate that a job is a customer-managed job.
|
7427
8643
|
#
|
7428
|
-
# When you specify a value for this parameter,
|
7429
|
-
# notifications to MQTT topics that contain the value in
|
7430
|
-
# format.
|
8644
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
8645
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
8646
|
+
# the following format.
|
7431
8647
|
#
|
7432
8648
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
7433
8649
|
#
|
@@ -7477,6 +8693,12 @@ module Aws::IoT
|
|
7477
8693
|
# Gets a list of all mitigation actions that match the specified filter
|
7478
8694
|
# criteria.
|
7479
8695
|
#
|
8696
|
+
# Requires permission to access the [ListMitigationActions][1] action.
|
8697
|
+
#
|
8698
|
+
#
|
8699
|
+
#
|
8700
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8701
|
+
#
|
7480
8702
|
# @option params [String] :action_type
|
7481
8703
|
# Specify a value to limit the result to mitigation actions with a
|
7482
8704
|
# specific action type.
|
@@ -7520,6 +8742,12 @@ module Aws::IoT
|
|
7520
8742
|
|
7521
8743
|
# Lists OTA updates.
|
7522
8744
|
#
|
8745
|
+
# Requires permission to access the [ListOTAUpdates][1] action.
|
8746
|
+
#
|
8747
|
+
#
|
8748
|
+
#
|
8749
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8750
|
+
#
|
7523
8751
|
# @option params [Integer] :max_results
|
7524
8752
|
# The maximum number of results to return at one time.
|
7525
8753
|
#
|
@@ -7561,6 +8789,13 @@ module Aws::IoT
|
|
7561
8789
|
|
7562
8790
|
# Lists certificates that are being transferred but not yet accepted.
|
7563
8791
|
#
|
8792
|
+
# Requires permission to access the [ListOutgoingCertificates][1]
|
8793
|
+
# action.
|
8794
|
+
#
|
8795
|
+
#
|
8796
|
+
#
|
8797
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8798
|
+
#
|
7564
8799
|
# @option params [Integer] :page_size
|
7565
8800
|
# The result page size.
|
7566
8801
|
#
|
@@ -7606,6 +8841,12 @@ module Aws::IoT
|
|
7606
8841
|
|
7607
8842
|
# Lists your policies.
|
7608
8843
|
#
|
8844
|
+
# Requires permission to access the [ListPolicies][1] action.
|
8845
|
+
#
|
8846
|
+
#
|
8847
|
+
#
|
8848
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8849
|
+
#
|
7609
8850
|
# @option params [String] :marker
|
7610
8851
|
# The marker for the next set of results.
|
7611
8852
|
#
|
@@ -7647,9 +8888,15 @@ module Aws::IoT
|
|
7647
8888
|
|
7648
8889
|
# Lists the principals associated with the specified policy.
|
7649
8890
|
#
|
7650
|
-
# **Note:** This
|
8891
|
+
# **Note:** This action is deprecated. Please use ListTargetsForPolicy
|
7651
8892
|
# instead.
|
7652
8893
|
#
|
8894
|
+
# Requires permission to access the [ListPolicyPrincipals][1] action.
|
8895
|
+
#
|
8896
|
+
#
|
8897
|
+
#
|
8898
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8899
|
+
#
|
7653
8900
|
# @option params [required, String] :policy_name
|
7654
8901
|
# The policy name.
|
7655
8902
|
#
|
@@ -7695,6 +8942,12 @@ module Aws::IoT
|
|
7695
8942
|
# Lists the versions of the specified policy and identifies the default
|
7696
8943
|
# version.
|
7697
8944
|
#
|
8945
|
+
# Requires permission to access the [ListPolicyVersions][1] action.
|
8946
|
+
#
|
8947
|
+
#
|
8948
|
+
#
|
8949
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8950
|
+
#
|
7698
8951
|
# @option params [required, String] :policy_name
|
7699
8952
|
# The policy name.
|
7700
8953
|
#
|
@@ -7726,12 +8979,15 @@ module Aws::IoT
|
|
7726
8979
|
# Cognito identity, the ID must be in [AmazonCognito Identity
|
7727
8980
|
# format][1].
|
7728
8981
|
#
|
7729
|
-
# **Note:** This
|
8982
|
+
# **Note:** This action is deprecated. Please use ListAttachedPolicies
|
7730
8983
|
# instead.
|
7731
8984
|
#
|
8985
|
+
# Requires permission to access the [ListPrincipalPolicies][2] action.
|
8986
|
+
#
|
7732
8987
|
#
|
7733
8988
|
#
|
7734
8989
|
# [1]: https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html#API_GetCredentialsForIdentity_RequestSyntax
|
8990
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7735
8991
|
#
|
7736
8992
|
# @option params [required, String] :principal
|
7737
8993
|
# The principal. Valid principals are CertificateArn
|
@@ -7784,6 +9040,12 @@ module Aws::IoT
|
|
7784
9040
|
# can be X.509 certificates, IAM users, groups, and roles, Amazon
|
7785
9041
|
# Cognito identities or federated identities.
|
7786
9042
|
#
|
9043
|
+
# Requires permission to access the [ListPrincipalThings][1] action.
|
9044
|
+
#
|
9045
|
+
#
|
9046
|
+
#
|
9047
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9048
|
+
#
|
7787
9049
|
# @option params [String] :next_token
|
7788
9050
|
# To retrieve the next set of results, the `nextToken` value from a
|
7789
9051
|
# previous response; otherwise **null** to receive the first set of
|
@@ -7825,6 +9087,13 @@ module Aws::IoT
|
|
7825
9087
|
|
7826
9088
|
# A list of fleet provisioning template versions.
|
7827
9089
|
#
|
9090
|
+
# Requires permission to access the
|
9091
|
+
# [ListProvisioningTemplateVersions][1] action.
|
9092
|
+
#
|
9093
|
+
#
|
9094
|
+
#
|
9095
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9096
|
+
#
|
7828
9097
|
# @option params [required, String] :template_name
|
7829
9098
|
# The name of the fleet provisioning template.
|
7830
9099
|
#
|
@@ -7864,7 +9133,15 @@ module Aws::IoT
|
|
7864
9133
|
req.send_request(options)
|
7865
9134
|
end
|
7866
9135
|
|
7867
|
-
# Lists the fleet provisioning templates in your
|
9136
|
+
# Lists the fleet provisioning templates in your Amazon Web Services
|
9137
|
+
# account.
|
9138
|
+
#
|
9139
|
+
# Requires permission to access the [ListProvisioningTemplates][1]
|
9140
|
+
# action.
|
9141
|
+
#
|
9142
|
+
#
|
9143
|
+
#
|
9144
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7868
9145
|
#
|
7869
9146
|
# @option params [Integer] :max_results
|
7870
9147
|
# The maximum number of results to return at one time.
|
@@ -7906,6 +9183,12 @@ module Aws::IoT
|
|
7906
9183
|
|
7907
9184
|
# Lists the role aliases registered in your account.
|
7908
9185
|
#
|
9186
|
+
# Requires permission to access the [ListRoleAliases][1] action.
|
9187
|
+
#
|
9188
|
+
#
|
9189
|
+
#
|
9190
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9191
|
+
#
|
7909
9192
|
# @option params [Integer] :page_size
|
7910
9193
|
# The maximum number of results to return at one time.
|
7911
9194
|
#
|
@@ -7945,6 +9228,12 @@ module Aws::IoT
|
|
7945
9228
|
|
7946
9229
|
# Lists all of your scheduled audits.
|
7947
9230
|
#
|
9231
|
+
# Requires permission to access the [ListScheduledAudits][1] action.
|
9232
|
+
#
|
9233
|
+
#
|
9234
|
+
#
|
9235
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9236
|
+
#
|
7948
9237
|
# @option params [String] :next_token
|
7949
9238
|
# The token for the next set of results.
|
7950
9239
|
#
|
@@ -7986,10 +9275,16 @@ module Aws::IoT
|
|
7986
9275
|
# Lists the Device Defender security profiles you've created. You can
|
7987
9276
|
# filter security profiles by dimension or custom metric.
|
7988
9277
|
#
|
9278
|
+
# Requires permission to access the [ListSecurityProfiles][1] action.
|
9279
|
+
#
|
7989
9280
|
# <note markdown="1"> `dimensionName` and `metricName` cannot be used in the same request.
|
7990
9281
|
#
|
7991
9282
|
# </note>
|
7992
9283
|
#
|
9284
|
+
#
|
9285
|
+
#
|
9286
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9287
|
+
#
|
7993
9288
|
# @option params [String] :next_token
|
7994
9289
|
# The token for the next set of results.
|
7995
9290
|
#
|
@@ -8036,6 +9331,13 @@ module Aws::IoT
|
|
8036
9331
|
# Lists the Device Defender security profiles attached to a target
|
8037
9332
|
# (thing group).
|
8038
9333
|
#
|
9334
|
+
# Requires permission to access the [ListSecurityProfilesForTarget][1]
|
9335
|
+
# action.
|
9336
|
+
#
|
9337
|
+
#
|
9338
|
+
#
|
9339
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9340
|
+
#
|
8039
9341
|
# @option params [String] :next_token
|
8040
9342
|
# The token for the next set of results.
|
8041
9343
|
#
|
@@ -8080,7 +9382,13 @@ module Aws::IoT
|
|
8080
9382
|
req.send_request(options)
|
8081
9383
|
end
|
8082
9384
|
|
8083
|
-
# Lists all of the streams in your
|
9385
|
+
# Lists all of the streams in your Amazon Web Services account.
|
9386
|
+
#
|
9387
|
+
# Requires permission to access the [ListStreams][1] action.
|
9388
|
+
#
|
9389
|
+
#
|
9390
|
+
#
|
9391
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8084
9392
|
#
|
8085
9393
|
# @option params [Integer] :max_results
|
8086
9394
|
# The maximum number of results to return at a time.
|
@@ -8124,6 +9432,12 @@ module Aws::IoT
|
|
8124
9432
|
|
8125
9433
|
# Lists the tags (metadata) you have assigned to the resource.
|
8126
9434
|
#
|
9435
|
+
# Requires permission to access the [ListTagsForResource][1] action.
|
9436
|
+
#
|
9437
|
+
#
|
9438
|
+
#
|
9439
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9440
|
+
#
|
8127
9441
|
# @option params [required, String] :resource_arn
|
8128
9442
|
# The ARN of the resource.
|
8129
9443
|
#
|
@@ -8162,6 +9476,12 @@ module Aws::IoT
|
|
8162
9476
|
|
8163
9477
|
# List targets for the specified policy.
|
8164
9478
|
#
|
9479
|
+
# Requires permission to access the [ListTargetsForPolicy][1] action.
|
9480
|
+
#
|
9481
|
+
#
|
9482
|
+
#
|
9483
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9484
|
+
#
|
8165
9485
|
# @option params [required, String] :policy_name
|
8166
9486
|
# The policy name.
|
8167
9487
|
#
|
@@ -8202,6 +9522,13 @@ module Aws::IoT
|
|
8202
9522
|
# Lists the targets (thing groups) associated with a given Device
|
8203
9523
|
# Defender security profile.
|
8204
9524
|
#
|
9525
|
+
# Requires permission to access the [ListTargetsForSecurityProfile][1]
|
9526
|
+
# action.
|
9527
|
+
#
|
9528
|
+
#
|
9529
|
+
#
|
9530
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9531
|
+
#
|
8205
9532
|
# @option params [required, String] :security_profile_name
|
8206
9533
|
# The security profile.
|
8207
9534
|
#
|
@@ -8241,6 +9568,12 @@ module Aws::IoT
|
|
8241
9568
|
|
8242
9569
|
# List the thing groups in your account.
|
8243
9570
|
#
|
9571
|
+
# Requires permission to access the [ListThingGroups][1] action.
|
9572
|
+
#
|
9573
|
+
#
|
9574
|
+
#
|
9575
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9576
|
+
#
|
8244
9577
|
# @option params [String] :next_token
|
8245
9578
|
# To retrieve the next set of results, the `nextToken` value from a
|
8246
9579
|
# previous response; otherwise **null** to receive the first set of
|
@@ -8293,6 +9626,12 @@ module Aws::IoT
|
|
8293
9626
|
|
8294
9627
|
# List the thing groups to which the specified thing belongs.
|
8295
9628
|
#
|
9629
|
+
# Requires permission to access the [ListThingGroupsForThing][1] action.
|
9630
|
+
#
|
9631
|
+
#
|
9632
|
+
#
|
9633
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9634
|
+
#
|
8296
9635
|
# @option params [required, String] :thing_name
|
8297
9636
|
# The thing name.
|
8298
9637
|
#
|
@@ -8337,6 +9676,12 @@ module Aws::IoT
|
|
8337
9676
|
# can be X.509 certificates, IAM users, groups, and roles, Amazon
|
8338
9677
|
# Cognito identities or federated identities.
|
8339
9678
|
#
|
9679
|
+
# Requires permission to access the [ListThingPrincipals][1] action.
|
9680
|
+
#
|
9681
|
+
#
|
9682
|
+
#
|
9683
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9684
|
+
#
|
8340
9685
|
# @option params [String] :next_token
|
8341
9686
|
# To retrieve the next set of results, the `nextToken` value from a
|
8342
9687
|
# previous response; otherwise **null** to receive the first set of
|
@@ -8425,6 +9770,13 @@ module Aws::IoT
|
|
8425
9770
|
|
8426
9771
|
# List bulk thing provisioning tasks.
|
8427
9772
|
#
|
9773
|
+
# Requires permission to access the [ListThingRegistrationTasks][1]
|
9774
|
+
# action.
|
9775
|
+
#
|
9776
|
+
#
|
9777
|
+
#
|
9778
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9779
|
+
#
|
8428
9780
|
# @option params [String] :next_token
|
8429
9781
|
# To retrieve the next set of results, the `nextToken` value from a
|
8430
9782
|
# previous response; otherwise **null** to receive the first set of
|
@@ -8466,6 +9818,12 @@ module Aws::IoT
|
|
8466
9818
|
|
8467
9819
|
# Lists the existing thing types.
|
8468
9820
|
#
|
9821
|
+
# Requires permission to access the [ListThingTypes][1] action.
|
9822
|
+
#
|
9823
|
+
#
|
9824
|
+
#
|
9825
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9826
|
+
#
|
8469
9827
|
# @option params [String] :next_token
|
8470
9828
|
# To retrieve the next set of results, the `nextToken` value from a
|
8471
9829
|
# previous response; otherwise **null** to receive the first set of
|
@@ -8518,6 +9876,8 @@ module Aws::IoT
|
|
8518
9876
|
# in the registry that contain an attribute **Color** with the value
|
8519
9877
|
# **Red**.
|
8520
9878
|
#
|
9879
|
+
# Requires permission to access the [ListThings][1] action.
|
9880
|
+
#
|
8521
9881
|
# <note markdown="1"> You will not be charged for calling this API if an `Access denied`
|
8522
9882
|
# error is returned. You will also not be charged if no attributes or
|
8523
9883
|
# pagination token was provided in request and no pagination token and
|
@@ -8525,6 +9885,10 @@ module Aws::IoT
|
|
8525
9885
|
#
|
8526
9886
|
# </note>
|
8527
9887
|
#
|
9888
|
+
#
|
9889
|
+
#
|
9890
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9891
|
+
#
|
8528
9892
|
# @option params [String] :next_token
|
8529
9893
|
# To retrieve the next set of results, the `nextToken` value from a
|
8530
9894
|
# previous response; otherwise **null** to receive the first set of
|
@@ -8588,6 +9952,13 @@ module Aws::IoT
|
|
8588
9952
|
|
8589
9953
|
# Lists the things you have added to the given billing group.
|
8590
9954
|
#
|
9955
|
+
# Requires permission to access the [ListThingsInBillingGroup][1]
|
9956
|
+
# action.
|
9957
|
+
#
|
9958
|
+
#
|
9959
|
+
#
|
9960
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9961
|
+
#
|
8591
9962
|
# @option params [required, String] :billing_group_name
|
8592
9963
|
# The name of the billing group.
|
8593
9964
|
#
|
@@ -8629,6 +10000,12 @@ module Aws::IoT
|
|
8629
10000
|
|
8630
10001
|
# Lists the things in the specified group.
|
8631
10002
|
#
|
10003
|
+
# Requires permission to access the [ListThingsInThingGroup][1] action.
|
10004
|
+
#
|
10005
|
+
#
|
10006
|
+
#
|
10007
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10008
|
+
#
|
8632
10009
|
# @option params [required, String] :thing_group_name
|
8633
10010
|
# The thing group name.
|
8634
10011
|
#
|
@@ -8673,7 +10050,15 @@ module Aws::IoT
|
|
8673
10050
|
req.send_request(options)
|
8674
10051
|
end
|
8675
10052
|
|
8676
|
-
# Lists all the topic rule destinations in your
|
10053
|
+
# Lists all the topic rule destinations in your Amazon Web Services
|
10054
|
+
# account.
|
10055
|
+
#
|
10056
|
+
# Requires permission to access the [ListTopicRuleDestinations][1]
|
10057
|
+
# action.
|
10058
|
+
#
|
10059
|
+
#
|
10060
|
+
#
|
10061
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8677
10062
|
#
|
8678
10063
|
# @option params [Integer] :max_results
|
8679
10064
|
# The maximum number of results to return at one time.
|
@@ -8723,6 +10108,12 @@ module Aws::IoT
|
|
8723
10108
|
|
8724
10109
|
# Lists the rules for the specific topic.
|
8725
10110
|
#
|
10111
|
+
# Requires permission to access the [ListTopicRules][1] action.
|
10112
|
+
#
|
10113
|
+
#
|
10114
|
+
#
|
10115
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10116
|
+
#
|
8726
10117
|
# @option params [String] :topic
|
8727
10118
|
# The topic.
|
8728
10119
|
#
|
@@ -8772,6 +10163,12 @@ module Aws::IoT
|
|
8772
10163
|
|
8773
10164
|
# Lists logging levels.
|
8774
10165
|
#
|
10166
|
+
# Requires permission to access the [ListV2LoggingLevels][1] action.
|
10167
|
+
#
|
10168
|
+
#
|
10169
|
+
#
|
10170
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10171
|
+
#
|
8775
10172
|
# @option params [String] :target_type
|
8776
10173
|
# The type of resource for which you are configuring logging. Must be
|
8777
10174
|
# `THING_Group`.
|
@@ -8819,6 +10216,12 @@ module Aws::IoT
|
|
8819
10216
|
# to those alerts issued for a particular security profile, behavior, or
|
8820
10217
|
# thing (device).
|
8821
10218
|
#
|
10219
|
+
# Requires permission to access the [ListViolationEvents][1] action.
|
10220
|
+
#
|
10221
|
+
#
|
10222
|
+
#
|
10223
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10224
|
+
#
|
8822
10225
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
8823
10226
|
# The start time for the alerts to be listed.
|
8824
10227
|
#
|
@@ -8839,6 +10242,9 @@ module Aws::IoT
|
|
8839
10242
|
# @option params [Boolean] :list_suppressed_alerts
|
8840
10243
|
# A list of all suppressed alerts.
|
8841
10244
|
#
|
10245
|
+
# @option params [String] :verification_state
|
10246
|
+
# The verification state of the violation (detect alarm).
|
10247
|
+
#
|
8842
10248
|
# @option params [String] :next_token
|
8843
10249
|
# The token for the next set of results.
|
8844
10250
|
#
|
@@ -8861,6 +10267,7 @@ module Aws::IoT
|
|
8861
10267
|
# security_profile_name: "SecurityProfileName",
|
8862
10268
|
# behavior_criteria_type: "STATIC", # accepts STATIC, STATISTICAL, MACHINE_LEARNING
|
8863
10269
|
# list_suppressed_alerts: false,
|
10270
|
+
# verification_state: "FALSE_POSITIVE", # accepts FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN
|
8864
10271
|
# next_token: "NextToken",
|
8865
10272
|
# max_results: 1,
|
8866
10273
|
# })
|
@@ -8904,6 +10311,8 @@ module Aws::IoT
|
|
8904
10311
|
# resp.violation_events[0].metric_value.strings[0] #=> String
|
8905
10312
|
# resp.violation_events[0].violation_event_additional_info.confidence_level #=> String, one of "LOW", "MEDIUM", "HIGH"
|
8906
10313
|
# resp.violation_events[0].violation_event_type #=> String, one of "in-alarm", "alarm-cleared", "alarm-invalidated"
|
10314
|
+
# resp.violation_events[0].verification_state #=> String, one of "FALSE_POSITIVE", "BENIGN_POSITIVE", "TRUE_POSITIVE", "UNKNOWN"
|
10315
|
+
# resp.violation_events[0].verification_state_description #=> String
|
8907
10316
|
# resp.violation_events[0].violation_event_time #=> Time
|
8908
10317
|
# resp.next_token #=> String
|
8909
10318
|
#
|
@@ -8914,14 +10323,50 @@ module Aws::IoT
|
|
8914
10323
|
req.send_request(options)
|
8915
10324
|
end
|
8916
10325
|
|
8917
|
-
#
|
8918
|
-
#
|
8919
|
-
#
|
8920
|
-
#
|
8921
|
-
#
|
8922
|
-
#
|
8923
|
-
#
|
8924
|
-
#
|
10326
|
+
# Set a verification state and provide a description of that
|
10327
|
+
# verification state on a violation (detect alarm).
|
10328
|
+
#
|
10329
|
+
# @option params [required, String] :violation_id
|
10330
|
+
# The violation ID.
|
10331
|
+
#
|
10332
|
+
# @option params [required, String] :verification_state
|
10333
|
+
# The verification state of the violation.
|
10334
|
+
#
|
10335
|
+
# @option params [String] :verification_state_description
|
10336
|
+
# The description of the verification state of the violation (detect
|
10337
|
+
# alarm).
|
10338
|
+
#
|
10339
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
10340
|
+
#
|
10341
|
+
# @example Request syntax with placeholder values
|
10342
|
+
#
|
10343
|
+
# resp = client.put_verification_state_on_violation({
|
10344
|
+
# violation_id: "ViolationId", # required
|
10345
|
+
# verification_state: "FALSE_POSITIVE", # required, accepts FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN
|
10346
|
+
# verification_state_description: "VerificationStateDescription",
|
10347
|
+
# })
|
10348
|
+
#
|
10349
|
+
# @overload put_verification_state_on_violation(params = {})
|
10350
|
+
# @param [Hash] params ({})
|
10351
|
+
def put_verification_state_on_violation(params = {}, options = {})
|
10352
|
+
req = build_request(:put_verification_state_on_violation, params)
|
10353
|
+
req.send_request(options)
|
10354
|
+
end
|
10355
|
+
|
10356
|
+
# Registers a CA certificate with IoT. This CA certificate can then be
|
10357
|
+
# used to sign device certificates, which can be then registered with
|
10358
|
+
# IoT. You can register up to 10 CA certificates per Amazon Web Services
|
10359
|
+
# account that have the same subject field. This enables you to have up
|
10360
|
+
# to 10 certificate authorities sign your device certificates. If you
|
10361
|
+
# have more than one CA certificate registered, make sure you pass the
|
10362
|
+
# CA certificate when you register your device certificates with the
|
10363
|
+
# RegisterCertificate action.
|
10364
|
+
#
|
10365
|
+
# Requires permission to access the [RegisterCACertificate][1] action.
|
10366
|
+
#
|
10367
|
+
#
|
10368
|
+
#
|
10369
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
8925
10370
|
#
|
8926
10371
|
# @option params [required, String] :ca_certificate
|
8927
10372
|
# The CA certificate.
|
@@ -8989,11 +10434,17 @@ module Aws::IoT
|
|
8989
10434
|
req.send_request(options)
|
8990
10435
|
end
|
8991
10436
|
|
8992
|
-
# Registers a device certificate with
|
8993
|
-
#
|
8994
|
-
#
|
10437
|
+
# Registers a device certificate with IoT. If you have more than one CA
|
10438
|
+
# certificate that has the same subject field, you must specify the CA
|
10439
|
+
# certificate that was used to sign the device certificate being
|
8995
10440
|
# registered.
|
8996
10441
|
#
|
10442
|
+
# Requires permission to access the [RegisterCertificate][1] action.
|
10443
|
+
#
|
10444
|
+
#
|
10445
|
+
#
|
10446
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10447
|
+
#
|
8997
10448
|
# @option params [required, String] :certificate_pem
|
8998
10449
|
# The certificate data, in PEM format.
|
8999
10450
|
#
|
@@ -9067,15 +10518,18 @@ module Aws::IoT
|
|
9067
10518
|
end
|
9068
10519
|
|
9069
10520
|
# Provisions a thing in the device registry. RegisterThing calls other
|
9070
|
-
#
|
9071
|
-
#
|
9072
|
-
#
|
10521
|
+
# IoT control plane APIs. These calls might exceed your account level [
|
10522
|
+
# IoT Throttling Limits][1] and cause throttle errors. Please contact
|
10523
|
+
# [Amazon Web Services Customer Support][2] to raise your throttling
|
9073
10524
|
# limits if necessary.
|
9074
10525
|
#
|
10526
|
+
# Requires permission to access the [RegisterThing][3] action.
|
10527
|
+
#
|
9075
10528
|
#
|
9076
10529
|
#
|
9077
10530
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_iot
|
9078
10531
|
# [2]: https://console.aws.amazon.com/support/home
|
10532
|
+
# [3]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9079
10533
|
#
|
9080
10534
|
# @option params [required, String] :template_body
|
9081
10535
|
# The provisioning template. See [Provisioning Devices That Have Device
|
@@ -9120,7 +10574,7 @@ module Aws::IoT
|
|
9120
10574
|
req.send_request(options)
|
9121
10575
|
end
|
9122
10576
|
|
9123
|
-
# Rejects a pending certificate transfer. After
|
10577
|
+
# Rejects a pending certificate transfer. After IoT rejects a
|
9124
10578
|
# certificate transfer, the certificate status changes from
|
9125
10579
|
# **PENDING\_TRANSFER** to **INACTIVE**.
|
9126
10580
|
#
|
@@ -9131,6 +10585,13 @@ module Aws::IoT
|
|
9131
10585
|
# it is called, the certificate will be returned to the source's
|
9132
10586
|
# account in the INACTIVE state.
|
9133
10587
|
#
|
10588
|
+
# Requires permission to access the [RejectCertificateTransfer][1]
|
10589
|
+
# action.
|
10590
|
+
#
|
10591
|
+
#
|
10592
|
+
#
|
10593
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10594
|
+
#
|
9134
10595
|
# @option params [required, String] :certificate_id
|
9135
10596
|
# The ID of the certificate. (The last part of the certificate ARN
|
9136
10597
|
# contains the certificate ID.)
|
@@ -9156,6 +10617,13 @@ module Aws::IoT
|
|
9156
10617
|
|
9157
10618
|
# Removes the given thing from the billing group.
|
9158
10619
|
#
|
10620
|
+
# Requires permission to access the [RemoveThingFromBillingGroup][1]
|
10621
|
+
# action.
|
10622
|
+
#
|
10623
|
+
#
|
10624
|
+
#
|
10625
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10626
|
+
#
|
9159
10627
|
# @option params [String] :billing_group_name
|
9160
10628
|
# The name of the billing group.
|
9161
10629
|
#
|
@@ -9192,6 +10660,13 @@ module Aws::IoT
|
|
9192
10660
|
# identify the thing group and either a `thingArn` or a `thingName` to
|
9193
10661
|
# identify the thing to remove from the thing group.
|
9194
10662
|
#
|
10663
|
+
# Requires permission to access the [RemoveThingFromThingGroup][1]
|
10664
|
+
# action.
|
10665
|
+
#
|
10666
|
+
#
|
10667
|
+
#
|
10668
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10669
|
+
#
|
9195
10670
|
# @option params [String] :thing_group_name
|
9196
10671
|
# The group name.
|
9197
10672
|
#
|
@@ -9227,6 +10702,12 @@ module Aws::IoT
|
|
9227
10702
|
# permission to create rules will be able to access data processed by
|
9228
10703
|
# the rule.
|
9229
10704
|
#
|
10705
|
+
# Requires permission to access the [ReplaceTopicRule][1] action.
|
10706
|
+
#
|
10707
|
+
#
|
10708
|
+
#
|
10709
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10710
|
+
#
|
9230
10711
|
# @option params [required, String] :rule_name
|
9231
10712
|
# The name of the rule.
|
9232
10713
|
#
|
@@ -9410,6 +10891,13 @@ module Aws::IoT
|
|
9410
10891
|
# "String" => "String",
|
9411
10892
|
# },
|
9412
10893
|
# },
|
10894
|
+
# open_search: {
|
10895
|
+
# role_arn: "AwsArn", # required
|
10896
|
+
# endpoint: "ElasticsearchEndpoint", # required
|
10897
|
+
# index: "ElasticsearchIndex", # required
|
10898
|
+
# type: "ElasticsearchType", # required
|
10899
|
+
# id: "ElasticsearchId", # required
|
10900
|
+
# },
|
9413
10901
|
# },
|
9414
10902
|
# ],
|
9415
10903
|
# rule_disabled: false,
|
@@ -9581,6 +11069,13 @@ module Aws::IoT
|
|
9581
11069
|
# "String" => "String",
|
9582
11070
|
# },
|
9583
11071
|
# },
|
11072
|
+
# open_search: {
|
11073
|
+
# role_arn: "AwsArn", # required
|
11074
|
+
# endpoint: "ElasticsearchEndpoint", # required
|
11075
|
+
# index: "ElasticsearchIndex", # required
|
11076
|
+
# type: "ElasticsearchType", # required
|
11077
|
+
# id: "ElasticsearchId", # required
|
11078
|
+
# },
|
9584
11079
|
# },
|
9585
11080
|
# },
|
9586
11081
|
# })
|
@@ -9594,6 +11089,12 @@ module Aws::IoT
|
|
9594
11089
|
|
9595
11090
|
# The query search index.
|
9596
11091
|
#
|
11092
|
+
# Requires permission to access the [SearchIndex][1] action.
|
11093
|
+
#
|
11094
|
+
#
|
11095
|
+
#
|
11096
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11097
|
+
#
|
9597
11098
|
# @option params [String] :index_name
|
9598
11099
|
# The search index name.
|
9599
11100
|
#
|
@@ -9640,6 +11141,7 @@ module Aws::IoT
|
|
9640
11141
|
# resp.things[0].shadow #=> String
|
9641
11142
|
# resp.things[0].connectivity.connected #=> Boolean
|
9642
11143
|
# resp.things[0].connectivity.timestamp #=> Integer
|
11144
|
+
# resp.things[0].connectivity.disconnect_reason #=> String
|
9643
11145
|
# resp.thing_groups #=> Array
|
9644
11146
|
# resp.thing_groups[0].thing_group_name #=> String
|
9645
11147
|
# resp.thing_groups[0].thing_group_id #=> String
|
@@ -9659,6 +11161,12 @@ module Aws::IoT
|
|
9659
11161
|
# Sets the default authorizer. This will be used if a websocket
|
9660
11162
|
# connection is made without specifying an authorizer.
|
9661
11163
|
#
|
11164
|
+
# Requires permission to access the [SetDefaultAuthorizer][1] action.
|
11165
|
+
#
|
11166
|
+
#
|
11167
|
+
#
|
11168
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11169
|
+
#
|
9662
11170
|
# @option params [required, String] :authorizer_name
|
9663
11171
|
# The authorizer name.
|
9664
11172
|
#
|
@@ -9688,7 +11196,13 @@ module Aws::IoT
|
|
9688
11196
|
# Sets the specified version of the specified policy as the policy's
|
9689
11197
|
# default (operative) version. This action affects all certificates to
|
9690
11198
|
# which the policy is attached. To list the principals the policy is
|
9691
|
-
# attached to, use the
|
11199
|
+
# attached to, use the ListPrincipalPolicies action.
|
11200
|
+
#
|
11201
|
+
# Requires permission to access the [SetDefaultPolicyVersion][1] action.
|
11202
|
+
#
|
11203
|
+
#
|
11204
|
+
#
|
11205
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9692
11206
|
#
|
9693
11207
|
# @option params [required, String] :policy_name
|
9694
11208
|
# The policy name.
|
@@ -9717,6 +11231,12 @@ module Aws::IoT
|
|
9717
11231
|
# NOTE: use of this command is not recommended. Use
|
9718
11232
|
# `SetV2LoggingOptions` instead.
|
9719
11233
|
#
|
11234
|
+
# Requires permission to access the [SetLoggingOptions][1] action.
|
11235
|
+
#
|
11236
|
+
#
|
11237
|
+
#
|
11238
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11239
|
+
#
|
9720
11240
|
# @option params [required, Types::LoggingOptionsPayload] :logging_options_payload
|
9721
11241
|
# The logging options payload.
|
9722
11242
|
#
|
@@ -9740,6 +11260,12 @@ module Aws::IoT
|
|
9740
11260
|
|
9741
11261
|
# Sets the logging level.
|
9742
11262
|
#
|
11263
|
+
# Requires permission to access the [SetV2LoggingLevel][1] action.
|
11264
|
+
#
|
11265
|
+
#
|
11266
|
+
#
|
11267
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11268
|
+
#
|
9743
11269
|
# @option params [required, Types::LogTarget] :log_target
|
9744
11270
|
# The log target.
|
9745
11271
|
#
|
@@ -9767,6 +11293,12 @@ module Aws::IoT
|
|
9767
11293
|
|
9768
11294
|
# Sets the logging options for the V2 logging service.
|
9769
11295
|
#
|
11296
|
+
# Requires permission to access the [SetV2LoggingOptions][1] action.
|
11297
|
+
#
|
11298
|
+
#
|
11299
|
+
#
|
11300
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11301
|
+
#
|
9770
11302
|
# @option params [String] :role_arn
|
9771
11303
|
# The ARN of the role that allows IoT to write to Cloudwatch logs.
|
9772
11304
|
#
|
@@ -9796,6 +11328,13 @@ module Aws::IoT
|
|
9796
11328
|
# Starts a task that applies a set of mitigation actions to the
|
9797
11329
|
# specified target.
|
9798
11330
|
#
|
11331
|
+
# Requires permission to access the [StartAuditMitigationActionsTask][1]
|
11332
|
+
# action.
|
11333
|
+
#
|
11334
|
+
#
|
11335
|
+
#
|
11336
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11337
|
+
#
|
9799
11338
|
# @option params [required, String] :task_id
|
9800
11339
|
# A unique identifier for the task. You can use this identifier to check
|
9801
11340
|
# the status of the task or to cancel it.
|
@@ -9807,7 +11346,7 @@ module Aws::IoT
|
|
9807
11346
|
#
|
9808
11347
|
# @option params [required, Hash<String,Array>] :audit_check_to_actions_mapping
|
9809
11348
|
# For an audit check, specifies which mitigation actions to apply. Those
|
9810
|
-
# actions must be defined in your
|
11349
|
+
# actions must be defined in your Amazon Web Services accounts.
|
9811
11350
|
#
|
9812
11351
|
# @option params [required, String] :client_request_token
|
9813
11352
|
# Each audit mitigation task must have a unique client request token. If
|
@@ -9852,6 +11391,13 @@ module Aws::IoT
|
|
9852
11391
|
|
9853
11392
|
# Starts a Device Defender ML Detect mitigation actions task.
|
9854
11393
|
#
|
11394
|
+
# Requires permission to access the
|
11395
|
+
# [StartDetectMitigationActionsTask][1] action.
|
11396
|
+
#
|
11397
|
+
#
|
11398
|
+
#
|
11399
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11400
|
+
#
|
9855
11401
|
# @option params [required, String] :task_id
|
9856
11402
|
# The unique identifier of the task.
|
9857
11403
|
#
|
@@ -9874,8 +11420,8 @@ module Aws::IoT
|
|
9874
11420
|
# @option params [required, String] :client_request_token
|
9875
11421
|
# Each mitigation action task must have a unique client request token.
|
9876
11422
|
# 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.
|
11423
|
+
# already exists, an exception occurs. If you omit this value, Amazon
|
11424
|
+
# Web Services SDKs will automatically generate a unique client request.
|
9879
11425
|
#
|
9880
11426
|
# **A suitable default value is auto-generated.** You should normally
|
9881
11427
|
# not need to pass this option.**
|
@@ -9916,6 +11462,12 @@ module Aws::IoT
|
|
9916
11462
|
|
9917
11463
|
# Starts an on-demand Device Defender audit.
|
9918
11464
|
#
|
11465
|
+
# Requires permission to access the [StartOnDemandAuditTask][1] action.
|
11466
|
+
#
|
11467
|
+
#
|
11468
|
+
#
|
11469
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11470
|
+
#
|
9919
11471
|
# @option params [required, Array<String>] :target_check_names
|
9920
11472
|
# Which checks are performed during the audit. The checks you specify
|
9921
11473
|
# must be enabled for your account or an exception occurs. Use
|
@@ -9946,6 +11498,13 @@ module Aws::IoT
|
|
9946
11498
|
|
9947
11499
|
# Creates a bulk thing provisioning task.
|
9948
11500
|
#
|
11501
|
+
# Requires permission to access the [StartThingRegistrationTask][1]
|
11502
|
+
# action.
|
11503
|
+
#
|
11504
|
+
#
|
11505
|
+
#
|
11506
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11507
|
+
#
|
9949
11508
|
# @option params [required, String] :template_body
|
9950
11509
|
# The provisioning template.
|
9951
11510
|
#
|
@@ -9986,6 +11545,13 @@ module Aws::IoT
|
|
9986
11545
|
|
9987
11546
|
# Cancels a bulk thing provisioning task.
|
9988
11547
|
#
|
11548
|
+
# Requires permission to access the [StopThingRegistrationTask][1]
|
11549
|
+
# action.
|
11550
|
+
#
|
11551
|
+
#
|
11552
|
+
#
|
11553
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11554
|
+
#
|
9989
11555
|
# @option params [required, String] :task_id
|
9990
11556
|
# The bulk thing provisioning task ID.
|
9991
11557
|
#
|
@@ -10007,6 +11573,12 @@ module Aws::IoT
|
|
10007
11573
|
# Adds to or modifies the tags of the given resource. Tags are metadata
|
10008
11574
|
# which can be used to manage a resource.
|
10009
11575
|
#
|
11576
|
+
# Requires permission to access the [TagResource][1] action.
|
11577
|
+
#
|
11578
|
+
#
|
11579
|
+
#
|
11580
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11581
|
+
#
|
10010
11582
|
# @option params [required, String] :resource_arn
|
10011
11583
|
# The ARN of the resource.
|
10012
11584
|
#
|
@@ -10034,10 +11606,15 @@ module Aws::IoT
|
|
10034
11606
|
req.send_request(options)
|
10035
11607
|
end
|
10036
11608
|
|
10037
|
-
# Tests if a specified principal is authorized to perform an
|
10038
|
-
#
|
10039
|
-
#
|
10040
|
-
#
|
11609
|
+
# Tests if a specified principal is authorized to perform an IoT action
|
11610
|
+
# on a specified resource. Use this to test and debug the authorization
|
11611
|
+
# behavior of devices that connect to the IoT device gateway.
|
11612
|
+
#
|
11613
|
+
# Requires permission to access the [TestAuthorization][1] action.
|
11614
|
+
#
|
11615
|
+
#
|
11616
|
+
#
|
11617
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10041
11618
|
#
|
10042
11619
|
# @option params [String] :principal
|
10043
11620
|
# The principal. Valid principals are CertificateArn
|
@@ -10112,7 +11689,13 @@ module Aws::IoT
|
|
10112
11689
|
|
10113
11690
|
# Tests a custom authorization behavior by invoking a specified custom
|
10114
11691
|
# authorizer. Use this to test and debug the custom authorization
|
10115
|
-
# behavior of devices that connect to the
|
11692
|
+
# behavior of devices that connect to the IoT device gateway.
|
11693
|
+
#
|
11694
|
+
# Requires permission to access the [TestInvokeAuthorizer][1] action.
|
11695
|
+
#
|
11696
|
+
#
|
11697
|
+
#
|
11698
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10116
11699
|
#
|
10117
11700
|
# @option params [required, String] :authorizer_name
|
10118
11701
|
# The custom authorizer name.
|
@@ -10179,7 +11762,10 @@ module Aws::IoT
|
|
10179
11762
|
req.send_request(options)
|
10180
11763
|
end
|
10181
11764
|
|
10182
|
-
# Transfers the specified certificate to the specified
|
11765
|
+
# Transfers the specified certificate to the specified Amazon Web
|
11766
|
+
# Services account.
|
11767
|
+
#
|
11768
|
+
# Requires permission to access the [TransferCertificate][1] action.
|
10183
11769
|
#
|
10184
11770
|
# You can cancel the transfer until it is acknowledged by the recipient.
|
10185
11771
|
#
|
@@ -10187,17 +11773,21 @@ module Aws::IoT
|
|
10187
11773
|
# up to the caller to notify the transfer target.
|
10188
11774
|
#
|
10189
11775
|
# The certificate being transferred must not be in the ACTIVE state. You
|
10190
|
-
# can use the UpdateCertificate
|
11776
|
+
# can use the UpdateCertificate action to deactivate it.
|
10191
11777
|
#
|
10192
11778
|
# The certificate must not have any policies attached to it. You can use
|
10193
|
-
# the
|
11779
|
+
# the DetachPolicy action to detach them.
|
11780
|
+
#
|
11781
|
+
#
|
11782
|
+
#
|
11783
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
10194
11784
|
#
|
10195
11785
|
# @option params [required, String] :certificate_id
|
10196
11786
|
# The ID of the certificate. (The last part of the certificate ARN
|
10197
11787
|
# contains the certificate ID.)
|
10198
11788
|
#
|
10199
11789
|
# @option params [required, String] :target_aws_account
|
10200
|
-
# The
|
11790
|
+
# The Amazon Web Services account.
|
10201
11791
|
#
|
10202
11792
|
# @option params [String] :transfer_message
|
10203
11793
|
# The transfer message.
|
@@ -10227,6 +11817,12 @@ module Aws::IoT
|
|
10227
11817
|
|
10228
11818
|
# Removes the given tags (metadata) from the resource.
|
10229
11819
|
#
|
11820
|
+
# Requires permission to access the [UntagResource][1] action.
|
11821
|
+
#
|
11822
|
+
#
|
11823
|
+
#
|
11824
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11825
|
+
#
|
10230
11826
|
# @option params [required, String] :resource_arn
|
10231
11827
|
# The ARN of the resource.
|
10232
11828
|
#
|
@@ -10253,10 +11849,17 @@ module Aws::IoT
|
|
10253
11849
|
# account. Settings include how audit notifications are sent and which
|
10254
11850
|
# audit checks are enabled or disabled.
|
10255
11851
|
#
|
11852
|
+
# Requires permission to access the [UpdateAccountAuditConfiguration][1]
|
11853
|
+
# action.
|
11854
|
+
#
|
11855
|
+
#
|
11856
|
+
#
|
11857
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11858
|
+
#
|
10256
11859
|
# @option params [String] :role_arn
|
10257
11860
|
# The Amazon Resource Name (ARN) of the role that grants permission to
|
10258
|
-
#
|
10259
|
-
#
|
11861
|
+
# IoT to access information about your devices, policies, certificates,
|
11862
|
+
# and other items as required when performing an audit.
|
10260
11863
|
#
|
10261
11864
|
# @option params [Hash<String,Types::AuditNotificationTarget>] :audit_notification_target_configurations
|
10262
11865
|
# Information about the targets to which audit notifications are sent.
|
@@ -10358,6 +11961,12 @@ module Aws::IoT
|
|
10358
11961
|
|
10359
11962
|
# Updates an authorizer.
|
10360
11963
|
#
|
11964
|
+
# Requires permission to access the [UpdateAuthorizer][1] action.
|
11965
|
+
#
|
11966
|
+
#
|
11967
|
+
#
|
11968
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
11969
|
+
#
|
10361
11970
|
# @option params [required, String] :authorizer_name
|
10362
11971
|
# The authorizer name.
|
10363
11972
|
#
|
@@ -10404,6 +12013,12 @@ module Aws::IoT
|
|
10404
12013
|
|
10405
12014
|
# Updates information about the billing group.
|
10406
12015
|
#
|
12016
|
+
# Requires permission to access the [UpdateBillingGroup][1] action.
|
12017
|
+
#
|
12018
|
+
#
|
12019
|
+
#
|
12020
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12021
|
+
#
|
10407
12022
|
# @option params [required, String] :billing_group_name
|
10408
12023
|
# The name of the billing group.
|
10409
12024
|
#
|
@@ -10443,6 +12058,12 @@ module Aws::IoT
|
|
10443
12058
|
|
10444
12059
|
# Updates a registered CA certificate.
|
10445
12060
|
#
|
12061
|
+
# Requires permission to access the [UpdateCACertificate][1] action.
|
12062
|
+
#
|
12063
|
+
#
|
12064
|
+
#
|
12065
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12066
|
+
#
|
10446
12067
|
# @option params [required, String] :certificate_id
|
10447
12068
|
# The CA certificate identifier.
|
10448
12069
|
#
|
@@ -10487,14 +12108,20 @@ module Aws::IoT
|
|
10487
12108
|
# Updates the status of the specified certificate. This operation is
|
10488
12109
|
# idempotent.
|
10489
12110
|
#
|
12111
|
+
# Requires permission to access the [UpdateCertificate][1] action.
|
12112
|
+
#
|
10490
12113
|
# Certificates must be in the ACTIVE state to authenticate devices that
|
10491
|
-
# use a certificate to connect to
|
12114
|
+
# use a certificate to connect to IoT.
|
10492
12115
|
#
|
10493
12116
|
# Within a few minutes of updating a certificate from the ACTIVE state
|
10494
|
-
# to any other state,
|
12117
|
+
# to any other state, IoT disconnects all devices that used that
|
10495
12118
|
# certificate to connect. Devices cannot use a certificate that is not
|
10496
12119
|
# in the ACTIVE state to reconnect.
|
10497
12120
|
#
|
12121
|
+
#
|
12122
|
+
#
|
12123
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12124
|
+
#
|
10498
12125
|
# @option params [required, String] :certificate_id
|
10499
12126
|
# The ID of the certificate. (The last part of the certificate ARN
|
10500
12127
|
# contains the certificate ID.)
|
@@ -10505,7 +12132,7 @@ module Aws::IoT
|
|
10505
12132
|
# **Note:** Setting the status to PENDING\_TRANSFER or
|
10506
12133
|
# PENDING\_ACTIVATION will result in an exception being thrown.
|
10507
12134
|
# PENDING\_TRANSFER and PENDING\_ACTIVATION are statuses used internally
|
10508
|
-
# by
|
12135
|
+
# by IoT. They are not intended for developer use.
|
10509
12136
|
#
|
10510
12137
|
# **Note:** The status value REGISTER\_INACTIVE is deprecated and should
|
10511
12138
|
# not be used.
|
@@ -10528,6 +12155,12 @@ module Aws::IoT
|
|
10528
12155
|
|
10529
12156
|
# Updates a Device Defender detect custom metric.
|
10530
12157
|
#
|
12158
|
+
# Requires permission to access the [UpdateCustomMetric][1] action.
|
12159
|
+
#
|
12160
|
+
#
|
12161
|
+
#
|
12162
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12163
|
+
#
|
10531
12164
|
# @option params [required, String] :metric_name
|
10532
12165
|
# The name of the custom metric. Cannot be updated.
|
10533
12166
|
#
|
@@ -10571,6 +12204,12 @@ module Aws::IoT
|
|
10571
12204
|
# Updates the definition for a dimension. You cannot change the type of
|
10572
12205
|
# a dimension after it is created (you can delete it and recreate it).
|
10573
12206
|
#
|
12207
|
+
# Requires permission to access the [UpdateDimension][1] action.
|
12208
|
+
#
|
12209
|
+
#
|
12210
|
+
#
|
12211
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12212
|
+
#
|
10574
12213
|
# @option params [required, String] :name
|
10575
12214
|
# A unique identifier for the dimension. Choose something that describes
|
10576
12215
|
# the type and value to make it easy to remember what it does.
|
@@ -10616,6 +12255,13 @@ module Aws::IoT
|
|
10616
12255
|
# Updates values stored in the domain configuration. Domain
|
10617
12256
|
# configurations for default endpoints can't be updated.
|
10618
12257
|
#
|
12258
|
+
# Requires permission to access the [UpdateDomainConfiguration][1]
|
12259
|
+
# action.
|
12260
|
+
#
|
12261
|
+
#
|
12262
|
+
#
|
12263
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12264
|
+
#
|
10619
12265
|
# @option params [required, String] :domain_configuration_name
|
10620
12266
|
# The name of the domain configuration to be updated.
|
10621
12267
|
#
|
@@ -10659,6 +12305,12 @@ module Aws::IoT
|
|
10659
12305
|
|
10660
12306
|
# Updates a dynamic thing group.
|
10661
12307
|
#
|
12308
|
+
# Requires permission to access the [UpdateDynamicThingGroup][1] action.
|
12309
|
+
#
|
12310
|
+
#
|
12311
|
+
#
|
12312
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12313
|
+
#
|
10662
12314
|
# @option params [required, String] :thing_group_name
|
10663
12315
|
# The name of the dynamic thing group to update.
|
10664
12316
|
#
|
@@ -10671,7 +12323,7 @@ module Aws::IoT
|
|
10671
12323
|
# @option params [String] :index_name
|
10672
12324
|
# The dynamic thing group index to update.
|
10673
12325
|
#
|
10674
|
-
# <note markdown="1"> Currently one index is supported:
|
12326
|
+
# <note markdown="1"> Currently one index is supported: `AWS_Things`.
|
10675
12327
|
#
|
10676
12328
|
# </note>
|
10677
12329
|
#
|
@@ -10722,6 +12374,13 @@ module Aws::IoT
|
|
10722
12374
|
|
10723
12375
|
# Updates the event configurations.
|
10724
12376
|
#
|
12377
|
+
# Requires permission to access the [UpdateEventConfigurations][1]
|
12378
|
+
# action.
|
12379
|
+
#
|
12380
|
+
#
|
12381
|
+
#
|
12382
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12383
|
+
#
|
10725
12384
|
# @option params [Hash<String,Types::Configuration>] :event_configurations
|
10726
12385
|
# The new event configuration values.
|
10727
12386
|
#
|
@@ -10744,8 +12403,86 @@ module Aws::IoT
|
|
10744
12403
|
req.send_request(options)
|
10745
12404
|
end
|
10746
12405
|
|
12406
|
+
# Updates the data for a fleet metric.
|
12407
|
+
#
|
12408
|
+
# Requires permission to access the [UpdateFleetMetric][1] action.
|
12409
|
+
#
|
12410
|
+
#
|
12411
|
+
#
|
12412
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12413
|
+
#
|
12414
|
+
# @option params [required, String] :metric_name
|
12415
|
+
# The name of the fleet metric to update.
|
12416
|
+
#
|
12417
|
+
# @option params [String] :query_string
|
12418
|
+
# The search query string.
|
12419
|
+
#
|
12420
|
+
# @option params [Types::AggregationType] :aggregation_type
|
12421
|
+
# The type of the aggregation query.
|
12422
|
+
#
|
12423
|
+
# @option params [Integer] :period
|
12424
|
+
# The time in seconds between fleet metric emissions. Range \[60(1 min),
|
12425
|
+
# 86400(1 day)\] and must be multiple of 60.
|
12426
|
+
#
|
12427
|
+
# @option params [String] :aggregation_field
|
12428
|
+
# The field to aggregate.
|
12429
|
+
#
|
12430
|
+
# @option params [String] :description
|
12431
|
+
# The description of the fleet metric.
|
12432
|
+
#
|
12433
|
+
# @option params [String] :query_version
|
12434
|
+
# The version of the query.
|
12435
|
+
#
|
12436
|
+
# @option params [required, String] :index_name
|
12437
|
+
# The name of the index to search.
|
12438
|
+
#
|
12439
|
+
# @option params [String] :unit
|
12440
|
+
# Used to support unit transformation such as milliseconds to seconds.
|
12441
|
+
# The unit must be supported by [CW metric][1].
|
12442
|
+
#
|
12443
|
+
#
|
12444
|
+
#
|
12445
|
+
# [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
|
12446
|
+
#
|
12447
|
+
# @option params [Integer] :expected_version
|
12448
|
+
# The expected version of the fleet metric record in the registry.
|
12449
|
+
#
|
12450
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
12451
|
+
#
|
12452
|
+
# @example Request syntax with placeholder values
|
12453
|
+
#
|
12454
|
+
# resp = client.update_fleet_metric({
|
12455
|
+
# metric_name: "FleetMetricName", # required
|
12456
|
+
# query_string: "QueryString",
|
12457
|
+
# aggregation_type: {
|
12458
|
+
# name: "Statistics", # required, accepts Statistics, Percentiles, Cardinality
|
12459
|
+
# values: ["AggregationTypeValue"],
|
12460
|
+
# },
|
12461
|
+
# period: 1,
|
12462
|
+
# aggregation_field: "AggregationField",
|
12463
|
+
# description: "FleetMetricDescription",
|
12464
|
+
# query_version: "QueryVersion",
|
12465
|
+
# index_name: "IndexName", # required
|
12466
|
+
# 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
|
12467
|
+
# expected_version: 1,
|
12468
|
+
# })
|
12469
|
+
#
|
12470
|
+
# @overload update_fleet_metric(params = {})
|
12471
|
+
# @param [Hash] params ({})
|
12472
|
+
def update_fleet_metric(params = {}, options = {})
|
12473
|
+
req = build_request(:update_fleet_metric, params)
|
12474
|
+
req.send_request(options)
|
12475
|
+
end
|
12476
|
+
|
10747
12477
|
# Updates the search configuration.
|
10748
12478
|
#
|
12479
|
+
# Requires permission to access the [UpdateIndexingConfiguration][1]
|
12480
|
+
# action.
|
12481
|
+
#
|
12482
|
+
#
|
12483
|
+
#
|
12484
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12485
|
+
#
|
10749
12486
|
# @option params [Types::ThingIndexingConfiguration] :thing_indexing_configuration
|
10750
12487
|
# Thing indexing configuration.
|
10751
12488
|
#
|
@@ -10799,6 +12536,12 @@ module Aws::IoT
|
|
10799
12536
|
|
10800
12537
|
# Updates supported fields of the specified job.
|
10801
12538
|
#
|
12539
|
+
# Requires permission to access the [UpdateJob][1] action.
|
12540
|
+
#
|
12541
|
+
#
|
12542
|
+
#
|
12543
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12544
|
+
#
|
10802
12545
|
# @option params [required, String] :job_id
|
10803
12546
|
# The ID of the job to be updated.
|
10804
12547
|
#
|
@@ -10824,9 +12567,9 @@ module Aws::IoT
|
|
10824
12567
|
# @option params [String] :namespace_id
|
10825
12568
|
# The namespace used to indicate that a job is a customer-managed job.
|
10826
12569
|
#
|
10827
|
-
# When you specify a value for this parameter,
|
10828
|
-
# notifications to MQTT topics that contain the value in
|
10829
|
-
# format.
|
12570
|
+
# When you specify a value for this parameter, Amazon Web Services IoT
|
12571
|
+
# Core sends jobs notifications to MQTT topics that contain the value in
|
12572
|
+
# the following format.
|
10830
12573
|
#
|
10831
12574
|
# `$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
|
10832
12575
|
#
|
@@ -10881,6 +12624,12 @@ module Aws::IoT
|
|
10881
12624
|
|
10882
12625
|
# Updates the definition for the specified mitigation action.
|
10883
12626
|
#
|
12627
|
+
# Requires permission to access the [UpdateMitigationAction][1] action.
|
12628
|
+
#
|
12629
|
+
#
|
12630
|
+
#
|
12631
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12632
|
+
#
|
10884
12633
|
# @option params [required, String] :action_name
|
10885
12634
|
# The friendly name for the mitigation action. You cannot change the
|
10886
12635
|
# name by using `UpdateMitigationAction`. Instead, you must delete and
|
@@ -10940,6 +12689,13 @@ module Aws::IoT
|
|
10940
12689
|
|
10941
12690
|
# Updates a fleet provisioning template.
|
10942
12691
|
#
|
12692
|
+
# Requires permission to access the [UpdateProvisioningTemplate][1]
|
12693
|
+
# action.
|
12694
|
+
#
|
12695
|
+
#
|
12696
|
+
#
|
12697
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12698
|
+
#
|
10943
12699
|
# @option params [required, String] :template_name
|
10944
12700
|
# The name of the fleet provisioning template.
|
10945
12701
|
#
|
@@ -10988,6 +12744,12 @@ module Aws::IoT
|
|
10988
12744
|
|
10989
12745
|
# Updates a role alias.
|
10990
12746
|
#
|
12747
|
+
# Requires permission to access the [UpdateRoleAlias][1] action.
|
12748
|
+
#
|
12749
|
+
#
|
12750
|
+
#
|
12751
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12752
|
+
#
|
10991
12753
|
# @option params [required, String] :role_alias
|
10992
12754
|
# The role alias to update.
|
10993
12755
|
#
|
@@ -11025,6 +12787,12 @@ module Aws::IoT
|
|
11025
12787
|
# Updates a scheduled audit, including which checks are performed and
|
11026
12788
|
# how often the audit takes place.
|
11027
12789
|
#
|
12790
|
+
# Requires permission to access the [UpdateScheduledAudit][1] action.
|
12791
|
+
#
|
12792
|
+
#
|
12793
|
+
#
|
12794
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12795
|
+
#
|
11028
12796
|
# @option params [String] :frequency
|
11029
12797
|
# How often the scheduled audit takes place, either `DAILY`, `WEEKLY`,
|
11030
12798
|
# `BIWEEKLY`, or `MONTHLY`. The start time of each audit is determined
|
@@ -11079,6 +12847,12 @@ module Aws::IoT
|
|
11079
12847
|
|
11080
12848
|
# Updates a Device Defender security profile.
|
11081
12849
|
#
|
12850
|
+
# Requires permission to access the [UpdateSecurityProfile][1] action.
|
12851
|
+
#
|
12852
|
+
#
|
12853
|
+
#
|
12854
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
12855
|
+
#
|
11082
12856
|
# @option params [required, String] :security_profile_name
|
11083
12857
|
# The name of the security profile you want to update.
|
11084
12858
|
#
|
@@ -11249,6 +13023,12 @@ module Aws::IoT
|
|
11249
13023
|
# Updates an existing stream. The stream version will be incremented by
|
11250
13024
|
# one.
|
11251
13025
|
#
|
13026
|
+
# Requires permission to access the [UpdateStream][1] action.
|
13027
|
+
#
|
13028
|
+
#
|
13029
|
+
#
|
13030
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13031
|
+
#
|
11252
13032
|
# @option params [required, String] :stream_id
|
11253
13033
|
# The stream ID.
|
11254
13034
|
#
|
@@ -11303,6 +13083,12 @@ module Aws::IoT
|
|
11303
13083
|
|
11304
13084
|
# Updates the data for a thing.
|
11305
13085
|
#
|
13086
|
+
# Requires permission to access the [UpdateThing][1] action.
|
13087
|
+
#
|
13088
|
+
#
|
13089
|
+
#
|
13090
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13091
|
+
#
|
11306
13092
|
# @option params [required, String] :thing_name
|
11307
13093
|
# The name of the thing to update.
|
11308
13094
|
#
|
@@ -11357,6 +13143,12 @@ module Aws::IoT
|
|
11357
13143
|
|
11358
13144
|
# Update a thing group.
|
11359
13145
|
#
|
13146
|
+
# Requires permission to access the [UpdateThingGroup][1] action.
|
13147
|
+
#
|
13148
|
+
#
|
13149
|
+
#
|
13150
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13151
|
+
#
|
11360
13152
|
# @option params [required, String] :thing_group_name
|
11361
13153
|
# The thing group to update.
|
11362
13154
|
#
|
@@ -11400,6 +13192,13 @@ module Aws::IoT
|
|
11400
13192
|
|
11401
13193
|
# Updates the groups to which the thing belongs.
|
11402
13194
|
#
|
13195
|
+
# Requires permission to access the [UpdateThingGroupsForThing][1]
|
13196
|
+
# action.
|
13197
|
+
#
|
13198
|
+
#
|
13199
|
+
#
|
13200
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13201
|
+
#
|
11403
13202
|
# @option params [String] :thing_name
|
11404
13203
|
# The thing whose group memberships will be updated.
|
11405
13204
|
#
|
@@ -11436,6 +13235,13 @@ module Aws::IoT
|
|
11436
13235
|
# Updates a topic rule destination. You use this to change the status,
|
11437
13236
|
# endpoint URL, or confirmation URL of the destination.
|
11438
13237
|
#
|
13238
|
+
# Requires permission to access the [UpdateTopicRuleDestination][1]
|
13239
|
+
# action.
|
13240
|
+
#
|
13241
|
+
#
|
13242
|
+
#
|
13243
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13244
|
+
#
|
11439
13245
|
# @option params [required, String] :arn
|
11440
13246
|
# The ARN of the topic rule destination.
|
11441
13247
|
#
|
@@ -11489,6 +13295,13 @@ module Aws::IoT
|
|
11489
13295
|
|
11490
13296
|
# Validates a Device Defender security profile behaviors specification.
|
11491
13297
|
#
|
13298
|
+
# Requires permission to access the
|
13299
|
+
# [ValidateSecurityProfileBehaviors][1] action.
|
13300
|
+
#
|
13301
|
+
#
|
13302
|
+
#
|
13303
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13304
|
+
#
|
11492
13305
|
# @option params [required, Array<Types::Behavior>] :behaviors
|
11493
13306
|
# Specifies the behaviors that, when violated by a device (thing), cause
|
11494
13307
|
# an alert.
|
@@ -11560,7 +13373,7 @@ module Aws::IoT
|
|
11560
13373
|
params: params,
|
11561
13374
|
config: config)
|
11562
13375
|
context[:gem_name] = 'aws-sdk-iot'
|
11563
|
-
context[:gem_version] = '1.
|
13376
|
+
context[:gem_version] = '1.76.0'
|
11564
13377
|
Seahorse::Client::Request.new(handlers, context)
|
11565
13378
|
end
|
11566
13379
|
|