aws-sdk-iotsitewise 1.11.0 → 1.16.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/lib/aws-sdk-iotsitewise.rb +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +321 -49
- data/lib/aws-sdk-iotsitewise/client_api.rb +163 -25
- data/lib/aws-sdk-iotsitewise/errors.rb +16 -0
- data/lib/aws-sdk-iotsitewise/types.rb +635 -73
- 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: c1c4250665f98d39db5d87fa06f8cbb5eb64e2b0c897745513eacd2cad614269
|
4
|
+
data.tar.gz: 7c2cfb619ae75781cab4b9fc07cb25914604099bdd8a61635c499ed59ba8da54
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5233fff7d8634c01cc76e27c632d3a4d62ed82f0caaa4e4c5f5249e52867bc4900c084bf8583fe644b77fd7d0379dac72eb4ebbe0f7527f6459fb5f1bce565b5
|
7
|
+
data.tar.gz: a0ed13dfa5515767b07cb1ee258746ba72a843f776d2f23629057f339a5791649bf10f295365697667a0f2e969571e50ade08813d4f01be1e239b664fbcd8810
|
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
|
@@ -736,6 +736,13 @@ module Aws::IoTSiteWise
|
|
736
736
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
|
737
737
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
|
738
738
|
#
|
739
|
+
# @option params [Array<Types::AssetModelCompositeModelDefinition>] :asset_model_composite_models
|
740
|
+
# The composite asset models that are part of this asset model.
|
741
|
+
# Composite asset models are asset models that contain specific
|
742
|
+
# properties. Each composite model has a type that defines the
|
743
|
+
# properties that the composite model supports. Use composite asset
|
744
|
+
# models to define alarms on this asset model.
|
745
|
+
#
|
739
746
|
# @option params [String] :client_token
|
740
747
|
# A unique case-sensitive identifier that you can provide to ensure the
|
741
748
|
# idempotency of the request. Don't reuse this client token if a new
|
@@ -767,7 +774,8 @@ module Aws::IoTSiteWise
|
|
767
774
|
# asset_model_properties: [
|
768
775
|
# {
|
769
776
|
# name: "Name", # required
|
770
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN
|
777
|
+
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
778
|
+
# data_type_spec: "Name",
|
771
779
|
# unit: "PropertyUnit",
|
772
780
|
# type: { # required
|
773
781
|
# attribute: {
|
@@ -813,6 +821,57 @@ module Aws::IoTSiteWise
|
|
813
821
|
# child_asset_model_id: "ID", # required
|
814
822
|
# },
|
815
823
|
# ],
|
824
|
+
# asset_model_composite_models: [
|
825
|
+
# {
|
826
|
+
# name: "Name", # required
|
827
|
+
# description: "Description",
|
828
|
+
# type: "Name", # required
|
829
|
+
# properties: [
|
830
|
+
# {
|
831
|
+
# name: "Name", # required
|
832
|
+
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
833
|
+
# data_type_spec: "Name",
|
834
|
+
# unit: "PropertyUnit",
|
835
|
+
# type: { # required
|
836
|
+
# attribute: {
|
837
|
+
# default_value: "DefaultValue",
|
838
|
+
# },
|
839
|
+
# measurement: {
|
840
|
+
# },
|
841
|
+
# transform: {
|
842
|
+
# expression: "Expression", # required
|
843
|
+
# variables: [ # required
|
844
|
+
# {
|
845
|
+
# name: "VariableName", # required
|
846
|
+
# value: { # required
|
847
|
+
# property_id: "Macro", # required
|
848
|
+
# hierarchy_id: "Macro",
|
849
|
+
# },
|
850
|
+
# },
|
851
|
+
# ],
|
852
|
+
# },
|
853
|
+
# metric: {
|
854
|
+
# expression: "Expression", # required
|
855
|
+
# variables: [ # required
|
856
|
+
# {
|
857
|
+
# name: "VariableName", # required
|
858
|
+
# value: { # required
|
859
|
+
# property_id: "Macro", # required
|
860
|
+
# hierarchy_id: "Macro",
|
861
|
+
# },
|
862
|
+
# },
|
863
|
+
# ],
|
864
|
+
# window: { # required
|
865
|
+
# tumbling: {
|
866
|
+
# interval: "Interval", # required
|
867
|
+
# },
|
868
|
+
# },
|
869
|
+
# },
|
870
|
+
# },
|
871
|
+
# },
|
872
|
+
# ],
|
873
|
+
# },
|
874
|
+
# ],
|
816
875
|
# client_token: "ClientToken",
|
817
876
|
# tags: {
|
818
877
|
# "TagKey" => "TagValue",
|
@@ -1024,9 +1083,8 @@ module Aws::IoTSiteWise
|
|
1024
1083
|
# Regions.
|
1025
1084
|
#
|
1026
1085
|
# * `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.
|
1086
|
+
# authenticate users and manage user permissions. This option is only
|
1087
|
+
# available in the China Regions.
|
1030
1088
|
#
|
1031
1089
|
# You can't change this value after you create a portal.
|
1032
1090
|
#
|
@@ -1079,42 +1137,6 @@ module Aws::IoTSiteWise
|
|
1079
1137
|
req.send_request(options)
|
1080
1138
|
end
|
1081
1139
|
|
1082
|
-
# Creates a pre-signed URL to a portal. Use this operation to create
|
1083
|
-
# URLs to portals that use AWS Identity and Access Management (IAM) to
|
1084
|
-
# authenticate users. An IAM user with access to a portal can call this
|
1085
|
-
# API to get a URL to that portal. The URL contains a session token that
|
1086
|
-
# lets the IAM user access the portal.
|
1087
|
-
#
|
1088
|
-
# @option params [required, String] :portal_id
|
1089
|
-
# The ID of the portal to access.
|
1090
|
-
#
|
1091
|
-
# @option params [Integer] :session_duration_seconds
|
1092
|
-
# The duration (in seconds) for which the session at the URL is valid.
|
1093
|
-
#
|
1094
|
-
# Default: 900 seconds (15 minutes)
|
1095
|
-
#
|
1096
|
-
# @return [Types::CreatePresignedPortalUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1097
|
-
#
|
1098
|
-
# * {Types::CreatePresignedPortalUrlResponse#presigned_portal_url #presigned_portal_url} => String
|
1099
|
-
#
|
1100
|
-
# @example Request syntax with placeholder values
|
1101
|
-
#
|
1102
|
-
# resp = client.create_presigned_portal_url({
|
1103
|
-
# portal_id: "ID", # required
|
1104
|
-
# session_duration_seconds: 1,
|
1105
|
-
# })
|
1106
|
-
#
|
1107
|
-
# @example Response structure
|
1108
|
-
#
|
1109
|
-
# resp.presigned_portal_url #=> String
|
1110
|
-
#
|
1111
|
-
# @overload create_presigned_portal_url(params = {})
|
1112
|
-
# @param [Hash] params ({})
|
1113
|
-
def create_presigned_portal_url(params = {}, options = {})
|
1114
|
-
req = build_request(:create_presigned_portal_url, params)
|
1115
|
-
req.send_request(options)
|
1116
|
-
end
|
1117
|
-
|
1118
1140
|
# Creates a project in the specified portal.
|
1119
1141
|
#
|
1120
1142
|
# @option params [required, String] :portal_id
|
@@ -1469,6 +1491,7 @@ module Aws::IoTSiteWise
|
|
1469
1491
|
# * {Types::DescribeAssetResponse#asset_model_id #asset_model_id} => String
|
1470
1492
|
# * {Types::DescribeAssetResponse#asset_properties #asset_properties} => Array<Types::AssetProperty>
|
1471
1493
|
# * {Types::DescribeAssetResponse#asset_hierarchies #asset_hierarchies} => Array<Types::AssetHierarchy>
|
1494
|
+
# * {Types::DescribeAssetResponse#asset_composite_models #asset_composite_models} => Array<Types::AssetCompositeModel>
|
1472
1495
|
# * {Types::DescribeAssetResponse#asset_creation_date #asset_creation_date} => Time
|
1473
1496
|
# * {Types::DescribeAssetResponse#asset_last_update_date #asset_last_update_date} => Time
|
1474
1497
|
# * {Types::DescribeAssetResponse#asset_status #asset_status} => Types::AssetStatus
|
@@ -1491,11 +1514,25 @@ module Aws::IoTSiteWise
|
|
1491
1514
|
# resp.asset_properties[0].alias #=> String
|
1492
1515
|
# resp.asset_properties[0].notification.topic #=> String
|
1493
1516
|
# resp.asset_properties[0].notification.state #=> String, one of "ENABLED", "DISABLED"
|
1494
|
-
# resp.asset_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN"
|
1517
|
+
# resp.asset_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1518
|
+
# resp.asset_properties[0].data_type_spec #=> String
|
1495
1519
|
# resp.asset_properties[0].unit #=> String
|
1496
1520
|
# resp.asset_hierarchies #=> Array
|
1497
1521
|
# resp.asset_hierarchies[0].id #=> String
|
1498
1522
|
# resp.asset_hierarchies[0].name #=> String
|
1523
|
+
# resp.asset_composite_models #=> Array
|
1524
|
+
# resp.asset_composite_models[0].name #=> String
|
1525
|
+
# resp.asset_composite_models[0].description #=> String
|
1526
|
+
# resp.asset_composite_models[0].type #=> String
|
1527
|
+
# resp.asset_composite_models[0].properties #=> Array
|
1528
|
+
# resp.asset_composite_models[0].properties[0].id #=> String
|
1529
|
+
# resp.asset_composite_models[0].properties[0].name #=> String
|
1530
|
+
# resp.asset_composite_models[0].properties[0].alias #=> String
|
1531
|
+
# resp.asset_composite_models[0].properties[0].notification.topic #=> String
|
1532
|
+
# resp.asset_composite_models[0].properties[0].notification.state #=> String, one of "ENABLED", "DISABLED"
|
1533
|
+
# resp.asset_composite_models[0].properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1534
|
+
# resp.asset_composite_models[0].properties[0].data_type_spec #=> String
|
1535
|
+
# resp.asset_composite_models[0].properties[0].unit #=> String
|
1499
1536
|
# resp.asset_creation_date #=> Time
|
1500
1537
|
# resp.asset_last_update_date #=> Time
|
1501
1538
|
# resp.asset_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
@@ -1528,6 +1565,7 @@ module Aws::IoTSiteWise
|
|
1528
1565
|
# * {Types::DescribeAssetModelResponse#asset_model_description #asset_model_description} => String
|
1529
1566
|
# * {Types::DescribeAssetModelResponse#asset_model_properties #asset_model_properties} => Array<Types::AssetModelProperty>
|
1530
1567
|
# * {Types::DescribeAssetModelResponse#asset_model_hierarchies #asset_model_hierarchies} => Array<Types::AssetModelHierarchy>
|
1568
|
+
# * {Types::DescribeAssetModelResponse#asset_model_composite_models #asset_model_composite_models} => Array<Types::AssetModelCompositeModel>
|
1531
1569
|
# * {Types::DescribeAssetModelResponse#asset_model_creation_date #asset_model_creation_date} => Time
|
1532
1570
|
# * {Types::DescribeAssetModelResponse#asset_model_last_update_date #asset_model_last_update_date} => Time
|
1533
1571
|
# * {Types::DescribeAssetModelResponse#asset_model_status #asset_model_status} => Types::AssetModelStatus
|
@@ -1547,7 +1585,8 @@ module Aws::IoTSiteWise
|
|
1547
1585
|
# resp.asset_model_properties #=> Array
|
1548
1586
|
# resp.asset_model_properties[0].id #=> String
|
1549
1587
|
# resp.asset_model_properties[0].name #=> String
|
1550
|
-
# resp.asset_model_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN"
|
1588
|
+
# resp.asset_model_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1589
|
+
# resp.asset_model_properties[0].data_type_spec #=> String
|
1551
1590
|
# resp.asset_model_properties[0].unit #=> String
|
1552
1591
|
# resp.asset_model_properties[0].type.attribute.default_value #=> String
|
1553
1592
|
# resp.asset_model_properties[0].type.transform.expression #=> String
|
@@ -1565,6 +1604,28 @@ module Aws::IoTSiteWise
|
|
1565
1604
|
# resp.asset_model_hierarchies[0].id #=> String
|
1566
1605
|
# resp.asset_model_hierarchies[0].name #=> String
|
1567
1606
|
# resp.asset_model_hierarchies[0].child_asset_model_id #=> String
|
1607
|
+
# resp.asset_model_composite_models #=> Array
|
1608
|
+
# resp.asset_model_composite_models[0].name #=> String
|
1609
|
+
# resp.asset_model_composite_models[0].description #=> String
|
1610
|
+
# resp.asset_model_composite_models[0].type #=> String
|
1611
|
+
# resp.asset_model_composite_models[0].properties #=> Array
|
1612
|
+
# resp.asset_model_composite_models[0].properties[0].id #=> String
|
1613
|
+
# resp.asset_model_composite_models[0].properties[0].name #=> String
|
1614
|
+
# resp.asset_model_composite_models[0].properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1615
|
+
# resp.asset_model_composite_models[0].properties[0].data_type_spec #=> String
|
1616
|
+
# resp.asset_model_composite_models[0].properties[0].unit #=> String
|
1617
|
+
# resp.asset_model_composite_models[0].properties[0].type.attribute.default_value #=> String
|
1618
|
+
# resp.asset_model_composite_models[0].properties[0].type.transform.expression #=> String
|
1619
|
+
# resp.asset_model_composite_models[0].properties[0].type.transform.variables #=> Array
|
1620
|
+
# resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].name #=> String
|
1621
|
+
# resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].value.property_id #=> String
|
1622
|
+
# resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].value.hierarchy_id #=> String
|
1623
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.expression #=> String
|
1624
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.variables #=> Array
|
1625
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].name #=> String
|
1626
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].value.property_id #=> String
|
1627
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].value.hierarchy_id #=> String
|
1628
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.window.tumbling.interval #=> String
|
1568
1629
|
# resp.asset_model_creation_date #=> Time
|
1569
1630
|
# resp.asset_model_last_update_date #=> Time
|
1570
1631
|
# resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
|
@@ -1612,6 +1673,7 @@ module Aws::IoTSiteWise
|
|
1612
1673
|
# * {Types::DescribeAssetPropertyResponse#asset_name #asset_name} => String
|
1613
1674
|
# * {Types::DescribeAssetPropertyResponse#asset_model_id #asset_model_id} => String
|
1614
1675
|
# * {Types::DescribeAssetPropertyResponse#asset_property #asset_property} => Types::Property
|
1676
|
+
# * {Types::DescribeAssetPropertyResponse#composite_model #composite_model} => Types::CompositeModelProperty
|
1615
1677
|
#
|
1616
1678
|
# @example Request syntax with placeholder values
|
1617
1679
|
#
|
@@ -1630,7 +1692,7 @@ module Aws::IoTSiteWise
|
|
1630
1692
|
# resp.asset_property.alias #=> String
|
1631
1693
|
# resp.asset_property.notification.topic #=> String
|
1632
1694
|
# resp.asset_property.notification.state #=> String, one of "ENABLED", "DISABLED"
|
1633
|
-
# resp.asset_property.data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN"
|
1695
|
+
# resp.asset_property.data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1634
1696
|
# resp.asset_property.unit #=> String
|
1635
1697
|
# resp.asset_property.type.attribute.default_value #=> String
|
1636
1698
|
# resp.asset_property.type.transform.expression #=> String
|
@@ -1644,6 +1706,27 @@ module Aws::IoTSiteWise
|
|
1644
1706
|
# resp.asset_property.type.metric.variables[0].value.property_id #=> String
|
1645
1707
|
# resp.asset_property.type.metric.variables[0].value.hierarchy_id #=> String
|
1646
1708
|
# resp.asset_property.type.metric.window.tumbling.interval #=> String
|
1709
|
+
# resp.composite_model.name #=> String
|
1710
|
+
# resp.composite_model.type #=> String
|
1711
|
+
# resp.composite_model.asset_property.id #=> String
|
1712
|
+
# resp.composite_model.asset_property.name #=> String
|
1713
|
+
# resp.composite_model.asset_property.alias #=> String
|
1714
|
+
# resp.composite_model.asset_property.notification.topic #=> String
|
1715
|
+
# resp.composite_model.asset_property.notification.state #=> String, one of "ENABLED", "DISABLED"
|
1716
|
+
# resp.composite_model.asset_property.data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1717
|
+
# resp.composite_model.asset_property.unit #=> String
|
1718
|
+
# resp.composite_model.asset_property.type.attribute.default_value #=> String
|
1719
|
+
# resp.composite_model.asset_property.type.transform.expression #=> String
|
1720
|
+
# resp.composite_model.asset_property.type.transform.variables #=> Array
|
1721
|
+
# resp.composite_model.asset_property.type.transform.variables[0].name #=> String
|
1722
|
+
# resp.composite_model.asset_property.type.transform.variables[0].value.property_id #=> String
|
1723
|
+
# resp.composite_model.asset_property.type.transform.variables[0].value.hierarchy_id #=> String
|
1724
|
+
# resp.composite_model.asset_property.type.metric.expression #=> String
|
1725
|
+
# resp.composite_model.asset_property.type.metric.variables #=> Array
|
1726
|
+
# resp.composite_model.asset_property.type.metric.variables[0].name #=> String
|
1727
|
+
# resp.composite_model.asset_property.type.metric.variables[0].value.property_id #=> String
|
1728
|
+
# resp.composite_model.asset_property.type.metric.variables[0].value.hierarchy_id #=> String
|
1729
|
+
# resp.composite_model.asset_property.type.metric.window.tumbling.interval #=> String
|
1647
1730
|
#
|
1648
1731
|
# @overload describe_asset_property(params = {})
|
1649
1732
|
# @param [Hash] params ({})
|
@@ -1692,6 +1775,36 @@ module Aws::IoTSiteWise
|
|
1692
1775
|
req.send_request(options)
|
1693
1776
|
end
|
1694
1777
|
|
1778
|
+
# Retrieves information about the default encryption configuration for
|
1779
|
+
# the AWS account in the default or specified region. For more
|
1780
|
+
# information, see [Key management][1] in the *AWS IoT SiteWise User
|
1781
|
+
# Guide*.
|
1782
|
+
#
|
1783
|
+
#
|
1784
|
+
#
|
1785
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html
|
1786
|
+
#
|
1787
|
+
# @return [Types::DescribeDefaultEncryptionConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1788
|
+
#
|
1789
|
+
# * {Types::DescribeDefaultEncryptionConfigurationResponse#encryption_type #encryption_type} => String
|
1790
|
+
# * {Types::DescribeDefaultEncryptionConfigurationResponse#kms_key_arn #kms_key_arn} => String
|
1791
|
+
# * {Types::DescribeDefaultEncryptionConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
|
1792
|
+
#
|
1793
|
+
# @example Response structure
|
1794
|
+
#
|
1795
|
+
# resp.encryption_type #=> String, one of "SITEWISE_DEFAULT_ENCRYPTION", "KMS_BASED_ENCRYPTION"
|
1796
|
+
# resp.kms_key_arn #=> String
|
1797
|
+
# resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
1798
|
+
# resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
1799
|
+
# resp.configuration_status.error.message #=> String
|
1800
|
+
#
|
1801
|
+
# @overload describe_default_encryption_configuration(params = {})
|
1802
|
+
# @param [Hash] params ({})
|
1803
|
+
def describe_default_encryption_configuration(params = {}, options = {})
|
1804
|
+
req = build_request(:describe_default_encryption_configuration, params)
|
1805
|
+
req.send_request(options)
|
1806
|
+
end
|
1807
|
+
|
1695
1808
|
# Retrieves information about a gateway.
|
1696
1809
|
#
|
1697
1810
|
# @option params [required, String] :gateway_id
|
@@ -2330,6 +2443,61 @@ module Aws::IoTSiteWise
|
|
2330
2443
|
req.send_request(options)
|
2331
2444
|
end
|
2332
2445
|
|
2446
|
+
# Retrieves a paginated list of asset relationships for an asset. You
|
2447
|
+
# can use this operation to identify an asset's root asset and all
|
2448
|
+
# associated assets between that asset and its root.
|
2449
|
+
#
|
2450
|
+
# @option params [required, String] :asset_id
|
2451
|
+
# The ID of the asset.
|
2452
|
+
#
|
2453
|
+
# @option params [required, String] :traversal_type
|
2454
|
+
# The type of traversal to use to identify asset relationships. Choose
|
2455
|
+
# the following option:
|
2456
|
+
#
|
2457
|
+
# * `PATH_TO_ROOT` – Identify the asset's parent assets up to the root
|
2458
|
+
# asset. The asset that you specify in `assetId` is the first result
|
2459
|
+
# in the list of `assetRelationshipSummaries`, and the root asset is
|
2460
|
+
# the last result.
|
2461
|
+
#
|
2462
|
+
# ^
|
2463
|
+
#
|
2464
|
+
# @option params [String] :next_token
|
2465
|
+
# The token to be used for the next set of paginated results.
|
2466
|
+
#
|
2467
|
+
# @option params [Integer] :max_results
|
2468
|
+
# The maximum number of results to be returned per paginated request.
|
2469
|
+
#
|
2470
|
+
# @return [Types::ListAssetRelationshipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2471
|
+
#
|
2472
|
+
# * {Types::ListAssetRelationshipsResponse#asset_relationship_summaries #asset_relationship_summaries} => Array<Types::AssetRelationshipSummary>
|
2473
|
+
# * {Types::ListAssetRelationshipsResponse#next_token #next_token} => String
|
2474
|
+
#
|
2475
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2476
|
+
#
|
2477
|
+
# @example Request syntax with placeholder values
|
2478
|
+
#
|
2479
|
+
# resp = client.list_asset_relationships({
|
2480
|
+
# asset_id: "ID", # required
|
2481
|
+
# traversal_type: "PATH_TO_ROOT", # required, accepts PATH_TO_ROOT
|
2482
|
+
# next_token: "NextToken",
|
2483
|
+
# max_results: 1,
|
2484
|
+
# })
|
2485
|
+
#
|
2486
|
+
# @example Response structure
|
2487
|
+
#
|
2488
|
+
# resp.asset_relationship_summaries #=> Array
|
2489
|
+
# resp.asset_relationship_summaries[0].hierarchy_info.parent_asset_id #=> String
|
2490
|
+
# resp.asset_relationship_summaries[0].hierarchy_info.child_asset_id #=> String
|
2491
|
+
# resp.asset_relationship_summaries[0].relationship_type #=> String, one of "HIERARCHY"
|
2492
|
+
# resp.next_token #=> String
|
2493
|
+
#
|
2494
|
+
# @overload list_asset_relationships(params = {})
|
2495
|
+
# @param [Hash] params ({})
|
2496
|
+
def list_asset_relationships(params = {}, options = {})
|
2497
|
+
req = build_request(:list_asset_relationships, params)
|
2498
|
+
req.send_request(options)
|
2499
|
+
end
|
2500
|
+
|
2333
2501
|
# Retrieves a paginated list of asset summaries.
|
2334
2502
|
#
|
2335
2503
|
# You can use this operation to do the following:
|
@@ -2753,6 +2921,50 @@ module Aws::IoTSiteWise
|
|
2753
2921
|
req.send_request(options)
|
2754
2922
|
end
|
2755
2923
|
|
2924
|
+
# Sets the default encryption configuration for the AWS account. For
|
2925
|
+
# more information, see [Key management][1] in the *AWS IoT SiteWise
|
2926
|
+
# User Guide*.
|
2927
|
+
#
|
2928
|
+
#
|
2929
|
+
#
|
2930
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html
|
2931
|
+
#
|
2932
|
+
# @option params [required, String] :encryption_type
|
2933
|
+
# The type of encryption used for the encryption configuration.
|
2934
|
+
#
|
2935
|
+
# @option params [String] :kms_key_id
|
2936
|
+
# The Key ID of the customer managed customer master key (CMK) used for
|
2937
|
+
# AWS KMS encryption. This is required if you use
|
2938
|
+
# `KMS_BASED_ENCRYPTION`.
|
2939
|
+
#
|
2940
|
+
# @return [Types::PutDefaultEncryptionConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2941
|
+
#
|
2942
|
+
# * {Types::PutDefaultEncryptionConfigurationResponse#encryption_type #encryption_type} => String
|
2943
|
+
# * {Types::PutDefaultEncryptionConfigurationResponse#kms_key_arn #kms_key_arn} => String
|
2944
|
+
# * {Types::PutDefaultEncryptionConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
|
2945
|
+
#
|
2946
|
+
# @example Request syntax with placeholder values
|
2947
|
+
#
|
2948
|
+
# resp = client.put_default_encryption_configuration({
|
2949
|
+
# encryption_type: "SITEWISE_DEFAULT_ENCRYPTION", # required, accepts SITEWISE_DEFAULT_ENCRYPTION, KMS_BASED_ENCRYPTION
|
2950
|
+
# kms_key_id: "KmsKeyId",
|
2951
|
+
# })
|
2952
|
+
#
|
2953
|
+
# @example Response structure
|
2954
|
+
#
|
2955
|
+
# resp.encryption_type #=> String, one of "SITEWISE_DEFAULT_ENCRYPTION", "KMS_BASED_ENCRYPTION"
|
2956
|
+
# resp.kms_key_arn #=> String
|
2957
|
+
# resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
2958
|
+
# resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
2959
|
+
# resp.configuration_status.error.message #=> String
|
2960
|
+
#
|
2961
|
+
# @overload put_default_encryption_configuration(params = {})
|
2962
|
+
# @param [Hash] params ({})
|
2963
|
+
def put_default_encryption_configuration(params = {}, options = {})
|
2964
|
+
req = build_request(:put_default_encryption_configuration, params)
|
2965
|
+
req.send_request(options)
|
2966
|
+
end
|
2967
|
+
|
2756
2968
|
# Sets logging options for AWS IoT SiteWise.
|
2757
2969
|
#
|
2758
2970
|
# @option params [required, Types::LoggingOptions] :logging_options
|
@@ -3007,6 +3219,13 @@ module Aws::IoTSiteWise
|
|
3007
3219
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
|
3008
3220
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
|
3009
3221
|
#
|
3222
|
+
# @option params [Array<Types::AssetModelCompositeModel>] :asset_model_composite_models
|
3223
|
+
# The composite asset models that are part of this asset model.
|
3224
|
+
# Composite asset models are asset models that contain specific
|
3225
|
+
# properties. Each composite model has a type that defines the
|
3226
|
+
# properties that the composite model supports. Use composite asset
|
3227
|
+
# models to define alarms on this asset model.
|
3228
|
+
#
|
3010
3229
|
# @option params [String] :client_token
|
3011
3230
|
# A unique case-sensitive identifier that you can provide to ensure the
|
3012
3231
|
# idempotency of the request. Don't reuse this client token if a new
|
@@ -3029,7 +3248,8 @@ module Aws::IoTSiteWise
|
|
3029
3248
|
# {
|
3030
3249
|
# id: "ID",
|
3031
3250
|
# name: "Name", # required
|
3032
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN
|
3251
|
+
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
3252
|
+
# data_type_spec: "Name",
|
3033
3253
|
# unit: "PropertyUnit",
|
3034
3254
|
# type: { # required
|
3035
3255
|
# attribute: {
|
@@ -3076,6 +3296,58 @@ module Aws::IoTSiteWise
|
|
3076
3296
|
# child_asset_model_id: "ID", # required
|
3077
3297
|
# },
|
3078
3298
|
# ],
|
3299
|
+
# asset_model_composite_models: [
|
3300
|
+
# {
|
3301
|
+
# name: "Name", # required
|
3302
|
+
# description: "Description",
|
3303
|
+
# type: "Name", # required
|
3304
|
+
# properties: [
|
3305
|
+
# {
|
3306
|
+
# id: "ID",
|
3307
|
+
# name: "Name", # required
|
3308
|
+
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
3309
|
+
# data_type_spec: "Name",
|
3310
|
+
# unit: "PropertyUnit",
|
3311
|
+
# type: { # required
|
3312
|
+
# attribute: {
|
3313
|
+
# default_value: "DefaultValue",
|
3314
|
+
# },
|
3315
|
+
# measurement: {
|
3316
|
+
# },
|
3317
|
+
# transform: {
|
3318
|
+
# expression: "Expression", # required
|
3319
|
+
# variables: [ # required
|
3320
|
+
# {
|
3321
|
+
# name: "VariableName", # required
|
3322
|
+
# value: { # required
|
3323
|
+
# property_id: "Macro", # required
|
3324
|
+
# hierarchy_id: "Macro",
|
3325
|
+
# },
|
3326
|
+
# },
|
3327
|
+
# ],
|
3328
|
+
# },
|
3329
|
+
# metric: {
|
3330
|
+
# expression: "Expression", # required
|
3331
|
+
# variables: [ # required
|
3332
|
+
# {
|
3333
|
+
# name: "VariableName", # required
|
3334
|
+
# value: { # required
|
3335
|
+
# property_id: "Macro", # required
|
3336
|
+
# hierarchy_id: "Macro",
|
3337
|
+
# },
|
3338
|
+
# },
|
3339
|
+
# ],
|
3340
|
+
# window: { # required
|
3341
|
+
# tumbling: {
|
3342
|
+
# interval: "Interval", # required
|
3343
|
+
# },
|
3344
|
+
# },
|
3345
|
+
# },
|
3346
|
+
# },
|
3347
|
+
# },
|
3348
|
+
# ],
|
3349
|
+
# },
|
3350
|
+
# ],
|
3079
3351
|
# client_token: "ClientToken",
|
3080
3352
|
# })
|
3081
3353
|
#
|
@@ -3417,7 +3689,7 @@ module Aws::IoTSiteWise
|
|
3417
3689
|
params: params,
|
3418
3690
|
config: config)
|
3419
3691
|
context[:gem_name] = 'aws-sdk-iotsitewise'
|
3420
|
-
context[:gem_version] = '1.
|
3692
|
+
context[:gem_version] = '1.16.0'
|
3421
3693
|
Seahorse::Client::Request.new(handlers, context)
|
3422
3694
|
end
|
3423
3695
|
|