aws-sdk-iot 1.23.0 → 1.24.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: a6542ac8b137ad55ee5a705df3ac051fc73a4308
4
- data.tar.gz: 28a06caf66530fc217fac6d4605e931840829874
3
+ metadata.gz: 1ce9fcc89f2b6a3aaa76defd6fe23b27fcc24bcb
4
+ data.tar.gz: 575bcd4e08f43f0f830894c82c27fe3b77abf399
5
5
  SHA512:
6
- metadata.gz: 18f98d0df7b1bd2fae4b04a923d42348613b2268fdff96411e9079150336299b7571854eb7bc73b437f23eebb8ade76e642507dee26cddaa49b68ad0c470439d
7
- data.tar.gz: c24f3ed75edff2cc859a44b39292f6263d4a9b47cb9d30d23fe6263911d0f4ee9d3314d316951a4417a7af29a857ceb2a8bc08954667634814d9f4379e9af99d
6
+ metadata.gz: ffd5349aecf7996969f122d4f5be63bd92523f4bd602e08e3e6abf1e269a505b2621cfc732b97ef4fcfc7d75dd2afd8ac63b10142dd273a5838243c9b8bfba26
7
+ data.tar.gz: 8d479ab4139d45a9c586af19d66349328006562b2a350ece7203214d1de0a267c64c63b980b87eda3226261197e47fed7273d46f6b5038ac14c36f5760386592
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-iot/customizations'
42
42
  # @service
43
43
  module Aws::IoT
44
44
 
45
- GEM_VERSION = '1.23.0'
45
+ GEM_VERSION = '1.24.0'
46
46
 
47
47
  end
@@ -436,7 +436,9 @@ module Aws::IoT
436
436
  req.send_request(options)
437
437
  end
438
438
 
439
- # Attaches the specified principal to the specified thing.
439
+ # Attaches the specified principal to the specified thing. A principal
440
+ # can be X.509 certificates, IAM users, groups, and roles, Amazon
441
+ # Cognito identities or federated identities.
440
442
  #
441
443
  # @option params [required, String] :thing_name
442
444
  # The name of the thing.
@@ -1323,12 +1325,12 @@ module Aws::IoT
1323
1325
  # see the list of all checks including those that are enabled or
1324
1326
  # `UpdateAccountAuditConfiguration` to select which checks are enabled.)
1325
1327
  #
1326
- # @option params [required, String] :scheduled_audit_name
1327
- # The name you want to give to the scheduled audit. (Max. 128 chars)
1328
- #
1329
1328
  # @option params [Array<Types::Tag>] :tags
1330
1329
  # Metadata which can be used to manage the scheduled audit.
1331
1330
  #
1331
+ # @option params [required, String] :scheduled_audit_name
1332
+ # The name you want to give to the scheduled audit. (Max. 128 chars)
1333
+ #
1332
1334
  # @return [Types::CreateScheduledAuditResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1333
1335
  #
1334
1336
  # * {Types::CreateScheduledAuditResponse#scheduled_audit_arn #scheduled_audit_arn} => String
@@ -1340,13 +1342,13 @@ module Aws::IoT
1340
1342
  # day_of_month: "DayOfMonth",
1341
1343
  # day_of_week: "SUN", # accepts SUN, MON, TUE, WED, THU, FRI, SAT
1342
1344
  # target_check_names: ["AuditCheckName"], # required
1343
- # scheduled_audit_name: "ScheduledAuditName", # required
1344
1345
  # tags: [
1345
1346
  # {
1346
1347
  # key: "TagKey",
1347
1348
  # value: "TagValue",
1348
1349
  # },
1349
1350
  # ],
1351
+ # scheduled_audit_name: "ScheduledAuditName", # required
1350
1352
  # })
1351
1353
  #
1352
1354
  # @example Response structure
@@ -1368,7 +1370,7 @@ module Aws::IoT
1368
1370
  # @option params [String] :security_profile_description
1369
1371
  # A description of the security profile.
1370
1372
  #
1371
- # @option params [required, Array<Types::Behavior>] :behaviors
1373
+ # @option params [Array<Types::Behavior>] :behaviors
1372
1374
  # Specifies the behaviors that, when violated by a device (thing), cause
1373
1375
  # an alert.
1374
1376
  #
@@ -1377,6 +1379,11 @@ module Aws::IoT
1377
1379
  # always sent to the console.) Alerts are generated when a device
1378
1380
  # (thing) violates a behavior.
1379
1381
  #
1382
+ # @option params [Array<String>] :additional_metrics_to_retain
1383
+ # A list of metrics whose data is retained (stored). By default, data is
1384
+ # retained for any metric used in the profile's `behaviors` but it is
1385
+ # also retained for any metric specified here.
1386
+ #
1380
1387
  # @option params [Array<Types::Tag>] :tags
1381
1388
  # Metadata which can be used to manage the security profile.
1382
1389
  #
@@ -1390,7 +1397,7 @@ module Aws::IoT
1390
1397
  # resp = client.create_security_profile({
1391
1398
  # security_profile_name: "SecurityProfileName", # required
1392
1399
  # security_profile_description: "SecurityProfileDescription",
1393
- # behaviors: [ # required
1400
+ # behaviors: [
1394
1401
  # {
1395
1402
  # name: "BehaviorName", # required
1396
1403
  # metric: "BehaviorMetric",
@@ -1402,6 +1409,11 @@ module Aws::IoT
1402
1409
  # ports: [1],
1403
1410
  # },
1404
1411
  # duration_seconds: 1,
1412
+ # consecutive_datapoints_to_alarm: 1,
1413
+ # consecutive_datapoints_to_clear: 1,
1414
+ # statistical_threshold: {
1415
+ # statistic: "EvaluationStatistic",
1416
+ # },
1405
1417
  # },
1406
1418
  # },
1407
1419
  # ],
@@ -1411,6 +1423,7 @@ module Aws::IoT
1411
1423
  # role_arn: "RoleArn", # required
1412
1424
  # },
1413
1425
  # },
1426
+ # additional_metrics_to_retain: ["BehaviorMetric"],
1414
1427
  # tags: [
1415
1428
  # {
1416
1429
  # key: "TagKey",
@@ -3015,6 +3028,7 @@ module Aws::IoT
3015
3028
  # * {Types::DescribeSecurityProfileResponse#security_profile_description #security_profile_description} => String
3016
3029
  # * {Types::DescribeSecurityProfileResponse#behaviors #behaviors} => Array&lt;Types::Behavior&gt;
3017
3030
  # * {Types::DescribeSecurityProfileResponse#alert_targets #alert_targets} => Hash&lt;String,Types::AlertTarget&gt;
3031
+ # * {Types::DescribeSecurityProfileResponse#additional_metrics_to_retain #additional_metrics_to_retain} => Array&lt;String&gt;
3018
3032
  # * {Types::DescribeSecurityProfileResponse#version #version} => Integer
3019
3033
  # * {Types::DescribeSecurityProfileResponse#creation_date #creation_date} => Time
3020
3034
  # * {Types::DescribeSecurityProfileResponse#last_modified_date #last_modified_date} => Time
@@ -3040,9 +3054,14 @@ module Aws::IoT
3040
3054
  # resp.behaviors[0].criteria.value.ports #=> Array
3041
3055
  # resp.behaviors[0].criteria.value.ports[0] #=> Integer
3042
3056
  # resp.behaviors[0].criteria.duration_seconds #=> Integer
3057
+ # resp.behaviors[0].criteria.consecutive_datapoints_to_alarm #=> Integer
3058
+ # resp.behaviors[0].criteria.consecutive_datapoints_to_clear #=> Integer
3059
+ # resp.behaviors[0].criteria.statistical_threshold.statistic #=> String
3043
3060
  # resp.alert_targets #=> Hash
3044
3061
  # resp.alert_targets["AlertTargetType"].alert_target_arn #=> String
3045
3062
  # resp.alert_targets["AlertTargetType"].role_arn #=> String
3063
+ # resp.additional_metrics_to_retain #=> Array
3064
+ # resp.additional_metrics_to_retain[0] #=> String
3046
3065
  # resp.version #=> Integer
3047
3066
  # resp.creation_date #=> Time
3048
3067
  # resp.last_modified_date #=> Time
@@ -3348,7 +3367,9 @@ module Aws::IoT
3348
3367
  req.send_request(options)
3349
3368
  end
3350
3369
 
3351
- # Detaches the specified principal from the specified thing.
3370
+ # Detaches the specified principal from the specified thing. A principal
3371
+ # can be X.509 certificates, IAM users, groups, and roles, Amazon
3372
+ # Cognito identities or federated identities.
3352
3373
  #
3353
3374
  # <note markdown="1"> This call is asynchronous. It might take several seconds for the
3354
3375
  # detachment to propagate.
@@ -3904,6 +3925,9 @@ module Aws::IoT
3904
3925
  # resp.active_violations[0].behavior.criteria.value.ports #=> Array
3905
3926
  # resp.active_violations[0].behavior.criteria.value.ports[0] #=> Integer
3906
3927
  # resp.active_violations[0].behavior.criteria.duration_seconds #=> Integer
3928
+ # resp.active_violations[0].behavior.criteria.consecutive_datapoints_to_alarm #=> Integer
3929
+ # resp.active_violations[0].behavior.criteria.consecutive_datapoints_to_clear #=> Integer
3930
+ # resp.active_violations[0].behavior.criteria.statistical_threshold.statistic #=> String
3907
3931
  # resp.active_violations[0].last_violation_value.count #=> Integer
3908
3932
  # resp.active_violations[0].last_violation_value.cidrs #=> Array
3909
3933
  # resp.active_violations[0].last_violation_value.cidrs[0] #=> String
@@ -4771,7 +4795,9 @@ module Aws::IoT
4771
4795
  req.send_request(options)
4772
4796
  end
4773
4797
 
4774
- # Lists the things associated with the specified principal.
4798
+ # Lists the things associated with the specified principal. A principal
4799
+ # can be X.509 certificates, IAM users, groups, and roles, Amazon
4800
+ # Cognito identities or federated identities.
4775
4801
  #
4776
4802
  # @option params [String] :next_token
4777
4803
  # The token to retrieve the next set of results.
@@ -5199,7 +5225,9 @@ module Aws::IoT
5199
5225
  req.send_request(options)
5200
5226
  end
5201
5227
 
5202
- # Lists the principals associated with the specified thing.
5228
+ # Lists the principals associated with the specified thing. A principal
5229
+ # can be X.509 certificates, IAM users, groups, and roles, Amazon
5230
+ # Cognito identities or federated identities.
5203
5231
  #
5204
5232
  # @option params [required, String] :thing_name
5205
5233
  # The name of the thing.
@@ -5625,6 +5653,9 @@ module Aws::IoT
5625
5653
  # resp.violation_events[0].behavior.criteria.value.ports #=> Array
5626
5654
  # resp.violation_events[0].behavior.criteria.value.ports[0] #=> Integer
5627
5655
  # resp.violation_events[0].behavior.criteria.duration_seconds #=> Integer
5656
+ # resp.violation_events[0].behavior.criteria.consecutive_datapoints_to_alarm #=> Integer
5657
+ # resp.violation_events[0].behavior.criteria.consecutive_datapoints_to_clear #=> Integer
5658
+ # resp.violation_events[0].behavior.criteria.statistical_threshold.statistic #=> String
5628
5659
  # resp.violation_events[0].metric_value.count #=> Integer
5629
5660
  # resp.violation_events[0].metric_value.cidrs #=> Array
5630
5661
  # resp.violation_events[0].metric_value.cidrs[0] #=> String
@@ -7125,6 +7156,26 @@ module Aws::IoT
7125
7156
  # @option params [Hash<String,Types::AlertTarget>] :alert_targets
7126
7157
  # Where the alerts are sent. (Alerts are always sent to the console.)
7127
7158
  #
7159
+ # @option params [Array<String>] :additional_metrics_to_retain
7160
+ # A list of metrics whose data is retained (stored). By default, data is
7161
+ # retained for any metric used in the profile's `behaviors` but it is
7162
+ # also retained for any metric specified here.
7163
+ #
7164
+ # @option params [Boolean] :delete_behaviors
7165
+ # If true, delete all `behaviors` defined for this security profile. If
7166
+ # any `behaviors` are defined in the current invocation an exception
7167
+ # occurs.
7168
+ #
7169
+ # @option params [Boolean] :delete_alert_targets
7170
+ # If true, delete all `alertTargets` defined for this security profile.
7171
+ # If any `alertTargets` are defined in the current invocation an
7172
+ # exception occurs.
7173
+ #
7174
+ # @option params [Boolean] :delete_additional_metrics_to_retain
7175
+ # If true, delete all `additionalMetricsToRetain` defined for this
7176
+ # security profile. If any `additionalMetricsToRetain` are defined in
7177
+ # the current invocation an exception occurs.
7178
+ #
7128
7179
  # @option params [Integer] :expected_version
7129
7180
  # The expected version of the security profile. A new version is
7130
7181
  # generated whenever the security profile is updated. If you specify a
@@ -7138,6 +7189,7 @@ module Aws::IoT
7138
7189
  # * {Types::UpdateSecurityProfileResponse#security_profile_description #security_profile_description} => String
7139
7190
  # * {Types::UpdateSecurityProfileResponse#behaviors #behaviors} => Array&lt;Types::Behavior&gt;
7140
7191
  # * {Types::UpdateSecurityProfileResponse#alert_targets #alert_targets} => Hash&lt;String,Types::AlertTarget&gt;
7192
+ # * {Types::UpdateSecurityProfileResponse#additional_metrics_to_retain #additional_metrics_to_retain} => Array&lt;String&gt;
7141
7193
  # * {Types::UpdateSecurityProfileResponse#version #version} => Integer
7142
7194
  # * {Types::UpdateSecurityProfileResponse#creation_date #creation_date} => Time
7143
7195
  # * {Types::UpdateSecurityProfileResponse#last_modified_date #last_modified_date} => Time
@@ -7159,6 +7211,11 @@ module Aws::IoT
7159
7211
  # ports: [1],
7160
7212
  # },
7161
7213
  # duration_seconds: 1,
7214
+ # consecutive_datapoints_to_alarm: 1,
7215
+ # consecutive_datapoints_to_clear: 1,
7216
+ # statistical_threshold: {
7217
+ # statistic: "EvaluationStatistic",
7218
+ # },
7162
7219
  # },
7163
7220
  # },
7164
7221
  # ],
@@ -7168,6 +7225,10 @@ module Aws::IoT
7168
7225
  # role_arn: "RoleArn", # required
7169
7226
  # },
7170
7227
  # },
7228
+ # additional_metrics_to_retain: ["BehaviorMetric"],
7229
+ # delete_behaviors: false,
7230
+ # delete_alert_targets: false,
7231
+ # delete_additional_metrics_to_retain: false,
7171
7232
  # expected_version: 1,
7172
7233
  # })
7173
7234
  #
@@ -7186,9 +7247,14 @@ module Aws::IoT
7186
7247
  # resp.behaviors[0].criteria.value.ports #=> Array
7187
7248
  # resp.behaviors[0].criteria.value.ports[0] #=> Integer
7188
7249
  # resp.behaviors[0].criteria.duration_seconds #=> Integer
7250
+ # resp.behaviors[0].criteria.consecutive_datapoints_to_alarm #=> Integer
7251
+ # resp.behaviors[0].criteria.consecutive_datapoints_to_clear #=> Integer
7252
+ # resp.behaviors[0].criteria.statistical_threshold.statistic #=> String
7189
7253
  # resp.alert_targets #=> Hash
7190
7254
  # resp.alert_targets["AlertTargetType"].alert_target_arn #=> String
7191
7255
  # resp.alert_targets["AlertTargetType"].role_arn #=> String
7256
+ # resp.additional_metrics_to_retain #=> Array
7257
+ # resp.additional_metrics_to_retain[0] #=> String
7192
7258
  # resp.version #=> Integer
7193
7259
  # resp.creation_date #=> Time
7194
7260
  # resp.last_modified_date #=> Time
@@ -7409,6 +7475,11 @@ module Aws::IoT
7409
7475
  # ports: [1],
7410
7476
  # },
7411
7477
  # duration_seconds: 1,
7478
+ # consecutive_datapoints_to_alarm: 1,
7479
+ # consecutive_datapoints_to_clear: 1,
7480
+ # statistical_threshold: {
7481
+ # statistic: "EvaluationStatistic",
7482
+ # },
7412
7483
  # },
7413
7484
  # },
7414
7485
  # ],
@@ -7440,7 +7511,7 @@ module Aws::IoT
7440
7511
  params: params,
7441
7512
  config: config)
7442
7513
  context[:gem_name] = 'aws-sdk-iot'
7443
- context[:gem_version] = '1.23.0'
7514
+ context[:gem_version] = '1.24.0'
7444
7515
  Seahorse::Client::Request.new(handlers, context)
7445
7516
  end
7446
7517
 
@@ -26,6 +26,7 @@ module Aws::IoT
26
26
  AddThingToBillingGroupResponse = Shapes::StructureShape.new(name: 'AddThingToBillingGroupResponse')
27
27
  AddThingToThingGroupRequest = Shapes::StructureShape.new(name: 'AddThingToThingGroupRequest')
28
28
  AddThingToThingGroupResponse = Shapes::StructureShape.new(name: 'AddThingToThingGroupResponse')
29
+ AdditionalMetricsToRetainList = Shapes::ListShape.new(name: 'AdditionalMetricsToRetainList')
29
30
  AdditionalParameterMap = Shapes::MapShape.new(name: 'AdditionalParameterMap')
30
31
  AlarmName = Shapes::StringShape.new(name: 'AlarmName')
31
32
  AlertTarget = Shapes::StructureShape.new(name: 'AlertTarget')
@@ -148,6 +149,8 @@ module Aws::IoT
148
149
  Configuration = Shapes::StructureShape.new(name: 'Configuration')
149
150
  ConflictingResourceUpdateException = Shapes::StructureShape.new(name: 'ConflictingResourceUpdateException')
150
151
  ConnectivityTimestamp = Shapes::IntegerShape.new(name: 'ConnectivityTimestamp')
152
+ ConsecutiveDatapointsToAlarm = Shapes::IntegerShape.new(name: 'ConsecutiveDatapointsToAlarm')
153
+ ConsecutiveDatapointsToClear = Shapes::IntegerShape.new(name: 'ConsecutiveDatapointsToClear')
151
154
  Count = Shapes::IntegerShape.new(name: 'Count')
152
155
  CreateAuthorizerRequest = Shapes::StructureShape.new(name: 'CreateAuthorizerRequest')
153
156
  CreateAuthorizerResponse = Shapes::StructureShape.new(name: 'CreateAuthorizerResponse')
@@ -192,8 +195,11 @@ module Aws::IoT
192
195
  DayOfWeek = Shapes::StringShape.new(name: 'DayOfWeek')
193
196
  DeleteAccountAuditConfigurationRequest = Shapes::StructureShape.new(name: 'DeleteAccountAuditConfigurationRequest')
194
197
  DeleteAccountAuditConfigurationResponse = Shapes::StructureShape.new(name: 'DeleteAccountAuditConfigurationResponse')
198
+ DeleteAdditionalMetricsToRetain = Shapes::BooleanShape.new(name: 'DeleteAdditionalMetricsToRetain')
199
+ DeleteAlertTargets = Shapes::BooleanShape.new(name: 'DeleteAlertTargets')
195
200
  DeleteAuthorizerRequest = Shapes::StructureShape.new(name: 'DeleteAuthorizerRequest')
196
201
  DeleteAuthorizerResponse = Shapes::StructureShape.new(name: 'DeleteAuthorizerResponse')
202
+ DeleteBehaviors = Shapes::BooleanShape.new(name: 'DeleteBehaviors')
197
203
  DeleteBillingGroupRequest = Shapes::StructureShape.new(name: 'DeleteBillingGroupRequest')
198
204
  DeleteBillingGroupResponse = Shapes::StructureShape.new(name: 'DeleteBillingGroupResponse')
199
205
  DeleteCACertificateRequest = Shapes::StructureShape.new(name: 'DeleteCACertificateRequest')
@@ -306,6 +312,7 @@ module Aws::IoT
306
312
  ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
307
313
  ErrorInfo = Shapes::StructureShape.new(name: 'ErrorInfo')
308
314
  ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
315
+ EvaluationStatistic = Shapes::StringShape.new(name: 'EvaluationStatistic')
309
316
  EventConfigurations = Shapes::MapShape.new(name: 'EventConfigurations')
310
317
  EventType = Shapes::StringShape.new(name: 'EventType')
311
318
  ExecutionNamePrefix = Shapes::StringShape.new(name: 'ExecutionNamePrefix')
@@ -675,6 +682,7 @@ module Aws::IoT
675
682
  StateMachineName = Shapes::StringShape.new(name: 'StateMachineName')
676
683
  StateReason = Shapes::StringShape.new(name: 'StateReason')
677
684
  StateValue = Shapes::StringShape.new(name: 'StateValue')
685
+ StatisticalThreshold = Shapes::StructureShape.new(name: 'StatisticalThreshold')
678
686
  Status = Shapes::StringShape.new(name: 'Status')
679
687
  StepFunctionsAction = Shapes::StructureShape.new(name: 'StepFunctionsAction')
680
688
  StopThingRegistrationTaskRequest = Shapes::StructureShape.new(name: 'StopThingRegistrationTaskRequest')
@@ -884,6 +892,8 @@ module Aws::IoT
884
892
 
885
893
  AddThingToThingGroupResponse.struct_class = Types::AddThingToThingGroupResponse
886
894
 
895
+ AdditionalMetricsToRetainList.member = Shapes::ShapeRef.new(shape: BehaviorMetric)
896
+
887
897
  AdditionalParameterMap.key = Shapes::ShapeRef.new(shape: AttributeKey)
888
898
  AdditionalParameterMap.value = Shapes::ShapeRef.new(shape: Value)
889
899
 
@@ -1024,6 +1034,9 @@ module Aws::IoT
1024
1034
  BehaviorCriteria.add_member(:comparison_operator, Shapes::ShapeRef.new(shape: ComparisonOperator, location_name: "comparisonOperator"))
1025
1035
  BehaviorCriteria.add_member(:value, Shapes::ShapeRef.new(shape: MetricValue, location_name: "value"))
1026
1036
  BehaviorCriteria.add_member(:duration_seconds, Shapes::ShapeRef.new(shape: DurationSeconds, location_name: "durationSeconds"))
1037
+ BehaviorCriteria.add_member(:consecutive_datapoints_to_alarm, Shapes::ShapeRef.new(shape: ConsecutiveDatapointsToAlarm, location_name: "consecutiveDatapointsToAlarm"))
1038
+ BehaviorCriteria.add_member(:consecutive_datapoints_to_clear, Shapes::ShapeRef.new(shape: ConsecutiveDatapointsToClear, location_name: "consecutiveDatapointsToClear"))
1039
+ BehaviorCriteria.add_member(:statistical_threshold, Shapes::ShapeRef.new(shape: StatisticalThreshold, location_name: "statisticalThreshold"))
1027
1040
  BehaviorCriteria.struct_class = Types::BehaviorCriteria
1028
1041
 
1029
1042
  Behaviors.member = Shapes::ShapeRef.new(shape: Behavior)
@@ -1269,8 +1282,8 @@ module Aws::IoT
1269
1282
  CreateScheduledAuditRequest.add_member(:day_of_month, Shapes::ShapeRef.new(shape: DayOfMonth, location_name: "dayOfMonth"))
1270
1283
  CreateScheduledAuditRequest.add_member(:day_of_week, Shapes::ShapeRef.new(shape: DayOfWeek, location_name: "dayOfWeek"))
1271
1284
  CreateScheduledAuditRequest.add_member(:target_check_names, Shapes::ShapeRef.new(shape: TargetAuditCheckNames, required: true, location_name: "targetCheckNames"))
1272
- CreateScheduledAuditRequest.add_member(:scheduled_audit_name, Shapes::ShapeRef.new(shape: ScheduledAuditName, required: true, location: "uri", location_name: "scheduledAuditName"))
1273
1285
  CreateScheduledAuditRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags"))
1286
+ CreateScheduledAuditRequest.add_member(:scheduled_audit_name, Shapes::ShapeRef.new(shape: ScheduledAuditName, required: true, location: "uri", location_name: "scheduledAuditName"))
1274
1287
  CreateScheduledAuditRequest.struct_class = Types::CreateScheduledAuditRequest
1275
1288
 
1276
1289
  CreateScheduledAuditResponse.add_member(:scheduled_audit_arn, Shapes::ShapeRef.new(shape: ScheduledAuditArn, location_name: "scheduledAuditArn"))
@@ -1278,8 +1291,9 @@ module Aws::IoT
1278
1291
 
1279
1292
  CreateSecurityProfileRequest.add_member(:security_profile_name, Shapes::ShapeRef.new(shape: SecurityProfileName, required: true, location: "uri", location_name: "securityProfileName"))
1280
1293
  CreateSecurityProfileRequest.add_member(:security_profile_description, Shapes::ShapeRef.new(shape: SecurityProfileDescription, location_name: "securityProfileDescription"))
1281
- CreateSecurityProfileRequest.add_member(:behaviors, Shapes::ShapeRef.new(shape: Behaviors, required: true, location_name: "behaviors"))
1294
+ CreateSecurityProfileRequest.add_member(:behaviors, Shapes::ShapeRef.new(shape: Behaviors, location_name: "behaviors"))
1282
1295
  CreateSecurityProfileRequest.add_member(:alert_targets, Shapes::ShapeRef.new(shape: AlertTargets, location_name: "alertTargets"))
1296
+ CreateSecurityProfileRequest.add_member(:additional_metrics_to_retain, Shapes::ShapeRef.new(shape: AdditionalMetricsToRetainList, location_name: "additionalMetricsToRetain"))
1283
1297
  CreateSecurityProfileRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags"))
1284
1298
  CreateSecurityProfileRequest.struct_class = Types::CreateSecurityProfileRequest
1285
1299
 
@@ -1572,6 +1586,7 @@ module Aws::IoT
1572
1586
  DescribeSecurityProfileResponse.add_member(:security_profile_description, Shapes::ShapeRef.new(shape: SecurityProfileDescription, location_name: "securityProfileDescription"))
1573
1587
  DescribeSecurityProfileResponse.add_member(:behaviors, Shapes::ShapeRef.new(shape: Behaviors, location_name: "behaviors"))
1574
1588
  DescribeSecurityProfileResponse.add_member(:alert_targets, Shapes::ShapeRef.new(shape: AlertTargets, location_name: "alertTargets"))
1589
+ DescribeSecurityProfileResponse.add_member(:additional_metrics_to_retain, Shapes::ShapeRef.new(shape: AdditionalMetricsToRetainList, location_name: "additionalMetricsToRetain"))
1575
1590
  DescribeSecurityProfileResponse.add_member(:version, Shapes::ShapeRef.new(shape: Version, location_name: "version"))
1576
1591
  DescribeSecurityProfileResponse.add_member(:creation_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationDate"))
1577
1592
  DescribeSecurityProfileResponse.add_member(:last_modified_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastModifiedDate"))
@@ -2624,6 +2639,9 @@ module Aws::IoT
2624
2639
  StartThingRegistrationTaskResponse.add_member(:task_id, Shapes::ShapeRef.new(shape: TaskId, location_name: "taskId"))
2625
2640
  StartThingRegistrationTaskResponse.struct_class = Types::StartThingRegistrationTaskResponse
2626
2641
 
2642
+ StatisticalThreshold.add_member(:statistic, Shapes::ShapeRef.new(shape: EvaluationStatistic, location_name: "statistic"))
2643
+ StatisticalThreshold.struct_class = Types::StatisticalThreshold
2644
+
2627
2645
  StepFunctionsAction.add_member(:execution_name_prefix, Shapes::ShapeRef.new(shape: ExecutionNamePrefix, location_name: "executionNamePrefix"))
2628
2646
  StepFunctionsAction.add_member(:state_machine_name, Shapes::ShapeRef.new(shape: StateMachineName, required: true, location_name: "stateMachineName"))
2629
2647
  StepFunctionsAction.add_member(:role_arn, Shapes::ShapeRef.new(shape: AwsArn, required: true, location_name: "roleArn"))
@@ -2932,6 +2950,10 @@ module Aws::IoT
2932
2950
  UpdateSecurityProfileRequest.add_member(:security_profile_description, Shapes::ShapeRef.new(shape: SecurityProfileDescription, location_name: "securityProfileDescription"))
2933
2951
  UpdateSecurityProfileRequest.add_member(:behaviors, Shapes::ShapeRef.new(shape: Behaviors, location_name: "behaviors"))
2934
2952
  UpdateSecurityProfileRequest.add_member(:alert_targets, Shapes::ShapeRef.new(shape: AlertTargets, location_name: "alertTargets"))
2953
+ UpdateSecurityProfileRequest.add_member(:additional_metrics_to_retain, Shapes::ShapeRef.new(shape: AdditionalMetricsToRetainList, location_name: "additionalMetricsToRetain"))
2954
+ UpdateSecurityProfileRequest.add_member(:delete_behaviors, Shapes::ShapeRef.new(shape: DeleteBehaviors, location_name: "deleteBehaviors"))
2955
+ UpdateSecurityProfileRequest.add_member(:delete_alert_targets, Shapes::ShapeRef.new(shape: DeleteAlertTargets, location_name: "deleteAlertTargets"))
2956
+ UpdateSecurityProfileRequest.add_member(:delete_additional_metrics_to_retain, Shapes::ShapeRef.new(shape: DeleteAdditionalMetricsToRetain, location_name: "deleteAdditionalMetricsToRetain"))
2935
2957
  UpdateSecurityProfileRequest.add_member(:expected_version, Shapes::ShapeRef.new(shape: OptionalVersion, location: "querystring", location_name: "expectedVersion"))
2936
2958
  UpdateSecurityProfileRequest.struct_class = Types::UpdateSecurityProfileRequest
2937
2959
 
@@ -2940,6 +2962,7 @@ module Aws::IoT
2940
2962
  UpdateSecurityProfileResponse.add_member(:security_profile_description, Shapes::ShapeRef.new(shape: SecurityProfileDescription, location_name: "securityProfileDescription"))
2941
2963
  UpdateSecurityProfileResponse.add_member(:behaviors, Shapes::ShapeRef.new(shape: Behaviors, location_name: "behaviors"))
2942
2964
  UpdateSecurityProfileResponse.add_member(:alert_targets, Shapes::ShapeRef.new(shape: AlertTargets, location_name: "alertTargets"))
2965
+ UpdateSecurityProfileResponse.add_member(:additional_metrics_to_retain, Shapes::ShapeRef.new(shape: AdditionalMetricsToRetainList, location_name: "additionalMetricsToRetain"))
2943
2966
  UpdateSecurityProfileResponse.add_member(:version, Shapes::ShapeRef.new(shape: Version, location_name: "version"))
2944
2967
  UpdateSecurityProfileResponse.add_member(:creation_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationDate"))
2945
2968
  UpdateSecurityProfileResponse.add_member(:last_modified_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastModifiedDate"))
@@ -958,6 +958,11 @@ module Aws::IoT
958
958
  # ports: [1],
959
959
  # },
960
960
  # duration_seconds: 1,
961
+ # consecutive_datapoints_to_alarm: 1,
962
+ # consecutive_datapoints_to_clear: 1,
963
+ # statistical_threshold: {
964
+ # statistic: "EvaluationStatistic",
965
+ # },
961
966
  # },
962
967
  # }
963
968
  #
@@ -994,11 +999,16 @@ module Aws::IoT
994
999
  # ports: [1],
995
1000
  # },
996
1001
  # duration_seconds: 1,
1002
+ # consecutive_datapoints_to_alarm: 1,
1003
+ # consecutive_datapoints_to_clear: 1,
1004
+ # statistical_threshold: {
1005
+ # statistic: "EvaluationStatistic",
1006
+ # },
997
1007
  # }
998
1008
  #
999
1009
  # @!attribute [rw] comparison_operator
1000
1010
  # The operator that relates the thing measured (`metric`) to the
1001
- # criteria (containing a `value`.
1011
+ # criteria (containing a `value` or `statisticalThreshold`).
1002
1012
  # @return [String]
1003
1013
  #
1004
1014
  # @!attribute [rw] value
@@ -1008,13 +1018,39 @@ module Aws::IoT
1008
1018
  # @!attribute [rw] duration_seconds
1009
1019
  # Use this to specify the time duration over which the behavior is
1010
1020
  # evaluated, for those criteria which have a time dimension (for
1011
- # example, `NUM_MESSAGES_SENT`).
1021
+ # example, `NUM_MESSAGES_SENT`). For a `statisticalThreshhold` metric
1022
+ # comparison, measurements from all devices are accumulated over this
1023
+ # time duration before being used to calculate percentiles, and later,
1024
+ # measurements from an individual device are also accumulated over
1025
+ # this time duration before being given a percentile rank.
1026
+ # @return [Integer]
1027
+ #
1028
+ # @!attribute [rw] consecutive_datapoints_to_alarm
1029
+ # If a device is in violation of the behavior for the specified number
1030
+ # of consecutive datapoints, an alarm occurs. If not specified, the
1031
+ # default is 1.
1012
1032
  # @return [Integer]
1013
1033
  #
1034
+ # @!attribute [rw] consecutive_datapoints_to_clear
1035
+ # If an alarm has occurred and the offending device is no longer in
1036
+ # violation of the behavior for the specified number of consecutive
1037
+ # datapoints, the alarm is cleared. If not specified, the default is
1038
+ # 1.
1039
+ # @return [Integer]
1040
+ #
1041
+ # @!attribute [rw] statistical_threshold
1042
+ # A statistical ranking (percentile) which indicates a threshold value
1043
+ # by which a behavior is determined to be in compliance or in
1044
+ # violation of the behavior.
1045
+ # @return [Types::StatisticalThreshold]
1046
+ #
1014
1047
  class BehaviorCriteria < Struct.new(
1015
1048
  :comparison_operator,
1016
1049
  :value,
1017
- :duration_seconds)
1050
+ :duration_seconds,
1051
+ :consecutive_datapoints_to_alarm,
1052
+ :consecutive_datapoints_to_clear,
1053
+ :statistical_threshold)
1018
1054
  include Aws::Structure
1019
1055
  end
1020
1056
 
@@ -2396,13 +2432,13 @@ module Aws::IoT
2396
2432
  # day_of_month: "DayOfMonth",
2397
2433
  # day_of_week: "SUN", # accepts SUN, MON, TUE, WED, THU, FRI, SAT
2398
2434
  # target_check_names: ["AuditCheckName"], # required
2399
- # scheduled_audit_name: "ScheduledAuditName", # required
2400
2435
  # tags: [
2401
2436
  # {
2402
2437
  # key: "TagKey",
2403
2438
  # value: "TagValue",
2404
2439
  # },
2405
2440
  # ],
2441
+ # scheduled_audit_name: "ScheduledAuditName", # required
2406
2442
  # }
2407
2443
  #
2408
2444
  # @!attribute [rw] frequency
@@ -2435,21 +2471,21 @@ module Aws::IoT
2435
2471
  # enabled.)
2436
2472
  # @return [Array<String>]
2437
2473
  #
2438
- # @!attribute [rw] scheduled_audit_name
2439
- # The name you want to give to the scheduled audit. (Max. 128 chars)
2440
- # @return [String]
2441
- #
2442
2474
  # @!attribute [rw] tags
2443
2475
  # Metadata which can be used to manage the scheduled audit.
2444
2476
  # @return [Array<Types::Tag>]
2445
2477
  #
2478
+ # @!attribute [rw] scheduled_audit_name
2479
+ # The name you want to give to the scheduled audit. (Max. 128 chars)
2480
+ # @return [String]
2481
+ #
2446
2482
  class CreateScheduledAuditRequest < Struct.new(
2447
2483
  :frequency,
2448
2484
  :day_of_month,
2449
2485
  :day_of_week,
2450
2486
  :target_check_names,
2451
- :scheduled_audit_name,
2452
- :tags)
2487
+ :tags,
2488
+ :scheduled_audit_name)
2453
2489
  include Aws::Structure
2454
2490
  end
2455
2491
 
@@ -2468,7 +2504,7 @@ module Aws::IoT
2468
2504
  # {
2469
2505
  # security_profile_name: "SecurityProfileName", # required
2470
2506
  # security_profile_description: "SecurityProfileDescription",
2471
- # behaviors: [ # required
2507
+ # behaviors: [
2472
2508
  # {
2473
2509
  # name: "BehaviorName", # required
2474
2510
  # metric: "BehaviorMetric",
@@ -2480,6 +2516,11 @@ module Aws::IoT
2480
2516
  # ports: [1],
2481
2517
  # },
2482
2518
  # duration_seconds: 1,
2519
+ # consecutive_datapoints_to_alarm: 1,
2520
+ # consecutive_datapoints_to_clear: 1,
2521
+ # statistical_threshold: {
2522
+ # statistic: "EvaluationStatistic",
2523
+ # },
2483
2524
  # },
2484
2525
  # },
2485
2526
  # ],
@@ -2489,6 +2530,7 @@ module Aws::IoT
2489
2530
  # role_arn: "RoleArn", # required
2490
2531
  # },
2491
2532
  # },
2533
+ # additional_metrics_to_retain: ["BehaviorMetric"],
2492
2534
  # tags: [
2493
2535
  # {
2494
2536
  # key: "TagKey",
@@ -2516,6 +2558,12 @@ module Aws::IoT
2516
2558
  # (thing) violates a behavior.
2517
2559
  # @return [Hash<String,Types::AlertTarget>]
2518
2560
  #
2561
+ # @!attribute [rw] additional_metrics_to_retain
2562
+ # A list of metrics whose data is retained (stored). By default, data
2563
+ # is retained for any metric used in the profile's `behaviors` but it
2564
+ # is also retained for any metric specified here.
2565
+ # @return [Array<String>]
2566
+ #
2519
2567
  # @!attribute [rw] tags
2520
2568
  # Metadata which can be used to manage the security profile.
2521
2569
  # @return [Array<Types::Tag>]
@@ -2525,6 +2573,7 @@ module Aws::IoT
2525
2573
  :security_profile_description,
2526
2574
  :behaviors,
2527
2575
  :alert_targets,
2576
+ :additional_metrics_to_retain,
2528
2577
  :tags)
2529
2578
  include Aws::Structure
2530
2579
  end
@@ -4180,6 +4229,12 @@ module Aws::IoT
4180
4229
  # Where the alerts are sent. (Alerts are always sent to the console.)
4181
4230
  # @return [Hash<String,Types::AlertTarget>]
4182
4231
  #
4232
+ # @!attribute [rw] additional_metrics_to_retain
4233
+ # A list of metrics whose data is retained (stored). By default, data
4234
+ # is retained for any metric used in the profile's `behaviors` but it
4235
+ # is also retained for any metric specified here.
4236
+ # @return [Array<String>]
4237
+ #
4183
4238
  # @!attribute [rw] version
4184
4239
  # The version of the security profile. A new version is generated
4185
4240
  # whenever the security profile is updated.
@@ -4199,6 +4254,7 @@ module Aws::IoT
4199
4254
  :security_profile_description,
4200
4255
  :behaviors,
4201
4256
  :alert_targets,
4257
+ :additional_metrics_to_retain,
4202
4258
  :version,
4203
4259
  :creation_date,
4204
4260
  :last_modified_date)
@@ -9544,6 +9600,34 @@ module Aws::IoT
9544
9600
  include Aws::Structure
9545
9601
  end
9546
9602
 
9603
+ # A statistical ranking (percentile) which indicates a threshold value
9604
+ # by which a behavior is determined to be in compliance or in violation
9605
+ # of the behavior.
9606
+ #
9607
+ # @note When making an API call, you may pass StatisticalThreshold
9608
+ # data as a hash:
9609
+ #
9610
+ # {
9611
+ # statistic: "EvaluationStatistic",
9612
+ # }
9613
+ #
9614
+ # @!attribute [rw] statistic
9615
+ # The percentile which resolves to a threshold value by which
9616
+ # compliance with a behavior is determined. Metrics are collected over
9617
+ # the specified period (`durationSeconds`) from all reporting devices
9618
+ # in your account and statistical ranks are calculated. Then, the
9619
+ # measurements from a device are collected over the same period. If
9620
+ # the accumulated measurements from the device fall above or below
9621
+ # (`comparisonOperator`) the value associated with the percentile
9622
+ # specified, then the device is considered to be in compliance with
9623
+ # the behavior, otherwise a violation occurs.
9624
+ # @return [String]
9625
+ #
9626
+ class StatisticalThreshold < Struct.new(
9627
+ :statistic)
9628
+ include Aws::Structure
9629
+ end
9630
+
9547
9631
  # Starts execution of a Step Functions state machine.
9548
9632
  #
9549
9633
  # @note When making an API call, you may pass StepFunctionsAction
@@ -11251,6 +11335,11 @@ module Aws::IoT
11251
11335
  # ports: [1],
11252
11336
  # },
11253
11337
  # duration_seconds: 1,
11338
+ # consecutive_datapoints_to_alarm: 1,
11339
+ # consecutive_datapoints_to_clear: 1,
11340
+ # statistical_threshold: {
11341
+ # statistic: "EvaluationStatistic",
11342
+ # },
11254
11343
  # },
11255
11344
  # },
11256
11345
  # ],
@@ -11260,6 +11349,10 @@ module Aws::IoT
11260
11349
  # role_arn: "RoleArn", # required
11261
11350
  # },
11262
11351
  # },
11352
+ # additional_metrics_to_retain: ["BehaviorMetric"],
11353
+ # delete_behaviors: false,
11354
+ # delete_alert_targets: false,
11355
+ # delete_additional_metrics_to_retain: false,
11263
11356
  # expected_version: 1,
11264
11357
  # }
11265
11358
  #
@@ -11280,6 +11373,30 @@ module Aws::IoT
11280
11373
  # Where the alerts are sent. (Alerts are always sent to the console.)
11281
11374
  # @return [Hash<String,Types::AlertTarget>]
11282
11375
  #
11376
+ # @!attribute [rw] additional_metrics_to_retain
11377
+ # A list of metrics whose data is retained (stored). By default, data
11378
+ # is retained for any metric used in the profile's `behaviors` but it
11379
+ # is also retained for any metric specified here.
11380
+ # @return [Array<String>]
11381
+ #
11382
+ # @!attribute [rw] delete_behaviors
11383
+ # If true, delete all `behaviors` defined for this security profile.
11384
+ # If any `behaviors` are defined in the current invocation an
11385
+ # exception occurs.
11386
+ # @return [Boolean]
11387
+ #
11388
+ # @!attribute [rw] delete_alert_targets
11389
+ # If true, delete all `alertTargets` defined for this security
11390
+ # profile. If any `alertTargets` are defined in the current invocation
11391
+ # an exception occurs.
11392
+ # @return [Boolean]
11393
+ #
11394
+ # @!attribute [rw] delete_additional_metrics_to_retain
11395
+ # If true, delete all `additionalMetricsToRetain` defined for this
11396
+ # security profile. If any `additionalMetricsToRetain` are defined in
11397
+ # the current invocation an exception occurs.
11398
+ # @return [Boolean]
11399
+ #
11283
11400
  # @!attribute [rw] expected_version
11284
11401
  # The expected version of the security profile. A new version is
11285
11402
  # generated whenever the security profile is updated. If you specify a
@@ -11292,6 +11409,10 @@ module Aws::IoT
11292
11409
  :security_profile_description,
11293
11410
  :behaviors,
11294
11411
  :alert_targets,
11412
+ :additional_metrics_to_retain,
11413
+ :delete_behaviors,
11414
+ :delete_alert_targets,
11415
+ :delete_additional_metrics_to_retain,
11295
11416
  :expected_version)
11296
11417
  include Aws::Structure
11297
11418
  end
@@ -11317,6 +11438,12 @@ module Aws::IoT
11317
11438
  # Where the alerts are sent. (Alerts are always sent to the console.)
11318
11439
  # @return [Hash<String,Types::AlertTarget>]
11319
11440
  #
11441
+ # @!attribute [rw] additional_metrics_to_retain
11442
+ # A list of metrics whose data is retained (stored). By default, data
11443
+ # is retained for any metric used in the security profile's
11444
+ # `behaviors` but it is also retained for any metric specified here.
11445
+ # @return [Array<String>]
11446
+ #
11320
11447
  # @!attribute [rw] version
11321
11448
  # The updated version of the security profile.
11322
11449
  # @return [Integer]
@@ -11335,6 +11462,7 @@ module Aws::IoT
11335
11462
  :security_profile_description,
11336
11463
  :behaviors,
11337
11464
  :alert_targets,
11465
+ :additional_metrics_to_retain,
11338
11466
  :version,
11339
11467
  :creation_date,
11340
11468
  :last_modified_date)
@@ -11571,6 +11699,11 @@ module Aws::IoT
11571
11699
  # ports: [1],
11572
11700
  # },
11573
11701
  # duration_seconds: 1,
11702
+ # consecutive_datapoints_to_alarm: 1,
11703
+ # consecutive_datapoints_to_clear: 1,
11704
+ # statistical_threshold: {
11705
+ # statistic: "EvaluationStatistic",
11706
+ # },
11574
11707
  # },
11575
11708
  # },
11576
11709
  # ],
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-iot
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.23.0
4
+ version: 1.24.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-02-15 00:00:00.000000000 Z
11
+ date: 2019-02-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core