aws-sdk-iotsitewise 1.47.0 → 1.49.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +13 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +5 -2
- data/lib/aws-sdk-iotsitewise/client_api.rb +2 -0
- data/lib/aws-sdk-iotsitewise/endpoint_provider.rb +38 -96
- data/lib/aws-sdk-iotsitewise/types.rb +25 -1864
- data/lib/aws-sdk-iotsitewise.rb +1 -1
- metadata +2 -2
@@ -123,14 +123,6 @@ module Aws::IoTSiteWise
|
|
123
123
|
#
|
124
124
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
|
125
125
|
#
|
126
|
-
# @note When making an API call, you may pass Alarms
|
127
|
-
# data as a hash:
|
128
|
-
#
|
129
|
-
# {
|
130
|
-
# alarm_role_arn: "ARN", # required
|
131
|
-
# notification_lambda_arn: "ARN",
|
132
|
-
# }
|
133
|
-
#
|
134
126
|
# @!attribute [rw] alarm_role_arn
|
135
127
|
# The [ARN][1] of the IAM role that allows the alarm to perform
|
136
128
|
# actions and access Amazon Web Services resources and services, such
|
@@ -262,76 +254,6 @@ module Aws::IoTSiteWise
|
|
262
254
|
# object contains the asset property definitions that you define in the
|
263
255
|
# composite model.
|
264
256
|
#
|
265
|
-
# @note When making an API call, you may pass AssetModelCompositeModel
|
266
|
-
# data as a hash:
|
267
|
-
#
|
268
|
-
# {
|
269
|
-
# name: "Name", # required
|
270
|
-
# description: "Description",
|
271
|
-
# type: "Name", # required
|
272
|
-
# properties: [
|
273
|
-
# {
|
274
|
-
# id: "ID",
|
275
|
-
# name: "Name", # required
|
276
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
277
|
-
# data_type_spec: "Name",
|
278
|
-
# unit: "PropertyUnit",
|
279
|
-
# type: { # required
|
280
|
-
# attribute: {
|
281
|
-
# default_value: "DefaultValue",
|
282
|
-
# },
|
283
|
-
# measurement: {
|
284
|
-
# processing_config: {
|
285
|
-
# forwarding_config: { # required
|
286
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
287
|
-
# },
|
288
|
-
# },
|
289
|
-
# },
|
290
|
-
# transform: {
|
291
|
-
# expression: "Expression", # required
|
292
|
-
# variables: [ # required
|
293
|
-
# {
|
294
|
-
# name: "VariableName", # required
|
295
|
-
# value: { # required
|
296
|
-
# property_id: "Macro", # required
|
297
|
-
# hierarchy_id: "Macro",
|
298
|
-
# },
|
299
|
-
# },
|
300
|
-
# ],
|
301
|
-
# processing_config: {
|
302
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
303
|
-
# forwarding_config: {
|
304
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
305
|
-
# },
|
306
|
-
# },
|
307
|
-
# },
|
308
|
-
# metric: {
|
309
|
-
# expression: "Expression", # required
|
310
|
-
# variables: [ # required
|
311
|
-
# {
|
312
|
-
# name: "VariableName", # required
|
313
|
-
# value: { # required
|
314
|
-
# property_id: "Macro", # required
|
315
|
-
# hierarchy_id: "Macro",
|
316
|
-
# },
|
317
|
-
# },
|
318
|
-
# ],
|
319
|
-
# window: { # required
|
320
|
-
# tumbling: {
|
321
|
-
# interval: "Interval", # required
|
322
|
-
# offset: "Offset",
|
323
|
-
# },
|
324
|
-
# },
|
325
|
-
# processing_config: {
|
326
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
327
|
-
# },
|
328
|
-
# },
|
329
|
-
# },
|
330
|
-
# },
|
331
|
-
# ],
|
332
|
-
# id: "ID",
|
333
|
-
# }
|
334
|
-
#
|
335
257
|
# @!attribute [rw] name
|
336
258
|
# The name of the composite model.
|
337
259
|
# @return [String]
|
@@ -367,74 +289,6 @@ module Aws::IoTSiteWise
|
|
367
289
|
# composite model definition is applied to all assets created from the
|
368
290
|
# asset model.
|
369
291
|
#
|
370
|
-
# @note When making an API call, you may pass AssetModelCompositeModelDefinition
|
371
|
-
# data as a hash:
|
372
|
-
#
|
373
|
-
# {
|
374
|
-
# name: "Name", # required
|
375
|
-
# description: "Description",
|
376
|
-
# type: "Name", # required
|
377
|
-
# properties: [
|
378
|
-
# {
|
379
|
-
# name: "Name", # required
|
380
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
381
|
-
# data_type_spec: "Name",
|
382
|
-
# unit: "PropertyUnit",
|
383
|
-
# type: { # required
|
384
|
-
# attribute: {
|
385
|
-
# default_value: "DefaultValue",
|
386
|
-
# },
|
387
|
-
# measurement: {
|
388
|
-
# processing_config: {
|
389
|
-
# forwarding_config: { # required
|
390
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
391
|
-
# },
|
392
|
-
# },
|
393
|
-
# },
|
394
|
-
# transform: {
|
395
|
-
# expression: "Expression", # required
|
396
|
-
# variables: [ # required
|
397
|
-
# {
|
398
|
-
# name: "VariableName", # required
|
399
|
-
# value: { # required
|
400
|
-
# property_id: "Macro", # required
|
401
|
-
# hierarchy_id: "Macro",
|
402
|
-
# },
|
403
|
-
# },
|
404
|
-
# ],
|
405
|
-
# processing_config: {
|
406
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
407
|
-
# forwarding_config: {
|
408
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
409
|
-
# },
|
410
|
-
# },
|
411
|
-
# },
|
412
|
-
# metric: {
|
413
|
-
# expression: "Expression", # required
|
414
|
-
# variables: [ # required
|
415
|
-
# {
|
416
|
-
# name: "VariableName", # required
|
417
|
-
# value: { # required
|
418
|
-
# property_id: "Macro", # required
|
419
|
-
# hierarchy_id: "Macro",
|
420
|
-
# },
|
421
|
-
# },
|
422
|
-
# ],
|
423
|
-
# window: { # required
|
424
|
-
# tumbling: {
|
425
|
-
# interval: "Interval", # required
|
426
|
-
# offset: "Offset",
|
427
|
-
# },
|
428
|
-
# },
|
429
|
-
# processing_config: {
|
430
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
431
|
-
# },
|
432
|
-
# },
|
433
|
-
# },
|
434
|
-
# },
|
435
|
-
# ],
|
436
|
-
# }
|
437
|
-
#
|
438
292
|
# @!attribute [rw] name
|
439
293
|
# The name of the composite model.
|
440
294
|
# @return [String]
|
@@ -465,15 +319,6 @@ module Aws::IoTSiteWise
|
|
465
319
|
# and child asset model ID that specifies the type of asset that can be
|
466
320
|
# in this hierarchy.
|
467
321
|
#
|
468
|
-
# @note When making an API call, you may pass AssetModelHierarchy
|
469
|
-
# data as a hash:
|
470
|
-
#
|
471
|
-
# {
|
472
|
-
# id: "ID",
|
473
|
-
# name: "Name", # required
|
474
|
-
# child_asset_model_id: "ID", # required
|
475
|
-
# }
|
476
|
-
#
|
477
322
|
# @!attribute [rw] id
|
478
323
|
# The ID of the asset model hierarchy. This ID is a `hierarchyId`.
|
479
324
|
# @return [String]
|
@@ -505,14 +350,6 @@ module Aws::IoTSiteWise
|
|
505
350
|
# asset model hierarchy determines the kind (or type) of asset that can
|
506
351
|
# belong to a hierarchy.
|
507
352
|
#
|
508
|
-
# @note When making an API call, you may pass AssetModelHierarchyDefinition
|
509
|
-
# data as a hash:
|
510
|
-
#
|
511
|
-
# {
|
512
|
-
# name: "Name", # required
|
513
|
-
# child_asset_model_id: "ID", # required
|
514
|
-
# }
|
515
|
-
#
|
516
353
|
# @!attribute [rw] name
|
517
354
|
# The name of the asset model hierarchy definition (as specified in
|
518
355
|
# the [CreateAssetModel][1] or [UpdateAssetModel][2] API operation).
|
@@ -536,68 +373,6 @@ module Aws::IoTSiteWise
|
|
536
373
|
|
537
374
|
# Contains information about an asset model property.
|
538
375
|
#
|
539
|
-
# @note When making an API call, you may pass AssetModelProperty
|
540
|
-
# data as a hash:
|
541
|
-
#
|
542
|
-
# {
|
543
|
-
# id: "ID",
|
544
|
-
# name: "Name", # required
|
545
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
546
|
-
# data_type_spec: "Name",
|
547
|
-
# unit: "PropertyUnit",
|
548
|
-
# type: { # required
|
549
|
-
# attribute: {
|
550
|
-
# default_value: "DefaultValue",
|
551
|
-
# },
|
552
|
-
# measurement: {
|
553
|
-
# processing_config: {
|
554
|
-
# forwarding_config: { # required
|
555
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
556
|
-
# },
|
557
|
-
# },
|
558
|
-
# },
|
559
|
-
# transform: {
|
560
|
-
# expression: "Expression", # required
|
561
|
-
# variables: [ # required
|
562
|
-
# {
|
563
|
-
# name: "VariableName", # required
|
564
|
-
# value: { # required
|
565
|
-
# property_id: "Macro", # required
|
566
|
-
# hierarchy_id: "Macro",
|
567
|
-
# },
|
568
|
-
# },
|
569
|
-
# ],
|
570
|
-
# processing_config: {
|
571
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
572
|
-
# forwarding_config: {
|
573
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
574
|
-
# },
|
575
|
-
# },
|
576
|
-
# },
|
577
|
-
# metric: {
|
578
|
-
# expression: "Expression", # required
|
579
|
-
# variables: [ # required
|
580
|
-
# {
|
581
|
-
# name: "VariableName", # required
|
582
|
-
# value: { # required
|
583
|
-
# property_id: "Macro", # required
|
584
|
-
# hierarchy_id: "Macro",
|
585
|
-
# },
|
586
|
-
# },
|
587
|
-
# ],
|
588
|
-
# window: { # required
|
589
|
-
# tumbling: {
|
590
|
-
# interval: "Interval", # required
|
591
|
-
# offset: "Offset",
|
592
|
-
# },
|
593
|
-
# },
|
594
|
-
# processing_config: {
|
595
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
596
|
-
# },
|
597
|
-
# },
|
598
|
-
# },
|
599
|
-
# }
|
600
|
-
#
|
601
376
|
# @!attribute [rw] id
|
602
377
|
# The ID of the asset model property.
|
603
378
|
# @return [String]
|
@@ -637,67 +412,6 @@ module Aws::IoTSiteWise
|
|
637
412
|
# Contains an asset model property definition. This property definition
|
638
413
|
# is applied to all assets created from the asset model.
|
639
414
|
#
|
640
|
-
# @note When making an API call, you may pass AssetModelPropertyDefinition
|
641
|
-
# data as a hash:
|
642
|
-
#
|
643
|
-
# {
|
644
|
-
# name: "Name", # required
|
645
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
646
|
-
# data_type_spec: "Name",
|
647
|
-
# unit: "PropertyUnit",
|
648
|
-
# type: { # required
|
649
|
-
# attribute: {
|
650
|
-
# default_value: "DefaultValue",
|
651
|
-
# },
|
652
|
-
# measurement: {
|
653
|
-
# processing_config: {
|
654
|
-
# forwarding_config: { # required
|
655
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
656
|
-
# },
|
657
|
-
# },
|
658
|
-
# },
|
659
|
-
# transform: {
|
660
|
-
# expression: "Expression", # required
|
661
|
-
# variables: [ # required
|
662
|
-
# {
|
663
|
-
# name: "VariableName", # required
|
664
|
-
# value: { # required
|
665
|
-
# property_id: "Macro", # required
|
666
|
-
# hierarchy_id: "Macro",
|
667
|
-
# },
|
668
|
-
# },
|
669
|
-
# ],
|
670
|
-
# processing_config: {
|
671
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
672
|
-
# forwarding_config: {
|
673
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
674
|
-
# },
|
675
|
-
# },
|
676
|
-
# },
|
677
|
-
# metric: {
|
678
|
-
# expression: "Expression", # required
|
679
|
-
# variables: [ # required
|
680
|
-
# {
|
681
|
-
# name: "VariableName", # required
|
682
|
-
# value: { # required
|
683
|
-
# property_id: "Macro", # required
|
684
|
-
# hierarchy_id: "Macro",
|
685
|
-
# },
|
686
|
-
# },
|
687
|
-
# ],
|
688
|
-
# window: { # required
|
689
|
-
# tumbling: {
|
690
|
-
# interval: "Interval", # required
|
691
|
-
# offset: "Offset",
|
692
|
-
# },
|
693
|
-
# },
|
694
|
-
# processing_config: {
|
695
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
696
|
-
# },
|
697
|
-
# },
|
698
|
-
# },
|
699
|
-
# }
|
700
|
-
#
|
701
415
|
# @!attribute [rw] name
|
702
416
|
# The name of the property definition.
|
703
417
|
# @return [String]
|
@@ -959,23 +673,6 @@ module Aws::IoTSiteWise
|
|
959
673
|
|
960
674
|
# Contains asset property value information.
|
961
675
|
#
|
962
|
-
# @note When making an API call, you may pass AssetPropertyValue
|
963
|
-
# data as a hash:
|
964
|
-
#
|
965
|
-
# {
|
966
|
-
# value: { # required
|
967
|
-
# string_value: "PropertyValueStringValue",
|
968
|
-
# integer_value: 1,
|
969
|
-
# double_value: 1.0,
|
970
|
-
# boolean_value: false,
|
971
|
-
# },
|
972
|
-
# timestamp: { # required
|
973
|
-
# time_in_seconds: 1, # required
|
974
|
-
# offset_in_nanos: 1,
|
975
|
-
# },
|
976
|
-
# quality: "GOOD", # accepts GOOD, BAD, UNCERTAIN
|
977
|
-
# }
|
978
|
-
#
|
979
676
|
# @!attribute [rw] value
|
980
677
|
# The value of the asset property (see `Variant`).
|
981
678
|
# @return [Types::Variant]
|
@@ -1104,16 +801,6 @@ module Aws::IoTSiteWise
|
|
1104
801
|
include Aws::Structure
|
1105
802
|
end
|
1106
803
|
|
1107
|
-
# @note When making an API call, you may pass AssociateAssetsRequest
|
1108
|
-
# data as a hash:
|
1109
|
-
#
|
1110
|
-
# {
|
1111
|
-
# asset_id: "ID", # required
|
1112
|
-
# hierarchy_id: "ID", # required
|
1113
|
-
# child_asset_id: "ID", # required
|
1114
|
-
# client_token: "ClientToken",
|
1115
|
-
# }
|
1116
|
-
#
|
1117
804
|
# @!attribute [rw] asset_id
|
1118
805
|
# The ID of the parent asset.
|
1119
806
|
# @return [String]
|
@@ -1151,16 +838,6 @@ module Aws::IoTSiteWise
|
|
1151
838
|
include Aws::Structure
|
1152
839
|
end
|
1153
840
|
|
1154
|
-
# @note When making an API call, you may pass AssociateTimeSeriesToAssetPropertyRequest
|
1155
|
-
# data as a hash:
|
1156
|
-
#
|
1157
|
-
# {
|
1158
|
-
# alias: "PropertyAlias", # required
|
1159
|
-
# asset_id: "ID", # required
|
1160
|
-
# property_id: "ID", # required
|
1161
|
-
# client_token: "ClientToken",
|
1162
|
-
# }
|
1163
|
-
#
|
1164
841
|
# @!attribute [rw] alias
|
1165
842
|
# The alias that identifies the time series.
|
1166
843
|
# @return [String]
|
@@ -1257,13 +934,6 @@ module Aws::IoTSiteWise
|
|
1257
934
|
#
|
1258
935
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#attributes
|
1259
936
|
#
|
1260
|
-
# @note When making an API call, you may pass Attribute
|
1261
|
-
# data as a hash:
|
1262
|
-
#
|
1263
|
-
# {
|
1264
|
-
# default_value: "DefaultValue",
|
1265
|
-
# }
|
1266
|
-
#
|
1267
937
|
# @!attribute [rw] default_value
|
1268
938
|
# The default value of the asset model property attribute. All assets
|
1269
939
|
# that you create from the asset model contain this attribute value.
|
@@ -1282,15 +952,6 @@ module Aws::IoTSiteWise
|
|
1282
952
|
include Aws::Structure
|
1283
953
|
end
|
1284
954
|
|
1285
|
-
# @note When making an API call, you may pass BatchAssociateProjectAssetsRequest
|
1286
|
-
# data as a hash:
|
1287
|
-
#
|
1288
|
-
# {
|
1289
|
-
# project_id: "ID", # required
|
1290
|
-
# asset_ids: ["ID"], # required
|
1291
|
-
# client_token: "ClientToken",
|
1292
|
-
# }
|
1293
|
-
#
|
1294
955
|
# @!attribute [rw] project_id
|
1295
956
|
# The ID of the project to which to associate the assets.
|
1296
957
|
# @return [String]
|
@@ -1326,15 +987,6 @@ module Aws::IoTSiteWise
|
|
1326
987
|
include Aws::Structure
|
1327
988
|
end
|
1328
989
|
|
1329
|
-
# @note When making an API call, you may pass BatchDisassociateProjectAssetsRequest
|
1330
|
-
# data as a hash:
|
1331
|
-
#
|
1332
|
-
# {
|
1333
|
-
# project_id: "ID", # required
|
1334
|
-
# asset_ids: ["ID"], # required
|
1335
|
-
# client_token: "ClientToken",
|
1336
|
-
# }
|
1337
|
-
#
|
1338
990
|
# @!attribute [rw] project_id
|
1339
991
|
# The ID of the project from which to disassociate the assets.
|
1340
992
|
# @return [String]
|
@@ -1386,22 +1038,6 @@ module Aws::IoTSiteWise
|
|
1386
1038
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
|
1387
1039
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
|
1388
1040
|
#
|
1389
|
-
# @note When making an API call, you may pass BatchGetAssetPropertyAggregatesEntry
|
1390
|
-
# data as a hash:
|
1391
|
-
#
|
1392
|
-
# {
|
1393
|
-
# entry_id: "EntryId", # required
|
1394
|
-
# asset_id: "ID",
|
1395
|
-
# property_id: "ID",
|
1396
|
-
# property_alias: "AssetPropertyAlias",
|
1397
|
-
# aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
|
1398
|
-
# resolution: "Resolution", # required
|
1399
|
-
# start_date: Time.now, # required
|
1400
|
-
# end_date: Time.now, # required
|
1401
|
-
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
1402
|
-
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1403
|
-
# }
|
1404
|
-
#
|
1405
1041
|
# @!attribute [rw] entry_id
|
1406
1042
|
# The ID of the entry.
|
1407
1043
|
# @return [String]
|
@@ -1519,28 +1155,6 @@ module Aws::IoTSiteWise
|
|
1519
1155
|
include Aws::Structure
|
1520
1156
|
end
|
1521
1157
|
|
1522
|
-
# @note When making an API call, you may pass BatchGetAssetPropertyAggregatesRequest
|
1523
|
-
# data as a hash:
|
1524
|
-
#
|
1525
|
-
# {
|
1526
|
-
# entries: [ # required
|
1527
|
-
# {
|
1528
|
-
# entry_id: "EntryId", # required
|
1529
|
-
# asset_id: "ID",
|
1530
|
-
# property_id: "ID",
|
1531
|
-
# property_alias: "AssetPropertyAlias",
|
1532
|
-
# aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
|
1533
|
-
# resolution: "Resolution", # required
|
1534
|
-
# start_date: Time.now, # required
|
1535
|
-
# end_date: Time.now, # required
|
1536
|
-
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
1537
|
-
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1538
|
-
# },
|
1539
|
-
# ],
|
1540
|
-
# next_token: "NextToken",
|
1541
|
-
# max_results: 1,
|
1542
|
-
# }
|
1543
|
-
#
|
1544
1158
|
# @!attribute [rw] entries
|
1545
1159
|
# The list of asset property aggregate entries for the batch get
|
1546
1160
|
# request. You can specify up to 16 entries per request.
|
@@ -1671,16 +1285,6 @@ module Aws::IoTSiteWise
|
|
1671
1285
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1672
1286
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
|
1673
1287
|
#
|
1674
|
-
# @note When making an API call, you may pass BatchGetAssetPropertyValueEntry
|
1675
|
-
# data as a hash:
|
1676
|
-
#
|
1677
|
-
# {
|
1678
|
-
# entry_id: "EntryId", # required
|
1679
|
-
# asset_id: "ID",
|
1680
|
-
# property_id: "ID",
|
1681
|
-
# property_alias: "AssetPropertyAlias",
|
1682
|
-
# }
|
1683
|
-
#
|
1684
1288
|
# @!attribute [rw] entry_id
|
1685
1289
|
# The ID of the entry.
|
1686
1290
|
# @return [String]
|
@@ -1774,20 +1378,6 @@ module Aws::IoTSiteWise
|
|
1774
1378
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1775
1379
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
|
1776
1380
|
#
|
1777
|
-
# @note When making an API call, you may pass BatchGetAssetPropertyValueHistoryEntry
|
1778
|
-
# data as a hash:
|
1779
|
-
#
|
1780
|
-
# {
|
1781
|
-
# entry_id: "EntryId", # required
|
1782
|
-
# asset_id: "ID",
|
1783
|
-
# property_id: "ID",
|
1784
|
-
# property_alias: "AssetPropertyAlias",
|
1785
|
-
# start_date: Time.now,
|
1786
|
-
# end_date: Time.now,
|
1787
|
-
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
1788
|
-
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1789
|
-
# }
|
1790
|
-
#
|
1791
1381
|
# @!attribute [rw] entry_id
|
1792
1382
|
# The ID of the entry.
|
1793
1383
|
# @return [String]
|
@@ -1885,26 +1475,6 @@ module Aws::IoTSiteWise
|
|
1885
1475
|
include Aws::Structure
|
1886
1476
|
end
|
1887
1477
|
|
1888
|
-
# @note When making an API call, you may pass BatchGetAssetPropertyValueHistoryRequest
|
1889
|
-
# data as a hash:
|
1890
|
-
#
|
1891
|
-
# {
|
1892
|
-
# entries: [ # required
|
1893
|
-
# {
|
1894
|
-
# entry_id: "EntryId", # required
|
1895
|
-
# asset_id: "ID",
|
1896
|
-
# property_id: "ID",
|
1897
|
-
# property_alias: "AssetPropertyAlias",
|
1898
|
-
# start_date: Time.now,
|
1899
|
-
# end_date: Time.now,
|
1900
|
-
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
1901
|
-
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1902
|
-
# },
|
1903
|
-
# ],
|
1904
|
-
# next_token: "NextToken",
|
1905
|
-
# max_results: 1,
|
1906
|
-
# }
|
1907
|
-
#
|
1908
1478
|
# @!attribute [rw] entries
|
1909
1479
|
# The list of asset property historical value entries for the batch
|
1910
1480
|
# get request. You can specify up to 16 entries per request.
|
@@ -2018,24 +1588,9 @@ module Aws::IoTSiteWise
|
|
2018
1588
|
include Aws::Structure
|
2019
1589
|
end
|
2020
1590
|
|
2021
|
-
# @note When making an API call, you may pass BatchGetAssetPropertyValueRequest
|
2022
|
-
# data as a hash:
|
2023
|
-
#
|
2024
|
-
# {
|
2025
|
-
# entries: [ # required
|
2026
|
-
# {
|
2027
|
-
# entry_id: "EntryId", # required
|
2028
|
-
# asset_id: "ID",
|
2029
|
-
# property_id: "ID",
|
2030
|
-
# property_alias: "AssetPropertyAlias",
|
2031
|
-
# },
|
2032
|
-
# ],
|
2033
|
-
# next_token: "NextToken",
|
2034
|
-
# }
|
2035
|
-
#
|
2036
1591
|
# @!attribute [rw] entries
|
2037
1592
|
# The list of asset property value entries for the batch get request.
|
2038
|
-
# You can specify up to
|
1593
|
+
# You can specify up to 128 entries per request.
|
2039
1594
|
# @return [Array<Types::BatchGetAssetPropertyValueEntry>]
|
2040
1595
|
#
|
2041
1596
|
# @!attribute [rw] next_token
|
@@ -2180,35 +1735,6 @@ module Aws::IoTSiteWise
|
|
2180
1735
|
include Aws::Structure
|
2181
1736
|
end
|
2182
1737
|
|
2183
|
-
# @note When making an API call, you may pass BatchPutAssetPropertyValueRequest
|
2184
|
-
# data as a hash:
|
2185
|
-
#
|
2186
|
-
# {
|
2187
|
-
# entries: [ # required
|
2188
|
-
# {
|
2189
|
-
# entry_id: "EntryId", # required
|
2190
|
-
# asset_id: "ID",
|
2191
|
-
# property_id: "ID",
|
2192
|
-
# property_alias: "AssetPropertyAlias",
|
2193
|
-
# property_values: [ # required
|
2194
|
-
# {
|
2195
|
-
# value: { # required
|
2196
|
-
# string_value: "PropertyValueStringValue",
|
2197
|
-
# integer_value: 1,
|
2198
|
-
# double_value: 1.0,
|
2199
|
-
# boolean_value: false,
|
2200
|
-
# },
|
2201
|
-
# timestamp: { # required
|
2202
|
-
# time_in_seconds: 1, # required
|
2203
|
-
# offset_in_nanos: 1,
|
2204
|
-
# },
|
2205
|
-
# quality: "GOOD", # accepts GOOD, BAD, UNCERTAIN
|
2206
|
-
# },
|
2207
|
-
# ],
|
2208
|
-
# },
|
2209
|
-
# ],
|
2210
|
-
# }
|
2211
|
-
#
|
2212
1738
|
# @!attribute [rw] entries
|
2213
1739
|
# The list of asset property value entries for the batch put request.
|
2214
1740
|
# You can specify up to 10 entries per request.
|
@@ -2315,39 +1841,6 @@ module Aws::IoTSiteWise
|
|
2315
1841
|
include Aws::Structure
|
2316
1842
|
end
|
2317
1843
|
|
2318
|
-
# @note When making an API call, you may pass CreateAccessPolicyRequest
|
2319
|
-
# data as a hash:
|
2320
|
-
#
|
2321
|
-
# {
|
2322
|
-
# access_policy_identity: { # required
|
2323
|
-
# user: {
|
2324
|
-
# id: "IdentityId", # required
|
2325
|
-
# },
|
2326
|
-
# group: {
|
2327
|
-
# id: "IdentityId", # required
|
2328
|
-
# },
|
2329
|
-
# iam_user: {
|
2330
|
-
# arn: "ARN", # required
|
2331
|
-
# },
|
2332
|
-
# iam_role: {
|
2333
|
-
# arn: "ARN", # required
|
2334
|
-
# },
|
2335
|
-
# },
|
2336
|
-
# access_policy_resource: { # required
|
2337
|
-
# portal: {
|
2338
|
-
# id: "ID", # required
|
2339
|
-
# },
|
2340
|
-
# project: {
|
2341
|
-
# id: "ID", # required
|
2342
|
-
# },
|
2343
|
-
# },
|
2344
|
-
# access_policy_permission: "ADMINISTRATOR", # required, accepts ADMINISTRATOR, VIEWER
|
2345
|
-
# client_token: "ClientToken",
|
2346
|
-
# tags: {
|
2347
|
-
# "TagKey" => "TagValue",
|
2348
|
-
# },
|
2349
|
-
# }
|
2350
|
-
#
|
2351
1844
|
# @!attribute [rw] access_policy_identity
|
2352
1845
|
# The identity for this access policy. Choose an IAM Identity Center
|
2353
1846
|
# user, an IAM Identity Center group, or an IAM user.
|
@@ -2413,149 +1906,6 @@ module Aws::IoTSiteWise
|
|
2413
1906
|
include Aws::Structure
|
2414
1907
|
end
|
2415
1908
|
|
2416
|
-
# @note When making an API call, you may pass CreateAssetModelRequest
|
2417
|
-
# data as a hash:
|
2418
|
-
#
|
2419
|
-
# {
|
2420
|
-
# asset_model_name: "Name", # required
|
2421
|
-
# asset_model_description: "Description",
|
2422
|
-
# asset_model_properties: [
|
2423
|
-
# {
|
2424
|
-
# name: "Name", # required
|
2425
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
2426
|
-
# data_type_spec: "Name",
|
2427
|
-
# unit: "PropertyUnit",
|
2428
|
-
# type: { # required
|
2429
|
-
# attribute: {
|
2430
|
-
# default_value: "DefaultValue",
|
2431
|
-
# },
|
2432
|
-
# measurement: {
|
2433
|
-
# processing_config: {
|
2434
|
-
# forwarding_config: { # required
|
2435
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
2436
|
-
# },
|
2437
|
-
# },
|
2438
|
-
# },
|
2439
|
-
# transform: {
|
2440
|
-
# expression: "Expression", # required
|
2441
|
-
# variables: [ # required
|
2442
|
-
# {
|
2443
|
-
# name: "VariableName", # required
|
2444
|
-
# value: { # required
|
2445
|
-
# property_id: "Macro", # required
|
2446
|
-
# hierarchy_id: "Macro",
|
2447
|
-
# },
|
2448
|
-
# },
|
2449
|
-
# ],
|
2450
|
-
# processing_config: {
|
2451
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
2452
|
-
# forwarding_config: {
|
2453
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
2454
|
-
# },
|
2455
|
-
# },
|
2456
|
-
# },
|
2457
|
-
# metric: {
|
2458
|
-
# expression: "Expression", # required
|
2459
|
-
# variables: [ # required
|
2460
|
-
# {
|
2461
|
-
# name: "VariableName", # required
|
2462
|
-
# value: { # required
|
2463
|
-
# property_id: "Macro", # required
|
2464
|
-
# hierarchy_id: "Macro",
|
2465
|
-
# },
|
2466
|
-
# },
|
2467
|
-
# ],
|
2468
|
-
# window: { # required
|
2469
|
-
# tumbling: {
|
2470
|
-
# interval: "Interval", # required
|
2471
|
-
# offset: "Offset",
|
2472
|
-
# },
|
2473
|
-
# },
|
2474
|
-
# processing_config: {
|
2475
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
2476
|
-
# },
|
2477
|
-
# },
|
2478
|
-
# },
|
2479
|
-
# },
|
2480
|
-
# ],
|
2481
|
-
# asset_model_hierarchies: [
|
2482
|
-
# {
|
2483
|
-
# name: "Name", # required
|
2484
|
-
# child_asset_model_id: "ID", # required
|
2485
|
-
# },
|
2486
|
-
# ],
|
2487
|
-
# asset_model_composite_models: [
|
2488
|
-
# {
|
2489
|
-
# name: "Name", # required
|
2490
|
-
# description: "Description",
|
2491
|
-
# type: "Name", # required
|
2492
|
-
# properties: [
|
2493
|
-
# {
|
2494
|
-
# name: "Name", # required
|
2495
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
2496
|
-
# data_type_spec: "Name",
|
2497
|
-
# unit: "PropertyUnit",
|
2498
|
-
# type: { # required
|
2499
|
-
# attribute: {
|
2500
|
-
# default_value: "DefaultValue",
|
2501
|
-
# },
|
2502
|
-
# measurement: {
|
2503
|
-
# processing_config: {
|
2504
|
-
# forwarding_config: { # required
|
2505
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
2506
|
-
# },
|
2507
|
-
# },
|
2508
|
-
# },
|
2509
|
-
# transform: {
|
2510
|
-
# expression: "Expression", # required
|
2511
|
-
# variables: [ # required
|
2512
|
-
# {
|
2513
|
-
# name: "VariableName", # required
|
2514
|
-
# value: { # required
|
2515
|
-
# property_id: "Macro", # required
|
2516
|
-
# hierarchy_id: "Macro",
|
2517
|
-
# },
|
2518
|
-
# },
|
2519
|
-
# ],
|
2520
|
-
# processing_config: {
|
2521
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
2522
|
-
# forwarding_config: {
|
2523
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
2524
|
-
# },
|
2525
|
-
# },
|
2526
|
-
# },
|
2527
|
-
# metric: {
|
2528
|
-
# expression: "Expression", # required
|
2529
|
-
# variables: [ # required
|
2530
|
-
# {
|
2531
|
-
# name: "VariableName", # required
|
2532
|
-
# value: { # required
|
2533
|
-
# property_id: "Macro", # required
|
2534
|
-
# hierarchy_id: "Macro",
|
2535
|
-
# },
|
2536
|
-
# },
|
2537
|
-
# ],
|
2538
|
-
# window: { # required
|
2539
|
-
# tumbling: {
|
2540
|
-
# interval: "Interval", # required
|
2541
|
-
# offset: "Offset",
|
2542
|
-
# },
|
2543
|
-
# },
|
2544
|
-
# processing_config: {
|
2545
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
2546
|
-
# },
|
2547
|
-
# },
|
2548
|
-
# },
|
2549
|
-
# },
|
2550
|
-
# ],
|
2551
|
-
# },
|
2552
|
-
# ],
|
2553
|
-
# client_token: "ClientToken",
|
2554
|
-
# tags: {
|
2555
|
-
# "TagKey" => "TagValue",
|
2556
|
-
# },
|
2557
|
-
# }
|
2558
|
-
#
|
2559
1909
|
# @!attribute [rw] asset_model_name
|
2560
1910
|
# A unique, friendly name for the asset model.
|
2561
1911
|
# @return [String]
|
@@ -2659,19 +2009,6 @@ module Aws::IoTSiteWise
|
|
2659
2009
|
include Aws::Structure
|
2660
2010
|
end
|
2661
2011
|
|
2662
|
-
# @note When making an API call, you may pass CreateAssetRequest
|
2663
|
-
# data as a hash:
|
2664
|
-
#
|
2665
|
-
# {
|
2666
|
-
# asset_name: "Name", # required
|
2667
|
-
# asset_model_id: "ID", # required
|
2668
|
-
# client_token: "ClientToken",
|
2669
|
-
# tags: {
|
2670
|
-
# "TagKey" => "TagValue",
|
2671
|
-
# },
|
2672
|
-
# asset_description: "Description",
|
2673
|
-
# }
|
2674
|
-
#
|
2675
2012
|
# @!attribute [rw] asset_name
|
2676
2013
|
# A friendly name for the asset.
|
2677
2014
|
# @return [String]
|
@@ -2741,32 +2078,6 @@ module Aws::IoTSiteWise
|
|
2741
2078
|
include Aws::Structure
|
2742
2079
|
end
|
2743
2080
|
|
2744
|
-
# @note When making an API call, you may pass CreateBulkImportJobRequest
|
2745
|
-
# data as a hash:
|
2746
|
-
#
|
2747
|
-
# {
|
2748
|
-
# job_name: "Name", # required
|
2749
|
-
# job_role_arn: "ARN", # required
|
2750
|
-
# files: [ # required
|
2751
|
-
# {
|
2752
|
-
# bucket: "Bucket", # required
|
2753
|
-
# key: "String", # required
|
2754
|
-
# version_id: "String",
|
2755
|
-
# },
|
2756
|
-
# ],
|
2757
|
-
# error_report_location: { # required
|
2758
|
-
# bucket: "Bucket", # required
|
2759
|
-
# prefix: "String", # required
|
2760
|
-
# },
|
2761
|
-
# job_configuration: { # required
|
2762
|
-
# file_format: { # required
|
2763
|
-
# csv: {
|
2764
|
-
# column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
|
2765
|
-
# },
|
2766
|
-
# },
|
2767
|
-
# },
|
2768
|
-
# }
|
2769
|
-
#
|
2770
2081
|
# @!attribute [rw] job_name
|
2771
2082
|
# The unique name that helps identify the job request.
|
2772
2083
|
# @return [String]
|
@@ -2844,20 +2155,6 @@ module Aws::IoTSiteWise
|
|
2844
2155
|
include Aws::Structure
|
2845
2156
|
end
|
2846
2157
|
|
2847
|
-
# @note When making an API call, you may pass CreateDashboardRequest
|
2848
|
-
# data as a hash:
|
2849
|
-
#
|
2850
|
-
# {
|
2851
|
-
# project_id: "ID", # required
|
2852
|
-
# dashboard_name: "Name", # required
|
2853
|
-
# dashboard_description: "Description",
|
2854
|
-
# dashboard_definition: "DashboardDefinition", # required
|
2855
|
-
# client_token: "ClientToken",
|
2856
|
-
# tags: {
|
2857
|
-
# "TagKey" => "TagValue",
|
2858
|
-
# },
|
2859
|
-
# }
|
2860
|
-
#
|
2861
2158
|
# @!attribute [rw] project_id
|
2862
2159
|
# The ID of the project in which to create the dashboard.
|
2863
2160
|
# @return [String]
|
@@ -2931,24 +2228,6 @@ module Aws::IoTSiteWise
|
|
2931
2228
|
include Aws::Structure
|
2932
2229
|
end
|
2933
2230
|
|
2934
|
-
# @note When making an API call, you may pass CreateGatewayRequest
|
2935
|
-
# data as a hash:
|
2936
|
-
#
|
2937
|
-
# {
|
2938
|
-
# gateway_name: "Name", # required
|
2939
|
-
# gateway_platform: { # required
|
2940
|
-
# greengrass: {
|
2941
|
-
# group_arn: "ARN", # required
|
2942
|
-
# },
|
2943
|
-
# greengrass_v2: {
|
2944
|
-
# core_device_thing_name: "CoreDeviceThingName", # required
|
2945
|
-
# },
|
2946
|
-
# },
|
2947
|
-
# tags: {
|
2948
|
-
# "TagKey" => "TagValue",
|
2949
|
-
# },
|
2950
|
-
# }
|
2951
|
-
#
|
2952
2231
|
# @!attribute [rw] gateway_name
|
2953
2232
|
# A unique, friendly name for the gateway.
|
2954
2233
|
# @return [String]
|
@@ -2998,30 +2277,6 @@ module Aws::IoTSiteWise
|
|
2998
2277
|
include Aws::Structure
|
2999
2278
|
end
|
3000
2279
|
|
3001
|
-
# @note When making an API call, you may pass CreatePortalRequest
|
3002
|
-
# data as a hash:
|
3003
|
-
#
|
3004
|
-
# {
|
3005
|
-
# portal_name: "Name", # required
|
3006
|
-
# portal_description: "Description",
|
3007
|
-
# portal_contact_email: "Email", # required
|
3008
|
-
# client_token: "ClientToken",
|
3009
|
-
# portal_logo_image_file: {
|
3010
|
-
# data: "data", # required
|
3011
|
-
# type: "PNG", # required, accepts PNG
|
3012
|
-
# },
|
3013
|
-
# role_arn: "ARN", # required
|
3014
|
-
# tags: {
|
3015
|
-
# "TagKey" => "TagValue",
|
3016
|
-
# },
|
3017
|
-
# portal_auth_mode: "IAM", # accepts IAM, SSO
|
3018
|
-
# notification_sender_email: "Email",
|
3019
|
-
# alarms: {
|
3020
|
-
# alarm_role_arn: "ARN", # required
|
3021
|
-
# notification_lambda_arn: "ARN",
|
3022
|
-
# },
|
3023
|
-
# }
|
3024
|
-
#
|
3025
2280
|
# @!attribute [rw] portal_name
|
3026
2281
|
# A friendly name for the portal.
|
3027
2282
|
# @return [String]
|
@@ -3175,19 +2430,6 @@ module Aws::IoTSiteWise
|
|
3175
2430
|
include Aws::Structure
|
3176
2431
|
end
|
3177
2432
|
|
3178
|
-
# @note When making an API call, you may pass CreateProjectRequest
|
3179
|
-
# data as a hash:
|
3180
|
-
#
|
3181
|
-
# {
|
3182
|
-
# portal_id: "ID", # required
|
3183
|
-
# project_name: "Name", # required
|
3184
|
-
# project_description: "Description",
|
3185
|
-
# client_token: "ClientToken",
|
3186
|
-
# tags: {
|
3187
|
-
# "TagKey" => "TagValue",
|
3188
|
-
# },
|
3189
|
-
# }
|
3190
|
-
#
|
3191
2433
|
# @!attribute [rw] portal_id
|
3192
2434
|
# The ID of the portal in which to create the project.
|
3193
2435
|
# @return [String]
|
@@ -3252,13 +2494,6 @@ module Aws::IoTSiteWise
|
|
3252
2494
|
|
3253
2495
|
# A .csv file.
|
3254
2496
|
#
|
3255
|
-
# @note When making an API call, you may pass Csv
|
3256
|
-
# data as a hash:
|
3257
|
-
#
|
3258
|
-
# {
|
3259
|
-
# column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
|
3260
|
-
# }
|
3261
|
-
#
|
3262
2497
|
# @!attribute [rw] column_names
|
3263
2498
|
# The column names specified in the .csv file.
|
3264
2499
|
# @return [Array<String>]
|
@@ -3271,14 +2506,6 @@ module Aws::IoTSiteWise
|
|
3271
2506
|
|
3272
2507
|
# Contains information about a customer managed Amazon S3 bucket.
|
3273
2508
|
#
|
3274
|
-
# @note When making an API call, you may pass CustomerManagedS3Storage
|
3275
|
-
# data as a hash:
|
3276
|
-
#
|
3277
|
-
# {
|
3278
|
-
# s3_resource_arn: "ARN", # required
|
3279
|
-
# role_arn: "ARN", # required
|
3280
|
-
# }
|
3281
|
-
#
|
3282
2509
|
# @!attribute [rw] s3_resource_arn
|
3283
2510
|
# The [ARN][1] of the Amazon S3 object. For more information about how
|
3284
2511
|
# to find the ARN for an Amazon S3 object, see [Amazon S3
|
@@ -3338,14 +2565,6 @@ module Aws::IoTSiteWise
|
|
3338
2565
|
include Aws::Structure
|
3339
2566
|
end
|
3340
2567
|
|
3341
|
-
# @note When making an API call, you may pass DeleteAccessPolicyRequest
|
3342
|
-
# data as a hash:
|
3343
|
-
#
|
3344
|
-
# {
|
3345
|
-
# access_policy_id: "ID", # required
|
3346
|
-
# client_token: "ClientToken",
|
3347
|
-
# }
|
3348
|
-
#
|
3349
2568
|
# @!attribute [rw] access_policy_id
|
3350
2569
|
# The ID of the access policy to be deleted.
|
3351
2570
|
# @return [String]
|
@@ -3368,14 +2587,6 @@ module Aws::IoTSiteWise
|
|
3368
2587
|
|
3369
2588
|
class DeleteAccessPolicyResponse < Aws::EmptyStructure; end
|
3370
2589
|
|
3371
|
-
# @note When making an API call, you may pass DeleteAssetModelRequest
|
3372
|
-
# data as a hash:
|
3373
|
-
#
|
3374
|
-
# {
|
3375
|
-
# asset_model_id: "ID", # required
|
3376
|
-
# client_token: "ClientToken",
|
3377
|
-
# }
|
3378
|
-
#
|
3379
2590
|
# @!attribute [rw] asset_model_id
|
3380
2591
|
# The ID of the asset model to delete.
|
3381
2592
|
# @return [String]
|
@@ -3407,14 +2618,6 @@ module Aws::IoTSiteWise
|
|
3407
2618
|
include Aws::Structure
|
3408
2619
|
end
|
3409
2620
|
|
3410
|
-
# @note When making an API call, you may pass DeleteAssetRequest
|
3411
|
-
# data as a hash:
|
3412
|
-
#
|
3413
|
-
# {
|
3414
|
-
# asset_id: "ID", # required
|
3415
|
-
# client_token: "ClientToken",
|
3416
|
-
# }
|
3417
|
-
#
|
3418
2621
|
# @!attribute [rw] asset_id
|
3419
2622
|
# The ID of the asset to delete.
|
3420
2623
|
# @return [String]
|
@@ -3446,14 +2649,6 @@ module Aws::IoTSiteWise
|
|
3446
2649
|
include Aws::Structure
|
3447
2650
|
end
|
3448
2651
|
|
3449
|
-
# @note When making an API call, you may pass DeleteDashboardRequest
|
3450
|
-
# data as a hash:
|
3451
|
-
#
|
3452
|
-
# {
|
3453
|
-
# dashboard_id: "ID", # required
|
3454
|
-
# client_token: "ClientToken",
|
3455
|
-
# }
|
3456
|
-
#
|
3457
2652
|
# @!attribute [rw] dashboard_id
|
3458
2653
|
# The ID of the dashboard to delete.
|
3459
2654
|
# @return [String]
|
@@ -3476,13 +2671,6 @@ module Aws::IoTSiteWise
|
|
3476
2671
|
|
3477
2672
|
class DeleteDashboardResponse < Aws::EmptyStructure; end
|
3478
2673
|
|
3479
|
-
# @note When making an API call, you may pass DeleteGatewayRequest
|
3480
|
-
# data as a hash:
|
3481
|
-
#
|
3482
|
-
# {
|
3483
|
-
# gateway_id: "ID", # required
|
3484
|
-
# }
|
3485
|
-
#
|
3486
2674
|
# @!attribute [rw] gateway_id
|
3487
2675
|
# The ID of the gateway to delete.
|
3488
2676
|
# @return [String]
|
@@ -3493,14 +2681,6 @@ module Aws::IoTSiteWise
|
|
3493
2681
|
include Aws::Structure
|
3494
2682
|
end
|
3495
2683
|
|
3496
|
-
# @note When making an API call, you may pass DeletePortalRequest
|
3497
|
-
# data as a hash:
|
3498
|
-
#
|
3499
|
-
# {
|
3500
|
-
# portal_id: "ID", # required
|
3501
|
-
# client_token: "ClientToken",
|
3502
|
-
# }
|
3503
|
-
#
|
3504
2684
|
# @!attribute [rw] portal_id
|
3505
2685
|
# The ID of the portal to delete.
|
3506
2686
|
# @return [String]
|
@@ -3532,14 +2712,6 @@ module Aws::IoTSiteWise
|
|
3532
2712
|
include Aws::Structure
|
3533
2713
|
end
|
3534
2714
|
|
3535
|
-
# @note When making an API call, you may pass DeleteProjectRequest
|
3536
|
-
# data as a hash:
|
3537
|
-
#
|
3538
|
-
# {
|
3539
|
-
# project_id: "ID", # required
|
3540
|
-
# client_token: "ClientToken",
|
3541
|
-
# }
|
3542
|
-
#
|
3543
2715
|
# @!attribute [rw] project_id
|
3544
2716
|
# The ID of the project.
|
3545
2717
|
# @return [String]
|
@@ -3562,16 +2734,6 @@ module Aws::IoTSiteWise
|
|
3562
2734
|
|
3563
2735
|
class DeleteProjectResponse < Aws::EmptyStructure; end
|
3564
2736
|
|
3565
|
-
# @note When making an API call, you may pass DeleteTimeSeriesRequest
|
3566
|
-
# data as a hash:
|
3567
|
-
#
|
3568
|
-
# {
|
3569
|
-
# alias: "PropertyAlias",
|
3570
|
-
# asset_id: "ID",
|
3571
|
-
# property_id: "ID",
|
3572
|
-
# client_token: "ClientToken",
|
3573
|
-
# }
|
3574
|
-
#
|
3575
2737
|
# @!attribute [rw] alias
|
3576
2738
|
# The alias that identifies the time series.
|
3577
2739
|
# @return [String]
|
@@ -3602,13 +2764,6 @@ module Aws::IoTSiteWise
|
|
3602
2764
|
include Aws::Structure
|
3603
2765
|
end
|
3604
2766
|
|
3605
|
-
# @note When making an API call, you may pass DescribeAccessPolicyRequest
|
3606
|
-
# data as a hash:
|
3607
|
-
#
|
3608
|
-
# {
|
3609
|
-
# access_policy_id: "ID", # required
|
3610
|
-
# }
|
3611
|
-
#
|
3612
2767
|
# @!attribute [rw] access_policy_id
|
3613
2768
|
# The ID of the access policy.
|
3614
2769
|
# @return [String]
|
@@ -3668,14 +2823,6 @@ module Aws::IoTSiteWise
|
|
3668
2823
|
include Aws::Structure
|
3669
2824
|
end
|
3670
2825
|
|
3671
|
-
# @note When making an API call, you may pass DescribeAssetModelRequest
|
3672
|
-
# data as a hash:
|
3673
|
-
#
|
3674
|
-
# {
|
3675
|
-
# asset_model_id: "ID", # required
|
3676
|
-
# exclude_properties: false,
|
3677
|
-
# }
|
3678
|
-
#
|
3679
2826
|
# @!attribute [rw] asset_model_id
|
3680
2827
|
# The ID of the asset model.
|
3681
2828
|
# @return [String]
|
@@ -3760,14 +2907,6 @@ module Aws::IoTSiteWise
|
|
3760
2907
|
include Aws::Structure
|
3761
2908
|
end
|
3762
2909
|
|
3763
|
-
# @note When making an API call, you may pass DescribeAssetPropertyRequest
|
3764
|
-
# data as a hash:
|
3765
|
-
#
|
3766
|
-
# {
|
3767
|
-
# asset_id: "ID", # required
|
3768
|
-
# property_id: "ID", # required
|
3769
|
-
# }
|
3770
|
-
#
|
3771
2910
|
# @!attribute [rw] asset_id
|
3772
2911
|
# The ID of the asset.
|
3773
2912
|
# @return [String]
|
@@ -3818,14 +2957,6 @@ module Aws::IoTSiteWise
|
|
3818
2957
|
include Aws::Structure
|
3819
2958
|
end
|
3820
2959
|
|
3821
|
-
# @note When making an API call, you may pass DescribeAssetRequest
|
3822
|
-
# data as a hash:
|
3823
|
-
#
|
3824
|
-
# {
|
3825
|
-
# asset_id: "ID", # required
|
3826
|
-
# exclude_properties: false,
|
3827
|
-
# }
|
3828
|
-
#
|
3829
2960
|
# @!attribute [rw] asset_id
|
3830
2961
|
# The ID of the asset.
|
3831
2962
|
# @return [String]
|
@@ -3913,13 +3044,6 @@ module Aws::IoTSiteWise
|
|
3913
3044
|
include Aws::Structure
|
3914
3045
|
end
|
3915
3046
|
|
3916
|
-
# @note When making an API call, you may pass DescribeBulkImportJobRequest
|
3917
|
-
# data as a hash:
|
3918
|
-
#
|
3919
|
-
# {
|
3920
|
-
# job_id: "ID", # required
|
3921
|
-
# }
|
3922
|
-
#
|
3923
3047
|
# @!attribute [rw] job_id
|
3924
3048
|
# The ID of the job.
|
3925
3049
|
# @return [String]
|
@@ -4007,13 +3131,6 @@ module Aws::IoTSiteWise
|
|
4007
3131
|
include Aws::Structure
|
4008
3132
|
end
|
4009
3133
|
|
4010
|
-
# @note When making an API call, you may pass DescribeDashboardRequest
|
4011
|
-
# data as a hash:
|
4012
|
-
#
|
4013
|
-
# {
|
4014
|
-
# dashboard_id: "ID", # required
|
4015
|
-
# }
|
4016
|
-
#
|
4017
3134
|
# @!attribute [rw] dashboard_id
|
4018
3135
|
# The ID of the dashboard.
|
4019
3136
|
# @return [String]
|
@@ -4107,14 +3224,6 @@ module Aws::IoTSiteWise
|
|
4107
3224
|
include Aws::Structure
|
4108
3225
|
end
|
4109
3226
|
|
4110
|
-
# @note When making an API call, you may pass DescribeGatewayCapabilityConfigurationRequest
|
4111
|
-
# data as a hash:
|
4112
|
-
#
|
4113
|
-
# {
|
4114
|
-
# gateway_id: "ID", # required
|
4115
|
-
# capability_namespace: "CapabilityNamespace", # required
|
4116
|
-
# }
|
4117
|
-
#
|
4118
3227
|
# @!attribute [rw] gateway_id
|
4119
3228
|
# The ID of the gateway that defines the capability configuration.
|
4120
3229
|
# @return [String]
|
@@ -4173,13 +3282,6 @@ module Aws::IoTSiteWise
|
|
4173
3282
|
include Aws::Structure
|
4174
3283
|
end
|
4175
3284
|
|
4176
|
-
# @note When making an API call, you may pass DescribeGatewayRequest
|
4177
|
-
# data as a hash:
|
4178
|
-
#
|
4179
|
-
# {
|
4180
|
-
# gateway_id: "ID", # required
|
4181
|
-
# }
|
4182
|
-
#
|
4183
3285
|
# @!attribute [rw] gateway_id
|
4184
3286
|
# The ID of the gateway device.
|
4185
3287
|
# @return [String]
|
@@ -4257,13 +3359,6 @@ module Aws::IoTSiteWise
|
|
4257
3359
|
include Aws::Structure
|
4258
3360
|
end
|
4259
3361
|
|
4260
|
-
# @note When making an API call, you may pass DescribePortalRequest
|
4261
|
-
# data as a hash:
|
4262
|
-
#
|
4263
|
-
# {
|
4264
|
-
# portal_id: "ID", # required
|
4265
|
-
# }
|
4266
|
-
#
|
4267
3362
|
# @!attribute [rw] portal_id
|
4268
3363
|
# The ID of the portal.
|
4269
3364
|
# @return [String]
|
@@ -4375,13 +3470,6 @@ module Aws::IoTSiteWise
|
|
4375
3470
|
include Aws::Structure
|
4376
3471
|
end
|
4377
3472
|
|
4378
|
-
# @note When making an API call, you may pass DescribeProjectRequest
|
4379
|
-
# data as a hash:
|
4380
|
-
#
|
4381
|
-
# {
|
4382
|
-
# project_id: "ID", # required
|
4383
|
-
# }
|
4384
|
-
#
|
4385
3473
|
# @!attribute [rw] project_id
|
4386
3474
|
# The ID of the project.
|
4387
3475
|
# @return [String]
|
@@ -4505,15 +3593,6 @@ module Aws::IoTSiteWise
|
|
4505
3593
|
include Aws::Structure
|
4506
3594
|
end
|
4507
3595
|
|
4508
|
-
# @note When making an API call, you may pass DescribeTimeSeriesRequest
|
4509
|
-
# data as a hash:
|
4510
|
-
#
|
4511
|
-
# {
|
4512
|
-
# alias: "PropertyAlias",
|
4513
|
-
# asset_id: "ID",
|
4514
|
-
# property_id: "ID",
|
4515
|
-
# }
|
4516
|
-
#
|
4517
3596
|
# @!attribute [rw] alias
|
4518
3597
|
# The alias that identifies the time series.
|
4519
3598
|
# @return [String]
|
@@ -4575,6 +3654,16 @@ module Aws::IoTSiteWise
|
|
4575
3654
|
# The date that the time series was last updated, in Unix epoch time.
|
4576
3655
|
# @return [Time]
|
4577
3656
|
#
|
3657
|
+
# @!attribute [rw] time_series_arn
|
3658
|
+
# The [ARN][1] of the time series, which has the following format.
|
3659
|
+
#
|
3660
|
+
# `arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:time-series/$\{TimeSeriesId\}`
|
3661
|
+
#
|
3662
|
+
#
|
3663
|
+
#
|
3664
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
3665
|
+
# @return [String]
|
3666
|
+
#
|
4578
3667
|
class DescribeTimeSeriesResponse < Struct.new(
|
4579
3668
|
:asset_id,
|
4580
3669
|
:property_id,
|
@@ -4583,7 +3672,8 @@ module Aws::IoTSiteWise
|
|
4583
3672
|
:data_type,
|
4584
3673
|
:data_type_spec,
|
4585
3674
|
:time_series_creation_date,
|
4586
|
-
:time_series_last_update_date
|
3675
|
+
:time_series_last_update_date,
|
3676
|
+
:time_series_arn)
|
4587
3677
|
SENSITIVE = []
|
4588
3678
|
include Aws::Structure
|
4589
3679
|
end
|
@@ -4605,16 +3695,6 @@ module Aws::IoTSiteWise
|
|
4605
3695
|
include Aws::Structure
|
4606
3696
|
end
|
4607
3697
|
|
4608
|
-
# @note When making an API call, you may pass DisassociateAssetsRequest
|
4609
|
-
# data as a hash:
|
4610
|
-
#
|
4611
|
-
# {
|
4612
|
-
# asset_id: "ID", # required
|
4613
|
-
# hierarchy_id: "ID", # required
|
4614
|
-
# child_asset_id: "ID", # required
|
4615
|
-
# client_token: "ClientToken",
|
4616
|
-
# }
|
4617
|
-
#
|
4618
3698
|
# @!attribute [rw] asset_id
|
4619
3699
|
# The ID of the parent asset from which to disassociate the child
|
4620
3700
|
# asset.
|
@@ -4654,16 +3734,6 @@ module Aws::IoTSiteWise
|
|
4654
3734
|
include Aws::Structure
|
4655
3735
|
end
|
4656
3736
|
|
4657
|
-
# @note When making an API call, you may pass DisassociateTimeSeriesFromAssetPropertyRequest
|
4658
|
-
# data as a hash:
|
4659
|
-
#
|
4660
|
-
# {
|
4661
|
-
# alias: "PropertyAlias", # required
|
4662
|
-
# asset_id: "ID", # required
|
4663
|
-
# property_id: "ID", # required
|
4664
|
-
# client_token: "ClientToken",
|
4665
|
-
# }
|
4666
|
-
#
|
4667
3737
|
# @!attribute [rw] alias
|
4668
3738
|
# The alias that identifies the time series.
|
4669
3739
|
# @return [String]
|
@@ -4719,14 +3789,6 @@ module Aws::IoTSiteWise
|
|
4719
3789
|
# The Amazon S3 destination where errors associated with the job
|
4720
3790
|
# creation request are saved.
|
4721
3791
|
#
|
4722
|
-
# @note When making an API call, you may pass ErrorReportLocation
|
4723
|
-
# data as a hash:
|
4724
|
-
#
|
4725
|
-
# {
|
4726
|
-
# bucket: "Bucket", # required
|
4727
|
-
# prefix: "String", # required
|
4728
|
-
# }
|
4729
|
-
#
|
4730
3792
|
# @!attribute [rw] bucket
|
4731
3793
|
# The name of the Amazon S3 bucket to which errors associated with the
|
4732
3794
|
# bulk import job are sent.
|
@@ -4754,17 +3816,6 @@ module Aws::IoTSiteWise
|
|
4754
3816
|
|
4755
3817
|
# Contains expression variable information.
|
4756
3818
|
#
|
4757
|
-
# @note When making an API call, you may pass ExpressionVariable
|
4758
|
-
# data as a hash:
|
4759
|
-
#
|
4760
|
-
# {
|
4761
|
-
# name: "VariableName", # required
|
4762
|
-
# value: { # required
|
4763
|
-
# property_id: "Macro", # required
|
4764
|
-
# hierarchy_id: "Macro",
|
4765
|
-
# },
|
4766
|
-
# }
|
4767
|
-
#
|
4768
3819
|
# @!attribute [rw] name
|
4769
3820
|
# The friendly name of the variable to be used in the expression.
|
4770
3821
|
# @return [String]
|
@@ -4783,15 +3834,6 @@ module Aws::IoTSiteWise
|
|
4783
3834
|
|
4784
3835
|
# The file in Amazon S3 where your data is saved.
|
4785
3836
|
#
|
4786
|
-
# @note When making an API call, you may pass File
|
4787
|
-
# data as a hash:
|
4788
|
-
#
|
4789
|
-
# {
|
4790
|
-
# bucket: "Bucket", # required
|
4791
|
-
# key: "String", # required
|
4792
|
-
# version_id: "String",
|
4793
|
-
# }
|
4794
|
-
#
|
4795
3837
|
# @!attribute [rw] bucket
|
4796
3838
|
# The name of the Amazon S3 bucket from which data is imported.
|
4797
3839
|
# @return [String]
|
@@ -4817,15 +3859,6 @@ module Aws::IoTSiteWise
|
|
4817
3859
|
|
4818
3860
|
# The file format of the data.
|
4819
3861
|
#
|
4820
|
-
# @note When making an API call, you may pass FileFormat
|
4821
|
-
# data as a hash:
|
4822
|
-
#
|
4823
|
-
# {
|
4824
|
-
# csv: {
|
4825
|
-
# column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
|
4826
|
-
# },
|
4827
|
-
# }
|
4828
|
-
#
|
4829
3862
|
# @!attribute [rw] csv
|
4830
3863
|
# The .csv file format.
|
4831
3864
|
# @return [Types::Csv]
|
@@ -4838,13 +3871,6 @@ module Aws::IoTSiteWise
|
|
4838
3871
|
|
4839
3872
|
# The forwarding configuration for a given property.
|
4840
3873
|
#
|
4841
|
-
# @note When making an API call, you may pass ForwardingConfig
|
4842
|
-
# data as a hash:
|
4843
|
-
#
|
4844
|
-
# {
|
4845
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
4846
|
-
# }
|
4847
|
-
#
|
4848
3874
|
# @!attribute [rw] state
|
4849
3875
|
# The forwarding state for the given property.
|
4850
3876
|
# @return [String]
|
@@ -4886,18 +3912,6 @@ module Aws::IoTSiteWise
|
|
4886
3912
|
|
4887
3913
|
# Contains a gateway's platform information.
|
4888
3914
|
#
|
4889
|
-
# @note When making an API call, you may pass GatewayPlatform
|
4890
|
-
# data as a hash:
|
4891
|
-
#
|
4892
|
-
# {
|
4893
|
-
# greengrass: {
|
4894
|
-
# group_arn: "ARN", # required
|
4895
|
-
# },
|
4896
|
-
# greengrass_v2: {
|
4897
|
-
# core_device_thing_name: "CoreDeviceThingName", # required
|
4898
|
-
# },
|
4899
|
-
# }
|
4900
|
-
#
|
4901
3915
|
# @!attribute [rw] greengrass
|
4902
3916
|
# A gateway that runs on IoT Greengrass.
|
4903
3917
|
# @return [Types::Greengrass]
|
@@ -4957,23 +3971,6 @@ module Aws::IoTSiteWise
|
|
4957
3971
|
include Aws::Structure
|
4958
3972
|
end
|
4959
3973
|
|
4960
|
-
# @note When making an API call, you may pass GetAssetPropertyAggregatesRequest
|
4961
|
-
# data as a hash:
|
4962
|
-
#
|
4963
|
-
# {
|
4964
|
-
# asset_id: "ID",
|
4965
|
-
# property_id: "ID",
|
4966
|
-
# property_alias: "AssetPropertyAlias",
|
4967
|
-
# aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
|
4968
|
-
# resolution: "Resolution", # required
|
4969
|
-
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
4970
|
-
# start_date: Time.now, # required
|
4971
|
-
# end_date: Time.now, # required
|
4972
|
-
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
4973
|
-
# next_token: "NextToken",
|
4974
|
-
# max_results: 1,
|
4975
|
-
# }
|
4976
|
-
#
|
4977
3974
|
# @!attribute [rw] asset_id
|
4978
3975
|
# The ID of the asset.
|
4979
3976
|
# @return [String]
|
@@ -5064,21 +4061,6 @@ module Aws::IoTSiteWise
|
|
5064
4061
|
include Aws::Structure
|
5065
4062
|
end
|
5066
4063
|
|
5067
|
-
# @note When making an API call, you may pass GetAssetPropertyValueHistoryRequest
|
5068
|
-
# data as a hash:
|
5069
|
-
#
|
5070
|
-
# {
|
5071
|
-
# asset_id: "ID",
|
5072
|
-
# property_id: "ID",
|
5073
|
-
# property_alias: "AssetPropertyAlias",
|
5074
|
-
# start_date: Time.now,
|
5075
|
-
# end_date: Time.now,
|
5076
|
-
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
5077
|
-
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
5078
|
-
# next_token: "NextToken",
|
5079
|
-
# max_results: 1,
|
5080
|
-
# }
|
5081
|
-
#
|
5082
4064
|
# @!attribute [rw] asset_id
|
5083
4065
|
# The ID of the asset.
|
5084
4066
|
# @return [String]
|
@@ -5159,15 +4141,6 @@ module Aws::IoTSiteWise
|
|
5159
4141
|
include Aws::Structure
|
5160
4142
|
end
|
5161
4143
|
|
5162
|
-
# @note When making an API call, you may pass GetAssetPropertyValueRequest
|
5163
|
-
# data as a hash:
|
5164
|
-
#
|
5165
|
-
# {
|
5166
|
-
# asset_id: "ID",
|
5167
|
-
# property_id: "ID",
|
5168
|
-
# property_alias: "AssetPropertyAlias",
|
5169
|
-
# }
|
5170
|
-
#
|
5171
4144
|
# @!attribute [rw] asset_id
|
5172
4145
|
# The ID of the asset.
|
5173
4146
|
# @return [String]
|
@@ -5206,25 +4179,6 @@ module Aws::IoTSiteWise
|
|
5206
4179
|
include Aws::Structure
|
5207
4180
|
end
|
5208
4181
|
|
5209
|
-
# @note When making an API call, you may pass GetInterpolatedAssetPropertyValuesRequest
|
5210
|
-
# data as a hash:
|
5211
|
-
#
|
5212
|
-
# {
|
5213
|
-
# asset_id: "ID",
|
5214
|
-
# property_id: "ID",
|
5215
|
-
# property_alias: "AssetPropertyAlias",
|
5216
|
-
# start_time_in_seconds: 1, # required
|
5217
|
-
# start_time_offset_in_nanos: 1,
|
5218
|
-
# end_time_in_seconds: 1, # required
|
5219
|
-
# end_time_offset_in_nanos: 1,
|
5220
|
-
# quality: "GOOD", # required, accepts GOOD, BAD, UNCERTAIN
|
5221
|
-
# interval_in_seconds: 1, # required
|
5222
|
-
# next_token: "NextToken",
|
5223
|
-
# max_results: 1,
|
5224
|
-
# type: "InterpolationType", # required
|
5225
|
-
# interval_window_in_seconds: 1,
|
5226
|
-
# }
|
5227
|
-
#
|
5228
4182
|
# @!attribute [rw] asset_id
|
5229
4183
|
# The ID of the asset.
|
5230
4184
|
# @return [String]
|
@@ -5390,13 +4344,6 @@ module Aws::IoTSiteWise
|
|
5390
4344
|
#
|
5391
4345
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html
|
5392
4346
|
#
|
5393
|
-
# @note When making an API call, you may pass Greengrass
|
5394
|
-
# data as a hash:
|
5395
|
-
#
|
5396
|
-
# {
|
5397
|
-
# group_arn: "ARN", # required
|
5398
|
-
# }
|
5399
|
-
#
|
5400
4347
|
# @!attribute [rw] group_arn
|
5401
4348
|
# The [ARN][1] of the Greengrass group. For more information about how
|
5402
4349
|
# to find a group's ARN, see [ListGroups][2] and [GetGroup][3] in the
|
@@ -5427,13 +4374,6 @@ module Aws::IoTSiteWise
|
|
5427
4374
|
# [1]: https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html
|
5428
4375
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html
|
5429
4376
|
#
|
5430
|
-
# @note When making an API call, you may pass GreengrassV2
|
5431
|
-
# data as a hash:
|
5432
|
-
#
|
5433
|
-
# {
|
5434
|
-
# core_device_thing_name: "CoreDeviceThingName", # required
|
5435
|
-
# }
|
5436
|
-
#
|
5437
4377
|
# @!attribute [rw] core_device_thing_name
|
5438
4378
|
# The name of the IoT thing for your IoT Greengrass V2 core device.
|
5439
4379
|
# @return [String]
|
@@ -5446,13 +4386,6 @@ module Aws::IoTSiteWise
|
|
5446
4386
|
|
5447
4387
|
# Contains information for a group identity in an access policy.
|
5448
4388
|
#
|
5449
|
-
# @note When making an API call, you may pass GroupIdentity
|
5450
|
-
# data as a hash:
|
5451
|
-
#
|
5452
|
-
# {
|
5453
|
-
# id: "IdentityId", # required
|
5454
|
-
# }
|
5455
|
-
#
|
5456
4389
|
# @!attribute [rw] id
|
5457
4390
|
# The IAM Identity Center ID of the group.
|
5458
4391
|
# @return [String]
|
@@ -5470,13 +4403,6 @@ module Aws::IoTSiteWise
|
|
5470
4403
|
#
|
5471
4404
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html
|
5472
4405
|
#
|
5473
|
-
# @note When making an API call, you may pass IAMRoleIdentity
|
5474
|
-
# data as a hash:
|
5475
|
-
#
|
5476
|
-
# {
|
5477
|
-
# arn: "ARN", # required
|
5478
|
-
# }
|
5479
|
-
#
|
5480
4406
|
# @!attribute [rw] arn
|
5481
4407
|
# The ARN of the IAM role. For more information, see [IAM ARNs][1] in
|
5482
4408
|
# the *IAM User Guide*.
|
@@ -5494,13 +4420,6 @@ module Aws::IoTSiteWise
|
|
5494
4420
|
|
5495
4421
|
# Contains information about an Identity and Access Management user.
|
5496
4422
|
#
|
5497
|
-
# @note When making an API call, you may pass IAMUserIdentity
|
5498
|
-
# data as a hash:
|
5499
|
-
#
|
5500
|
-
# {
|
5501
|
-
# arn: "ARN", # required
|
5502
|
-
# }
|
5503
|
-
#
|
5504
4423
|
# @!attribute [rw] arn
|
5505
4424
|
# The ARN of the IAM user. For more information, see [IAM ARNs][1] in
|
5506
4425
|
# the *IAM User Guide*.
|
@@ -5535,24 +4454,6 @@ module Aws::IoTSiteWise
|
|
5535
4454
|
#
|
5536
4455
|
# [1]: https://console.aws.amazon.com/singlesignon
|
5537
4456
|
#
|
5538
|
-
# @note When making an API call, you may pass Identity
|
5539
|
-
# data as a hash:
|
5540
|
-
#
|
5541
|
-
# {
|
5542
|
-
# user: {
|
5543
|
-
# id: "IdentityId", # required
|
5544
|
-
# },
|
5545
|
-
# group: {
|
5546
|
-
# id: "IdentityId", # required
|
5547
|
-
# },
|
5548
|
-
# iam_user: {
|
5549
|
-
# arn: "ARN", # required
|
5550
|
-
# },
|
5551
|
-
# iam_role: {
|
5552
|
-
# arn: "ARN", # required
|
5553
|
-
# },
|
5554
|
-
# }
|
5555
|
-
#
|
5556
4457
|
# @!attribute [rw] user
|
5557
4458
|
# An IAM Identity Center user identity.
|
5558
4459
|
# @return [Types::UserIdentity]
|
@@ -5585,17 +4486,6 @@ module Aws::IoTSiteWise
|
|
5585
4486
|
# * The ID of an existing image. Choose this option to keep an existing
|
5586
4487
|
# image.
|
5587
4488
|
#
|
5588
|
-
# @note When making an API call, you may pass Image
|
5589
|
-
# data as a hash:
|
5590
|
-
#
|
5591
|
-
# {
|
5592
|
-
# id: "ID",
|
5593
|
-
# file: {
|
5594
|
-
# data: "data", # required
|
5595
|
-
# type: "PNG", # required, accepts PNG
|
5596
|
-
# },
|
5597
|
-
# }
|
5598
|
-
#
|
5599
4489
|
# @!attribute [rw] id
|
5600
4490
|
# The ID of an existing image. Specify this parameter to keep an
|
5601
4491
|
# existing image.
|
@@ -5614,14 +4504,6 @@ module Aws::IoTSiteWise
|
|
5614
4504
|
|
5615
4505
|
# Contains an image file.
|
5616
4506
|
#
|
5617
|
-
# @note When making an API call, you may pass ImageFile
|
5618
|
-
# data as a hash:
|
5619
|
-
#
|
5620
|
-
# {
|
5621
|
-
# data: "data", # required
|
5622
|
-
# type: "PNG", # required, accepts PNG
|
5623
|
-
# }
|
5624
|
-
#
|
5625
4507
|
# @!attribute [rw] data
|
5626
4508
|
# The image file contents, represented as a base64-encoded string. The
|
5627
4509
|
# file size must be less than 1 MB.
|
@@ -5701,17 +4583,6 @@ module Aws::IoTSiteWise
|
|
5701
4583
|
# Contains the configuration information of a job, such as the file
|
5702
4584
|
# format used to save data in Amazon S3.
|
5703
4585
|
#
|
5704
|
-
# @note When making an API call, you may pass JobConfiguration
|
5705
|
-
# data as a hash:
|
5706
|
-
#
|
5707
|
-
# {
|
5708
|
-
# file_format: { # required
|
5709
|
-
# csv: {
|
5710
|
-
# column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
|
5711
|
-
# },
|
5712
|
-
# },
|
5713
|
-
# }
|
5714
|
-
#
|
5715
4586
|
# @!attribute [rw] file_format
|
5716
4587
|
# The file format of the data in Amazon S3.
|
5717
4588
|
# @return [Types::FileFormat]
|
@@ -5785,19 +4656,6 @@ module Aws::IoTSiteWise
|
|
5785
4656
|
include Aws::Structure
|
5786
4657
|
end
|
5787
4658
|
|
5788
|
-
# @note When making an API call, you may pass ListAccessPoliciesRequest
|
5789
|
-
# data as a hash:
|
5790
|
-
#
|
5791
|
-
# {
|
5792
|
-
# identity_type: "USER", # accepts USER, GROUP, IAM
|
5793
|
-
# identity_id: "IdentityId",
|
5794
|
-
# resource_type: "PORTAL", # accepts PORTAL, PROJECT
|
5795
|
-
# resource_id: "ID",
|
5796
|
-
# iam_arn: "ARN",
|
5797
|
-
# next_token: "NextToken",
|
5798
|
-
# max_results: 1,
|
5799
|
-
# }
|
5800
|
-
#
|
5801
4659
|
# @!attribute [rw] identity_type
|
5802
4660
|
# The type of identity (IAM Identity Center user, IAM Identity Center
|
5803
4661
|
# group, or IAM user). This parameter is required if you specify
|
@@ -5867,16 +4725,6 @@ module Aws::IoTSiteWise
|
|
5867
4725
|
include Aws::Structure
|
5868
4726
|
end
|
5869
4727
|
|
5870
|
-
# @note When making an API call, you may pass ListAssetModelPropertiesRequest
|
5871
|
-
# data as a hash:
|
5872
|
-
#
|
5873
|
-
# {
|
5874
|
-
# asset_model_id: "ID", # required
|
5875
|
-
# next_token: "NextToken",
|
5876
|
-
# max_results: 1,
|
5877
|
-
# filter: "ALL", # accepts ALL, BASE
|
5878
|
-
# }
|
5879
|
-
#
|
5880
4728
|
# @!attribute [rw] asset_model_id
|
5881
4729
|
# The ID of the asset model.
|
5882
4730
|
# @return [String]
|
@@ -5929,14 +4777,6 @@ module Aws::IoTSiteWise
|
|
5929
4777
|
include Aws::Structure
|
5930
4778
|
end
|
5931
4779
|
|
5932
|
-
# @note When making an API call, you may pass ListAssetModelsRequest
|
5933
|
-
# data as a hash:
|
5934
|
-
#
|
5935
|
-
# {
|
5936
|
-
# next_token: "NextToken",
|
5937
|
-
# max_results: 1,
|
5938
|
-
# }
|
5939
|
-
#
|
5940
4780
|
# @!attribute [rw] next_token
|
5941
4781
|
# The token to be used for the next set of paginated results.
|
5942
4782
|
# @return [String]
|
@@ -5970,16 +4810,6 @@ module Aws::IoTSiteWise
|
|
5970
4810
|
include Aws::Structure
|
5971
4811
|
end
|
5972
4812
|
|
5973
|
-
# @note When making an API call, you may pass ListAssetPropertiesRequest
|
5974
|
-
# data as a hash:
|
5975
|
-
#
|
5976
|
-
# {
|
5977
|
-
# asset_id: "ID", # required
|
5978
|
-
# next_token: "NextToken",
|
5979
|
-
# max_results: 1,
|
5980
|
-
# filter: "ALL", # accepts ALL, BASE
|
5981
|
-
# }
|
5982
|
-
#
|
5983
4813
|
# @!attribute [rw] asset_id
|
5984
4814
|
# The ID of the asset.
|
5985
4815
|
# @return [String]
|
@@ -6032,16 +4862,6 @@ module Aws::IoTSiteWise
|
|
6032
4862
|
include Aws::Structure
|
6033
4863
|
end
|
6034
4864
|
|
6035
|
-
# @note When making an API call, you may pass ListAssetRelationshipsRequest
|
6036
|
-
# data as a hash:
|
6037
|
-
#
|
6038
|
-
# {
|
6039
|
-
# asset_id: "ID", # required
|
6040
|
-
# traversal_type: "PATH_TO_ROOT", # required, accepts PATH_TO_ROOT
|
6041
|
-
# next_token: "NextToken",
|
6042
|
-
# max_results: 1,
|
6043
|
-
# }
|
6044
|
-
#
|
6045
4865
|
# @!attribute [rw] asset_id
|
6046
4866
|
# The ID of the asset.
|
6047
4867
|
# @return [String]
|
@@ -6091,16 +4911,6 @@ module Aws::IoTSiteWise
|
|
6091
4911
|
include Aws::Structure
|
6092
4912
|
end
|
6093
4913
|
|
6094
|
-
# @note When making an API call, you may pass ListAssetsRequest
|
6095
|
-
# data as a hash:
|
6096
|
-
#
|
6097
|
-
# {
|
6098
|
-
# next_token: "NextToken",
|
6099
|
-
# max_results: 1,
|
6100
|
-
# asset_model_id: "ID",
|
6101
|
-
# filter: "ALL", # accepts ALL, TOP_LEVEL
|
6102
|
-
# }
|
6103
|
-
#
|
6104
4914
|
# @!attribute [rw] next_token
|
6105
4915
|
# The token to be used for the next set of paginated results.
|
6106
4916
|
# @return [String]
|
@@ -6154,17 +4964,6 @@ module Aws::IoTSiteWise
|
|
6154
4964
|
include Aws::Structure
|
6155
4965
|
end
|
6156
4966
|
|
6157
|
-
# @note When making an API call, you may pass ListAssociatedAssetsRequest
|
6158
|
-
# data as a hash:
|
6159
|
-
#
|
6160
|
-
# {
|
6161
|
-
# asset_id: "ID", # required
|
6162
|
-
# hierarchy_id: "ID",
|
6163
|
-
# traversal_direction: "PARENT", # accepts PARENT, CHILD
|
6164
|
-
# next_token: "NextToken",
|
6165
|
-
# max_results: 1,
|
6166
|
-
# }
|
6167
|
-
#
|
6168
4967
|
# @!attribute [rw] asset_id
|
6169
4968
|
# The ID of the asset to query.
|
6170
4969
|
# @return [String]
|
@@ -6234,15 +5033,6 @@ module Aws::IoTSiteWise
|
|
6234
5033
|
include Aws::Structure
|
6235
5034
|
end
|
6236
5035
|
|
6237
|
-
# @note When making an API call, you may pass ListBulkImportJobsRequest
|
6238
|
-
# data as a hash:
|
6239
|
-
#
|
6240
|
-
# {
|
6241
|
-
# next_token: "NextToken",
|
6242
|
-
# max_results: 1,
|
6243
|
-
# filter: "ALL", # accepts ALL, PENDING, RUNNING, CANCELLED, FAILED, COMPLETED_WITH_FAILURES, COMPLETED
|
6244
|
-
# }
|
6245
|
-
#
|
6246
5036
|
# @!attribute [rw] next_token
|
6247
5037
|
# The token to be used for the next set of paginated results.
|
6248
5038
|
# @return [String]
|
@@ -6280,15 +5070,6 @@ module Aws::IoTSiteWise
|
|
6280
5070
|
include Aws::Structure
|
6281
5071
|
end
|
6282
5072
|
|
6283
|
-
# @note When making an API call, you may pass ListDashboardsRequest
|
6284
|
-
# data as a hash:
|
6285
|
-
#
|
6286
|
-
# {
|
6287
|
-
# project_id: "ID", # required
|
6288
|
-
# next_token: "NextToken",
|
6289
|
-
# max_results: 1,
|
6290
|
-
# }
|
6291
|
-
#
|
6292
5073
|
# @!attribute [rw] project_id
|
6293
5074
|
# The ID of the project.
|
6294
5075
|
# @return [String]
|
@@ -6327,14 +5108,6 @@ module Aws::IoTSiteWise
|
|
6327
5108
|
include Aws::Structure
|
6328
5109
|
end
|
6329
5110
|
|
6330
|
-
# @note When making an API call, you may pass ListGatewaysRequest
|
6331
|
-
# data as a hash:
|
6332
|
-
#
|
6333
|
-
# {
|
6334
|
-
# next_token: "NextToken",
|
6335
|
-
# max_results: 1,
|
6336
|
-
# }
|
6337
|
-
#
|
6338
5111
|
# @!attribute [rw] next_token
|
6339
5112
|
# The token to be used for the next set of paginated results.
|
6340
5113
|
# @return [String]
|
@@ -6368,14 +5141,6 @@ module Aws::IoTSiteWise
|
|
6368
5141
|
include Aws::Structure
|
6369
5142
|
end
|
6370
5143
|
|
6371
|
-
# @note When making an API call, you may pass ListPortalsRequest
|
6372
|
-
# data as a hash:
|
6373
|
-
#
|
6374
|
-
# {
|
6375
|
-
# next_token: "NextToken",
|
6376
|
-
# max_results: 1,
|
6377
|
-
# }
|
6378
|
-
#
|
6379
5144
|
# @!attribute [rw] next_token
|
6380
5145
|
# The token to be used for the next set of paginated results.
|
6381
5146
|
# @return [String]
|
@@ -6409,15 +5174,6 @@ module Aws::IoTSiteWise
|
|
6409
5174
|
include Aws::Structure
|
6410
5175
|
end
|
6411
5176
|
|
6412
|
-
# @note When making an API call, you may pass ListProjectAssetsRequest
|
6413
|
-
# data as a hash:
|
6414
|
-
#
|
6415
|
-
# {
|
6416
|
-
# project_id: "ID", # required
|
6417
|
-
# next_token: "NextToken",
|
6418
|
-
# max_results: 1,
|
6419
|
-
# }
|
6420
|
-
#
|
6421
5177
|
# @!attribute [rw] project_id
|
6422
5178
|
# The ID of the project.
|
6423
5179
|
# @return [String]
|
@@ -6457,15 +5213,6 @@ module Aws::IoTSiteWise
|
|
6457
5213
|
include Aws::Structure
|
6458
5214
|
end
|
6459
5215
|
|
6460
|
-
# @note When making an API call, you may pass ListProjectsRequest
|
6461
|
-
# data as a hash:
|
6462
|
-
#
|
6463
|
-
# {
|
6464
|
-
# portal_id: "ID", # required
|
6465
|
-
# next_token: "NextToken",
|
6466
|
-
# max_results: 1,
|
6467
|
-
# }
|
6468
|
-
#
|
6469
5216
|
# @!attribute [rw] portal_id
|
6470
5217
|
# The ID of the portal.
|
6471
5218
|
# @return [String]
|
@@ -6504,13 +5251,6 @@ module Aws::IoTSiteWise
|
|
6504
5251
|
include Aws::Structure
|
6505
5252
|
end
|
6506
5253
|
|
6507
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
6508
|
-
# data as a hash:
|
6509
|
-
#
|
6510
|
-
# {
|
6511
|
-
# resource_arn: "AmazonResourceName", # required
|
6512
|
-
# }
|
6513
|
-
#
|
6514
5254
|
# @!attribute [rw] resource_arn
|
6515
5255
|
# The [ARN][1] of the resource.
|
6516
5256
|
#
|
@@ -6541,17 +5281,6 @@ module Aws::IoTSiteWise
|
|
6541
5281
|
include Aws::Structure
|
6542
5282
|
end
|
6543
5283
|
|
6544
|
-
# @note When making an API call, you may pass ListTimeSeriesRequest
|
6545
|
-
# data as a hash:
|
6546
|
-
#
|
6547
|
-
# {
|
6548
|
-
# next_token: "NextToken",
|
6549
|
-
# max_results: 1,
|
6550
|
-
# asset_id: "ID",
|
6551
|
-
# alias_prefix: "PropertyAlias",
|
6552
|
-
# time_series_type: "ASSOCIATED", # accepts ASSOCIATED, DISASSOCIATED
|
6553
|
-
# }
|
6554
|
-
#
|
6555
5284
|
# @!attribute [rw] next_token
|
6556
5285
|
# The token to be used for the next set of paginated results.
|
6557
5286
|
# @return [String]
|
@@ -6607,13 +5336,6 @@ module Aws::IoTSiteWise
|
|
6607
5336
|
|
6608
5337
|
# Contains logging options.
|
6609
5338
|
#
|
6610
|
-
# @note When making an API call, you may pass LoggingOptions
|
6611
|
-
# data as a hash:
|
6612
|
-
#
|
6613
|
-
# {
|
6614
|
-
# level: "ERROR", # required, accepts ERROR, INFO, OFF
|
6615
|
-
# }
|
6616
|
-
#
|
6617
5339
|
# @!attribute [rw] level
|
6618
5340
|
# The IoT SiteWise logging verbosity level.
|
6619
5341
|
# @return [String]
|
@@ -6631,17 +5353,6 @@ module Aws::IoTSiteWise
|
|
6631
5353
|
#
|
6632
5354
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#measurements
|
6633
5355
|
#
|
6634
|
-
# @note When making an API call, you may pass Measurement
|
6635
|
-
# data as a hash:
|
6636
|
-
#
|
6637
|
-
# {
|
6638
|
-
# processing_config: {
|
6639
|
-
# forwarding_config: { # required
|
6640
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
6641
|
-
# },
|
6642
|
-
# },
|
6643
|
-
# }
|
6644
|
-
#
|
6645
5356
|
# @!attribute [rw] processing_config
|
6646
5357
|
# The processing configuration for the given measurement property. You
|
6647
5358
|
# can configure measurements to be kept at the edge or forwarded to
|
@@ -6660,15 +5371,6 @@ module Aws::IoTSiteWise
|
|
6660
5371
|
# Amazon Web Services Cloud. By default, measurements are forwarded to
|
6661
5372
|
# the cloud.
|
6662
5373
|
#
|
6663
|
-
# @note When making an API call, you may pass MeasurementProcessingConfig
|
6664
|
-
# data as a hash:
|
6665
|
-
#
|
6666
|
-
# {
|
6667
|
-
# forwarding_config: { # required
|
6668
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
6669
|
-
# },
|
6670
|
-
# }
|
6671
|
-
#
|
6672
5374
|
# @!attribute [rw] forwarding_config
|
6673
5375
|
# The forwarding configuration for the given measurement property.
|
6674
5376
|
# @return [Types::ForwardingConfig]
|
@@ -6697,31 +5399,6 @@ module Aws::IoTSiteWise
|
|
6697
5399
|
#
|
6698
5400
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics
|
6699
5401
|
#
|
6700
|
-
# @note When making an API call, you may pass Metric
|
6701
|
-
# data as a hash:
|
6702
|
-
#
|
6703
|
-
# {
|
6704
|
-
# expression: "Expression", # required
|
6705
|
-
# variables: [ # required
|
6706
|
-
# {
|
6707
|
-
# name: "VariableName", # required
|
6708
|
-
# value: { # required
|
6709
|
-
# property_id: "Macro", # required
|
6710
|
-
# hierarchy_id: "Macro",
|
6711
|
-
# },
|
6712
|
-
# },
|
6713
|
-
# ],
|
6714
|
-
# window: { # required
|
6715
|
-
# tumbling: {
|
6716
|
-
# interval: "Interval", # required
|
6717
|
-
# offset: "Offset",
|
6718
|
-
# },
|
6719
|
-
# },
|
6720
|
-
# processing_config: {
|
6721
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
6722
|
-
# },
|
6723
|
-
# }
|
6724
|
-
#
|
6725
5402
|
# @!attribute [rw] expression
|
6726
5403
|
# The mathematical expression that defines the metric aggregation
|
6727
5404
|
# function. You can specify up to 10 variables per expression. You can
|
@@ -6764,13 +5441,6 @@ module Aws::IoTSiteWise
|
|
6764
5441
|
# configure metrics to be computed at the edge or in the Amazon Web
|
6765
5442
|
# Services Cloud. By default, metrics are forwarded to the cloud.
|
6766
5443
|
#
|
6767
|
-
# @note When making an API call, you may pass MetricProcessingConfig
|
6768
|
-
# data as a hash:
|
6769
|
-
#
|
6770
|
-
# {
|
6771
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
6772
|
-
# }
|
6773
|
-
#
|
6774
5444
|
# @!attribute [rw] compute_location
|
6775
5445
|
# The compute location for the given metric property.
|
6776
5446
|
# @return [String]
|
@@ -6784,16 +5454,6 @@ module Aws::IoTSiteWise
|
|
6784
5454
|
# Contains a time interval window used for data aggregate computations
|
6785
5455
|
# (for example, average, sum, count, and so on).
|
6786
5456
|
#
|
6787
|
-
# @note When making an API call, you may pass MetricWindow
|
6788
|
-
# data as a hash:
|
6789
|
-
#
|
6790
|
-
# {
|
6791
|
-
# tumbling: {
|
6792
|
-
# interval: "Interval", # required
|
6793
|
-
# offset: "Offset",
|
6794
|
-
# },
|
6795
|
-
# }
|
6796
|
-
#
|
6797
5457
|
# @!attribute [rw] tumbling
|
6798
5458
|
# The tumbling time interval window.
|
6799
5459
|
# @return [Types::TumblingWindow]
|
@@ -6823,16 +5483,6 @@ module Aws::IoTSiteWise
|
|
6823
5483
|
|
6824
5484
|
# Contains information about the storage destination.
|
6825
5485
|
#
|
6826
|
-
# @note When making an API call, you may pass MultiLayerStorage
|
6827
|
-
# data as a hash:
|
6828
|
-
#
|
6829
|
-
# {
|
6830
|
-
# customer_managed_s3_storage: { # required
|
6831
|
-
# s3_resource_arn: "ARN", # required
|
6832
|
-
# role_arn: "ARN", # required
|
6833
|
-
# },
|
6834
|
-
# }
|
6835
|
-
#
|
6836
5486
|
# @!attribute [rw] customer_managed_s3_storage
|
6837
5487
|
# Contains information about a customer managed Amazon S3 bucket.
|
6838
5488
|
# @return [Types::CustomerManagedS3Storage]
|
@@ -6845,13 +5495,6 @@ module Aws::IoTSiteWise
|
|
6845
5495
|
|
6846
5496
|
# Identifies an IoT SiteWise Monitor portal.
|
6847
5497
|
#
|
6848
|
-
# @note When making an API call, you may pass PortalResource
|
6849
|
-
# data as a hash:
|
6850
|
-
#
|
6851
|
-
# {
|
6852
|
-
# id: "ID", # required
|
6853
|
-
# }
|
6854
|
-
#
|
6855
5498
|
# @!attribute [rw] id
|
6856
5499
|
# The ID of the portal.
|
6857
5500
|
# @return [String]
|
@@ -6939,13 +5582,6 @@ module Aws::IoTSiteWise
|
|
6939
5582
|
|
6940
5583
|
# Identifies a specific IoT SiteWise Monitor project.
|
6941
5584
|
#
|
6942
|
-
# @note When making an API call, you may pass ProjectResource
|
6943
|
-
# data as a hash:
|
6944
|
-
#
|
6945
|
-
# {
|
6946
|
-
# id: "ID", # required
|
6947
|
-
# }
|
6948
|
-
#
|
6949
5585
|
# @!attribute [rw] id
|
6950
5586
|
# The ID of the project.
|
6951
5587
|
# @return [String]
|
@@ -7072,61 +5708,6 @@ module Aws::IoTSiteWise
|
|
7072
5708
|
# Contains a property type, which can be one of `attribute`,
|
7073
5709
|
# `measurement`, `metric`, or `transform`.
|
7074
5710
|
#
|
7075
|
-
# @note When making an API call, you may pass PropertyType
|
7076
|
-
# data as a hash:
|
7077
|
-
#
|
7078
|
-
# {
|
7079
|
-
# attribute: {
|
7080
|
-
# default_value: "DefaultValue",
|
7081
|
-
# },
|
7082
|
-
# measurement: {
|
7083
|
-
# processing_config: {
|
7084
|
-
# forwarding_config: { # required
|
7085
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
7086
|
-
# },
|
7087
|
-
# },
|
7088
|
-
# },
|
7089
|
-
# transform: {
|
7090
|
-
# expression: "Expression", # required
|
7091
|
-
# variables: [ # required
|
7092
|
-
# {
|
7093
|
-
# name: "VariableName", # required
|
7094
|
-
# value: { # required
|
7095
|
-
# property_id: "Macro", # required
|
7096
|
-
# hierarchy_id: "Macro",
|
7097
|
-
# },
|
7098
|
-
# },
|
7099
|
-
# ],
|
7100
|
-
# processing_config: {
|
7101
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
7102
|
-
# forwarding_config: {
|
7103
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
7104
|
-
# },
|
7105
|
-
# },
|
7106
|
-
# },
|
7107
|
-
# metric: {
|
7108
|
-
# expression: "Expression", # required
|
7109
|
-
# variables: [ # required
|
7110
|
-
# {
|
7111
|
-
# name: "VariableName", # required
|
7112
|
-
# value: { # required
|
7113
|
-
# property_id: "Macro", # required
|
7114
|
-
# hierarchy_id: "Macro",
|
7115
|
-
# },
|
7116
|
-
# },
|
7117
|
-
# ],
|
7118
|
-
# window: { # required
|
7119
|
-
# tumbling: {
|
7120
|
-
# interval: "Interval", # required
|
7121
|
-
# offset: "Offset",
|
7122
|
-
# },
|
7123
|
-
# },
|
7124
|
-
# processing_config: {
|
7125
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
7126
|
-
# },
|
7127
|
-
# },
|
7128
|
-
# }
|
7129
|
-
#
|
7130
5711
|
# @!attribute [rw] attribute
|
7131
5712
|
# Specifies an asset attribute property. An attribute generally
|
7132
5713
|
# contains static information, such as the serial number of an
|
@@ -7174,31 +5755,6 @@ module Aws::IoTSiteWise
|
|
7174
5755
|
#
|
7175
5756
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html
|
7176
5757
|
#
|
7177
|
-
# @note When making an API call, you may pass PutAssetPropertyValueEntry
|
7178
|
-
# data as a hash:
|
7179
|
-
#
|
7180
|
-
# {
|
7181
|
-
# entry_id: "EntryId", # required
|
7182
|
-
# asset_id: "ID",
|
7183
|
-
# property_id: "ID",
|
7184
|
-
# property_alias: "AssetPropertyAlias",
|
7185
|
-
# property_values: [ # required
|
7186
|
-
# {
|
7187
|
-
# value: { # required
|
7188
|
-
# string_value: "PropertyValueStringValue",
|
7189
|
-
# integer_value: 1,
|
7190
|
-
# double_value: 1.0,
|
7191
|
-
# boolean_value: false,
|
7192
|
-
# },
|
7193
|
-
# timestamp: { # required
|
7194
|
-
# time_in_seconds: 1, # required
|
7195
|
-
# offset_in_nanos: 1,
|
7196
|
-
# },
|
7197
|
-
# quality: "GOOD", # accepts GOOD, BAD, UNCERTAIN
|
7198
|
-
# },
|
7199
|
-
# ],
|
7200
|
-
# }
|
7201
|
-
#
|
7202
5758
|
# @!attribute [rw] entry_id
|
7203
5759
|
# The user specified ID for the entry. You can use this ID to identify
|
7204
5760
|
# which entries failed.
|
@@ -7239,14 +5795,6 @@ module Aws::IoTSiteWise
|
|
7239
5795
|
include Aws::Structure
|
7240
5796
|
end
|
7241
5797
|
|
7242
|
-
# @note When making an API call, you may pass PutDefaultEncryptionConfigurationRequest
|
7243
|
-
# data as a hash:
|
7244
|
-
#
|
7245
|
-
# {
|
7246
|
-
# encryption_type: "SITEWISE_DEFAULT_ENCRYPTION", # required, accepts SITEWISE_DEFAULT_ENCRYPTION, KMS_BASED_ENCRYPTION
|
7247
|
-
# kms_key_id: "KmsKeyId",
|
7248
|
-
# }
|
7249
|
-
#
|
7250
5798
|
# @!attribute [rw] encryption_type
|
7251
5799
|
# The type of encryption used for the encryption configuration.
|
7252
5800
|
# @return [String]
|
@@ -7286,15 +5834,6 @@ module Aws::IoTSiteWise
|
|
7286
5834
|
include Aws::Structure
|
7287
5835
|
end
|
7288
5836
|
|
7289
|
-
# @note When making an API call, you may pass PutLoggingOptionsRequest
|
7290
|
-
# data as a hash:
|
7291
|
-
#
|
7292
|
-
# {
|
7293
|
-
# logging_options: { # required
|
7294
|
-
# level: "ERROR", # required, accepts ERROR, INFO, OFF
|
7295
|
-
# },
|
7296
|
-
# }
|
7297
|
-
#
|
7298
5837
|
# @!attribute [rw] logging_options
|
7299
5838
|
# The logging options to set.
|
7300
5839
|
# @return [Types::LoggingOptions]
|
@@ -7307,24 +5846,6 @@ module Aws::IoTSiteWise
|
|
7307
5846
|
|
7308
5847
|
class PutLoggingOptionsResponse < Aws::EmptyStructure; end
|
7309
5848
|
|
7310
|
-
# @note When making an API call, you may pass PutStorageConfigurationRequest
|
7311
|
-
# data as a hash:
|
7312
|
-
#
|
7313
|
-
# {
|
7314
|
-
# storage_type: "SITEWISE_DEFAULT_STORAGE", # required, accepts SITEWISE_DEFAULT_STORAGE, MULTI_LAYER_STORAGE
|
7315
|
-
# multi_layer_storage: {
|
7316
|
-
# customer_managed_s3_storage: { # required
|
7317
|
-
# s3_resource_arn: "ARN", # required
|
7318
|
-
# role_arn: "ARN", # required
|
7319
|
-
# },
|
7320
|
-
# },
|
7321
|
-
# disassociated_data_storage: "ENABLED", # accepts ENABLED, DISABLED
|
7322
|
-
# retention_period: {
|
7323
|
-
# number_of_days: 1,
|
7324
|
-
# unlimited: false,
|
7325
|
-
# },
|
7326
|
-
# }
|
7327
|
-
#
|
7328
5849
|
# @!attribute [rw] storage_type
|
7329
5850
|
# The storage tier that you specified for your data. The `storageType`
|
7330
5851
|
# parameter can be one of the following values:
|
@@ -7438,18 +5959,6 @@ module Aws::IoTSiteWise
|
|
7438
5959
|
|
7439
5960
|
# Contains an IoT SiteWise Monitor resource ID for a portal or project.
|
7440
5961
|
#
|
7441
|
-
# @note When making an API call, you may pass Resource
|
7442
|
-
# data as a hash:
|
7443
|
-
#
|
7444
|
-
# {
|
7445
|
-
# portal: {
|
7446
|
-
# id: "ID", # required
|
7447
|
-
# },
|
7448
|
-
# project: {
|
7449
|
-
# id: "ID", # required
|
7450
|
-
# },
|
7451
|
-
# }
|
7452
|
-
#
|
7453
5962
|
# @!attribute [rw] portal
|
7454
5963
|
# A portal resource.
|
7455
5964
|
# @return [Types::PortalResource]
|
@@ -7500,14 +6009,6 @@ module Aws::IoTSiteWise
|
|
7500
6009
|
# How many days your data is kept in the hot tier. By default, your data
|
7501
6010
|
# is kept indefinitely in the hot tier.
|
7502
6011
|
#
|
7503
|
-
# @note When making an API call, you may pass RetentionPeriod
|
7504
|
-
# data as a hash:
|
7505
|
-
#
|
7506
|
-
# {
|
7507
|
-
# number_of_days: 1,
|
7508
|
-
# unlimited: false,
|
7509
|
-
# }
|
7510
|
-
#
|
7511
6012
|
# @!attribute [rw] number_of_days
|
7512
6013
|
# The number of days that your data is kept.
|
7513
6014
|
#
|
@@ -7544,16 +6045,6 @@ module Aws::IoTSiteWise
|
|
7544
6045
|
include Aws::Structure
|
7545
6046
|
end
|
7546
6047
|
|
7547
|
-
# @note When making an API call, you may pass TagResourceRequest
|
7548
|
-
# data as a hash:
|
7549
|
-
#
|
7550
|
-
# {
|
7551
|
-
# resource_arn: "AmazonResourceName", # required
|
7552
|
-
# tags: { # required
|
7553
|
-
# "TagKey" => "TagValue",
|
7554
|
-
# },
|
7555
|
-
# }
|
7556
|
-
#
|
7557
6048
|
# @!attribute [rw] resource_arn
|
7558
6049
|
# The [ARN][1] of the resource to tag.
|
7559
6050
|
#
|
@@ -7603,14 +6094,6 @@ module Aws::IoTSiteWise
|
|
7603
6094
|
|
7604
6095
|
# Contains a timestamp with optional nanosecond granularity.
|
7605
6096
|
#
|
7606
|
-
# @note When making an API call, you may pass TimeInNanos
|
7607
|
-
# data as a hash:
|
7608
|
-
#
|
7609
|
-
# {
|
7610
|
-
# time_in_seconds: 1, # required
|
7611
|
-
# offset_in_nanos: 1,
|
7612
|
-
# }
|
7613
|
-
#
|
7614
6097
|
# @!attribute [rw] time_in_seconds
|
7615
6098
|
# The timestamp date, in seconds, in the Unix epoch format. Fractional
|
7616
6099
|
# nanosecond data is provided by `offsetInNanos`.
|
@@ -7670,6 +6153,16 @@ module Aws::IoTSiteWise
|
|
7670
6153
|
# The date that the time series was last updated, in Unix epoch time.
|
7671
6154
|
# @return [Time]
|
7672
6155
|
#
|
6156
|
+
# @!attribute [rw] time_series_arn
|
6157
|
+
# The [ARN][1] of the time series, which has the following format.
|
6158
|
+
#
|
6159
|
+
# `arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:time-series/$\{TimeSeriesId\}`
|
6160
|
+
#
|
6161
|
+
#
|
6162
|
+
#
|
6163
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
6164
|
+
# @return [String]
|
6165
|
+
#
|
7673
6166
|
class TimeSeriesSummary < Struct.new(
|
7674
6167
|
:asset_id,
|
7675
6168
|
:property_id,
|
@@ -7678,7 +6171,8 @@ module Aws::IoTSiteWise
|
|
7678
6171
|
:data_type,
|
7679
6172
|
:data_type_spec,
|
7680
6173
|
:time_series_creation_date,
|
7681
|
-
:time_series_last_update_date
|
6174
|
+
:time_series_last_update_date,
|
6175
|
+
:time_series_arn)
|
7682
6176
|
SENSITIVE = []
|
7683
6177
|
include Aws::Structure
|
7684
6178
|
end
|
@@ -7720,28 +6214,6 @@ module Aws::IoTSiteWise
|
|
7720
6214
|
#
|
7721
6215
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#transforms
|
7722
6216
|
#
|
7723
|
-
# @note When making an API call, you may pass Transform
|
7724
|
-
# data as a hash:
|
7725
|
-
#
|
7726
|
-
# {
|
7727
|
-
# expression: "Expression", # required
|
7728
|
-
# variables: [ # required
|
7729
|
-
# {
|
7730
|
-
# name: "VariableName", # required
|
7731
|
-
# value: { # required
|
7732
|
-
# property_id: "Macro", # required
|
7733
|
-
# hierarchy_id: "Macro",
|
7734
|
-
# },
|
7735
|
-
# },
|
7736
|
-
# ],
|
7737
|
-
# processing_config: {
|
7738
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
7739
|
-
# forwarding_config: {
|
7740
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
7741
|
-
# },
|
7742
|
-
# },
|
7743
|
-
# }
|
7744
|
-
#
|
7745
6217
|
# @!attribute [rw] expression
|
7746
6218
|
# The mathematical expression that defines the transformation
|
7747
6219
|
# function. You can specify up to 10 variables per expression. You can
|
@@ -7779,16 +6251,6 @@ module Aws::IoTSiteWise
|
|
7779
6251
|
# Web Services Cloud. You can also configure transforms to be computed
|
7780
6252
|
# at the edge or in the cloud.
|
7781
6253
|
#
|
7782
|
-
# @note When making an API call, you may pass TransformProcessingConfig
|
7783
|
-
# data as a hash:
|
7784
|
-
#
|
7785
|
-
# {
|
7786
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
7787
|
-
# forwarding_config: {
|
7788
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
7789
|
-
# },
|
7790
|
-
# }
|
7791
|
-
#
|
7792
6254
|
# @!attribute [rw] compute_location
|
7793
6255
|
# The compute location for the given transform property.
|
7794
6256
|
# @return [String]
|
@@ -7821,14 +6283,6 @@ module Aws::IoTSiteWise
|
|
7821
6283
|
#
|
7822
6284
|
# [1]: https://en.wikipedia.org/wiki/ISO_8601
|
7823
6285
|
#
|
7824
|
-
# @note When making an API call, you may pass TumblingWindow
|
7825
|
-
# data as a hash:
|
7826
|
-
#
|
7827
|
-
# {
|
7828
|
-
# interval: "Interval", # required
|
7829
|
-
# offset: "Offset",
|
7830
|
-
# }
|
7831
|
-
#
|
7832
6286
|
# @!attribute [rw] interval
|
7833
6287
|
# The time interval for the tumbling window. The interval time must be
|
7834
6288
|
# between 1 minute and 1 week.
|
@@ -7913,14 +6367,6 @@ module Aws::IoTSiteWise
|
|
7913
6367
|
include Aws::Structure
|
7914
6368
|
end
|
7915
6369
|
|
7916
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
7917
|
-
# data as a hash:
|
7918
|
-
#
|
7919
|
-
# {
|
7920
|
-
# resource_arn: "AmazonResourceName", # required
|
7921
|
-
# tag_keys: ["TagKey"], # required
|
7922
|
-
# }
|
7923
|
-
#
|
7924
6370
|
# @!attribute [rw] resource_arn
|
7925
6371
|
# The [ARN][1] of the resource to untag.
|
7926
6372
|
#
|
@@ -7942,37 +6388,6 @@ module Aws::IoTSiteWise
|
|
7942
6388
|
|
7943
6389
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
7944
6390
|
|
7945
|
-
# @note When making an API call, you may pass UpdateAccessPolicyRequest
|
7946
|
-
# data as a hash:
|
7947
|
-
#
|
7948
|
-
# {
|
7949
|
-
# access_policy_id: "ID", # required
|
7950
|
-
# access_policy_identity: { # required
|
7951
|
-
# user: {
|
7952
|
-
# id: "IdentityId", # required
|
7953
|
-
# },
|
7954
|
-
# group: {
|
7955
|
-
# id: "IdentityId", # required
|
7956
|
-
# },
|
7957
|
-
# iam_user: {
|
7958
|
-
# arn: "ARN", # required
|
7959
|
-
# },
|
7960
|
-
# iam_role: {
|
7961
|
-
# arn: "ARN", # required
|
7962
|
-
# },
|
7963
|
-
# },
|
7964
|
-
# access_policy_resource: { # required
|
7965
|
-
# portal: {
|
7966
|
-
# id: "ID", # required
|
7967
|
-
# },
|
7968
|
-
# project: {
|
7969
|
-
# id: "ID", # required
|
7970
|
-
# },
|
7971
|
-
# },
|
7972
|
-
# access_policy_permission: "ADMINISTRATOR", # required, accepts ADMINISTRATOR, VIEWER
|
7973
|
-
# client_token: "ClientToken",
|
7974
|
-
# }
|
7975
|
-
#
|
7976
6391
|
# @!attribute [rw] access_policy_id
|
7977
6392
|
# The ID of the access policy.
|
7978
6393
|
# @return [String]
|
@@ -8013,151 +6428,6 @@ module Aws::IoTSiteWise
|
|
8013
6428
|
|
8014
6429
|
class UpdateAccessPolicyResponse < Aws::EmptyStructure; end
|
8015
6430
|
|
8016
|
-
# @note When making an API call, you may pass UpdateAssetModelRequest
|
8017
|
-
# data as a hash:
|
8018
|
-
#
|
8019
|
-
# {
|
8020
|
-
# asset_model_id: "ID", # required
|
8021
|
-
# asset_model_name: "Name", # required
|
8022
|
-
# asset_model_description: "Description",
|
8023
|
-
# asset_model_properties: [
|
8024
|
-
# {
|
8025
|
-
# id: "ID",
|
8026
|
-
# name: "Name", # required
|
8027
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
8028
|
-
# data_type_spec: "Name",
|
8029
|
-
# unit: "PropertyUnit",
|
8030
|
-
# type: { # required
|
8031
|
-
# attribute: {
|
8032
|
-
# default_value: "DefaultValue",
|
8033
|
-
# },
|
8034
|
-
# measurement: {
|
8035
|
-
# processing_config: {
|
8036
|
-
# forwarding_config: { # required
|
8037
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
8038
|
-
# },
|
8039
|
-
# },
|
8040
|
-
# },
|
8041
|
-
# transform: {
|
8042
|
-
# expression: "Expression", # required
|
8043
|
-
# variables: [ # required
|
8044
|
-
# {
|
8045
|
-
# name: "VariableName", # required
|
8046
|
-
# value: { # required
|
8047
|
-
# property_id: "Macro", # required
|
8048
|
-
# hierarchy_id: "Macro",
|
8049
|
-
# },
|
8050
|
-
# },
|
8051
|
-
# ],
|
8052
|
-
# processing_config: {
|
8053
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
8054
|
-
# forwarding_config: {
|
8055
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
8056
|
-
# },
|
8057
|
-
# },
|
8058
|
-
# },
|
8059
|
-
# metric: {
|
8060
|
-
# expression: "Expression", # required
|
8061
|
-
# variables: [ # required
|
8062
|
-
# {
|
8063
|
-
# name: "VariableName", # required
|
8064
|
-
# value: { # required
|
8065
|
-
# property_id: "Macro", # required
|
8066
|
-
# hierarchy_id: "Macro",
|
8067
|
-
# },
|
8068
|
-
# },
|
8069
|
-
# ],
|
8070
|
-
# window: { # required
|
8071
|
-
# tumbling: {
|
8072
|
-
# interval: "Interval", # required
|
8073
|
-
# offset: "Offset",
|
8074
|
-
# },
|
8075
|
-
# },
|
8076
|
-
# processing_config: {
|
8077
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
8078
|
-
# },
|
8079
|
-
# },
|
8080
|
-
# },
|
8081
|
-
# },
|
8082
|
-
# ],
|
8083
|
-
# asset_model_hierarchies: [
|
8084
|
-
# {
|
8085
|
-
# id: "ID",
|
8086
|
-
# name: "Name", # required
|
8087
|
-
# child_asset_model_id: "ID", # required
|
8088
|
-
# },
|
8089
|
-
# ],
|
8090
|
-
# asset_model_composite_models: [
|
8091
|
-
# {
|
8092
|
-
# name: "Name", # required
|
8093
|
-
# description: "Description",
|
8094
|
-
# type: "Name", # required
|
8095
|
-
# properties: [
|
8096
|
-
# {
|
8097
|
-
# id: "ID",
|
8098
|
-
# name: "Name", # required
|
8099
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
8100
|
-
# data_type_spec: "Name",
|
8101
|
-
# unit: "PropertyUnit",
|
8102
|
-
# type: { # required
|
8103
|
-
# attribute: {
|
8104
|
-
# default_value: "DefaultValue",
|
8105
|
-
# },
|
8106
|
-
# measurement: {
|
8107
|
-
# processing_config: {
|
8108
|
-
# forwarding_config: { # required
|
8109
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
8110
|
-
# },
|
8111
|
-
# },
|
8112
|
-
# },
|
8113
|
-
# transform: {
|
8114
|
-
# expression: "Expression", # required
|
8115
|
-
# variables: [ # required
|
8116
|
-
# {
|
8117
|
-
# name: "VariableName", # required
|
8118
|
-
# value: { # required
|
8119
|
-
# property_id: "Macro", # required
|
8120
|
-
# hierarchy_id: "Macro",
|
8121
|
-
# },
|
8122
|
-
# },
|
8123
|
-
# ],
|
8124
|
-
# processing_config: {
|
8125
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
8126
|
-
# forwarding_config: {
|
8127
|
-
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
8128
|
-
# },
|
8129
|
-
# },
|
8130
|
-
# },
|
8131
|
-
# metric: {
|
8132
|
-
# expression: "Expression", # required
|
8133
|
-
# variables: [ # required
|
8134
|
-
# {
|
8135
|
-
# name: "VariableName", # required
|
8136
|
-
# value: { # required
|
8137
|
-
# property_id: "Macro", # required
|
8138
|
-
# hierarchy_id: "Macro",
|
8139
|
-
# },
|
8140
|
-
# },
|
8141
|
-
# ],
|
8142
|
-
# window: { # required
|
8143
|
-
# tumbling: {
|
8144
|
-
# interval: "Interval", # required
|
8145
|
-
# offset: "Offset",
|
8146
|
-
# },
|
8147
|
-
# },
|
8148
|
-
# processing_config: {
|
8149
|
-
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
8150
|
-
# },
|
8151
|
-
# },
|
8152
|
-
# },
|
8153
|
-
# },
|
8154
|
-
# ],
|
8155
|
-
# id: "ID",
|
8156
|
-
# },
|
8157
|
-
# ],
|
8158
|
-
# client_token: "ClientToken",
|
8159
|
-
# }
|
8160
|
-
#
|
8161
6431
|
# @!attribute [rw] asset_model_id
|
8162
6432
|
# The ID of the asset model to update.
|
8163
6433
|
# @return [String]
|
@@ -8239,18 +6509,6 @@ module Aws::IoTSiteWise
|
|
8239
6509
|
include Aws::Structure
|
8240
6510
|
end
|
8241
6511
|
|
8242
|
-
# @note When making an API call, you may pass UpdateAssetPropertyRequest
|
8243
|
-
# data as a hash:
|
8244
|
-
#
|
8245
|
-
# {
|
8246
|
-
# asset_id: "ID", # required
|
8247
|
-
# property_id: "ID", # required
|
8248
|
-
# property_alias: "PropertyAlias",
|
8249
|
-
# property_notification_state: "ENABLED", # accepts ENABLED, DISABLED
|
8250
|
-
# client_token: "ClientToken",
|
8251
|
-
# property_unit: "PropertyUnit",
|
8252
|
-
# }
|
8253
|
-
#
|
8254
6512
|
# @!attribute [rw] asset_id
|
8255
6513
|
# The ID of the asset to be updated.
|
8256
6514
|
# @return [String]
|
@@ -8314,16 +6572,6 @@ module Aws::IoTSiteWise
|
|
8314
6572
|
include Aws::Structure
|
8315
6573
|
end
|
8316
6574
|
|
8317
|
-
# @note When making an API call, you may pass UpdateAssetRequest
|
8318
|
-
# data as a hash:
|
8319
|
-
#
|
8320
|
-
# {
|
8321
|
-
# asset_id: "ID", # required
|
8322
|
-
# asset_name: "Name", # required
|
8323
|
-
# client_token: "ClientToken",
|
8324
|
-
# asset_description: "Description",
|
8325
|
-
# }
|
8326
|
-
#
|
8327
6575
|
# @!attribute [rw] asset_id
|
8328
6576
|
# The ID of the asset to update.
|
8329
6577
|
# @return [String]
|
@@ -8365,17 +6613,6 @@ module Aws::IoTSiteWise
|
|
8365
6613
|
include Aws::Structure
|
8366
6614
|
end
|
8367
6615
|
|
8368
|
-
# @note When making an API call, you may pass UpdateDashboardRequest
|
8369
|
-
# data as a hash:
|
8370
|
-
#
|
8371
|
-
# {
|
8372
|
-
# dashboard_id: "ID", # required
|
8373
|
-
# dashboard_name: "Name", # required
|
8374
|
-
# dashboard_description: "Description",
|
8375
|
-
# dashboard_definition: "DashboardDefinition", # required
|
8376
|
-
# client_token: "ClientToken",
|
8377
|
-
# }
|
8378
|
-
#
|
8379
6616
|
# @!attribute [rw] dashboard_id
|
8380
6617
|
# The ID of the dashboard to update.
|
8381
6618
|
# @return [String]
|
@@ -8419,15 +6656,6 @@ module Aws::IoTSiteWise
|
|
8419
6656
|
|
8420
6657
|
class UpdateDashboardResponse < Aws::EmptyStructure; end
|
8421
6658
|
|
8422
|
-
# @note When making an API call, you may pass UpdateGatewayCapabilityConfigurationRequest
|
8423
|
-
# data as a hash:
|
8424
|
-
#
|
8425
|
-
# {
|
8426
|
-
# gateway_id: "ID", # required
|
8427
|
-
# capability_namespace: "CapabilityNamespace", # required
|
8428
|
-
# capability_configuration: "CapabilityConfiguration", # required
|
8429
|
-
# }
|
8430
|
-
#
|
8431
6659
|
# @!attribute [rw] gateway_id
|
8432
6660
|
# The ID of the gateway to be updated.
|
8433
6661
|
# @return [String]
|
@@ -8485,14 +6713,6 @@ module Aws::IoTSiteWise
|
|
8485
6713
|
include Aws::Structure
|
8486
6714
|
end
|
8487
6715
|
|
8488
|
-
# @note When making an API call, you may pass UpdateGatewayRequest
|
8489
|
-
# data as a hash:
|
8490
|
-
#
|
8491
|
-
# {
|
8492
|
-
# gateway_id: "ID", # required
|
8493
|
-
# gateway_name: "Name", # required
|
8494
|
-
# }
|
8495
|
-
#
|
8496
6716
|
# @!attribute [rw] gateway_id
|
8497
6717
|
# The ID of the gateway to update.
|
8498
6718
|
# @return [String]
|
@@ -8508,30 +6728,6 @@ module Aws::IoTSiteWise
|
|
8508
6728
|
include Aws::Structure
|
8509
6729
|
end
|
8510
6730
|
|
8511
|
-
# @note When making an API call, you may pass UpdatePortalRequest
|
8512
|
-
# data as a hash:
|
8513
|
-
#
|
8514
|
-
# {
|
8515
|
-
# portal_id: "ID", # required
|
8516
|
-
# portal_name: "Name", # required
|
8517
|
-
# portal_description: "Description",
|
8518
|
-
# portal_contact_email: "Email", # required
|
8519
|
-
# portal_logo_image: {
|
8520
|
-
# id: "ID",
|
8521
|
-
# file: {
|
8522
|
-
# data: "data", # required
|
8523
|
-
# type: "PNG", # required, accepts PNG
|
8524
|
-
# },
|
8525
|
-
# },
|
8526
|
-
# role_arn: "ARN", # required
|
8527
|
-
# client_token: "ClientToken",
|
8528
|
-
# notification_sender_email: "Email",
|
8529
|
-
# alarms: {
|
8530
|
-
# alarm_role_arn: "ARN", # required
|
8531
|
-
# notification_lambda_arn: "ARN",
|
8532
|
-
# },
|
8533
|
-
# }
|
8534
|
-
#
|
8535
6731
|
# @!attribute [rw] portal_id
|
8536
6732
|
# The ID of the portal to update.
|
8537
6733
|
# @return [String]
|
@@ -8619,16 +6815,6 @@ module Aws::IoTSiteWise
|
|
8619
6815
|
include Aws::Structure
|
8620
6816
|
end
|
8621
6817
|
|
8622
|
-
# @note When making an API call, you may pass UpdateProjectRequest
|
8623
|
-
# data as a hash:
|
8624
|
-
#
|
8625
|
-
# {
|
8626
|
-
# project_id: "ID", # required
|
8627
|
-
# project_name: "Name", # required
|
8628
|
-
# project_description: "Description",
|
8629
|
-
# client_token: "ClientToken",
|
8630
|
-
# }
|
8631
|
-
#
|
8632
6818
|
# @!attribute [rw] project_id
|
8633
6819
|
# The ID of the project to update.
|
8634
6820
|
# @return [String]
|
@@ -8663,13 +6849,6 @@ module Aws::IoTSiteWise
|
|
8663
6849
|
|
8664
6850
|
# Contains information for a user identity in an access policy.
|
8665
6851
|
#
|
8666
|
-
# @note When making an API call, you may pass UserIdentity
|
8667
|
-
# data as a hash:
|
8668
|
-
#
|
8669
|
-
# {
|
8670
|
-
# id: "IdentityId", # required
|
8671
|
-
# }
|
8672
|
-
#
|
8673
6852
|
# @!attribute [rw] id
|
8674
6853
|
# The IAM Identity Center ID of the user.
|
8675
6854
|
# @return [String]
|
@@ -8682,14 +6861,6 @@ module Aws::IoTSiteWise
|
|
8682
6861
|
|
8683
6862
|
# Identifies a property value used in an expression.
|
8684
6863
|
#
|
8685
|
-
# @note When making an API call, you may pass VariableValue
|
8686
|
-
# data as a hash:
|
8687
|
-
#
|
8688
|
-
# {
|
8689
|
-
# property_id: "Macro", # required
|
8690
|
-
# hierarchy_id: "Macro",
|
8691
|
-
# }
|
8692
|
-
#
|
8693
6864
|
# @!attribute [rw] property_id
|
8694
6865
|
# The ID of the property to use as the variable. You can use the
|
8695
6866
|
# property `name` if it's from the same asset model.
|
@@ -8719,16 +6890,6 @@ module Aws::IoTSiteWise
|
|
8719
6890
|
|
8720
6891
|
# Contains an asset property value (of a single type only).
|
8721
6892
|
#
|
8722
|
-
# @note When making an API call, you may pass Variant
|
8723
|
-
# data as a hash:
|
8724
|
-
#
|
8725
|
-
# {
|
8726
|
-
# string_value: "PropertyValueStringValue",
|
8727
|
-
# integer_value: 1,
|
8728
|
-
# double_value: 1.0,
|
8729
|
-
# boolean_value: false,
|
8730
|
-
# }
|
8731
|
-
#
|
8732
6893
|
# @!attribute [rw] string_value
|
8733
6894
|
# Asset property data of type string (sequence of characters).
|
8734
6895
|
# @return [String]
|