aws-sdk-iotsitewise 1.88.0 → 1.89.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +734 -85
- data/lib/aws-sdk-iotsitewise/client_api.rb +489 -19
- data/lib/aws-sdk-iotsitewise/types.rb +1206 -185
- data/lib/aws-sdk-iotsitewise.rb +1 -1
- data/sig/client.rbs +220 -11
- data/sig/types.rbs +295 -12
- metadata +1 -1
@@ -110,10 +110,15 @@ module Aws::IoTSiteWise
|
|
110
110
|
# The resource the action will be taken on.
|
111
111
|
# @return [Types::TargetResource]
|
112
112
|
#
|
113
|
+
# @!attribute [rw] resolve_to
|
114
|
+
# The detailed resource this action resolves to.
|
115
|
+
# @return [Types::ResolveTo]
|
116
|
+
#
|
113
117
|
class ActionSummary < Struct.new(
|
114
118
|
:action_id,
|
115
119
|
:action_definition_id,
|
116
|
-
:target_resource
|
120
|
+
:target_resource,
|
121
|
+
:resolve_to)
|
117
122
|
SENSITIVE = []
|
118
123
|
include Aws::Structure
|
119
124
|
end
|
@@ -219,6 +224,21 @@ module Aws::IoTSiteWise
|
|
219
224
|
include Aws::Structure
|
220
225
|
end
|
221
226
|
|
227
|
+
# A filter used to match data bindings based on a specific asset. This
|
228
|
+
# filter identifies all computation models referencing a particular
|
229
|
+
# asset in their data bindings.
|
230
|
+
#
|
231
|
+
# @!attribute [rw] asset_id
|
232
|
+
# The ID of the asset to filter data bindings by. Only data bindings
|
233
|
+
# referencing this specific asset are matched.
|
234
|
+
# @return [String]
|
235
|
+
#
|
236
|
+
class AssetBindingValueFilter < Struct.new(
|
237
|
+
:asset_id)
|
238
|
+
SENSITIVE = []
|
239
|
+
include Aws::Structure
|
240
|
+
end
|
241
|
+
|
222
242
|
# Contains information about a composite model in an asset. This object
|
223
243
|
# contains the asset's properties that you define in the composite
|
224
244
|
# model.
|
@@ -362,16 +382,6 @@ module Aws::IoTSiteWise
|
|
362
382
|
# The ID of the hierarchy. This ID is a `hierarchyId`.
|
363
383
|
# @return [String]
|
364
384
|
#
|
365
|
-
# @!attribute [rw] name
|
366
|
-
# The hierarchy name provided in the [CreateAssetModel][1] or
|
367
|
-
# [UpdateAssetModel][2] API operation.
|
368
|
-
#
|
369
|
-
#
|
370
|
-
#
|
371
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html
|
372
|
-
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
|
373
|
-
# @return [String]
|
374
|
-
#
|
375
385
|
# @!attribute [rw] external_id
|
376
386
|
# The external ID of the hierarchy, if it has one. When you update an
|
377
387
|
# asset hierarchy, you may assign an external ID if it doesn't
|
@@ -384,10 +394,20 @@ module Aws::IoTSiteWise
|
|
384
394
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
385
395
|
# @return [String]
|
386
396
|
#
|
397
|
+
# @!attribute [rw] name
|
398
|
+
# The hierarchy name provided in the [CreateAssetModel][1] or
|
399
|
+
# [UpdateAssetModel][2] API operation.
|
400
|
+
#
|
401
|
+
#
|
402
|
+
#
|
403
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html
|
404
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
|
405
|
+
# @return [String]
|
406
|
+
#
|
387
407
|
class AssetHierarchy < Struct.new(
|
388
408
|
:id,
|
389
|
-
:
|
390
|
-
:
|
409
|
+
:external_id,
|
410
|
+
:name)
|
391
411
|
SENSITIVE = []
|
392
412
|
include Aws::Structure
|
393
413
|
end
|
@@ -410,6 +430,21 @@ module Aws::IoTSiteWise
|
|
410
430
|
include Aws::Structure
|
411
431
|
end
|
412
432
|
|
433
|
+
# A filter used to match data bindings based on a specific asset model.
|
434
|
+
# This filter identifies all computation models referencing a particular
|
435
|
+
# asset model in their data bindings.
|
436
|
+
#
|
437
|
+
# @!attribute [rw] asset_model_id
|
438
|
+
# The ID of the asset model to filter data bindings by. Only data
|
439
|
+
# bindings referemncing this specific asset model are matched.
|
440
|
+
# @return [String]
|
441
|
+
#
|
442
|
+
class AssetModelBindingValueFilter < Struct.new(
|
443
|
+
:asset_model_id)
|
444
|
+
SENSITIVE = []
|
445
|
+
include Aws::Structure
|
446
|
+
end
|
447
|
+
|
413
448
|
# Contains information about a composite model in an asset model. This
|
414
449
|
# object contains the asset property definitions that you define in the
|
415
450
|
# composite model.
|
@@ -780,6 +815,46 @@ module Aws::IoTSiteWise
|
|
780
815
|
include Aws::Structure
|
781
816
|
end
|
782
817
|
|
818
|
+
# Contains information about an `assetModelProperty` binding value.
|
819
|
+
#
|
820
|
+
# @!attribute [rw] asset_model_id
|
821
|
+
# The ID of the asset model, in UUID format.
|
822
|
+
# @return [String]
|
823
|
+
#
|
824
|
+
# @!attribute [rw] property_id
|
825
|
+
# The ID of the asset model property used in data binding value.
|
826
|
+
# @return [String]
|
827
|
+
#
|
828
|
+
class AssetModelPropertyBindingValue < Struct.new(
|
829
|
+
:asset_model_id,
|
830
|
+
:property_id)
|
831
|
+
SENSITIVE = []
|
832
|
+
include Aws::Structure
|
833
|
+
end
|
834
|
+
|
835
|
+
# A filter used to match data bindings based on a specific asset model
|
836
|
+
# property. This filter identifies all computation models that reference
|
837
|
+
# a particular property of an asset model in their data bindings.
|
838
|
+
#
|
839
|
+
# @!attribute [rw] asset_model_id
|
840
|
+
# The ID of the asset model containing the filter property. This
|
841
|
+
# identifies the specific asset model that contains the property of
|
842
|
+
# interest.
|
843
|
+
# @return [String]
|
844
|
+
#
|
845
|
+
# @!attribute [rw] property_id
|
846
|
+
# The ID of the property within the asset model to filter by. Only
|
847
|
+
# data bindings referencing this specific property of the specified
|
848
|
+
# asset model are matched.
|
849
|
+
# @return [String]
|
850
|
+
#
|
851
|
+
class AssetModelPropertyBindingValueFilter < Struct.new(
|
852
|
+
:asset_model_id,
|
853
|
+
:property_id)
|
854
|
+
SENSITIVE = []
|
855
|
+
include Aws::Structure
|
856
|
+
end
|
857
|
+
|
783
858
|
# Contains an asset model property definition. This property definition
|
784
859
|
# is applied to all assets created from the asset model.
|
785
860
|
#
|
@@ -1027,6 +1102,15 @@ module Aws::IoTSiteWise
|
|
1027
1102
|
# The ID of the asset property.
|
1028
1103
|
# @return [String]
|
1029
1104
|
#
|
1105
|
+
# @!attribute [rw] external_id
|
1106
|
+
# The external ID of the asset property. For more information, see
|
1107
|
+
# [Using external IDs][1] in the *IoT SiteWise User Guide*.
|
1108
|
+
#
|
1109
|
+
#
|
1110
|
+
#
|
1111
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1112
|
+
# @return [String]
|
1113
|
+
#
|
1030
1114
|
# @!attribute [rw] name
|
1031
1115
|
# The name of the property.
|
1032
1116
|
# @return [String]
|
@@ -1069,25 +1153,61 @@ module Aws::IoTSiteWise
|
|
1069
1153
|
# The structured path to the property from the root of the asset.
|
1070
1154
|
# @return [Array<Types::AssetPropertyPathSegment>]
|
1071
1155
|
#
|
1072
|
-
# @!attribute [rw] external_id
|
1073
|
-
# The external ID of the asset property. For more information, see
|
1074
|
-
# [Using external IDs][1] in the *IoT SiteWise User Guide*.
|
1075
|
-
#
|
1076
|
-
#
|
1077
|
-
#
|
1078
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1079
|
-
# @return [String]
|
1080
|
-
#
|
1081
1156
|
class AssetProperty < Struct.new(
|
1082
1157
|
:id,
|
1158
|
+
:external_id,
|
1083
1159
|
:name,
|
1084
1160
|
:alias,
|
1085
1161
|
:notification,
|
1086
1162
|
:data_type,
|
1087
1163
|
:data_type_spec,
|
1088
1164
|
:unit,
|
1089
|
-
:path
|
1090
|
-
|
1165
|
+
:path)
|
1166
|
+
SENSITIVE = []
|
1167
|
+
include Aws::Structure
|
1168
|
+
end
|
1169
|
+
|
1170
|
+
# Represents a data binding value referencing a specific asset property.
|
1171
|
+
# It's used to bind computation model variables to actual asset
|
1172
|
+
# property values for processing.
|
1173
|
+
#
|
1174
|
+
# @!attribute [rw] asset_id
|
1175
|
+
# The ID of the asset containing the property. This identifies the
|
1176
|
+
# specific asset instance's property value used in the computation
|
1177
|
+
# model.
|
1178
|
+
# @return [String]
|
1179
|
+
#
|
1180
|
+
# @!attribute [rw] property_id
|
1181
|
+
# The ID of the property within the asset. This identifies the
|
1182
|
+
# specific property's value used in the computation model.
|
1183
|
+
# @return [String]
|
1184
|
+
#
|
1185
|
+
class AssetPropertyBindingValue < Struct.new(
|
1186
|
+
:asset_id,
|
1187
|
+
:property_id)
|
1188
|
+
SENSITIVE = []
|
1189
|
+
include Aws::Structure
|
1190
|
+
end
|
1191
|
+
|
1192
|
+
# A filter used to match data bindings based on a specific asset
|
1193
|
+
# property. This filter helps identify all computation models
|
1194
|
+
# referencing a particular property of an asset in their data bindings.
|
1195
|
+
#
|
1196
|
+
# @!attribute [rw] asset_id
|
1197
|
+
# The ID of the asset containing the property to filter by. This
|
1198
|
+
# identifies the specific asset instance containing the property of
|
1199
|
+
# interest.
|
1200
|
+
# @return [String]
|
1201
|
+
#
|
1202
|
+
# @!attribute [rw] property_id
|
1203
|
+
# The ID of the property within the asset to filter by. Only data
|
1204
|
+
# bindings referencing this specific property of the specified asset
|
1205
|
+
# are matched.
|
1206
|
+
# @return [String]
|
1207
|
+
#
|
1208
|
+
class AssetPropertyBindingValueFilter < Struct.new(
|
1209
|
+
:asset_id,
|
1210
|
+
:property_id)
|
1091
1211
|
SENSITIVE = []
|
1092
1212
|
include Aws::Structure
|
1093
1213
|
end
|
@@ -1115,6 +1235,15 @@ module Aws::IoTSiteWise
|
|
1115
1235
|
# The ID of the property.
|
1116
1236
|
# @return [String]
|
1117
1237
|
#
|
1238
|
+
# @!attribute [rw] external_id
|
1239
|
+
# The external ID of the property. For more information, see [Using
|
1240
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
1241
|
+
#
|
1242
|
+
#
|
1243
|
+
#
|
1244
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1245
|
+
# @return [String]
|
1246
|
+
#
|
1118
1247
|
# @!attribute [rw] alias
|
1119
1248
|
# The alias that identifies the property, such as an OPC-UA server
|
1120
1249
|
# data stream path (for example,
|
@@ -1151,23 +1280,14 @@ module Aws::IoTSiteWise
|
|
1151
1280
|
# The structured path to the property from the root of the asset.
|
1152
1281
|
# @return [Array<Types::AssetPropertyPathSegment>]
|
1153
1282
|
#
|
1154
|
-
# @!attribute [rw] external_id
|
1155
|
-
# The external ID of the property. For more information, see [Using
|
1156
|
-
# external IDs][1] in the *IoT SiteWise User Guide*.
|
1157
|
-
#
|
1158
|
-
#
|
1159
|
-
#
|
1160
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1161
|
-
# @return [String]
|
1162
|
-
#
|
1163
1283
|
class AssetPropertySummary < Struct.new(
|
1164
1284
|
:id,
|
1285
|
+
:external_id,
|
1165
1286
|
:alias,
|
1166
1287
|
:unit,
|
1167
1288
|
:notification,
|
1168
1289
|
:asset_composite_model_id,
|
1169
|
-
:path
|
1170
|
-
:external_id)
|
1290
|
+
:path)
|
1171
1291
|
SENSITIVE = []
|
1172
1292
|
include Aws::Structure
|
1173
1293
|
end
|
@@ -1249,6 +1369,15 @@ module Aws::IoTSiteWise
|
|
1249
1369
|
# The ID of the asset, in UUID format.
|
1250
1370
|
# @return [String]
|
1251
1371
|
#
|
1372
|
+
# @!attribute [rw] external_id
|
1373
|
+
# The external ID of the asset. For more information, see [Using
|
1374
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
1375
|
+
#
|
1376
|
+
#
|
1377
|
+
#
|
1378
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1379
|
+
# @return [String]
|
1380
|
+
#
|
1252
1381
|
# @!attribute [rw] arn
|
1253
1382
|
# The [ARN][1] of the asset, which has the following format.
|
1254
1383
|
#
|
@@ -1288,17 +1417,9 @@ module Aws::IoTSiteWise
|
|
1288
1417
|
# A description for the asset.
|
1289
1418
|
# @return [String]
|
1290
1419
|
#
|
1291
|
-
# @!attribute [rw] external_id
|
1292
|
-
# The external ID of the asset. For more information, see [Using
|
1293
|
-
# external IDs][1] in the *IoT SiteWise User Guide*.
|
1294
|
-
#
|
1295
|
-
#
|
1296
|
-
#
|
1297
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1298
|
-
# @return [String]
|
1299
|
-
#
|
1300
1420
|
class AssetSummary < Struct.new(
|
1301
1421
|
:id,
|
1422
|
+
:external_id,
|
1302
1423
|
:arn,
|
1303
1424
|
:name,
|
1304
1425
|
:asset_model_id,
|
@@ -1306,8 +1427,7 @@ module Aws::IoTSiteWise
|
|
1306
1427
|
:last_update_date,
|
1307
1428
|
:status,
|
1308
1429
|
:hierarchies,
|
1309
|
-
:description
|
1310
|
-
:external_id)
|
1430
|
+
:description)
|
1311
1431
|
SENSITIVE = []
|
1312
1432
|
include Aws::Structure
|
1313
1433
|
end
|
@@ -1419,6 +1539,15 @@ module Aws::IoTSiteWise
|
|
1419
1539
|
# The ID of the asset, in UUID format.
|
1420
1540
|
# @return [String]
|
1421
1541
|
#
|
1542
|
+
# @!attribute [rw] external_id
|
1543
|
+
# The external ID of the asset. For more information, see [Using
|
1544
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
1545
|
+
#
|
1546
|
+
#
|
1547
|
+
#
|
1548
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1549
|
+
# @return [String]
|
1550
|
+
#
|
1422
1551
|
# @!attribute [rw] arn
|
1423
1552
|
# The [ARN][1] of the asset, which has the following format.
|
1424
1553
|
#
|
@@ -1458,17 +1587,9 @@ module Aws::IoTSiteWise
|
|
1458
1587
|
# A description for the asset.
|
1459
1588
|
# @return [String]
|
1460
1589
|
#
|
1461
|
-
# @!attribute [rw] external_id
|
1462
|
-
# The external ID of the asset. For more information, see [Using
|
1463
|
-
# external IDs][1] in the *IoT SiteWise User Guide*.
|
1464
|
-
#
|
1465
|
-
#
|
1466
|
-
#
|
1467
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1468
|
-
# @return [String]
|
1469
|
-
#
|
1470
1590
|
class AssociatedAssetsSummary < Struct.new(
|
1471
1591
|
:id,
|
1592
|
+
:external_id,
|
1472
1593
|
:arn,
|
1473
1594
|
:name,
|
1474
1595
|
:asset_model_id,
|
@@ -1476,8 +1597,7 @@ module Aws::IoTSiteWise
|
|
1476
1597
|
:last_update_date,
|
1477
1598
|
:status,
|
1478
1599
|
:hierarchies,
|
1479
|
-
:description
|
1480
|
-
:external_id)
|
1600
|
+
:description)
|
1481
1601
|
SENSITIVE = []
|
1482
1602
|
include Aws::Structure
|
1483
1603
|
end
|
@@ -2460,6 +2580,173 @@ module Aws::IoTSiteWise
|
|
2460
2580
|
include Aws::Structure
|
2461
2581
|
end
|
2462
2582
|
|
2583
|
+
# Contains the configuration of the type of anomaly detection
|
2584
|
+
# computation model.
|
2585
|
+
#
|
2586
|
+
# @!attribute [rw] input_properties
|
2587
|
+
# Define the variable name associated with input properties, with the
|
2588
|
+
# following format `${VariableName}`.
|
2589
|
+
# @return [String]
|
2590
|
+
#
|
2591
|
+
# @!attribute [rw] result_property
|
2592
|
+
# Define the variable name associated with the result property, and
|
2593
|
+
# the following format `${VariableName}`.
|
2594
|
+
# @return [String]
|
2595
|
+
#
|
2596
|
+
class ComputationModelAnomalyDetectionConfiguration < Struct.new(
|
2597
|
+
:input_properties,
|
2598
|
+
:result_property)
|
2599
|
+
SENSITIVE = []
|
2600
|
+
include Aws::Structure
|
2601
|
+
end
|
2602
|
+
|
2603
|
+
# The configuration for the computation model.
|
2604
|
+
#
|
2605
|
+
# @!attribute [rw] anomaly_detection
|
2606
|
+
# The configuration for the anomaly detection type of computation
|
2607
|
+
# model.
|
2608
|
+
# @return [Types::ComputationModelAnomalyDetectionConfiguration]
|
2609
|
+
#
|
2610
|
+
class ComputationModelConfiguration < Struct.new(
|
2611
|
+
:anomaly_detection)
|
2612
|
+
SENSITIVE = []
|
2613
|
+
include Aws::Structure
|
2614
|
+
end
|
2615
|
+
|
2616
|
+
# A summary of how a specific data binding is used across computation
|
2617
|
+
# models. This tracks dependencies between data sources and computation
|
2618
|
+
# models, allowing you to understand the impact of changes to data
|
2619
|
+
# sources.
|
2620
|
+
#
|
2621
|
+
# @!attribute [rw] computation_model_ids
|
2622
|
+
# The list of computation model IDs that use this data binding. This
|
2623
|
+
# allows identification of all computation models affected by changes
|
2624
|
+
# to the referenced data source.
|
2625
|
+
# @return [Array<String>]
|
2626
|
+
#
|
2627
|
+
# @!attribute [rw] matched_data_binding
|
2628
|
+
# The data binding matched by the filter criteria. Contains details
|
2629
|
+
# about specific data binding values used by the computation models.
|
2630
|
+
# @return [Types::MatchedDataBinding]
|
2631
|
+
#
|
2632
|
+
class ComputationModelDataBindingUsageSummary < Struct.new(
|
2633
|
+
:computation_model_ids,
|
2634
|
+
:matched_data_binding)
|
2635
|
+
SENSITIVE = []
|
2636
|
+
include Aws::Structure
|
2637
|
+
end
|
2638
|
+
|
2639
|
+
# Contains computation model data binding value information, which can
|
2640
|
+
# be one of `assetModelProperty`, `list`.
|
2641
|
+
#
|
2642
|
+
# @!attribute [rw] asset_model_property
|
2643
|
+
# Specifies an asset model property data binding value.
|
2644
|
+
# @return [Types::AssetModelPropertyBindingValue]
|
2645
|
+
#
|
2646
|
+
# @!attribute [rw] asset_property
|
2647
|
+
# The asset property value used for computation model data binding.
|
2648
|
+
# @return [Types::AssetPropertyBindingValue]
|
2649
|
+
#
|
2650
|
+
# @!attribute [rw] list
|
2651
|
+
# Specifies a list of data binding value.
|
2652
|
+
# @return [Array<Types::ComputationModelDataBindingValue>]
|
2653
|
+
#
|
2654
|
+
class ComputationModelDataBindingValue < Struct.new(
|
2655
|
+
:asset_model_property,
|
2656
|
+
:asset_property,
|
2657
|
+
:list)
|
2658
|
+
SENSITIVE = []
|
2659
|
+
include Aws::Structure
|
2660
|
+
end
|
2661
|
+
|
2662
|
+
# A summary of the resource that a computation model resolves to.
|
2663
|
+
#
|
2664
|
+
# @!attribute [rw] resolve_to
|
2665
|
+
# The detailed resource this execution summary resolves to.
|
2666
|
+
# @return [Types::ResolveTo]
|
2667
|
+
#
|
2668
|
+
class ComputationModelResolveToResourceSummary < Struct.new(
|
2669
|
+
:resolve_to)
|
2670
|
+
SENSITIVE = []
|
2671
|
+
include Aws::Structure
|
2672
|
+
end
|
2673
|
+
|
2674
|
+
# Contains current status information for a computation model.
|
2675
|
+
#
|
2676
|
+
# @!attribute [rw] state
|
2677
|
+
# The current state of the computation model.
|
2678
|
+
# @return [String]
|
2679
|
+
#
|
2680
|
+
# @!attribute [rw] error
|
2681
|
+
# Contains the details of an IoT SiteWise error.
|
2682
|
+
# @return [Types::ErrorDetails]
|
2683
|
+
#
|
2684
|
+
class ComputationModelStatus < Struct.new(
|
2685
|
+
:state,
|
2686
|
+
:error)
|
2687
|
+
SENSITIVE = []
|
2688
|
+
include Aws::Structure
|
2689
|
+
end
|
2690
|
+
|
2691
|
+
# Contains a summary of a computation model.
|
2692
|
+
#
|
2693
|
+
# @!attribute [rw] id
|
2694
|
+
# The ID of the computation model.
|
2695
|
+
# @return [String]
|
2696
|
+
#
|
2697
|
+
# @!attribute [rw] arn
|
2698
|
+
# The [ARN][1] of the computation model, which has the following
|
2699
|
+
# format.
|
2700
|
+
#
|
2701
|
+
# `arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}`
|
2702
|
+
#
|
2703
|
+
#
|
2704
|
+
#
|
2705
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
2706
|
+
# @return [String]
|
2707
|
+
#
|
2708
|
+
# @!attribute [rw] name
|
2709
|
+
# The name of the computation model.
|
2710
|
+
# @return [String]
|
2711
|
+
#
|
2712
|
+
# @!attribute [rw] description
|
2713
|
+
# The description of the computation model.
|
2714
|
+
# @return [String]
|
2715
|
+
#
|
2716
|
+
# @!attribute [rw] type
|
2717
|
+
# The type of the computation model.
|
2718
|
+
# @return [String]
|
2719
|
+
#
|
2720
|
+
# @!attribute [rw] creation_date
|
2721
|
+
# The model creation date, in Unix epoch time.
|
2722
|
+
# @return [Time]
|
2723
|
+
#
|
2724
|
+
# @!attribute [rw] last_update_date
|
2725
|
+
# The time the model was last updated, in Unix epoch time.
|
2726
|
+
# @return [Time]
|
2727
|
+
#
|
2728
|
+
# @!attribute [rw] status
|
2729
|
+
# The current status of the computation model.
|
2730
|
+
# @return [Types::ComputationModelStatus]
|
2731
|
+
#
|
2732
|
+
# @!attribute [rw] version
|
2733
|
+
# The version of the computation model.
|
2734
|
+
# @return [String]
|
2735
|
+
#
|
2736
|
+
class ComputationModelSummary < Struct.new(
|
2737
|
+
:id,
|
2738
|
+
:arn,
|
2739
|
+
:name,
|
2740
|
+
:description,
|
2741
|
+
:type,
|
2742
|
+
:creation_date,
|
2743
|
+
:last_update_date,
|
2744
|
+
:status,
|
2745
|
+
:version)
|
2746
|
+
SENSITIVE = []
|
2747
|
+
include Aws::Structure
|
2748
|
+
end
|
2749
|
+
|
2463
2750
|
# Contains the details of an IoT SiteWise configuration error.
|
2464
2751
|
#
|
2465
2752
|
# @!attribute [rw] code
|
@@ -2897,6 +3184,25 @@ module Aws::IoTSiteWise
|
|
2897
3184
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
2898
3185
|
# @return [String]
|
2899
3186
|
#
|
3187
|
+
# @!attribute [rw] asset_id
|
3188
|
+
# The ID to assign to the asset, if desired. IoT SiteWise
|
3189
|
+
# automatically generates a unique ID for you, so this parameter is
|
3190
|
+
# never required. However, if you prefer to supply your own ID
|
3191
|
+
# instead, you can specify it here in UUID format. If you specify your
|
3192
|
+
# own ID, it must be globally unique.
|
3193
|
+
# @return [String]
|
3194
|
+
#
|
3195
|
+
# @!attribute [rw] asset_external_id
|
3196
|
+
# An external ID to assign to the asset. The external ID must be
|
3197
|
+
# unique within your Amazon Web Services account. For more
|
3198
|
+
# information, see [Using external IDs][1] in the *IoT SiteWise User
|
3199
|
+
# Guide*.
|
3200
|
+
#
|
3201
|
+
#
|
3202
|
+
#
|
3203
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
3204
|
+
# @return [String]
|
3205
|
+
#
|
2900
3206
|
# @!attribute [rw] client_token
|
2901
3207
|
# A unique case-sensitive identifier that you can provide to ensure
|
2902
3208
|
# the idempotency of the request. Don't reuse this client token if a
|
@@ -2920,33 +3226,14 @@ module Aws::IoTSiteWise
|
|
2920
3226
|
# A description for the asset.
|
2921
3227
|
# @return [String]
|
2922
3228
|
#
|
2923
|
-
# @!attribute [rw] asset_id
|
2924
|
-
# The ID to assign to the asset, if desired. IoT SiteWise
|
2925
|
-
# automatically generates a unique ID for you, so this parameter is
|
2926
|
-
# never required. However, if you prefer to supply your own ID
|
2927
|
-
# instead, you can specify it here in UUID format. If you specify your
|
2928
|
-
# own ID, it must be globally unique.
|
2929
|
-
# @return [String]
|
2930
|
-
#
|
2931
|
-
# @!attribute [rw] asset_external_id
|
2932
|
-
# An external ID to assign to the asset. The external ID must be
|
2933
|
-
# unique within your Amazon Web Services account. For more
|
2934
|
-
# information, see [Using external IDs][1] in the *IoT SiteWise User
|
2935
|
-
# Guide*.
|
2936
|
-
#
|
2937
|
-
#
|
2938
|
-
#
|
2939
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
2940
|
-
# @return [String]
|
2941
|
-
#
|
2942
3229
|
class CreateAssetRequest < Struct.new(
|
2943
3230
|
:asset_name,
|
2944
3231
|
:asset_model_id,
|
3232
|
+
:asset_id,
|
3233
|
+
:asset_external_id,
|
2945
3234
|
:client_token,
|
2946
3235
|
:tags,
|
2947
|
-
:asset_description
|
2948
|
-
:asset_id,
|
2949
|
-
:asset_external_id)
|
3236
|
+
:asset_description)
|
2950
3237
|
SENSITIVE = []
|
2951
3238
|
include Aws::Structure
|
2952
3239
|
end
|
@@ -3071,6 +3358,82 @@ module Aws::IoTSiteWise
|
|
3071
3358
|
include Aws::Structure
|
3072
3359
|
end
|
3073
3360
|
|
3361
|
+
# @!attribute [rw] computation_model_name
|
3362
|
+
# The name of the computation model.
|
3363
|
+
# @return [String]
|
3364
|
+
#
|
3365
|
+
# @!attribute [rw] computation_model_description
|
3366
|
+
# The description of the computation model.
|
3367
|
+
# @return [String]
|
3368
|
+
#
|
3369
|
+
# @!attribute [rw] computation_model_configuration
|
3370
|
+
# The configuration for the computation model.
|
3371
|
+
# @return [Types::ComputationModelConfiguration]
|
3372
|
+
#
|
3373
|
+
# @!attribute [rw] computation_model_data_binding
|
3374
|
+
# The data binding for the computation model. Key is a variable name
|
3375
|
+
# defined in configuration. Value is a
|
3376
|
+
# `ComputationModelDataBindingValue` referenced by the variable.
|
3377
|
+
# @return [Hash<String,Types::ComputationModelDataBindingValue>]
|
3378
|
+
#
|
3379
|
+
# @!attribute [rw] client_token
|
3380
|
+
# A unique case-sensitive identifier that you can provide to ensure
|
3381
|
+
# the idempotency of the request. Don't reuse this client token if a
|
3382
|
+
# new idempotent request is required.
|
3383
|
+
#
|
3384
|
+
# **A suitable default value is auto-generated.** You should normally
|
3385
|
+
# not need to pass this option.
|
3386
|
+
# @return [String]
|
3387
|
+
#
|
3388
|
+
# @!attribute [rw] tags
|
3389
|
+
# A list of key-value pairs that contain metadata for the asset. For
|
3390
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in
|
3391
|
+
# the *IoT SiteWise User Guide*.
|
3392
|
+
#
|
3393
|
+
#
|
3394
|
+
#
|
3395
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
|
3396
|
+
# @return [Hash<String,String>]
|
3397
|
+
#
|
3398
|
+
class CreateComputationModelRequest < Struct.new(
|
3399
|
+
:computation_model_name,
|
3400
|
+
:computation_model_description,
|
3401
|
+
:computation_model_configuration,
|
3402
|
+
:computation_model_data_binding,
|
3403
|
+
:client_token,
|
3404
|
+
:tags)
|
3405
|
+
SENSITIVE = []
|
3406
|
+
include Aws::Structure
|
3407
|
+
end
|
3408
|
+
|
3409
|
+
# @!attribute [rw] computation_model_id
|
3410
|
+
# The ID of the computation model.
|
3411
|
+
# @return [String]
|
3412
|
+
#
|
3413
|
+
# @!attribute [rw] computation_model_arn
|
3414
|
+
# The [ARN][1] of the computation model, which has the following
|
3415
|
+
# format.
|
3416
|
+
#
|
3417
|
+
# `arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}`
|
3418
|
+
#
|
3419
|
+
#
|
3420
|
+
#
|
3421
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
3422
|
+
# @return [String]
|
3423
|
+
#
|
3424
|
+
# @!attribute [rw] computation_model_status
|
3425
|
+
# The status of the computation model, containing a state (CREATING
|
3426
|
+
# after successfully calling this operation) and any error messages.
|
3427
|
+
# @return [Types::ComputationModelStatus]
|
3428
|
+
#
|
3429
|
+
class CreateComputationModelResponse < Struct.new(
|
3430
|
+
:computation_model_id,
|
3431
|
+
:computation_model_arn,
|
3432
|
+
:computation_model_status)
|
3433
|
+
SENSITIVE = []
|
3434
|
+
include Aws::Structure
|
3435
|
+
end
|
3436
|
+
|
3074
3437
|
# @!attribute [rw] project_id
|
3075
3438
|
# The ID of the project in which to create the dashboard.
|
3076
3439
|
# @return [String]
|
@@ -3234,18 +3597,24 @@ module Aws::IoTSiteWise
|
|
3234
3597
|
#
|
3235
3598
|
# @!attribute [rw] gateway_version
|
3236
3599
|
# The version of the gateway to create. Specify `3` to create an
|
3237
|
-
# MQTT-enabled, V3 gateway and `2`
|
3238
|
-
# gateway. If the
|
3239
|
-
# gateway
|
3600
|
+
# MQTT-enabled, V3 gateway and `2` to create a Classic streams, V2
|
3601
|
+
# gateway. If not specified, the default is `2` (Classic streams, V2
|
3602
|
+
# gateway).
|
3603
|
+
#
|
3604
|
+
# <note markdown="1"> When creating a V3 gateway (`gatewayVersion=3`) with the
|
3605
|
+
# `GreengrassV2` platform, you must also specify the
|
3606
|
+
# `coreDeviceOperatingSystem` parameter.
|
3607
|
+
#
|
3608
|
+
# </note>
|
3240
3609
|
#
|
3241
|
-
# We recommend creating an MQTT-enabled
|
3242
|
-
# gateways
|
3243
|
-
#
|
3244
|
-
#
|
3610
|
+
# We recommend creating an MQTT-enabled gateway for self-hosted
|
3611
|
+
# gateways and Siemens Industrial Edge gateways. For more information
|
3612
|
+
# on gateway versions, see [Use Amazon Web Services IoT SiteWise Edge
|
3613
|
+
# Edge gateways][1].
|
3245
3614
|
#
|
3246
3615
|
#
|
3247
3616
|
#
|
3248
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/
|
3617
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html
|
3249
3618
|
# @return [String]
|
3250
3619
|
#
|
3251
3620
|
# @!attribute [rw] tags
|
@@ -3591,6 +3960,61 @@ module Aws::IoTSiteWise
|
|
3591
3960
|
include Aws::Structure
|
3592
3961
|
end
|
3593
3962
|
|
3963
|
+
# Represents a value used in a data binding. It can be an asset property
|
3964
|
+
# or an asset model property.
|
3965
|
+
#
|
3966
|
+
# @!attribute [rw] asset_model_property
|
3967
|
+
# Contains information about an `assetModelProperty` binding value.
|
3968
|
+
# @return [Types::AssetModelPropertyBindingValue]
|
3969
|
+
#
|
3970
|
+
# @!attribute [rw] asset_property
|
3971
|
+
# The asset property value used in the data binding.
|
3972
|
+
# @return [Types::AssetPropertyBindingValue]
|
3973
|
+
#
|
3974
|
+
class DataBindingValue < Struct.new(
|
3975
|
+
:asset_model_property,
|
3976
|
+
:asset_property)
|
3977
|
+
SENSITIVE = []
|
3978
|
+
include Aws::Structure
|
3979
|
+
end
|
3980
|
+
|
3981
|
+
# A filter used to match specific data binding values based on criteria.
|
3982
|
+
# This filter allows searching for data bindings by asset, asset model,
|
3983
|
+
# asset property, or asset model property.
|
3984
|
+
#
|
3985
|
+
# @!attribute [rw] asset
|
3986
|
+
# Filter criteria for matching data bindings based on a specific
|
3987
|
+
# asset. Used to list all data bindings referencing a particular asset
|
3988
|
+
# or its properties.
|
3989
|
+
# @return [Types::AssetBindingValueFilter]
|
3990
|
+
#
|
3991
|
+
# @!attribute [rw] asset_model
|
3992
|
+
# Filter criteria for matching data bindings based on a specific asset
|
3993
|
+
# model. Used to list all data bindings referencing a particular asset
|
3994
|
+
# model or its properties.
|
3995
|
+
# @return [Types::AssetModelBindingValueFilter]
|
3996
|
+
#
|
3997
|
+
# @!attribute [rw] asset_property
|
3998
|
+
# Filter criteria for matching data bindings based on a specific asset
|
3999
|
+
# property. Used to list all data bindings referencing a particular
|
4000
|
+
# property of an asset.
|
4001
|
+
# @return [Types::AssetPropertyBindingValueFilter]
|
4002
|
+
#
|
4003
|
+
# @!attribute [rw] asset_model_property
|
4004
|
+
# Filter criteria for matching data bindings based on a specific asset
|
4005
|
+
# model property. Used to list all data bindings referencing a
|
4006
|
+
# particular property of an asset model.
|
4007
|
+
# @return [Types::AssetModelPropertyBindingValueFilter]
|
4008
|
+
#
|
4009
|
+
class DataBindingValueFilter < Struct.new(
|
4010
|
+
:asset,
|
4011
|
+
:asset_model,
|
4012
|
+
:asset_property,
|
4013
|
+
:asset_model_property)
|
4014
|
+
SENSITIVE = []
|
4015
|
+
include Aws::Structure
|
4016
|
+
end
|
4017
|
+
|
3594
4018
|
# Contains information about the dataset use and it's source.
|
3595
4019
|
#
|
3596
4020
|
# @!attribute [rw] dataset_arn
|
@@ -3922,6 +4346,37 @@ module Aws::IoTSiteWise
|
|
3922
4346
|
include Aws::Structure
|
3923
4347
|
end
|
3924
4348
|
|
4349
|
+
# @!attribute [rw] computation_model_id
|
4350
|
+
# The ID of the computation model.
|
4351
|
+
# @return [String]
|
4352
|
+
#
|
4353
|
+
# @!attribute [rw] client_token
|
4354
|
+
# A unique case-sensitive identifier that you can provide to ensure
|
4355
|
+
# the idempotency of the request. Don't reuse this client token if a
|
4356
|
+
# new idempotent request is required.
|
4357
|
+
#
|
4358
|
+
# **A suitable default value is auto-generated.** You should normally
|
4359
|
+
# not need to pass this option.
|
4360
|
+
# @return [String]
|
4361
|
+
#
|
4362
|
+
class DeleteComputationModelRequest < Struct.new(
|
4363
|
+
:computation_model_id,
|
4364
|
+
:client_token)
|
4365
|
+
SENSITIVE = []
|
4366
|
+
include Aws::Structure
|
4367
|
+
end
|
4368
|
+
|
4369
|
+
# @!attribute [rw] computation_model_status
|
4370
|
+
# The status of the computation model. It contains a state (DELETING
|
4371
|
+
# after successfully calling this operation) and any error messages.
|
4372
|
+
# @return [Types::ComputationModelStatus]
|
4373
|
+
#
|
4374
|
+
class DeleteComputationModelResponse < Struct.new(
|
4375
|
+
:computation_model_status)
|
4376
|
+
SENSITIVE = []
|
4377
|
+
include Aws::Structure
|
4378
|
+
end
|
4379
|
+
|
3925
4380
|
# @!attribute [rw] dashboard_id
|
3926
4381
|
# The ID of the dashboard to delete.
|
3927
4382
|
# @return [String]
|
@@ -4173,12 +4628,17 @@ module Aws::IoTSiteWise
|
|
4173
4628
|
# The time the action was executed.
|
4174
4629
|
# @return [Time]
|
4175
4630
|
#
|
4631
|
+
# @!attribute [rw] resolve_to
|
4632
|
+
# The detailed resource this action resolves to.
|
4633
|
+
# @return [Types::ResolveTo]
|
4634
|
+
#
|
4176
4635
|
class DescribeActionResponse < Struct.new(
|
4177
4636
|
:action_id,
|
4178
4637
|
:target_resource,
|
4179
4638
|
:action_definition_id,
|
4180
4639
|
:action_payload,
|
4181
|
-
:execution_time
|
4640
|
+
:execution_time,
|
4641
|
+
:resolve_to)
|
4182
4642
|
SENSITIVE = []
|
4183
4643
|
include Aws::Structure
|
4184
4644
|
end
|
@@ -4571,6 +5031,15 @@ module Aws::IoTSiteWise
|
|
4571
5031
|
# The ID of the asset, in UUID format.
|
4572
5032
|
# @return [String]
|
4573
5033
|
#
|
5034
|
+
# @!attribute [rw] asset_external_id
|
5035
|
+
# The external ID of the asset. For more information, see [Using
|
5036
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
5037
|
+
#
|
5038
|
+
#
|
5039
|
+
#
|
5040
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
5041
|
+
# @return [String]
|
5042
|
+
#
|
4574
5043
|
# @!attribute [rw] asset_name
|
4575
5044
|
# The name of the asset.
|
4576
5045
|
# @return [String]
|
@@ -4592,22 +5061,13 @@ module Aws::IoTSiteWise
|
|
4592
5061
|
# property exists in a composite model.
|
4593
5062
|
# @return [Types::CompositeModelProperty]
|
4594
5063
|
#
|
4595
|
-
# @!attribute [rw] asset_external_id
|
4596
|
-
# The external ID of the asset. For more information, see [Using
|
4597
|
-
# external IDs][1] in the *IoT SiteWise User Guide*.
|
4598
|
-
#
|
4599
|
-
#
|
4600
|
-
#
|
4601
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
4602
|
-
# @return [String]
|
4603
|
-
#
|
4604
5064
|
class DescribeAssetPropertyResponse < Struct.new(
|
4605
5065
|
:asset_id,
|
5066
|
+
:asset_external_id,
|
4606
5067
|
:asset_name,
|
4607
5068
|
:asset_model_id,
|
4608
5069
|
:asset_property,
|
4609
|
-
:composite_model
|
4610
|
-
:asset_external_id)
|
5070
|
+
:composite_model)
|
4611
5071
|
SENSITIVE = []
|
4612
5072
|
include Aws::Structure
|
4613
5073
|
end
|
@@ -4638,6 +5098,10 @@ module Aws::IoTSiteWise
|
|
4638
5098
|
# The ID of the asset, in UUID format.
|
4639
5099
|
# @return [String]
|
4640
5100
|
#
|
5101
|
+
# @!attribute [rw] asset_external_id
|
5102
|
+
# The external ID of the asset, if any.
|
5103
|
+
# @return [String]
|
5104
|
+
#
|
4641
5105
|
# @!attribute [rw] asset_arn
|
4642
5106
|
# The [ARN][1] of the asset, which has the following format.
|
4643
5107
|
#
|
@@ -4695,12 +5159,9 @@ module Aws::IoTSiteWise
|
|
4695
5159
|
# the asset.
|
4696
5160
|
# @return [Array<Types::AssetCompositeModelSummary>]
|
4697
5161
|
#
|
4698
|
-
# @!attribute [rw] asset_external_id
|
4699
|
-
# The external ID of the asset, if any.
|
4700
|
-
# @return [String]
|
4701
|
-
#
|
4702
5162
|
class DescribeAssetResponse < Struct.new(
|
4703
5163
|
:asset_id,
|
5164
|
+
:asset_external_id,
|
4704
5165
|
:asset_arn,
|
4705
5166
|
:asset_name,
|
4706
5167
|
:asset_model_id,
|
@@ -4711,8 +5172,7 @@ module Aws::IoTSiteWise
|
|
4711
5172
|
:asset_last_update_date,
|
4712
5173
|
:asset_status,
|
4713
5174
|
:asset_description,
|
4714
|
-
:asset_composite_model_summaries
|
4715
|
-
:asset_external_id)
|
5175
|
+
:asset_composite_model_summaries)
|
4716
5176
|
SENSITIVE = []
|
4717
5177
|
include Aws::Structure
|
4718
5178
|
end
|
@@ -4818,6 +5278,126 @@ module Aws::IoTSiteWise
|
|
4818
5278
|
include Aws::Structure
|
4819
5279
|
end
|
4820
5280
|
|
5281
|
+
# @!attribute [rw] computation_model_id
|
5282
|
+
# The ID of the computation model.
|
5283
|
+
# @return [String]
|
5284
|
+
#
|
5285
|
+
# @!attribute [rw] resolve_to_resource_type
|
5286
|
+
# The type of the resolved resource.
|
5287
|
+
# @return [String]
|
5288
|
+
#
|
5289
|
+
# @!attribute [rw] resolve_to_resource_id
|
5290
|
+
# The ID of the resolved resource.
|
5291
|
+
# @return [String]
|
5292
|
+
#
|
5293
|
+
class DescribeComputationModelExecutionSummaryRequest < Struct.new(
|
5294
|
+
:computation_model_id,
|
5295
|
+
:resolve_to_resource_type,
|
5296
|
+
:resolve_to_resource_id)
|
5297
|
+
SENSITIVE = []
|
5298
|
+
include Aws::Structure
|
5299
|
+
end
|
5300
|
+
|
5301
|
+
# @!attribute [rw] computation_model_id
|
5302
|
+
# The ID of the computation model.
|
5303
|
+
# @return [String]
|
5304
|
+
#
|
5305
|
+
# @!attribute [rw] resolve_to
|
5306
|
+
# The detailed resource this execution summary resolves to.
|
5307
|
+
# @return [Types::ResolveTo]
|
5308
|
+
#
|
5309
|
+
# @!attribute [rw] computation_model_execution_summary
|
5310
|
+
# Contains the execution summary of the computation model.
|
5311
|
+
# @return [Hash<String,String>]
|
5312
|
+
#
|
5313
|
+
class DescribeComputationModelExecutionSummaryResponse < Struct.new(
|
5314
|
+
:computation_model_id,
|
5315
|
+
:resolve_to,
|
5316
|
+
:computation_model_execution_summary)
|
5317
|
+
SENSITIVE = []
|
5318
|
+
include Aws::Structure
|
5319
|
+
end
|
5320
|
+
|
5321
|
+
# @!attribute [rw] computation_model_id
|
5322
|
+
# The ID of the computation model.
|
5323
|
+
# @return [String]
|
5324
|
+
#
|
5325
|
+
class DescribeComputationModelRequest < Struct.new(
|
5326
|
+
:computation_model_id)
|
5327
|
+
SENSITIVE = []
|
5328
|
+
include Aws::Structure
|
5329
|
+
end
|
5330
|
+
|
5331
|
+
# @!attribute [rw] computation_model_id
|
5332
|
+
# The ID of the computation model.
|
5333
|
+
# @return [String]
|
5334
|
+
#
|
5335
|
+
# @!attribute [rw] computation_model_arn
|
5336
|
+
# The [ARN][1] of the computation model, which has the following
|
5337
|
+
# format.
|
5338
|
+
#
|
5339
|
+
# `arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}`
|
5340
|
+
#
|
5341
|
+
#
|
5342
|
+
#
|
5343
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
5344
|
+
# @return [String]
|
5345
|
+
#
|
5346
|
+
# @!attribute [rw] computation_model_name
|
5347
|
+
# The name of the computation model.
|
5348
|
+
# @return [String]
|
5349
|
+
#
|
5350
|
+
# @!attribute [rw] computation_model_description
|
5351
|
+
# The description of the computation model.
|
5352
|
+
# @return [String]
|
5353
|
+
#
|
5354
|
+
# @!attribute [rw] computation_model_configuration
|
5355
|
+
# The configuration for the computation model.
|
5356
|
+
# @return [Types::ComputationModelConfiguration]
|
5357
|
+
#
|
5358
|
+
# @!attribute [rw] computation_model_data_binding
|
5359
|
+
# The data binding for the computation model. Key is a variable name
|
5360
|
+
# defined in configuration. Value is a
|
5361
|
+
# `ComputationModelDataBindingValue` referenced by the variable.
|
5362
|
+
# @return [Hash<String,Types::ComputationModelDataBindingValue>]
|
5363
|
+
#
|
5364
|
+
# @!attribute [rw] computation_model_creation_date
|
5365
|
+
# The model creation date, in Unix epoch time.
|
5366
|
+
# @return [Time]
|
5367
|
+
#
|
5368
|
+
# @!attribute [rw] computation_model_last_update_date
|
5369
|
+
# The date the model was last updated, in Unix epoch time.
|
5370
|
+
# @return [Time]
|
5371
|
+
#
|
5372
|
+
# @!attribute [rw] computation_model_status
|
5373
|
+
# The current status of the asset model, which contains a state and an
|
5374
|
+
# error message if any.
|
5375
|
+
# @return [Types::ComputationModelStatus]
|
5376
|
+
#
|
5377
|
+
# @!attribute [rw] computation_model_version
|
5378
|
+
# The version of the computation model.
|
5379
|
+
# @return [String]
|
5380
|
+
#
|
5381
|
+
# @!attribute [rw] action_definitions
|
5382
|
+
# The available actions for this computation model.
|
5383
|
+
# @return [Array<Types::ActionDefinition>]
|
5384
|
+
#
|
5385
|
+
class DescribeComputationModelResponse < Struct.new(
|
5386
|
+
:computation_model_id,
|
5387
|
+
:computation_model_arn,
|
5388
|
+
:computation_model_name,
|
5389
|
+
:computation_model_description,
|
5390
|
+
:computation_model_configuration,
|
5391
|
+
:computation_model_data_binding,
|
5392
|
+
:computation_model_creation_date,
|
5393
|
+
:computation_model_last_update_date,
|
5394
|
+
:computation_model_status,
|
5395
|
+
:computation_model_version,
|
5396
|
+
:action_definitions)
|
5397
|
+
SENSITIVE = []
|
5398
|
+
include Aws::Structure
|
5399
|
+
end
|
5400
|
+
|
4821
5401
|
# @!attribute [rw] dashboard_id
|
4822
5402
|
# The ID of the dashboard.
|
4823
5403
|
# @return [String]
|
@@ -4979,16 +5559,99 @@ module Aws::IoTSiteWise
|
|
4979
5559
|
include Aws::Structure
|
4980
5560
|
end
|
4981
5561
|
|
5562
|
+
# @!attribute [rw] execution_id
|
5563
|
+
# The ID of the execution.
|
5564
|
+
# @return [String]
|
5565
|
+
#
|
5566
|
+
class DescribeExecutionRequest < Struct.new(
|
5567
|
+
:execution_id)
|
5568
|
+
SENSITIVE = []
|
5569
|
+
include Aws::Structure
|
5570
|
+
end
|
5571
|
+
|
5572
|
+
# @!attribute [rw] execution_id
|
5573
|
+
# The ID of the execution.
|
5574
|
+
# @return [String]
|
5575
|
+
#
|
5576
|
+
# @!attribute [rw] action_type
|
5577
|
+
# The type of action exectued.
|
5578
|
+
# @return [String]
|
5579
|
+
#
|
5580
|
+
# @!attribute [rw] target_resource
|
5581
|
+
# The resource the action will be taken on.
|
5582
|
+
# @return [Types::TargetResource]
|
5583
|
+
#
|
5584
|
+
# @!attribute [rw] target_resource_version
|
5585
|
+
# The version of the target resource.
|
5586
|
+
# @return [String]
|
5587
|
+
#
|
5588
|
+
# @!attribute [rw] resolve_to
|
5589
|
+
# The detailed resource this execution resolves to.
|
5590
|
+
# @return [Types::ResolveTo]
|
5591
|
+
#
|
5592
|
+
# @!attribute [rw] execution_start_time
|
5593
|
+
# The time the process started.
|
5594
|
+
# @return [Time]
|
5595
|
+
#
|
5596
|
+
# @!attribute [rw] execution_end_time
|
5597
|
+
# The time the process ended.
|
5598
|
+
# @return [Time]
|
5599
|
+
#
|
5600
|
+
# @!attribute [rw] execution_status
|
5601
|
+
# The status of the execution process.
|
5602
|
+
# @return [Types::ExecutionStatus]
|
5603
|
+
#
|
5604
|
+
# @!attribute [rw] execution_result
|
5605
|
+
# The result of the execution.
|
5606
|
+
# @return [Hash<String,String>]
|
5607
|
+
#
|
5608
|
+
# @!attribute [rw] execution_details
|
5609
|
+
# Provides detailed information about the execution of your anomaly
|
5610
|
+
# detection models. This includes model metrics and training
|
5611
|
+
# timestamps for both training and inference actions.
|
5612
|
+
#
|
5613
|
+
# * The training action (Amazon Web
|
5614
|
+
# Services/ANOMALY\_DETECTION\_TRAINING), includes performance
|
5615
|
+
# metrics that help you compare different versions of your anomaly
|
5616
|
+
# detection models. These metrics provide insights into the model's
|
5617
|
+
# performance during the training process.
|
5618
|
+
#
|
5619
|
+
# * The inference action (Amazon Web
|
5620
|
+
# Services/ANOMALY\_DETECTION\_INFERENCE), includes information
|
5621
|
+
# about the results of executing your anomaly detection models. This
|
5622
|
+
# helps you understand the output of your models and assess their
|
5623
|
+
# performance.
|
5624
|
+
# @return [Hash<String,String>]
|
5625
|
+
#
|
5626
|
+
# @!attribute [rw] execution_entity_version
|
5627
|
+
# Entity version used for the execution.
|
5628
|
+
# @return [String]
|
5629
|
+
#
|
5630
|
+
class DescribeExecutionResponse < Struct.new(
|
5631
|
+
:execution_id,
|
5632
|
+
:action_type,
|
5633
|
+
:target_resource,
|
5634
|
+
:target_resource_version,
|
5635
|
+
:resolve_to,
|
5636
|
+
:execution_start_time,
|
5637
|
+
:execution_end_time,
|
5638
|
+
:execution_status,
|
5639
|
+
:execution_result,
|
5640
|
+
:execution_details,
|
5641
|
+
:execution_entity_version)
|
5642
|
+
SENSITIVE = []
|
5643
|
+
include Aws::Structure
|
5644
|
+
end
|
5645
|
+
|
4982
5646
|
# @!attribute [rw] gateway_id
|
4983
5647
|
# The ID of the gateway that defines the capability configuration.
|
4984
5648
|
# @return [String]
|
4985
5649
|
#
|
4986
5650
|
# @!attribute [rw] capability_namespace
|
4987
5651
|
# The namespace of the capability configuration. For example, if you
|
4988
|
-
# configure OPC
|
5652
|
+
# configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA
|
4989
5653
|
# capability configuration has the namespace
|
4990
|
-
# `iotsitewise:opcuacollector:
|
4991
|
-
# such as `1`.
|
5654
|
+
# `iotsitewise:opcuacollector:3`.
|
4992
5655
|
# @return [String]
|
4993
5656
|
#
|
4994
5657
|
class DescribeGatewayCapabilityConfigurationRequest < Struct.new(
|
@@ -5017,23 +5680,21 @@ module Aws::IoTSiteWise
|
|
5017
5680
|
# @return [String]
|
5018
5681
|
#
|
5019
5682
|
# @!attribute [rw] capability_sync_status
|
5020
|
-
# The synchronization status of the capability configuration.
|
5021
|
-
# status can be one of the following:
|
5683
|
+
# The synchronization status of the gateway capability configuration.
|
5684
|
+
# The sync status can be one of the following:
|
5022
5685
|
#
|
5023
|
-
# * `IN_SYNC`
|
5686
|
+
# * `IN_SYNC` - The gateway is running with the latest configuration.
|
5024
5687
|
#
|
5025
|
-
# * `
|
5026
|
-
# capability configuration. This is most common when integrating
|
5027
|
-
# partner data sources, because the data integration is handled
|
5028
|
-
# externally by the partner.
|
5029
|
-
#
|
5030
|
-
# * `OUT_OF_SYNC` – The gateway hasn't received the capability
|
5688
|
+
# * `OUT_OF_SYNC` - The gateway hasn't received the latest
|
5031
5689
|
# configuration.
|
5032
5690
|
#
|
5033
|
-
# * `SYNC_FAILED`
|
5691
|
+
# * `SYNC_FAILED` - The gateway rejected the latest configuration.
|
5692
|
+
#
|
5693
|
+
# * `UNKNOWN` - The gateway hasn't reported its sync status.
|
5034
5694
|
#
|
5035
|
-
# * `
|
5036
|
-
#
|
5695
|
+
# * `NOT_APPLICABLE` - The gateway doesn't support this capability.
|
5696
|
+
# This is most common when integrating partner data sources, because
|
5697
|
+
# the data integration is handled externally by the partner.
|
5037
5698
|
# @return [String]
|
5038
5699
|
#
|
5039
5700
|
class DescribeGatewayCapabilityConfigurationResponse < Struct.new(
|
@@ -5688,11 +6349,16 @@ module Aws::IoTSiteWise
|
|
5688
6349
|
# new idempotent request is required.
|
5689
6350
|
# @return [String]
|
5690
6351
|
#
|
6352
|
+
# @!attribute [rw] resolve_to
|
6353
|
+
# The detailed resource this action resolves to.
|
6354
|
+
# @return [Types::ResolveTo]
|
6355
|
+
#
|
5691
6356
|
class ExecuteActionRequest < Struct.new(
|
5692
6357
|
:target_resource,
|
5693
6358
|
:action_definition_id,
|
5694
6359
|
:action_payload,
|
5695
|
-
:client_token
|
6360
|
+
:client_token,
|
6361
|
+
:resolve_to)
|
5696
6362
|
SENSITIVE = []
|
5697
6363
|
include Aws::Structure
|
5698
6364
|
end
|
@@ -5715,9 +6381,14 @@ module Aws::IoTSiteWise
|
|
5715
6381
|
# The string that specifies the next page of results.
|
5716
6382
|
# @return [String]
|
5717
6383
|
#
|
5718
|
-
# @!attribute [rw] max_results
|
5719
|
-
# The maximum number of results to return at one time.
|
5720
|
-
#
|
6384
|
+
# @!attribute [rw] max_results
|
6385
|
+
# The maximum number of results to return at one time.
|
6386
|
+
#
|
6387
|
+
# * Minimum is 1
|
6388
|
+
#
|
6389
|
+
# * Maximum is 20000
|
6390
|
+
#
|
6391
|
+
# * Default is 250
|
5721
6392
|
# @return [Integer]
|
5722
6393
|
#
|
5723
6394
|
# @!attribute [rw] client_token
|
@@ -5758,6 +6429,70 @@ module Aws::IoTSiteWise
|
|
5758
6429
|
include Aws::Structure
|
5759
6430
|
end
|
5760
6431
|
|
6432
|
+
# The status of the execution.
|
6433
|
+
#
|
6434
|
+
# @!attribute [rw] state
|
6435
|
+
# The current state of the computation model.
|
6436
|
+
# @return [String]
|
6437
|
+
#
|
6438
|
+
class ExecutionStatus < Struct.new(
|
6439
|
+
:state)
|
6440
|
+
SENSITIVE = []
|
6441
|
+
include Aws::Structure
|
6442
|
+
end
|
6443
|
+
|
6444
|
+
# Contains the execution summary of the computation model.
|
6445
|
+
#
|
6446
|
+
# @!attribute [rw] execution_id
|
6447
|
+
# The ID of the execution.
|
6448
|
+
# @return [String]
|
6449
|
+
#
|
6450
|
+
# @!attribute [rw] action_type
|
6451
|
+
# The type of action exectued.
|
6452
|
+
# @return [String]
|
6453
|
+
#
|
6454
|
+
# @!attribute [rw] target_resource
|
6455
|
+
# The resource the action will be taken on.
|
6456
|
+
# @return [Types::TargetResource]
|
6457
|
+
#
|
6458
|
+
# @!attribute [rw] target_resource_version
|
6459
|
+
# The version of the target resource.
|
6460
|
+
# @return [String]
|
6461
|
+
#
|
6462
|
+
# @!attribute [rw] resolve_to
|
6463
|
+
# The detailed resource this execution resolves to.
|
6464
|
+
# @return [Types::ResolveTo]
|
6465
|
+
#
|
6466
|
+
# @!attribute [rw] execution_start_time
|
6467
|
+
# The time the process started.
|
6468
|
+
# @return [Time]
|
6469
|
+
#
|
6470
|
+
# @!attribute [rw] execution_end_time
|
6471
|
+
# The time the process ended.
|
6472
|
+
# @return [Time]
|
6473
|
+
#
|
6474
|
+
# @!attribute [rw] execution_status
|
6475
|
+
# The status of the execution process.
|
6476
|
+
# @return [Types::ExecutionStatus]
|
6477
|
+
#
|
6478
|
+
# @!attribute [rw] execution_entity_version
|
6479
|
+
# The execution entity version associated with the summary.
|
6480
|
+
# @return [String]
|
6481
|
+
#
|
6482
|
+
class ExecutionSummary < Struct.new(
|
6483
|
+
:execution_id,
|
6484
|
+
:action_type,
|
6485
|
+
:target_resource,
|
6486
|
+
:target_resource_version,
|
6487
|
+
:resolve_to,
|
6488
|
+
:execution_start_time,
|
6489
|
+
:execution_end_time,
|
6490
|
+
:execution_status,
|
6491
|
+
:execution_entity_version)
|
6492
|
+
SENSITIVE = []
|
6493
|
+
include Aws::Structure
|
6494
|
+
end
|
6495
|
+
|
5761
6496
|
# Contains expression variable information.
|
5762
6497
|
#
|
5763
6498
|
# @!attribute [rw] name
|
@@ -5834,30 +6569,27 @@ module Aws::IoTSiteWise
|
|
5834
6569
|
#
|
5835
6570
|
# @!attribute [rw] capability_namespace
|
5836
6571
|
# The namespace of the capability configuration. For example, if you
|
5837
|
-
# configure OPC
|
6572
|
+
# configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA
|
5838
6573
|
# capability configuration has the namespace
|
5839
|
-
# `iotsitewise:opcuacollector:
|
5840
|
-
# such as `1`.
|
6574
|
+
# `iotsitewise:opcuacollector:3`.
|
5841
6575
|
# @return [String]
|
5842
6576
|
#
|
5843
6577
|
# @!attribute [rw] capability_sync_status
|
5844
|
-
# The synchronization status of the capability configuration.
|
5845
|
-
# status can be one of the following:
|
6578
|
+
# The synchronization status of the gateway capability configuration.
|
6579
|
+
# The sync status can be one of the following:
|
5846
6580
|
#
|
5847
|
-
# * `IN_SYNC`
|
6581
|
+
# * `IN_SYNC` - The gateway is running with the latest configuration.
|
5848
6582
|
#
|
5849
|
-
# * `
|
5850
|
-
# capability configuration. This is most common when integrating
|
5851
|
-
# partner data sources, because the data integration is handled
|
5852
|
-
# externally by the partner.
|
5853
|
-
#
|
5854
|
-
# * `OUT_OF_SYNC` – The gateway hasn't received the capability
|
6583
|
+
# * `OUT_OF_SYNC` - The gateway hasn't received the latest
|
5855
6584
|
# configuration.
|
5856
6585
|
#
|
5857
|
-
# * `SYNC_FAILED`
|
6586
|
+
# * `SYNC_FAILED` - The gateway rejected the latest configuration.
|
6587
|
+
#
|
6588
|
+
# * `UNKNOWN` - The gateway hasn't reported its sync status.
|
5858
6589
|
#
|
5859
|
-
# * `
|
5860
|
-
#
|
6590
|
+
# * `NOT_APPLICABLE` - The gateway doesn't support this capability.
|
6591
|
+
# This is most common when integrating partner data sources, because
|
6592
|
+
# the data integration is handled externally by the partner.
|
5861
6593
|
# @return [String]
|
5862
6594
|
#
|
5863
6595
|
class GatewayCapabilitySummary < Struct.new(
|
@@ -5867,7 +6599,19 @@ module Aws::IoTSiteWise
|
|
5867
6599
|
include Aws::Structure
|
5868
6600
|
end
|
5869
6601
|
|
5870
|
-
#
|
6602
|
+
# The gateway's platform configuration. You can only specify one
|
6603
|
+
# platform type in a gateway.
|
6604
|
+
#
|
6605
|
+
# (Legacy only) For Greengrass V1 gateways, specify the `greengrass`
|
6606
|
+
# parameter with a valid Greengrass group ARN.
|
6607
|
+
#
|
6608
|
+
# For Greengrass V2 gateways, specify the `greengrassV2` parameter with
|
6609
|
+
# a valid core device thing name. If creating a V3 gateway
|
6610
|
+
# (`gatewayVersion=3`), you must also specify the
|
6611
|
+
# `coreDeviceOperatingSystem`.
|
6612
|
+
#
|
6613
|
+
# For Siemens Industrial Edge gateways, specify the `siemensIE`
|
6614
|
+
# parameter with a valid IoT Core thing name.
|
5871
6615
|
#
|
5872
6616
|
# @!attribute [rw] greengrass
|
5873
6617
|
# A gateway that runs on IoT Greengrass.
|
@@ -5901,7 +6645,19 @@ module Aws::IoTSiteWise
|
|
5901
6645
|
# @return [String]
|
5902
6646
|
#
|
5903
6647
|
# @!attribute [rw] gateway_platform
|
5904
|
-
#
|
6648
|
+
# The gateway's platform configuration. You can only specify one
|
6649
|
+
# platform type in a gateway.
|
6650
|
+
#
|
6651
|
+
# (Legacy only) For Greengrass V1 gateways, specify the `greengrass`
|
6652
|
+
# parameter with a valid Greengrass group ARN.
|
6653
|
+
#
|
6654
|
+
# For Greengrass V2 gateways, specify the `greengrassV2` parameter
|
6655
|
+
# with a valid core device thing name. If creating a V3 gateway
|
6656
|
+
# (`gatewayVersion=3`), you must also specify the
|
6657
|
+
# `coreDeviceOperatingSystem`.
|
6658
|
+
#
|
6659
|
+
# For Siemens Industrial Edge gateways, specify the `siemensIE`
|
6660
|
+
# parameter with a valid IoT Core thing name.
|
5905
6661
|
# @return [Types::GatewayPlatform]
|
5906
6662
|
#
|
5907
6663
|
# @!attribute [rw] gateway_version
|
@@ -6358,6 +7114,9 @@ module Aws::IoTSiteWise
|
|
6358
7114
|
#
|
6359
7115
|
# @!attribute [rw] core_device_operating_system
|
6360
7116
|
# The operating system of the core device in IoT Greengrass V2.
|
7117
|
+
# Specifying the operating system is required for MQTT-enabled, V3
|
7118
|
+
# gateways (`gatewayVersion` `3`) and not applicable for Classic
|
7119
|
+
# stream, V2 gateways (`gatewayVersion` `2`).
|
6361
7120
|
# @return [String]
|
6362
7121
|
#
|
6363
7122
|
class GreengrassV2 < Struct.new(
|
@@ -6699,7 +7458,7 @@ module Aws::IoTSiteWise
|
|
6699
7458
|
include Aws::Structure
|
6700
7459
|
end
|
6701
7460
|
|
6702
|
-
# You've reached the
|
7461
|
+
# You've reached the quota for a resource. For example, this can occur
|
6703
7462
|
# if you're trying to associate more than the allowed number of child
|
6704
7463
|
# assets or attempting to create more than the allowed number of
|
6705
7464
|
# properties for an asset model.
|
@@ -6806,11 +7565,21 @@ module Aws::IoTSiteWise
|
|
6806
7565
|
# The maximum number of results to return for each paginated request.
|
6807
7566
|
# @return [Integer]
|
6808
7567
|
#
|
7568
|
+
# @!attribute [rw] resolve_to_resource_type
|
7569
|
+
# The type of the resolved resource.
|
7570
|
+
# @return [String]
|
7571
|
+
#
|
7572
|
+
# @!attribute [rw] resolve_to_resource_id
|
7573
|
+
# The ID of the resolved resource.
|
7574
|
+
# @return [String]
|
7575
|
+
#
|
6809
7576
|
class ListActionsRequest < Struct.new(
|
6810
7577
|
:target_resource_type,
|
6811
7578
|
:target_resource_id,
|
6812
7579
|
:next_token,
|
6813
|
-
:max_results
|
7580
|
+
:max_results,
|
7581
|
+
:resolve_to_resource_type,
|
7582
|
+
:resolve_to_resource_id)
|
6814
7583
|
SENSITIVE = []
|
6815
7584
|
include Aws::Structure
|
6816
7585
|
end
|
@@ -7354,6 +8123,122 @@ module Aws::IoTSiteWise
|
|
7354
8123
|
include Aws::Structure
|
7355
8124
|
end
|
7356
8125
|
|
8126
|
+
# @!attribute [rw] data_binding_value_filter
|
8127
|
+
# A filter used to limit the returned data binding usages based on
|
8128
|
+
# specific data binding values. You can filter by asset, asset model,
|
8129
|
+
# asset property, or asset model property to find all computation
|
8130
|
+
# models using these specific data sources.
|
8131
|
+
# @return [Types::DataBindingValueFilter]
|
8132
|
+
#
|
8133
|
+
# @!attribute [rw] next_token
|
8134
|
+
# The token used for the next set of paginated results.
|
8135
|
+
# @return [String]
|
8136
|
+
#
|
8137
|
+
# @!attribute [rw] max_results
|
8138
|
+
# The maximum number of results returned for each paginated request.
|
8139
|
+
# @return [Integer]
|
8140
|
+
#
|
8141
|
+
class ListComputationModelDataBindingUsagesRequest < Struct.new(
|
8142
|
+
:data_binding_value_filter,
|
8143
|
+
:next_token,
|
8144
|
+
:max_results)
|
8145
|
+
SENSITIVE = []
|
8146
|
+
include Aws::Structure
|
8147
|
+
end
|
8148
|
+
|
8149
|
+
# @!attribute [rw] data_binding_usage_summaries
|
8150
|
+
# A list of summaries describing the data binding usages across
|
8151
|
+
# computation models. Each summary includes the computation model IDs
|
8152
|
+
# and the matched data binding details.
|
8153
|
+
# @return [Array<Types::ComputationModelDataBindingUsageSummary>]
|
8154
|
+
#
|
8155
|
+
# @!attribute [rw] next_token
|
8156
|
+
# The token for the next set of paginated results, or null if there
|
8157
|
+
# are no additional results.
|
8158
|
+
# @return [String]
|
8159
|
+
#
|
8160
|
+
class ListComputationModelDataBindingUsagesResponse < Struct.new(
|
8161
|
+
:data_binding_usage_summaries,
|
8162
|
+
:next_token)
|
8163
|
+
SENSITIVE = []
|
8164
|
+
include Aws::Structure
|
8165
|
+
end
|
8166
|
+
|
8167
|
+
# @!attribute [rw] computation_model_id
|
8168
|
+
# The ID of the computation model for which to list resolved
|
8169
|
+
# resources.
|
8170
|
+
# @return [String]
|
8171
|
+
#
|
8172
|
+
# @!attribute [rw] next_token
|
8173
|
+
# The token used for the next set of paginated results.
|
8174
|
+
# @return [String]
|
8175
|
+
#
|
8176
|
+
# @!attribute [rw] max_results
|
8177
|
+
# The maximum number of results returned for each paginated request.
|
8178
|
+
# @return [Integer]
|
8179
|
+
#
|
8180
|
+
class ListComputationModelResolveToResourcesRequest < Struct.new(
|
8181
|
+
:computation_model_id,
|
8182
|
+
:next_token,
|
8183
|
+
:max_results)
|
8184
|
+
SENSITIVE = []
|
8185
|
+
include Aws::Structure
|
8186
|
+
end
|
8187
|
+
|
8188
|
+
# @!attribute [rw] computation_model_resolve_to_resource_summaries
|
8189
|
+
# A list of summaries describing the distinct resources that this
|
8190
|
+
# computation model resolves to when actions were executed.
|
8191
|
+
# @return [Array<Types::ComputationModelResolveToResourceSummary>]
|
8192
|
+
#
|
8193
|
+
# @!attribute [rw] next_token
|
8194
|
+
# The token for the next set of paginated results, or null if there
|
8195
|
+
# are no additional results.
|
8196
|
+
# @return [String]
|
8197
|
+
#
|
8198
|
+
class ListComputationModelResolveToResourcesResponse < Struct.new(
|
8199
|
+
:computation_model_resolve_to_resource_summaries,
|
8200
|
+
:next_token)
|
8201
|
+
SENSITIVE = []
|
8202
|
+
include Aws::Structure
|
8203
|
+
end
|
8204
|
+
|
8205
|
+
# @!attribute [rw] computation_model_type
|
8206
|
+
# The type of computation model. If a `computationModelType` is not
|
8207
|
+
# provided, all types of computation models are returned.
|
8208
|
+
# @return [String]
|
8209
|
+
#
|
8210
|
+
# @!attribute [rw] next_token
|
8211
|
+
# The token to be used for the next set of paginated results.
|
8212
|
+
# @return [String]
|
8213
|
+
#
|
8214
|
+
# @!attribute [rw] max_results
|
8215
|
+
# The maximum number of results to return for each paginated request.
|
8216
|
+
# @return [Integer]
|
8217
|
+
#
|
8218
|
+
class ListComputationModelsRequest < Struct.new(
|
8219
|
+
:computation_model_type,
|
8220
|
+
:next_token,
|
8221
|
+
:max_results)
|
8222
|
+
SENSITIVE = []
|
8223
|
+
include Aws::Structure
|
8224
|
+
end
|
8225
|
+
|
8226
|
+
# @!attribute [rw] computation_model_summaries
|
8227
|
+
# A list summarizing each computation model.
|
8228
|
+
# @return [Array<Types::ComputationModelSummary>]
|
8229
|
+
#
|
8230
|
+
# @!attribute [rw] next_token
|
8231
|
+
# The token for the next set of results, or null if there are no
|
8232
|
+
# additional results.
|
8233
|
+
# @return [String]
|
8234
|
+
#
|
8235
|
+
class ListComputationModelsResponse < Struct.new(
|
8236
|
+
:computation_model_summaries,
|
8237
|
+
:next_token)
|
8238
|
+
SENSITIVE = []
|
8239
|
+
include Aws::Structure
|
8240
|
+
end
|
8241
|
+
|
7357
8242
|
# @!attribute [rw] project_id
|
7358
8243
|
# The ID of the project.
|
7359
8244
|
# @return [String]
|
@@ -7429,6 +8314,62 @@ module Aws::IoTSiteWise
|
|
7429
8314
|
include Aws::Structure
|
7430
8315
|
end
|
7431
8316
|
|
8317
|
+
# @!attribute [rw] target_resource_type
|
8318
|
+
# The type of the target resource.
|
8319
|
+
# @return [String]
|
8320
|
+
#
|
8321
|
+
# @!attribute [rw] target_resource_id
|
8322
|
+
# The ID of the target resource.
|
8323
|
+
# @return [String]
|
8324
|
+
#
|
8325
|
+
# @!attribute [rw] resolve_to_resource_type
|
8326
|
+
# The type of the resolved resource.
|
8327
|
+
# @return [String]
|
8328
|
+
#
|
8329
|
+
# @!attribute [rw] resolve_to_resource_id
|
8330
|
+
# The ID of the resolved resource.
|
8331
|
+
# @return [String]
|
8332
|
+
#
|
8333
|
+
# @!attribute [rw] next_token
|
8334
|
+
# The token used for the next set of paginated results.
|
8335
|
+
# @return [String]
|
8336
|
+
#
|
8337
|
+
# @!attribute [rw] max_results
|
8338
|
+
# The maximum number of results returned for each paginated request.
|
8339
|
+
# @return [Integer]
|
8340
|
+
#
|
8341
|
+
# @!attribute [rw] action_type
|
8342
|
+
# The type of action exectued.
|
8343
|
+
# @return [String]
|
8344
|
+
#
|
8345
|
+
class ListExecutionsRequest < Struct.new(
|
8346
|
+
:target_resource_type,
|
8347
|
+
:target_resource_id,
|
8348
|
+
:resolve_to_resource_type,
|
8349
|
+
:resolve_to_resource_id,
|
8350
|
+
:next_token,
|
8351
|
+
:max_results,
|
8352
|
+
:action_type)
|
8353
|
+
SENSITIVE = []
|
8354
|
+
include Aws::Structure
|
8355
|
+
end
|
8356
|
+
|
8357
|
+
# @!attribute [rw] execution_summaries
|
8358
|
+
# Contains the list of execution summaries of the computation models.
|
8359
|
+
# @return [Array<Types::ExecutionSummary>]
|
8360
|
+
#
|
8361
|
+
# @!attribute [rw] next_token
|
8362
|
+
# The token for the next set of results, or null if there are no
|
8363
|
+
# additional results.
|
8364
|
+
# @return [String]
|
8365
|
+
#
|
8366
|
+
class ListExecutionsResponse < Struct.new(
|
8367
|
+
:execution_summaries,
|
8368
|
+
:next_token)
|
8369
|
+
SENSITIVE = []
|
8370
|
+
include Aws::Structure
|
8371
|
+
end
|
8372
|
+
|
7432
8373
|
# @!attribute [rw] next_token
|
7433
8374
|
# The token to be used for the next set of paginated results.
|
7434
8375
|
# @return [String]
|
@@ -7688,6 +8629,18 @@ module Aws::IoTSiteWise
|
|
7688
8629
|
include Aws::Structure
|
7689
8630
|
end
|
7690
8631
|
|
8632
|
+
# Represents a data binding that matches the specified filter criteria.
|
8633
|
+
#
|
8634
|
+
# @!attribute [rw] value
|
8635
|
+
# The value of the matched data binding.
|
8636
|
+
# @return [Types::DataBindingValue]
|
8637
|
+
#
|
8638
|
+
class MatchedDataBinding < Struct.new(
|
8639
|
+
:value)
|
8640
|
+
SENSITIVE = []
|
8641
|
+
include Aws::Structure
|
8642
|
+
end
|
8643
|
+
|
7691
8644
|
# Contains an asset measurement property. For more information, see
|
7692
8645
|
# [Measurements][1] in the *IoT SiteWise User Guide*.
|
7693
8646
|
#
|
@@ -8024,6 +8977,15 @@ module Aws::IoTSiteWise
|
|
8024
8977
|
# The ID of the asset property.
|
8025
8978
|
# @return [String]
|
8026
8979
|
#
|
8980
|
+
# @!attribute [rw] external_id
|
8981
|
+
# The external ID of the asset property. For more information, see
|
8982
|
+
# [Using external IDs][1] in the *IoT SiteWise User Guide*.
|
8983
|
+
#
|
8984
|
+
#
|
8985
|
+
#
|
8986
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
8987
|
+
# @return [String]
|
8988
|
+
#
|
8027
8989
|
# @!attribute [rw] name
|
8028
8990
|
# The name of the property.
|
8029
8991
|
# @return [String]
|
@@ -8066,25 +9028,16 @@ module Aws::IoTSiteWise
|
|
8066
9028
|
# The structured path to the property from the root of the asset.
|
8067
9029
|
# @return [Array<Types::AssetPropertyPathSegment>]
|
8068
9030
|
#
|
8069
|
-
# @!attribute [rw] external_id
|
8070
|
-
# The external ID of the asset property. For more information, see
|
8071
|
-
# [Using external IDs][1] in the *IoT SiteWise User Guide*.
|
8072
|
-
#
|
8073
|
-
#
|
8074
|
-
#
|
8075
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
8076
|
-
# @return [String]
|
8077
|
-
#
|
8078
9031
|
class Property < Struct.new(
|
8079
9032
|
:id,
|
9033
|
+
:external_id,
|
8080
9034
|
:name,
|
8081
9035
|
:alias,
|
8082
9036
|
:notification,
|
8083
9037
|
:data_type,
|
8084
9038
|
:unit,
|
8085
9039
|
:type,
|
8086
|
-
:path
|
8087
|
-
:external_id)
|
9040
|
+
:path)
|
8088
9041
|
SENSITIVE = []
|
8089
9042
|
include Aws::Structure
|
8090
9043
|
end
|
@@ -8444,6 +9397,18 @@ module Aws::IoTSiteWise
|
|
8444
9397
|
include Aws::Structure
|
8445
9398
|
end
|
8446
9399
|
|
9400
|
+
# The detailed resource this execution summary resolves to.
|
9401
|
+
#
|
9402
|
+
# @!attribute [rw] asset_id
|
9403
|
+
# The ID of the asset that the resource resolves to.
|
9404
|
+
# @return [String]
|
9405
|
+
#
|
9406
|
+
class ResolveTo < Struct.new(
|
9407
|
+
:asset_id)
|
9408
|
+
SENSITIVE = []
|
9409
|
+
include Aws::Structure
|
9410
|
+
end
|
9411
|
+
|
8447
9412
|
# Contains an IoT SiteWise Monitor resource ID for a portal or project.
|
8448
9413
|
#
|
8449
9414
|
# @!attribute [rw] portal
|
@@ -8624,8 +9589,13 @@ module Aws::IoTSiteWise
|
|
8624
9589
|
# The ID of the asset, in UUID format.
|
8625
9590
|
# @return [String]
|
8626
9591
|
#
|
9592
|
+
# @!attribute [rw] computation_model_id
|
9593
|
+
# The ID of the computation model.
|
9594
|
+
# @return [String]
|
9595
|
+
#
|
8627
9596
|
class TargetResource < Struct.new(
|
8628
|
-
:asset_id
|
9597
|
+
:asset_id,
|
9598
|
+
:computation_model_id)
|
8629
9599
|
SENSITIVE = []
|
8630
9600
|
include Aws::Structure
|
8631
9601
|
end
|
@@ -8736,7 +9706,7 @@ module Aws::IoTSiteWise
|
|
8736
9706
|
include Aws::Structure
|
8737
9707
|
end
|
8738
9708
|
|
8739
|
-
# You've reached the
|
9709
|
+
# You've reached the quota for the number of tags allowed for a
|
8740
9710
|
# resource. For more information, see [Tag naming limits and
|
8741
9711
|
# requirements][1] in the *Amazon Web Services General Reference*.
|
8742
9712
|
#
|
@@ -9333,6 +10303,17 @@ module Aws::IoTSiteWise
|
|
9333
10303
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
9334
10304
|
# @return [String]
|
9335
10305
|
#
|
10306
|
+
# @!attribute [rw] asset_external_id
|
10307
|
+
# An external ID to assign to the asset. The asset must not already
|
10308
|
+
# have an external ID. The external ID must be unique within your
|
10309
|
+
# Amazon Web Services account. For more information, see [Using
|
10310
|
+
# external IDs][1] in the *IoT SiteWise User Guide*.
|
10311
|
+
#
|
10312
|
+
#
|
10313
|
+
#
|
10314
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
10315
|
+
# @return [String]
|
10316
|
+
#
|
9336
10317
|
# @!attribute [rw] asset_name
|
9337
10318
|
# A friendly name for the asset.
|
9338
10319
|
# @return [String]
|
@@ -9350,23 +10331,12 @@ module Aws::IoTSiteWise
|
|
9350
10331
|
# A description for the asset.
|
9351
10332
|
# @return [String]
|
9352
10333
|
#
|
9353
|
-
# @!attribute [rw] asset_external_id
|
9354
|
-
# An external ID to assign to the asset. The asset must not already
|
9355
|
-
# have an external ID. The external ID must be unique within your
|
9356
|
-
# Amazon Web Services account. For more information, see [Using
|
9357
|
-
# external IDs][1] in the *IoT SiteWise User Guide*.
|
9358
|
-
#
|
9359
|
-
#
|
9360
|
-
#
|
9361
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
9362
|
-
# @return [String]
|
9363
|
-
#
|
9364
10334
|
class UpdateAssetRequest < Struct.new(
|
9365
10335
|
:asset_id,
|
10336
|
+
:asset_external_id,
|
9366
10337
|
:asset_name,
|
9367
10338
|
:client_token,
|
9368
|
-
:asset_description
|
9369
|
-
:asset_external_id)
|
10339
|
+
:asset_description)
|
9370
10340
|
SENSITIVE = []
|
9371
10341
|
include Aws::Structure
|
9372
10342
|
end
|
@@ -9382,6 +10352,60 @@ module Aws::IoTSiteWise
|
|
9382
10352
|
include Aws::Structure
|
9383
10353
|
end
|
9384
10354
|
|
10355
|
+
# @!attribute [rw] computation_model_id
|
10356
|
+
# The ID of the computation model.
|
10357
|
+
# @return [String]
|
10358
|
+
#
|
10359
|
+
# @!attribute [rw] computation_model_name
|
10360
|
+
# The name of the computation model.
|
10361
|
+
# @return [String]
|
10362
|
+
#
|
10363
|
+
# @!attribute [rw] computation_model_description
|
10364
|
+
# The description of the computation model.
|
10365
|
+
# @return [String]
|
10366
|
+
#
|
10367
|
+
# @!attribute [rw] computation_model_configuration
|
10368
|
+
# The configuration for the computation model.
|
10369
|
+
# @return [Types::ComputationModelConfiguration]
|
10370
|
+
#
|
10371
|
+
# @!attribute [rw] computation_model_data_binding
|
10372
|
+
# The data binding for the computation model. Key is a variable name
|
10373
|
+
# defined in configuration. Value is a
|
10374
|
+
# `ComputationModelDataBindingValue` referenced by the variable.
|
10375
|
+
# @return [Hash<String,Types::ComputationModelDataBindingValue>]
|
10376
|
+
#
|
10377
|
+
# @!attribute [rw] client_token
|
10378
|
+
# A unique case-sensitive identifier that you can provide to ensure
|
10379
|
+
# the idempotency of the request. Don't reuse this client token if a
|
10380
|
+
# new idempotent request is required.
|
10381
|
+
#
|
10382
|
+
# **A suitable default value is auto-generated.** You should normally
|
10383
|
+
# not need to pass this option.
|
10384
|
+
# @return [String]
|
10385
|
+
#
|
10386
|
+
class UpdateComputationModelRequest < Struct.new(
|
10387
|
+
:computation_model_id,
|
10388
|
+
:computation_model_name,
|
10389
|
+
:computation_model_description,
|
10390
|
+
:computation_model_configuration,
|
10391
|
+
:computation_model_data_binding,
|
10392
|
+
:client_token)
|
10393
|
+
SENSITIVE = []
|
10394
|
+
include Aws::Structure
|
10395
|
+
end
|
10396
|
+
|
10397
|
+
# @!attribute [rw] computation_model_status
|
10398
|
+
# The status of the computation model. It contains a state (UPDATING
|
10399
|
+
# after successfully calling this operation) and an error message if
|
10400
|
+
# any.
|
10401
|
+
# @return [Types::ComputationModelStatus]
|
10402
|
+
#
|
10403
|
+
class UpdateComputationModelResponse < Struct.new(
|
10404
|
+
:computation_model_status)
|
10405
|
+
SENSITIVE = []
|
10406
|
+
include Aws::Structure
|
10407
|
+
end
|
10408
|
+
|
9385
10409
|
# @!attribute [rw] dashboard_id
|
9386
10410
|
# The ID of the dashboard to update.
|
9387
10411
|
# @return [String]
|
@@ -9499,10 +10523,9 @@ module Aws::IoTSiteWise
|
|
9499
10523
|
#
|
9500
10524
|
# @!attribute [rw] capability_namespace
|
9501
10525
|
# The namespace of the gateway capability configuration to be updated.
|
9502
|
-
# For example, if you configure OPC
|
9503
|
-
#
|
9504
|
-
# `iotsitewise:opcuacollector:
|
9505
|
-
# such as `1`.
|
10526
|
+
# For example, if you configure OPC UA sources for an MQTT-enabled
|
10527
|
+
# gateway, your OPC-UA capability configuration has the namespace
|
10528
|
+
# `iotsitewise:opcuacollector:3`.
|
9506
10529
|
# @return [String]
|
9507
10530
|
#
|
9508
10531
|
# @!attribute [rw] capability_configuration
|
@@ -9528,23 +10551,21 @@ module Aws::IoTSiteWise
|
|
9528
10551
|
# @return [String]
|
9529
10552
|
#
|
9530
10553
|
# @!attribute [rw] capability_sync_status
|
9531
|
-
# The synchronization status of the capability configuration.
|
9532
|
-
# status can be one of the following:
|
10554
|
+
# The synchronization status of the gateway capability configuration.
|
10555
|
+
# The sync status can be one of the following:
|
9533
10556
|
#
|
9534
|
-
# * `IN_SYNC`
|
10557
|
+
# * `IN_SYNC` - The gateway is running with the latest configuration.
|
9535
10558
|
#
|
9536
|
-
# * `
|
9537
|
-
# capability configuration. This is most common when integrating
|
9538
|
-
# partner data sources, because the data integration is handled
|
9539
|
-
# externally by the partner.
|
9540
|
-
#
|
9541
|
-
# * `OUT_OF_SYNC` – The gateway hasn't received the capability
|
10559
|
+
# * `OUT_OF_SYNC` - The gateway hasn't received the latest
|
9542
10560
|
# configuration.
|
9543
10561
|
#
|
9544
|
-
# * `SYNC_FAILED`
|
10562
|
+
# * `SYNC_FAILED` - The gateway rejected the latest configuration.
|
10563
|
+
#
|
10564
|
+
# * `UNKNOWN` - The gateway hasn't reported its sync status.
|
9545
10565
|
#
|
9546
|
-
# * `
|
9547
|
-
#
|
10566
|
+
# * `NOT_APPLICABLE` - The gateway doesn't support this capability.
|
10567
|
+
# This is most common when integrating partner data sources, because
|
10568
|
+
# the data integration is handled externally by the partner.
|
9548
10569
|
#
|
9549
10570
|
# After you update a capability configuration, its sync status is
|
9550
10571
|
# `OUT_OF_SYNC` until the gateway receives and applies or rejects the
|