aws-sdk-iotsitewise 1.23.0 → 1.27.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotsitewise.rb +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +406 -199
- data/lib/aws-sdk-iotsitewise/client_api.rb +147 -26
- data/lib/aws-sdk-iotsitewise/types.rb +750 -240
- metadata +4 -4
@@ -10,19 +10,20 @@
|
|
10
10
|
module Aws::IoTSiteWise
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# Contains an access policy that defines an identity's access to an
|
14
|
-
#
|
13
|
+
# Contains an access policy that defines an identity's access to an IoT
|
14
|
+
# SiteWise Monitor resource.
|
15
15
|
#
|
16
16
|
# @!attribute [rw] id
|
17
17
|
# The ID of the access policy.
|
18
18
|
# @return [String]
|
19
19
|
#
|
20
20
|
# @!attribute [rw] identity
|
21
|
-
# The identity (an
|
21
|
+
# The identity (an Amazon Web Services SSO user, an Amazon Web
|
22
|
+
# Services SSO group, or an IAM user).
|
22
23
|
# @return [Types::Identity]
|
23
24
|
#
|
24
25
|
# @!attribute [rw] resource
|
25
|
-
# The
|
26
|
+
# The IoT SiteWise Monitor resource (a portal or project).
|
26
27
|
# @return [Types::Resource]
|
27
28
|
#
|
28
29
|
# @!attribute [rw] permission
|
@@ -112,10 +113,15 @@ module Aws::IoTSiteWise
|
|
112
113
|
include Aws::Structure
|
113
114
|
end
|
114
115
|
|
115
|
-
# Contains the configuration information of an alarm created in an
|
116
|
-
#
|
116
|
+
# Contains the configuration information of an alarm created in an IoT
|
117
|
+
# SiteWise Monitor portal. You can use the alarm to monitor an asset
|
117
118
|
# property and get notified when the asset property value is outside a
|
118
|
-
# specified range. For more information, see
|
119
|
+
# specified range. For more information, see [Monitoring with alarms][1]
|
120
|
+
# in the *IoT SiteWise Application Guide*.
|
121
|
+
#
|
122
|
+
#
|
123
|
+
#
|
124
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
|
119
125
|
#
|
120
126
|
# @note When making an API call, you may pass Alarms
|
121
127
|
# data as a hash:
|
@@ -127,7 +133,8 @@ module Aws::IoTSiteWise
|
|
127
133
|
#
|
128
134
|
# @!attribute [rw] alarm_role_arn
|
129
135
|
# The [ARN][1] of the IAM role that allows the alarm to perform
|
130
|
-
# actions and access
|
136
|
+
# actions and access Amazon Web Services resources and services, such
|
137
|
+
# as IoT Events.
|
131
138
|
#
|
132
139
|
#
|
133
140
|
#
|
@@ -135,14 +142,14 @@ module Aws::IoTSiteWise
|
|
135
142
|
# @return [String]
|
136
143
|
#
|
137
144
|
# @!attribute [rw] notification_lambda_arn
|
138
|
-
# The [ARN][1] of the
|
145
|
+
# The [ARN][1] of the Lambda function that manages alarm
|
139
146
|
# notifications. For more information, see [Managing alarm
|
140
|
-
# notifications][2] in the *
|
147
|
+
# notifications][2] in the *IoT Events Developer Guide*.
|
141
148
|
#
|
142
149
|
#
|
143
150
|
#
|
144
151
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
145
|
-
# [2]: https://docs.aws.amazon.com/
|
152
|
+
# [2]: https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html
|
146
153
|
# @return [String]
|
147
154
|
#
|
148
155
|
class Alarms < Struct.new(
|
@@ -269,6 +276,11 @@ module Aws::IoTSiteWise
|
|
269
276
|
# default_value: "DefaultValue",
|
270
277
|
# },
|
271
278
|
# measurement: {
|
279
|
+
# processing_config: {
|
280
|
+
# forwarding_config: { # required
|
281
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
282
|
+
# },
|
283
|
+
# },
|
272
284
|
# },
|
273
285
|
# transform: {
|
274
286
|
# expression: "Expression", # required
|
@@ -281,6 +293,12 @@ module Aws::IoTSiteWise
|
|
281
293
|
# },
|
282
294
|
# },
|
283
295
|
# ],
|
296
|
+
# processing_config: {
|
297
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
298
|
+
# forwarding_config: {
|
299
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
300
|
+
# },
|
301
|
+
# },
|
284
302
|
# },
|
285
303
|
# metric: {
|
286
304
|
# expression: "Expression", # required
|
@@ -298,6 +316,9 @@ module Aws::IoTSiteWise
|
|
298
316
|
# interval: "Interval", # required
|
299
317
|
# },
|
300
318
|
# },
|
319
|
+
# processing_config: {
|
320
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
321
|
+
# },
|
301
322
|
# },
|
302
323
|
# },
|
303
324
|
# },
|
@@ -352,6 +373,11 @@ module Aws::IoTSiteWise
|
|
352
373
|
# default_value: "DefaultValue",
|
353
374
|
# },
|
354
375
|
# measurement: {
|
376
|
+
# processing_config: {
|
377
|
+
# forwarding_config: { # required
|
378
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
379
|
+
# },
|
380
|
+
# },
|
355
381
|
# },
|
356
382
|
# transform: {
|
357
383
|
# expression: "Expression", # required
|
@@ -364,6 +390,12 @@ module Aws::IoTSiteWise
|
|
364
390
|
# },
|
365
391
|
# },
|
366
392
|
# ],
|
393
|
+
# processing_config: {
|
394
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
395
|
+
# forwarding_config: {
|
396
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
397
|
+
# },
|
398
|
+
# },
|
367
399
|
# },
|
368
400
|
# metric: {
|
369
401
|
# expression: "Expression", # required
|
@@ -381,6 +413,9 @@ module Aws::IoTSiteWise
|
|
381
413
|
# interval: "Interval", # required
|
382
414
|
# },
|
383
415
|
# },
|
416
|
+
# processing_config: {
|
417
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
418
|
+
# },
|
384
419
|
# },
|
385
420
|
# },
|
386
421
|
# },
|
@@ -502,6 +537,11 @@ module Aws::IoTSiteWise
|
|
502
537
|
# default_value: "DefaultValue",
|
503
538
|
# },
|
504
539
|
# measurement: {
|
540
|
+
# processing_config: {
|
541
|
+
# forwarding_config: { # required
|
542
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
543
|
+
# },
|
544
|
+
# },
|
505
545
|
# },
|
506
546
|
# transform: {
|
507
547
|
# expression: "Expression", # required
|
@@ -514,6 +554,12 @@ module Aws::IoTSiteWise
|
|
514
554
|
# },
|
515
555
|
# },
|
516
556
|
# ],
|
557
|
+
# processing_config: {
|
558
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
559
|
+
# forwarding_config: {
|
560
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
561
|
+
# },
|
562
|
+
# },
|
517
563
|
# },
|
518
564
|
# metric: {
|
519
565
|
# expression: "Expression", # required
|
@@ -531,6 +577,9 @@ module Aws::IoTSiteWise
|
|
531
577
|
# interval: "Interval", # required
|
532
578
|
# },
|
533
579
|
# },
|
580
|
+
# processing_config: {
|
581
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
582
|
+
# },
|
534
583
|
# },
|
535
584
|
# },
|
536
585
|
# }
|
@@ -587,6 +636,11 @@ module Aws::IoTSiteWise
|
|
587
636
|
# default_value: "DefaultValue",
|
588
637
|
# },
|
589
638
|
# measurement: {
|
639
|
+
# processing_config: {
|
640
|
+
# forwarding_config: { # required
|
641
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
642
|
+
# },
|
643
|
+
# },
|
590
644
|
# },
|
591
645
|
# transform: {
|
592
646
|
# expression: "Expression", # required
|
@@ -599,6 +653,12 @@ module Aws::IoTSiteWise
|
|
599
653
|
# },
|
600
654
|
# },
|
601
655
|
# ],
|
656
|
+
# processing_config: {
|
657
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
658
|
+
# forwarding_config: {
|
659
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
660
|
+
# },
|
661
|
+
# },
|
602
662
|
# },
|
603
663
|
# metric: {
|
604
664
|
# expression: "Expression", # required
|
@@ -616,6 +676,9 @@ module Aws::IoTSiteWise
|
|
616
676
|
# interval: "Interval", # required
|
617
677
|
# },
|
618
678
|
# },
|
679
|
+
# processing_config: {
|
680
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
681
|
+
# },
|
619
682
|
# },
|
620
683
|
# },
|
621
684
|
# }
|
@@ -660,8 +723,8 @@ module Aws::IoTSiteWise
|
|
660
723
|
end
|
661
724
|
|
662
725
|
# Contains current status information for an asset model. For more
|
663
|
-
# information, see [Asset and model states][1] in the *
|
664
|
-
#
|
726
|
+
# information, see [Asset and model states][1] in the *IoT SiteWise User
|
727
|
+
# Guide*.
|
665
728
|
#
|
666
729
|
#
|
667
730
|
#
|
@@ -685,7 +748,7 @@ module Aws::IoTSiteWise
|
|
685
748
|
# Contains a summary of an asset model.
|
686
749
|
#
|
687
750
|
# @!attribute [rw] id
|
688
|
-
# The ID of the asset model (used with
|
751
|
+
# The ID of the asset model (used with IoT SiteWise APIs).
|
689
752
|
# @return [String]
|
690
753
|
#
|
691
754
|
# @!attribute [rw] arn
|
@@ -741,11 +804,11 @@ module Aws::IoTSiteWise
|
|
741
804
|
# @return [String]
|
742
805
|
#
|
743
806
|
# @!attribute [rw] alias
|
744
|
-
# The
|
745
|
-
#
|
807
|
+
# The alias that identifies the property, such as an OPC-UA server
|
808
|
+
# data stream path (for example,
|
746
809
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
747
810
|
# see [Mapping industrial data streams to asset properties][1] in the
|
748
|
-
# *
|
811
|
+
# *IoT SiteWise User Guide*.
|
749
812
|
#
|
750
813
|
#
|
751
814
|
#
|
@@ -852,8 +915,8 @@ module Aws::IoTSiteWise
|
|
852
915
|
end
|
853
916
|
|
854
917
|
# Contains information about the current status of an asset. For more
|
855
|
-
# information, see [Asset and model states][1] in the *
|
856
|
-
#
|
918
|
+
# information, see [Asset and model states][1] in the *IoT SiteWise User
|
919
|
+
# Guide*.
|
857
920
|
#
|
858
921
|
#
|
859
922
|
#
|
@@ -946,7 +1009,7 @@ module Aws::IoTSiteWise
|
|
946
1009
|
# The ID of a hierarchy in the parent asset's model. Hierarchies
|
947
1010
|
# allow different groupings of assets to be formed that all come from
|
948
1011
|
# the same asset model. For more information, see [Asset
|
949
|
-
# hierarchies][1] in the *
|
1012
|
+
# hierarchies][1] in the *IoT SiteWise User Guide*.
|
950
1013
|
#
|
951
1014
|
#
|
952
1015
|
#
|
@@ -1030,7 +1093,7 @@ module Aws::IoTSiteWise
|
|
1030
1093
|
end
|
1031
1094
|
|
1032
1095
|
# Contains an asset attribute property. For more information, see
|
1033
|
-
# [Attributes][1] in the *
|
1096
|
+
# [Attributes][1] in the *IoT SiteWise User Guide*.
|
1034
1097
|
#
|
1035
1098
|
#
|
1036
1099
|
#
|
@@ -1047,7 +1110,7 @@ module Aws::IoTSiteWise
|
|
1047
1110
|
# The default value of the asset model property attribute. All assets
|
1048
1111
|
# that you create from the asset model contain this attribute value.
|
1049
1112
|
# You can update an attribute's value after you create an asset. For
|
1050
|
-
# more information, see [Updating attribute values][1] in the *
|
1113
|
+
# more information, see [Updating attribute values][1] in the *IoT
|
1051
1114
|
# SiteWise User Guide*.
|
1052
1115
|
#
|
1053
1116
|
#
|
@@ -1267,7 +1330,7 @@ module Aws::IoTSiteWise
|
|
1267
1330
|
include Aws::Structure
|
1268
1331
|
end
|
1269
1332
|
|
1270
|
-
# Contains the details of an
|
1333
|
+
# Contains the details of an IoT SiteWise configuration error.
|
1271
1334
|
#
|
1272
1335
|
# @!attribute [rw] code
|
1273
1336
|
# The error code.
|
@@ -1358,12 +1421,12 @@ module Aws::IoTSiteWise
|
|
1358
1421
|
# }
|
1359
1422
|
#
|
1360
1423
|
# @!attribute [rw] access_policy_identity
|
1361
|
-
# The identity for this access policy. Choose an
|
1362
|
-
# SSO group, or an IAM user.
|
1424
|
+
# The identity for this access policy. Choose an Amazon Web Services
|
1425
|
+
# SSO user, an Amazon Web Services SSO group, or an IAM user.
|
1363
1426
|
# @return [Types::Identity]
|
1364
1427
|
#
|
1365
1428
|
# @!attribute [rw] access_policy_resource
|
1366
|
-
# The
|
1429
|
+
# The IoT SiteWise Monitor resource for this access policy. Choose
|
1367
1430
|
# either a portal or a project.
|
1368
1431
|
# @return [Types::Resource]
|
1369
1432
|
#
|
@@ -1383,8 +1446,8 @@ module Aws::IoTSiteWise
|
|
1383
1446
|
#
|
1384
1447
|
# @!attribute [rw] tags
|
1385
1448
|
# A list of key-value pairs that contain metadata for the access
|
1386
|
-
# policy. For more information, see [Tagging your
|
1387
|
-
# resources][1] in the *
|
1449
|
+
# policy. For more information, see [Tagging your IoT SiteWise
|
1450
|
+
# resources][1] in the *IoT SiteWise User Guide*.
|
1388
1451
|
#
|
1389
1452
|
#
|
1390
1453
|
#
|
@@ -1439,6 +1502,11 @@ module Aws::IoTSiteWise
|
|
1439
1502
|
# default_value: "DefaultValue",
|
1440
1503
|
# },
|
1441
1504
|
# measurement: {
|
1505
|
+
# processing_config: {
|
1506
|
+
# forwarding_config: { # required
|
1507
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
1508
|
+
# },
|
1509
|
+
# },
|
1442
1510
|
# },
|
1443
1511
|
# transform: {
|
1444
1512
|
# expression: "Expression", # required
|
@@ -1451,6 +1519,12 @@ module Aws::IoTSiteWise
|
|
1451
1519
|
# },
|
1452
1520
|
# },
|
1453
1521
|
# ],
|
1522
|
+
# processing_config: {
|
1523
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
1524
|
+
# forwarding_config: {
|
1525
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
1526
|
+
# },
|
1527
|
+
# },
|
1454
1528
|
# },
|
1455
1529
|
# metric: {
|
1456
1530
|
# expression: "Expression", # required
|
@@ -1468,6 +1542,9 @@ module Aws::IoTSiteWise
|
|
1468
1542
|
# interval: "Interval", # required
|
1469
1543
|
# },
|
1470
1544
|
# },
|
1545
|
+
# processing_config: {
|
1546
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
1547
|
+
# },
|
1471
1548
|
# },
|
1472
1549
|
# },
|
1473
1550
|
# },
|
@@ -1494,6 +1571,11 @@ module Aws::IoTSiteWise
|
|
1494
1571
|
# default_value: "DefaultValue",
|
1495
1572
|
# },
|
1496
1573
|
# measurement: {
|
1574
|
+
# processing_config: {
|
1575
|
+
# forwarding_config: { # required
|
1576
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
1577
|
+
# },
|
1578
|
+
# },
|
1497
1579
|
# },
|
1498
1580
|
# transform: {
|
1499
1581
|
# expression: "Expression", # required
|
@@ -1506,6 +1588,12 @@ module Aws::IoTSiteWise
|
|
1506
1588
|
# },
|
1507
1589
|
# },
|
1508
1590
|
# ],
|
1591
|
+
# processing_config: {
|
1592
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
1593
|
+
# forwarding_config: {
|
1594
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
1595
|
+
# },
|
1596
|
+
# },
|
1509
1597
|
# },
|
1510
1598
|
# metric: {
|
1511
1599
|
# expression: "Expression", # required
|
@@ -1523,6 +1611,9 @@ module Aws::IoTSiteWise
|
|
1523
1611
|
# interval: "Interval", # required
|
1524
1612
|
# },
|
1525
1613
|
# },
|
1614
|
+
# processing_config: {
|
1615
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
1616
|
+
# },
|
1526
1617
|
# },
|
1527
1618
|
# },
|
1528
1619
|
# },
|
@@ -1545,10 +1636,10 @@ module Aws::IoTSiteWise
|
|
1545
1636
|
#
|
1546
1637
|
# @!attribute [rw] asset_model_properties
|
1547
1638
|
# The property definitions of the asset model. For more information,
|
1548
|
-
# see [Asset properties][1] in the *
|
1639
|
+
# see [Asset properties][1] in the *IoT SiteWise User Guide*.
|
1549
1640
|
#
|
1550
1641
|
# You can specify up to 200 properties per asset model. For more
|
1551
|
-
# information, see [Quotas][2] in the *
|
1642
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
1552
1643
|
#
|
1553
1644
|
#
|
1554
1645
|
#
|
@@ -1560,10 +1651,10 @@ module Aws::IoTSiteWise
|
|
1560
1651
|
# The hierarchy definitions of the asset model. Each hierarchy
|
1561
1652
|
# specifies an asset model whose assets can be children of any other
|
1562
1653
|
# assets created from this asset model. For more information, see
|
1563
|
-
# [Asset hierarchies][1] in the *
|
1654
|
+
# [Asset hierarchies][1] in the *IoT SiteWise User Guide*.
|
1564
1655
|
#
|
1565
1656
|
# You can specify up to 10 hierarchies per asset model. For more
|
1566
|
-
# information, see [Quotas][2] in the *
|
1657
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
1567
1658
|
#
|
1568
1659
|
#
|
1569
1660
|
#
|
@@ -1590,8 +1681,8 @@ module Aws::IoTSiteWise
|
|
1590
1681
|
#
|
1591
1682
|
# @!attribute [rw] tags
|
1592
1683
|
# A list of key-value pairs that contain metadata for the asset model.
|
1593
|
-
# For more information, see [Tagging your
|
1594
|
-
#
|
1684
|
+
# For more information, see [Tagging your IoT SiteWise resources][1]
|
1685
|
+
# in the *IoT SiteWise User Guide*.
|
1595
1686
|
#
|
1596
1687
|
#
|
1597
1688
|
#
|
@@ -1612,7 +1703,7 @@ module Aws::IoTSiteWise
|
|
1612
1703
|
|
1613
1704
|
# @!attribute [rw] asset_model_id
|
1614
1705
|
# The ID of the asset model. You can use this ID when you call other
|
1615
|
-
#
|
1706
|
+
# IoT SiteWise APIs.
|
1616
1707
|
# @return [String]
|
1617
1708
|
#
|
1618
1709
|
# @!attribute [rw] asset_model_arn
|
@@ -1669,8 +1760,8 @@ module Aws::IoTSiteWise
|
|
1669
1760
|
#
|
1670
1761
|
# @!attribute [rw] tags
|
1671
1762
|
# A list of key-value pairs that contain metadata for the asset. For
|
1672
|
-
# more information, see [Tagging your
|
1673
|
-
#
|
1763
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in
|
1764
|
+
# the *IoT SiteWise User Guide*.
|
1674
1765
|
#
|
1675
1766
|
#
|
1676
1767
|
#
|
@@ -1688,7 +1779,7 @@ module Aws::IoTSiteWise
|
|
1688
1779
|
|
1689
1780
|
# @!attribute [rw] asset_id
|
1690
1781
|
# The ID of the asset. This ID uniquely identifies the asset within
|
1691
|
-
#
|
1782
|
+
# IoT SiteWise and can be used with other IoT SiteWise APIs.
|
1692
1783
|
# @return [String]
|
1693
1784
|
#
|
1694
1785
|
# @!attribute [rw] asset_arn
|
@@ -1742,8 +1833,8 @@ module Aws::IoTSiteWise
|
|
1742
1833
|
#
|
1743
1834
|
# @!attribute [rw] dashboard_definition
|
1744
1835
|
# The dashboard definition specified in a JSON literal. For detailed
|
1745
|
-
# information, see [Creating dashboards (CLI)][1] in the *
|
1746
|
-
#
|
1836
|
+
# information, see [Creating dashboards (CLI)][1] in the *IoT SiteWise
|
1837
|
+
# User Guide*.
|
1747
1838
|
#
|
1748
1839
|
#
|
1749
1840
|
#
|
@@ -1761,8 +1852,8 @@ module Aws::IoTSiteWise
|
|
1761
1852
|
#
|
1762
1853
|
# @!attribute [rw] tags
|
1763
1854
|
# A list of key-value pairs that contain metadata for the dashboard.
|
1764
|
-
# For more information, see [Tagging your
|
1765
|
-
#
|
1855
|
+
# For more information, see [Tagging your IoT SiteWise resources][1]
|
1856
|
+
# in the *IoT SiteWise User Guide*.
|
1766
1857
|
#
|
1767
1858
|
#
|
1768
1859
|
#
|
@@ -1807,9 +1898,12 @@ module Aws::IoTSiteWise
|
|
1807
1898
|
# {
|
1808
1899
|
# gateway_name: "Name", # required
|
1809
1900
|
# gateway_platform: { # required
|
1810
|
-
# greengrass: {
|
1901
|
+
# greengrass: {
|
1811
1902
|
# group_arn: "ARN", # required
|
1812
1903
|
# },
|
1904
|
+
# greengrass_v2: {
|
1905
|
+
# core_device_thing_name: "CoreDeviceThingName", # required
|
1906
|
+
# },
|
1813
1907
|
# },
|
1814
1908
|
# tags: {
|
1815
1909
|
# "TagKey" => "TagValue",
|
@@ -1827,8 +1921,8 @@ module Aws::IoTSiteWise
|
|
1827
1921
|
#
|
1828
1922
|
# @!attribute [rw] tags
|
1829
1923
|
# A list of key-value pairs that contain metadata for the gateway. For
|
1830
|
-
# more information, see [Tagging your
|
1831
|
-
#
|
1924
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in
|
1925
|
+
# the *IoT SiteWise User Guide*.
|
1832
1926
|
#
|
1833
1927
|
#
|
1834
1928
|
#
|
@@ -1845,7 +1939,7 @@ module Aws::IoTSiteWise
|
|
1845
1939
|
|
1846
1940
|
# @!attribute [rw] gateway_id
|
1847
1941
|
# The ID of the gateway device. You can use this ID when you call
|
1848
|
-
# other
|
1942
|
+
# other IoT SiteWise APIs.
|
1849
1943
|
# @return [String]
|
1850
1944
|
#
|
1851
1945
|
# @!attribute [rw] gateway_arn
|
@@ -1898,7 +1992,7 @@ module Aws::IoTSiteWise
|
|
1898
1992
|
# @return [String]
|
1899
1993
|
#
|
1900
1994
|
# @!attribute [rw] portal_contact_email
|
1901
|
-
# The
|
1995
|
+
# The Amazon Web Services administrator's contact email address.
|
1902
1996
|
# @return [String]
|
1903
1997
|
#
|
1904
1998
|
# @!attribute [rw] client_token
|
@@ -1917,9 +2011,9 @@ module Aws::IoTSiteWise
|
|
1917
2011
|
#
|
1918
2012
|
# @!attribute [rw] role_arn
|
1919
2013
|
# The [ARN][1] of a service role that allows the portal's users to
|
1920
|
-
# access your
|
1921
|
-
# information, see [Using service roles for
|
1922
|
-
#
|
2014
|
+
# access your IoT SiteWise resources on your behalf. For more
|
2015
|
+
# information, see [Using service roles for IoT SiteWise Monitor][2]
|
2016
|
+
# in the *IoT SiteWise User Guide*.
|
1923
2017
|
#
|
1924
2018
|
#
|
1925
2019
|
#
|
@@ -1929,8 +2023,8 @@ module Aws::IoTSiteWise
|
|
1929
2023
|
#
|
1930
2024
|
# @!attribute [rw] tags
|
1931
2025
|
# A list of key-value pairs that contain metadata for the portal. For
|
1932
|
-
# more information, see [Tagging your
|
1933
|
-
#
|
2026
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in
|
2027
|
+
# the *IoT SiteWise User Guide*.
|
1934
2028
|
#
|
1935
2029
|
#
|
1936
2030
|
#
|
@@ -1941,15 +2035,16 @@ module Aws::IoTSiteWise
|
|
1941
2035
|
# The service to use to authenticate users to the portal. Choose from
|
1942
2036
|
# the following options:
|
1943
2037
|
#
|
1944
|
-
# * `SSO` – The portal uses
|
1945
|
-
# and manage user permissions. Before you can
|
1946
|
-
# uses
|
1947
|
-
#
|
1948
|
-
#
|
1949
|
-
# Regions
|
2038
|
+
# * `SSO` – The portal uses Amazon Web Services Single Sign On to
|
2039
|
+
# authenticate users and manage user permissions. Before you can
|
2040
|
+
# create a portal that uses Amazon Web Services SSO, you must enable
|
2041
|
+
# Amazon Web Services SSO. For more information, see [Enabling
|
2042
|
+
# Amazon Web Services SSO][1] in the *IoT SiteWise User Guide*. This
|
2043
|
+
# option is only available in Amazon Web Services Regions other than
|
2044
|
+
# the China Regions.
|
1950
2045
|
#
|
1951
|
-
# * `IAM` – The portal uses
|
1952
|
-
#
|
2046
|
+
# * `IAM` – The portal uses Identity and Access Management to
|
2047
|
+
# authenticate users and manage user permissions. This option is
|
1953
2048
|
# only available in the China Regions.
|
1954
2049
|
#
|
1955
2050
|
# You can't change this value after you create a portal.
|
@@ -1964,20 +2059,26 @@ module Aws::IoTSiteWise
|
|
1964
2059
|
# @!attribute [rw] notification_sender_email
|
1965
2060
|
# The email address that sends alarm notifications.
|
1966
2061
|
#
|
1967
|
-
# If you use the
|
2062
|
+
# If you use the [IoT Events managed Lambda function][1] to manage
|
1968
2063
|
# your emails, you must [verify the sender email address in Amazon
|
1969
|
-
# SES][
|
2064
|
+
# SES][2].
|
1970
2065
|
#
|
1971
2066
|
#
|
1972
2067
|
#
|
1973
|
-
# [1]: https://docs.aws.amazon.com/
|
2068
|
+
# [1]: https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html
|
2069
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html
|
1974
2070
|
# @return [String]
|
1975
2071
|
#
|
1976
2072
|
# @!attribute [rw] alarms
|
1977
|
-
# Contains the configuration information of an alarm created in an
|
1978
|
-
#
|
1979
|
-
#
|
1980
|
-
#
|
2073
|
+
# Contains the configuration information of an alarm created in an IoT
|
2074
|
+
# SiteWise Monitor portal. You can use the alarm to monitor an asset
|
2075
|
+
# property and get notified when the asset property value is outside a
|
2076
|
+
# specified range. For more information, see [Monitoring with
|
2077
|
+
# alarms][1] in the *IoT SiteWise Application Guide*.
|
2078
|
+
#
|
2079
|
+
#
|
2080
|
+
#
|
2081
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
|
1981
2082
|
# @return [Types::Alarms]
|
1982
2083
|
#
|
1983
2084
|
class CreatePortalRequest < Struct.new(
|
@@ -2010,9 +2111,9 @@ module Aws::IoTSiteWise
|
|
2010
2111
|
# @return [String]
|
2011
2112
|
#
|
2012
2113
|
# @!attribute [rw] portal_start_url
|
2013
|
-
# The URL for the
|
2014
|
-
#
|
2015
|
-
# portals that use IAM for authentication, you must use the
|
2114
|
+
# The URL for the IoT SiteWise Monitor portal. You can use this URL to
|
2115
|
+
# access portals that use Amazon Web Services SSO for authentication.
|
2116
|
+
# For portals that use IAM for authentication, you must use the IoT
|
2016
2117
|
# SiteWise console to get a URL that you can use to access the portal.
|
2017
2118
|
# @return [String]
|
2018
2119
|
#
|
@@ -2022,7 +2123,8 @@ module Aws::IoTSiteWise
|
|
2022
2123
|
# @return [Types::PortalStatus]
|
2023
2124
|
#
|
2024
2125
|
# @!attribute [rw] sso_application_id
|
2025
|
-
# The associated
|
2126
|
+
# The associated Amazon Web Services SSO application ID, if the portal
|
2127
|
+
# uses Amazon Web Services SSO.
|
2026
2128
|
# @return [String]
|
2027
2129
|
#
|
2028
2130
|
class CreatePortalResponse < Struct.new(
|
@@ -2071,8 +2173,8 @@ module Aws::IoTSiteWise
|
|
2071
2173
|
#
|
2072
2174
|
# @!attribute [rw] tags
|
2073
2175
|
# A list of key-value pairs that contain metadata for the project. For
|
2074
|
-
# more information, see [Tagging your
|
2075
|
-
#
|
2176
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in
|
2177
|
+
# the *IoT SiteWise User Guide*.
|
2076
2178
|
#
|
2077
2179
|
#
|
2078
2180
|
#
|
@@ -2110,6 +2212,43 @@ module Aws::IoTSiteWise
|
|
2110
2212
|
include Aws::Structure
|
2111
2213
|
end
|
2112
2214
|
|
2215
|
+
# Contains information about a customer managed Amazon S3 bucket.
|
2216
|
+
#
|
2217
|
+
# @note When making an API call, you may pass CustomerManagedS3Storage
|
2218
|
+
# data as a hash:
|
2219
|
+
#
|
2220
|
+
# {
|
2221
|
+
# s3_resource_arn: "ARN", # required
|
2222
|
+
# role_arn: "ARN", # required
|
2223
|
+
# }
|
2224
|
+
#
|
2225
|
+
# @!attribute [rw] s3_resource_arn
|
2226
|
+
# The [ARN][1] of the Amazon S3 object. For more information about how
|
2227
|
+
# to find the ARN for an Amazon S3 object, see [Amazon S3
|
2228
|
+
# resources][2] in the *Amazon Simple Storage Service User Guide*.
|
2229
|
+
#
|
2230
|
+
#
|
2231
|
+
#
|
2232
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
2233
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-arn-format.html
|
2234
|
+
# @return [String]
|
2235
|
+
#
|
2236
|
+
# @!attribute [rw] role_arn
|
2237
|
+
# The [ARN][1] of the Identity and Access Management role that allows
|
2238
|
+
# IoT SiteWise to send data to Amazon S3.
|
2239
|
+
#
|
2240
|
+
#
|
2241
|
+
#
|
2242
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
2243
|
+
# @return [String]
|
2244
|
+
#
|
2245
|
+
class CustomerManagedS3Storage < Struct.new(
|
2246
|
+
:s3_resource_arn,
|
2247
|
+
:role_arn)
|
2248
|
+
SENSITIVE = []
|
2249
|
+
include Aws::Structure
|
2250
|
+
end
|
2251
|
+
|
2113
2252
|
# Contains a dashboard summary.
|
2114
2253
|
#
|
2115
2254
|
# @!attribute [rw] id
|
@@ -2398,13 +2537,13 @@ module Aws::IoTSiteWise
|
|
2398
2537
|
# @return [String]
|
2399
2538
|
#
|
2400
2539
|
# @!attribute [rw] access_policy_identity
|
2401
|
-
# The identity (
|
2402
|
-
# this access policy applies.
|
2540
|
+
# The identity (Amazon Web Services SSO user, Amazon Web Services SSO
|
2541
|
+
# group, or IAM user) to which this access policy applies.
|
2403
2542
|
# @return [Types::Identity]
|
2404
2543
|
#
|
2405
2544
|
# @!attribute [rw] access_policy_resource
|
2406
|
-
# The
|
2407
|
-
#
|
2545
|
+
# The IoT SiteWise Monitor resource (portal or project) to which this
|
2546
|
+
# access policy provides access.
|
2408
2547
|
# @return [Types::Resource]
|
2409
2548
|
#
|
2410
2549
|
# @!attribute [rw] access_policy_permission
|
@@ -2705,8 +2844,7 @@ module Aws::IoTSiteWise
|
|
2705
2844
|
#
|
2706
2845
|
# @!attribute [rw] dashboard_definition
|
2707
2846
|
# The dashboard's definition JSON literal. For detailed information,
|
2708
|
-
# see [Creating dashboards (CLI)][1] in the *
|
2709
|
-
# Guide*.
|
2847
|
+
# see [Creating dashboards (CLI)][1] in the *IoT SiteWise User Guide*.
|
2710
2848
|
#
|
2711
2849
|
#
|
2712
2850
|
#
|
@@ -2744,7 +2882,7 @@ module Aws::IoTSiteWise
|
|
2744
2882
|
#
|
2745
2883
|
# @!attribute [rw] kms_key_arn
|
2746
2884
|
# The key ARN of the customer managed customer master key (CMK) used
|
2747
|
-
# for
|
2885
|
+
# for KMS encryption if you use `KMS_BASED_ENCRYPTION`.
|
2748
2886
|
# @return [String]
|
2749
2887
|
#
|
2750
2888
|
# @!attribute [rw] configuration_status
|
@@ -2775,8 +2913,8 @@ module Aws::IoTSiteWise
|
|
2775
2913
|
#
|
2776
2914
|
# @!attribute [rw] capability_namespace
|
2777
2915
|
# The namespace of the capability configuration. For example, if you
|
2778
|
-
# configure OPC-UA sources from the
|
2779
|
-
#
|
2916
|
+
# configure OPC-UA sources from the IoT SiteWise console, your OPC-UA
|
2917
|
+
# capability configuration has the namespace
|
2780
2918
|
# `iotsitewise:opcuacollector:version`, where `version` is a number
|
2781
2919
|
# such as `1`.
|
2782
2920
|
# @return [String]
|
@@ -2799,7 +2937,7 @@ module Aws::IoTSiteWise
|
|
2799
2937
|
# @!attribute [rw] capability_configuration
|
2800
2938
|
# The JSON document that defines the gateway capability's
|
2801
2939
|
# configuration. For more information, see [Configuring data sources
|
2802
|
-
# (CLI)][1] in the *
|
2940
|
+
# (CLI)][1] in the *IoT SiteWise User Guide*.
|
2803
2941
|
#
|
2804
2942
|
#
|
2805
2943
|
#
|
@@ -2951,20 +3089,21 @@ module Aws::IoTSiteWise
|
|
2951
3089
|
# @return [String]
|
2952
3090
|
#
|
2953
3091
|
# @!attribute [rw] portal_client_id
|
2954
|
-
# The
|
2955
|
-
# APIs).
|
2956
|
-
# that use
|
3092
|
+
# The Amazon Web Services SSO application generated client ID (used
|
3093
|
+
# with Amazon Web Services SSO APIs). IoT SiteWise includes
|
3094
|
+
# `portalClientId` for only portals that use Amazon Web Services SSO
|
3095
|
+
# to authenticate users.
|
2957
3096
|
# @return [String]
|
2958
3097
|
#
|
2959
3098
|
# @!attribute [rw] portal_start_url
|
2960
|
-
# The URL for the
|
2961
|
-
#
|
2962
|
-
# portals that use IAM for authentication, you must use the
|
3099
|
+
# The URL for the IoT SiteWise Monitor portal. You can use this URL to
|
3100
|
+
# access portals that use Amazon Web Services SSO for authentication.
|
3101
|
+
# For portals that use IAM for authentication, you must use the IoT
|
2963
3102
|
# SiteWise console to get a URL that you can use to access the portal.
|
2964
3103
|
# @return [String]
|
2965
3104
|
#
|
2966
3105
|
# @!attribute [rw] portal_contact_email
|
2967
|
-
# The
|
3106
|
+
# The Amazon Web Services administrator's contact email address.
|
2968
3107
|
# @return [String]
|
2969
3108
|
#
|
2970
3109
|
# @!attribute [rw] portal_status
|
@@ -2986,9 +3125,9 @@ module Aws::IoTSiteWise
|
|
2986
3125
|
#
|
2987
3126
|
# @!attribute [rw] role_arn
|
2988
3127
|
# The [ARN][1] of the service role that allows the portal's users to
|
2989
|
-
# access your
|
2990
|
-
# information, see [Using service roles for
|
2991
|
-
#
|
3128
|
+
# access your IoT SiteWise resources on your behalf. For more
|
3129
|
+
# information, see [Using service roles for IoT SiteWise Monitor][2]
|
3130
|
+
# in the *IoT SiteWise User Guide*.
|
2992
3131
|
#
|
2993
3132
|
#
|
2994
3133
|
#
|
@@ -3005,8 +3144,8 @@ module Aws::IoTSiteWise
|
|
3005
3144
|
# @return [String]
|
3006
3145
|
#
|
3007
3146
|
# @!attribute [rw] alarms
|
3008
|
-
# Contains the configuration information of an alarm created in
|
3009
|
-
#
|
3147
|
+
# Contains the configuration information of an alarm created in an IoT
|
3148
|
+
# SiteWise Monitor portal.
|
3010
3149
|
# @return [Types::Alarms]
|
3011
3150
|
#
|
3012
3151
|
class DescribePortalResponse < Struct.new(
|
@@ -3092,6 +3231,61 @@ module Aws::IoTSiteWise
|
|
3092
3231
|
include Aws::Structure
|
3093
3232
|
end
|
3094
3233
|
|
3234
|
+
# @api private
|
3235
|
+
#
|
3236
|
+
class DescribeStorageConfigurationRequest < Aws::EmptyStructure; end
|
3237
|
+
|
3238
|
+
# @!attribute [rw] storage_type
|
3239
|
+
# The type of storage that you specified for your data. The storage
|
3240
|
+
# type can be one of the following values:
|
3241
|
+
#
|
3242
|
+
# * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise replicates your data
|
3243
|
+
# into a service managed database.
|
3244
|
+
#
|
3245
|
+
# * `MULTI_LAYER_STORAGE` – IoT SiteWise replicates your data into a
|
3246
|
+
# service managed database and saves a copy of your raw data and
|
3247
|
+
# metadata in an Amazon S3 object that you specified.
|
3248
|
+
# @return [String]
|
3249
|
+
#
|
3250
|
+
# @!attribute [rw] multi_layer_storage
|
3251
|
+
# Contains information about the storage destination.
|
3252
|
+
# @return [Types::MultiLayerStorage]
|
3253
|
+
#
|
3254
|
+
# @!attribute [rw] configuration_status
|
3255
|
+
# Contains current status information for the configuration.
|
3256
|
+
# @return [Types::ConfigurationStatus]
|
3257
|
+
#
|
3258
|
+
# @!attribute [rw] last_update_date
|
3259
|
+
# The date the storage configuration was last updated, in Unix epoch
|
3260
|
+
# time.
|
3261
|
+
# @return [Time]
|
3262
|
+
#
|
3263
|
+
class DescribeStorageConfigurationResponse < Struct.new(
|
3264
|
+
:storage_type,
|
3265
|
+
:multi_layer_storage,
|
3266
|
+
:configuration_status,
|
3267
|
+
:last_update_date)
|
3268
|
+
SENSITIVE = []
|
3269
|
+
include Aws::Structure
|
3270
|
+
end
|
3271
|
+
|
3272
|
+
# Contains detailed error information.
|
3273
|
+
#
|
3274
|
+
# @!attribute [rw] code
|
3275
|
+
# The error code.
|
3276
|
+
# @return [String]
|
3277
|
+
#
|
3278
|
+
# @!attribute [rw] message
|
3279
|
+
# The error message.
|
3280
|
+
# @return [String]
|
3281
|
+
#
|
3282
|
+
class DetailedError < Struct.new(
|
3283
|
+
:code,
|
3284
|
+
:message)
|
3285
|
+
SENSITIVE = []
|
3286
|
+
include Aws::Structure
|
3287
|
+
end
|
3288
|
+
|
3095
3289
|
# @note When making an API call, you may pass DisassociateAssetsRequest
|
3096
3290
|
# data as a hash:
|
3097
3291
|
#
|
@@ -3112,7 +3306,7 @@ module Aws::IoTSiteWise
|
|
3112
3306
|
# allow different groupings of assets to be formed that all come from
|
3113
3307
|
# the same asset model. You can use the hierarchy ID to identify the
|
3114
3308
|
# correct asset to disassociate. For more information, see [Asset
|
3115
|
-
# hierarchies][1] in the *
|
3309
|
+
# hierarchies][1] in the *IoT SiteWise User Guide*.
|
3116
3310
|
#
|
3117
3311
|
#
|
3118
3312
|
#
|
@@ -3141,7 +3335,7 @@ module Aws::IoTSiteWise
|
|
3141
3335
|
include Aws::Structure
|
3142
3336
|
end
|
3143
3337
|
|
3144
|
-
# Contains the details of an
|
3338
|
+
# Contains the details of an IoT SiteWise error.
|
3145
3339
|
#
|
3146
3340
|
# @!attribute [rw] code
|
3147
3341
|
# The error code.
|
@@ -3151,9 +3345,14 @@ module Aws::IoTSiteWise
|
|
3151
3345
|
# The error message.
|
3152
3346
|
# @return [String]
|
3153
3347
|
#
|
3348
|
+
# @!attribute [rw] details
|
3349
|
+
# A list of detailed errors.
|
3350
|
+
# @return [Array<Types::DetailedError>]
|
3351
|
+
#
|
3154
3352
|
class ErrorDetails < Struct.new(
|
3155
3353
|
:code,
|
3156
|
-
:message
|
3354
|
+
:message,
|
3355
|
+
:details)
|
3157
3356
|
SENSITIVE = []
|
3158
3357
|
include Aws::Structure
|
3159
3358
|
end
|
@@ -3187,12 +3386,31 @@ module Aws::IoTSiteWise
|
|
3187
3386
|
include Aws::Structure
|
3188
3387
|
end
|
3189
3388
|
|
3389
|
+
# The forwarding configuration for a given property.
|
3390
|
+
#
|
3391
|
+
# @note When making an API call, you may pass ForwardingConfig
|
3392
|
+
# data as a hash:
|
3393
|
+
#
|
3394
|
+
# {
|
3395
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
3396
|
+
# }
|
3397
|
+
#
|
3398
|
+
# @!attribute [rw] state
|
3399
|
+
# The forwarding state for the given property.
|
3400
|
+
# @return [String]
|
3401
|
+
#
|
3402
|
+
class ForwardingConfig < Struct.new(
|
3403
|
+
:state)
|
3404
|
+
SENSITIVE = []
|
3405
|
+
include Aws::Structure
|
3406
|
+
end
|
3407
|
+
|
3190
3408
|
# Contains a summary of a gateway capability configuration.
|
3191
3409
|
#
|
3192
3410
|
# @!attribute [rw] capability_namespace
|
3193
3411
|
# The namespace of the capability configuration. For example, if you
|
3194
|
-
# configure OPC-UA sources from the
|
3195
|
-
#
|
3412
|
+
# configure OPC-UA sources from the IoT SiteWise console, your OPC-UA
|
3413
|
+
# capability configuration has the namespace
|
3196
3414
|
# `iotsitewise:opcuacollector:version`, where `version` is a number
|
3197
3415
|
# such as `1`.
|
3198
3416
|
# @return [String]
|
@@ -3222,17 +3440,25 @@ module Aws::IoTSiteWise
|
|
3222
3440
|
# data as a hash:
|
3223
3441
|
#
|
3224
3442
|
# {
|
3225
|
-
# greengrass: {
|
3443
|
+
# greengrass: {
|
3226
3444
|
# group_arn: "ARN", # required
|
3227
3445
|
# },
|
3446
|
+
# greengrass_v2: {
|
3447
|
+
# core_device_thing_name: "CoreDeviceThingName", # required
|
3448
|
+
# },
|
3228
3449
|
# }
|
3229
3450
|
#
|
3230
3451
|
# @!attribute [rw] greengrass
|
3231
|
-
# A gateway that runs on
|
3452
|
+
# A gateway that runs on IoT Greengrass.
|
3232
3453
|
# @return [Types::Greengrass]
|
3233
3454
|
#
|
3455
|
+
# @!attribute [rw] greengrass_v2
|
3456
|
+
# A gateway that runs on IoT Greengrass V2.
|
3457
|
+
# @return [Types::GreengrassV2]
|
3458
|
+
#
|
3234
3459
|
class GatewayPlatform < Struct.new(
|
3235
|
-
:greengrass
|
3460
|
+
:greengrass,
|
3461
|
+
:greengrass_v2)
|
3236
3462
|
SENSITIVE = []
|
3237
3463
|
include Aws::Structure
|
3238
3464
|
end
|
@@ -3247,6 +3473,10 @@ module Aws::IoTSiteWise
|
|
3247
3473
|
# The name of the asset.
|
3248
3474
|
# @return [String]
|
3249
3475
|
#
|
3476
|
+
# @!attribute [rw] gateway_platform
|
3477
|
+
# Contains a gateway's platform information.
|
3478
|
+
# @return [Types::GatewayPlatform]
|
3479
|
+
#
|
3250
3480
|
# @!attribute [rw] gateway_capability_summaries
|
3251
3481
|
# A list of gateway capability summaries that each contain a namespace
|
3252
3482
|
# and status. Each gateway capability defines data sources for the
|
@@ -3269,6 +3499,7 @@ module Aws::IoTSiteWise
|
|
3269
3499
|
class GatewaySummary < Struct.new(
|
3270
3500
|
:gateway_id,
|
3271
3501
|
:gateway_name,
|
3502
|
+
:gateway_platform,
|
3272
3503
|
:gateway_capability_summaries,
|
3273
3504
|
:creation_date,
|
3274
3505
|
:last_update_date)
|
@@ -3302,11 +3533,11 @@ module Aws::IoTSiteWise
|
|
3302
3533
|
# @return [String]
|
3303
3534
|
#
|
3304
3535
|
# @!attribute [rw] property_alias
|
3305
|
-
# The
|
3306
|
-
#
|
3536
|
+
# The alias that identifies the property, such as an OPC-UA server
|
3537
|
+
# data stream path (for example,
|
3307
3538
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
3308
3539
|
# see [Mapping industrial data streams to asset properties][1] in the
|
3309
|
-
# *
|
3540
|
+
# *IoT SiteWise User Guide*.
|
3310
3541
|
#
|
3311
3542
|
#
|
3312
3543
|
#
|
@@ -3346,7 +3577,7 @@ module Aws::IoTSiteWise
|
|
3346
3577
|
# @return [String]
|
3347
3578
|
#
|
3348
3579
|
# @!attribute [rw] max_results
|
3349
|
-
# The maximum number of results to
|
3580
|
+
# The maximum number of results to return for each paginated request.
|
3350
3581
|
#
|
3351
3582
|
# Default: 100
|
3352
3583
|
# @return [Integer]
|
@@ -3407,11 +3638,11 @@ module Aws::IoTSiteWise
|
|
3407
3638
|
# @return [String]
|
3408
3639
|
#
|
3409
3640
|
# @!attribute [rw] property_alias
|
3410
|
-
# The
|
3411
|
-
#
|
3641
|
+
# The alias that identifies the property, such as an OPC-UA server
|
3642
|
+
# data stream path (for example,
|
3412
3643
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
3413
3644
|
# see [Mapping industrial data streams to asset properties][1] in the
|
3414
|
-
# *
|
3645
|
+
# *IoT SiteWise User Guide*.
|
3415
3646
|
#
|
3416
3647
|
#
|
3417
3648
|
#
|
@@ -3443,7 +3674,7 @@ module Aws::IoTSiteWise
|
|
3443
3674
|
# @return [String]
|
3444
3675
|
#
|
3445
3676
|
# @!attribute [rw] max_results
|
3446
|
-
# The maximum number of results to
|
3677
|
+
# The maximum number of results to return for each paginated request.
|
3447
3678
|
#
|
3448
3679
|
# Default: 100
|
3449
3680
|
# @return [Integer]
|
@@ -3496,11 +3727,11 @@ module Aws::IoTSiteWise
|
|
3496
3727
|
# @return [String]
|
3497
3728
|
#
|
3498
3729
|
# @!attribute [rw] property_alias
|
3499
|
-
# The
|
3500
|
-
#
|
3730
|
+
# The alias that identifies the property, such as an OPC-UA server
|
3731
|
+
# data stream path (for example,
|
3501
3732
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
3502
3733
|
# see [Mapping industrial data streams to asset properties][1] in the
|
3503
|
-
# *
|
3734
|
+
# *IoT SiteWise User Guide*.
|
3504
3735
|
#
|
3505
3736
|
#
|
3506
3737
|
#
|
@@ -3552,11 +3783,11 @@ module Aws::IoTSiteWise
|
|
3552
3783
|
# @return [String]
|
3553
3784
|
#
|
3554
3785
|
# @!attribute [rw] property_alias
|
3555
|
-
# The
|
3556
|
-
#
|
3786
|
+
# The alias that identifies the property, such as an OPC-UA server
|
3787
|
+
# data stream path (for example,
|
3557
3788
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
3558
3789
|
# see [Mapping industrial data streams to asset properties][1] in the
|
3559
|
-
# *
|
3790
|
+
# *IoT SiteWise User Guide*.
|
3560
3791
|
#
|
3561
3792
|
#
|
3562
3793
|
#
|
@@ -3597,7 +3828,7 @@ module Aws::IoTSiteWise
|
|
3597
3828
|
# @return [String]
|
3598
3829
|
#
|
3599
3830
|
# @!attribute [rw] max_results
|
3600
|
-
# The maximum number of results to
|
3831
|
+
# The maximum number of results to return for each paginated request.
|
3601
3832
|
# If not specified, the default value is 10.
|
3602
3833
|
# @return [Integer]
|
3603
3834
|
#
|
@@ -3640,12 +3871,12 @@ module Aws::IoTSiteWise
|
|
3640
3871
|
include Aws::Structure
|
3641
3872
|
end
|
3642
3873
|
|
3643
|
-
# Contains details for a gateway that runs on
|
3644
|
-
#
|
3645
|
-
#
|
3646
|
-
#
|
3647
|
-
#
|
3648
|
-
#
|
3874
|
+
# Contains details for a gateway that runs on IoT Greengrass. To create
|
3875
|
+
# a gateway that runs on IoT Greengrass, you must add the IoT SiteWise
|
3876
|
+
# connector to a Greengrass group and deploy it. Your Greengrass group
|
3877
|
+
# must also have permissions to upload data to IoT SiteWise. For more
|
3878
|
+
# information, see [Ingesting data using a gateway][1] in the *IoT
|
3879
|
+
# SiteWise User Guide*.
|
3649
3880
|
#
|
3650
3881
|
#
|
3651
3882
|
#
|
@@ -3661,7 +3892,7 @@ module Aws::IoTSiteWise
|
|
3661
3892
|
# @!attribute [rw] group_arn
|
3662
3893
|
# The [ARN][1] of the Greengrass group. For more information about how
|
3663
3894
|
# to find a group's ARN, see [ListGroups][2] and [GetGroup][3] in the
|
3664
|
-
# *
|
3895
|
+
# *IoT Greengrass API Reference*.
|
3665
3896
|
#
|
3666
3897
|
#
|
3667
3898
|
#
|
@@ -3676,6 +3907,35 @@ module Aws::IoTSiteWise
|
|
3676
3907
|
include Aws::Structure
|
3677
3908
|
end
|
3678
3909
|
|
3910
|
+
# Contains details for a gateway that runs on IoT Greengrass V2. To
|
3911
|
+
# create a gateway that runs on IoT Greengrass V2, you must deploy the
|
3912
|
+
# IoT SiteWise Edge component to your gateway device. Your [Greengrass
|
3913
|
+
# device role][1] must use the `AWSIoTSiteWiseEdgeAccess` policy. For
|
3914
|
+
# more information, see [Using IoT SiteWise at the edge][2] in the *IoT
|
3915
|
+
# SiteWise User Guide*.
|
3916
|
+
#
|
3917
|
+
#
|
3918
|
+
#
|
3919
|
+
# [1]: https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html
|
3920
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html
|
3921
|
+
#
|
3922
|
+
# @note When making an API call, you may pass GreengrassV2
|
3923
|
+
# data as a hash:
|
3924
|
+
#
|
3925
|
+
# {
|
3926
|
+
# core_device_thing_name: "CoreDeviceThingName", # required
|
3927
|
+
# }
|
3928
|
+
#
|
3929
|
+
# @!attribute [rw] core_device_thing_name
|
3930
|
+
# The name of the IoT thing for your IoT Greengrass V2 core device.
|
3931
|
+
# @return [String]
|
3932
|
+
#
|
3933
|
+
class GreengrassV2 < Struct.new(
|
3934
|
+
:core_device_thing_name)
|
3935
|
+
SENSITIVE = []
|
3936
|
+
include Aws::Structure
|
3937
|
+
end
|
3938
|
+
|
3679
3939
|
# Contains information for a group identity in an access policy.
|
3680
3940
|
#
|
3681
3941
|
# @note When making an API call, you may pass GroupIdentity
|
@@ -3686,7 +3946,7 @@ module Aws::IoTSiteWise
|
|
3686
3946
|
# }
|
3687
3947
|
#
|
3688
3948
|
# @!attribute [rw] id
|
3689
|
-
# The
|
3949
|
+
# The Amazon Web Services SSO ID of the group.
|
3690
3950
|
# @return [String]
|
3691
3951
|
#
|
3692
3952
|
class GroupIdentity < Struct.new(
|
@@ -3695,9 +3955,8 @@ module Aws::IoTSiteWise
|
|
3695
3955
|
include Aws::Structure
|
3696
3956
|
end
|
3697
3957
|
|
3698
|
-
# Contains information about an
|
3699
|
-
#
|
3700
|
-
# Guide*.
|
3958
|
+
# Contains information about an Identity and Access Management role. For
|
3959
|
+
# more information, see [IAM roles][1] in the *IAM User Guide*.
|
3701
3960
|
#
|
3702
3961
|
#
|
3703
3962
|
#
|
@@ -3725,8 +3984,7 @@ module Aws::IoTSiteWise
|
|
3725
3984
|
include Aws::Structure
|
3726
3985
|
end
|
3727
3986
|
|
3728
|
-
# Contains information about an
|
3729
|
-
# user.
|
3987
|
+
# Contains information about an Identity and Access Management user.
|
3730
3988
|
#
|
3731
3989
|
# @note When making an API call, you may pass IAMUserIdentity
|
3732
3990
|
# data as a hash:
|
@@ -3756,12 +4014,12 @@ module Aws::IoTSiteWise
|
|
3756
4014
|
include Aws::Structure
|
3757
4015
|
end
|
3758
4016
|
|
3759
|
-
# Contains an identity that can access an
|
3760
|
-
# resource.
|
4017
|
+
# Contains an identity that can access an IoT SiteWise Monitor resource.
|
3761
4018
|
#
|
3762
|
-
# <note markdown="1"> Currently, you can't use
|
3763
|
-
#
|
3764
|
-
# pages in the [
|
4019
|
+
# <note markdown="1"> Currently, you can't use Amazon Web Services APIs to retrieve Amazon
|
4020
|
+
# Web Services SSO identity IDs. You can find the Amazon Web Services
|
4021
|
+
# SSO identity IDs in the URL of user and group pages in the [Amazon Web
|
4022
|
+
# Services SSO console][1].
|
3765
4023
|
#
|
3766
4024
|
# </note>
|
3767
4025
|
#
|
@@ -3788,11 +4046,11 @@ module Aws::IoTSiteWise
|
|
3788
4046
|
# }
|
3789
4047
|
#
|
3790
4048
|
# @!attribute [rw] user
|
3791
|
-
# An
|
4049
|
+
# An Amazon Web Services SSO user identity.
|
3792
4050
|
# @return [Types::UserIdentity]
|
3793
4051
|
#
|
3794
4052
|
# @!attribute [rw] group
|
3795
|
-
# An
|
4053
|
+
# An Amazon Web Services SSO group identity.
|
3796
4054
|
# @return [Types::GroupIdentity]
|
3797
4055
|
#
|
3798
4056
|
# @!attribute [rw] iam_user
|
@@ -3872,8 +4130,8 @@ module Aws::IoTSiteWise
|
|
3872
4130
|
include Aws::Structure
|
3873
4131
|
end
|
3874
4132
|
|
3875
|
-
# Contains an image that is uploaded to
|
3876
|
-
#
|
4133
|
+
# Contains an image that is uploaded to IoT SiteWise and available at a
|
4134
|
+
# URL.
|
3877
4135
|
#
|
3878
4136
|
# @!attribute [rw] id
|
3879
4137
|
# The ID of the image.
|
@@ -3891,8 +4149,7 @@ module Aws::IoTSiteWise
|
|
3891
4149
|
include Aws::Structure
|
3892
4150
|
end
|
3893
4151
|
|
3894
|
-
#
|
3895
|
-
# later.
|
4152
|
+
# IoT SiteWise can't process your request right now. Try again later.
|
3896
4153
|
#
|
3897
4154
|
# @!attribute [rw] message
|
3898
4155
|
# @return [String]
|
@@ -3938,7 +4195,7 @@ module Aws::IoTSiteWise
|
|
3938
4195
|
# assets or attempting to create more than the allowed number of
|
3939
4196
|
# properties for an asset model.
|
3940
4197
|
#
|
3941
|
-
# For more information, see [Quotas][1] in the *
|
4198
|
+
# For more information, see [Quotas][1] in the *IoT SiteWise User
|
3942
4199
|
# Guide*.
|
3943
4200
|
#
|
3944
4201
|
#
|
@@ -3968,8 +4225,9 @@ module Aws::IoTSiteWise
|
|
3968
4225
|
# }
|
3969
4226
|
#
|
3970
4227
|
# @!attribute [rw] identity_type
|
3971
|
-
# The type of identity (
|
3972
|
-
# This parameter is required if you
|
4228
|
+
# The type of identity (Amazon Web Services SSO user, Amazon Web
|
4229
|
+
# Services SSO group, or IAM user). This parameter is required if you
|
4230
|
+
# specify `identityId`.
|
3973
4231
|
# @return [String]
|
3974
4232
|
#
|
3975
4233
|
# @!attribute [rw] identity_id
|
@@ -4002,7 +4260,7 @@ module Aws::IoTSiteWise
|
|
4002
4260
|
# @return [String]
|
4003
4261
|
#
|
4004
4262
|
# @!attribute [rw] max_results
|
4005
|
-
# The maximum number of results to
|
4263
|
+
# The maximum number of results to return for each paginated request.
|
4006
4264
|
#
|
4007
4265
|
# Default: 50
|
4008
4266
|
# @return [Integer]
|
@@ -4048,7 +4306,7 @@ module Aws::IoTSiteWise
|
|
4048
4306
|
# @return [String]
|
4049
4307
|
#
|
4050
4308
|
# @!attribute [rw] max_results
|
4051
|
-
# The maximum number of results to
|
4309
|
+
# The maximum number of results to return for each paginated request.
|
4052
4310
|
#
|
4053
4311
|
# Default: 50
|
4054
4312
|
# @return [Integer]
|
@@ -4107,7 +4365,7 @@ module Aws::IoTSiteWise
|
|
4107
4365
|
# @return [String]
|
4108
4366
|
#
|
4109
4367
|
# @!attribute [rw] max_results
|
4110
|
-
# The maximum number of results to
|
4368
|
+
# The maximum number of results to return for each paginated request.
|
4111
4369
|
# @return [Integer]
|
4112
4370
|
#
|
4113
4371
|
class ListAssetRelationshipsRequest < Struct.new(
|
@@ -4150,7 +4408,7 @@ module Aws::IoTSiteWise
|
|
4150
4408
|
# @return [String]
|
4151
4409
|
#
|
4152
4410
|
# @!attribute [rw] max_results
|
4153
|
-
# The maximum number of results to
|
4411
|
+
# The maximum number of results to return for each paginated request.
|
4154
4412
|
#
|
4155
4413
|
# Default: 50
|
4156
4414
|
# @return [Integer]
|
@@ -4219,7 +4477,7 @@ module Aws::IoTSiteWise
|
|
4219
4477
|
# [DescribeAssetModel][2] operations. This parameter is required if
|
4220
4478
|
# you choose `CHILD` for `traversalDirection`.
|
4221
4479
|
#
|
4222
|
-
# For more information, see [Asset hierarchies][3] in the *
|
4480
|
+
# For more information, see [Asset hierarchies][3] in the *IoT
|
4223
4481
|
# SiteWise User Guide*.
|
4224
4482
|
#
|
4225
4483
|
#
|
@@ -4247,7 +4505,7 @@ module Aws::IoTSiteWise
|
|
4247
4505
|
# @return [String]
|
4248
4506
|
#
|
4249
4507
|
# @!attribute [rw] max_results
|
4250
|
-
# The maximum number of results to
|
4508
|
+
# The maximum number of results to return for each paginated request.
|
4251
4509
|
#
|
4252
4510
|
# Default: 50
|
4253
4511
|
# @return [Integer]
|
@@ -4296,7 +4554,7 @@ module Aws::IoTSiteWise
|
|
4296
4554
|
# @return [String]
|
4297
4555
|
#
|
4298
4556
|
# @!attribute [rw] max_results
|
4299
|
-
# The maximum number of results to
|
4557
|
+
# The maximum number of results to return for each paginated request.
|
4300
4558
|
#
|
4301
4559
|
# Default: 50
|
4302
4560
|
# @return [Integer]
|
@@ -4338,7 +4596,7 @@ module Aws::IoTSiteWise
|
|
4338
4596
|
# @return [String]
|
4339
4597
|
#
|
4340
4598
|
# @!attribute [rw] max_results
|
4341
|
-
# The maximum number of results to
|
4599
|
+
# The maximum number of results to return for each paginated request.
|
4342
4600
|
#
|
4343
4601
|
# Default: 50
|
4344
4602
|
# @return [Integer]
|
@@ -4379,7 +4637,7 @@ module Aws::IoTSiteWise
|
|
4379
4637
|
# @return [String]
|
4380
4638
|
#
|
4381
4639
|
# @!attribute [rw] max_results
|
4382
|
-
# The maximum number of results to
|
4640
|
+
# The maximum number of results to return for each paginated request.
|
4383
4641
|
#
|
4384
4642
|
# Default: 50
|
4385
4643
|
# @return [Integer]
|
@@ -4425,7 +4683,7 @@ module Aws::IoTSiteWise
|
|
4425
4683
|
# @return [String]
|
4426
4684
|
#
|
4427
4685
|
# @!attribute [rw] max_results
|
4428
|
-
# The maximum number of results to
|
4686
|
+
# The maximum number of results to return for each paginated request.
|
4429
4687
|
#
|
4430
4688
|
# Default: 50
|
4431
4689
|
# @return [Integer]
|
@@ -4473,7 +4731,7 @@ module Aws::IoTSiteWise
|
|
4473
4731
|
# @return [String]
|
4474
4732
|
#
|
4475
4733
|
# @!attribute [rw] max_results
|
4476
|
-
# The maximum number of results to
|
4734
|
+
# The maximum number of results to return for each paginated request.
|
4477
4735
|
#
|
4478
4736
|
# Default: 50
|
4479
4737
|
# @return [Integer]
|
@@ -4525,8 +4783,8 @@ module Aws::IoTSiteWise
|
|
4525
4783
|
|
4526
4784
|
# @!attribute [rw] tags
|
4527
4785
|
# The list of key-value pairs that contain metadata for the resource.
|
4528
|
-
# For more information, see [Tagging your
|
4529
|
-
#
|
4786
|
+
# For more information, see [Tagging your IoT SiteWise resources][1]
|
4787
|
+
# in the *IoT SiteWise User Guide*.
|
4530
4788
|
#
|
4531
4789
|
#
|
4532
4790
|
#
|
@@ -4549,7 +4807,7 @@ module Aws::IoTSiteWise
|
|
4549
4807
|
# }
|
4550
4808
|
#
|
4551
4809
|
# @!attribute [rw] level
|
4552
|
-
# The
|
4810
|
+
# The IoT SiteWise logging verbosity level.
|
4553
4811
|
# @return [String]
|
4554
4812
|
#
|
4555
4813
|
class LoggingOptions < Struct.new(
|
@@ -4559,15 +4817,59 @@ module Aws::IoTSiteWise
|
|
4559
4817
|
end
|
4560
4818
|
|
4561
4819
|
# Contains an asset measurement property. For more information, see
|
4562
|
-
# [Measurements][1] in the *
|
4820
|
+
# [Measurements][1] in the *IoT SiteWise User Guide*.
|
4563
4821
|
#
|
4564
4822
|
#
|
4565
4823
|
#
|
4566
4824
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#measurements
|
4567
4825
|
#
|
4568
|
-
# @
|
4826
|
+
# @note When making an API call, you may pass Measurement
|
4827
|
+
# data as a hash:
|
4828
|
+
#
|
4829
|
+
# {
|
4830
|
+
# processing_config: {
|
4831
|
+
# forwarding_config: { # required
|
4832
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
4833
|
+
# },
|
4834
|
+
# },
|
4835
|
+
# }
|
4569
4836
|
#
|
4570
|
-
|
4837
|
+
# @!attribute [rw] processing_config
|
4838
|
+
# The processing configuration for the given measurement property. You
|
4839
|
+
# can configure measurements to be kept at the edge or forwarded to
|
4840
|
+
# the Amazon Web Services Cloud. By default, measurements are
|
4841
|
+
# forwarded to the cloud.
|
4842
|
+
# @return [Types::MeasurementProcessingConfig]
|
4843
|
+
#
|
4844
|
+
class Measurement < Struct.new(
|
4845
|
+
:processing_config)
|
4846
|
+
SENSITIVE = []
|
4847
|
+
include Aws::Structure
|
4848
|
+
end
|
4849
|
+
|
4850
|
+
# The processing configuration for the given measurement property. You
|
4851
|
+
# can configure measurements to be kept at the edge or forwarded to the
|
4852
|
+
# Amazon Web Services Cloud. By default, measurements are forwarded to
|
4853
|
+
# the cloud.
|
4854
|
+
#
|
4855
|
+
# @note When making an API call, you may pass MeasurementProcessingConfig
|
4856
|
+
# data as a hash:
|
4857
|
+
#
|
4858
|
+
# {
|
4859
|
+
# forwarding_config: { # required
|
4860
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
4861
|
+
# },
|
4862
|
+
# }
|
4863
|
+
#
|
4864
|
+
# @!attribute [rw] forwarding_config
|
4865
|
+
# The forwarding configuration for the given measurement property.
|
4866
|
+
# @return [Types::ForwardingConfig]
|
4867
|
+
#
|
4868
|
+
class MeasurementProcessingConfig < Struct.new(
|
4869
|
+
:forwarding_config)
|
4870
|
+
SENSITIVE = []
|
4871
|
+
include Aws::Structure
|
4872
|
+
end
|
4571
4873
|
|
4572
4874
|
# Contains an asset metric property. With metrics, you can calculate
|
4573
4875
|
# aggregate functions, such as an average, maximum, or minimum, as
|
@@ -4580,7 +4882,7 @@ module Aws::IoTSiteWise
|
|
4580
4882
|
# a metric can only have a data type of `DOUBLE` and consume properties
|
4581
4883
|
# with data types of `INTEGER` or `DOUBLE`.
|
4582
4884
|
#
|
4583
|
-
# For more information, see [Metrics][1] in the *
|
4885
|
+
# For more information, see [Metrics][1] in the *IoT SiteWise User
|
4584
4886
|
# Guide*.
|
4585
4887
|
#
|
4586
4888
|
#
|
@@ -4606,6 +4908,9 @@ module Aws::IoTSiteWise
|
|
4606
4908
|
# interval: "Interval", # required
|
4607
4909
|
# },
|
4608
4910
|
# },
|
4911
|
+
# processing_config: {
|
4912
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
4913
|
+
# },
|
4609
4914
|
# }
|
4610
4915
|
#
|
4611
4916
|
# @!attribute [rw] expression
|
@@ -4613,7 +4918,7 @@ module Aws::IoTSiteWise
|
|
4613
4918
|
# function. You can specify up to 10 variables per expression. You can
|
4614
4919
|
# specify up to 10 functions per expression.
|
4615
4920
|
#
|
4616
|
-
# For more information, see [Quotas][1] in the *
|
4921
|
+
# For more information, see [Quotas][1] in the *IoT SiteWise User
|
4617
4922
|
# Guide*.
|
4618
4923
|
#
|
4619
4924
|
#
|
@@ -4626,15 +4931,43 @@ module Aws::IoTSiteWise
|
|
4626
4931
|
# @return [Array<Types::ExpressionVariable>]
|
4627
4932
|
#
|
4628
4933
|
# @!attribute [rw] window
|
4629
|
-
# The window (time interval) over which
|
4630
|
-
# metric's aggregation expression.
|
4934
|
+
# The window (time interval) over which IoT SiteWise computes the
|
4935
|
+
# metric's aggregation expression. IoT SiteWise computes one data
|
4631
4936
|
# point per `window`.
|
4632
4937
|
# @return [Types::MetricWindow]
|
4633
4938
|
#
|
4939
|
+
# @!attribute [rw] processing_config
|
4940
|
+
# The processing configuration for the given metric property. You can
|
4941
|
+
# configure metrics to be computed at the edge or in the Amazon Web
|
4942
|
+
# Services Cloud. By default, metrics are forwarded to the cloud.
|
4943
|
+
# @return [Types::MetricProcessingConfig]
|
4944
|
+
#
|
4634
4945
|
class Metric < Struct.new(
|
4635
4946
|
:expression,
|
4636
4947
|
:variables,
|
4637
|
-
:window
|
4948
|
+
:window,
|
4949
|
+
:processing_config)
|
4950
|
+
SENSITIVE = []
|
4951
|
+
include Aws::Structure
|
4952
|
+
end
|
4953
|
+
|
4954
|
+
# The processing configuration for the given metric property. You can
|
4955
|
+
# configure metrics to be computed at the edge or in the Amazon Web
|
4956
|
+
# Services Cloud. By default, metrics are forwarded to the cloud.
|
4957
|
+
#
|
4958
|
+
# @note When making an API call, you may pass MetricProcessingConfig
|
4959
|
+
# data as a hash:
|
4960
|
+
#
|
4961
|
+
# {
|
4962
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
4963
|
+
# }
|
4964
|
+
#
|
4965
|
+
# @!attribute [rw] compute_location
|
4966
|
+
# The compute location for the given metric property.
|
4967
|
+
# @return [String]
|
4968
|
+
#
|
4969
|
+
class MetricProcessingConfig < Struct.new(
|
4970
|
+
:compute_location)
|
4638
4971
|
SENSITIVE = []
|
4639
4972
|
include Aws::Structure
|
4640
4973
|
end
|
@@ -4661,7 +4994,7 @@ module Aws::IoTSiteWise
|
|
4661
4994
|
include Aws::Structure
|
4662
4995
|
end
|
4663
4996
|
|
4664
|
-
# Contains
|
4997
|
+
# Contains IoT SiteWise Monitor error details.
|
4665
4998
|
#
|
4666
4999
|
# @!attribute [rw] code
|
4667
5000
|
# The error code.
|
@@ -4678,7 +5011,29 @@ module Aws::IoTSiteWise
|
|
4678
5011
|
include Aws::Structure
|
4679
5012
|
end
|
4680
5013
|
|
4681
|
-
#
|
5014
|
+
# Contains information about the storage destination.
|
5015
|
+
#
|
5016
|
+
# @note When making an API call, you may pass MultiLayerStorage
|
5017
|
+
# data as a hash:
|
5018
|
+
#
|
5019
|
+
# {
|
5020
|
+
# customer_managed_s3_storage: { # required
|
5021
|
+
# s3_resource_arn: "ARN", # required
|
5022
|
+
# role_arn: "ARN", # required
|
5023
|
+
# },
|
5024
|
+
# }
|
5025
|
+
#
|
5026
|
+
# @!attribute [rw] customer_managed_s3_storage
|
5027
|
+
# Contains information about a customer managed Amazon S3 bucket.
|
5028
|
+
# @return [Types::CustomerManagedS3Storage]
|
5029
|
+
#
|
5030
|
+
class MultiLayerStorage < Struct.new(
|
5031
|
+
:customer_managed_s3_storage)
|
5032
|
+
SENSITIVE = []
|
5033
|
+
include Aws::Structure
|
5034
|
+
end
|
5035
|
+
|
5036
|
+
# Identifies an IoT SiteWise Monitor portal.
|
4682
5037
|
#
|
4683
5038
|
# @note When making an API call, you may pass PortalResource
|
4684
5039
|
# data as a hash:
|
@@ -4729,9 +5084,9 @@ module Aws::IoTSiteWise
|
|
4729
5084
|
# @return [String]
|
4730
5085
|
#
|
4731
5086
|
# @!attribute [rw] start_url
|
4732
|
-
# The URL for the
|
4733
|
-
#
|
4734
|
-
# portals that use IAM for authentication, you must use the
|
5087
|
+
# The URL for the IoT SiteWise Monitor portal. You can use this URL to
|
5088
|
+
# access portals that use Amazon Web Services SSO for authentication.
|
5089
|
+
# For portals that use IAM for authentication, you must use the IoT
|
4735
5090
|
# SiteWise console to get a URL that you can use to access the portal.
|
4736
5091
|
# @return [String]
|
4737
5092
|
#
|
@@ -4745,9 +5100,9 @@ module Aws::IoTSiteWise
|
|
4745
5100
|
#
|
4746
5101
|
# @!attribute [rw] role_arn
|
4747
5102
|
# The [ARN][1] of the service role that allows the portal's users to
|
4748
|
-
# access your
|
4749
|
-
# information, see [Using service roles for
|
4750
|
-
#
|
5103
|
+
# access your IoT SiteWise resources on your behalf. For more
|
5104
|
+
# information, see [Using service roles for IoT SiteWise Monitor][2]
|
5105
|
+
# in the *IoT SiteWise User Guide*.
|
4751
5106
|
#
|
4752
5107
|
#
|
4753
5108
|
#
|
@@ -4772,7 +5127,7 @@ module Aws::IoTSiteWise
|
|
4772
5127
|
include Aws::Structure
|
4773
5128
|
end
|
4774
5129
|
|
4775
|
-
# Identifies a specific
|
5130
|
+
# Identifies a specific IoT SiteWise Monitor project.
|
4776
5131
|
#
|
4777
5132
|
# @note When making an API call, you may pass ProjectResource
|
4778
5133
|
# data as a hash:
|
@@ -4834,11 +5189,11 @@ module Aws::IoTSiteWise
|
|
4834
5189
|
# @return [String]
|
4835
5190
|
#
|
4836
5191
|
# @!attribute [rw] alias
|
4837
|
-
# The
|
4838
|
-
#
|
5192
|
+
# The alias that identifies the property, such as an OPC-UA server
|
5193
|
+
# data stream path (for example,
|
4839
5194
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
4840
5195
|
# see [Mapping industrial data streams to asset properties][1] in the
|
4841
|
-
# *
|
5196
|
+
# *IoT SiteWise User Guide*.
|
4842
5197
|
#
|
4843
5198
|
#
|
4844
5199
|
#
|
@@ -4880,18 +5235,17 @@ module Aws::IoTSiteWise
|
|
4880
5235
|
end
|
4881
5236
|
|
4882
5237
|
# Contains asset property value notification information. When the
|
4883
|
-
# notification state is enabled,
|
4884
|
-
#
|
4885
|
-
#
|
4886
|
-
# Guide*.
|
5238
|
+
# notification state is enabled, IoT SiteWise publishes property value
|
5239
|
+
# updates to a unique MQTT topic. For more information, see [Interacting
|
5240
|
+
# with other services][1] in the *IoT SiteWise User Guide*.
|
4887
5241
|
#
|
4888
5242
|
#
|
4889
5243
|
#
|
4890
5244
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html
|
4891
5245
|
#
|
4892
5246
|
# @!attribute [rw] topic
|
4893
|
-
# The MQTT topic to which
|
4894
|
-
#
|
5247
|
+
# The MQTT topic to which IoT SiteWise publishes property value update
|
5248
|
+
# notifications.
|
4895
5249
|
# @return [String]
|
4896
5250
|
#
|
4897
5251
|
# @!attribute [rw] state
|
@@ -4916,6 +5270,11 @@ module Aws::IoTSiteWise
|
|
4916
5270
|
# default_value: "DefaultValue",
|
4917
5271
|
# },
|
4918
5272
|
# measurement: {
|
5273
|
+
# processing_config: {
|
5274
|
+
# forwarding_config: { # required
|
5275
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
5276
|
+
# },
|
5277
|
+
# },
|
4919
5278
|
# },
|
4920
5279
|
# transform: {
|
4921
5280
|
# expression: "Expression", # required
|
@@ -4928,6 +5287,12 @@ module Aws::IoTSiteWise
|
|
4928
5287
|
# },
|
4929
5288
|
# },
|
4930
5289
|
# ],
|
5290
|
+
# processing_config: {
|
5291
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
5292
|
+
# forwarding_config: {
|
5293
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
5294
|
+
# },
|
5295
|
+
# },
|
4931
5296
|
# },
|
4932
5297
|
# metric: {
|
4933
5298
|
# expression: "Expression", # required
|
@@ -4945,6 +5310,9 @@ module Aws::IoTSiteWise
|
|
4945
5310
|
# interval: "Interval", # required
|
4946
5311
|
# },
|
4947
5312
|
# },
|
5313
|
+
# processing_config: {
|
5314
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
5315
|
+
# },
|
4948
5316
|
# },
|
4949
5317
|
# }
|
4950
5318
|
#
|
@@ -5034,11 +5402,11 @@ module Aws::IoTSiteWise
|
|
5034
5402
|
# @return [String]
|
5035
5403
|
#
|
5036
5404
|
# @!attribute [rw] property_alias
|
5037
|
-
# The
|
5038
|
-
#
|
5405
|
+
# The alias that identifies the property, such as an OPC-UA server
|
5406
|
+
# data stream path (for example,
|
5039
5407
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
5040
5408
|
# see [Mapping industrial data streams to asset properties][1] in the
|
5041
|
-
# *
|
5409
|
+
# *IoT SiteWise User Guide*.
|
5042
5410
|
#
|
5043
5411
|
#
|
5044
5412
|
#
|
@@ -5074,7 +5442,7 @@ module Aws::IoTSiteWise
|
|
5074
5442
|
#
|
5075
5443
|
# @!attribute [rw] kms_key_id
|
5076
5444
|
# The Key ID of the customer managed customer master key (CMK) used
|
5077
|
-
# for
|
5445
|
+
# for KMS encryption. This is required if you use
|
5078
5446
|
# `KMS_BASED_ENCRYPTION`.
|
5079
5447
|
# @return [String]
|
5080
5448
|
#
|
@@ -5090,8 +5458,8 @@ module Aws::IoTSiteWise
|
|
5090
5458
|
# @return [String]
|
5091
5459
|
#
|
5092
5460
|
# @!attribute [rw] kms_key_arn
|
5093
|
-
# The Key ARN of the
|
5094
|
-
#
|
5461
|
+
# The Key ARN of the KMS CMK used for KMS encryption if you use
|
5462
|
+
# `KMS_BASED_ENCRYPTION`.
|
5095
5463
|
# @return [String]
|
5096
5464
|
#
|
5097
5465
|
# @!attribute [rw] configuration_status
|
@@ -5129,8 +5497,73 @@ module Aws::IoTSiteWise
|
|
5129
5497
|
|
5130
5498
|
class PutLoggingOptionsResponse < Aws::EmptyStructure; end
|
5131
5499
|
|
5132
|
-
#
|
5133
|
-
#
|
5500
|
+
# @note When making an API call, you may pass PutStorageConfigurationRequest
|
5501
|
+
# data as a hash:
|
5502
|
+
#
|
5503
|
+
# {
|
5504
|
+
# storage_type: "SITEWISE_DEFAULT_STORAGE", # required, accepts SITEWISE_DEFAULT_STORAGE, MULTI_LAYER_STORAGE
|
5505
|
+
# multi_layer_storage: {
|
5506
|
+
# customer_managed_s3_storage: { # required
|
5507
|
+
# s3_resource_arn: "ARN", # required
|
5508
|
+
# role_arn: "ARN", # required
|
5509
|
+
# },
|
5510
|
+
# },
|
5511
|
+
# }
|
5512
|
+
#
|
5513
|
+
# @!attribute [rw] storage_type
|
5514
|
+
# The type of storage that you specified for your data. The storage
|
5515
|
+
# type can be one of the following values:
|
5516
|
+
#
|
5517
|
+
# * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise replicates your data
|
5518
|
+
# into a service managed database.
|
5519
|
+
#
|
5520
|
+
# * `MULTI_LAYER_STORAGE` – IoT SiteWise replicates your data into a
|
5521
|
+
# service managed database and saves a copy of your raw data and
|
5522
|
+
# metadata in an Amazon S3 object that you specified.
|
5523
|
+
# @return [String]
|
5524
|
+
#
|
5525
|
+
# @!attribute [rw] multi_layer_storage
|
5526
|
+
# Identifies a storage destination. If you specified
|
5527
|
+
# `MULTI_LAYER_STORAGE` for the storage type, you must specify a
|
5528
|
+
# `MultiLayerStorage` object.
|
5529
|
+
# @return [Types::MultiLayerStorage]
|
5530
|
+
#
|
5531
|
+
class PutStorageConfigurationRequest < Struct.new(
|
5532
|
+
:storage_type,
|
5533
|
+
:multi_layer_storage)
|
5534
|
+
SENSITIVE = []
|
5535
|
+
include Aws::Structure
|
5536
|
+
end
|
5537
|
+
|
5538
|
+
# @!attribute [rw] storage_type
|
5539
|
+
# The type of storage that you specified for your data. The storage
|
5540
|
+
# type can be one of the following values:
|
5541
|
+
#
|
5542
|
+
# * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise replicates your data
|
5543
|
+
# into a service managed database.
|
5544
|
+
#
|
5545
|
+
# * `MULTI_LAYER_STORAGE` – IoT SiteWise replicates your data into a
|
5546
|
+
# service managed database and saves a copy of your raw data and
|
5547
|
+
# metadata in an Amazon S3 object that you specified.
|
5548
|
+
# @return [String]
|
5549
|
+
#
|
5550
|
+
# @!attribute [rw] multi_layer_storage
|
5551
|
+
# Contains information about the storage destination.
|
5552
|
+
# @return [Types::MultiLayerStorage]
|
5553
|
+
#
|
5554
|
+
# @!attribute [rw] configuration_status
|
5555
|
+
# Contains current status information for the configuration.
|
5556
|
+
# @return [Types::ConfigurationStatus]
|
5557
|
+
#
|
5558
|
+
class PutStorageConfigurationResponse < Struct.new(
|
5559
|
+
:storage_type,
|
5560
|
+
:multi_layer_storage,
|
5561
|
+
:configuration_status)
|
5562
|
+
SENSITIVE = []
|
5563
|
+
include Aws::Structure
|
5564
|
+
end
|
5565
|
+
|
5566
|
+
# Contains an IoT SiteWise Monitor resource ID for a portal or project.
|
5134
5567
|
#
|
5135
5568
|
# @note When making an API call, you may pass Resource
|
5136
5569
|
# data as a hash:
|
@@ -5222,8 +5655,8 @@ module Aws::IoTSiteWise
|
|
5222
5655
|
#
|
5223
5656
|
# @!attribute [rw] tags
|
5224
5657
|
# A list of key-value pairs that contain metadata for the resource.
|
5225
|
-
# For more information, see [Tagging your
|
5226
|
-
#
|
5658
|
+
# For more information, see [Tagging your IoT SiteWise resources][1]
|
5659
|
+
# in the *IoT SiteWise User Guide*.
|
5227
5660
|
#
|
5228
5661
|
#
|
5229
5662
|
#
|
@@ -5240,10 +5673,10 @@ module Aws::IoTSiteWise
|
|
5240
5673
|
class TagResourceResponse < Aws::EmptyStructure; end
|
5241
5674
|
|
5242
5675
|
# Your request exceeded a rate limit. For example, you might have
|
5243
|
-
# exceeded the number of
|
5676
|
+
# exceeded the number of IoT SiteWise assets that can be created per
|
5244
5677
|
# second, the allowed number of messages per second, and so on.
|
5245
5678
|
#
|
5246
|
-
# For more information, see [Quotas][1] in the *
|
5679
|
+
# For more information, see [Quotas][1] in the *IoT SiteWise User
|
5247
5680
|
# Guide*.
|
5248
5681
|
#
|
5249
5682
|
#
|
@@ -5287,7 +5720,7 @@ module Aws::IoTSiteWise
|
|
5287
5720
|
|
5288
5721
|
# You've reached the limit for the number of tags allowed for a
|
5289
5722
|
# resource. For more information, see [Tag naming limits and
|
5290
|
-
# requirements][1] in the *
|
5723
|
+
# requirements][1] in the *Amazon Web Services General Reference*.
|
5291
5724
|
#
|
5292
5725
|
#
|
5293
5726
|
#
|
@@ -5315,8 +5748,8 @@ module Aws::IoTSiteWise
|
|
5315
5748
|
# `DOUBLE` and consume properties with data types of `INTEGER` or
|
5316
5749
|
# `DOUBLE`.
|
5317
5750
|
#
|
5318
|
-
# For more information, see [Transforms][1] in the *
|
5319
|
-
#
|
5751
|
+
# For more information, see [Transforms][1] in the *IoT SiteWise User
|
5752
|
+
# Guide*.
|
5320
5753
|
#
|
5321
5754
|
#
|
5322
5755
|
#
|
@@ -5336,6 +5769,12 @@ module Aws::IoTSiteWise
|
|
5336
5769
|
# },
|
5337
5770
|
# },
|
5338
5771
|
# ],
|
5772
|
+
# processing_config: {
|
5773
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
5774
|
+
# forwarding_config: {
|
5775
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
5776
|
+
# },
|
5777
|
+
# },
|
5339
5778
|
# }
|
5340
5779
|
#
|
5341
5780
|
# @!attribute [rw] expression
|
@@ -5343,7 +5782,7 @@ module Aws::IoTSiteWise
|
|
5343
5782
|
# function. You can specify up to 10 variables per expression. You can
|
5344
5783
|
# specify up to 10 functions per expression.
|
5345
5784
|
#
|
5346
|
-
# For more information, see [Quotas][1] in the *
|
5785
|
+
# For more information, see [Quotas][1] in the *IoT SiteWise User
|
5347
5786
|
# Guide*.
|
5348
5787
|
#
|
5349
5788
|
#
|
@@ -5355,9 +5794,47 @@ module Aws::IoTSiteWise
|
|
5355
5794
|
# The list of variables used in the expression.
|
5356
5795
|
# @return [Array<Types::ExpressionVariable>]
|
5357
5796
|
#
|
5797
|
+
# @!attribute [rw] processing_config
|
5798
|
+
# The processing configuration for the given transform property. You
|
5799
|
+
# can configure transforms to be kept at the edge or forwarded to the
|
5800
|
+
# Amazon Web Services Cloud. You can also configure transforms to be
|
5801
|
+
# computed at the edge or in the cloud.
|
5802
|
+
# @return [Types::TransformProcessingConfig]
|
5803
|
+
#
|
5358
5804
|
class Transform < Struct.new(
|
5359
5805
|
:expression,
|
5360
|
-
:variables
|
5806
|
+
:variables,
|
5807
|
+
:processing_config)
|
5808
|
+
SENSITIVE = []
|
5809
|
+
include Aws::Structure
|
5810
|
+
end
|
5811
|
+
|
5812
|
+
# The processing configuration for the given transform property. You can
|
5813
|
+
# configure transforms to be kept at the edge or forwarded to the Amazon
|
5814
|
+
# Web Services Cloud. You can also configure transforms to be computed
|
5815
|
+
# at the edge or in the cloud.
|
5816
|
+
#
|
5817
|
+
# @note When making an API call, you may pass TransformProcessingConfig
|
5818
|
+
# data as a hash:
|
5819
|
+
#
|
5820
|
+
# {
|
5821
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
5822
|
+
# forwarding_config: {
|
5823
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
5824
|
+
# },
|
5825
|
+
# }
|
5826
|
+
#
|
5827
|
+
# @!attribute [rw] compute_location
|
5828
|
+
# The compute location for the given transform property.
|
5829
|
+
# @return [String]
|
5830
|
+
#
|
5831
|
+
# @!attribute [rw] forwarding_config
|
5832
|
+
# The forwarding configuration for a given property.
|
5833
|
+
# @return [Types::ForwardingConfig]
|
5834
|
+
#
|
5835
|
+
class TransformProcessingConfig < Struct.new(
|
5836
|
+
:compute_location,
|
5837
|
+
:forwarding_config)
|
5361
5838
|
SENSITIVE = []
|
5362
5839
|
include Aws::Structure
|
5363
5840
|
end
|
@@ -5376,15 +5853,15 @@ module Aws::IoTSiteWise
|
|
5376
5853
|
# @!attribute [rw] interval
|
5377
5854
|
# The time interval for the tumbling window. Note that `w` represents
|
5378
5855
|
# weeks, `d` represents days, `h` represents hours, and `m` represents
|
5379
|
-
# minutes.
|
5380
|
-
#
|
5381
|
-
#
|
5382
|
-
#
|
5856
|
+
# minutes. IoT SiteWise computes the `1w` interval the end of Sunday
|
5857
|
+
# at midnight each week (UTC), the `1d` interval at the end of each
|
5858
|
+
# day at midnight (UTC), the `1h` interval at the end of each hour,
|
5859
|
+
# and so on.
|
5383
5860
|
#
|
5384
|
-
# When
|
5385
|
-
#
|
5386
|
-
#
|
5387
|
-
#
|
5861
|
+
# When IoT SiteWise aggregates data points for metric computations,
|
5862
|
+
# the start of each interval is exclusive and the end of each interval
|
5863
|
+
# is inclusive. IoT SiteWise places the computed data point at the end
|
5864
|
+
# of the interval.
|
5388
5865
|
# @return [String]
|
5389
5866
|
#
|
5390
5867
|
class TumblingWindow < Struct.new(
|
@@ -5469,12 +5946,12 @@ module Aws::IoTSiteWise
|
|
5469
5946
|
# @return [String]
|
5470
5947
|
#
|
5471
5948
|
# @!attribute [rw] access_policy_identity
|
5472
|
-
# The identity for this access policy. Choose an
|
5473
|
-
# SSO group, or an IAM user.
|
5949
|
+
# The identity for this access policy. Choose an Amazon Web Services
|
5950
|
+
# SSO user, an Amazon Web Services SSO group, or an IAM user.
|
5474
5951
|
# @return [Types::Identity]
|
5475
5952
|
#
|
5476
5953
|
# @!attribute [rw] access_policy_resource
|
5477
|
-
# The
|
5954
|
+
# The IoT SiteWise Monitor resource for this access policy. Choose
|
5478
5955
|
# either a portal or a project.
|
5479
5956
|
# @return [Types::Resource]
|
5480
5957
|
#
|
@@ -5523,6 +6000,11 @@ module Aws::IoTSiteWise
|
|
5523
6000
|
# default_value: "DefaultValue",
|
5524
6001
|
# },
|
5525
6002
|
# measurement: {
|
6003
|
+
# processing_config: {
|
6004
|
+
# forwarding_config: { # required
|
6005
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
6006
|
+
# },
|
6007
|
+
# },
|
5526
6008
|
# },
|
5527
6009
|
# transform: {
|
5528
6010
|
# expression: "Expression", # required
|
@@ -5535,6 +6017,12 @@ module Aws::IoTSiteWise
|
|
5535
6017
|
# },
|
5536
6018
|
# },
|
5537
6019
|
# ],
|
6020
|
+
# processing_config: {
|
6021
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
6022
|
+
# forwarding_config: {
|
6023
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
6024
|
+
# },
|
6025
|
+
# },
|
5538
6026
|
# },
|
5539
6027
|
# metric: {
|
5540
6028
|
# expression: "Expression", # required
|
@@ -5552,6 +6040,9 @@ module Aws::IoTSiteWise
|
|
5552
6040
|
# interval: "Interval", # required
|
5553
6041
|
# },
|
5554
6042
|
# },
|
6043
|
+
# processing_config: {
|
6044
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
6045
|
+
# },
|
5555
6046
|
# },
|
5556
6047
|
# },
|
5557
6048
|
# },
|
@@ -5580,6 +6071,11 @@ module Aws::IoTSiteWise
|
|
5580
6071
|
# default_value: "DefaultValue",
|
5581
6072
|
# },
|
5582
6073
|
# measurement: {
|
6074
|
+
# processing_config: {
|
6075
|
+
# forwarding_config: { # required
|
6076
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
6077
|
+
# },
|
6078
|
+
# },
|
5583
6079
|
# },
|
5584
6080
|
# transform: {
|
5585
6081
|
# expression: "Expression", # required
|
@@ -5592,6 +6088,12 @@ module Aws::IoTSiteWise
|
|
5592
6088
|
# },
|
5593
6089
|
# },
|
5594
6090
|
# ],
|
6091
|
+
# processing_config: {
|
6092
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
6093
|
+
# forwarding_config: {
|
6094
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
6095
|
+
# },
|
6096
|
+
# },
|
5595
6097
|
# },
|
5596
6098
|
# metric: {
|
5597
6099
|
# expression: "Expression", # required
|
@@ -5609,6 +6111,9 @@ module Aws::IoTSiteWise
|
|
5609
6111
|
# interval: "Interval", # required
|
5610
6112
|
# },
|
5611
6113
|
# },
|
6114
|
+
# processing_config: {
|
6115
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
6116
|
+
# },
|
5612
6117
|
# },
|
5613
6118
|
# },
|
5614
6119
|
# },
|
@@ -5632,11 +6137,11 @@ module Aws::IoTSiteWise
|
|
5632
6137
|
#
|
5633
6138
|
# @!attribute [rw] asset_model_properties
|
5634
6139
|
# The updated property definitions of the asset model. For more
|
5635
|
-
# information, see [Asset properties][1] in the *
|
6140
|
+
# information, see [Asset properties][1] in the *IoT SiteWise User
|
5636
6141
|
# Guide*.
|
5637
6142
|
#
|
5638
6143
|
# You can specify up to 200 properties per asset model. For more
|
5639
|
-
# information, see [Quotas][2] in the *
|
6144
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
5640
6145
|
#
|
5641
6146
|
#
|
5642
6147
|
#
|
@@ -5648,10 +6153,10 @@ module Aws::IoTSiteWise
|
|
5648
6153
|
# The updated hierarchy definitions of the asset model. Each hierarchy
|
5649
6154
|
# specifies an asset model whose assets can be children of any other
|
5650
6155
|
# assets created from this asset model. For more information, see
|
5651
|
-
# [Asset hierarchies][1] in the *
|
6156
|
+
# [Asset hierarchies][1] in the *IoT SiteWise User Guide*.
|
5652
6157
|
#
|
5653
6158
|
# You can specify up to 10 hierarchies per asset model. For more
|
5654
|
-
# information, see [Quotas][2] in the *
|
6159
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
5655
6160
|
#
|
5656
6161
|
#
|
5657
6162
|
#
|
@@ -5719,11 +6224,11 @@ module Aws::IoTSiteWise
|
|
5719
6224
|
# @return [String]
|
5720
6225
|
#
|
5721
6226
|
# @!attribute [rw] property_alias
|
5722
|
-
# The
|
5723
|
-
#
|
6227
|
+
# The alias that identifies the property, such as an OPC-UA server
|
6228
|
+
# data stream path (for example,
|
5724
6229
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
5725
6230
|
# see [Mapping industrial data streams to asset properties][1] in the
|
5726
|
-
# *
|
6231
|
+
# *IoT SiteWise User Guide*.
|
5727
6232
|
#
|
5728
6233
|
# If you omit this parameter, the alias is removed from the property.
|
5729
6234
|
#
|
@@ -5734,10 +6239,10 @@ module Aws::IoTSiteWise
|
|
5734
6239
|
#
|
5735
6240
|
# @!attribute [rw] property_notification_state
|
5736
6241
|
# The MQTT notification state (enabled or disabled) for this asset
|
5737
|
-
# property. When the notification state is enabled,
|
6242
|
+
# property. When the notification state is enabled, IoT SiteWise
|
5738
6243
|
# publishes property value updates to a unique MQTT topic. For more
|
5739
|
-
# information, see [Interacting with other services][1] in the *
|
5740
|
-
#
|
6244
|
+
# information, see [Interacting with other services][1] in the *IoT
|
6245
|
+
# SiteWise User Guide*.
|
5741
6246
|
#
|
5742
6247
|
# If you omit this parameter, the notification state is set to
|
5743
6248
|
# `DISABLED`.
|
@@ -5836,8 +6341,8 @@ module Aws::IoTSiteWise
|
|
5836
6341
|
#
|
5837
6342
|
# @!attribute [rw] dashboard_definition
|
5838
6343
|
# The new dashboard definition, as specified in a JSON literal. For
|
5839
|
-
# detailed information, see [Creating dashboards (CLI)][1] in the *
|
5840
|
-
#
|
6344
|
+
# detailed information, see [Creating dashboards (CLI)][1] in the *IoT
|
6345
|
+
# SiteWise User Guide*.
|
5841
6346
|
#
|
5842
6347
|
#
|
5843
6348
|
#
|
@@ -5880,16 +6385,16 @@ module Aws::IoTSiteWise
|
|
5880
6385
|
#
|
5881
6386
|
# @!attribute [rw] capability_namespace
|
5882
6387
|
# The namespace of the gateway capability configuration to be updated.
|
5883
|
-
# For example, if you configure OPC-UA sources from the
|
5884
|
-
#
|
5885
|
-
#
|
5886
|
-
#
|
6388
|
+
# For example, if you configure OPC-UA sources from the IoT SiteWise
|
6389
|
+
# console, your OPC-UA capability configuration has the namespace
|
6390
|
+
# `iotsitewise:opcuacollector:version`, where `version` is a number
|
6391
|
+
# such as `1`.
|
5887
6392
|
# @return [String]
|
5888
6393
|
#
|
5889
6394
|
# @!attribute [rw] capability_configuration
|
5890
6395
|
# The JSON document that defines the configuration for the gateway
|
5891
6396
|
# capability. For more information, see [Configuring data sources
|
5892
|
-
# (CLI)][1] in the *
|
6397
|
+
# (CLI)][1] in the *IoT SiteWise User Guide*.
|
5893
6398
|
#
|
5894
6399
|
#
|
5895
6400
|
#
|
@@ -5991,7 +6496,7 @@ module Aws::IoTSiteWise
|
|
5991
6496
|
# @return [String]
|
5992
6497
|
#
|
5993
6498
|
# @!attribute [rw] portal_contact_email
|
5994
|
-
# The
|
6499
|
+
# The Amazon Web Services administrator's contact email address.
|
5995
6500
|
# @return [String]
|
5996
6501
|
#
|
5997
6502
|
# @!attribute [rw] portal_logo_image
|
@@ -6005,9 +6510,9 @@ module Aws::IoTSiteWise
|
|
6005
6510
|
#
|
6006
6511
|
# @!attribute [rw] role_arn
|
6007
6512
|
# The [ARN][1] of a service role that allows the portal's users to
|
6008
|
-
# access your
|
6009
|
-
# information, see [Using service roles for
|
6010
|
-
#
|
6513
|
+
# access your IoT SiteWise resources on your behalf. For more
|
6514
|
+
# information, see [Using service roles for IoT SiteWise Monitor][2]
|
6515
|
+
# in the *IoT SiteWise User Guide*.
|
6011
6516
|
#
|
6012
6517
|
#
|
6013
6518
|
#
|
@@ -6029,10 +6534,15 @@ module Aws::IoTSiteWise
|
|
6029
6534
|
# @return [String]
|
6030
6535
|
#
|
6031
6536
|
# @!attribute [rw] alarms
|
6032
|
-
# Contains the configuration information of an alarm created in an
|
6033
|
-
#
|
6034
|
-
#
|
6035
|
-
#
|
6537
|
+
# Contains the configuration information of an alarm created in an IoT
|
6538
|
+
# SiteWise Monitor portal. You can use the alarm to monitor an asset
|
6539
|
+
# property and get notified when the asset property value is outside a
|
6540
|
+
# specified range. For more information, see [Monitoring with
|
6541
|
+
# alarms][1] in the *IoT SiteWise Application Guide*.
|
6542
|
+
#
|
6543
|
+
#
|
6544
|
+
#
|
6545
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
|
6036
6546
|
# @return [Types::Alarms]
|
6037
6547
|
#
|
6038
6548
|
class UpdatePortalRequest < Struct.new(
|
@@ -6112,7 +6622,7 @@ module Aws::IoTSiteWise
|
|
6112
6622
|
# }
|
6113
6623
|
#
|
6114
6624
|
# @!attribute [rw] id
|
6115
|
-
# The
|
6625
|
+
# The Amazon Web Services SSO ID of the user.
|
6116
6626
|
# @return [String]
|
6117
6627
|
#
|
6118
6628
|
class UserIdentity < Struct.new(
|
@@ -6144,7 +6654,7 @@ module Aws::IoTSiteWise
|
|
6144
6654
|
# several hierarchies using the same model and therefore the same
|
6145
6655
|
# `propertyId`. For example, you might have separately grouped assets
|
6146
6656
|
# that come from the same asset model. For more information, see
|
6147
|
-
# [Asset hierarchies][1] in the *
|
6657
|
+
# [Asset hierarchies][1] in the *IoT SiteWise User Guide*.
|
6148
6658
|
#
|
6149
6659
|
#
|
6150
6660
|
#
|