aws-sdk-iotsitewise 1.14.0 → 1.19.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 +329 -49
- data/lib/aws-sdk-iotsitewise/client_api.rb +168 -25
- data/lib/aws-sdk-iotsitewise/errors.rb +16 -0
- data/lib/aws-sdk-iotsitewise/types.rb +682 -77
- 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: 65c6de73b05e281052a2e1d0da3874c69cb2f5e4d76afa15aed4abd2e7a38fd5
|
4
|
+
data.tar.gz: 55c55f5faab24c8f2b697d591ad87a002c8f17490593b78b654436a9ae2158ac
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bb80fc1883c61547a0fb93ddd7470dcd88b3839fc54e9f061c50262b32080b34360fb4776abacab850e337c3ff1b83a5993e408c9d9b3f3781d6543d79a8a479
|
7
|
+
data.tar.gz: df94fd02acab9af3e86f3b25098533d49aec34743a8c157808c7858a783c653435dfa3ce4532210b07920f59d1113b2b35e63ad4ffe003e7c51ee190512eed02
|
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,42 +1140,6 @@ module Aws::IoTSiteWise
|
|
1079
1140
|
req.send_request(options)
|
1080
1141
|
end
|
1081
1142
|
|
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
1143
|
# Creates a project in the specified portal.
|
1119
1144
|
#
|
1120
1145
|
# @option params [required, String] :portal_id
|
@@ -1443,6 +1468,7 @@ module Aws::IoTSiteWise
|
|
1443
1468
|
# resp.access_policy_identity.user.id #=> String
|
1444
1469
|
# resp.access_policy_identity.group.id #=> String
|
1445
1470
|
# resp.access_policy_identity.iam_user.arn #=> String
|
1471
|
+
# resp.access_policy_identity.iam_role.arn #=> String
|
1446
1472
|
# resp.access_policy_resource.portal.id #=> String
|
1447
1473
|
# resp.access_policy_resource.project.id #=> String
|
1448
1474
|
# resp.access_policy_permission #=> String, one of "ADMINISTRATOR", "VIEWER"
|
@@ -1469,6 +1495,7 @@ module Aws::IoTSiteWise
|
|
1469
1495
|
# * {Types::DescribeAssetResponse#asset_model_id #asset_model_id} => String
|
1470
1496
|
# * {Types::DescribeAssetResponse#asset_properties #asset_properties} => Array<Types::AssetProperty>
|
1471
1497
|
# * {Types::DescribeAssetResponse#asset_hierarchies #asset_hierarchies} => Array<Types::AssetHierarchy>
|
1498
|
+
# * {Types::DescribeAssetResponse#asset_composite_models #asset_composite_models} => Array<Types::AssetCompositeModel>
|
1472
1499
|
# * {Types::DescribeAssetResponse#asset_creation_date #asset_creation_date} => Time
|
1473
1500
|
# * {Types::DescribeAssetResponse#asset_last_update_date #asset_last_update_date} => Time
|
1474
1501
|
# * {Types::DescribeAssetResponse#asset_status #asset_status} => Types::AssetStatus
|
@@ -1491,11 +1518,25 @@ module Aws::IoTSiteWise
|
|
1491
1518
|
# resp.asset_properties[0].alias #=> String
|
1492
1519
|
# resp.asset_properties[0].notification.topic #=> String
|
1493
1520
|
# 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"
|
1521
|
+
# resp.asset_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1522
|
+
# resp.asset_properties[0].data_type_spec #=> String
|
1495
1523
|
# resp.asset_properties[0].unit #=> String
|
1496
1524
|
# resp.asset_hierarchies #=> Array
|
1497
1525
|
# resp.asset_hierarchies[0].id #=> String
|
1498
1526
|
# resp.asset_hierarchies[0].name #=> String
|
1527
|
+
# resp.asset_composite_models #=> Array
|
1528
|
+
# resp.asset_composite_models[0].name #=> String
|
1529
|
+
# resp.asset_composite_models[0].description #=> String
|
1530
|
+
# resp.asset_composite_models[0].type #=> String
|
1531
|
+
# resp.asset_composite_models[0].properties #=> Array
|
1532
|
+
# resp.asset_composite_models[0].properties[0].id #=> String
|
1533
|
+
# resp.asset_composite_models[0].properties[0].name #=> String
|
1534
|
+
# resp.asset_composite_models[0].properties[0].alias #=> String
|
1535
|
+
# resp.asset_composite_models[0].properties[0].notification.topic #=> String
|
1536
|
+
# resp.asset_composite_models[0].properties[0].notification.state #=> String, one of "ENABLED", "DISABLED"
|
1537
|
+
# resp.asset_composite_models[0].properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1538
|
+
# resp.asset_composite_models[0].properties[0].data_type_spec #=> String
|
1539
|
+
# resp.asset_composite_models[0].properties[0].unit #=> String
|
1499
1540
|
# resp.asset_creation_date #=> Time
|
1500
1541
|
# resp.asset_last_update_date #=> Time
|
1501
1542
|
# resp.asset_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
@@ -1528,6 +1569,7 @@ module Aws::IoTSiteWise
|
|
1528
1569
|
# * {Types::DescribeAssetModelResponse#asset_model_description #asset_model_description} => String
|
1529
1570
|
# * {Types::DescribeAssetModelResponse#asset_model_properties #asset_model_properties} => Array<Types::AssetModelProperty>
|
1530
1571
|
# * {Types::DescribeAssetModelResponse#asset_model_hierarchies #asset_model_hierarchies} => Array<Types::AssetModelHierarchy>
|
1572
|
+
# * {Types::DescribeAssetModelResponse#asset_model_composite_models #asset_model_composite_models} => Array<Types::AssetModelCompositeModel>
|
1531
1573
|
# * {Types::DescribeAssetModelResponse#asset_model_creation_date #asset_model_creation_date} => Time
|
1532
1574
|
# * {Types::DescribeAssetModelResponse#asset_model_last_update_date #asset_model_last_update_date} => Time
|
1533
1575
|
# * {Types::DescribeAssetModelResponse#asset_model_status #asset_model_status} => Types::AssetModelStatus
|
@@ -1547,7 +1589,8 @@ module Aws::IoTSiteWise
|
|
1547
1589
|
# resp.asset_model_properties #=> Array
|
1548
1590
|
# resp.asset_model_properties[0].id #=> String
|
1549
1591
|
# resp.asset_model_properties[0].name #=> String
|
1550
|
-
# resp.asset_model_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN"
|
1592
|
+
# resp.asset_model_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1593
|
+
# resp.asset_model_properties[0].data_type_spec #=> String
|
1551
1594
|
# resp.asset_model_properties[0].unit #=> String
|
1552
1595
|
# resp.asset_model_properties[0].type.attribute.default_value #=> String
|
1553
1596
|
# resp.asset_model_properties[0].type.transform.expression #=> String
|
@@ -1565,6 +1608,28 @@ module Aws::IoTSiteWise
|
|
1565
1608
|
# resp.asset_model_hierarchies[0].id #=> String
|
1566
1609
|
# resp.asset_model_hierarchies[0].name #=> String
|
1567
1610
|
# resp.asset_model_hierarchies[0].child_asset_model_id #=> String
|
1611
|
+
# resp.asset_model_composite_models #=> Array
|
1612
|
+
# resp.asset_model_composite_models[0].name #=> String
|
1613
|
+
# resp.asset_model_composite_models[0].description #=> String
|
1614
|
+
# resp.asset_model_composite_models[0].type #=> String
|
1615
|
+
# resp.asset_model_composite_models[0].properties #=> Array
|
1616
|
+
# resp.asset_model_composite_models[0].properties[0].id #=> String
|
1617
|
+
# resp.asset_model_composite_models[0].properties[0].name #=> String
|
1618
|
+
# resp.asset_model_composite_models[0].properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1619
|
+
# resp.asset_model_composite_models[0].properties[0].data_type_spec #=> String
|
1620
|
+
# resp.asset_model_composite_models[0].properties[0].unit #=> String
|
1621
|
+
# resp.asset_model_composite_models[0].properties[0].type.attribute.default_value #=> String
|
1622
|
+
# resp.asset_model_composite_models[0].properties[0].type.transform.expression #=> String
|
1623
|
+
# resp.asset_model_composite_models[0].properties[0].type.transform.variables #=> Array
|
1624
|
+
# resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].name #=> String
|
1625
|
+
# resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].value.property_id #=> String
|
1626
|
+
# resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].value.hierarchy_id #=> String
|
1627
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.expression #=> String
|
1628
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.variables #=> Array
|
1629
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].name #=> String
|
1630
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].value.property_id #=> String
|
1631
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].value.hierarchy_id #=> String
|
1632
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.window.tumbling.interval #=> String
|
1568
1633
|
# resp.asset_model_creation_date #=> Time
|
1569
1634
|
# resp.asset_model_last_update_date #=> Time
|
1570
1635
|
# resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
|
@@ -1612,6 +1677,7 @@ module Aws::IoTSiteWise
|
|
1612
1677
|
# * {Types::DescribeAssetPropertyResponse#asset_name #asset_name} => String
|
1613
1678
|
# * {Types::DescribeAssetPropertyResponse#asset_model_id #asset_model_id} => String
|
1614
1679
|
# * {Types::DescribeAssetPropertyResponse#asset_property #asset_property} => Types::Property
|
1680
|
+
# * {Types::DescribeAssetPropertyResponse#composite_model #composite_model} => Types::CompositeModelProperty
|
1615
1681
|
#
|
1616
1682
|
# @example Request syntax with placeholder values
|
1617
1683
|
#
|
@@ -1630,7 +1696,7 @@ module Aws::IoTSiteWise
|
|
1630
1696
|
# resp.asset_property.alias #=> String
|
1631
1697
|
# resp.asset_property.notification.topic #=> String
|
1632
1698
|
# resp.asset_property.notification.state #=> String, one of "ENABLED", "DISABLED"
|
1633
|
-
# resp.asset_property.data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN"
|
1699
|
+
# resp.asset_property.data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1634
1700
|
# resp.asset_property.unit #=> String
|
1635
1701
|
# resp.asset_property.type.attribute.default_value #=> String
|
1636
1702
|
# resp.asset_property.type.transform.expression #=> String
|
@@ -1644,6 +1710,27 @@ module Aws::IoTSiteWise
|
|
1644
1710
|
# resp.asset_property.type.metric.variables[0].value.property_id #=> String
|
1645
1711
|
# resp.asset_property.type.metric.variables[0].value.hierarchy_id #=> String
|
1646
1712
|
# resp.asset_property.type.metric.window.tumbling.interval #=> String
|
1713
|
+
# resp.composite_model.name #=> String
|
1714
|
+
# resp.composite_model.type #=> String
|
1715
|
+
# resp.composite_model.asset_property.id #=> String
|
1716
|
+
# resp.composite_model.asset_property.name #=> String
|
1717
|
+
# resp.composite_model.asset_property.alias #=> String
|
1718
|
+
# resp.composite_model.asset_property.notification.topic #=> String
|
1719
|
+
# resp.composite_model.asset_property.notification.state #=> String, one of "ENABLED", "DISABLED"
|
1720
|
+
# resp.composite_model.asset_property.data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1721
|
+
# resp.composite_model.asset_property.unit #=> String
|
1722
|
+
# resp.composite_model.asset_property.type.attribute.default_value #=> String
|
1723
|
+
# resp.composite_model.asset_property.type.transform.expression #=> String
|
1724
|
+
# resp.composite_model.asset_property.type.transform.variables #=> Array
|
1725
|
+
# resp.composite_model.asset_property.type.transform.variables[0].name #=> String
|
1726
|
+
# resp.composite_model.asset_property.type.transform.variables[0].value.property_id #=> String
|
1727
|
+
# resp.composite_model.asset_property.type.transform.variables[0].value.hierarchy_id #=> String
|
1728
|
+
# resp.composite_model.asset_property.type.metric.expression #=> String
|
1729
|
+
# resp.composite_model.asset_property.type.metric.variables #=> Array
|
1730
|
+
# resp.composite_model.asset_property.type.metric.variables[0].name #=> String
|
1731
|
+
# resp.composite_model.asset_property.type.metric.variables[0].value.property_id #=> String
|
1732
|
+
# resp.composite_model.asset_property.type.metric.variables[0].value.hierarchy_id #=> String
|
1733
|
+
# resp.composite_model.asset_property.type.metric.window.tumbling.interval #=> String
|
1647
1734
|
#
|
1648
1735
|
# @overload describe_asset_property(params = {})
|
1649
1736
|
# @param [Hash] params ({})
|
@@ -1692,6 +1779,36 @@ module Aws::IoTSiteWise
|
|
1692
1779
|
req.send_request(options)
|
1693
1780
|
end
|
1694
1781
|
|
1782
|
+
# Retrieves information about the default encryption configuration for
|
1783
|
+
# the AWS account in the default or specified region. For more
|
1784
|
+
# information, see [Key management][1] in the *AWS IoT SiteWise User
|
1785
|
+
# Guide*.
|
1786
|
+
#
|
1787
|
+
#
|
1788
|
+
#
|
1789
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html
|
1790
|
+
#
|
1791
|
+
# @return [Types::DescribeDefaultEncryptionConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1792
|
+
#
|
1793
|
+
# * {Types::DescribeDefaultEncryptionConfigurationResponse#encryption_type #encryption_type} => String
|
1794
|
+
# * {Types::DescribeDefaultEncryptionConfigurationResponse#kms_key_arn #kms_key_arn} => String
|
1795
|
+
# * {Types::DescribeDefaultEncryptionConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
|
1796
|
+
#
|
1797
|
+
# @example Response structure
|
1798
|
+
#
|
1799
|
+
# resp.encryption_type #=> String, one of "SITEWISE_DEFAULT_ENCRYPTION", "KMS_BASED_ENCRYPTION"
|
1800
|
+
# resp.kms_key_arn #=> String
|
1801
|
+
# resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
1802
|
+
# resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
1803
|
+
# resp.configuration_status.error.message #=> String
|
1804
|
+
#
|
1805
|
+
# @overload describe_default_encryption_configuration(params = {})
|
1806
|
+
# @param [Hash] params ({})
|
1807
|
+
def describe_default_encryption_configuration(params = {}, options = {})
|
1808
|
+
req = build_request(:describe_default_encryption_configuration, params)
|
1809
|
+
req.send_request(options)
|
1810
|
+
end
|
1811
|
+
|
1695
1812
|
# Retrieves information about a gateway.
|
1696
1813
|
#
|
1697
1814
|
# @option params [required, String] :gateway_id
|
@@ -2271,6 +2388,7 @@ module Aws::IoTSiteWise
|
|
2271
2388
|
# resp.access_policy_summaries[0].identity.user.id #=> String
|
2272
2389
|
# resp.access_policy_summaries[0].identity.group.id #=> String
|
2273
2390
|
# resp.access_policy_summaries[0].identity.iam_user.arn #=> String
|
2391
|
+
# resp.access_policy_summaries[0].identity.iam_role.arn #=> String
|
2274
2392
|
# resp.access_policy_summaries[0].resource.portal.id #=> String
|
2275
2393
|
# resp.access_policy_summaries[0].resource.project.id #=> String
|
2276
2394
|
# resp.access_policy_summaries[0].permission #=> String, one of "ADMINISTRATOR", "VIEWER"
|
@@ -2330,6 +2448,61 @@ module Aws::IoTSiteWise
|
|
2330
2448
|
req.send_request(options)
|
2331
2449
|
end
|
2332
2450
|
|
2451
|
+
# Retrieves a paginated list of asset relationships for an asset. You
|
2452
|
+
# can use this operation to identify an asset's root asset and all
|
2453
|
+
# associated assets between that asset and its root.
|
2454
|
+
#
|
2455
|
+
# @option params [required, String] :asset_id
|
2456
|
+
# The ID of the asset.
|
2457
|
+
#
|
2458
|
+
# @option params [required, String] :traversal_type
|
2459
|
+
# The type of traversal to use to identify asset relationships. Choose
|
2460
|
+
# the following option:
|
2461
|
+
#
|
2462
|
+
# * `PATH_TO_ROOT` – Identify the asset's parent assets up to the root
|
2463
|
+
# asset. The asset that you specify in `assetId` is the first result
|
2464
|
+
# in the list of `assetRelationshipSummaries`, and the root asset is
|
2465
|
+
# the last result.
|
2466
|
+
#
|
2467
|
+
# ^
|
2468
|
+
#
|
2469
|
+
# @option params [String] :next_token
|
2470
|
+
# The token to be used for the next set of paginated results.
|
2471
|
+
#
|
2472
|
+
# @option params [Integer] :max_results
|
2473
|
+
# The maximum number of results to be returned per paginated request.
|
2474
|
+
#
|
2475
|
+
# @return [Types::ListAssetRelationshipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2476
|
+
#
|
2477
|
+
# * {Types::ListAssetRelationshipsResponse#asset_relationship_summaries #asset_relationship_summaries} => Array<Types::AssetRelationshipSummary>
|
2478
|
+
# * {Types::ListAssetRelationshipsResponse#next_token #next_token} => String
|
2479
|
+
#
|
2480
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2481
|
+
#
|
2482
|
+
# @example Request syntax with placeholder values
|
2483
|
+
#
|
2484
|
+
# resp = client.list_asset_relationships({
|
2485
|
+
# asset_id: "ID", # required
|
2486
|
+
# traversal_type: "PATH_TO_ROOT", # required, accepts PATH_TO_ROOT
|
2487
|
+
# next_token: "NextToken",
|
2488
|
+
# max_results: 1,
|
2489
|
+
# })
|
2490
|
+
#
|
2491
|
+
# @example Response structure
|
2492
|
+
#
|
2493
|
+
# resp.asset_relationship_summaries #=> Array
|
2494
|
+
# resp.asset_relationship_summaries[0].hierarchy_info.parent_asset_id #=> String
|
2495
|
+
# resp.asset_relationship_summaries[0].hierarchy_info.child_asset_id #=> String
|
2496
|
+
# resp.asset_relationship_summaries[0].relationship_type #=> String, one of "HIERARCHY"
|
2497
|
+
# resp.next_token #=> String
|
2498
|
+
#
|
2499
|
+
# @overload list_asset_relationships(params = {})
|
2500
|
+
# @param [Hash] params ({})
|
2501
|
+
def list_asset_relationships(params = {}, options = {})
|
2502
|
+
req = build_request(:list_asset_relationships, params)
|
2503
|
+
req.send_request(options)
|
2504
|
+
end
|
2505
|
+
|
2333
2506
|
# Retrieves a paginated list of asset summaries.
|
2334
2507
|
#
|
2335
2508
|
# You can use this operation to do the following:
|
@@ -2753,6 +2926,50 @@ module Aws::IoTSiteWise
|
|
2753
2926
|
req.send_request(options)
|
2754
2927
|
end
|
2755
2928
|
|
2929
|
+
# Sets the default encryption configuration for the AWS account. For
|
2930
|
+
# more information, see [Key management][1] in the *AWS IoT SiteWise
|
2931
|
+
# User Guide*.
|
2932
|
+
#
|
2933
|
+
#
|
2934
|
+
#
|
2935
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html
|
2936
|
+
#
|
2937
|
+
# @option params [required, String] :encryption_type
|
2938
|
+
# The type of encryption used for the encryption configuration.
|
2939
|
+
#
|
2940
|
+
# @option params [String] :kms_key_id
|
2941
|
+
# The Key ID of the customer managed customer master key (CMK) used for
|
2942
|
+
# AWS KMS encryption. This is required if you use
|
2943
|
+
# `KMS_BASED_ENCRYPTION`.
|
2944
|
+
#
|
2945
|
+
# @return [Types::PutDefaultEncryptionConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2946
|
+
#
|
2947
|
+
# * {Types::PutDefaultEncryptionConfigurationResponse#encryption_type #encryption_type} => String
|
2948
|
+
# * {Types::PutDefaultEncryptionConfigurationResponse#kms_key_arn #kms_key_arn} => String
|
2949
|
+
# * {Types::PutDefaultEncryptionConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
|
2950
|
+
#
|
2951
|
+
# @example Request syntax with placeholder values
|
2952
|
+
#
|
2953
|
+
# resp = client.put_default_encryption_configuration({
|
2954
|
+
# encryption_type: "SITEWISE_DEFAULT_ENCRYPTION", # required, accepts SITEWISE_DEFAULT_ENCRYPTION, KMS_BASED_ENCRYPTION
|
2955
|
+
# kms_key_id: "KmsKeyId",
|
2956
|
+
# })
|
2957
|
+
#
|
2958
|
+
# @example Response structure
|
2959
|
+
#
|
2960
|
+
# resp.encryption_type #=> String, one of "SITEWISE_DEFAULT_ENCRYPTION", "KMS_BASED_ENCRYPTION"
|
2961
|
+
# resp.kms_key_arn #=> String
|
2962
|
+
# resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
2963
|
+
# resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
2964
|
+
# resp.configuration_status.error.message #=> String
|
2965
|
+
#
|
2966
|
+
# @overload put_default_encryption_configuration(params = {})
|
2967
|
+
# @param [Hash] params ({})
|
2968
|
+
def put_default_encryption_configuration(params = {}, options = {})
|
2969
|
+
req = build_request(:put_default_encryption_configuration, params)
|
2970
|
+
req.send_request(options)
|
2971
|
+
end
|
2972
|
+
|
2756
2973
|
# Sets logging options for AWS IoT SiteWise.
|
2757
2974
|
#
|
2758
2975
|
# @option params [required, Types::LoggingOptions] :logging_options
|
@@ -2882,6 +3099,9 @@ module Aws::IoTSiteWise
|
|
2882
3099
|
# iam_user: {
|
2883
3100
|
# arn: "ARN", # required
|
2884
3101
|
# },
|
3102
|
+
# iam_role: {
|
3103
|
+
# arn: "ARN", # required
|
3104
|
+
# },
|
2885
3105
|
# },
|
2886
3106
|
# access_policy_resource: { # required
|
2887
3107
|
# portal: {
|
@@ -3007,6 +3227,13 @@ module Aws::IoTSiteWise
|
|
3007
3227
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
|
3008
3228
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
|
3009
3229
|
#
|
3230
|
+
# @option params [Array<Types::AssetModelCompositeModel>] :asset_model_composite_models
|
3231
|
+
# The composite asset models that are part of this asset model.
|
3232
|
+
# Composite asset models are asset models that contain specific
|
3233
|
+
# properties. Each composite model has a type that defines the
|
3234
|
+
# properties that the composite model supports. Use composite asset
|
3235
|
+
# models to define alarms on this asset model.
|
3236
|
+
#
|
3010
3237
|
# @option params [String] :client_token
|
3011
3238
|
# A unique case-sensitive identifier that you can provide to ensure the
|
3012
3239
|
# idempotency of the request. Don't reuse this client token if a new
|
@@ -3029,7 +3256,8 @@ module Aws::IoTSiteWise
|
|
3029
3256
|
# {
|
3030
3257
|
# id: "ID",
|
3031
3258
|
# name: "Name", # required
|
3032
|
-
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN
|
3259
|
+
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
3260
|
+
# data_type_spec: "Name",
|
3033
3261
|
# unit: "PropertyUnit",
|
3034
3262
|
# type: { # required
|
3035
3263
|
# attribute: {
|
@@ -3076,6 +3304,58 @@ module Aws::IoTSiteWise
|
|
3076
3304
|
# child_asset_model_id: "ID", # required
|
3077
3305
|
# },
|
3078
3306
|
# ],
|
3307
|
+
# asset_model_composite_models: [
|
3308
|
+
# {
|
3309
|
+
# name: "Name", # required
|
3310
|
+
# description: "Description",
|
3311
|
+
# type: "Name", # required
|
3312
|
+
# properties: [
|
3313
|
+
# {
|
3314
|
+
# id: "ID",
|
3315
|
+
# name: "Name", # required
|
3316
|
+
# data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
|
3317
|
+
# data_type_spec: "Name",
|
3318
|
+
# unit: "PropertyUnit",
|
3319
|
+
# type: { # required
|
3320
|
+
# attribute: {
|
3321
|
+
# default_value: "DefaultValue",
|
3322
|
+
# },
|
3323
|
+
# measurement: {
|
3324
|
+
# },
|
3325
|
+
# transform: {
|
3326
|
+
# expression: "Expression", # required
|
3327
|
+
# variables: [ # required
|
3328
|
+
# {
|
3329
|
+
# name: "VariableName", # required
|
3330
|
+
# value: { # required
|
3331
|
+
# property_id: "Macro", # required
|
3332
|
+
# hierarchy_id: "Macro",
|
3333
|
+
# },
|
3334
|
+
# },
|
3335
|
+
# ],
|
3336
|
+
# },
|
3337
|
+
# metric: {
|
3338
|
+
# expression: "Expression", # required
|
3339
|
+
# variables: [ # required
|
3340
|
+
# {
|
3341
|
+
# name: "VariableName", # required
|
3342
|
+
# value: { # required
|
3343
|
+
# property_id: "Macro", # required
|
3344
|
+
# hierarchy_id: "Macro",
|
3345
|
+
# },
|
3346
|
+
# },
|
3347
|
+
# ],
|
3348
|
+
# window: { # required
|
3349
|
+
# tumbling: {
|
3350
|
+
# interval: "Interval", # required
|
3351
|
+
# },
|
3352
|
+
# },
|
3353
|
+
# },
|
3354
|
+
# },
|
3355
|
+
# },
|
3356
|
+
# ],
|
3357
|
+
# },
|
3358
|
+
# ],
|
3079
3359
|
# client_token: "ClientToken",
|
3080
3360
|
# })
|
3081
3361
|
#
|
@@ -3417,7 +3697,7 @@ module Aws::IoTSiteWise
|
|
3417
3697
|
params: params,
|
3418
3698
|
config: config)
|
3419
3699
|
context[:gem_name] = 'aws-sdk-iotsitewise'
|
3420
|
-
context[:gem_version] = '1.
|
3700
|
+
context[:gem_version] = '1.19.0'
|
3421
3701
|
Seahorse::Client::Request.new(handlers, context)
|
3422
3702
|
end
|
3423
3703
|
|