aws-sdk-iot 1.35.0 → 1.36.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-iot.rb +1 -1
- data/lib/aws-sdk-iot/client.rb +606 -47
- data/lib/aws-sdk-iot/client_api.rb +400 -5
- data/lib/aws-sdk-iot/errors.rb +16 -0
- data/lib/aws-sdk-iot/types.rb +1109 -117
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9e4b876f176fb80e033afdd2dec7ce787f7a99a4
|
4
|
+
data.tar.gz: 2f1f4550b568be534872f99e459527d2bccbe8e7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 964f6c363dd20b5028215fff66029f1ae8fe2c176b0779f4e5c0cd5759f8ef2d72797b218e0fb6004c66d493767376b21e962283082bd3b042dd71e185d43bc2
|
7
|
+
data.tar.gz: b8fadc23fca1f3632686e42ee053eb83c7a4a92d0eac369ac58556182ffe955d731196cede32fe5de2c8c647e3643c7c81933b70d79d656f1af02987fcc94ddd
|
data/lib/aws-sdk-iot.rb
CHANGED
data/lib/aws-sdk-iot/client.rb
CHANGED
@@ -459,8 +459,8 @@ module Aws::IoT
|
|
459
459
|
end
|
460
460
|
|
461
461
|
# Associates a Device Defender security profile with a thing group or
|
462
|
-
#
|
463
|
-
#
|
462
|
+
# this account. Each thing group or account can have up to five security
|
463
|
+
# profiles associated with it.
|
464
464
|
#
|
465
465
|
# @option params [required, String] :security_profile_name
|
466
466
|
# The security profile that is attached.
|
@@ -511,6 +511,27 @@ module Aws::IoT
|
|
511
511
|
req.send_request(options)
|
512
512
|
end
|
513
513
|
|
514
|
+
# Cancels a mitigation action task that is in progress. If the task is
|
515
|
+
# not in progress, an InvalidRequestException occurs.
|
516
|
+
#
|
517
|
+
# @option params [required, String] :task_id
|
518
|
+
# The unique identifier for the task that you want to cancel.
|
519
|
+
#
|
520
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
521
|
+
#
|
522
|
+
# @example Request syntax with placeholder values
|
523
|
+
#
|
524
|
+
# resp = client.cancel_audit_mitigation_actions_task({
|
525
|
+
# task_id: "AuditMitigationActionsTaskId", # required
|
526
|
+
# })
|
527
|
+
#
|
528
|
+
# @overload cancel_audit_mitigation_actions_task(params = {})
|
529
|
+
# @param [Hash] params ({})
|
530
|
+
def cancel_audit_mitigation_actions_task(params = {}, options = {})
|
531
|
+
req = build_request(:cancel_audit_mitigation_actions_task, params)
|
532
|
+
req.send_request(options)
|
533
|
+
end
|
534
|
+
|
514
535
|
# Cancels an audit that is in progress. The audit can be either
|
515
536
|
# scheduled or on-demand. If the audit is not in progress, an
|
516
537
|
# "InvalidRequestException" occurs.
|
@@ -1097,6 +1118,75 @@ module Aws::IoT
|
|
1097
1118
|
req.send_request(options)
|
1098
1119
|
end
|
1099
1120
|
|
1121
|
+
# Defines an action that can be applied to audit findings by using
|
1122
|
+
# StartAuditMitigationActionsTask. Each mitigation action can apply only
|
1123
|
+
# one type of change.
|
1124
|
+
#
|
1125
|
+
# @option params [required, String] :action_name
|
1126
|
+
# A friendly name for the action. Choose a friendly name that accurately
|
1127
|
+
# describes the action (for example, `EnableLoggingAction`).
|
1128
|
+
#
|
1129
|
+
# @option params [required, String] :role_arn
|
1130
|
+
# The ARN of the IAM role that is used to apply the mitigation action.
|
1131
|
+
#
|
1132
|
+
# @option params [required, Types::MitigationActionParams] :action_params
|
1133
|
+
# Defines the type of action and the parameters for that action.
|
1134
|
+
#
|
1135
|
+
# @option params [Array<Types::Tag>] :tags
|
1136
|
+
# Metadata that can be used to manage the mitigation action.
|
1137
|
+
#
|
1138
|
+
# @return [Types::CreateMitigationActionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1139
|
+
#
|
1140
|
+
# * {Types::CreateMitigationActionResponse#action_arn #action_arn} => String
|
1141
|
+
# * {Types::CreateMitigationActionResponse#action_id #action_id} => String
|
1142
|
+
#
|
1143
|
+
# @example Request syntax with placeholder values
|
1144
|
+
#
|
1145
|
+
# resp = client.create_mitigation_action({
|
1146
|
+
# action_name: "MitigationActionName", # required
|
1147
|
+
# role_arn: "RoleArn", # required
|
1148
|
+
# action_params: { # required
|
1149
|
+
# update_device_certificate_params: {
|
1150
|
+
# action: "DEACTIVATE", # required, accepts DEACTIVATE
|
1151
|
+
# },
|
1152
|
+
# update_ca_certificate_params: {
|
1153
|
+
# action: "DEACTIVATE", # required, accepts DEACTIVATE
|
1154
|
+
# },
|
1155
|
+
# add_things_to_thing_group_params: {
|
1156
|
+
# thing_group_names: ["ThingGroupName"], # required
|
1157
|
+
# override_dynamic_groups: false,
|
1158
|
+
# },
|
1159
|
+
# replace_default_policy_version_params: {
|
1160
|
+
# template_name: "BLANK_POLICY", # required, accepts BLANK_POLICY
|
1161
|
+
# },
|
1162
|
+
# enable_io_t_logging_params: {
|
1163
|
+
# role_arn_for_logging: "RoleArn", # required
|
1164
|
+
# log_level: "DEBUG", # required, accepts DEBUG, INFO, ERROR, WARN, DISABLED
|
1165
|
+
# },
|
1166
|
+
# publish_finding_to_sns_params: {
|
1167
|
+
# topic_arn: "SnsTopicArn", # required
|
1168
|
+
# },
|
1169
|
+
# },
|
1170
|
+
# tags: [
|
1171
|
+
# {
|
1172
|
+
# key: "TagKey",
|
1173
|
+
# value: "TagValue",
|
1174
|
+
# },
|
1175
|
+
# ],
|
1176
|
+
# })
|
1177
|
+
#
|
1178
|
+
# @example Response structure
|
1179
|
+
#
|
1180
|
+
# resp.action_arn #=> String
|
1181
|
+
# resp.action_id #=> String
|
1182
|
+
#
|
1183
|
+
# @overload create_mitigation_action(params = {})
|
1184
|
+
# @param [Hash] params ({})
|
1185
|
+
def create_mitigation_action(params = {}, options = {})
|
1186
|
+
req = build_request(:create_mitigation_action, params)
|
1187
|
+
req.send_request(options)
|
1188
|
+
end
|
1189
|
+
|
1100
1190
|
# Creates an AWS IoT OTAUpdate on a target group of things or groups.
|
1101
1191
|
#
|
1102
1192
|
# @option params [required, String] :ota_update_id
|
@@ -1361,8 +1451,8 @@ module Aws::IoT
|
|
1361
1451
|
#
|
1362
1452
|
# @option params [required, String] :frequency
|
1363
1453
|
# How often the scheduled audit takes place. Can be one of "DAILY",
|
1364
|
-
# "WEEKLY", "BIWEEKLY" or "MONTHLY". The
|
1365
|
-
#
|
1454
|
+
# "WEEKLY", "BIWEEKLY" or "MONTHLY". The start time of each audit
|
1455
|
+
# is determined by the system.
|
1366
1456
|
#
|
1367
1457
|
# @option params [String] :day_of_month
|
1368
1458
|
# The day of the month on which the scheduled audit takes place. Can be
|
@@ -1373,22 +1463,22 @@ module Aws::IoT
|
|
1373
1463
|
#
|
1374
1464
|
# @option params [String] :day_of_week
|
1375
1465
|
# The day of the week on which the scheduled audit takes place. Can be
|
1376
|
-
# one of "SUN", "MON", "TUE", "WED", "THU", "FRI" or
|
1466
|
+
# one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or
|
1377
1467
|
# "SAT". This field is required if the "frequency" parameter is set
|
1378
1468
|
# to "WEEKLY" or "BIWEEKLY".
|
1379
1469
|
#
|
1380
1470
|
# @option params [required, Array<String>] :target_check_names
|
1381
1471
|
# Which checks are performed during the scheduled audit. Checks must be
|
1382
1472
|
# enabled for your account. (Use `DescribeAccountAuditConfiguration` to
|
1383
|
-
# see the list of all checks including those that are enabled or
|
1473
|
+
# see the list of all checks, including those that are enabled or use
|
1384
1474
|
# `UpdateAccountAuditConfiguration` to select which checks are enabled.)
|
1385
1475
|
#
|
1386
|
-
# @option params [Array<Types::Tag>] :tags
|
1387
|
-
# Metadata which can be used to manage the scheduled audit.
|
1388
|
-
#
|
1389
1476
|
# @option params [required, String] :scheduled_audit_name
|
1390
1477
|
# The name you want to give to the scheduled audit. (Max. 128 chars)
|
1391
1478
|
#
|
1479
|
+
# @option params [Array<Types::Tag>] :tags
|
1480
|
+
# Metadata that can be used to manage the scheduled audit.
|
1481
|
+
#
|
1392
1482
|
# @return [Types::CreateScheduledAuditResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1393
1483
|
#
|
1394
1484
|
# * {Types::CreateScheduledAuditResponse#scheduled_audit_arn #scheduled_audit_arn} => String
|
@@ -1400,13 +1490,13 @@ module Aws::IoT
|
|
1400
1490
|
# day_of_month: "DayOfMonth",
|
1401
1491
|
# day_of_week: "SUN", # accepts SUN, MON, TUE, WED, THU, FRI, SAT
|
1402
1492
|
# target_check_names: ["AuditCheckName"], # required
|
1493
|
+
# scheduled_audit_name: "ScheduledAuditName", # required
|
1403
1494
|
# tags: [
|
1404
1495
|
# {
|
1405
1496
|
# key: "TagKey",
|
1406
1497
|
# value: "TagValue",
|
1407
1498
|
# },
|
1408
1499
|
# ],
|
1409
|
-
# scheduled_audit_name: "ScheduledAuditName", # required
|
1410
1500
|
# })
|
1411
1501
|
#
|
1412
1502
|
# @example Response structure
|
@@ -1439,11 +1529,11 @@ module Aws::IoT
|
|
1439
1529
|
#
|
1440
1530
|
# @option params [Array<String>] :additional_metrics_to_retain
|
1441
1531
|
# A list of metrics whose data is retained (stored). By default, data is
|
1442
|
-
# retained for any metric used in the profile's `behaviors
|
1532
|
+
# retained for any metric used in the profile's `behaviors`, but it is
|
1443
1533
|
# also retained for any metric specified here.
|
1444
1534
|
#
|
1445
1535
|
# @option params [Array<Types::Tag>] :tags
|
1446
|
-
# Metadata
|
1536
|
+
# Metadata that can be used to manage the security profile.
|
1447
1537
|
#
|
1448
1538
|
# @return [Types::CreateSecurityProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1449
1539
|
#
|
@@ -2072,17 +2162,19 @@ module Aws::IoT
|
|
2072
2162
|
|
2073
2163
|
# Deletes the specified certificate.
|
2074
2164
|
#
|
2075
|
-
# A certificate cannot be deleted if it has a policy
|
2076
|
-
# if its status is set to ACTIVE. To delete a
|
2077
|
-
# DetachPrincipalPolicy API to detach all
|
2078
|
-
# UpdateCertificate API to set the certificate
|
2165
|
+
# A certificate cannot be deleted if it has a policy or IoT thing
|
2166
|
+
# attached to it or if its status is set to ACTIVE. To delete a
|
2167
|
+
# certificate, first use the DetachPrincipalPolicy API to detach all
|
2168
|
+
# policies. Next, use the UpdateCertificate API to set the certificate
|
2169
|
+
# to the INACTIVE status.
|
2079
2170
|
#
|
2080
2171
|
# @option params [required, String] :certificate_id
|
2081
2172
|
# The ID of the certificate. (The last part of the certificate ARN
|
2082
2173
|
# contains the certificate ID.)
|
2083
2174
|
#
|
2084
2175
|
# @option params [Boolean] :force_delete
|
2085
|
-
# Forces a certificate
|
2176
|
+
# Forces the deletion of a certificate if it is inactive and is not
|
2177
|
+
# attached to an IoT thing.
|
2086
2178
|
#
|
2087
2179
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2088
2180
|
#
|
@@ -2220,6 +2312,26 @@ module Aws::IoT
|
|
2220
2312
|
req.send_request(options)
|
2221
2313
|
end
|
2222
2314
|
|
2315
|
+
# Deletes a defined mitigation action from your AWS account.
|
2316
|
+
#
|
2317
|
+
# @option params [required, String] :action_name
|
2318
|
+
# The name of the mitigation action that you want to delete.
|
2319
|
+
#
|
2320
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2321
|
+
#
|
2322
|
+
# @example Request syntax with placeholder values
|
2323
|
+
#
|
2324
|
+
# resp = client.delete_mitigation_action({
|
2325
|
+
# action_name: "MitigationActionName", # required
|
2326
|
+
# })
|
2327
|
+
#
|
2328
|
+
# @overload delete_mitigation_action(params = {})
|
2329
|
+
# @param [Hash] params ({})
|
2330
|
+
def delete_mitigation_action(params = {}, options = {})
|
2331
|
+
req = build_request(:delete_mitigation_action, params)
|
2332
|
+
req.send_request(options)
|
2333
|
+
end
|
2334
|
+
|
2223
2335
|
# Delete an OTA update.
|
2224
2336
|
#
|
2225
2337
|
# @option params [required, String] :ota_update_id
|
@@ -2368,7 +2480,7 @@ module Aws::IoT
|
|
2368
2480
|
# @option params [Integer] :expected_version
|
2369
2481
|
# The expected version of the security profile. A new version is
|
2370
2482
|
# generated whenever the security profile is updated. If you specify a
|
2371
|
-
# value that is different
|
2483
|
+
# value that is different from the actual version, a
|
2372
2484
|
# `VersionConflictException` is thrown.
|
2373
2485
|
#
|
2374
2486
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -2583,6 +2695,128 @@ module Aws::IoT
|
|
2583
2695
|
req.send_request(options)
|
2584
2696
|
end
|
2585
2697
|
|
2698
|
+
# Gets information about a single audit finding. Properties include the
|
2699
|
+
# reason for noncompliance, the severity of the issue, and when the
|
2700
|
+
# audit that returned the finding was started.
|
2701
|
+
#
|
2702
|
+
# @option params [required, String] :finding_id
|
2703
|
+
# A unique identifier for a single audit finding. You can use this
|
2704
|
+
# identifier to apply mitigation actions to the finding.
|
2705
|
+
#
|
2706
|
+
# @return [Types::DescribeAuditFindingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2707
|
+
#
|
2708
|
+
# * {Types::DescribeAuditFindingResponse#finding #finding} => Types::AuditFinding
|
2709
|
+
#
|
2710
|
+
# @example Request syntax with placeholder values
|
2711
|
+
#
|
2712
|
+
# resp = client.describe_audit_finding({
|
2713
|
+
# finding_id: "FindingId", # required
|
2714
|
+
# })
|
2715
|
+
#
|
2716
|
+
# @example Response structure
|
2717
|
+
#
|
2718
|
+
# resp.finding.finding_id #=> String
|
2719
|
+
# resp.finding.task_id #=> String
|
2720
|
+
# resp.finding.check_name #=> String
|
2721
|
+
# resp.finding.task_start_time #=> Time
|
2722
|
+
# resp.finding.finding_time #=> Time
|
2723
|
+
# resp.finding.severity #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW"
|
2724
|
+
# resp.finding.non_compliant_resource.resource_type #=> String, one of "DEVICE_CERTIFICATE", "CA_CERTIFICATE", "IOT_POLICY", "COGNITO_IDENTITY_POOL", "CLIENT_ID", "ACCOUNT_SETTINGS"
|
2725
|
+
# resp.finding.non_compliant_resource.resource_identifier.device_certificate_id #=> String
|
2726
|
+
# resp.finding.non_compliant_resource.resource_identifier.ca_certificate_id #=> String
|
2727
|
+
# resp.finding.non_compliant_resource.resource_identifier.cognito_identity_pool_id #=> String
|
2728
|
+
# resp.finding.non_compliant_resource.resource_identifier.client_id #=> String
|
2729
|
+
# resp.finding.non_compliant_resource.resource_identifier.policy_version_identifier.policy_name #=> String
|
2730
|
+
# resp.finding.non_compliant_resource.resource_identifier.policy_version_identifier.policy_version_id #=> String
|
2731
|
+
# resp.finding.non_compliant_resource.resource_identifier.account #=> String
|
2732
|
+
# resp.finding.non_compliant_resource.additional_info #=> Hash
|
2733
|
+
# resp.finding.non_compliant_resource.additional_info["String"] #=> String
|
2734
|
+
# resp.finding.related_resources #=> Array
|
2735
|
+
# resp.finding.related_resources[0].resource_type #=> String, one of "DEVICE_CERTIFICATE", "CA_CERTIFICATE", "IOT_POLICY", "COGNITO_IDENTITY_POOL", "CLIENT_ID", "ACCOUNT_SETTINGS"
|
2736
|
+
# resp.finding.related_resources[0].resource_identifier.device_certificate_id #=> String
|
2737
|
+
# resp.finding.related_resources[0].resource_identifier.ca_certificate_id #=> String
|
2738
|
+
# resp.finding.related_resources[0].resource_identifier.cognito_identity_pool_id #=> String
|
2739
|
+
# resp.finding.related_resources[0].resource_identifier.client_id #=> String
|
2740
|
+
# resp.finding.related_resources[0].resource_identifier.policy_version_identifier.policy_name #=> String
|
2741
|
+
# resp.finding.related_resources[0].resource_identifier.policy_version_identifier.policy_version_id #=> String
|
2742
|
+
# resp.finding.related_resources[0].resource_identifier.account #=> String
|
2743
|
+
# resp.finding.related_resources[0].additional_info #=> Hash
|
2744
|
+
# resp.finding.related_resources[0].additional_info["String"] #=> String
|
2745
|
+
# resp.finding.reason_for_non_compliance #=> String
|
2746
|
+
# resp.finding.reason_for_non_compliance_code #=> String
|
2747
|
+
#
|
2748
|
+
# @overload describe_audit_finding(params = {})
|
2749
|
+
# @param [Hash] params ({})
|
2750
|
+
def describe_audit_finding(params = {}, options = {})
|
2751
|
+
req = build_request(:describe_audit_finding, params)
|
2752
|
+
req.send_request(options)
|
2753
|
+
end
|
2754
|
+
|
2755
|
+
# Gets information about an audit mitigation task that is used to apply
|
2756
|
+
# mitigation actions to a set of audit findings. Properties include the
|
2757
|
+
# actions being applied, the audit checks to which they're being
|
2758
|
+
# applied, the task status, and aggregated task statistics.
|
2759
|
+
#
|
2760
|
+
# @option params [required, String] :task_id
|
2761
|
+
# The unique identifier for the audit mitigation task.
|
2762
|
+
#
|
2763
|
+
# @return [Types::DescribeAuditMitigationActionsTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2764
|
+
#
|
2765
|
+
# * {Types::DescribeAuditMitigationActionsTaskResponse#task_status #task_status} => String
|
2766
|
+
# * {Types::DescribeAuditMitigationActionsTaskResponse#start_time #start_time} => Time
|
2767
|
+
# * {Types::DescribeAuditMitigationActionsTaskResponse#end_time #end_time} => Time
|
2768
|
+
# * {Types::DescribeAuditMitigationActionsTaskResponse#task_statistics #task_statistics} => Hash<String,Types::TaskStatisticsForAuditCheck>
|
2769
|
+
# * {Types::DescribeAuditMitigationActionsTaskResponse#target #target} => Types::AuditMitigationActionsTaskTarget
|
2770
|
+
# * {Types::DescribeAuditMitigationActionsTaskResponse#audit_check_to_actions_mapping #audit_check_to_actions_mapping} => Hash<String,Array<String>>
|
2771
|
+
# * {Types::DescribeAuditMitigationActionsTaskResponse#actions_definition #actions_definition} => Array<Types::MitigationAction>
|
2772
|
+
#
|
2773
|
+
# @example Request syntax with placeholder values
|
2774
|
+
#
|
2775
|
+
# resp = client.describe_audit_mitigation_actions_task({
|
2776
|
+
# task_id: "AuditMitigationActionsTaskId", # required
|
2777
|
+
# })
|
2778
|
+
#
|
2779
|
+
# @example Response structure
|
2780
|
+
#
|
2781
|
+
# resp.task_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED", "CANCELED"
|
2782
|
+
# resp.start_time #=> Time
|
2783
|
+
# resp.end_time #=> Time
|
2784
|
+
# resp.task_statistics #=> Hash
|
2785
|
+
# resp.task_statistics["AuditCheckName"].total_findings_count #=> Integer
|
2786
|
+
# resp.task_statistics["AuditCheckName"].failed_findings_count #=> Integer
|
2787
|
+
# resp.task_statistics["AuditCheckName"].succeeded_findings_count #=> Integer
|
2788
|
+
# resp.task_statistics["AuditCheckName"].skipped_findings_count #=> Integer
|
2789
|
+
# resp.task_statistics["AuditCheckName"].canceled_findings_count #=> Integer
|
2790
|
+
# resp.target.audit_task_id #=> String
|
2791
|
+
# resp.target.finding_ids #=> Array
|
2792
|
+
# resp.target.finding_ids[0] #=> String
|
2793
|
+
# resp.target.audit_check_to_reason_code_filter #=> Hash
|
2794
|
+
# resp.target.audit_check_to_reason_code_filter["AuditCheckName"] #=> Array
|
2795
|
+
# resp.target.audit_check_to_reason_code_filter["AuditCheckName"][0] #=> String
|
2796
|
+
# resp.audit_check_to_actions_mapping #=> Hash
|
2797
|
+
# resp.audit_check_to_actions_mapping["AuditCheckName"] #=> Array
|
2798
|
+
# resp.audit_check_to_actions_mapping["AuditCheckName"][0] #=> String
|
2799
|
+
# resp.actions_definition #=> Array
|
2800
|
+
# resp.actions_definition[0].name #=> String
|
2801
|
+
# resp.actions_definition[0].id #=> String
|
2802
|
+
# resp.actions_definition[0].role_arn #=> String
|
2803
|
+
# resp.actions_definition[0].action_params.update_device_certificate_params.action #=> String, one of "DEACTIVATE"
|
2804
|
+
# resp.actions_definition[0].action_params.update_ca_certificate_params.action #=> String, one of "DEACTIVATE"
|
2805
|
+
# resp.actions_definition[0].action_params.add_things_to_thing_group_params.thing_group_names #=> Array
|
2806
|
+
# resp.actions_definition[0].action_params.add_things_to_thing_group_params.thing_group_names[0] #=> String
|
2807
|
+
# resp.actions_definition[0].action_params.add_things_to_thing_group_params.override_dynamic_groups #=> Boolean
|
2808
|
+
# resp.actions_definition[0].action_params.replace_default_policy_version_params.template_name #=> String, one of "BLANK_POLICY"
|
2809
|
+
# resp.actions_definition[0].action_params.enable_io_t_logging_params.role_arn_for_logging #=> String
|
2810
|
+
# resp.actions_definition[0].action_params.enable_io_t_logging_params.log_level #=> String, one of "DEBUG", "INFO", "ERROR", "WARN", "DISABLED"
|
2811
|
+
# resp.actions_definition[0].action_params.publish_finding_to_sns_params.topic_arn #=> String
|
2812
|
+
#
|
2813
|
+
# @overload describe_audit_mitigation_actions_task(params = {})
|
2814
|
+
# @param [Hash] params ({})
|
2815
|
+
def describe_audit_mitigation_actions_task(params = {}, options = {})
|
2816
|
+
req = build_request(:describe_audit_mitigation_actions_task, params)
|
2817
|
+
req.send_request(options)
|
2818
|
+
end
|
2819
|
+
|
2586
2820
|
# Gets information about a Device Defender audit.
|
2587
2821
|
#
|
2588
2822
|
# @option params [required, String] :task_id
|
@@ -3017,6 +3251,54 @@ module Aws::IoT
|
|
3017
3251
|
req.send_request(options)
|
3018
3252
|
end
|
3019
3253
|
|
3254
|
+
# Gets information about a mitigation action.
|
3255
|
+
#
|
3256
|
+
# @option params [required, String] :action_name
|
3257
|
+
# The friendly name that uniquely identifies the mitigation action.
|
3258
|
+
#
|
3259
|
+
# @return [Types::DescribeMitigationActionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3260
|
+
#
|
3261
|
+
# * {Types::DescribeMitigationActionResponse#action_name #action_name} => String
|
3262
|
+
# * {Types::DescribeMitigationActionResponse#action_type #action_type} => String
|
3263
|
+
# * {Types::DescribeMitigationActionResponse#action_arn #action_arn} => String
|
3264
|
+
# * {Types::DescribeMitigationActionResponse#action_id #action_id} => String
|
3265
|
+
# * {Types::DescribeMitigationActionResponse#role_arn #role_arn} => String
|
3266
|
+
# * {Types::DescribeMitigationActionResponse#action_params #action_params} => Types::MitigationActionParams
|
3267
|
+
# * {Types::DescribeMitigationActionResponse#creation_date #creation_date} => Time
|
3268
|
+
# * {Types::DescribeMitigationActionResponse#last_modified_date #last_modified_date} => Time
|
3269
|
+
#
|
3270
|
+
# @example Request syntax with placeholder values
|
3271
|
+
#
|
3272
|
+
# resp = client.describe_mitigation_action({
|
3273
|
+
# action_name: "MitigationActionName", # required
|
3274
|
+
# })
|
3275
|
+
#
|
3276
|
+
# @example Response structure
|
3277
|
+
#
|
3278
|
+
# resp.action_name #=> String
|
3279
|
+
# resp.action_type #=> String, one of "UPDATE_DEVICE_CERTIFICATE", "UPDATE_CA_CERTIFICATE", "ADD_THINGS_TO_THING_GROUP", "REPLACE_DEFAULT_POLICY_VERSION", "ENABLE_IOT_LOGGING", "PUBLISH_FINDING_TO_SNS"
|
3280
|
+
# resp.action_arn #=> String
|
3281
|
+
# resp.action_id #=> String
|
3282
|
+
# resp.role_arn #=> String
|
3283
|
+
# resp.action_params.update_device_certificate_params.action #=> String, one of "DEACTIVATE"
|
3284
|
+
# resp.action_params.update_ca_certificate_params.action #=> String, one of "DEACTIVATE"
|
3285
|
+
# resp.action_params.add_things_to_thing_group_params.thing_group_names #=> Array
|
3286
|
+
# resp.action_params.add_things_to_thing_group_params.thing_group_names[0] #=> String
|
3287
|
+
# resp.action_params.add_things_to_thing_group_params.override_dynamic_groups #=> Boolean
|
3288
|
+
# resp.action_params.replace_default_policy_version_params.template_name #=> String, one of "BLANK_POLICY"
|
3289
|
+
# resp.action_params.enable_io_t_logging_params.role_arn_for_logging #=> String
|
3290
|
+
# resp.action_params.enable_io_t_logging_params.log_level #=> String, one of "DEBUG", "INFO", "ERROR", "WARN", "DISABLED"
|
3291
|
+
# resp.action_params.publish_finding_to_sns_params.topic_arn #=> String
|
3292
|
+
# resp.creation_date #=> Time
|
3293
|
+
# resp.last_modified_date #=> Time
|
3294
|
+
#
|
3295
|
+
# @overload describe_mitigation_action(params = {})
|
3296
|
+
# @param [Hash] params ({})
|
3297
|
+
def describe_mitigation_action(params = {}, options = {})
|
3298
|
+
req = build_request(:describe_mitigation_action, params)
|
3299
|
+
req.send_request(options)
|
3300
|
+
end
|
3301
|
+
|
3020
3302
|
# Describes a role alias.
|
3021
3303
|
#
|
3022
3304
|
# @option params [required, String] :role_alias
|
@@ -4013,7 +4295,7 @@ module Aws::IoT
|
|
4013
4295
|
# @example Request syntax with placeholder values
|
4014
4296
|
#
|
4015
4297
|
# resp = client.list_active_violations({
|
4016
|
-
# thing_name: "
|
4298
|
+
# thing_name: "DeviceDefenderThingName",
|
4017
4299
|
# security_profile_name: "SecurityProfileName",
|
4018
4300
|
# next_token: "NextToken",
|
4019
4301
|
# max_results: 1,
|
@@ -4108,7 +4390,7 @@ module Aws::IoT
|
|
4108
4390
|
# check.
|
4109
4391
|
#
|
4110
4392
|
# @option params [Types::ResourceIdentifier] :resource_identifier
|
4111
|
-
# Information identifying the
|
4393
|
+
# Information identifying the noncompliant resource.
|
4112
4394
|
#
|
4113
4395
|
# @option params [Integer] :max_results
|
4114
4396
|
# The maximum number of results to return at one time. The default is
|
@@ -4157,6 +4439,7 @@ module Aws::IoT
|
|
4157
4439
|
# @example Response structure
|
4158
4440
|
#
|
4159
4441
|
# resp.findings #=> Array
|
4442
|
+
# resp.findings[0].finding_id #=> String
|
4160
4443
|
# resp.findings[0].task_id #=> String
|
4161
4444
|
# resp.findings[0].check_name #=> String
|
4162
4445
|
# resp.findings[0].task_start_time #=> Time
|
@@ -4194,13 +4477,131 @@ module Aws::IoT
|
|
4194
4477
|
req.send_request(options)
|
4195
4478
|
end
|
4196
4479
|
|
4480
|
+
# Gets the status of audit mitigation action tasks that were executed.
|
4481
|
+
#
|
4482
|
+
# @option params [required, String] :task_id
|
4483
|
+
# Specify this filter to limit results to actions for a specific audit
|
4484
|
+
# mitigation actions task.
|
4485
|
+
#
|
4486
|
+
# @option params [String] :action_status
|
4487
|
+
# Specify this filter to limit results to those with a specific status.
|
4488
|
+
#
|
4489
|
+
# @option params [required, String] :finding_id
|
4490
|
+
# Specify this filter to limit results to those that were applied to a
|
4491
|
+
# specific audit finding.
|
4492
|
+
#
|
4493
|
+
# @option params [Integer] :max_results
|
4494
|
+
# The maximum number of results to return at one time. The default is
|
4495
|
+
# 25.
|
4496
|
+
#
|
4497
|
+
# @option params [String] :next_token
|
4498
|
+
# The token for the next set of results.
|
4499
|
+
#
|
4500
|
+
# @return [Types::ListAuditMitigationActionsExecutionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4501
|
+
#
|
4502
|
+
# * {Types::ListAuditMitigationActionsExecutionsResponse#actions_executions #actions_executions} => Array<Types::AuditMitigationActionExecutionMetadata>
|
4503
|
+
# * {Types::ListAuditMitigationActionsExecutionsResponse#next_token #next_token} => String
|
4504
|
+
#
|
4505
|
+
# @example Request syntax with placeholder values
|
4506
|
+
#
|
4507
|
+
# resp = client.list_audit_mitigation_actions_executions({
|
4508
|
+
# task_id: "AuditMitigationActionsTaskId", # required
|
4509
|
+
# action_status: "IN_PROGRESS", # accepts IN_PROGRESS, COMPLETED, FAILED, CANCELED, SKIPPED, PENDING
|
4510
|
+
# finding_id: "FindingId", # required
|
4511
|
+
# max_results: 1,
|
4512
|
+
# next_token: "NextToken",
|
4513
|
+
# })
|
4514
|
+
#
|
4515
|
+
# @example Response structure
|
4516
|
+
#
|
4517
|
+
# resp.actions_executions #=> Array
|
4518
|
+
# resp.actions_executions[0].task_id #=> String
|
4519
|
+
# resp.actions_executions[0].finding_id #=> String
|
4520
|
+
# resp.actions_executions[0].action_name #=> String
|
4521
|
+
# resp.actions_executions[0].action_id #=> String
|
4522
|
+
# resp.actions_executions[0].status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED", "CANCELED", "SKIPPED", "PENDING"
|
4523
|
+
# resp.actions_executions[0].start_time #=> Time
|
4524
|
+
# resp.actions_executions[0].end_time #=> Time
|
4525
|
+
# resp.actions_executions[0].error_code #=> String
|
4526
|
+
# resp.actions_executions[0].message #=> String
|
4527
|
+
# resp.next_token #=> String
|
4528
|
+
#
|
4529
|
+
# @overload list_audit_mitigation_actions_executions(params = {})
|
4530
|
+
# @param [Hash] params ({})
|
4531
|
+
def list_audit_mitigation_actions_executions(params = {}, options = {})
|
4532
|
+
req = build_request(:list_audit_mitigation_actions_executions, params)
|
4533
|
+
req.send_request(options)
|
4534
|
+
end
|
4535
|
+
|
4536
|
+
# Gets a list of audit mitigation action tasks that match the specified
|
4537
|
+
# filters.
|
4538
|
+
#
|
4539
|
+
# @option params [String] :audit_task_id
|
4540
|
+
# Specify this filter to limit results to tasks that were applied to
|
4541
|
+
# results for a specific audit.
|
4542
|
+
#
|
4543
|
+
# @option params [String] :finding_id
|
4544
|
+
# Specify this filter to limit results to tasks that were applied to a
|
4545
|
+
# specific audit finding.
|
4546
|
+
#
|
4547
|
+
# @option params [String] :task_status
|
4548
|
+
# Specify this filter to limit results to tasks that are in a specific
|
4549
|
+
# state.
|
4550
|
+
#
|
4551
|
+
# @option params [Integer] :max_results
|
4552
|
+
# The maximum number of results to return at one time. The default is
|
4553
|
+
# 25.
|
4554
|
+
#
|
4555
|
+
# @option params [String] :next_token
|
4556
|
+
# The token for the next set of results.
|
4557
|
+
#
|
4558
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
4559
|
+
# Specify this filter to limit results to tasks that began on or after a
|
4560
|
+
# specific date and time.
|
4561
|
+
#
|
4562
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
|
4563
|
+
# Specify this filter to limit results to tasks that were completed or
|
4564
|
+
# canceled on or before a specific date and time.
|
4565
|
+
#
|
4566
|
+
# @return [Types::ListAuditMitigationActionsTasksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4567
|
+
#
|
4568
|
+
# * {Types::ListAuditMitigationActionsTasksResponse#tasks #tasks} => Array<Types::AuditMitigationActionsTaskMetadata>
|
4569
|
+
# * {Types::ListAuditMitigationActionsTasksResponse#next_token #next_token} => String
|
4570
|
+
#
|
4571
|
+
# @example Request syntax with placeholder values
|
4572
|
+
#
|
4573
|
+
# resp = client.list_audit_mitigation_actions_tasks({
|
4574
|
+
# audit_task_id: "AuditTaskId",
|
4575
|
+
# finding_id: "FindingId",
|
4576
|
+
# task_status: "IN_PROGRESS", # accepts IN_PROGRESS, COMPLETED, FAILED, CANCELED
|
4577
|
+
# max_results: 1,
|
4578
|
+
# next_token: "NextToken",
|
4579
|
+
# start_time: Time.now, # required
|
4580
|
+
# end_time: Time.now, # required
|
4581
|
+
# })
|
4582
|
+
#
|
4583
|
+
# @example Response structure
|
4584
|
+
#
|
4585
|
+
# resp.tasks #=> Array
|
4586
|
+
# resp.tasks[0].task_id #=> String
|
4587
|
+
# resp.tasks[0].start_time #=> Time
|
4588
|
+
# resp.tasks[0].task_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED", "CANCELED"
|
4589
|
+
# resp.next_token #=> String
|
4590
|
+
#
|
4591
|
+
# @overload list_audit_mitigation_actions_tasks(params = {})
|
4592
|
+
# @param [Hash] params ({})
|
4593
|
+
def list_audit_mitigation_actions_tasks(params = {}, options = {})
|
4594
|
+
req = build_request(:list_audit_mitigation_actions_tasks, params)
|
4595
|
+
req.send_request(options)
|
4596
|
+
end
|
4597
|
+
|
4197
4598
|
# Lists the Device Defender audits that have been performed during a
|
4198
4599
|
# given time period.
|
4199
4600
|
#
|
4200
4601
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
4201
|
-
# The beginning of the time period.
|
4202
|
-
#
|
4203
|
-
#
|
4602
|
+
# The beginning of the time period. Audit information is retained for a
|
4603
|
+
# limited time (180 days). Requesting a start time prior to what is
|
4604
|
+
# retained results in an "InvalidRequestException".
|
4204
4605
|
#
|
4205
4606
|
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
|
4206
4607
|
# The end of the time period.
|
@@ -4211,7 +4612,7 @@ module Aws::IoT
|
|
4211
4612
|
#
|
4212
4613
|
# @option params [String] :task_status
|
4213
4614
|
# A filter to limit the output to audits with the specified completion
|
4214
|
-
# status: can be one of "IN\_PROGRESS", "COMPLETED", "FAILED" or
|
4615
|
+
# status: can be one of "IN\_PROGRESS", "COMPLETED", "FAILED", or
|
4215
4616
|
# "CANCELED".
|
4216
4617
|
#
|
4217
4618
|
# @option params [String] :next_token
|
@@ -4656,6 +5057,48 @@ module Aws::IoT
|
|
4656
5057
|
req.send_request(options)
|
4657
5058
|
end
|
4658
5059
|
|
5060
|
+
# Gets a list of all mitigation actions that match the specified filter
|
5061
|
+
# criteria.
|
5062
|
+
#
|
5063
|
+
# @option params [String] :action_type
|
5064
|
+
# Specify a value to limit the result to mitigation actions with a
|
5065
|
+
# specific action type.
|
5066
|
+
#
|
5067
|
+
# @option params [Integer] :max_results
|
5068
|
+
# The maximum number of results to return at one time. The default is
|
5069
|
+
# 25.
|
5070
|
+
#
|
5071
|
+
# @option params [String] :next_token
|
5072
|
+
# The token for the next set of results.
|
5073
|
+
#
|
5074
|
+
# @return [Types::ListMitigationActionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5075
|
+
#
|
5076
|
+
# * {Types::ListMitigationActionsResponse#action_identifiers #action_identifiers} => Array<Types::MitigationActionIdentifier>
|
5077
|
+
# * {Types::ListMitigationActionsResponse#next_token #next_token} => String
|
5078
|
+
#
|
5079
|
+
# @example Request syntax with placeholder values
|
5080
|
+
#
|
5081
|
+
# resp = client.list_mitigation_actions({
|
5082
|
+
# action_type: "UPDATE_DEVICE_CERTIFICATE", # accepts UPDATE_DEVICE_CERTIFICATE, UPDATE_CA_CERTIFICATE, ADD_THINGS_TO_THING_GROUP, REPLACE_DEFAULT_POLICY_VERSION, ENABLE_IOT_LOGGING, PUBLISH_FINDING_TO_SNS
|
5083
|
+
# max_results: 1,
|
5084
|
+
# next_token: "NextToken",
|
5085
|
+
# })
|
5086
|
+
#
|
5087
|
+
# @example Response structure
|
5088
|
+
#
|
5089
|
+
# resp.action_identifiers #=> Array
|
5090
|
+
# resp.action_identifiers[0].action_name #=> String
|
5091
|
+
# resp.action_identifiers[0].action_arn #=> String
|
5092
|
+
# resp.action_identifiers[0].creation_date #=> Time
|
5093
|
+
# resp.next_token #=> String
|
5094
|
+
#
|
5095
|
+
# @overload list_mitigation_actions(params = {})
|
5096
|
+
# @param [Hash] params ({})
|
5097
|
+
def list_mitigation_actions(params = {}, options = {})
|
5098
|
+
req = build_request(:list_mitigation_actions, params)
|
5099
|
+
req.send_request(options)
|
5100
|
+
end
|
5101
|
+
|
4659
5102
|
# Lists OTA updates.
|
4660
5103
|
#
|
4661
5104
|
# @option params [Integer] :max_results
|
@@ -5064,7 +5507,7 @@ module Aws::IoT
|
|
5064
5507
|
# The maximum number of results to return at one time.
|
5065
5508
|
#
|
5066
5509
|
# @option params [Boolean] :recursive
|
5067
|
-
# If true, return child groups
|
5510
|
+
# If true, return child groups too.
|
5068
5511
|
#
|
5069
5512
|
# @option params [required, String] :security_profile_target_arn
|
5070
5513
|
# The ARN of the target (thing group) whose attached security profiles
|
@@ -5708,7 +6151,7 @@ module Aws::IoT
|
|
5708
6151
|
|
5709
6152
|
# Lists the Device Defender security profile violations discovered
|
5710
6153
|
# during the given time period. You can use filters to limit the results
|
5711
|
-
# to those alerts issued for a particular security profile, behavior or
|
6154
|
+
# to those alerts issued for a particular security profile, behavior, or
|
5712
6155
|
# thing (device).
|
5713
6156
|
#
|
5714
6157
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
@@ -5741,7 +6184,7 @@ module Aws::IoT
|
|
5741
6184
|
# resp = client.list_violation_events({
|
5742
6185
|
# start_time: Time.now, # required
|
5743
6186
|
# end_time: Time.now, # required
|
5744
|
-
# thing_name: "
|
6187
|
+
# thing_name: "DeviceDefenderThingName",
|
5745
6188
|
# security_profile_name: "SecurityProfileName",
|
5746
6189
|
# next_token: "NextToken",
|
5747
6190
|
# max_results: 1,
|
@@ -6444,12 +6887,69 @@ module Aws::IoT
|
|
6444
6887
|
req.send_request(options)
|
6445
6888
|
end
|
6446
6889
|
|
6890
|
+
# Starts a task that applies a set of mitigation actions to the
|
6891
|
+
# specified target.
|
6892
|
+
#
|
6893
|
+
# @option params [required, String] :task_id
|
6894
|
+
# A unique identifier for the task. You can use this identifier to check
|
6895
|
+
# the status of the task or to cancel it.
|
6896
|
+
#
|
6897
|
+
# @option params [required, Types::AuditMitigationActionsTaskTarget] :target
|
6898
|
+
# Specifies the audit findings to which the mitigation actions are
|
6899
|
+
# applied. You can apply them to a type of audit check, to all findings
|
6900
|
+
# from an audit, or to a speecific set of findings.
|
6901
|
+
#
|
6902
|
+
# @option params [required, Hash<String,Array>] :audit_check_to_actions_mapping
|
6903
|
+
# For an audit check, specifies which mitigation actions to apply. Those
|
6904
|
+
# actions must be defined in your AWS account.
|
6905
|
+
#
|
6906
|
+
# @option params [required, String] :client_request_token
|
6907
|
+
# Each audit mitigation task must have a unique client request token. If
|
6908
|
+
# you try to start a new task with the same token as a task that already
|
6909
|
+
# exists, an exception occurs. If you omit this value, a unique client
|
6910
|
+
# request token is generated automatically.
|
6911
|
+
#
|
6912
|
+
# **A suitable default value is auto-generated.** You should normally
|
6913
|
+
# not need to pass this option.**
|
6914
|
+
#
|
6915
|
+
# @return [Types::StartAuditMitigationActionsTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6916
|
+
#
|
6917
|
+
# * {Types::StartAuditMitigationActionsTaskResponse#task_id #task_id} => String
|
6918
|
+
#
|
6919
|
+
# @example Request syntax with placeholder values
|
6920
|
+
#
|
6921
|
+
# resp = client.start_audit_mitigation_actions_task({
|
6922
|
+
# task_id: "AuditMitigationActionsTaskId", # required
|
6923
|
+
# target: { # required
|
6924
|
+
# audit_task_id: "AuditTaskId",
|
6925
|
+
# finding_ids: ["FindingId"],
|
6926
|
+
# audit_check_to_reason_code_filter: {
|
6927
|
+
# "AuditCheckName" => ["ReasonForNonComplianceCode"],
|
6928
|
+
# },
|
6929
|
+
# },
|
6930
|
+
# audit_check_to_actions_mapping: { # required
|
6931
|
+
# "AuditCheckName" => ["MitigationActionName"],
|
6932
|
+
# },
|
6933
|
+
# client_request_token: "ClientRequestToken", # required
|
6934
|
+
# })
|
6935
|
+
#
|
6936
|
+
# @example Response structure
|
6937
|
+
#
|
6938
|
+
# resp.task_id #=> String
|
6939
|
+
#
|
6940
|
+
# @overload start_audit_mitigation_actions_task(params = {})
|
6941
|
+
# @param [Hash] params ({})
|
6942
|
+
def start_audit_mitigation_actions_task(params = {}, options = {})
|
6943
|
+
req = build_request(:start_audit_mitigation_actions_task, params)
|
6944
|
+
req.send_request(options)
|
6945
|
+
end
|
6946
|
+
|
6447
6947
|
# Starts an on-demand Device Defender audit.
|
6448
6948
|
#
|
6449
6949
|
# @option params [required, Array<String>] :target_check_names
|
6450
6950
|
# Which checks are performed during the audit. The checks you specify
|
6451
6951
|
# must be enabled for your account or an exception occurs. Use
|
6452
|
-
# `DescribeAccountAuditConfiguration` to see the list of all checks
|
6952
|
+
# `DescribeAccountAuditConfiguration` to see the list of all checks,
|
6453
6953
|
# including those that are enabled or `UpdateAccountAuditConfiguration`
|
6454
6954
|
# to select which checks are enabled.
|
6455
6955
|
#
|
@@ -6759,7 +7259,7 @@ module Aws::IoT
|
|
6759
7259
|
# @option params [String] :role_arn
|
6760
7260
|
# The ARN of the role that grants permission to AWS IoT to access
|
6761
7261
|
# information about your devices, policies, certificates and other items
|
6762
|
-
# as
|
7262
|
+
# as required when performing an audit.
|
6763
7263
|
#
|
6764
7264
|
# @option params [Hash<String,Types::AuditNotificationTarget>] :audit_notification_target_configurations
|
6765
7265
|
# Information about the targets to which audit notifications are sent.
|
@@ -6767,17 +7267,17 @@ module Aws::IoT
|
|
6767
7267
|
# @option params [Hash<String,Types::AuditCheckConfiguration>] :audit_check_configurations
|
6768
7268
|
# Specifies which audit checks are enabled and disabled for this
|
6769
7269
|
# account. Use `DescribeAccountAuditConfiguration` to see the list of
|
6770
|
-
# all checks including those that are currently enabled.
|
7270
|
+
# all checks, including those that are currently enabled.
|
6771
7271
|
#
|
6772
|
-
#
|
6773
|
-
#
|
6774
|
-
#
|
7272
|
+
# Some data collection might start immediately when certain checks are
|
7273
|
+
# enabled. When a check is disabled, any data collected so far in
|
7274
|
+
# relation to the check is deleted.
|
6775
7275
|
#
|
6776
7276
|
# You cannot disable a check if it is used by any scheduled audit. You
|
6777
7277
|
# must first delete the check from the scheduled audit or delete the
|
6778
7278
|
# scheduled audit itself.
|
6779
7279
|
#
|
6780
|
-
# On the first call to `UpdateAccountAuditConfiguration
|
7280
|
+
# On the first call to `UpdateAccountAuditConfiguration`, this parameter
|
6781
7281
|
# is required and must specify at least one enabled check.
|
6782
7282
|
#
|
6783
7283
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -6911,7 +7411,7 @@ module Aws::IoT
|
|
6911
7411
|
# Information about the registration configuration.
|
6912
7412
|
#
|
6913
7413
|
# @option params [Boolean] :remove_auto_registration
|
6914
|
-
# If true,
|
7414
|
+
# If true, removes auto registration.
|
6915
7415
|
#
|
6916
7416
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6917
7417
|
#
|
@@ -7159,6 +7659,65 @@ module Aws::IoT
|
|
7159
7659
|
req.send_request(options)
|
7160
7660
|
end
|
7161
7661
|
|
7662
|
+
# Updates the definition for the specified mitigation action.
|
7663
|
+
#
|
7664
|
+
# @option params [required, String] :action_name
|
7665
|
+
# The friendly name for the mitigation action. You can't change the
|
7666
|
+
# name by using `UpdateMitigationAction`. Instead, you must delete and
|
7667
|
+
# re-create the mitigation action with the new name.
|
7668
|
+
#
|
7669
|
+
# @option params [String] :role_arn
|
7670
|
+
# The ARN of the IAM role that is used to apply the mitigation action.
|
7671
|
+
#
|
7672
|
+
# @option params [Types::MitigationActionParams] :action_params
|
7673
|
+
# Defines the type of action and the parameters for that action.
|
7674
|
+
#
|
7675
|
+
# @return [Types::UpdateMitigationActionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7676
|
+
#
|
7677
|
+
# * {Types::UpdateMitigationActionResponse#action_arn #action_arn} => String
|
7678
|
+
# * {Types::UpdateMitigationActionResponse#action_id #action_id} => String
|
7679
|
+
#
|
7680
|
+
# @example Request syntax with placeholder values
|
7681
|
+
#
|
7682
|
+
# resp = client.update_mitigation_action({
|
7683
|
+
# action_name: "MitigationActionName", # required
|
7684
|
+
# role_arn: "RoleArn",
|
7685
|
+
# action_params: {
|
7686
|
+
# update_device_certificate_params: {
|
7687
|
+
# action: "DEACTIVATE", # required, accepts DEACTIVATE
|
7688
|
+
# },
|
7689
|
+
# update_ca_certificate_params: {
|
7690
|
+
# action: "DEACTIVATE", # required, accepts DEACTIVATE
|
7691
|
+
# },
|
7692
|
+
# add_things_to_thing_group_params: {
|
7693
|
+
# thing_group_names: ["ThingGroupName"], # required
|
7694
|
+
# override_dynamic_groups: false,
|
7695
|
+
# },
|
7696
|
+
# replace_default_policy_version_params: {
|
7697
|
+
# template_name: "BLANK_POLICY", # required, accepts BLANK_POLICY
|
7698
|
+
# },
|
7699
|
+
# enable_io_t_logging_params: {
|
7700
|
+
# role_arn_for_logging: "RoleArn", # required
|
7701
|
+
# log_level: "DEBUG", # required, accepts DEBUG, INFO, ERROR, WARN, DISABLED
|
7702
|
+
# },
|
7703
|
+
# publish_finding_to_sns_params: {
|
7704
|
+
# topic_arn: "SnsTopicArn", # required
|
7705
|
+
# },
|
7706
|
+
# },
|
7707
|
+
# })
|
7708
|
+
#
|
7709
|
+
# @example Response structure
|
7710
|
+
#
|
7711
|
+
# resp.action_arn #=> String
|
7712
|
+
# resp.action_id #=> String
|
7713
|
+
#
|
7714
|
+
# @overload update_mitigation_action(params = {})
|
7715
|
+
# @param [Hash] params ({})
|
7716
|
+
def update_mitigation_action(params = {}, options = {})
|
7717
|
+
req = build_request(:update_mitigation_action, params)
|
7718
|
+
req.send_request(options)
|
7719
|
+
end
|
7720
|
+
|
7162
7721
|
# Updates a role alias.
|
7163
7722
|
#
|
7164
7723
|
# @option params [required, String] :role_alias
|
@@ -7195,13 +7754,13 @@ module Aws::IoT
|
|
7195
7754
|
req.send_request(options)
|
7196
7755
|
end
|
7197
7756
|
|
7198
|
-
# Updates a scheduled audit, including
|
7199
|
-
# often the audit takes place.
|
7757
|
+
# Updates a scheduled audit, including which checks are performed and
|
7758
|
+
# how often the audit takes place.
|
7200
7759
|
#
|
7201
7760
|
# @option params [String] :frequency
|
7202
7761
|
# How often the scheduled audit takes place. Can be one of "DAILY",
|
7203
|
-
# "WEEKLY", "BIWEEKLY" or "MONTHLY". The
|
7204
|
-
#
|
7762
|
+
# "WEEKLY", "BIWEEKLY", or "MONTHLY". The start time of each audit
|
7763
|
+
# is determined by the system.
|
7205
7764
|
#
|
7206
7765
|
# @option params [String] :day_of_month
|
7207
7766
|
# The day of the month on which the scheduled audit takes place. Can be
|
@@ -7212,14 +7771,14 @@ module Aws::IoT
|
|
7212
7771
|
#
|
7213
7772
|
# @option params [String] :day_of_week
|
7214
7773
|
# The day of the week on which the scheduled audit takes place. Can be
|
7215
|
-
# one of "SUN", "MON", "TUE", "WED", "THU", "FRI" or
|
7774
|
+
# one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or
|
7216
7775
|
# "SAT". This field is required if the "frequency" parameter is set
|
7217
7776
|
# to "WEEKLY" or "BIWEEKLY".
|
7218
7777
|
#
|
7219
7778
|
# @option params [Array<String>] :target_check_names
|
7220
7779
|
# Which checks are performed during the scheduled audit. Checks must be
|
7221
7780
|
# enabled for your account. (Use `DescribeAccountAuditConfiguration` to
|
7222
|
-
# see the list of all checks including those that are enabled or
|
7781
|
+
# see the list of all checks, including those that are enabled or use
|
7223
7782
|
# `UpdateAccountAuditConfiguration` to select which checks are enabled.)
|
7224
7783
|
#
|
7225
7784
|
# @option params [required, String] :scheduled_audit_name
|
@@ -7267,28 +7826,28 @@ module Aws::IoT
|
|
7267
7826
|
#
|
7268
7827
|
# @option params [Array<String>] :additional_metrics_to_retain
|
7269
7828
|
# A list of metrics whose data is retained (stored). By default, data is
|
7270
|
-
# retained for any metric used in the profile's `behaviors
|
7829
|
+
# retained for any metric used in the profile's `behaviors`, but it is
|
7271
7830
|
# also retained for any metric specified here.
|
7272
7831
|
#
|
7273
7832
|
# @option params [Boolean] :delete_behaviors
|
7274
7833
|
# If true, delete all `behaviors` defined for this security profile. If
|
7275
|
-
# any `behaviors` are defined in the current invocation an exception
|
7834
|
+
# any `behaviors` are defined in the current invocation, an exception
|
7276
7835
|
# occurs.
|
7277
7836
|
#
|
7278
7837
|
# @option params [Boolean] :delete_alert_targets
|
7279
7838
|
# If true, delete all `alertTargets` defined for this security profile.
|
7280
|
-
# If any `alertTargets` are defined in the current invocation an
|
7839
|
+
# If any `alertTargets` are defined in the current invocation, an
|
7281
7840
|
# exception occurs.
|
7282
7841
|
#
|
7283
7842
|
# @option params [Boolean] :delete_additional_metrics_to_retain
|
7284
7843
|
# If true, delete all `additionalMetricsToRetain` defined for this
|
7285
7844
|
# security profile. If any `additionalMetricsToRetain` are defined in
|
7286
|
-
# the current invocation an exception occurs.
|
7845
|
+
# the current invocation, an exception occurs.
|
7287
7846
|
#
|
7288
7847
|
# @option params [Integer] :expected_version
|
7289
7848
|
# The expected version of the security profile. A new version is
|
7290
7849
|
# generated whenever the security profile is updated. If you specify a
|
7291
|
-
# value that is different
|
7850
|
+
# value that is different from the actual version, a
|
7292
7851
|
# `VersionConflictException` is thrown.
|
7293
7852
|
#
|
7294
7853
|
# @return [Types::UpdateSecurityProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -7620,7 +8179,7 @@ module Aws::IoT
|
|
7620
8179
|
params: params,
|
7621
8180
|
config: config)
|
7622
8181
|
context[:gem_name] = 'aws-sdk-iot'
|
7623
|
-
context[:gem_version] = '1.
|
8182
|
+
context[:gem_version] = '1.36.0'
|
7624
8183
|
Seahorse::Client::Request.new(handlers, context)
|
7625
8184
|
end
|
7626
8185
|
|