aws-sdk-iotsitewise 1.13.0 → 1.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-iotsitewise.rb +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +358 -13
- data/lib/aws-sdk-iotsitewise/client_api.rb +194 -1
- data/lib/aws-sdk-iotsitewise/errors.rb +16 -0
- data/lib/aws-sdk-iotsitewise/types.rb +717 -38
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4c9103cb30a2ad2906a7992c9807a5a2437e9ec095f6999945d878aff74fca57
|
4
|
+
data.tar.gz: f8459e4d532b058c2c6b2dd597a0e3d7a3c7f84073ac51cf1dcf85b830b2e275
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6cc9ff677e2b9bfb41da2cd687ca09ea4f8e081d3aa686295199e3402a5667d6590aeb0c4804390eb2bf32f0962b6c1511266f5f8964c61c3b3770427e357854
|
7
|
+
data.tar.gz: 72ed325fc379f068d69e8c5118cc71a8c4c2a090a04f673343f260e67d931b0904e5c2854de8ae88d4ba25a394e0841fc750fbc21d02a3d3f5e456416d447933
|
data/lib/aws-sdk-iotsitewise.rb
CHANGED
@@ -477,10 +477,10 @@ module Aws::IoTSiteWise
|
|
477
477
|
# property's alias, see [UpdateAssetProperty][2].
|
478
478
|
#
|
479
479
|
# With respect to Unix epoch time, AWS IoT SiteWise accepts only TQVs
|
480
|
-
# that have a timestamp of no more than
|
481
|
-
#
|
482
|
-
# outside of the inclusive range of \[-
|
483
|
-
# `TimestampOutOfRangeException` error.
|
480
|
+
# that have a timestamp of no more than 7 days in the past and no more
|
481
|
+
# than 5 minutes in the future. AWS IoT SiteWise rejects timestamps
|
482
|
+
# outside of the inclusive range of \[-7 days, +5 minutes\] and returns
|
483
|
+
# a `TimestampOutOfRangeException` error.
|
484
484
|
#
|
485
485
|
# For each asset property, AWS IoT SiteWise overwrites TQVs with
|
486
486
|
# duplicate timestamps unless the newer TQV has a different quality. For
|
@@ -603,6 +603,9 @@ module Aws::IoTSiteWise
|
|
603
603
|
# iam_user: {
|
604
604
|
# arn: "ARN", # required
|
605
605
|
# },
|
606
|
+
# iam_role: {
|
607
|
+
# arn: "ARN", # required
|
608
|
+
# },
|
606
609
|
# },
|
607
610
|
# access_policy_resource: { # required
|
608
611
|
# portal: {
|
@@ -736,6 +739,13 @@ module Aws::IoTSiteWise
|
|
736
739
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
|
737
740
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
|
738
741
|
#
|
742
|
+
# @option params [Array<Types::AssetModelCompositeModelDefinition>] :asset_model_composite_models
|
743
|
+
# The composite asset models that are part of this asset model.
|
744
|
+
# Composite asset models are asset models that contain specific
|
745
|
+
# properties. Each composite model has a type that defines the
|
746
|
+
# properties that the composite model supports. Use composite asset
|
747
|
+
# models to define alarms on this asset model.
|
748
|
+
#
|
739
749
|
# @option params [String] :client_token
|
740
750
|
# A unique case-sensitive identifier that you can provide to ensure the
|
741
751
|
# idempotency of the request. Don't reuse this client token if a new
|
@@ -767,7 +777,8 @@ module Aws::IoTSiteWise
|
|
767
777
|
# asset_model_properties: [
|
768
778
|
# {
|
769
779
|
# name: "Name", # required
|
770
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN
|
780
|
+
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
781
|
+
# data_type_spec: "Name",
|
771
782
|
# unit: "PropertyUnit",
|
772
783
|
# type: { # required
|
773
784
|
# attribute: {
|
@@ -813,6 +824,57 @@ module Aws::IoTSiteWise
|
|
813
824
|
# child_asset_model_id: "ID", # required
|
814
825
|
# },
|
815
826
|
# ],
|
827
|
+
# asset_model_composite_models: [
|
828
|
+
# {
|
829
|
+
# name: "Name", # required
|
830
|
+
# description: "Description",
|
831
|
+
# type: "Name", # required
|
832
|
+
# properties: [
|
833
|
+
# {
|
834
|
+
# name: "Name", # required
|
835
|
+
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
836
|
+
# data_type_spec: "Name",
|
837
|
+
# unit: "PropertyUnit",
|
838
|
+
# type: { # required
|
839
|
+
# attribute: {
|
840
|
+
# default_value: "DefaultValue",
|
841
|
+
# },
|
842
|
+
# measurement: {
|
843
|
+
# },
|
844
|
+
# transform: {
|
845
|
+
# expression: "Expression", # required
|
846
|
+
# variables: [ # required
|
847
|
+
# {
|
848
|
+
# name: "VariableName", # required
|
849
|
+
# value: { # required
|
850
|
+
# property_id: "Macro", # required
|
851
|
+
# hierarchy_id: "Macro",
|
852
|
+
# },
|
853
|
+
# },
|
854
|
+
# ],
|
855
|
+
# },
|
856
|
+
# metric: {
|
857
|
+
# expression: "Expression", # required
|
858
|
+
# variables: [ # required
|
859
|
+
# {
|
860
|
+
# name: "VariableName", # required
|
861
|
+
# value: { # required
|
862
|
+
# property_id: "Macro", # required
|
863
|
+
# hierarchy_id: "Macro",
|
864
|
+
# },
|
865
|
+
# },
|
866
|
+
# ],
|
867
|
+
# window: { # required
|
868
|
+
# tumbling: {
|
869
|
+
# interval: "Interval", # required
|
870
|
+
# },
|
871
|
+
# },
|
872
|
+
# },
|
873
|
+
# },
|
874
|
+
# },
|
875
|
+
# ],
|
876
|
+
# },
|
877
|
+
# ],
|
816
878
|
# client_token: "ClientToken",
|
817
879
|
# tags: {
|
818
880
|
# "TagKey" => "TagValue",
|
@@ -1024,9 +1086,8 @@ module Aws::IoTSiteWise
|
|
1024
1086
|
# Regions.
|
1025
1087
|
#
|
1026
1088
|
# * `IAM` – The portal uses AWS Identity and Access Management (IAM) to
|
1027
|
-
# authenticate users and manage user permissions.
|
1028
|
-
#
|
1029
|
-
# the portal. This option is only available in the China Regions.
|
1089
|
+
# authenticate users and manage user permissions. This option is only
|
1090
|
+
# available in the China Regions.
|
1030
1091
|
#
|
1031
1092
|
# You can't change this value after you create a portal.
|
1032
1093
|
#
|
@@ -1079,6 +1140,35 @@ module Aws::IoTSiteWise
|
|
1079
1140
|
req.send_request(options)
|
1080
1141
|
end
|
1081
1142
|
|
1143
|
+
# @option params [required, String] :portal_id
|
1144
|
+
#
|
1145
|
+
# @option params [Integer] :session_duration_seconds
|
1146
|
+
#
|
1147
|
+
# @option params [String] :state
|
1148
|
+
#
|
1149
|
+
# @return [Types::CreatePresignedPortalUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1150
|
+
#
|
1151
|
+
# * {Types::CreatePresignedPortalUrlResponse#presigned_portal_url #presigned_portal_url} => String
|
1152
|
+
#
|
1153
|
+
# @example Request syntax with placeholder values
|
1154
|
+
#
|
1155
|
+
# resp = client.create_presigned_portal_url({
|
1156
|
+
# portal_id: "ID", # required
|
1157
|
+
# session_duration_seconds: 1,
|
1158
|
+
# state: "state",
|
1159
|
+
# })
|
1160
|
+
#
|
1161
|
+
# @example Response structure
|
1162
|
+
#
|
1163
|
+
# resp.presigned_portal_url #=> String
|
1164
|
+
#
|
1165
|
+
# @overload create_presigned_portal_url(params = {})
|
1166
|
+
# @param [Hash] params ({})
|
1167
|
+
def create_presigned_portal_url(params = {}, options = {})
|
1168
|
+
req = build_request(:create_presigned_portal_url, params)
|
1169
|
+
req.send_request(options)
|
1170
|
+
end
|
1171
|
+
|
1082
1172
|
# Creates a project in the specified portal.
|
1083
1173
|
#
|
1084
1174
|
# @option params [required, String] :portal_id
|
@@ -1407,6 +1497,7 @@ module Aws::IoTSiteWise
|
|
1407
1497
|
# resp.access_policy_identity.user.id #=> String
|
1408
1498
|
# resp.access_policy_identity.group.id #=> String
|
1409
1499
|
# resp.access_policy_identity.iam_user.arn #=> String
|
1500
|
+
# resp.access_policy_identity.iam_role.arn #=> String
|
1410
1501
|
# resp.access_policy_resource.portal.id #=> String
|
1411
1502
|
# resp.access_policy_resource.project.id #=> String
|
1412
1503
|
# resp.access_policy_permission #=> String, one of "ADMINISTRATOR", "VIEWER"
|
@@ -1433,6 +1524,7 @@ module Aws::IoTSiteWise
|
|
1433
1524
|
# * {Types::DescribeAssetResponse#asset_model_id #asset_model_id} => String
|
1434
1525
|
# * {Types::DescribeAssetResponse#asset_properties #asset_properties} => Array<Types::AssetProperty>
|
1435
1526
|
# * {Types::DescribeAssetResponse#asset_hierarchies #asset_hierarchies} => Array<Types::AssetHierarchy>
|
1527
|
+
# * {Types::DescribeAssetResponse#asset_composite_models #asset_composite_models} => Array<Types::AssetCompositeModel>
|
1436
1528
|
# * {Types::DescribeAssetResponse#asset_creation_date #asset_creation_date} => Time
|
1437
1529
|
# * {Types::DescribeAssetResponse#asset_last_update_date #asset_last_update_date} => Time
|
1438
1530
|
# * {Types::DescribeAssetResponse#asset_status #asset_status} => Types::AssetStatus
|
@@ -1455,11 +1547,25 @@ module Aws::IoTSiteWise
|
|
1455
1547
|
# resp.asset_properties[0].alias #=> String
|
1456
1548
|
# resp.asset_properties[0].notification.topic #=> String
|
1457
1549
|
# resp.asset_properties[0].notification.state #=> String, one of "ENABLED", "DISABLED"
|
1458
|
-
# resp.asset_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN"
|
1550
|
+
# resp.asset_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1551
|
+
# resp.asset_properties[0].data_type_spec #=> String
|
1459
1552
|
# resp.asset_properties[0].unit #=> String
|
1460
1553
|
# resp.asset_hierarchies #=> Array
|
1461
1554
|
# resp.asset_hierarchies[0].id #=> String
|
1462
1555
|
# resp.asset_hierarchies[0].name #=> String
|
1556
|
+
# resp.asset_composite_models #=> Array
|
1557
|
+
# resp.asset_composite_models[0].name #=> String
|
1558
|
+
# resp.asset_composite_models[0].description #=> String
|
1559
|
+
# resp.asset_composite_models[0].type #=> String
|
1560
|
+
# resp.asset_composite_models[0].properties #=> Array
|
1561
|
+
# resp.asset_composite_models[0].properties[0].id #=> String
|
1562
|
+
# resp.asset_composite_models[0].properties[0].name #=> String
|
1563
|
+
# resp.asset_composite_models[0].properties[0].alias #=> String
|
1564
|
+
# resp.asset_composite_models[0].properties[0].notification.topic #=> String
|
1565
|
+
# resp.asset_composite_models[0].properties[0].notification.state #=> String, one of "ENABLED", "DISABLED"
|
1566
|
+
# resp.asset_composite_models[0].properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1567
|
+
# resp.asset_composite_models[0].properties[0].data_type_spec #=> String
|
1568
|
+
# resp.asset_composite_models[0].properties[0].unit #=> String
|
1463
1569
|
# resp.asset_creation_date #=> Time
|
1464
1570
|
# resp.asset_last_update_date #=> Time
|
1465
1571
|
# resp.asset_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
@@ -1492,6 +1598,7 @@ module Aws::IoTSiteWise
|
|
1492
1598
|
# * {Types::DescribeAssetModelResponse#asset_model_description #asset_model_description} => String
|
1493
1599
|
# * {Types::DescribeAssetModelResponse#asset_model_properties #asset_model_properties} => Array<Types::AssetModelProperty>
|
1494
1600
|
# * {Types::DescribeAssetModelResponse#asset_model_hierarchies #asset_model_hierarchies} => Array<Types::AssetModelHierarchy>
|
1601
|
+
# * {Types::DescribeAssetModelResponse#asset_model_composite_models #asset_model_composite_models} => Array<Types::AssetModelCompositeModel>
|
1495
1602
|
# * {Types::DescribeAssetModelResponse#asset_model_creation_date #asset_model_creation_date} => Time
|
1496
1603
|
# * {Types::DescribeAssetModelResponse#asset_model_last_update_date #asset_model_last_update_date} => Time
|
1497
1604
|
# * {Types::DescribeAssetModelResponse#asset_model_status #asset_model_status} => Types::AssetModelStatus
|
@@ -1511,7 +1618,8 @@ module Aws::IoTSiteWise
|
|
1511
1618
|
# resp.asset_model_properties #=> Array
|
1512
1619
|
# resp.asset_model_properties[0].id #=> String
|
1513
1620
|
# resp.asset_model_properties[0].name #=> String
|
1514
|
-
# resp.asset_model_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN"
|
1621
|
+
# resp.asset_model_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1622
|
+
# resp.asset_model_properties[0].data_type_spec #=> String
|
1515
1623
|
# resp.asset_model_properties[0].unit #=> String
|
1516
1624
|
# resp.asset_model_properties[0].type.attribute.default_value #=> String
|
1517
1625
|
# resp.asset_model_properties[0].type.transform.expression #=> String
|
@@ -1529,6 +1637,28 @@ module Aws::IoTSiteWise
|
|
1529
1637
|
# resp.asset_model_hierarchies[0].id #=> String
|
1530
1638
|
# resp.asset_model_hierarchies[0].name #=> String
|
1531
1639
|
# resp.asset_model_hierarchies[0].child_asset_model_id #=> String
|
1640
|
+
# resp.asset_model_composite_models #=> Array
|
1641
|
+
# resp.asset_model_composite_models[0].name #=> String
|
1642
|
+
# resp.asset_model_composite_models[0].description #=> String
|
1643
|
+
# resp.asset_model_composite_models[0].type #=> String
|
1644
|
+
# resp.asset_model_composite_models[0].properties #=> Array
|
1645
|
+
# resp.asset_model_composite_models[0].properties[0].id #=> String
|
1646
|
+
# resp.asset_model_composite_models[0].properties[0].name #=> String
|
1647
|
+
# resp.asset_model_composite_models[0].properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1648
|
+
# resp.asset_model_composite_models[0].properties[0].data_type_spec #=> String
|
1649
|
+
# resp.asset_model_composite_models[0].properties[0].unit #=> String
|
1650
|
+
# resp.asset_model_composite_models[0].properties[0].type.attribute.default_value #=> String
|
1651
|
+
# resp.asset_model_composite_models[0].properties[0].type.transform.expression #=> String
|
1652
|
+
# resp.asset_model_composite_models[0].properties[0].type.transform.variables #=> Array
|
1653
|
+
# resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].name #=> String
|
1654
|
+
# resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].value.property_id #=> String
|
1655
|
+
# resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].value.hierarchy_id #=> String
|
1656
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.expression #=> String
|
1657
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.variables #=> Array
|
1658
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].name #=> String
|
1659
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].value.property_id #=> String
|
1660
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].value.hierarchy_id #=> String
|
1661
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.window.tumbling.interval #=> String
|
1532
1662
|
# resp.asset_model_creation_date #=> Time
|
1533
1663
|
# resp.asset_model_last_update_date #=> Time
|
1534
1664
|
# resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
|
@@ -1576,6 +1706,7 @@ module Aws::IoTSiteWise
|
|
1576
1706
|
# * {Types::DescribeAssetPropertyResponse#asset_name #asset_name} => String
|
1577
1707
|
# * {Types::DescribeAssetPropertyResponse#asset_model_id #asset_model_id} => String
|
1578
1708
|
# * {Types::DescribeAssetPropertyResponse#asset_property #asset_property} => Types::Property
|
1709
|
+
# * {Types::DescribeAssetPropertyResponse#composite_model #composite_model} => Types::CompositeModelProperty
|
1579
1710
|
#
|
1580
1711
|
# @example Request syntax with placeholder values
|
1581
1712
|
#
|
@@ -1594,7 +1725,7 @@ module Aws::IoTSiteWise
|
|
1594
1725
|
# resp.asset_property.alias #=> String
|
1595
1726
|
# resp.asset_property.notification.topic #=> String
|
1596
1727
|
# resp.asset_property.notification.state #=> String, one of "ENABLED", "DISABLED"
|
1597
|
-
# resp.asset_property.data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN"
|
1728
|
+
# resp.asset_property.data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1598
1729
|
# resp.asset_property.unit #=> String
|
1599
1730
|
# resp.asset_property.type.attribute.default_value #=> String
|
1600
1731
|
# resp.asset_property.type.transform.expression #=> String
|
@@ -1608,6 +1739,27 @@ module Aws::IoTSiteWise
|
|
1608
1739
|
# resp.asset_property.type.metric.variables[0].value.property_id #=> String
|
1609
1740
|
# resp.asset_property.type.metric.variables[0].value.hierarchy_id #=> String
|
1610
1741
|
# resp.asset_property.type.metric.window.tumbling.interval #=> String
|
1742
|
+
# resp.composite_model.name #=> String
|
1743
|
+
# resp.composite_model.type #=> String
|
1744
|
+
# resp.composite_model.asset_property.id #=> String
|
1745
|
+
# resp.composite_model.asset_property.name #=> String
|
1746
|
+
# resp.composite_model.asset_property.alias #=> String
|
1747
|
+
# resp.composite_model.asset_property.notification.topic #=> String
|
1748
|
+
# resp.composite_model.asset_property.notification.state #=> String, one of "ENABLED", "DISABLED"
|
1749
|
+
# resp.composite_model.asset_property.data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1750
|
+
# resp.composite_model.asset_property.unit #=> String
|
1751
|
+
# resp.composite_model.asset_property.type.attribute.default_value #=> String
|
1752
|
+
# resp.composite_model.asset_property.type.transform.expression #=> String
|
1753
|
+
# resp.composite_model.asset_property.type.transform.variables #=> Array
|
1754
|
+
# resp.composite_model.asset_property.type.transform.variables[0].name #=> String
|
1755
|
+
# resp.composite_model.asset_property.type.transform.variables[0].value.property_id #=> String
|
1756
|
+
# resp.composite_model.asset_property.type.transform.variables[0].value.hierarchy_id #=> String
|
1757
|
+
# resp.composite_model.asset_property.type.metric.expression #=> String
|
1758
|
+
# resp.composite_model.asset_property.type.metric.variables #=> Array
|
1759
|
+
# resp.composite_model.asset_property.type.metric.variables[0].name #=> String
|
1760
|
+
# resp.composite_model.asset_property.type.metric.variables[0].value.property_id #=> String
|
1761
|
+
# resp.composite_model.asset_property.type.metric.variables[0].value.hierarchy_id #=> String
|
1762
|
+
# resp.composite_model.asset_property.type.metric.window.tumbling.interval #=> String
|
1611
1763
|
#
|
1612
1764
|
# @overload describe_asset_property(params = {})
|
1613
1765
|
# @param [Hash] params ({})
|
@@ -1656,6 +1808,36 @@ module Aws::IoTSiteWise
|
|
1656
1808
|
req.send_request(options)
|
1657
1809
|
end
|
1658
1810
|
|
1811
|
+
# Retrieves information about the default encryption configuration for
|
1812
|
+
# the AWS account in the default or specified region. For more
|
1813
|
+
# information, see [Key management][1] in the *AWS IoT SiteWise User
|
1814
|
+
# Guide*.
|
1815
|
+
#
|
1816
|
+
#
|
1817
|
+
#
|
1818
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html
|
1819
|
+
#
|
1820
|
+
# @return [Types::DescribeDefaultEncryptionConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1821
|
+
#
|
1822
|
+
# * {Types::DescribeDefaultEncryptionConfigurationResponse#encryption_type #encryption_type} => String
|
1823
|
+
# * {Types::DescribeDefaultEncryptionConfigurationResponse#kms_key_arn #kms_key_arn} => String
|
1824
|
+
# * {Types::DescribeDefaultEncryptionConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
|
1825
|
+
#
|
1826
|
+
# @example Response structure
|
1827
|
+
#
|
1828
|
+
# resp.encryption_type #=> String, one of "SITEWISE_DEFAULT_ENCRYPTION", "KMS_BASED_ENCRYPTION"
|
1829
|
+
# resp.kms_key_arn #=> String
|
1830
|
+
# resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
1831
|
+
# resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
1832
|
+
# resp.configuration_status.error.message #=> String
|
1833
|
+
#
|
1834
|
+
# @overload describe_default_encryption_configuration(params = {})
|
1835
|
+
# @param [Hash] params ({})
|
1836
|
+
def describe_default_encryption_configuration(params = {}, options = {})
|
1837
|
+
req = build_request(:describe_default_encryption_configuration, params)
|
1838
|
+
req.send_request(options)
|
1839
|
+
end
|
1840
|
+
|
1659
1841
|
# Retrieves information about a gateway.
|
1660
1842
|
#
|
1661
1843
|
# @option params [required, String] :gateway_id
|
@@ -2235,6 +2417,7 @@ module Aws::IoTSiteWise
|
|
2235
2417
|
# resp.access_policy_summaries[0].identity.user.id #=> String
|
2236
2418
|
# resp.access_policy_summaries[0].identity.group.id #=> String
|
2237
2419
|
# resp.access_policy_summaries[0].identity.iam_user.arn #=> String
|
2420
|
+
# resp.access_policy_summaries[0].identity.iam_role.arn #=> String
|
2238
2421
|
# resp.access_policy_summaries[0].resource.portal.id #=> String
|
2239
2422
|
# resp.access_policy_summaries[0].resource.project.id #=> String
|
2240
2423
|
# resp.access_policy_summaries[0].permission #=> String, one of "ADMINISTRATOR", "VIEWER"
|
@@ -2294,6 +2477,61 @@ module Aws::IoTSiteWise
|
|
2294
2477
|
req.send_request(options)
|
2295
2478
|
end
|
2296
2479
|
|
2480
|
+
# Retrieves a paginated list of asset relationships for an asset. You
|
2481
|
+
# can use this operation to identify an asset's root asset and all
|
2482
|
+
# associated assets between that asset and its root.
|
2483
|
+
#
|
2484
|
+
# @option params [required, String] :asset_id
|
2485
|
+
# The ID of the asset.
|
2486
|
+
#
|
2487
|
+
# @option params [required, String] :traversal_type
|
2488
|
+
# The type of traversal to use to identify asset relationships. Choose
|
2489
|
+
# the following option:
|
2490
|
+
#
|
2491
|
+
# * `PATH_TO_ROOT` – Identify the asset's parent assets up to the root
|
2492
|
+
# asset. The asset that you specify in `assetId` is the first result
|
2493
|
+
# in the list of `assetRelationshipSummaries`, and the root asset is
|
2494
|
+
# the last result.
|
2495
|
+
#
|
2496
|
+
# ^
|
2497
|
+
#
|
2498
|
+
# @option params [String] :next_token
|
2499
|
+
# The token to be used for the next set of paginated results.
|
2500
|
+
#
|
2501
|
+
# @option params [Integer] :max_results
|
2502
|
+
# The maximum number of results to be returned per paginated request.
|
2503
|
+
#
|
2504
|
+
# @return [Types::ListAssetRelationshipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2505
|
+
#
|
2506
|
+
# * {Types::ListAssetRelationshipsResponse#asset_relationship_summaries #asset_relationship_summaries} => Array<Types::AssetRelationshipSummary>
|
2507
|
+
# * {Types::ListAssetRelationshipsResponse#next_token #next_token} => String
|
2508
|
+
#
|
2509
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2510
|
+
#
|
2511
|
+
# @example Request syntax with placeholder values
|
2512
|
+
#
|
2513
|
+
# resp = client.list_asset_relationships({
|
2514
|
+
# asset_id: "ID", # required
|
2515
|
+
# traversal_type: "PATH_TO_ROOT", # required, accepts PATH_TO_ROOT
|
2516
|
+
# next_token: "NextToken",
|
2517
|
+
# max_results: 1,
|
2518
|
+
# })
|
2519
|
+
#
|
2520
|
+
# @example Response structure
|
2521
|
+
#
|
2522
|
+
# resp.asset_relationship_summaries #=> Array
|
2523
|
+
# resp.asset_relationship_summaries[0].hierarchy_info.parent_asset_id #=> String
|
2524
|
+
# resp.asset_relationship_summaries[0].hierarchy_info.child_asset_id #=> String
|
2525
|
+
# resp.asset_relationship_summaries[0].relationship_type #=> String, one of "HIERARCHY"
|
2526
|
+
# resp.next_token #=> String
|
2527
|
+
#
|
2528
|
+
# @overload list_asset_relationships(params = {})
|
2529
|
+
# @param [Hash] params ({})
|
2530
|
+
def list_asset_relationships(params = {}, options = {})
|
2531
|
+
req = build_request(:list_asset_relationships, params)
|
2532
|
+
req.send_request(options)
|
2533
|
+
end
|
2534
|
+
|
2297
2535
|
# Retrieves a paginated list of asset summaries.
|
2298
2536
|
#
|
2299
2537
|
# You can use this operation to do the following:
|
@@ -2717,6 +2955,50 @@ module Aws::IoTSiteWise
|
|
2717
2955
|
req.send_request(options)
|
2718
2956
|
end
|
2719
2957
|
|
2958
|
+
# Sets the default encryption configuration for the AWS account. For
|
2959
|
+
# more information, see [Key management][1] in the *AWS IoT SiteWise
|
2960
|
+
# User Guide*.
|
2961
|
+
#
|
2962
|
+
#
|
2963
|
+
#
|
2964
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html
|
2965
|
+
#
|
2966
|
+
# @option params [required, String] :encryption_type
|
2967
|
+
# The type of encryption used for the encryption configuration.
|
2968
|
+
#
|
2969
|
+
# @option params [String] :kms_key_id
|
2970
|
+
# The Key ID of the customer managed customer master key (CMK) used for
|
2971
|
+
# AWS KMS encryption. This is required if you use
|
2972
|
+
# `KMS_BASED_ENCRYPTION`.
|
2973
|
+
#
|
2974
|
+
# @return [Types::PutDefaultEncryptionConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2975
|
+
#
|
2976
|
+
# * {Types::PutDefaultEncryptionConfigurationResponse#encryption_type #encryption_type} => String
|
2977
|
+
# * {Types::PutDefaultEncryptionConfigurationResponse#kms_key_arn #kms_key_arn} => String
|
2978
|
+
# * {Types::PutDefaultEncryptionConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
|
2979
|
+
#
|
2980
|
+
# @example Request syntax with placeholder values
|
2981
|
+
#
|
2982
|
+
# resp = client.put_default_encryption_configuration({
|
2983
|
+
# encryption_type: "SITEWISE_DEFAULT_ENCRYPTION", # required, accepts SITEWISE_DEFAULT_ENCRYPTION, KMS_BASED_ENCRYPTION
|
2984
|
+
# kms_key_id: "KmsKeyId",
|
2985
|
+
# })
|
2986
|
+
#
|
2987
|
+
# @example Response structure
|
2988
|
+
#
|
2989
|
+
# resp.encryption_type #=> String, one of "SITEWISE_DEFAULT_ENCRYPTION", "KMS_BASED_ENCRYPTION"
|
2990
|
+
# resp.kms_key_arn #=> String
|
2991
|
+
# resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
2992
|
+
# resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
2993
|
+
# resp.configuration_status.error.message #=> String
|
2994
|
+
#
|
2995
|
+
# @overload put_default_encryption_configuration(params = {})
|
2996
|
+
# @param [Hash] params ({})
|
2997
|
+
def put_default_encryption_configuration(params = {}, options = {})
|
2998
|
+
req = build_request(:put_default_encryption_configuration, params)
|
2999
|
+
req.send_request(options)
|
3000
|
+
end
|
3001
|
+
|
2720
3002
|
# Sets logging options for AWS IoT SiteWise.
|
2721
3003
|
#
|
2722
3004
|
# @option params [required, Types::LoggingOptions] :logging_options
|
@@ -2846,6 +3128,9 @@ module Aws::IoTSiteWise
|
|
2846
3128
|
# iam_user: {
|
2847
3129
|
# arn: "ARN", # required
|
2848
3130
|
# },
|
3131
|
+
# iam_role: {
|
3132
|
+
# arn: "ARN", # required
|
3133
|
+
# },
|
2849
3134
|
# },
|
2850
3135
|
# access_policy_resource: { # required
|
2851
3136
|
# portal: {
|
@@ -2971,6 +3256,13 @@ module Aws::IoTSiteWise
|
|
2971
3256
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
|
2972
3257
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
|
2973
3258
|
#
|
3259
|
+
# @option params [Array<Types::AssetModelCompositeModel>] :asset_model_composite_models
|
3260
|
+
# The composite asset models that are part of this asset model.
|
3261
|
+
# Composite asset models are asset models that contain specific
|
3262
|
+
# properties. Each composite model has a type that defines the
|
3263
|
+
# properties that the composite model supports. Use composite asset
|
3264
|
+
# models to define alarms on this asset model.
|
3265
|
+
#
|
2974
3266
|
# @option params [String] :client_token
|
2975
3267
|
# A unique case-sensitive identifier that you can provide to ensure the
|
2976
3268
|
# idempotency of the request. Don't reuse this client token if a new
|
@@ -2993,7 +3285,8 @@ module Aws::IoTSiteWise
|
|
2993
3285
|
# {
|
2994
3286
|
# id: "ID",
|
2995
3287
|
# name: "Name", # required
|
2996
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN
|
3288
|
+
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
3289
|
+
# data_type_spec: "Name",
|
2997
3290
|
# unit: "PropertyUnit",
|
2998
3291
|
# type: { # required
|
2999
3292
|
# attribute: {
|
@@ -3040,6 +3333,58 @@ module Aws::IoTSiteWise
|
|
3040
3333
|
# child_asset_model_id: "ID", # required
|
3041
3334
|
# },
|
3042
3335
|
# ],
|
3336
|
+
# asset_model_composite_models: [
|
3337
|
+
# {
|
3338
|
+
# name: "Name", # required
|
3339
|
+
# description: "Description",
|
3340
|
+
# type: "Name", # required
|
3341
|
+
# properties: [
|
3342
|
+
# {
|
3343
|
+
# id: "ID",
|
3344
|
+
# name: "Name", # required
|
3345
|
+
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
3346
|
+
# data_type_spec: "Name",
|
3347
|
+
# unit: "PropertyUnit",
|
3348
|
+
# type: { # required
|
3349
|
+
# attribute: {
|
3350
|
+
# default_value: "DefaultValue",
|
3351
|
+
# },
|
3352
|
+
# measurement: {
|
3353
|
+
# },
|
3354
|
+
# transform: {
|
3355
|
+
# expression: "Expression", # required
|
3356
|
+
# variables: [ # required
|
3357
|
+
# {
|
3358
|
+
# name: "VariableName", # required
|
3359
|
+
# value: { # required
|
3360
|
+
# property_id: "Macro", # required
|
3361
|
+
# hierarchy_id: "Macro",
|
3362
|
+
# },
|
3363
|
+
# },
|
3364
|
+
# ],
|
3365
|
+
# },
|
3366
|
+
# metric: {
|
3367
|
+
# expression: "Expression", # required
|
3368
|
+
# variables: [ # required
|
3369
|
+
# {
|
3370
|
+
# name: "VariableName", # required
|
3371
|
+
# value: { # required
|
3372
|
+
# property_id: "Macro", # required
|
3373
|
+
# hierarchy_id: "Macro",
|
3374
|
+
# },
|
3375
|
+
# },
|
3376
|
+
# ],
|
3377
|
+
# window: { # required
|
3378
|
+
# tumbling: {
|
3379
|
+
# interval: "Interval", # required
|
3380
|
+
# },
|
3381
|
+
# },
|
3382
|
+
# },
|
3383
|
+
# },
|
3384
|
+
# },
|
3385
|
+
# ],
|
3386
|
+
# },
|
3387
|
+
# ],
|
3043
3388
|
# client_token: "ClientToken",
|
3044
3389
|
# })
|
3045
3390
|
#
|
@@ -3381,7 +3726,7 @@ module Aws::IoTSiteWise
|
|
3381
3726
|
params: params,
|
3382
3727
|
config: config)
|
3383
3728
|
context[:gem_name] = 'aws-sdk-iotsitewise'
|
3384
|
-
context[:gem_version] = '1.
|
3729
|
+
context[:gem_version] = '1.18.0'
|
3385
3730
|
Seahorse::Client::Request.new(handlers, context)
|
3386
3731
|
end
|
3387
3732
|
|