aws-sdk-iotsitewise 1.23.0 → 1.24.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotsitewise.rb +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +278 -194
- data/lib/aws-sdk-iotsitewise/client_api.rb +60 -0
- data/lib/aws-sdk-iotsitewise/types.rb +411 -232
- metadata +2 -2
@@ -103,6 +103,7 @@ module Aws::IoTSiteWise
|
|
103
103
|
CreatePortalResponse = Shapes::StructureShape.new(name: 'CreatePortalResponse')
|
104
104
|
CreateProjectRequest = Shapes::StructureShape.new(name: 'CreateProjectRequest')
|
105
105
|
CreateProjectResponse = Shapes::StructureShape.new(name: 'CreateProjectResponse')
|
106
|
+
CustomerManagedS3Storage = Shapes::StructureShape.new(name: 'CustomerManagedS3Storage')
|
106
107
|
DashboardDefinition = Shapes::StringShape.new(name: 'DashboardDefinition')
|
107
108
|
DashboardSummaries = Shapes::ListShape.new(name: 'DashboardSummaries')
|
108
109
|
DashboardSummary = Shapes::StructureShape.new(name: 'DashboardSummary')
|
@@ -142,6 +143,8 @@ module Aws::IoTSiteWise
|
|
142
143
|
DescribePortalResponse = Shapes::StructureShape.new(name: 'DescribePortalResponse')
|
143
144
|
DescribeProjectRequest = Shapes::StructureShape.new(name: 'DescribeProjectRequest')
|
144
145
|
DescribeProjectResponse = Shapes::StructureShape.new(name: 'DescribeProjectResponse')
|
146
|
+
DescribeStorageConfigurationRequest = Shapes::StructureShape.new(name: 'DescribeStorageConfigurationRequest')
|
147
|
+
DescribeStorageConfigurationResponse = Shapes::StructureShape.new(name: 'DescribeStorageConfigurationResponse')
|
145
148
|
Description = Shapes::StringShape.new(name: 'Description')
|
146
149
|
DisassociateAssetsRequest = Shapes::StructureShape.new(name: 'DisassociateAssetsRequest')
|
147
150
|
Email = Shapes::StringShape.new(name: 'Email')
|
@@ -224,6 +227,7 @@ module Aws::IoTSiteWise
|
|
224
227
|
MonitorErrorCode = Shapes::StringShape.new(name: 'MonitorErrorCode')
|
225
228
|
MonitorErrorDetails = Shapes::StructureShape.new(name: 'MonitorErrorDetails')
|
226
229
|
MonitorErrorMessage = Shapes::StringShape.new(name: 'MonitorErrorMessage')
|
230
|
+
MultiLayerStorage = Shapes::StructureShape.new(name: 'MultiLayerStorage')
|
227
231
|
Name = Shapes::StringShape.new(name: 'Name')
|
228
232
|
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
229
233
|
OffsetInNanos = Shapes::IntegerShape.new(name: 'OffsetInNanos')
|
@@ -255,6 +259,8 @@ module Aws::IoTSiteWise
|
|
255
259
|
PutDefaultEncryptionConfigurationResponse = Shapes::StructureShape.new(name: 'PutDefaultEncryptionConfigurationResponse')
|
256
260
|
PutLoggingOptionsRequest = Shapes::StructureShape.new(name: 'PutLoggingOptionsRequest')
|
257
261
|
PutLoggingOptionsResponse = Shapes::StructureShape.new(name: 'PutLoggingOptionsResponse')
|
262
|
+
PutStorageConfigurationRequest = Shapes::StructureShape.new(name: 'PutStorageConfigurationRequest')
|
263
|
+
PutStorageConfigurationResponse = Shapes::StructureShape.new(name: 'PutStorageConfigurationResponse')
|
258
264
|
Qualities = Shapes::ListShape.new(name: 'Qualities')
|
259
265
|
Quality = Shapes::StringShape.new(name: 'Quality')
|
260
266
|
Resolution = Shapes::StringShape.new(name: 'Resolution')
|
@@ -266,6 +272,7 @@ module Aws::IoTSiteWise
|
|
266
272
|
ResourceType = Shapes::StringShape.new(name: 'ResourceType')
|
267
273
|
SSOApplicationId = Shapes::StringShape.new(name: 'SSOApplicationId')
|
268
274
|
ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
|
275
|
+
StorageType = Shapes::StringShape.new(name: 'StorageType')
|
269
276
|
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
270
277
|
TagKeyList = Shapes::ListShape.new(name: 'TagKeyList')
|
271
278
|
TagMap = Shapes::MapShape.new(name: 'TagMap')
|
@@ -634,6 +641,10 @@ module Aws::IoTSiteWise
|
|
634
641
|
CreateProjectResponse.add_member(:project_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "projectArn"))
|
635
642
|
CreateProjectResponse.struct_class = Types::CreateProjectResponse
|
636
643
|
|
644
|
+
CustomerManagedS3Storage.add_member(:s3_resource_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "s3ResourceArn"))
|
645
|
+
CustomerManagedS3Storage.add_member(:role_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "roleArn"))
|
646
|
+
CustomerManagedS3Storage.struct_class = Types::CustomerManagedS3Storage
|
647
|
+
|
637
648
|
DashboardSummaries.member = Shapes::ShapeRef.new(shape: DashboardSummary)
|
638
649
|
|
639
650
|
DashboardSummary.add_member(:id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "id"))
|
@@ -817,6 +828,14 @@ module Aws::IoTSiteWise
|
|
817
828
|
DescribeProjectResponse.add_member(:project_last_update_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "projectLastUpdateDate"))
|
818
829
|
DescribeProjectResponse.struct_class = Types::DescribeProjectResponse
|
819
830
|
|
831
|
+
DescribeStorageConfigurationRequest.struct_class = Types::DescribeStorageConfigurationRequest
|
832
|
+
|
833
|
+
DescribeStorageConfigurationResponse.add_member(:storage_type, Shapes::ShapeRef.new(shape: StorageType, required: true, location_name: "storageType"))
|
834
|
+
DescribeStorageConfigurationResponse.add_member(:multi_layer_storage, Shapes::ShapeRef.new(shape: MultiLayerStorage, location_name: "multiLayerStorage"))
|
835
|
+
DescribeStorageConfigurationResponse.add_member(:configuration_status, Shapes::ShapeRef.new(shape: ConfigurationStatus, required: true, location_name: "configurationStatus"))
|
836
|
+
DescribeStorageConfigurationResponse.add_member(:last_update_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateDate"))
|
837
|
+
DescribeStorageConfigurationResponse.struct_class = Types::DescribeStorageConfigurationResponse
|
838
|
+
|
820
839
|
DisassociateAssetsRequest.add_member(:asset_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "assetId"))
|
821
840
|
DisassociateAssetsRequest.add_member(:hierarchy_id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "hierarchyId"))
|
822
841
|
DisassociateAssetsRequest.add_member(:child_asset_id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "childAssetId"))
|
@@ -1074,6 +1093,9 @@ module Aws::IoTSiteWise
|
|
1074
1093
|
MonitorErrorDetails.add_member(:message, Shapes::ShapeRef.new(shape: MonitorErrorMessage, location_name: "message"))
|
1075
1094
|
MonitorErrorDetails.struct_class = Types::MonitorErrorDetails
|
1076
1095
|
|
1096
|
+
MultiLayerStorage.add_member(:customer_managed_s3_storage, Shapes::ShapeRef.new(shape: CustomerManagedS3Storage, required: true, location_name: "customerManagedS3Storage"))
|
1097
|
+
MultiLayerStorage.struct_class = Types::MultiLayerStorage
|
1098
|
+
|
1077
1099
|
PortalResource.add_member(:id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "id"))
|
1078
1100
|
PortalResource.struct_class = Types::PortalResource
|
1079
1101
|
|
@@ -1147,6 +1169,15 @@ module Aws::IoTSiteWise
|
|
1147
1169
|
|
1148
1170
|
PutLoggingOptionsResponse.struct_class = Types::PutLoggingOptionsResponse
|
1149
1171
|
|
1172
|
+
PutStorageConfigurationRequest.add_member(:storage_type, Shapes::ShapeRef.new(shape: StorageType, required: true, location_name: "storageType"))
|
1173
|
+
PutStorageConfigurationRequest.add_member(:multi_layer_storage, Shapes::ShapeRef.new(shape: MultiLayerStorage, location_name: "multiLayerStorage"))
|
1174
|
+
PutStorageConfigurationRequest.struct_class = Types::PutStorageConfigurationRequest
|
1175
|
+
|
1176
|
+
PutStorageConfigurationResponse.add_member(:storage_type, Shapes::ShapeRef.new(shape: StorageType, required: true, location_name: "storageType"))
|
1177
|
+
PutStorageConfigurationResponse.add_member(:multi_layer_storage, Shapes::ShapeRef.new(shape: MultiLayerStorage, location_name: "multiLayerStorage"))
|
1178
|
+
PutStorageConfigurationResponse.add_member(:configuration_status, Shapes::ShapeRef.new(shape: ConfigurationStatus, required: true, location_name: "configurationStatus"))
|
1179
|
+
PutStorageConfigurationResponse.struct_class = Types::PutStorageConfigurationResponse
|
1180
|
+
|
1150
1181
|
Qualities.member = Shapes::ShapeRef.new(shape: Quality)
|
1151
1182
|
|
1152
1183
|
Resource.add_member(:portal, Shapes::ShapeRef.new(shape: PortalResource, location_name: "portal"))
|
@@ -1766,6 +1797,20 @@ module Aws::IoTSiteWise
|
|
1766
1797
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1767
1798
|
end)
|
1768
1799
|
|
1800
|
+
api.add_operation(:describe_storage_configuration, Seahorse::Model::Operation.new.tap do |o|
|
1801
|
+
o.name = "DescribeStorageConfiguration"
|
1802
|
+
o.http_method = "GET"
|
1803
|
+
o.http_request_uri = "/configuration/account/storage"
|
1804
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeStorageConfigurationRequest)
|
1805
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeStorageConfigurationResponse)
|
1806
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1807
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1808
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
1809
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1810
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1811
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictingOperationException)
|
1812
|
+
end)
|
1813
|
+
|
1769
1814
|
api.add_operation(:disassociate_assets, Seahorse::Model::Operation.new.tap do |o|
|
1770
1815
|
o.name = "DisassociateAssets"
|
1771
1816
|
o.http_method = "POST"
|
@@ -2111,6 +2156,21 @@ module Aws::IoTSiteWise
|
|
2111
2156
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
2112
2157
|
end)
|
2113
2158
|
|
2159
|
+
api.add_operation(:put_storage_configuration, Seahorse::Model::Operation.new.tap do |o|
|
2160
|
+
o.name = "PutStorageConfiguration"
|
2161
|
+
o.http_method = "POST"
|
2162
|
+
o.http_request_uri = "/configuration/account/storage"
|
2163
|
+
o.input = Shapes::ShapeRef.new(shape: PutStorageConfigurationRequest)
|
2164
|
+
o.output = Shapes::ShapeRef.new(shape: PutStorageConfigurationResponse)
|
2165
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
2166
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceAlreadyExistsException)
|
2167
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
2168
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
2169
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
2170
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
2171
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictingOperationException)
|
2172
|
+
end)
|
2173
|
+
|
2114
2174
|
api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
|
2115
2175
|
o.name = "TagResource"
|
2116
2176
|
o.http_method = "POST"
|
@@ -10,19 +10,20 @@
|
|
10
10
|
module Aws::IoTSiteWise
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# Contains an access policy that defines an identity's access to an
|
14
|
-
#
|
13
|
+
# Contains an access policy that defines an identity's access to an IoT
|
14
|
+
# SiteWise Monitor resource.
|
15
15
|
#
|
16
16
|
# @!attribute [rw] id
|
17
17
|
# The ID of the access policy.
|
18
18
|
# @return [String]
|
19
19
|
#
|
20
20
|
# @!attribute [rw] identity
|
21
|
-
# The identity (an
|
21
|
+
# The identity (an Amazon Web Services SSO user, an Amazon Web
|
22
|
+
# Services SSO group, or an IAM user).
|
22
23
|
# @return [Types::Identity]
|
23
24
|
#
|
24
25
|
# @!attribute [rw] resource
|
25
|
-
# The
|
26
|
+
# The IoT SiteWise Monitor resource (a portal or project).
|
26
27
|
# @return [Types::Resource]
|
27
28
|
#
|
28
29
|
# @!attribute [rw] permission
|
@@ -112,10 +113,15 @@ module Aws::IoTSiteWise
|
|
112
113
|
include Aws::Structure
|
113
114
|
end
|
114
115
|
|
115
|
-
# Contains the configuration information of an alarm created in an
|
116
|
-
#
|
116
|
+
# Contains the configuration information of an alarm created in an IoT
|
117
|
+
# SiteWise Monitor portal. You can use the alarm to monitor an asset
|
117
118
|
# property and get notified when the asset property value is outside a
|
118
|
-
# specified range. For more information, see
|
119
|
+
# specified range. For more information, see [Monitoring with alarms][1]
|
120
|
+
# in the *IoT SiteWise Application Guide*.
|
121
|
+
#
|
122
|
+
#
|
123
|
+
#
|
124
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
|
119
125
|
#
|
120
126
|
# @note When making an API call, you may pass Alarms
|
121
127
|
# data as a hash:
|
@@ -127,7 +133,8 @@ module Aws::IoTSiteWise
|
|
127
133
|
#
|
128
134
|
# @!attribute [rw] alarm_role_arn
|
129
135
|
# The [ARN][1] of the IAM role that allows the alarm to perform
|
130
|
-
# actions and access
|
136
|
+
# actions and access Amazon Web Services resources and services, such
|
137
|
+
# as IoT Events.
|
131
138
|
#
|
132
139
|
#
|
133
140
|
#
|
@@ -135,14 +142,14 @@ module Aws::IoTSiteWise
|
|
135
142
|
# @return [String]
|
136
143
|
#
|
137
144
|
# @!attribute [rw] notification_lambda_arn
|
138
|
-
# The [ARN][1] of the
|
145
|
+
# The [ARN][1] of the Lambda function that manages alarm
|
139
146
|
# notifications. For more information, see [Managing alarm
|
140
|
-
# notifications][2] in the *
|
147
|
+
# notifications][2] in the *IoT Events Developer Guide*.
|
141
148
|
#
|
142
149
|
#
|
143
150
|
#
|
144
151
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
145
|
-
# [2]: https://docs.aws.amazon.com/
|
152
|
+
# [2]: https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html
|
146
153
|
# @return [String]
|
147
154
|
#
|
148
155
|
class Alarms < Struct.new(
|
@@ -660,8 +667,8 @@ module Aws::IoTSiteWise
|
|
660
667
|
end
|
661
668
|
|
662
669
|
# Contains current status information for an asset model. For more
|
663
|
-
# information, see [Asset and model states][1] in the *
|
664
|
-
#
|
670
|
+
# information, see [Asset and model states][1] in the *IoT SiteWise User
|
671
|
+
# Guide*.
|
665
672
|
#
|
666
673
|
#
|
667
674
|
#
|
@@ -685,7 +692,7 @@ module Aws::IoTSiteWise
|
|
685
692
|
# Contains a summary of an asset model.
|
686
693
|
#
|
687
694
|
# @!attribute [rw] id
|
688
|
-
# The ID of the asset model (used with
|
695
|
+
# The ID of the asset model (used with IoT SiteWise APIs).
|
689
696
|
# @return [String]
|
690
697
|
#
|
691
698
|
# @!attribute [rw] arn
|
@@ -741,11 +748,11 @@ module Aws::IoTSiteWise
|
|
741
748
|
# @return [String]
|
742
749
|
#
|
743
750
|
# @!attribute [rw] alias
|
744
|
-
# The
|
745
|
-
#
|
751
|
+
# The alias that identifies the property, such as an OPC-UA server
|
752
|
+
# data stream path (for example,
|
746
753
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
747
754
|
# see [Mapping industrial data streams to asset properties][1] in the
|
748
|
-
# *
|
755
|
+
# *IoT SiteWise User Guide*.
|
749
756
|
#
|
750
757
|
#
|
751
758
|
#
|
@@ -852,8 +859,8 @@ module Aws::IoTSiteWise
|
|
852
859
|
end
|
853
860
|
|
854
861
|
# Contains information about the current status of an asset. For more
|
855
|
-
# information, see [Asset and model states][1] in the *
|
856
|
-
#
|
862
|
+
# information, see [Asset and model states][1] in the *IoT SiteWise User
|
863
|
+
# Guide*.
|
857
864
|
#
|
858
865
|
#
|
859
866
|
#
|
@@ -946,7 +953,7 @@ module Aws::IoTSiteWise
|
|
946
953
|
# The ID of a hierarchy in the parent asset's model. Hierarchies
|
947
954
|
# allow different groupings of assets to be formed that all come from
|
948
955
|
# the same asset model. For more information, see [Asset
|
949
|
-
# hierarchies][1] in the *
|
956
|
+
# hierarchies][1] in the *IoT SiteWise User Guide*.
|
950
957
|
#
|
951
958
|
#
|
952
959
|
#
|
@@ -1030,7 +1037,7 @@ module Aws::IoTSiteWise
|
|
1030
1037
|
end
|
1031
1038
|
|
1032
1039
|
# Contains an asset attribute property. For more information, see
|
1033
|
-
# [Attributes][1] in the *
|
1040
|
+
# [Attributes][1] in the *IoT SiteWise User Guide*.
|
1034
1041
|
#
|
1035
1042
|
#
|
1036
1043
|
#
|
@@ -1047,7 +1054,7 @@ module Aws::IoTSiteWise
|
|
1047
1054
|
# The default value of the asset model property attribute. All assets
|
1048
1055
|
# that you create from the asset model contain this attribute value.
|
1049
1056
|
# You can update an attribute's value after you create an asset. For
|
1050
|
-
# more information, see [Updating attribute values][1] in the *
|
1057
|
+
# more information, see [Updating attribute values][1] in the *IoT
|
1051
1058
|
# SiteWise User Guide*.
|
1052
1059
|
#
|
1053
1060
|
#
|
@@ -1267,7 +1274,7 @@ module Aws::IoTSiteWise
|
|
1267
1274
|
include Aws::Structure
|
1268
1275
|
end
|
1269
1276
|
|
1270
|
-
# Contains the details of an
|
1277
|
+
# Contains the details of an IoT SiteWise configuration error.
|
1271
1278
|
#
|
1272
1279
|
# @!attribute [rw] code
|
1273
1280
|
# The error code.
|
@@ -1358,12 +1365,12 @@ module Aws::IoTSiteWise
|
|
1358
1365
|
# }
|
1359
1366
|
#
|
1360
1367
|
# @!attribute [rw] access_policy_identity
|
1361
|
-
# The identity for this access policy. Choose an
|
1362
|
-
# SSO group, or an IAM user.
|
1368
|
+
# The identity for this access policy. Choose an Amazon Web Services
|
1369
|
+
# SSO user, an Amazon Web Services SSO group, or an IAM user.
|
1363
1370
|
# @return [Types::Identity]
|
1364
1371
|
#
|
1365
1372
|
# @!attribute [rw] access_policy_resource
|
1366
|
-
# The
|
1373
|
+
# The IoT SiteWise Monitor resource for this access policy. Choose
|
1367
1374
|
# either a portal or a project.
|
1368
1375
|
# @return [Types::Resource]
|
1369
1376
|
#
|
@@ -1383,8 +1390,8 @@ module Aws::IoTSiteWise
|
|
1383
1390
|
#
|
1384
1391
|
# @!attribute [rw] tags
|
1385
1392
|
# A list of key-value pairs that contain metadata for the access
|
1386
|
-
# policy. For more information, see [Tagging your
|
1387
|
-
# resources][1] in the *
|
1393
|
+
# policy. For more information, see [Tagging your IoT SiteWise
|
1394
|
+
# resources][1] in the *IoT SiteWise User Guide*.
|
1388
1395
|
#
|
1389
1396
|
#
|
1390
1397
|
#
|
@@ -1545,10 +1552,10 @@ module Aws::IoTSiteWise
|
|
1545
1552
|
#
|
1546
1553
|
# @!attribute [rw] asset_model_properties
|
1547
1554
|
# The property definitions of the asset model. For more information,
|
1548
|
-
# see [Asset properties][1] in the *
|
1555
|
+
# see [Asset properties][1] in the *IoT SiteWise User Guide*.
|
1549
1556
|
#
|
1550
1557
|
# You can specify up to 200 properties per asset model. For more
|
1551
|
-
# information, see [Quotas][2] in the *
|
1558
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
1552
1559
|
#
|
1553
1560
|
#
|
1554
1561
|
#
|
@@ -1560,10 +1567,10 @@ module Aws::IoTSiteWise
|
|
1560
1567
|
# The hierarchy definitions of the asset model. Each hierarchy
|
1561
1568
|
# specifies an asset model whose assets can be children of any other
|
1562
1569
|
# assets created from this asset model. For more information, see
|
1563
|
-
# [Asset hierarchies][1] in the *
|
1570
|
+
# [Asset hierarchies][1] in the *IoT SiteWise User Guide*.
|
1564
1571
|
#
|
1565
1572
|
# You can specify up to 10 hierarchies per asset model. For more
|
1566
|
-
# information, see [Quotas][2] in the *
|
1573
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
1567
1574
|
#
|
1568
1575
|
#
|
1569
1576
|
#
|
@@ -1590,8 +1597,8 @@ module Aws::IoTSiteWise
|
|
1590
1597
|
#
|
1591
1598
|
# @!attribute [rw] tags
|
1592
1599
|
# A list of key-value pairs that contain metadata for the asset model.
|
1593
|
-
# For more information, see [Tagging your
|
1594
|
-
#
|
1600
|
+
# For more information, see [Tagging your IoT SiteWise resources][1]
|
1601
|
+
# in the *IoT SiteWise User Guide*.
|
1595
1602
|
#
|
1596
1603
|
#
|
1597
1604
|
#
|
@@ -1612,7 +1619,7 @@ module Aws::IoTSiteWise
|
|
1612
1619
|
|
1613
1620
|
# @!attribute [rw] asset_model_id
|
1614
1621
|
# The ID of the asset model. You can use this ID when you call other
|
1615
|
-
#
|
1622
|
+
# IoT SiteWise APIs.
|
1616
1623
|
# @return [String]
|
1617
1624
|
#
|
1618
1625
|
# @!attribute [rw] asset_model_arn
|
@@ -1669,8 +1676,8 @@ module Aws::IoTSiteWise
|
|
1669
1676
|
#
|
1670
1677
|
# @!attribute [rw] tags
|
1671
1678
|
# A list of key-value pairs that contain metadata for the asset. For
|
1672
|
-
# more information, see [Tagging your
|
1673
|
-
#
|
1679
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in
|
1680
|
+
# the *IoT SiteWise User Guide*.
|
1674
1681
|
#
|
1675
1682
|
#
|
1676
1683
|
#
|
@@ -1688,7 +1695,7 @@ module Aws::IoTSiteWise
|
|
1688
1695
|
|
1689
1696
|
# @!attribute [rw] asset_id
|
1690
1697
|
# The ID of the asset. This ID uniquely identifies the asset within
|
1691
|
-
#
|
1698
|
+
# IoT SiteWise and can be used with other IoT SiteWise APIs.
|
1692
1699
|
# @return [String]
|
1693
1700
|
#
|
1694
1701
|
# @!attribute [rw] asset_arn
|
@@ -1742,8 +1749,8 @@ module Aws::IoTSiteWise
|
|
1742
1749
|
#
|
1743
1750
|
# @!attribute [rw] dashboard_definition
|
1744
1751
|
# The dashboard definition specified in a JSON literal. For detailed
|
1745
|
-
# information, see [Creating dashboards (CLI)][1] in the *
|
1746
|
-
#
|
1752
|
+
# information, see [Creating dashboards (CLI)][1] in the *IoT SiteWise
|
1753
|
+
# User Guide*.
|
1747
1754
|
#
|
1748
1755
|
#
|
1749
1756
|
#
|
@@ -1761,8 +1768,8 @@ module Aws::IoTSiteWise
|
|
1761
1768
|
#
|
1762
1769
|
# @!attribute [rw] tags
|
1763
1770
|
# A list of key-value pairs that contain metadata for the dashboard.
|
1764
|
-
# For more information, see [Tagging your
|
1765
|
-
#
|
1771
|
+
# For more information, see [Tagging your IoT SiteWise resources][1]
|
1772
|
+
# in the *IoT SiteWise User Guide*.
|
1766
1773
|
#
|
1767
1774
|
#
|
1768
1775
|
#
|
@@ -1827,8 +1834,8 @@ module Aws::IoTSiteWise
|
|
1827
1834
|
#
|
1828
1835
|
# @!attribute [rw] tags
|
1829
1836
|
# A list of key-value pairs that contain metadata for the gateway. For
|
1830
|
-
# more information, see [Tagging your
|
1831
|
-
#
|
1837
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in
|
1838
|
+
# the *IoT SiteWise User Guide*.
|
1832
1839
|
#
|
1833
1840
|
#
|
1834
1841
|
#
|
@@ -1845,7 +1852,7 @@ module Aws::IoTSiteWise
|
|
1845
1852
|
|
1846
1853
|
# @!attribute [rw] gateway_id
|
1847
1854
|
# The ID of the gateway device. You can use this ID when you call
|
1848
|
-
# other
|
1855
|
+
# other IoT SiteWise APIs.
|
1849
1856
|
# @return [String]
|
1850
1857
|
#
|
1851
1858
|
# @!attribute [rw] gateway_arn
|
@@ -1898,7 +1905,7 @@ module Aws::IoTSiteWise
|
|
1898
1905
|
# @return [String]
|
1899
1906
|
#
|
1900
1907
|
# @!attribute [rw] portal_contact_email
|
1901
|
-
# The
|
1908
|
+
# The Amazon Web Services administrator's contact email address.
|
1902
1909
|
# @return [String]
|
1903
1910
|
#
|
1904
1911
|
# @!attribute [rw] client_token
|
@@ -1917,9 +1924,9 @@ module Aws::IoTSiteWise
|
|
1917
1924
|
#
|
1918
1925
|
# @!attribute [rw] role_arn
|
1919
1926
|
# The [ARN][1] of a service role that allows the portal's users to
|
1920
|
-
# access your
|
1921
|
-
# information, see [Using service roles for
|
1922
|
-
#
|
1927
|
+
# access your IoT SiteWise resources on your behalf. For more
|
1928
|
+
# information, see [Using service roles for IoT SiteWise Monitor][2]
|
1929
|
+
# in the *IoT SiteWise User Guide*.
|
1923
1930
|
#
|
1924
1931
|
#
|
1925
1932
|
#
|
@@ -1929,8 +1936,8 @@ module Aws::IoTSiteWise
|
|
1929
1936
|
#
|
1930
1937
|
# @!attribute [rw] tags
|
1931
1938
|
# A list of key-value pairs that contain metadata for the portal. For
|
1932
|
-
# more information, see [Tagging your
|
1933
|
-
#
|
1939
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in
|
1940
|
+
# the *IoT SiteWise User Guide*.
|
1934
1941
|
#
|
1935
1942
|
#
|
1936
1943
|
#
|
@@ -1941,15 +1948,16 @@ module Aws::IoTSiteWise
|
|
1941
1948
|
# The service to use to authenticate users to the portal. Choose from
|
1942
1949
|
# the following options:
|
1943
1950
|
#
|
1944
|
-
# * `SSO` – The portal uses
|
1945
|
-
# and manage user permissions. Before you can
|
1946
|
-
# uses
|
1947
|
-
#
|
1948
|
-
#
|
1949
|
-
# Regions
|
1951
|
+
# * `SSO` – The portal uses Amazon Web Services Single Sign On to
|
1952
|
+
# authenticate users and manage user permissions. Before you can
|
1953
|
+
# create a portal that uses Amazon Web Services SSO, you must enable
|
1954
|
+
# Amazon Web Services SSO. For more information, see [Enabling
|
1955
|
+
# Amazon Web Services SSO][1] in the *IoT SiteWise User Guide*. This
|
1956
|
+
# option is only available in Amazon Web Services Regions other than
|
1957
|
+
# the China Regions.
|
1950
1958
|
#
|
1951
|
-
# * `IAM` – The portal uses
|
1952
|
-
#
|
1959
|
+
# * `IAM` – The portal uses Identity and Access Management to
|
1960
|
+
# authenticate users and manage user permissions. This option is
|
1953
1961
|
# only available in the China Regions.
|
1954
1962
|
#
|
1955
1963
|
# You can't change this value after you create a portal.
|
@@ -1964,20 +1972,26 @@ module Aws::IoTSiteWise
|
|
1964
1972
|
# @!attribute [rw] notification_sender_email
|
1965
1973
|
# The email address that sends alarm notifications.
|
1966
1974
|
#
|
1967
|
-
# If you use the
|
1975
|
+
# If you use the [IoT Events managed Lambda function][1] to manage
|
1968
1976
|
# your emails, you must [verify the sender email address in Amazon
|
1969
|
-
# SES][
|
1977
|
+
# SES][2].
|
1970
1978
|
#
|
1971
1979
|
#
|
1972
1980
|
#
|
1973
|
-
# [1]: https://docs.aws.amazon.com/
|
1981
|
+
# [1]: https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html
|
1982
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html
|
1974
1983
|
# @return [String]
|
1975
1984
|
#
|
1976
1985
|
# @!attribute [rw] alarms
|
1977
|
-
# Contains the configuration information of an alarm created in an
|
1978
|
-
#
|
1979
|
-
#
|
1980
|
-
#
|
1986
|
+
# Contains the configuration information of an alarm created in an IoT
|
1987
|
+
# SiteWise Monitor portal. You can use the alarm to monitor an asset
|
1988
|
+
# property and get notified when the asset property value is outside a
|
1989
|
+
# specified range. For more information, see [Monitoring with
|
1990
|
+
# alarms][1] in the *IoT SiteWise Application Guide*.
|
1991
|
+
#
|
1992
|
+
#
|
1993
|
+
#
|
1994
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
|
1981
1995
|
# @return [Types::Alarms]
|
1982
1996
|
#
|
1983
1997
|
class CreatePortalRequest < Struct.new(
|
@@ -2010,9 +2024,9 @@ module Aws::IoTSiteWise
|
|
2010
2024
|
# @return [String]
|
2011
2025
|
#
|
2012
2026
|
# @!attribute [rw] portal_start_url
|
2013
|
-
# The URL for the
|
2014
|
-
#
|
2015
|
-
# portals that use IAM for authentication, you must use the
|
2027
|
+
# The URL for the IoT SiteWise Monitor portal. You can use this URL to
|
2028
|
+
# access portals that use Amazon Web Services SSO for authentication.
|
2029
|
+
# For portals that use IAM for authentication, you must use the IoT
|
2016
2030
|
# SiteWise console to get a URL that you can use to access the portal.
|
2017
2031
|
# @return [String]
|
2018
2032
|
#
|
@@ -2022,7 +2036,8 @@ module Aws::IoTSiteWise
|
|
2022
2036
|
# @return [Types::PortalStatus]
|
2023
2037
|
#
|
2024
2038
|
# @!attribute [rw] sso_application_id
|
2025
|
-
# The associated
|
2039
|
+
# The associated Amazon Web Services SSO application ID, if the portal
|
2040
|
+
# uses Amazon Web Services SSO.
|
2026
2041
|
# @return [String]
|
2027
2042
|
#
|
2028
2043
|
class CreatePortalResponse < Struct.new(
|
@@ -2071,8 +2086,8 @@ module Aws::IoTSiteWise
|
|
2071
2086
|
#
|
2072
2087
|
# @!attribute [rw] tags
|
2073
2088
|
# A list of key-value pairs that contain metadata for the project. For
|
2074
|
-
# more information, see [Tagging your
|
2075
|
-
#
|
2089
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in
|
2090
|
+
# the *IoT SiteWise User Guide*.
|
2076
2091
|
#
|
2077
2092
|
#
|
2078
2093
|
#
|
@@ -2110,6 +2125,43 @@ module Aws::IoTSiteWise
|
|
2110
2125
|
include Aws::Structure
|
2111
2126
|
end
|
2112
2127
|
|
2128
|
+
# Contains information about a customer managed Amazon S3 bucket.
|
2129
|
+
#
|
2130
|
+
# @note When making an API call, you may pass CustomerManagedS3Storage
|
2131
|
+
# data as a hash:
|
2132
|
+
#
|
2133
|
+
# {
|
2134
|
+
# s3_resource_arn: "ARN", # required
|
2135
|
+
# role_arn: "ARN", # required
|
2136
|
+
# }
|
2137
|
+
#
|
2138
|
+
# @!attribute [rw] s3_resource_arn
|
2139
|
+
# The [ARN][1] of the Amazon S3 object. For more information about how
|
2140
|
+
# to find the ARN for an Amazon S3 object, see [Amazon S3
|
2141
|
+
# resources][2] in the *Amazon Simple Storage Service User Guide*.
|
2142
|
+
#
|
2143
|
+
#
|
2144
|
+
#
|
2145
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
2146
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-arn-format.html
|
2147
|
+
# @return [String]
|
2148
|
+
#
|
2149
|
+
# @!attribute [rw] role_arn
|
2150
|
+
# The [ARN][1] of the Identity and Access Management role that allows
|
2151
|
+
# IoT SiteWise to send data to Amazon S3.
|
2152
|
+
#
|
2153
|
+
#
|
2154
|
+
#
|
2155
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
2156
|
+
# @return [String]
|
2157
|
+
#
|
2158
|
+
class CustomerManagedS3Storage < Struct.new(
|
2159
|
+
:s3_resource_arn,
|
2160
|
+
:role_arn)
|
2161
|
+
SENSITIVE = []
|
2162
|
+
include Aws::Structure
|
2163
|
+
end
|
2164
|
+
|
2113
2165
|
# Contains a dashboard summary.
|
2114
2166
|
#
|
2115
2167
|
# @!attribute [rw] id
|
@@ -2398,13 +2450,13 @@ module Aws::IoTSiteWise
|
|
2398
2450
|
# @return [String]
|
2399
2451
|
#
|
2400
2452
|
# @!attribute [rw] access_policy_identity
|
2401
|
-
# The identity (
|
2402
|
-
# this access policy applies.
|
2453
|
+
# The identity (Amazon Web Services SSO user, Amazon Web Services SSO
|
2454
|
+
# group, or IAM user) to which this access policy applies.
|
2403
2455
|
# @return [Types::Identity]
|
2404
2456
|
#
|
2405
2457
|
# @!attribute [rw] access_policy_resource
|
2406
|
-
# The
|
2407
|
-
#
|
2458
|
+
# The IoT SiteWise Monitor resource (portal or project) to which this
|
2459
|
+
# access policy provides access.
|
2408
2460
|
# @return [Types::Resource]
|
2409
2461
|
#
|
2410
2462
|
# @!attribute [rw] access_policy_permission
|
@@ -2705,8 +2757,7 @@ module Aws::IoTSiteWise
|
|
2705
2757
|
#
|
2706
2758
|
# @!attribute [rw] dashboard_definition
|
2707
2759
|
# The dashboard's definition JSON literal. For detailed information,
|
2708
|
-
# see [Creating dashboards (CLI)][1] in the *
|
2709
|
-
# Guide*.
|
2760
|
+
# see [Creating dashboards (CLI)][1] in the *IoT SiteWise User Guide*.
|
2710
2761
|
#
|
2711
2762
|
#
|
2712
2763
|
#
|
@@ -2744,7 +2795,7 @@ module Aws::IoTSiteWise
|
|
2744
2795
|
#
|
2745
2796
|
# @!attribute [rw] kms_key_arn
|
2746
2797
|
# The key ARN of the customer managed customer master key (CMK) used
|
2747
|
-
# for
|
2798
|
+
# for KMS encryption if you use `KMS_BASED_ENCRYPTION`.
|
2748
2799
|
# @return [String]
|
2749
2800
|
#
|
2750
2801
|
# @!attribute [rw] configuration_status
|
@@ -2775,8 +2826,8 @@ module Aws::IoTSiteWise
|
|
2775
2826
|
#
|
2776
2827
|
# @!attribute [rw] capability_namespace
|
2777
2828
|
# The namespace of the capability configuration. For example, if you
|
2778
|
-
# configure OPC-UA sources from the
|
2779
|
-
#
|
2829
|
+
# configure OPC-UA sources from the IoT SiteWise console, your OPC-UA
|
2830
|
+
# capability configuration has the namespace
|
2780
2831
|
# `iotsitewise:opcuacollector:version`, where `version` is a number
|
2781
2832
|
# such as `1`.
|
2782
2833
|
# @return [String]
|
@@ -2799,7 +2850,7 @@ module Aws::IoTSiteWise
|
|
2799
2850
|
# @!attribute [rw] capability_configuration
|
2800
2851
|
# The JSON document that defines the gateway capability's
|
2801
2852
|
# configuration. For more information, see [Configuring data sources
|
2802
|
-
# (CLI)][1] in the *
|
2853
|
+
# (CLI)][1] in the *IoT SiteWise User Guide*.
|
2803
2854
|
#
|
2804
2855
|
#
|
2805
2856
|
#
|
@@ -2951,20 +3002,21 @@ module Aws::IoTSiteWise
|
|
2951
3002
|
# @return [String]
|
2952
3003
|
#
|
2953
3004
|
# @!attribute [rw] portal_client_id
|
2954
|
-
# The
|
2955
|
-
# APIs).
|
2956
|
-
# that use
|
3005
|
+
# The Amazon Web Services SSO application generated client ID (used
|
3006
|
+
# with Amazon Web Services SSO APIs). IoT SiteWise includes
|
3007
|
+
# `portalClientId` for only portals that use Amazon Web Services SSO
|
3008
|
+
# to authenticate users.
|
2957
3009
|
# @return [String]
|
2958
3010
|
#
|
2959
3011
|
# @!attribute [rw] portal_start_url
|
2960
|
-
# The URL for the
|
2961
|
-
#
|
2962
|
-
# portals that use IAM for authentication, you must use the
|
3012
|
+
# The URL for the IoT SiteWise Monitor portal. You can use this URL to
|
3013
|
+
# access portals that use Amazon Web Services SSO for authentication.
|
3014
|
+
# For portals that use IAM for authentication, you must use the IoT
|
2963
3015
|
# SiteWise console to get a URL that you can use to access the portal.
|
2964
3016
|
# @return [String]
|
2965
3017
|
#
|
2966
3018
|
# @!attribute [rw] portal_contact_email
|
2967
|
-
# The
|
3019
|
+
# The Amazon Web Services administrator's contact email address.
|
2968
3020
|
# @return [String]
|
2969
3021
|
#
|
2970
3022
|
# @!attribute [rw] portal_status
|
@@ -2986,9 +3038,9 @@ module Aws::IoTSiteWise
|
|
2986
3038
|
#
|
2987
3039
|
# @!attribute [rw] role_arn
|
2988
3040
|
# The [ARN][1] of the service role that allows the portal's users to
|
2989
|
-
# access your
|
2990
|
-
# information, see [Using service roles for
|
2991
|
-
#
|
3041
|
+
# access your IoT SiteWise resources on your behalf. For more
|
3042
|
+
# information, see [Using service roles for IoT SiteWise Monitor][2]
|
3043
|
+
# in the *IoT SiteWise User Guide*.
|
2992
3044
|
#
|
2993
3045
|
#
|
2994
3046
|
#
|
@@ -3005,8 +3057,8 @@ module Aws::IoTSiteWise
|
|
3005
3057
|
# @return [String]
|
3006
3058
|
#
|
3007
3059
|
# @!attribute [rw] alarms
|
3008
|
-
# Contains the configuration information of an alarm created in
|
3009
|
-
#
|
3060
|
+
# Contains the configuration information of an alarm created in an IoT
|
3061
|
+
# SiteWise Monitor portal.
|
3010
3062
|
# @return [Types::Alarms]
|
3011
3063
|
#
|
3012
3064
|
class DescribePortalResponse < Struct.new(
|
@@ -3092,6 +3144,44 @@ module Aws::IoTSiteWise
|
|
3092
3144
|
include Aws::Structure
|
3093
3145
|
end
|
3094
3146
|
|
3147
|
+
# @api private
|
3148
|
+
#
|
3149
|
+
class DescribeStorageConfigurationRequest < Aws::EmptyStructure; end
|
3150
|
+
|
3151
|
+
# @!attribute [rw] storage_type
|
3152
|
+
# The type of storage that you specified for your data. The storage
|
3153
|
+
# type can be one of the following values:
|
3154
|
+
#
|
3155
|
+
# * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise replicates your data
|
3156
|
+
# into a service managed database.
|
3157
|
+
#
|
3158
|
+
# * `MULTI_LAYER_STORAGE` – IoT SiteWise replicates your data into a
|
3159
|
+
# service managed database and saves a copy of your raw data and
|
3160
|
+
# metadata in an Amazon S3 object that you specified.
|
3161
|
+
# @return [String]
|
3162
|
+
#
|
3163
|
+
# @!attribute [rw] multi_layer_storage
|
3164
|
+
# Contains information about the storage destination.
|
3165
|
+
# @return [Types::MultiLayerStorage]
|
3166
|
+
#
|
3167
|
+
# @!attribute [rw] configuration_status
|
3168
|
+
# Contains current status information for the configuration.
|
3169
|
+
# @return [Types::ConfigurationStatus]
|
3170
|
+
#
|
3171
|
+
# @!attribute [rw] last_update_date
|
3172
|
+
# The date the storage configuration was last updated, in Unix epoch
|
3173
|
+
# time.
|
3174
|
+
# @return [Time]
|
3175
|
+
#
|
3176
|
+
class DescribeStorageConfigurationResponse < Struct.new(
|
3177
|
+
:storage_type,
|
3178
|
+
:multi_layer_storage,
|
3179
|
+
:configuration_status,
|
3180
|
+
:last_update_date)
|
3181
|
+
SENSITIVE = []
|
3182
|
+
include Aws::Structure
|
3183
|
+
end
|
3184
|
+
|
3095
3185
|
# @note When making an API call, you may pass DisassociateAssetsRequest
|
3096
3186
|
# data as a hash:
|
3097
3187
|
#
|
@@ -3112,7 +3202,7 @@ module Aws::IoTSiteWise
|
|
3112
3202
|
# allow different groupings of assets to be formed that all come from
|
3113
3203
|
# the same asset model. You can use the hierarchy ID to identify the
|
3114
3204
|
# correct asset to disassociate. For more information, see [Asset
|
3115
|
-
# hierarchies][1] in the *
|
3205
|
+
# hierarchies][1] in the *IoT SiteWise User Guide*.
|
3116
3206
|
#
|
3117
3207
|
#
|
3118
3208
|
#
|
@@ -3141,7 +3231,7 @@ module Aws::IoTSiteWise
|
|
3141
3231
|
include Aws::Structure
|
3142
3232
|
end
|
3143
3233
|
|
3144
|
-
# Contains the details of an
|
3234
|
+
# Contains the details of an IoT SiteWise error.
|
3145
3235
|
#
|
3146
3236
|
# @!attribute [rw] code
|
3147
3237
|
# The error code.
|
@@ -3191,8 +3281,8 @@ module Aws::IoTSiteWise
|
|
3191
3281
|
#
|
3192
3282
|
# @!attribute [rw] capability_namespace
|
3193
3283
|
# The namespace of the capability configuration. For example, if you
|
3194
|
-
# configure OPC-UA sources from the
|
3195
|
-
#
|
3284
|
+
# configure OPC-UA sources from the IoT SiteWise console, your OPC-UA
|
3285
|
+
# capability configuration has the namespace
|
3196
3286
|
# `iotsitewise:opcuacollector:version`, where `version` is a number
|
3197
3287
|
# such as `1`.
|
3198
3288
|
# @return [String]
|
@@ -3228,7 +3318,7 @@ module Aws::IoTSiteWise
|
|
3228
3318
|
# }
|
3229
3319
|
#
|
3230
3320
|
# @!attribute [rw] greengrass
|
3231
|
-
# A gateway that runs on
|
3321
|
+
# A gateway that runs on IoT Greengrass.
|
3232
3322
|
# @return [Types::Greengrass]
|
3233
3323
|
#
|
3234
3324
|
class GatewayPlatform < Struct.new(
|
@@ -3302,11 +3392,11 @@ module Aws::IoTSiteWise
|
|
3302
3392
|
# @return [String]
|
3303
3393
|
#
|
3304
3394
|
# @!attribute [rw] property_alias
|
3305
|
-
# The
|
3306
|
-
#
|
3395
|
+
# The alias that identifies the property, such as an OPC-UA server
|
3396
|
+
# data stream path (for example,
|
3307
3397
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
3308
3398
|
# see [Mapping industrial data streams to asset properties][1] in the
|
3309
|
-
# *
|
3399
|
+
# *IoT SiteWise User Guide*.
|
3310
3400
|
#
|
3311
3401
|
#
|
3312
3402
|
#
|
@@ -3346,7 +3436,7 @@ module Aws::IoTSiteWise
|
|
3346
3436
|
# @return [String]
|
3347
3437
|
#
|
3348
3438
|
# @!attribute [rw] max_results
|
3349
|
-
# The maximum number of results to
|
3439
|
+
# The maximum number of results to return for each paginated request.
|
3350
3440
|
#
|
3351
3441
|
# Default: 100
|
3352
3442
|
# @return [Integer]
|
@@ -3407,11 +3497,11 @@ module Aws::IoTSiteWise
|
|
3407
3497
|
# @return [String]
|
3408
3498
|
#
|
3409
3499
|
# @!attribute [rw] property_alias
|
3410
|
-
# The
|
3411
|
-
#
|
3500
|
+
# The alias that identifies the property, such as an OPC-UA server
|
3501
|
+
# data stream path (for example,
|
3412
3502
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
3413
3503
|
# see [Mapping industrial data streams to asset properties][1] in the
|
3414
|
-
# *
|
3504
|
+
# *IoT SiteWise User Guide*.
|
3415
3505
|
#
|
3416
3506
|
#
|
3417
3507
|
#
|
@@ -3443,7 +3533,7 @@ module Aws::IoTSiteWise
|
|
3443
3533
|
# @return [String]
|
3444
3534
|
#
|
3445
3535
|
# @!attribute [rw] max_results
|
3446
|
-
# The maximum number of results to
|
3536
|
+
# The maximum number of results to return for each paginated request.
|
3447
3537
|
#
|
3448
3538
|
# Default: 100
|
3449
3539
|
# @return [Integer]
|
@@ -3496,11 +3586,11 @@ module Aws::IoTSiteWise
|
|
3496
3586
|
# @return [String]
|
3497
3587
|
#
|
3498
3588
|
# @!attribute [rw] property_alias
|
3499
|
-
# The
|
3500
|
-
#
|
3589
|
+
# The alias that identifies the property, such as an OPC-UA server
|
3590
|
+
# data stream path (for example,
|
3501
3591
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
3502
3592
|
# see [Mapping industrial data streams to asset properties][1] in the
|
3503
|
-
# *
|
3593
|
+
# *IoT SiteWise User Guide*.
|
3504
3594
|
#
|
3505
3595
|
#
|
3506
3596
|
#
|
@@ -3552,11 +3642,11 @@ module Aws::IoTSiteWise
|
|
3552
3642
|
# @return [String]
|
3553
3643
|
#
|
3554
3644
|
# @!attribute [rw] property_alias
|
3555
|
-
# The
|
3556
|
-
#
|
3645
|
+
# The alias that identifies the property, such as an OPC-UA server
|
3646
|
+
# data stream path (for example,
|
3557
3647
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
3558
3648
|
# see [Mapping industrial data streams to asset properties][1] in the
|
3559
|
-
# *
|
3649
|
+
# *IoT SiteWise User Guide*.
|
3560
3650
|
#
|
3561
3651
|
#
|
3562
3652
|
#
|
@@ -3597,7 +3687,7 @@ module Aws::IoTSiteWise
|
|
3597
3687
|
# @return [String]
|
3598
3688
|
#
|
3599
3689
|
# @!attribute [rw] max_results
|
3600
|
-
# The maximum number of results to
|
3690
|
+
# The maximum number of results to return for each paginated request.
|
3601
3691
|
# If not specified, the default value is 10.
|
3602
3692
|
# @return [Integer]
|
3603
3693
|
#
|
@@ -3640,12 +3730,12 @@ module Aws::IoTSiteWise
|
|
3640
3730
|
include Aws::Structure
|
3641
3731
|
end
|
3642
3732
|
|
3643
|
-
# Contains details for a gateway that runs on
|
3644
|
-
#
|
3645
|
-
#
|
3646
|
-
#
|
3647
|
-
#
|
3648
|
-
#
|
3733
|
+
# Contains details for a gateway that runs on IoT Greengrass. To create
|
3734
|
+
# a gateway that runs on IoT Greengrass, you must add the IoT SiteWise
|
3735
|
+
# connector to a Greengrass group and deploy it. Your Greengrass group
|
3736
|
+
# must also have permissions to upload data to IoT SiteWise. For more
|
3737
|
+
# information, see [Ingesting data using a gateway][1] in the *IoT
|
3738
|
+
# SiteWise User Guide*.
|
3649
3739
|
#
|
3650
3740
|
#
|
3651
3741
|
#
|
@@ -3661,7 +3751,7 @@ module Aws::IoTSiteWise
|
|
3661
3751
|
# @!attribute [rw] group_arn
|
3662
3752
|
# The [ARN][1] of the Greengrass group. For more information about how
|
3663
3753
|
# to find a group's ARN, see [ListGroups][2] and [GetGroup][3] in the
|
3664
|
-
# *
|
3754
|
+
# *IoT Greengrass API Reference*.
|
3665
3755
|
#
|
3666
3756
|
#
|
3667
3757
|
#
|
@@ -3686,7 +3776,7 @@ module Aws::IoTSiteWise
|
|
3686
3776
|
# }
|
3687
3777
|
#
|
3688
3778
|
# @!attribute [rw] id
|
3689
|
-
# The
|
3779
|
+
# The Amazon Web Services SSO ID of the group.
|
3690
3780
|
# @return [String]
|
3691
3781
|
#
|
3692
3782
|
class GroupIdentity < Struct.new(
|
@@ -3695,9 +3785,8 @@ module Aws::IoTSiteWise
|
|
3695
3785
|
include Aws::Structure
|
3696
3786
|
end
|
3697
3787
|
|
3698
|
-
# Contains information about an
|
3699
|
-
#
|
3700
|
-
# Guide*.
|
3788
|
+
# Contains information about an Identity and Access Management role. For
|
3789
|
+
# more information, see [IAM roles][1] in the *IAM User Guide*.
|
3701
3790
|
#
|
3702
3791
|
#
|
3703
3792
|
#
|
@@ -3725,8 +3814,7 @@ module Aws::IoTSiteWise
|
|
3725
3814
|
include Aws::Structure
|
3726
3815
|
end
|
3727
3816
|
|
3728
|
-
# Contains information about an
|
3729
|
-
# user.
|
3817
|
+
# Contains information about an Identity and Access Management user.
|
3730
3818
|
#
|
3731
3819
|
# @note When making an API call, you may pass IAMUserIdentity
|
3732
3820
|
# data as a hash:
|
@@ -3756,12 +3844,12 @@ module Aws::IoTSiteWise
|
|
3756
3844
|
include Aws::Structure
|
3757
3845
|
end
|
3758
3846
|
|
3759
|
-
# Contains an identity that can access an
|
3760
|
-
# resource.
|
3847
|
+
# Contains an identity that can access an IoT SiteWise Monitor resource.
|
3761
3848
|
#
|
3762
|
-
# <note markdown="1"> Currently, you can't use
|
3763
|
-
#
|
3764
|
-
# pages in the [
|
3849
|
+
# <note markdown="1"> Currently, you can't use Amazon Web Services APIs to retrieve Amazon
|
3850
|
+
# Web Services SSO identity IDs. You can find the Amazon Web Services
|
3851
|
+
# SSO identity IDs in the URL of user and group pages in the [Amazon Web
|
3852
|
+
# Services SSO console][1].
|
3765
3853
|
#
|
3766
3854
|
# </note>
|
3767
3855
|
#
|
@@ -3788,11 +3876,11 @@ module Aws::IoTSiteWise
|
|
3788
3876
|
# }
|
3789
3877
|
#
|
3790
3878
|
# @!attribute [rw] user
|
3791
|
-
# An
|
3879
|
+
# An Amazon Web Services SSO user identity.
|
3792
3880
|
# @return [Types::UserIdentity]
|
3793
3881
|
#
|
3794
3882
|
# @!attribute [rw] group
|
3795
|
-
# An
|
3883
|
+
# An Amazon Web Services SSO group identity.
|
3796
3884
|
# @return [Types::GroupIdentity]
|
3797
3885
|
#
|
3798
3886
|
# @!attribute [rw] iam_user
|
@@ -3872,8 +3960,8 @@ module Aws::IoTSiteWise
|
|
3872
3960
|
include Aws::Structure
|
3873
3961
|
end
|
3874
3962
|
|
3875
|
-
# Contains an image that is uploaded to
|
3876
|
-
#
|
3963
|
+
# Contains an image that is uploaded to IoT SiteWise and available at a
|
3964
|
+
# URL.
|
3877
3965
|
#
|
3878
3966
|
# @!attribute [rw] id
|
3879
3967
|
# The ID of the image.
|
@@ -3891,8 +3979,7 @@ module Aws::IoTSiteWise
|
|
3891
3979
|
include Aws::Structure
|
3892
3980
|
end
|
3893
3981
|
|
3894
|
-
#
|
3895
|
-
# later.
|
3982
|
+
# IoT SiteWise can't process your request right now. Try again later.
|
3896
3983
|
#
|
3897
3984
|
# @!attribute [rw] message
|
3898
3985
|
# @return [String]
|
@@ -3938,7 +4025,7 @@ module Aws::IoTSiteWise
|
|
3938
4025
|
# assets or attempting to create more than the allowed number of
|
3939
4026
|
# properties for an asset model.
|
3940
4027
|
#
|
3941
|
-
# For more information, see [Quotas][1] in the *
|
4028
|
+
# For more information, see [Quotas][1] in the *IoT SiteWise User
|
3942
4029
|
# Guide*.
|
3943
4030
|
#
|
3944
4031
|
#
|
@@ -3968,8 +4055,9 @@ module Aws::IoTSiteWise
|
|
3968
4055
|
# }
|
3969
4056
|
#
|
3970
4057
|
# @!attribute [rw] identity_type
|
3971
|
-
# The type of identity (
|
3972
|
-
# This parameter is required if you
|
4058
|
+
# The type of identity (Amazon Web Services SSO user, Amazon Web
|
4059
|
+
# Services SSO group, or IAM user). This parameter is required if you
|
4060
|
+
# specify `identityId`.
|
3973
4061
|
# @return [String]
|
3974
4062
|
#
|
3975
4063
|
# @!attribute [rw] identity_id
|
@@ -4002,7 +4090,7 @@ module Aws::IoTSiteWise
|
|
4002
4090
|
# @return [String]
|
4003
4091
|
#
|
4004
4092
|
# @!attribute [rw] max_results
|
4005
|
-
# The maximum number of results to
|
4093
|
+
# The maximum number of results to return for each paginated request.
|
4006
4094
|
#
|
4007
4095
|
# Default: 50
|
4008
4096
|
# @return [Integer]
|
@@ -4048,7 +4136,7 @@ module Aws::IoTSiteWise
|
|
4048
4136
|
# @return [String]
|
4049
4137
|
#
|
4050
4138
|
# @!attribute [rw] max_results
|
4051
|
-
# The maximum number of results to
|
4139
|
+
# The maximum number of results to return for each paginated request.
|
4052
4140
|
#
|
4053
4141
|
# Default: 50
|
4054
4142
|
# @return [Integer]
|
@@ -4107,7 +4195,7 @@ module Aws::IoTSiteWise
|
|
4107
4195
|
# @return [String]
|
4108
4196
|
#
|
4109
4197
|
# @!attribute [rw] max_results
|
4110
|
-
# The maximum number of results to
|
4198
|
+
# The maximum number of results to return for each paginated request.
|
4111
4199
|
# @return [Integer]
|
4112
4200
|
#
|
4113
4201
|
class ListAssetRelationshipsRequest < Struct.new(
|
@@ -4150,7 +4238,7 @@ module Aws::IoTSiteWise
|
|
4150
4238
|
# @return [String]
|
4151
4239
|
#
|
4152
4240
|
# @!attribute [rw] max_results
|
4153
|
-
# The maximum number of results to
|
4241
|
+
# The maximum number of results to return for each paginated request.
|
4154
4242
|
#
|
4155
4243
|
# Default: 50
|
4156
4244
|
# @return [Integer]
|
@@ -4219,7 +4307,7 @@ module Aws::IoTSiteWise
|
|
4219
4307
|
# [DescribeAssetModel][2] operations. This parameter is required if
|
4220
4308
|
# you choose `CHILD` for `traversalDirection`.
|
4221
4309
|
#
|
4222
|
-
# For more information, see [Asset hierarchies][3] in the *
|
4310
|
+
# For more information, see [Asset hierarchies][3] in the *IoT
|
4223
4311
|
# SiteWise User Guide*.
|
4224
4312
|
#
|
4225
4313
|
#
|
@@ -4247,7 +4335,7 @@ module Aws::IoTSiteWise
|
|
4247
4335
|
# @return [String]
|
4248
4336
|
#
|
4249
4337
|
# @!attribute [rw] max_results
|
4250
|
-
# The maximum number of results to
|
4338
|
+
# The maximum number of results to return for each paginated request.
|
4251
4339
|
#
|
4252
4340
|
# Default: 50
|
4253
4341
|
# @return [Integer]
|
@@ -4296,7 +4384,7 @@ module Aws::IoTSiteWise
|
|
4296
4384
|
# @return [String]
|
4297
4385
|
#
|
4298
4386
|
# @!attribute [rw] max_results
|
4299
|
-
# The maximum number of results to
|
4387
|
+
# The maximum number of results to return for each paginated request.
|
4300
4388
|
#
|
4301
4389
|
# Default: 50
|
4302
4390
|
# @return [Integer]
|
@@ -4338,7 +4426,7 @@ module Aws::IoTSiteWise
|
|
4338
4426
|
# @return [String]
|
4339
4427
|
#
|
4340
4428
|
# @!attribute [rw] max_results
|
4341
|
-
# The maximum number of results to
|
4429
|
+
# The maximum number of results to return for each paginated request.
|
4342
4430
|
#
|
4343
4431
|
# Default: 50
|
4344
4432
|
# @return [Integer]
|
@@ -4379,7 +4467,7 @@ module Aws::IoTSiteWise
|
|
4379
4467
|
# @return [String]
|
4380
4468
|
#
|
4381
4469
|
# @!attribute [rw] max_results
|
4382
|
-
# The maximum number of results to
|
4470
|
+
# The maximum number of results to return for each paginated request.
|
4383
4471
|
#
|
4384
4472
|
# Default: 50
|
4385
4473
|
# @return [Integer]
|
@@ -4425,7 +4513,7 @@ module Aws::IoTSiteWise
|
|
4425
4513
|
# @return [String]
|
4426
4514
|
#
|
4427
4515
|
# @!attribute [rw] max_results
|
4428
|
-
# The maximum number of results to
|
4516
|
+
# The maximum number of results to return for each paginated request.
|
4429
4517
|
#
|
4430
4518
|
# Default: 50
|
4431
4519
|
# @return [Integer]
|
@@ -4473,7 +4561,7 @@ module Aws::IoTSiteWise
|
|
4473
4561
|
# @return [String]
|
4474
4562
|
#
|
4475
4563
|
# @!attribute [rw] max_results
|
4476
|
-
# The maximum number of results to
|
4564
|
+
# The maximum number of results to return for each paginated request.
|
4477
4565
|
#
|
4478
4566
|
# Default: 50
|
4479
4567
|
# @return [Integer]
|
@@ -4525,8 +4613,8 @@ module Aws::IoTSiteWise
|
|
4525
4613
|
|
4526
4614
|
# @!attribute [rw] tags
|
4527
4615
|
# The list of key-value pairs that contain metadata for the resource.
|
4528
|
-
# For more information, see [Tagging your
|
4529
|
-
#
|
4616
|
+
# For more information, see [Tagging your IoT SiteWise resources][1]
|
4617
|
+
# in the *IoT SiteWise User Guide*.
|
4530
4618
|
#
|
4531
4619
|
#
|
4532
4620
|
#
|
@@ -4549,7 +4637,7 @@ module Aws::IoTSiteWise
|
|
4549
4637
|
# }
|
4550
4638
|
#
|
4551
4639
|
# @!attribute [rw] level
|
4552
|
-
# The
|
4640
|
+
# The IoT SiteWise logging verbosity level.
|
4553
4641
|
# @return [String]
|
4554
4642
|
#
|
4555
4643
|
class LoggingOptions < Struct.new(
|
@@ -4559,7 +4647,7 @@ module Aws::IoTSiteWise
|
|
4559
4647
|
end
|
4560
4648
|
|
4561
4649
|
# Contains an asset measurement property. For more information, see
|
4562
|
-
# [Measurements][1] in the *
|
4650
|
+
# [Measurements][1] in the *IoT SiteWise User Guide*.
|
4563
4651
|
#
|
4564
4652
|
#
|
4565
4653
|
#
|
@@ -4580,7 +4668,7 @@ module Aws::IoTSiteWise
|
|
4580
4668
|
# a metric can only have a data type of `DOUBLE` and consume properties
|
4581
4669
|
# with data types of `INTEGER` or `DOUBLE`.
|
4582
4670
|
#
|
4583
|
-
# For more information, see [Metrics][1] in the *
|
4671
|
+
# For more information, see [Metrics][1] in the *IoT SiteWise User
|
4584
4672
|
# Guide*.
|
4585
4673
|
#
|
4586
4674
|
#
|
@@ -4613,7 +4701,7 @@ module Aws::IoTSiteWise
|
|
4613
4701
|
# function. You can specify up to 10 variables per expression. You can
|
4614
4702
|
# specify up to 10 functions per expression.
|
4615
4703
|
#
|
4616
|
-
# For more information, see [Quotas][1] in the *
|
4704
|
+
# For more information, see [Quotas][1] in the *IoT SiteWise User
|
4617
4705
|
# Guide*.
|
4618
4706
|
#
|
4619
4707
|
#
|
@@ -4626,8 +4714,8 @@ module Aws::IoTSiteWise
|
|
4626
4714
|
# @return [Array<Types::ExpressionVariable>]
|
4627
4715
|
#
|
4628
4716
|
# @!attribute [rw] window
|
4629
|
-
# The window (time interval) over which
|
4630
|
-
# metric's aggregation expression.
|
4717
|
+
# The window (time interval) over which IoT SiteWise computes the
|
4718
|
+
# metric's aggregation expression. IoT SiteWise computes one data
|
4631
4719
|
# point per `window`.
|
4632
4720
|
# @return [Types::MetricWindow]
|
4633
4721
|
#
|
@@ -4661,7 +4749,7 @@ module Aws::IoTSiteWise
|
|
4661
4749
|
include Aws::Structure
|
4662
4750
|
end
|
4663
4751
|
|
4664
|
-
# Contains
|
4752
|
+
# Contains IoT SiteWise Monitor error details.
|
4665
4753
|
#
|
4666
4754
|
# @!attribute [rw] code
|
4667
4755
|
# The error code.
|
@@ -4678,7 +4766,29 @@ module Aws::IoTSiteWise
|
|
4678
4766
|
include Aws::Structure
|
4679
4767
|
end
|
4680
4768
|
|
4681
|
-
#
|
4769
|
+
# Contains information about the storage destination.
|
4770
|
+
#
|
4771
|
+
# @note When making an API call, you may pass MultiLayerStorage
|
4772
|
+
# data as a hash:
|
4773
|
+
#
|
4774
|
+
# {
|
4775
|
+
# customer_managed_s3_storage: { # required
|
4776
|
+
# s3_resource_arn: "ARN", # required
|
4777
|
+
# role_arn: "ARN", # required
|
4778
|
+
# },
|
4779
|
+
# }
|
4780
|
+
#
|
4781
|
+
# @!attribute [rw] customer_managed_s3_storage
|
4782
|
+
# Contains information about a customer managed Amazon S3 bucket.
|
4783
|
+
# @return [Types::CustomerManagedS3Storage]
|
4784
|
+
#
|
4785
|
+
class MultiLayerStorage < Struct.new(
|
4786
|
+
:customer_managed_s3_storage)
|
4787
|
+
SENSITIVE = []
|
4788
|
+
include Aws::Structure
|
4789
|
+
end
|
4790
|
+
|
4791
|
+
# Identifies an IoT SiteWise Monitor portal.
|
4682
4792
|
#
|
4683
4793
|
# @note When making an API call, you may pass PortalResource
|
4684
4794
|
# data as a hash:
|
@@ -4729,9 +4839,9 @@ module Aws::IoTSiteWise
|
|
4729
4839
|
# @return [String]
|
4730
4840
|
#
|
4731
4841
|
# @!attribute [rw] start_url
|
4732
|
-
# The URL for the
|
4733
|
-
#
|
4734
|
-
# portals that use IAM for authentication, you must use the
|
4842
|
+
# The URL for the IoT SiteWise Monitor portal. You can use this URL to
|
4843
|
+
# access portals that use Amazon Web Services SSO for authentication.
|
4844
|
+
# For portals that use IAM for authentication, you must use the IoT
|
4735
4845
|
# SiteWise console to get a URL that you can use to access the portal.
|
4736
4846
|
# @return [String]
|
4737
4847
|
#
|
@@ -4745,9 +4855,9 @@ module Aws::IoTSiteWise
|
|
4745
4855
|
#
|
4746
4856
|
# @!attribute [rw] role_arn
|
4747
4857
|
# The [ARN][1] of the service role that allows the portal's users to
|
4748
|
-
# access your
|
4749
|
-
# information, see [Using service roles for
|
4750
|
-
#
|
4858
|
+
# access your IoT SiteWise resources on your behalf. For more
|
4859
|
+
# information, see [Using service roles for IoT SiteWise Monitor][2]
|
4860
|
+
# in the *IoT SiteWise User Guide*.
|
4751
4861
|
#
|
4752
4862
|
#
|
4753
4863
|
#
|
@@ -4772,7 +4882,7 @@ module Aws::IoTSiteWise
|
|
4772
4882
|
include Aws::Structure
|
4773
4883
|
end
|
4774
4884
|
|
4775
|
-
# Identifies a specific
|
4885
|
+
# Identifies a specific IoT SiteWise Monitor project.
|
4776
4886
|
#
|
4777
4887
|
# @note When making an API call, you may pass ProjectResource
|
4778
4888
|
# data as a hash:
|
@@ -4834,11 +4944,11 @@ module Aws::IoTSiteWise
|
|
4834
4944
|
# @return [String]
|
4835
4945
|
#
|
4836
4946
|
# @!attribute [rw] alias
|
4837
|
-
# The
|
4838
|
-
#
|
4947
|
+
# The alias that identifies the property, such as an OPC-UA server
|
4948
|
+
# data stream path (for example,
|
4839
4949
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
4840
4950
|
# see [Mapping industrial data streams to asset properties][1] in the
|
4841
|
-
# *
|
4951
|
+
# *IoT SiteWise User Guide*.
|
4842
4952
|
#
|
4843
4953
|
#
|
4844
4954
|
#
|
@@ -4880,18 +4990,17 @@ module Aws::IoTSiteWise
|
|
4880
4990
|
end
|
4881
4991
|
|
4882
4992
|
# Contains asset property value notification information. When the
|
4883
|
-
# notification state is enabled,
|
4884
|
-
#
|
4885
|
-
#
|
4886
|
-
# Guide*.
|
4993
|
+
# notification state is enabled, IoT SiteWise publishes property value
|
4994
|
+
# updates to a unique MQTT topic. For more information, see [Interacting
|
4995
|
+
# with other services][1] in the *IoT SiteWise User Guide*.
|
4887
4996
|
#
|
4888
4997
|
#
|
4889
4998
|
#
|
4890
4999
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html
|
4891
5000
|
#
|
4892
5001
|
# @!attribute [rw] topic
|
4893
|
-
# The MQTT topic to which
|
4894
|
-
#
|
5002
|
+
# The MQTT topic to which IoT SiteWise publishes property value update
|
5003
|
+
# notifications.
|
4895
5004
|
# @return [String]
|
4896
5005
|
#
|
4897
5006
|
# @!attribute [rw] state
|
@@ -5034,11 +5143,11 @@ module Aws::IoTSiteWise
|
|
5034
5143
|
# @return [String]
|
5035
5144
|
#
|
5036
5145
|
# @!attribute [rw] property_alias
|
5037
|
-
# The
|
5038
|
-
#
|
5146
|
+
# The alias that identifies the property, such as an OPC-UA server
|
5147
|
+
# data stream path (for example,
|
5039
5148
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
5040
5149
|
# see [Mapping industrial data streams to asset properties][1] in the
|
5041
|
-
# *
|
5150
|
+
# *IoT SiteWise User Guide*.
|
5042
5151
|
#
|
5043
5152
|
#
|
5044
5153
|
#
|
@@ -5074,7 +5183,7 @@ module Aws::IoTSiteWise
|
|
5074
5183
|
#
|
5075
5184
|
# @!attribute [rw] kms_key_id
|
5076
5185
|
# The Key ID of the customer managed customer master key (CMK) used
|
5077
|
-
# for
|
5186
|
+
# for KMS encryption. This is required if you use
|
5078
5187
|
# `KMS_BASED_ENCRYPTION`.
|
5079
5188
|
# @return [String]
|
5080
5189
|
#
|
@@ -5090,8 +5199,8 @@ module Aws::IoTSiteWise
|
|
5090
5199
|
# @return [String]
|
5091
5200
|
#
|
5092
5201
|
# @!attribute [rw] kms_key_arn
|
5093
|
-
# The Key ARN of the
|
5094
|
-
#
|
5202
|
+
# The Key ARN of the KMS CMK used for KMS encryption if you use
|
5203
|
+
# `KMS_BASED_ENCRYPTION`.
|
5095
5204
|
# @return [String]
|
5096
5205
|
#
|
5097
5206
|
# @!attribute [rw] configuration_status
|
@@ -5129,8 +5238,73 @@ module Aws::IoTSiteWise
|
|
5129
5238
|
|
5130
5239
|
class PutLoggingOptionsResponse < Aws::EmptyStructure; end
|
5131
5240
|
|
5132
|
-
#
|
5133
|
-
#
|
5241
|
+
# @note When making an API call, you may pass PutStorageConfigurationRequest
|
5242
|
+
# data as a hash:
|
5243
|
+
#
|
5244
|
+
# {
|
5245
|
+
# storage_type: "SITEWISE_DEFAULT_STORAGE", # required, accepts SITEWISE_DEFAULT_STORAGE, MULTI_LAYER_STORAGE
|
5246
|
+
# multi_layer_storage: {
|
5247
|
+
# customer_managed_s3_storage: { # required
|
5248
|
+
# s3_resource_arn: "ARN", # required
|
5249
|
+
# role_arn: "ARN", # required
|
5250
|
+
# },
|
5251
|
+
# },
|
5252
|
+
# }
|
5253
|
+
#
|
5254
|
+
# @!attribute [rw] storage_type
|
5255
|
+
# The type of storage that you specified for your data. The storage
|
5256
|
+
# type can be one of the following values:
|
5257
|
+
#
|
5258
|
+
# * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise replicates your data
|
5259
|
+
# into a service managed database.
|
5260
|
+
#
|
5261
|
+
# * `MULTI_LAYER_STORAGE` – IoT SiteWise replicates your data into a
|
5262
|
+
# service managed database and saves a copy of your raw data and
|
5263
|
+
# metadata in an Amazon S3 object that you specified.
|
5264
|
+
# @return [String]
|
5265
|
+
#
|
5266
|
+
# @!attribute [rw] multi_layer_storage
|
5267
|
+
# Identifies a storage destination. If you specified
|
5268
|
+
# `MULTI_LAYER_STORAGE` for the storage type, you must specify a
|
5269
|
+
# `MultiLayerStorage` object.
|
5270
|
+
# @return [Types::MultiLayerStorage]
|
5271
|
+
#
|
5272
|
+
class PutStorageConfigurationRequest < Struct.new(
|
5273
|
+
:storage_type,
|
5274
|
+
:multi_layer_storage)
|
5275
|
+
SENSITIVE = []
|
5276
|
+
include Aws::Structure
|
5277
|
+
end
|
5278
|
+
|
5279
|
+
# @!attribute [rw] storage_type
|
5280
|
+
# The type of storage that you specified for your data. The storage
|
5281
|
+
# type can be one of the following values:
|
5282
|
+
#
|
5283
|
+
# * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise replicates your data
|
5284
|
+
# into a service managed database.
|
5285
|
+
#
|
5286
|
+
# * `MULTI_LAYER_STORAGE` – IoT SiteWise replicates your data into a
|
5287
|
+
# service managed database and saves a copy of your raw data and
|
5288
|
+
# metadata in an Amazon S3 object that you specified.
|
5289
|
+
# @return [String]
|
5290
|
+
#
|
5291
|
+
# @!attribute [rw] multi_layer_storage
|
5292
|
+
# Contains information about the storage destination.
|
5293
|
+
# @return [Types::MultiLayerStorage]
|
5294
|
+
#
|
5295
|
+
# @!attribute [rw] configuration_status
|
5296
|
+
# Contains current status information for the configuration.
|
5297
|
+
# @return [Types::ConfigurationStatus]
|
5298
|
+
#
|
5299
|
+
class PutStorageConfigurationResponse < Struct.new(
|
5300
|
+
:storage_type,
|
5301
|
+
:multi_layer_storage,
|
5302
|
+
:configuration_status)
|
5303
|
+
SENSITIVE = []
|
5304
|
+
include Aws::Structure
|
5305
|
+
end
|
5306
|
+
|
5307
|
+
# Contains an IoT SiteWise Monitor resource ID for a portal or project.
|
5134
5308
|
#
|
5135
5309
|
# @note When making an API call, you may pass Resource
|
5136
5310
|
# data as a hash:
|
@@ -5222,8 +5396,8 @@ module Aws::IoTSiteWise
|
|
5222
5396
|
#
|
5223
5397
|
# @!attribute [rw] tags
|
5224
5398
|
# A list of key-value pairs that contain metadata for the resource.
|
5225
|
-
# For more information, see [Tagging your
|
5226
|
-
#
|
5399
|
+
# For more information, see [Tagging your IoT SiteWise resources][1]
|
5400
|
+
# in the *IoT SiteWise User Guide*.
|
5227
5401
|
#
|
5228
5402
|
#
|
5229
5403
|
#
|
@@ -5240,10 +5414,10 @@ module Aws::IoTSiteWise
|
|
5240
5414
|
class TagResourceResponse < Aws::EmptyStructure; end
|
5241
5415
|
|
5242
5416
|
# Your request exceeded a rate limit. For example, you might have
|
5243
|
-
# exceeded the number of
|
5417
|
+
# exceeded the number of IoT SiteWise assets that can be created per
|
5244
5418
|
# second, the allowed number of messages per second, and so on.
|
5245
5419
|
#
|
5246
|
-
# For more information, see [Quotas][1] in the *
|
5420
|
+
# For more information, see [Quotas][1] in the *IoT SiteWise User
|
5247
5421
|
# Guide*.
|
5248
5422
|
#
|
5249
5423
|
#
|
@@ -5287,7 +5461,7 @@ module Aws::IoTSiteWise
|
|
5287
5461
|
|
5288
5462
|
# You've reached the limit for the number of tags allowed for a
|
5289
5463
|
# resource. For more information, see [Tag naming limits and
|
5290
|
-
# requirements][1] in the *
|
5464
|
+
# requirements][1] in the *Amazon Web Services General Reference*.
|
5291
5465
|
#
|
5292
5466
|
#
|
5293
5467
|
#
|
@@ -5315,8 +5489,8 @@ module Aws::IoTSiteWise
|
|
5315
5489
|
# `DOUBLE` and consume properties with data types of `INTEGER` or
|
5316
5490
|
# `DOUBLE`.
|
5317
5491
|
#
|
5318
|
-
# For more information, see [Transforms][1] in the *
|
5319
|
-
#
|
5492
|
+
# For more information, see [Transforms][1] in the *IoT SiteWise User
|
5493
|
+
# Guide*.
|
5320
5494
|
#
|
5321
5495
|
#
|
5322
5496
|
#
|
@@ -5343,7 +5517,7 @@ module Aws::IoTSiteWise
|
|
5343
5517
|
# function. You can specify up to 10 variables per expression. You can
|
5344
5518
|
# specify up to 10 functions per expression.
|
5345
5519
|
#
|
5346
|
-
# For more information, see [Quotas][1] in the *
|
5520
|
+
# For more information, see [Quotas][1] in the *IoT SiteWise User
|
5347
5521
|
# Guide*.
|
5348
5522
|
#
|
5349
5523
|
#
|
@@ -5376,15 +5550,15 @@ module Aws::IoTSiteWise
|
|
5376
5550
|
# @!attribute [rw] interval
|
5377
5551
|
# The time interval for the tumbling window. Note that `w` represents
|
5378
5552
|
# weeks, `d` represents days, `h` represents hours, and `m` represents
|
5379
|
-
# minutes.
|
5380
|
-
#
|
5381
|
-
#
|
5382
|
-
#
|
5553
|
+
# minutes. IoT SiteWise computes the `1w` interval the end of Sunday
|
5554
|
+
# at midnight each week (UTC), the `1d` interval at the end of each
|
5555
|
+
# day at midnight (UTC), the `1h` interval at the end of each hour,
|
5556
|
+
# and so on.
|
5383
5557
|
#
|
5384
|
-
# When
|
5385
|
-
#
|
5386
|
-
#
|
5387
|
-
#
|
5558
|
+
# When IoT SiteWise aggregates data points for metric computations,
|
5559
|
+
# the start of each interval is exclusive and the end of each interval
|
5560
|
+
# is inclusive. IoT SiteWise places the computed data point at the end
|
5561
|
+
# of the interval.
|
5388
5562
|
# @return [String]
|
5389
5563
|
#
|
5390
5564
|
class TumblingWindow < Struct.new(
|
@@ -5469,12 +5643,12 @@ module Aws::IoTSiteWise
|
|
5469
5643
|
# @return [String]
|
5470
5644
|
#
|
5471
5645
|
# @!attribute [rw] access_policy_identity
|
5472
|
-
# The identity for this access policy. Choose an
|
5473
|
-
# SSO group, or an IAM user.
|
5646
|
+
# The identity for this access policy. Choose an Amazon Web Services
|
5647
|
+
# SSO user, an Amazon Web Services SSO group, or an IAM user.
|
5474
5648
|
# @return [Types::Identity]
|
5475
5649
|
#
|
5476
5650
|
# @!attribute [rw] access_policy_resource
|
5477
|
-
# The
|
5651
|
+
# The IoT SiteWise Monitor resource for this access policy. Choose
|
5478
5652
|
# either a portal or a project.
|
5479
5653
|
# @return [Types::Resource]
|
5480
5654
|
#
|
@@ -5632,11 +5806,11 @@ module Aws::IoTSiteWise
|
|
5632
5806
|
#
|
5633
5807
|
# @!attribute [rw] asset_model_properties
|
5634
5808
|
# The updated property definitions of the asset model. For more
|
5635
|
-
# information, see [Asset properties][1] in the *
|
5809
|
+
# information, see [Asset properties][1] in the *IoT SiteWise User
|
5636
5810
|
# Guide*.
|
5637
5811
|
#
|
5638
5812
|
# You can specify up to 200 properties per asset model. For more
|
5639
|
-
# information, see [Quotas][2] in the *
|
5813
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
5640
5814
|
#
|
5641
5815
|
#
|
5642
5816
|
#
|
@@ -5648,10 +5822,10 @@ module Aws::IoTSiteWise
|
|
5648
5822
|
# The updated hierarchy definitions of the asset model. Each hierarchy
|
5649
5823
|
# specifies an asset model whose assets can be children of any other
|
5650
5824
|
# assets created from this asset model. For more information, see
|
5651
|
-
# [Asset hierarchies][1] in the *
|
5825
|
+
# [Asset hierarchies][1] in the *IoT SiteWise User Guide*.
|
5652
5826
|
#
|
5653
5827
|
# You can specify up to 10 hierarchies per asset model. For more
|
5654
|
-
# information, see [Quotas][2] in the *
|
5828
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
5655
5829
|
#
|
5656
5830
|
#
|
5657
5831
|
#
|
@@ -5719,11 +5893,11 @@ module Aws::IoTSiteWise
|
|
5719
5893
|
# @return [String]
|
5720
5894
|
#
|
5721
5895
|
# @!attribute [rw] property_alias
|
5722
|
-
# The
|
5723
|
-
#
|
5896
|
+
# The alias that identifies the property, such as an OPC-UA server
|
5897
|
+
# data stream path (for example,
|
5724
5898
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
5725
5899
|
# see [Mapping industrial data streams to asset properties][1] in the
|
5726
|
-
# *
|
5900
|
+
# *IoT SiteWise User Guide*.
|
5727
5901
|
#
|
5728
5902
|
# If you omit this parameter, the alias is removed from the property.
|
5729
5903
|
#
|
@@ -5734,10 +5908,10 @@ module Aws::IoTSiteWise
|
|
5734
5908
|
#
|
5735
5909
|
# @!attribute [rw] property_notification_state
|
5736
5910
|
# The MQTT notification state (enabled or disabled) for this asset
|
5737
|
-
# property. When the notification state is enabled,
|
5911
|
+
# property. When the notification state is enabled, IoT SiteWise
|
5738
5912
|
# publishes property value updates to a unique MQTT topic. For more
|
5739
|
-
# information, see [Interacting with other services][1] in the *
|
5740
|
-
#
|
5913
|
+
# information, see [Interacting with other services][1] in the *IoT
|
5914
|
+
# SiteWise User Guide*.
|
5741
5915
|
#
|
5742
5916
|
# If you omit this parameter, the notification state is set to
|
5743
5917
|
# `DISABLED`.
|
@@ -5836,8 +6010,8 @@ module Aws::IoTSiteWise
|
|
5836
6010
|
#
|
5837
6011
|
# @!attribute [rw] dashboard_definition
|
5838
6012
|
# The new dashboard definition, as specified in a JSON literal. For
|
5839
|
-
# detailed information, see [Creating dashboards (CLI)][1] in the *
|
5840
|
-
#
|
6013
|
+
# detailed information, see [Creating dashboards (CLI)][1] in the *IoT
|
6014
|
+
# SiteWise User Guide*.
|
5841
6015
|
#
|
5842
6016
|
#
|
5843
6017
|
#
|
@@ -5880,16 +6054,16 @@ module Aws::IoTSiteWise
|
|
5880
6054
|
#
|
5881
6055
|
# @!attribute [rw] capability_namespace
|
5882
6056
|
# The namespace of the gateway capability configuration to be updated.
|
5883
|
-
# For example, if you configure OPC-UA sources from the
|
5884
|
-
#
|
5885
|
-
#
|
5886
|
-
#
|
6057
|
+
# For example, if you configure OPC-UA sources from the IoT SiteWise
|
6058
|
+
# console, your OPC-UA capability configuration has the namespace
|
6059
|
+
# `iotsitewise:opcuacollector:version`, where `version` is a number
|
6060
|
+
# such as `1`.
|
5887
6061
|
# @return [String]
|
5888
6062
|
#
|
5889
6063
|
# @!attribute [rw] capability_configuration
|
5890
6064
|
# The JSON document that defines the configuration for the gateway
|
5891
6065
|
# capability. For more information, see [Configuring data sources
|
5892
|
-
# (CLI)][1] in the *
|
6066
|
+
# (CLI)][1] in the *IoT SiteWise User Guide*.
|
5893
6067
|
#
|
5894
6068
|
#
|
5895
6069
|
#
|
@@ -5991,7 +6165,7 @@ module Aws::IoTSiteWise
|
|
5991
6165
|
# @return [String]
|
5992
6166
|
#
|
5993
6167
|
# @!attribute [rw] portal_contact_email
|
5994
|
-
# The
|
6168
|
+
# The Amazon Web Services administrator's contact email address.
|
5995
6169
|
# @return [String]
|
5996
6170
|
#
|
5997
6171
|
# @!attribute [rw] portal_logo_image
|
@@ -6005,9 +6179,9 @@ module Aws::IoTSiteWise
|
|
6005
6179
|
#
|
6006
6180
|
# @!attribute [rw] role_arn
|
6007
6181
|
# The [ARN][1] of a service role that allows the portal's users to
|
6008
|
-
# access your
|
6009
|
-
# information, see [Using service roles for
|
6010
|
-
#
|
6182
|
+
# access your IoT SiteWise resources on your behalf. For more
|
6183
|
+
# information, see [Using service roles for IoT SiteWise Monitor][2]
|
6184
|
+
# in the *IoT SiteWise User Guide*.
|
6011
6185
|
#
|
6012
6186
|
#
|
6013
6187
|
#
|
@@ -6029,10 +6203,15 @@ module Aws::IoTSiteWise
|
|
6029
6203
|
# @return [String]
|
6030
6204
|
#
|
6031
6205
|
# @!attribute [rw] alarms
|
6032
|
-
# Contains the configuration information of an alarm created in an
|
6033
|
-
#
|
6034
|
-
#
|
6035
|
-
#
|
6206
|
+
# Contains the configuration information of an alarm created in an IoT
|
6207
|
+
# SiteWise Monitor portal. You can use the alarm to monitor an asset
|
6208
|
+
# property and get notified when the asset property value is outside a
|
6209
|
+
# specified range. For more information, see [Monitoring with
|
6210
|
+
# alarms][1] in the *IoT SiteWise Application Guide*.
|
6211
|
+
#
|
6212
|
+
#
|
6213
|
+
#
|
6214
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
|
6036
6215
|
# @return [Types::Alarms]
|
6037
6216
|
#
|
6038
6217
|
class UpdatePortalRequest < Struct.new(
|
@@ -6112,7 +6291,7 @@ module Aws::IoTSiteWise
|
|
6112
6291
|
# }
|
6113
6292
|
#
|
6114
6293
|
# @!attribute [rw] id
|
6115
|
-
# The
|
6294
|
+
# The Amazon Web Services SSO ID of the user.
|
6116
6295
|
# @return [String]
|
6117
6296
|
#
|
6118
6297
|
class UserIdentity < Struct.new(
|
@@ -6144,7 +6323,7 @@ module Aws::IoTSiteWise
|
|
6144
6323
|
# several hierarchies using the same model and therefore the same
|
6145
6324
|
# `propertyId`. For example, you might have separately grouped assets
|
6146
6325
|
# that come from the same asset model. For more information, see
|
6147
|
-
# [Asset hierarchies][1] in the *
|
6326
|
+
# [Asset hierarchies][1] in the *IoT SiteWise User Guide*.
|
6148
6327
|
#
|
6149
6328
|
#
|
6150
6329
|
#
|