aws-sdk-iotsitewise 1.19.0 → 1.24.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +133 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-iotsitewise.rb +2 -2
- data/lib/aws-sdk-iotsitewise/client.rb +417 -177
- data/lib/aws-sdk-iotsitewise/client_api.rb +125 -1
- data/lib/aws-sdk-iotsitewise/errors.rb +1 -1
- data/lib/aws-sdk-iotsitewise/resource.rb +1 -1
- data/lib/aws-sdk-iotsitewise/types.rb +619 -213
- data/lib/aws-sdk-iotsitewise/waiters.rb +1 -1
- metadata +9 -7
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -22,6 +22,7 @@ module Aws::IoTSiteWise
|
|
22
22
|
AggregatedValue = Shapes::StructureShape.new(name: 'AggregatedValue')
|
23
23
|
AggregatedValues = Shapes::ListShape.new(name: 'AggregatedValues')
|
24
24
|
Aggregates = Shapes::StructureShape.new(name: 'Aggregates')
|
25
|
+
Alarms = Shapes::StructureShape.new(name: 'Alarms')
|
25
26
|
AmazonResourceName = Shapes::StringShape.new(name: 'AmazonResourceName')
|
26
27
|
AssetCompositeModel = Shapes::StructureShape.new(name: 'AssetCompositeModel')
|
27
28
|
AssetCompositeModels = Shapes::ListShape.new(name: 'AssetCompositeModels')
|
@@ -102,6 +103,7 @@ module Aws::IoTSiteWise
|
|
102
103
|
CreatePortalResponse = Shapes::StructureShape.new(name: 'CreatePortalResponse')
|
103
104
|
CreateProjectRequest = Shapes::StructureShape.new(name: 'CreateProjectRequest')
|
104
105
|
CreateProjectResponse = Shapes::StructureShape.new(name: 'CreateProjectResponse')
|
106
|
+
CustomerManagedS3Storage = Shapes::StructureShape.new(name: 'CustomerManagedS3Storage')
|
105
107
|
DashboardDefinition = Shapes::StringShape.new(name: 'DashboardDefinition')
|
106
108
|
DashboardSummaries = Shapes::ListShape.new(name: 'DashboardSummaries')
|
107
109
|
DashboardSummary = Shapes::StructureShape.new(name: 'DashboardSummary')
|
@@ -141,6 +143,8 @@ module Aws::IoTSiteWise
|
|
141
143
|
DescribePortalResponse = Shapes::StructureShape.new(name: 'DescribePortalResponse')
|
142
144
|
DescribeProjectRequest = Shapes::StructureShape.new(name: 'DescribeProjectRequest')
|
143
145
|
DescribeProjectResponse = Shapes::StructureShape.new(name: 'DescribeProjectResponse')
|
146
|
+
DescribeStorageConfigurationRequest = Shapes::StructureShape.new(name: 'DescribeStorageConfigurationRequest')
|
147
|
+
DescribeStorageConfigurationResponse = Shapes::StructureShape.new(name: 'DescribeStorageConfigurationResponse')
|
144
148
|
Description = Shapes::StringShape.new(name: 'Description')
|
145
149
|
DisassociateAssetsRequest = Shapes::StructureShape.new(name: 'DisassociateAssetsRequest')
|
146
150
|
Email = Shapes::StringShape.new(name: 'Email')
|
@@ -164,6 +168,8 @@ module Aws::IoTSiteWise
|
|
164
168
|
GetAssetPropertyValueHistoryResponse = Shapes::StructureShape.new(name: 'GetAssetPropertyValueHistoryResponse')
|
165
169
|
GetAssetPropertyValueRequest = Shapes::StructureShape.new(name: 'GetAssetPropertyValueRequest')
|
166
170
|
GetAssetPropertyValueResponse = Shapes::StructureShape.new(name: 'GetAssetPropertyValueResponse')
|
171
|
+
GetInterpolatedAssetPropertyValuesRequest = Shapes::StructureShape.new(name: 'GetInterpolatedAssetPropertyValuesRequest')
|
172
|
+
GetInterpolatedAssetPropertyValuesResponse = Shapes::StructureShape.new(name: 'GetInterpolatedAssetPropertyValuesResponse')
|
167
173
|
Greengrass = Shapes::StructureShape.new(name: 'Greengrass')
|
168
174
|
GroupIdentity = Shapes::StructureShape.new(name: 'GroupIdentity')
|
169
175
|
IAMRoleIdentity = Shapes::StructureShape.new(name: 'IAMRoleIdentity')
|
@@ -179,7 +185,11 @@ module Aws::IoTSiteWise
|
|
179
185
|
ImageFileType = Shapes::StringShape.new(name: 'ImageFileType')
|
180
186
|
ImageLocation = Shapes::StructureShape.new(name: 'ImageLocation')
|
181
187
|
InternalFailureException = Shapes::StructureShape.new(name: 'InternalFailureException')
|
188
|
+
InterpolatedAssetPropertyValue = Shapes::StructureShape.new(name: 'InterpolatedAssetPropertyValue')
|
189
|
+
InterpolatedAssetPropertyValues = Shapes::ListShape.new(name: 'InterpolatedAssetPropertyValues')
|
190
|
+
InterpolationType = Shapes::StringShape.new(name: 'InterpolationType')
|
182
191
|
Interval = Shapes::StringShape.new(name: 'Interval')
|
192
|
+
IntervalInSeconds = Shapes::IntegerShape.new(name: 'IntervalInSeconds')
|
183
193
|
InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
|
184
194
|
KmsKeyId = Shapes::StringShape.new(name: 'KmsKeyId')
|
185
195
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
@@ -209,6 +219,7 @@ module Aws::IoTSiteWise
|
|
209
219
|
LoggingLevel = Shapes::StringShape.new(name: 'LoggingLevel')
|
210
220
|
LoggingOptions = Shapes::StructureShape.new(name: 'LoggingOptions')
|
211
221
|
Macro = Shapes::StringShape.new(name: 'Macro')
|
222
|
+
MaxInterpolatedResults = Shapes::IntegerShape.new(name: 'MaxInterpolatedResults')
|
212
223
|
MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
|
213
224
|
Measurement = Shapes::StructureShape.new(name: 'Measurement')
|
214
225
|
Metric = Shapes::StructureShape.new(name: 'Metric')
|
@@ -216,6 +227,7 @@ module Aws::IoTSiteWise
|
|
216
227
|
MonitorErrorCode = Shapes::StringShape.new(name: 'MonitorErrorCode')
|
217
228
|
MonitorErrorDetails = Shapes::StructureShape.new(name: 'MonitorErrorDetails')
|
218
229
|
MonitorErrorMessage = Shapes::StringShape.new(name: 'MonitorErrorMessage')
|
230
|
+
MultiLayerStorage = Shapes::StructureShape.new(name: 'MultiLayerStorage')
|
219
231
|
Name = Shapes::StringShape.new(name: 'Name')
|
220
232
|
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
221
233
|
OffsetInNanos = Shapes::IntegerShape.new(name: 'OffsetInNanos')
|
@@ -247,6 +259,8 @@ module Aws::IoTSiteWise
|
|
247
259
|
PutDefaultEncryptionConfigurationResponse = Shapes::StructureShape.new(name: 'PutDefaultEncryptionConfigurationResponse')
|
248
260
|
PutLoggingOptionsRequest = Shapes::StructureShape.new(name: 'PutLoggingOptionsRequest')
|
249
261
|
PutLoggingOptionsResponse = Shapes::StructureShape.new(name: 'PutLoggingOptionsResponse')
|
262
|
+
PutStorageConfigurationRequest = Shapes::StructureShape.new(name: 'PutStorageConfigurationRequest')
|
263
|
+
PutStorageConfigurationResponse = Shapes::StructureShape.new(name: 'PutStorageConfigurationResponse')
|
250
264
|
Qualities = Shapes::ListShape.new(name: 'Qualities')
|
251
265
|
Quality = Shapes::StringShape.new(name: 'Quality')
|
252
266
|
Resolution = Shapes::StringShape.new(name: 'Resolution')
|
@@ -258,6 +272,7 @@ module Aws::IoTSiteWise
|
|
258
272
|
ResourceType = Shapes::StringShape.new(name: 'ResourceType')
|
259
273
|
SSOApplicationId = Shapes::StringShape.new(name: 'SSOApplicationId')
|
260
274
|
ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
|
275
|
+
StorageType = Shapes::StringShape.new(name: 'StorageType')
|
261
276
|
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
262
277
|
TagKeyList = Shapes::ListShape.new(name: 'TagKeyList')
|
263
278
|
TagMap = Shapes::MapShape.new(name: 'TagMap')
|
@@ -327,6 +342,10 @@ module Aws::IoTSiteWise
|
|
327
342
|
Aggregates.add_member(:standard_deviation, Shapes::ShapeRef.new(shape: AggregatedDoubleValue, location_name: "standardDeviation"))
|
328
343
|
Aggregates.struct_class = Types::Aggregates
|
329
344
|
|
345
|
+
Alarms.add_member(:alarm_role_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "alarmRoleArn"))
|
346
|
+
Alarms.add_member(:notification_lambda_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "notificationLambdaArn"))
|
347
|
+
Alarms.struct_class = Types::Alarms
|
348
|
+
|
330
349
|
AssetCompositeModel.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
|
331
350
|
AssetCompositeModel.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description"))
|
332
351
|
AssetCompositeModel.add_member(:type, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "type"))
|
@@ -600,6 +619,8 @@ module Aws::IoTSiteWise
|
|
600
619
|
CreatePortalRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "roleArn"))
|
601
620
|
CreatePortalRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags"))
|
602
621
|
CreatePortalRequest.add_member(:portal_auth_mode, Shapes::ShapeRef.new(shape: AuthMode, location_name: "portalAuthMode"))
|
622
|
+
CreatePortalRequest.add_member(:notification_sender_email, Shapes::ShapeRef.new(shape: Email, location_name: "notificationSenderEmail"))
|
623
|
+
CreatePortalRequest.add_member(:alarms, Shapes::ShapeRef.new(shape: Alarms, location_name: "alarms"))
|
603
624
|
CreatePortalRequest.struct_class = Types::CreatePortalRequest
|
604
625
|
|
605
626
|
CreatePortalResponse.add_member(:portal_id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "portalId"))
|
@@ -620,6 +641,10 @@ module Aws::IoTSiteWise
|
|
620
641
|
CreateProjectResponse.add_member(:project_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "projectArn"))
|
621
642
|
CreateProjectResponse.struct_class = Types::CreateProjectResponse
|
622
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
|
+
|
623
648
|
DashboardSummaries.member = Shapes::ShapeRef.new(shape: DashboardSummary)
|
624
649
|
|
625
650
|
DashboardSummary.add_member(:id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "id"))
|
@@ -787,6 +812,8 @@ module Aws::IoTSiteWise
|
|
787
812
|
DescribePortalResponse.add_member(:portal_logo_image_location, Shapes::ShapeRef.new(shape: ImageLocation, location_name: "portalLogoImageLocation"))
|
788
813
|
DescribePortalResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "roleArn"))
|
789
814
|
DescribePortalResponse.add_member(:portal_auth_mode, Shapes::ShapeRef.new(shape: AuthMode, location_name: "portalAuthMode"))
|
815
|
+
DescribePortalResponse.add_member(:notification_sender_email, Shapes::ShapeRef.new(shape: Email, location_name: "notificationSenderEmail"))
|
816
|
+
DescribePortalResponse.add_member(:alarms, Shapes::ShapeRef.new(shape: Alarms, location_name: "alarms"))
|
790
817
|
DescribePortalResponse.struct_class = Types::DescribePortalResponse
|
791
818
|
|
792
819
|
DescribeProjectRequest.add_member(:project_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "projectId"))
|
@@ -801,6 +828,14 @@ module Aws::IoTSiteWise
|
|
801
828
|
DescribeProjectResponse.add_member(:project_last_update_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "projectLastUpdateDate"))
|
802
829
|
DescribeProjectResponse.struct_class = Types::DescribeProjectResponse
|
803
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
|
+
|
804
839
|
DisassociateAssetsRequest.add_member(:asset_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "assetId"))
|
805
840
|
DisassociateAssetsRequest.add_member(:hierarchy_id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "hierarchyId"))
|
806
841
|
DisassociateAssetsRequest.add_member(:child_asset_id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "childAssetId"))
|
@@ -875,6 +910,24 @@ module Aws::IoTSiteWise
|
|
875
910
|
GetAssetPropertyValueResponse.add_member(:property_value, Shapes::ShapeRef.new(shape: AssetPropertyValue, location_name: "propertyValue"))
|
876
911
|
GetAssetPropertyValueResponse.struct_class = Types::GetAssetPropertyValueResponse
|
877
912
|
|
913
|
+
GetInterpolatedAssetPropertyValuesRequest.add_member(:asset_id, Shapes::ShapeRef.new(shape: ID, location: "querystring", location_name: "assetId"))
|
914
|
+
GetInterpolatedAssetPropertyValuesRequest.add_member(:property_id, Shapes::ShapeRef.new(shape: ID, location: "querystring", location_name: "propertyId"))
|
915
|
+
GetInterpolatedAssetPropertyValuesRequest.add_member(:property_alias, Shapes::ShapeRef.new(shape: AssetPropertyAlias, location: "querystring", location_name: "propertyAlias"))
|
916
|
+
GetInterpolatedAssetPropertyValuesRequest.add_member(:start_time_in_seconds, Shapes::ShapeRef.new(shape: TimeInSeconds, required: true, location: "querystring", location_name: "startTimeInSeconds"))
|
917
|
+
GetInterpolatedAssetPropertyValuesRequest.add_member(:start_time_offset_in_nanos, Shapes::ShapeRef.new(shape: OffsetInNanos, location: "querystring", location_name: "startTimeOffsetInNanos"))
|
918
|
+
GetInterpolatedAssetPropertyValuesRequest.add_member(:end_time_in_seconds, Shapes::ShapeRef.new(shape: TimeInSeconds, required: true, location: "querystring", location_name: "endTimeInSeconds"))
|
919
|
+
GetInterpolatedAssetPropertyValuesRequest.add_member(:end_time_offset_in_nanos, Shapes::ShapeRef.new(shape: OffsetInNanos, location: "querystring", location_name: "endTimeOffsetInNanos"))
|
920
|
+
GetInterpolatedAssetPropertyValuesRequest.add_member(:quality, Shapes::ShapeRef.new(shape: Quality, required: true, location: "querystring", location_name: "quality"))
|
921
|
+
GetInterpolatedAssetPropertyValuesRequest.add_member(:interval_in_seconds, Shapes::ShapeRef.new(shape: IntervalInSeconds, required: true, location: "querystring", location_name: "intervalInSeconds"))
|
922
|
+
GetInterpolatedAssetPropertyValuesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
923
|
+
GetInterpolatedAssetPropertyValuesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxInterpolatedResults, location: "querystring", location_name: "maxResults"))
|
924
|
+
GetInterpolatedAssetPropertyValuesRequest.add_member(:type, Shapes::ShapeRef.new(shape: InterpolationType, required: true, location: "querystring", location_name: "type"))
|
925
|
+
GetInterpolatedAssetPropertyValuesRequest.struct_class = Types::GetInterpolatedAssetPropertyValuesRequest
|
926
|
+
|
927
|
+
GetInterpolatedAssetPropertyValuesResponse.add_member(:interpolated_asset_property_values, Shapes::ShapeRef.new(shape: InterpolatedAssetPropertyValues, required: true, location_name: "interpolatedAssetPropertyValues"))
|
928
|
+
GetInterpolatedAssetPropertyValuesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
929
|
+
GetInterpolatedAssetPropertyValuesResponse.struct_class = Types::GetInterpolatedAssetPropertyValuesResponse
|
930
|
+
|
878
931
|
Greengrass.add_member(:group_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "groupArn"))
|
879
932
|
Greengrass.struct_class = Types::Greengrass
|
880
933
|
|
@@ -910,6 +963,12 @@ module Aws::IoTSiteWise
|
|
910
963
|
InternalFailureException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "message"))
|
911
964
|
InternalFailureException.struct_class = Types::InternalFailureException
|
912
965
|
|
966
|
+
InterpolatedAssetPropertyValue.add_member(:timestamp, Shapes::ShapeRef.new(shape: TimeInNanos, required: true, location_name: "timestamp"))
|
967
|
+
InterpolatedAssetPropertyValue.add_member(:value, Shapes::ShapeRef.new(shape: Variant, required: true, location_name: "value"))
|
968
|
+
InterpolatedAssetPropertyValue.struct_class = Types::InterpolatedAssetPropertyValue
|
969
|
+
|
970
|
+
InterpolatedAssetPropertyValues.member = Shapes::ShapeRef.new(shape: InterpolatedAssetPropertyValue)
|
971
|
+
|
913
972
|
InvalidRequestException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "message"))
|
914
973
|
InvalidRequestException.struct_class = Types::InvalidRequestException
|
915
974
|
|
@@ -1034,6 +1093,9 @@ module Aws::IoTSiteWise
|
|
1034
1093
|
MonitorErrorDetails.add_member(:message, Shapes::ShapeRef.new(shape: MonitorErrorMessage, location_name: "message"))
|
1035
1094
|
MonitorErrorDetails.struct_class = Types::MonitorErrorDetails
|
1036
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
|
+
|
1037
1099
|
PortalResource.add_member(:id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "id"))
|
1038
1100
|
PortalResource.struct_class = Types::PortalResource
|
1039
1101
|
|
@@ -1107,6 +1169,15 @@ module Aws::IoTSiteWise
|
|
1107
1169
|
|
1108
1170
|
PutLoggingOptionsResponse.struct_class = Types::PutLoggingOptionsResponse
|
1109
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
|
+
|
1110
1181
|
Qualities.member = Shapes::ShapeRef.new(shape: Quality)
|
1111
1182
|
|
1112
1183
|
Resource.add_member(:portal, Shapes::ShapeRef.new(shape: PortalResource, location_name: "portal"))
|
@@ -1229,6 +1300,8 @@ module Aws::IoTSiteWise
|
|
1229
1300
|
UpdatePortalRequest.add_member(:portal_logo_image, Shapes::ShapeRef.new(shape: Image, location_name: "portalLogoImage"))
|
1230
1301
|
UpdatePortalRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "roleArn"))
|
1231
1302
|
UpdatePortalRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
|
1303
|
+
UpdatePortalRequest.add_member(:notification_sender_email, Shapes::ShapeRef.new(shape: Email, location_name: "notificationSenderEmail"))
|
1304
|
+
UpdatePortalRequest.add_member(:alarms, Shapes::ShapeRef.new(shape: Alarms, location_name: "alarms"))
|
1232
1305
|
UpdatePortalRequest.struct_class = Types::UpdatePortalRequest
|
1233
1306
|
|
1234
1307
|
UpdatePortalResponse.add_member(:portal_status, Shapes::ShapeRef.new(shape: PortalStatus, required: true, location_name: "portalStatus"))
|
@@ -1724,6 +1797,20 @@ module Aws::IoTSiteWise
|
|
1724
1797
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1725
1798
|
end)
|
1726
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
|
+
|
1727
1814
|
api.add_operation(:disassociate_assets, Seahorse::Model::Operation.new.tap do |o|
|
1728
1815
|
o.name = "DisassociateAssets"
|
1729
1816
|
o.http_method = "POST"
|
@@ -1800,6 +1887,28 @@ module Aws::IoTSiteWise
|
|
1800
1887
|
)
|
1801
1888
|
end)
|
1802
1889
|
|
1890
|
+
api.add_operation(:get_interpolated_asset_property_values, Seahorse::Model::Operation.new.tap do |o|
|
1891
|
+
o.name = "GetInterpolatedAssetPropertyValues"
|
1892
|
+
o.http_method = "GET"
|
1893
|
+
o.http_request_uri = "/properties/interpolated"
|
1894
|
+
o.endpoint_pattern = {
|
1895
|
+
"hostPrefix" => "data.",
|
1896
|
+
}
|
1897
|
+
o.input = Shapes::ShapeRef.new(shape: GetInterpolatedAssetPropertyValuesRequest)
|
1898
|
+
o.output = Shapes::ShapeRef.new(shape: GetInterpolatedAssetPropertyValuesResponse)
|
1899
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1900
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1901
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
1902
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1903
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1904
|
+
o[:pager] = Aws::Pager.new(
|
1905
|
+
limit_key: "max_results",
|
1906
|
+
tokens: {
|
1907
|
+
"next_token" => "next_token"
|
1908
|
+
}
|
1909
|
+
)
|
1910
|
+
end)
|
1911
|
+
|
1803
1912
|
api.add_operation(:list_access_policies, Seahorse::Model::Operation.new.tap do |o|
|
1804
1913
|
o.name = "ListAccessPolicies"
|
1805
1914
|
o.http_method = "GET"
|
@@ -2047,6 +2156,21 @@ module Aws::IoTSiteWise
|
|
2047
2156
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
2048
2157
|
end)
|
2049
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
|
+
|
2050
2174
|
api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
|
2051
2175
|
o.name = "TagResource"
|
2052
2176
|
o.http_method = "POST"
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,26 +3,27 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
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,6 +113,52 @@ module Aws::IoTSiteWise
|
|
112
113
|
include Aws::Structure
|
113
114
|
end
|
114
115
|
|
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
|
118
|
+
# property and get notified when the asset property value is outside a
|
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
|
125
|
+
#
|
126
|
+
# @note When making an API call, you may pass Alarms
|
127
|
+
# data as a hash:
|
128
|
+
#
|
129
|
+
# {
|
130
|
+
# alarm_role_arn: "ARN", # required
|
131
|
+
# notification_lambda_arn: "ARN",
|
132
|
+
# }
|
133
|
+
#
|
134
|
+
# @!attribute [rw] alarm_role_arn
|
135
|
+
# The [ARN][1] of the IAM role that allows the alarm to perform
|
136
|
+
# actions and access Amazon Web Services resources and services, such
|
137
|
+
# as IoT Events.
|
138
|
+
#
|
139
|
+
#
|
140
|
+
#
|
141
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
142
|
+
# @return [String]
|
143
|
+
#
|
144
|
+
# @!attribute [rw] notification_lambda_arn
|
145
|
+
# The [ARN][1] of the Lambda function that manages alarm
|
146
|
+
# notifications. For more information, see [Managing alarm
|
147
|
+
# notifications][2] in the *IoT Events Developer Guide*.
|
148
|
+
#
|
149
|
+
#
|
150
|
+
#
|
151
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
152
|
+
# [2]: https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html
|
153
|
+
# @return [String]
|
154
|
+
#
|
155
|
+
class Alarms < Struct.new(
|
156
|
+
:alarm_role_arn,
|
157
|
+
:notification_lambda_arn)
|
158
|
+
SENSITIVE = []
|
159
|
+
include Aws::Structure
|
160
|
+
end
|
161
|
+
|
115
162
|
# Contains information about a composite model in an asset. This object
|
116
163
|
# contains the asset's properties that you define in the composite
|
117
164
|
# model.
|
@@ -620,8 +667,8 @@ module Aws::IoTSiteWise
|
|
620
667
|
end
|
621
668
|
|
622
669
|
# Contains current status information for an asset model. For more
|
623
|
-
# information, see [Asset and model states][1] in the *
|
624
|
-
#
|
670
|
+
# information, see [Asset and model states][1] in the *IoT SiteWise User
|
671
|
+
# Guide*.
|
625
672
|
#
|
626
673
|
#
|
627
674
|
#
|
@@ -645,7 +692,7 @@ module Aws::IoTSiteWise
|
|
645
692
|
# Contains a summary of an asset model.
|
646
693
|
#
|
647
694
|
# @!attribute [rw] id
|
648
|
-
# The ID of the asset model (used with
|
695
|
+
# The ID of the asset model (used with IoT SiteWise APIs).
|
649
696
|
# @return [String]
|
650
697
|
#
|
651
698
|
# @!attribute [rw] arn
|
@@ -701,11 +748,11 @@ module Aws::IoTSiteWise
|
|
701
748
|
# @return [String]
|
702
749
|
#
|
703
750
|
# @!attribute [rw] alias
|
704
|
-
# The
|
705
|
-
#
|
751
|
+
# The alias that identifies the property, such as an OPC-UA server
|
752
|
+
# data stream path (for example,
|
706
753
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
707
754
|
# see [Mapping industrial data streams to asset properties][1] in the
|
708
|
-
# *
|
755
|
+
# *IoT SiteWise User Guide*.
|
709
756
|
#
|
710
757
|
#
|
711
758
|
#
|
@@ -812,8 +859,8 @@ module Aws::IoTSiteWise
|
|
812
859
|
end
|
813
860
|
|
814
861
|
# Contains information about the current status of an asset. For more
|
815
|
-
# information, see [Asset and model states][1] in the *
|
816
|
-
#
|
862
|
+
# information, see [Asset and model states][1] in the *IoT SiteWise User
|
863
|
+
# Guide*.
|
817
864
|
#
|
818
865
|
#
|
819
866
|
#
|
@@ -906,7 +953,7 @@ module Aws::IoTSiteWise
|
|
906
953
|
# The ID of a hierarchy in the parent asset's model. Hierarchies
|
907
954
|
# allow different groupings of assets to be formed that all come from
|
908
955
|
# the same asset model. For more information, see [Asset
|
909
|
-
# hierarchies][1] in the *
|
956
|
+
# hierarchies][1] in the *IoT SiteWise User Guide*.
|
910
957
|
#
|
911
958
|
#
|
912
959
|
#
|
@@ -990,7 +1037,7 @@ module Aws::IoTSiteWise
|
|
990
1037
|
end
|
991
1038
|
|
992
1039
|
# Contains an asset attribute property. For more information, see
|
993
|
-
# [Attributes][1] in the *
|
1040
|
+
# [Attributes][1] in the *IoT SiteWise User Guide*.
|
994
1041
|
#
|
995
1042
|
#
|
996
1043
|
#
|
@@ -1007,7 +1054,7 @@ module Aws::IoTSiteWise
|
|
1007
1054
|
# The default value of the asset model property attribute. All assets
|
1008
1055
|
# that you create from the asset model contain this attribute value.
|
1009
1056
|
# You can update an attribute's value after you create an asset. For
|
1010
|
-
# more information, see [Updating attribute values][1] in the *
|
1057
|
+
# more information, see [Updating attribute values][1] in the *IoT
|
1011
1058
|
# SiteWise User Guide*.
|
1012
1059
|
#
|
1013
1060
|
#
|
@@ -1227,7 +1274,7 @@ module Aws::IoTSiteWise
|
|
1227
1274
|
include Aws::Structure
|
1228
1275
|
end
|
1229
1276
|
|
1230
|
-
# Contains the details of an
|
1277
|
+
# Contains the details of an IoT SiteWise configuration error.
|
1231
1278
|
#
|
1232
1279
|
# @!attribute [rw] code
|
1233
1280
|
# The error code.
|
@@ -1318,12 +1365,12 @@ module Aws::IoTSiteWise
|
|
1318
1365
|
# }
|
1319
1366
|
#
|
1320
1367
|
# @!attribute [rw] access_policy_identity
|
1321
|
-
# The identity for this access policy. Choose an
|
1322
|
-
# 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.
|
1323
1370
|
# @return [Types::Identity]
|
1324
1371
|
#
|
1325
1372
|
# @!attribute [rw] access_policy_resource
|
1326
|
-
# The
|
1373
|
+
# The IoT SiteWise Monitor resource for this access policy. Choose
|
1327
1374
|
# either a portal or a project.
|
1328
1375
|
# @return [Types::Resource]
|
1329
1376
|
#
|
@@ -1343,8 +1390,8 @@ module Aws::IoTSiteWise
|
|
1343
1390
|
#
|
1344
1391
|
# @!attribute [rw] tags
|
1345
1392
|
# A list of key-value pairs that contain metadata for the access
|
1346
|
-
# policy. For more information, see [Tagging your
|
1347
|
-
# resources][1] in the *
|
1393
|
+
# policy. For more information, see [Tagging your IoT SiteWise
|
1394
|
+
# resources][1] in the *IoT SiteWise User Guide*.
|
1348
1395
|
#
|
1349
1396
|
#
|
1350
1397
|
#
|
@@ -1505,10 +1552,10 @@ module Aws::IoTSiteWise
|
|
1505
1552
|
#
|
1506
1553
|
# @!attribute [rw] asset_model_properties
|
1507
1554
|
# The property definitions of the asset model. For more information,
|
1508
|
-
# see [Asset properties][1] in the *
|
1555
|
+
# see [Asset properties][1] in the *IoT SiteWise User Guide*.
|
1509
1556
|
#
|
1510
1557
|
# You can specify up to 200 properties per asset model. For more
|
1511
|
-
# information, see [Quotas][2] in the *
|
1558
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
1512
1559
|
#
|
1513
1560
|
#
|
1514
1561
|
#
|
@@ -1520,10 +1567,10 @@ module Aws::IoTSiteWise
|
|
1520
1567
|
# The hierarchy definitions of the asset model. Each hierarchy
|
1521
1568
|
# specifies an asset model whose assets can be children of any other
|
1522
1569
|
# assets created from this asset model. For more information, see
|
1523
|
-
# [Asset hierarchies][1] in the *
|
1570
|
+
# [Asset hierarchies][1] in the *IoT SiteWise User Guide*.
|
1524
1571
|
#
|
1525
1572
|
# You can specify up to 10 hierarchies per asset model. For more
|
1526
|
-
# information, see [Quotas][2] in the *
|
1573
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
1527
1574
|
#
|
1528
1575
|
#
|
1529
1576
|
#
|
@@ -1550,8 +1597,8 @@ module Aws::IoTSiteWise
|
|
1550
1597
|
#
|
1551
1598
|
# @!attribute [rw] tags
|
1552
1599
|
# A list of key-value pairs that contain metadata for the asset model.
|
1553
|
-
# For more information, see [Tagging your
|
1554
|
-
#
|
1600
|
+
# For more information, see [Tagging your IoT SiteWise resources][1]
|
1601
|
+
# in the *IoT SiteWise User Guide*.
|
1555
1602
|
#
|
1556
1603
|
#
|
1557
1604
|
#
|
@@ -1572,7 +1619,7 @@ module Aws::IoTSiteWise
|
|
1572
1619
|
|
1573
1620
|
# @!attribute [rw] asset_model_id
|
1574
1621
|
# The ID of the asset model. You can use this ID when you call other
|
1575
|
-
#
|
1622
|
+
# IoT SiteWise APIs.
|
1576
1623
|
# @return [String]
|
1577
1624
|
#
|
1578
1625
|
# @!attribute [rw] asset_model_arn
|
@@ -1629,8 +1676,8 @@ module Aws::IoTSiteWise
|
|
1629
1676
|
#
|
1630
1677
|
# @!attribute [rw] tags
|
1631
1678
|
# A list of key-value pairs that contain metadata for the asset. For
|
1632
|
-
# more information, see [Tagging your
|
1633
|
-
#
|
1679
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in
|
1680
|
+
# the *IoT SiteWise User Guide*.
|
1634
1681
|
#
|
1635
1682
|
#
|
1636
1683
|
#
|
@@ -1648,7 +1695,7 @@ module Aws::IoTSiteWise
|
|
1648
1695
|
|
1649
1696
|
# @!attribute [rw] asset_id
|
1650
1697
|
# The ID of the asset. This ID uniquely identifies the asset within
|
1651
|
-
#
|
1698
|
+
# IoT SiteWise and can be used with other IoT SiteWise APIs.
|
1652
1699
|
# @return [String]
|
1653
1700
|
#
|
1654
1701
|
# @!attribute [rw] asset_arn
|
@@ -1702,8 +1749,8 @@ module Aws::IoTSiteWise
|
|
1702
1749
|
#
|
1703
1750
|
# @!attribute [rw] dashboard_definition
|
1704
1751
|
# The dashboard definition specified in a JSON literal. For detailed
|
1705
|
-
# information, see [Creating dashboards (CLI)][1] in the *
|
1706
|
-
#
|
1752
|
+
# information, see [Creating dashboards (CLI)][1] in the *IoT SiteWise
|
1753
|
+
# User Guide*.
|
1707
1754
|
#
|
1708
1755
|
#
|
1709
1756
|
#
|
@@ -1721,8 +1768,8 @@ module Aws::IoTSiteWise
|
|
1721
1768
|
#
|
1722
1769
|
# @!attribute [rw] tags
|
1723
1770
|
# A list of key-value pairs that contain metadata for the dashboard.
|
1724
|
-
# For more information, see [Tagging your
|
1725
|
-
#
|
1771
|
+
# For more information, see [Tagging your IoT SiteWise resources][1]
|
1772
|
+
# in the *IoT SiteWise User Guide*.
|
1726
1773
|
#
|
1727
1774
|
#
|
1728
1775
|
#
|
@@ -1787,8 +1834,8 @@ module Aws::IoTSiteWise
|
|
1787
1834
|
#
|
1788
1835
|
# @!attribute [rw] tags
|
1789
1836
|
# A list of key-value pairs that contain metadata for the gateway. For
|
1790
|
-
# more information, see [Tagging your
|
1791
|
-
#
|
1837
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in
|
1838
|
+
# the *IoT SiteWise User Guide*.
|
1792
1839
|
#
|
1793
1840
|
#
|
1794
1841
|
#
|
@@ -1805,7 +1852,7 @@ module Aws::IoTSiteWise
|
|
1805
1852
|
|
1806
1853
|
# @!attribute [rw] gateway_id
|
1807
1854
|
# The ID of the gateway device. You can use this ID when you call
|
1808
|
-
# other
|
1855
|
+
# other IoT SiteWise APIs.
|
1809
1856
|
# @return [String]
|
1810
1857
|
#
|
1811
1858
|
# @!attribute [rw] gateway_arn
|
@@ -1842,6 +1889,11 @@ module Aws::IoTSiteWise
|
|
1842
1889
|
# "TagKey" => "TagValue",
|
1843
1890
|
# },
|
1844
1891
|
# portal_auth_mode: "IAM", # accepts IAM, SSO
|
1892
|
+
# notification_sender_email: "Email",
|
1893
|
+
# alarms: {
|
1894
|
+
# alarm_role_arn: "ARN", # required
|
1895
|
+
# notification_lambda_arn: "ARN",
|
1896
|
+
# },
|
1845
1897
|
# }
|
1846
1898
|
#
|
1847
1899
|
# @!attribute [rw] portal_name
|
@@ -1853,7 +1905,7 @@ module Aws::IoTSiteWise
|
|
1853
1905
|
# @return [String]
|
1854
1906
|
#
|
1855
1907
|
# @!attribute [rw] portal_contact_email
|
1856
|
-
# The
|
1908
|
+
# The Amazon Web Services administrator's contact email address.
|
1857
1909
|
# @return [String]
|
1858
1910
|
#
|
1859
1911
|
# @!attribute [rw] client_token
|
@@ -1872,9 +1924,9 @@ module Aws::IoTSiteWise
|
|
1872
1924
|
#
|
1873
1925
|
# @!attribute [rw] role_arn
|
1874
1926
|
# The [ARN][1] of a service role that allows the portal's users to
|
1875
|
-
# access your
|
1876
|
-
# information, see [Using service roles for
|
1877
|
-
#
|
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*.
|
1878
1930
|
#
|
1879
1931
|
#
|
1880
1932
|
#
|
@@ -1884,8 +1936,8 @@ module Aws::IoTSiteWise
|
|
1884
1936
|
#
|
1885
1937
|
# @!attribute [rw] tags
|
1886
1938
|
# A list of key-value pairs that contain metadata for the portal. For
|
1887
|
-
# more information, see [Tagging your
|
1888
|
-
#
|
1939
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in
|
1940
|
+
# the *IoT SiteWise User Guide*.
|
1889
1941
|
#
|
1890
1942
|
#
|
1891
1943
|
#
|
@@ -1896,15 +1948,16 @@ module Aws::IoTSiteWise
|
|
1896
1948
|
# The service to use to authenticate users to the portal. Choose from
|
1897
1949
|
# the following options:
|
1898
1950
|
#
|
1899
|
-
# * `SSO` – The portal uses
|
1900
|
-
# and manage user permissions. Before you can
|
1901
|
-
# uses
|
1902
|
-
#
|
1903
|
-
#
|
1904
|
-
# 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.
|
1905
1958
|
#
|
1906
|
-
# * `IAM` – The portal uses
|
1907
|
-
#
|
1959
|
+
# * `IAM` – The portal uses Identity and Access Management to
|
1960
|
+
# authenticate users and manage user permissions. This option is
|
1908
1961
|
# only available in the China Regions.
|
1909
1962
|
#
|
1910
1963
|
# You can't change this value after you create a portal.
|
@@ -1916,6 +1969,31 @@ module Aws::IoTSiteWise
|
|
1916
1969
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso
|
1917
1970
|
# @return [String]
|
1918
1971
|
#
|
1972
|
+
# @!attribute [rw] notification_sender_email
|
1973
|
+
# The email address that sends alarm notifications.
|
1974
|
+
#
|
1975
|
+
# If you use the [IoT Events managed Lambda function][1] to manage
|
1976
|
+
# your emails, you must [verify the sender email address in Amazon
|
1977
|
+
# SES][2].
|
1978
|
+
#
|
1979
|
+
#
|
1980
|
+
#
|
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
|
1983
|
+
# @return [String]
|
1984
|
+
#
|
1985
|
+
# @!attribute [rw] alarms
|
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
|
1995
|
+
# @return [Types::Alarms]
|
1996
|
+
#
|
1919
1997
|
class CreatePortalRequest < Struct.new(
|
1920
1998
|
:portal_name,
|
1921
1999
|
:portal_description,
|
@@ -1924,7 +2002,9 @@ module Aws::IoTSiteWise
|
|
1924
2002
|
:portal_logo_image_file,
|
1925
2003
|
:role_arn,
|
1926
2004
|
:tags,
|
1927
|
-
:portal_auth_mode
|
2005
|
+
:portal_auth_mode,
|
2006
|
+
:notification_sender_email,
|
2007
|
+
:alarms)
|
1928
2008
|
SENSITIVE = []
|
1929
2009
|
include Aws::Structure
|
1930
2010
|
end
|
@@ -1944,9 +2024,9 @@ module Aws::IoTSiteWise
|
|
1944
2024
|
# @return [String]
|
1945
2025
|
#
|
1946
2026
|
# @!attribute [rw] portal_start_url
|
1947
|
-
# The URL for the
|
1948
|
-
#
|
1949
|
-
# 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
|
1950
2030
|
# SiteWise console to get a URL that you can use to access the portal.
|
1951
2031
|
# @return [String]
|
1952
2032
|
#
|
@@ -1956,7 +2036,8 @@ module Aws::IoTSiteWise
|
|
1956
2036
|
# @return [Types::PortalStatus]
|
1957
2037
|
#
|
1958
2038
|
# @!attribute [rw] sso_application_id
|
1959
|
-
# The associated
|
2039
|
+
# The associated Amazon Web Services SSO application ID, if the portal
|
2040
|
+
# uses Amazon Web Services SSO.
|
1960
2041
|
# @return [String]
|
1961
2042
|
#
|
1962
2043
|
class CreatePortalResponse < Struct.new(
|
@@ -2005,8 +2086,8 @@ module Aws::IoTSiteWise
|
|
2005
2086
|
#
|
2006
2087
|
# @!attribute [rw] tags
|
2007
2088
|
# A list of key-value pairs that contain metadata for the project. For
|
2008
|
-
# more information, see [Tagging your
|
2009
|
-
#
|
2089
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in
|
2090
|
+
# the *IoT SiteWise User Guide*.
|
2010
2091
|
#
|
2011
2092
|
#
|
2012
2093
|
#
|
@@ -2044,6 +2125,43 @@ module Aws::IoTSiteWise
|
|
2044
2125
|
include Aws::Structure
|
2045
2126
|
end
|
2046
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
|
+
|
2047
2165
|
# Contains a dashboard summary.
|
2048
2166
|
#
|
2049
2167
|
# @!attribute [rw] id
|
@@ -2332,13 +2450,13 @@ module Aws::IoTSiteWise
|
|
2332
2450
|
# @return [String]
|
2333
2451
|
#
|
2334
2452
|
# @!attribute [rw] access_policy_identity
|
2335
|
-
# The identity (
|
2336
|
-
# 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.
|
2337
2455
|
# @return [Types::Identity]
|
2338
2456
|
#
|
2339
2457
|
# @!attribute [rw] access_policy_resource
|
2340
|
-
# The
|
2341
|
-
#
|
2458
|
+
# The IoT SiteWise Monitor resource (portal or project) to which this
|
2459
|
+
# access policy provides access.
|
2342
2460
|
# @return [Types::Resource]
|
2343
2461
|
#
|
2344
2462
|
# @!attribute [rw] access_policy_permission
|
@@ -2639,8 +2757,7 @@ module Aws::IoTSiteWise
|
|
2639
2757
|
#
|
2640
2758
|
# @!attribute [rw] dashboard_definition
|
2641
2759
|
# The dashboard's definition JSON literal. For detailed information,
|
2642
|
-
# see [Creating dashboards (CLI)][1] in the *
|
2643
|
-
# Guide*.
|
2760
|
+
# see [Creating dashboards (CLI)][1] in the *IoT SiteWise User Guide*.
|
2644
2761
|
#
|
2645
2762
|
#
|
2646
2763
|
#
|
@@ -2678,7 +2795,7 @@ module Aws::IoTSiteWise
|
|
2678
2795
|
#
|
2679
2796
|
# @!attribute [rw] kms_key_arn
|
2680
2797
|
# The key ARN of the customer managed customer master key (CMK) used
|
2681
|
-
# for
|
2798
|
+
# for KMS encryption if you use `KMS_BASED_ENCRYPTION`.
|
2682
2799
|
# @return [String]
|
2683
2800
|
#
|
2684
2801
|
# @!attribute [rw] configuration_status
|
@@ -2709,8 +2826,8 @@ module Aws::IoTSiteWise
|
|
2709
2826
|
#
|
2710
2827
|
# @!attribute [rw] capability_namespace
|
2711
2828
|
# The namespace of the capability configuration. For example, if you
|
2712
|
-
# configure OPC-UA sources from the
|
2713
|
-
#
|
2829
|
+
# configure OPC-UA sources from the IoT SiteWise console, your OPC-UA
|
2830
|
+
# capability configuration has the namespace
|
2714
2831
|
# `iotsitewise:opcuacollector:version`, where `version` is a number
|
2715
2832
|
# such as `1`.
|
2716
2833
|
# @return [String]
|
@@ -2733,7 +2850,7 @@ module Aws::IoTSiteWise
|
|
2733
2850
|
# @!attribute [rw] capability_configuration
|
2734
2851
|
# The JSON document that defines the gateway capability's
|
2735
2852
|
# configuration. For more information, see [Configuring data sources
|
2736
|
-
# (CLI)][1] in the *
|
2853
|
+
# (CLI)][1] in the *IoT SiteWise User Guide*.
|
2737
2854
|
#
|
2738
2855
|
#
|
2739
2856
|
#
|
@@ -2885,20 +3002,21 @@ module Aws::IoTSiteWise
|
|
2885
3002
|
# @return [String]
|
2886
3003
|
#
|
2887
3004
|
# @!attribute [rw] portal_client_id
|
2888
|
-
# The
|
2889
|
-
# APIs).
|
2890
|
-
# 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.
|
2891
3009
|
# @return [String]
|
2892
3010
|
#
|
2893
3011
|
# @!attribute [rw] portal_start_url
|
2894
|
-
# The URL for the
|
2895
|
-
#
|
2896
|
-
# 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
|
2897
3015
|
# SiteWise console to get a URL that you can use to access the portal.
|
2898
3016
|
# @return [String]
|
2899
3017
|
#
|
2900
3018
|
# @!attribute [rw] portal_contact_email
|
2901
|
-
# The
|
3019
|
+
# The Amazon Web Services administrator's contact email address.
|
2902
3020
|
# @return [String]
|
2903
3021
|
#
|
2904
3022
|
# @!attribute [rw] portal_status
|
@@ -2920,9 +3038,9 @@ module Aws::IoTSiteWise
|
|
2920
3038
|
#
|
2921
3039
|
# @!attribute [rw] role_arn
|
2922
3040
|
# The [ARN][1] of the service role that allows the portal's users to
|
2923
|
-
# access your
|
2924
|
-
# information, see [Using service roles for
|
2925
|
-
#
|
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*.
|
2926
3044
|
#
|
2927
3045
|
#
|
2928
3046
|
#
|
@@ -2934,6 +3052,15 @@ module Aws::IoTSiteWise
|
|
2934
3052
|
# The service to use to authenticate users to the portal.
|
2935
3053
|
# @return [String]
|
2936
3054
|
#
|
3055
|
+
# @!attribute [rw] notification_sender_email
|
3056
|
+
# The email address that sends alarm notifications.
|
3057
|
+
# @return [String]
|
3058
|
+
#
|
3059
|
+
# @!attribute [rw] alarms
|
3060
|
+
# Contains the configuration information of an alarm created in an IoT
|
3061
|
+
# SiteWise Monitor portal.
|
3062
|
+
# @return [Types::Alarms]
|
3063
|
+
#
|
2937
3064
|
class DescribePortalResponse < Struct.new(
|
2938
3065
|
:portal_id,
|
2939
3066
|
:portal_arn,
|
@@ -2947,7 +3074,9 @@ module Aws::IoTSiteWise
|
|
2947
3074
|
:portal_last_update_date,
|
2948
3075
|
:portal_logo_image_location,
|
2949
3076
|
:role_arn,
|
2950
|
-
:portal_auth_mode
|
3077
|
+
:portal_auth_mode,
|
3078
|
+
:notification_sender_email,
|
3079
|
+
:alarms)
|
2951
3080
|
SENSITIVE = []
|
2952
3081
|
include Aws::Structure
|
2953
3082
|
end
|
@@ -3015,6 +3144,44 @@ module Aws::IoTSiteWise
|
|
3015
3144
|
include Aws::Structure
|
3016
3145
|
end
|
3017
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
|
+
|
3018
3185
|
# @note When making an API call, you may pass DisassociateAssetsRequest
|
3019
3186
|
# data as a hash:
|
3020
3187
|
#
|
@@ -3035,7 +3202,7 @@ module Aws::IoTSiteWise
|
|
3035
3202
|
# allow different groupings of assets to be formed that all come from
|
3036
3203
|
# the same asset model. You can use the hierarchy ID to identify the
|
3037
3204
|
# correct asset to disassociate. For more information, see [Asset
|
3038
|
-
# hierarchies][1] in the *
|
3205
|
+
# hierarchies][1] in the *IoT SiteWise User Guide*.
|
3039
3206
|
#
|
3040
3207
|
#
|
3041
3208
|
#
|
@@ -3064,7 +3231,7 @@ module Aws::IoTSiteWise
|
|
3064
3231
|
include Aws::Structure
|
3065
3232
|
end
|
3066
3233
|
|
3067
|
-
# Contains the details of an
|
3234
|
+
# Contains the details of an IoT SiteWise error.
|
3068
3235
|
#
|
3069
3236
|
# @!attribute [rw] code
|
3070
3237
|
# The error code.
|
@@ -3114,8 +3281,8 @@ module Aws::IoTSiteWise
|
|
3114
3281
|
#
|
3115
3282
|
# @!attribute [rw] capability_namespace
|
3116
3283
|
# The namespace of the capability configuration. For example, if you
|
3117
|
-
# configure OPC-UA sources from the
|
3118
|
-
#
|
3284
|
+
# configure OPC-UA sources from the IoT SiteWise console, your OPC-UA
|
3285
|
+
# capability configuration has the namespace
|
3119
3286
|
# `iotsitewise:opcuacollector:version`, where `version` is a number
|
3120
3287
|
# such as `1`.
|
3121
3288
|
# @return [String]
|
@@ -3151,7 +3318,7 @@ module Aws::IoTSiteWise
|
|
3151
3318
|
# }
|
3152
3319
|
#
|
3153
3320
|
# @!attribute [rw] greengrass
|
3154
|
-
# A gateway that runs on
|
3321
|
+
# A gateway that runs on IoT Greengrass.
|
3155
3322
|
# @return [Types::Greengrass]
|
3156
3323
|
#
|
3157
3324
|
class GatewayPlatform < Struct.new(
|
@@ -3225,11 +3392,11 @@ module Aws::IoTSiteWise
|
|
3225
3392
|
# @return [String]
|
3226
3393
|
#
|
3227
3394
|
# @!attribute [rw] property_alias
|
3228
|
-
# The
|
3229
|
-
#
|
3395
|
+
# The alias that identifies the property, such as an OPC-UA server
|
3396
|
+
# data stream path (for example,
|
3230
3397
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
3231
3398
|
# see [Mapping industrial data streams to asset properties][1] in the
|
3232
|
-
# *
|
3399
|
+
# *IoT SiteWise User Guide*.
|
3233
3400
|
#
|
3234
3401
|
#
|
3235
3402
|
#
|
@@ -3269,7 +3436,7 @@ module Aws::IoTSiteWise
|
|
3269
3436
|
# @return [String]
|
3270
3437
|
#
|
3271
3438
|
# @!attribute [rw] max_results
|
3272
|
-
# The maximum number of results to
|
3439
|
+
# The maximum number of results to return for each paginated request.
|
3273
3440
|
#
|
3274
3441
|
# Default: 100
|
3275
3442
|
# @return [Integer]
|
@@ -3330,11 +3497,11 @@ module Aws::IoTSiteWise
|
|
3330
3497
|
# @return [String]
|
3331
3498
|
#
|
3332
3499
|
# @!attribute [rw] property_alias
|
3333
|
-
# The
|
3334
|
-
#
|
3500
|
+
# The alias that identifies the property, such as an OPC-UA server
|
3501
|
+
# data stream path (for example,
|
3335
3502
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
3336
3503
|
# see [Mapping industrial data streams to asset properties][1] in the
|
3337
|
-
# *
|
3504
|
+
# *IoT SiteWise User Guide*.
|
3338
3505
|
#
|
3339
3506
|
#
|
3340
3507
|
#
|
@@ -3366,7 +3533,7 @@ module Aws::IoTSiteWise
|
|
3366
3533
|
# @return [String]
|
3367
3534
|
#
|
3368
3535
|
# @!attribute [rw] max_results
|
3369
|
-
# The maximum number of results to
|
3536
|
+
# The maximum number of results to return for each paginated request.
|
3370
3537
|
#
|
3371
3538
|
# Default: 100
|
3372
3539
|
# @return [Integer]
|
@@ -3419,11 +3586,11 @@ module Aws::IoTSiteWise
|
|
3419
3586
|
# @return [String]
|
3420
3587
|
#
|
3421
3588
|
# @!attribute [rw] property_alias
|
3422
|
-
# The
|
3423
|
-
#
|
3589
|
+
# The alias that identifies the property, such as an OPC-UA server
|
3590
|
+
# data stream path (for example,
|
3424
3591
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
3425
3592
|
# see [Mapping industrial data streams to asset properties][1] in the
|
3426
|
-
# *
|
3593
|
+
# *IoT SiteWise User Guide*.
|
3427
3594
|
#
|
3428
3595
|
#
|
3429
3596
|
#
|
@@ -3448,12 +3615,127 @@ module Aws::IoTSiteWise
|
|
3448
3615
|
include Aws::Structure
|
3449
3616
|
end
|
3450
3617
|
|
3451
|
-
#
|
3452
|
-
#
|
3453
|
-
#
|
3454
|
-
#
|
3455
|
-
#
|
3456
|
-
#
|
3618
|
+
# @note When making an API call, you may pass GetInterpolatedAssetPropertyValuesRequest
|
3619
|
+
# data as a hash:
|
3620
|
+
#
|
3621
|
+
# {
|
3622
|
+
# asset_id: "ID",
|
3623
|
+
# property_id: "ID",
|
3624
|
+
# property_alias: "AssetPropertyAlias",
|
3625
|
+
# start_time_in_seconds: 1, # required
|
3626
|
+
# start_time_offset_in_nanos: 1,
|
3627
|
+
# end_time_in_seconds: 1, # required
|
3628
|
+
# end_time_offset_in_nanos: 1,
|
3629
|
+
# quality: "GOOD", # required, accepts GOOD, BAD, UNCERTAIN
|
3630
|
+
# interval_in_seconds: 1, # required
|
3631
|
+
# next_token: "NextToken",
|
3632
|
+
# max_results: 1,
|
3633
|
+
# type: "InterpolationType", # required
|
3634
|
+
# }
|
3635
|
+
#
|
3636
|
+
# @!attribute [rw] asset_id
|
3637
|
+
# The ID of the asset.
|
3638
|
+
# @return [String]
|
3639
|
+
#
|
3640
|
+
# @!attribute [rw] property_id
|
3641
|
+
# The ID of the asset property.
|
3642
|
+
# @return [String]
|
3643
|
+
#
|
3644
|
+
# @!attribute [rw] property_alias
|
3645
|
+
# The alias that identifies the property, such as an OPC-UA server
|
3646
|
+
# data stream path (for example,
|
3647
|
+
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
3648
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
3649
|
+
# *IoT SiteWise User Guide*.
|
3650
|
+
#
|
3651
|
+
#
|
3652
|
+
#
|
3653
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
|
3654
|
+
# @return [String]
|
3655
|
+
#
|
3656
|
+
# @!attribute [rw] start_time_in_seconds
|
3657
|
+
# The exclusive start of the range from which to interpolate data,
|
3658
|
+
# expressed in seconds in Unix epoch time.
|
3659
|
+
# @return [Integer]
|
3660
|
+
#
|
3661
|
+
# @!attribute [rw] start_time_offset_in_nanos
|
3662
|
+
# The nanosecond offset converted from `startTimeInSeconds`.
|
3663
|
+
# @return [Integer]
|
3664
|
+
#
|
3665
|
+
# @!attribute [rw] end_time_in_seconds
|
3666
|
+
# The inclusive end of the range from which to interpolate data,
|
3667
|
+
# expressed in seconds in Unix epoch time.
|
3668
|
+
# @return [Integer]
|
3669
|
+
#
|
3670
|
+
# @!attribute [rw] end_time_offset_in_nanos
|
3671
|
+
# The nanosecond offset converted from `endTimeInSeconds`.
|
3672
|
+
# @return [Integer]
|
3673
|
+
#
|
3674
|
+
# @!attribute [rw] quality
|
3675
|
+
# The quality of the asset property value. You can use this parameter
|
3676
|
+
# as a filter to choose only the asset property values that have a
|
3677
|
+
# specific quality.
|
3678
|
+
# @return [String]
|
3679
|
+
#
|
3680
|
+
# @!attribute [rw] interval_in_seconds
|
3681
|
+
# The time interval in seconds over which to interpolate data. Each
|
3682
|
+
# interval starts when the previous one ends.
|
3683
|
+
# @return [Integer]
|
3684
|
+
#
|
3685
|
+
# @!attribute [rw] next_token
|
3686
|
+
# The token to be used for the next set of paginated results.
|
3687
|
+
# @return [String]
|
3688
|
+
#
|
3689
|
+
# @!attribute [rw] max_results
|
3690
|
+
# The maximum number of results to return for each paginated request.
|
3691
|
+
# If not specified, the default value is 10.
|
3692
|
+
# @return [Integer]
|
3693
|
+
#
|
3694
|
+
# @!attribute [rw] type
|
3695
|
+
# The interpolation type.
|
3696
|
+
#
|
3697
|
+
# Valid values: `LINEAR_INTERPOLATION`
|
3698
|
+
# @return [String]
|
3699
|
+
#
|
3700
|
+
class GetInterpolatedAssetPropertyValuesRequest < Struct.new(
|
3701
|
+
:asset_id,
|
3702
|
+
:property_id,
|
3703
|
+
:property_alias,
|
3704
|
+
:start_time_in_seconds,
|
3705
|
+
:start_time_offset_in_nanos,
|
3706
|
+
:end_time_in_seconds,
|
3707
|
+
:end_time_offset_in_nanos,
|
3708
|
+
:quality,
|
3709
|
+
:interval_in_seconds,
|
3710
|
+
:next_token,
|
3711
|
+
:max_results,
|
3712
|
+
:type)
|
3713
|
+
SENSITIVE = []
|
3714
|
+
include Aws::Structure
|
3715
|
+
end
|
3716
|
+
|
3717
|
+
# @!attribute [rw] interpolated_asset_property_values
|
3718
|
+
# The requested interpolated values.
|
3719
|
+
# @return [Array<Types::InterpolatedAssetPropertyValue>]
|
3720
|
+
#
|
3721
|
+
# @!attribute [rw] next_token
|
3722
|
+
# The token for the next set of results, or null if there are no
|
3723
|
+
# additional results.
|
3724
|
+
# @return [String]
|
3725
|
+
#
|
3726
|
+
class GetInterpolatedAssetPropertyValuesResponse < Struct.new(
|
3727
|
+
:interpolated_asset_property_values,
|
3728
|
+
:next_token)
|
3729
|
+
SENSITIVE = []
|
3730
|
+
include Aws::Structure
|
3731
|
+
end
|
3732
|
+
|
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*.
|
3457
3739
|
#
|
3458
3740
|
#
|
3459
3741
|
#
|
@@ -3469,7 +3751,7 @@ module Aws::IoTSiteWise
|
|
3469
3751
|
# @!attribute [rw] group_arn
|
3470
3752
|
# The [ARN][1] of the Greengrass group. For more information about how
|
3471
3753
|
# to find a group's ARN, see [ListGroups][2] and [GetGroup][3] in the
|
3472
|
-
# *
|
3754
|
+
# *IoT Greengrass API Reference*.
|
3473
3755
|
#
|
3474
3756
|
#
|
3475
3757
|
#
|
@@ -3494,7 +3776,7 @@ module Aws::IoTSiteWise
|
|
3494
3776
|
# }
|
3495
3777
|
#
|
3496
3778
|
# @!attribute [rw] id
|
3497
|
-
# The
|
3779
|
+
# The Amazon Web Services SSO ID of the group.
|
3498
3780
|
# @return [String]
|
3499
3781
|
#
|
3500
3782
|
class GroupIdentity < Struct.new(
|
@@ -3503,9 +3785,8 @@ module Aws::IoTSiteWise
|
|
3503
3785
|
include Aws::Structure
|
3504
3786
|
end
|
3505
3787
|
|
3506
|
-
# Contains information about an
|
3507
|
-
#
|
3508
|
-
# Guide*.
|
3788
|
+
# Contains information about an Identity and Access Management role. For
|
3789
|
+
# more information, see [IAM roles][1] in the *IAM User Guide*.
|
3509
3790
|
#
|
3510
3791
|
#
|
3511
3792
|
#
|
@@ -3524,7 +3805,7 @@ module Aws::IoTSiteWise
|
|
3524
3805
|
#
|
3525
3806
|
#
|
3526
3807
|
#
|
3527
|
-
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.
|
3808
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html
|
3528
3809
|
# @return [String]
|
3529
3810
|
#
|
3530
3811
|
class IAMRoleIdentity < Struct.new(
|
@@ -3533,8 +3814,7 @@ module Aws::IoTSiteWise
|
|
3533
3814
|
include Aws::Structure
|
3534
3815
|
end
|
3535
3816
|
|
3536
|
-
# Contains information about an
|
3537
|
-
# user.
|
3817
|
+
# Contains information about an Identity and Access Management user.
|
3538
3818
|
#
|
3539
3819
|
# @note When making an API call, you may pass IAMUserIdentity
|
3540
3820
|
# data as a hash:
|
@@ -3564,12 +3844,12 @@ module Aws::IoTSiteWise
|
|
3564
3844
|
include Aws::Structure
|
3565
3845
|
end
|
3566
3846
|
|
3567
|
-
# Contains an identity that can access an
|
3568
|
-
# resource.
|
3847
|
+
# Contains an identity that can access an IoT SiteWise Monitor resource.
|
3569
3848
|
#
|
3570
|
-
# <note markdown="1"> Currently, you can't use
|
3571
|
-
#
|
3572
|
-
# 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].
|
3573
3853
|
#
|
3574
3854
|
# </note>
|
3575
3855
|
#
|
@@ -3596,11 +3876,11 @@ module Aws::IoTSiteWise
|
|
3596
3876
|
# }
|
3597
3877
|
#
|
3598
3878
|
# @!attribute [rw] user
|
3599
|
-
# An
|
3879
|
+
# An Amazon Web Services SSO user identity.
|
3600
3880
|
# @return [Types::UserIdentity]
|
3601
3881
|
#
|
3602
3882
|
# @!attribute [rw] group
|
3603
|
-
# An
|
3883
|
+
# An Amazon Web Services SSO group identity.
|
3604
3884
|
# @return [Types::GroupIdentity]
|
3605
3885
|
#
|
3606
3886
|
# @!attribute [rw] iam_user
|
@@ -3680,8 +3960,8 @@ module Aws::IoTSiteWise
|
|
3680
3960
|
include Aws::Structure
|
3681
3961
|
end
|
3682
3962
|
|
3683
|
-
# Contains an image that is uploaded to
|
3684
|
-
#
|
3963
|
+
# Contains an image that is uploaded to IoT SiteWise and available at a
|
3964
|
+
# URL.
|
3685
3965
|
#
|
3686
3966
|
# @!attribute [rw] id
|
3687
3967
|
# The ID of the image.
|
@@ -3699,8 +3979,7 @@ module Aws::IoTSiteWise
|
|
3699
3979
|
include Aws::Structure
|
3700
3980
|
end
|
3701
3981
|
|
3702
|
-
#
|
3703
|
-
# later.
|
3982
|
+
# IoT SiteWise can't process your request right now. Try again later.
|
3704
3983
|
#
|
3705
3984
|
# @!attribute [rw] message
|
3706
3985
|
# @return [String]
|
@@ -3711,6 +3990,23 @@ module Aws::IoTSiteWise
|
|
3711
3990
|
include Aws::Structure
|
3712
3991
|
end
|
3713
3992
|
|
3993
|
+
# Contains information about an interpolated asset property value.
|
3994
|
+
#
|
3995
|
+
# @!attribute [rw] timestamp
|
3996
|
+
# Contains a timestamp with optional nanosecond granularity.
|
3997
|
+
# @return [Types::TimeInNanos]
|
3998
|
+
#
|
3999
|
+
# @!attribute [rw] value
|
4000
|
+
# Contains an asset property value (of a single type only).
|
4001
|
+
# @return [Types::Variant]
|
4002
|
+
#
|
4003
|
+
class InterpolatedAssetPropertyValue < Struct.new(
|
4004
|
+
:timestamp,
|
4005
|
+
:value)
|
4006
|
+
SENSITIVE = []
|
4007
|
+
include Aws::Structure
|
4008
|
+
end
|
4009
|
+
|
3714
4010
|
# The request isn't valid. This can occur if your request contains
|
3715
4011
|
# malformed JSON or unsupported characters. Check your request and try
|
3716
4012
|
# again.
|
@@ -3729,7 +4025,7 @@ module Aws::IoTSiteWise
|
|
3729
4025
|
# assets or attempting to create more than the allowed number of
|
3730
4026
|
# properties for an asset model.
|
3731
4027
|
#
|
3732
|
-
# For more information, see [Quotas][1] in the *
|
4028
|
+
# For more information, see [Quotas][1] in the *IoT SiteWise User
|
3733
4029
|
# Guide*.
|
3734
4030
|
#
|
3735
4031
|
#
|
@@ -3759,8 +4055,9 @@ module Aws::IoTSiteWise
|
|
3759
4055
|
# }
|
3760
4056
|
#
|
3761
4057
|
# @!attribute [rw] identity_type
|
3762
|
-
# The type of identity (
|
3763
|
-
# 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`.
|
3764
4061
|
# @return [String]
|
3765
4062
|
#
|
3766
4063
|
# @!attribute [rw] identity_id
|
@@ -3793,7 +4090,7 @@ module Aws::IoTSiteWise
|
|
3793
4090
|
# @return [String]
|
3794
4091
|
#
|
3795
4092
|
# @!attribute [rw] max_results
|
3796
|
-
# The maximum number of results to
|
4093
|
+
# The maximum number of results to return for each paginated request.
|
3797
4094
|
#
|
3798
4095
|
# Default: 50
|
3799
4096
|
# @return [Integer]
|
@@ -3839,7 +4136,7 @@ module Aws::IoTSiteWise
|
|
3839
4136
|
# @return [String]
|
3840
4137
|
#
|
3841
4138
|
# @!attribute [rw] max_results
|
3842
|
-
# The maximum number of results to
|
4139
|
+
# The maximum number of results to return for each paginated request.
|
3843
4140
|
#
|
3844
4141
|
# Default: 50
|
3845
4142
|
# @return [Integer]
|
@@ -3898,7 +4195,7 @@ module Aws::IoTSiteWise
|
|
3898
4195
|
# @return [String]
|
3899
4196
|
#
|
3900
4197
|
# @!attribute [rw] max_results
|
3901
|
-
# The maximum number of results to
|
4198
|
+
# The maximum number of results to return for each paginated request.
|
3902
4199
|
# @return [Integer]
|
3903
4200
|
#
|
3904
4201
|
class ListAssetRelationshipsRequest < Struct.new(
|
@@ -3941,7 +4238,7 @@ module Aws::IoTSiteWise
|
|
3941
4238
|
# @return [String]
|
3942
4239
|
#
|
3943
4240
|
# @!attribute [rw] max_results
|
3944
|
-
# The maximum number of results to
|
4241
|
+
# The maximum number of results to return for each paginated request.
|
3945
4242
|
#
|
3946
4243
|
# Default: 50
|
3947
4244
|
# @return [Integer]
|
@@ -4010,7 +4307,7 @@ module Aws::IoTSiteWise
|
|
4010
4307
|
# [DescribeAssetModel][2] operations. This parameter is required if
|
4011
4308
|
# you choose `CHILD` for `traversalDirection`.
|
4012
4309
|
#
|
4013
|
-
# For more information, see [Asset hierarchies][3] in the *
|
4310
|
+
# For more information, see [Asset hierarchies][3] in the *IoT
|
4014
4311
|
# SiteWise User Guide*.
|
4015
4312
|
#
|
4016
4313
|
#
|
@@ -4038,7 +4335,7 @@ module Aws::IoTSiteWise
|
|
4038
4335
|
# @return [String]
|
4039
4336
|
#
|
4040
4337
|
# @!attribute [rw] max_results
|
4041
|
-
# The maximum number of results to
|
4338
|
+
# The maximum number of results to return for each paginated request.
|
4042
4339
|
#
|
4043
4340
|
# Default: 50
|
4044
4341
|
# @return [Integer]
|
@@ -4087,7 +4384,7 @@ module Aws::IoTSiteWise
|
|
4087
4384
|
# @return [String]
|
4088
4385
|
#
|
4089
4386
|
# @!attribute [rw] max_results
|
4090
|
-
# The maximum number of results to
|
4387
|
+
# The maximum number of results to return for each paginated request.
|
4091
4388
|
#
|
4092
4389
|
# Default: 50
|
4093
4390
|
# @return [Integer]
|
@@ -4129,7 +4426,7 @@ module Aws::IoTSiteWise
|
|
4129
4426
|
# @return [String]
|
4130
4427
|
#
|
4131
4428
|
# @!attribute [rw] max_results
|
4132
|
-
# The maximum number of results to
|
4429
|
+
# The maximum number of results to return for each paginated request.
|
4133
4430
|
#
|
4134
4431
|
# Default: 50
|
4135
4432
|
# @return [Integer]
|
@@ -4170,7 +4467,7 @@ module Aws::IoTSiteWise
|
|
4170
4467
|
# @return [String]
|
4171
4468
|
#
|
4172
4469
|
# @!attribute [rw] max_results
|
4173
|
-
# The maximum number of results to
|
4470
|
+
# The maximum number of results to return for each paginated request.
|
4174
4471
|
#
|
4175
4472
|
# Default: 50
|
4176
4473
|
# @return [Integer]
|
@@ -4216,7 +4513,7 @@ module Aws::IoTSiteWise
|
|
4216
4513
|
# @return [String]
|
4217
4514
|
#
|
4218
4515
|
# @!attribute [rw] max_results
|
4219
|
-
# The maximum number of results to
|
4516
|
+
# The maximum number of results to return for each paginated request.
|
4220
4517
|
#
|
4221
4518
|
# Default: 50
|
4222
4519
|
# @return [Integer]
|
@@ -4264,7 +4561,7 @@ module Aws::IoTSiteWise
|
|
4264
4561
|
# @return [String]
|
4265
4562
|
#
|
4266
4563
|
# @!attribute [rw] max_results
|
4267
|
-
# The maximum number of results to
|
4564
|
+
# The maximum number of results to return for each paginated request.
|
4268
4565
|
#
|
4269
4566
|
# Default: 50
|
4270
4567
|
# @return [Integer]
|
@@ -4316,8 +4613,8 @@ module Aws::IoTSiteWise
|
|
4316
4613
|
|
4317
4614
|
# @!attribute [rw] tags
|
4318
4615
|
# The list of key-value pairs that contain metadata for the resource.
|
4319
|
-
# For more information, see [Tagging your
|
4320
|
-
#
|
4616
|
+
# For more information, see [Tagging your IoT SiteWise resources][1]
|
4617
|
+
# in the *IoT SiteWise User Guide*.
|
4321
4618
|
#
|
4322
4619
|
#
|
4323
4620
|
#
|
@@ -4340,7 +4637,7 @@ module Aws::IoTSiteWise
|
|
4340
4637
|
# }
|
4341
4638
|
#
|
4342
4639
|
# @!attribute [rw] level
|
4343
|
-
# The
|
4640
|
+
# The IoT SiteWise logging verbosity level.
|
4344
4641
|
# @return [String]
|
4345
4642
|
#
|
4346
4643
|
class LoggingOptions < Struct.new(
|
@@ -4350,7 +4647,7 @@ module Aws::IoTSiteWise
|
|
4350
4647
|
end
|
4351
4648
|
|
4352
4649
|
# Contains an asset measurement property. For more information, see
|
4353
|
-
# [Measurements][1] in the *
|
4650
|
+
# [Measurements][1] in the *IoT SiteWise User Guide*.
|
4354
4651
|
#
|
4355
4652
|
#
|
4356
4653
|
#
|
@@ -4371,7 +4668,7 @@ module Aws::IoTSiteWise
|
|
4371
4668
|
# a metric can only have a data type of `DOUBLE` and consume properties
|
4372
4669
|
# with data types of `INTEGER` or `DOUBLE`.
|
4373
4670
|
#
|
4374
|
-
# For more information, see [Metrics][1] in the *
|
4671
|
+
# For more information, see [Metrics][1] in the *IoT SiteWise User
|
4375
4672
|
# Guide*.
|
4376
4673
|
#
|
4377
4674
|
#
|
@@ -4404,7 +4701,7 @@ module Aws::IoTSiteWise
|
|
4404
4701
|
# function. You can specify up to 10 variables per expression. You can
|
4405
4702
|
# specify up to 10 functions per expression.
|
4406
4703
|
#
|
4407
|
-
# For more information, see [Quotas][1] in the *
|
4704
|
+
# For more information, see [Quotas][1] in the *IoT SiteWise User
|
4408
4705
|
# Guide*.
|
4409
4706
|
#
|
4410
4707
|
#
|
@@ -4417,8 +4714,8 @@ module Aws::IoTSiteWise
|
|
4417
4714
|
# @return [Array<Types::ExpressionVariable>]
|
4418
4715
|
#
|
4419
4716
|
# @!attribute [rw] window
|
4420
|
-
# The window (time interval) over which
|
4421
|
-
# 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
|
4422
4719
|
# point per `window`.
|
4423
4720
|
# @return [Types::MetricWindow]
|
4424
4721
|
#
|
@@ -4452,7 +4749,7 @@ module Aws::IoTSiteWise
|
|
4452
4749
|
include Aws::Structure
|
4453
4750
|
end
|
4454
4751
|
|
4455
|
-
# Contains
|
4752
|
+
# Contains IoT SiteWise Monitor error details.
|
4456
4753
|
#
|
4457
4754
|
# @!attribute [rw] code
|
4458
4755
|
# The error code.
|
@@ -4469,7 +4766,29 @@ module Aws::IoTSiteWise
|
|
4469
4766
|
include Aws::Structure
|
4470
4767
|
end
|
4471
4768
|
|
4472
|
-
#
|
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.
|
4473
4792
|
#
|
4474
4793
|
# @note When making an API call, you may pass PortalResource
|
4475
4794
|
# data as a hash:
|
@@ -4520,9 +4839,9 @@ module Aws::IoTSiteWise
|
|
4520
4839
|
# @return [String]
|
4521
4840
|
#
|
4522
4841
|
# @!attribute [rw] start_url
|
4523
|
-
# The URL for the
|
4524
|
-
#
|
4525
|
-
# 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
|
4526
4845
|
# SiteWise console to get a URL that you can use to access the portal.
|
4527
4846
|
# @return [String]
|
4528
4847
|
#
|
@@ -4536,9 +4855,9 @@ module Aws::IoTSiteWise
|
|
4536
4855
|
#
|
4537
4856
|
# @!attribute [rw] role_arn
|
4538
4857
|
# The [ARN][1] of the service role that allows the portal's users to
|
4539
|
-
# access your
|
4540
|
-
# information, see [Using service roles for
|
4541
|
-
#
|
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*.
|
4542
4861
|
#
|
4543
4862
|
#
|
4544
4863
|
#
|
@@ -4563,7 +4882,7 @@ module Aws::IoTSiteWise
|
|
4563
4882
|
include Aws::Structure
|
4564
4883
|
end
|
4565
4884
|
|
4566
|
-
# Identifies a specific
|
4885
|
+
# Identifies a specific IoT SiteWise Monitor project.
|
4567
4886
|
#
|
4568
4887
|
# @note When making an API call, you may pass ProjectResource
|
4569
4888
|
# data as a hash:
|
@@ -4625,11 +4944,11 @@ module Aws::IoTSiteWise
|
|
4625
4944
|
# @return [String]
|
4626
4945
|
#
|
4627
4946
|
# @!attribute [rw] alias
|
4628
|
-
# The
|
4629
|
-
#
|
4947
|
+
# The alias that identifies the property, such as an OPC-UA server
|
4948
|
+
# data stream path (for example,
|
4630
4949
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
4631
4950
|
# see [Mapping industrial data streams to asset properties][1] in the
|
4632
|
-
# *
|
4951
|
+
# *IoT SiteWise User Guide*.
|
4633
4952
|
#
|
4634
4953
|
#
|
4635
4954
|
#
|
@@ -4671,18 +4990,17 @@ module Aws::IoTSiteWise
|
|
4671
4990
|
end
|
4672
4991
|
|
4673
4992
|
# Contains asset property value notification information. When the
|
4674
|
-
# notification state is enabled,
|
4675
|
-
#
|
4676
|
-
#
|
4677
|
-
# 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*.
|
4678
4996
|
#
|
4679
4997
|
#
|
4680
4998
|
#
|
4681
4999
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html
|
4682
5000
|
#
|
4683
5001
|
# @!attribute [rw] topic
|
4684
|
-
# The MQTT topic to which
|
4685
|
-
#
|
5002
|
+
# The MQTT topic to which IoT SiteWise publishes property value update
|
5003
|
+
# notifications.
|
4686
5004
|
# @return [String]
|
4687
5005
|
#
|
4688
5006
|
# @!attribute [rw] state
|
@@ -4825,11 +5143,11 @@ module Aws::IoTSiteWise
|
|
4825
5143
|
# @return [String]
|
4826
5144
|
#
|
4827
5145
|
# @!attribute [rw] property_alias
|
4828
|
-
# The
|
4829
|
-
#
|
5146
|
+
# The alias that identifies the property, such as an OPC-UA server
|
5147
|
+
# data stream path (for example,
|
4830
5148
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
4831
5149
|
# see [Mapping industrial data streams to asset properties][1] in the
|
4832
|
-
# *
|
5150
|
+
# *IoT SiteWise User Guide*.
|
4833
5151
|
#
|
4834
5152
|
#
|
4835
5153
|
#
|
@@ -4865,7 +5183,7 @@ module Aws::IoTSiteWise
|
|
4865
5183
|
#
|
4866
5184
|
# @!attribute [rw] kms_key_id
|
4867
5185
|
# The Key ID of the customer managed customer master key (CMK) used
|
4868
|
-
# for
|
5186
|
+
# for KMS encryption. This is required if you use
|
4869
5187
|
# `KMS_BASED_ENCRYPTION`.
|
4870
5188
|
# @return [String]
|
4871
5189
|
#
|
@@ -4881,8 +5199,8 @@ module Aws::IoTSiteWise
|
|
4881
5199
|
# @return [String]
|
4882
5200
|
#
|
4883
5201
|
# @!attribute [rw] kms_key_arn
|
4884
|
-
# The Key ARN of the
|
4885
|
-
#
|
5202
|
+
# The Key ARN of the KMS CMK used for KMS encryption if you use
|
5203
|
+
# `KMS_BASED_ENCRYPTION`.
|
4886
5204
|
# @return [String]
|
4887
5205
|
#
|
4888
5206
|
# @!attribute [rw] configuration_status
|
@@ -4920,8 +5238,73 @@ module Aws::IoTSiteWise
|
|
4920
5238
|
|
4921
5239
|
class PutLoggingOptionsResponse < Aws::EmptyStructure; end
|
4922
5240
|
|
4923
|
-
#
|
4924
|
-
#
|
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.
|
4925
5308
|
#
|
4926
5309
|
# @note When making an API call, you may pass Resource
|
4927
5310
|
# data as a hash:
|
@@ -5013,8 +5396,8 @@ module Aws::IoTSiteWise
|
|
5013
5396
|
#
|
5014
5397
|
# @!attribute [rw] tags
|
5015
5398
|
# A list of key-value pairs that contain metadata for the resource.
|
5016
|
-
# For more information, see [Tagging your
|
5017
|
-
#
|
5399
|
+
# For more information, see [Tagging your IoT SiteWise resources][1]
|
5400
|
+
# in the *IoT SiteWise User Guide*.
|
5018
5401
|
#
|
5019
5402
|
#
|
5020
5403
|
#
|
@@ -5031,10 +5414,10 @@ module Aws::IoTSiteWise
|
|
5031
5414
|
class TagResourceResponse < Aws::EmptyStructure; end
|
5032
5415
|
|
5033
5416
|
# Your request exceeded a rate limit. For example, you might have
|
5034
|
-
# exceeded the number of
|
5417
|
+
# exceeded the number of IoT SiteWise assets that can be created per
|
5035
5418
|
# second, the allowed number of messages per second, and so on.
|
5036
5419
|
#
|
5037
|
-
# For more information, see [Quotas][1] in the *
|
5420
|
+
# For more information, see [Quotas][1] in the *IoT SiteWise User
|
5038
5421
|
# Guide*.
|
5039
5422
|
#
|
5040
5423
|
#
|
@@ -5078,7 +5461,7 @@ module Aws::IoTSiteWise
|
|
5078
5461
|
|
5079
5462
|
# You've reached the limit for the number of tags allowed for a
|
5080
5463
|
# resource. For more information, see [Tag naming limits and
|
5081
|
-
# requirements][1] in the *
|
5464
|
+
# requirements][1] in the *Amazon Web Services General Reference*.
|
5082
5465
|
#
|
5083
5466
|
#
|
5084
5467
|
#
|
@@ -5106,8 +5489,8 @@ module Aws::IoTSiteWise
|
|
5106
5489
|
# `DOUBLE` and consume properties with data types of `INTEGER` or
|
5107
5490
|
# `DOUBLE`.
|
5108
5491
|
#
|
5109
|
-
# For more information, see [Transforms][1] in the *
|
5110
|
-
#
|
5492
|
+
# For more information, see [Transforms][1] in the *IoT SiteWise User
|
5493
|
+
# Guide*.
|
5111
5494
|
#
|
5112
5495
|
#
|
5113
5496
|
#
|
@@ -5134,7 +5517,7 @@ module Aws::IoTSiteWise
|
|
5134
5517
|
# function. You can specify up to 10 variables per expression. You can
|
5135
5518
|
# specify up to 10 functions per expression.
|
5136
5519
|
#
|
5137
|
-
# For more information, see [Quotas][1] in the *
|
5520
|
+
# For more information, see [Quotas][1] in the *IoT SiteWise User
|
5138
5521
|
# Guide*.
|
5139
5522
|
#
|
5140
5523
|
#
|
@@ -5167,15 +5550,15 @@ module Aws::IoTSiteWise
|
|
5167
5550
|
# @!attribute [rw] interval
|
5168
5551
|
# The time interval for the tumbling window. Note that `w` represents
|
5169
5552
|
# weeks, `d` represents days, `h` represents hours, and `m` represents
|
5170
|
-
# minutes.
|
5171
|
-
#
|
5172
|
-
#
|
5173
|
-
#
|
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.
|
5174
5557
|
#
|
5175
|
-
# When
|
5176
|
-
#
|
5177
|
-
#
|
5178
|
-
#
|
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.
|
5179
5562
|
# @return [String]
|
5180
5563
|
#
|
5181
5564
|
class TumblingWindow < Struct.new(
|
@@ -5260,12 +5643,12 @@ module Aws::IoTSiteWise
|
|
5260
5643
|
# @return [String]
|
5261
5644
|
#
|
5262
5645
|
# @!attribute [rw] access_policy_identity
|
5263
|
-
# The identity for this access policy. Choose an
|
5264
|
-
# 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.
|
5265
5648
|
# @return [Types::Identity]
|
5266
5649
|
#
|
5267
5650
|
# @!attribute [rw] access_policy_resource
|
5268
|
-
# The
|
5651
|
+
# The IoT SiteWise Monitor resource for this access policy. Choose
|
5269
5652
|
# either a portal or a project.
|
5270
5653
|
# @return [Types::Resource]
|
5271
5654
|
#
|
@@ -5423,11 +5806,11 @@ module Aws::IoTSiteWise
|
|
5423
5806
|
#
|
5424
5807
|
# @!attribute [rw] asset_model_properties
|
5425
5808
|
# The updated property definitions of the asset model. For more
|
5426
|
-
# information, see [Asset properties][1] in the *
|
5809
|
+
# information, see [Asset properties][1] in the *IoT SiteWise User
|
5427
5810
|
# Guide*.
|
5428
5811
|
#
|
5429
5812
|
# You can specify up to 200 properties per asset model. For more
|
5430
|
-
# information, see [Quotas][2] in the *
|
5813
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
5431
5814
|
#
|
5432
5815
|
#
|
5433
5816
|
#
|
@@ -5439,10 +5822,10 @@ module Aws::IoTSiteWise
|
|
5439
5822
|
# The updated hierarchy definitions of the asset model. Each hierarchy
|
5440
5823
|
# specifies an asset model whose assets can be children of any other
|
5441
5824
|
# assets created from this asset model. For more information, see
|
5442
|
-
# [Asset hierarchies][1] in the *
|
5825
|
+
# [Asset hierarchies][1] in the *IoT SiteWise User Guide*.
|
5443
5826
|
#
|
5444
5827
|
# You can specify up to 10 hierarchies per asset model. For more
|
5445
|
-
# information, see [Quotas][2] in the *
|
5828
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
5446
5829
|
#
|
5447
5830
|
#
|
5448
5831
|
#
|
@@ -5510,11 +5893,11 @@ module Aws::IoTSiteWise
|
|
5510
5893
|
# @return [String]
|
5511
5894
|
#
|
5512
5895
|
# @!attribute [rw] property_alias
|
5513
|
-
# The
|
5514
|
-
#
|
5896
|
+
# The alias that identifies the property, such as an OPC-UA server
|
5897
|
+
# data stream path (for example,
|
5515
5898
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
5516
5899
|
# see [Mapping industrial data streams to asset properties][1] in the
|
5517
|
-
# *
|
5900
|
+
# *IoT SiteWise User Guide*.
|
5518
5901
|
#
|
5519
5902
|
# If you omit this parameter, the alias is removed from the property.
|
5520
5903
|
#
|
@@ -5525,10 +5908,10 @@ module Aws::IoTSiteWise
|
|
5525
5908
|
#
|
5526
5909
|
# @!attribute [rw] property_notification_state
|
5527
5910
|
# The MQTT notification state (enabled or disabled) for this asset
|
5528
|
-
# property. When the notification state is enabled,
|
5911
|
+
# property. When the notification state is enabled, IoT SiteWise
|
5529
5912
|
# publishes property value updates to a unique MQTT topic. For more
|
5530
|
-
# information, see [Interacting with other services][1] in the *
|
5531
|
-
#
|
5913
|
+
# information, see [Interacting with other services][1] in the *IoT
|
5914
|
+
# SiteWise User Guide*.
|
5532
5915
|
#
|
5533
5916
|
# If you omit this parameter, the notification state is set to
|
5534
5917
|
# `DISABLED`.
|
@@ -5627,8 +6010,8 @@ module Aws::IoTSiteWise
|
|
5627
6010
|
#
|
5628
6011
|
# @!attribute [rw] dashboard_definition
|
5629
6012
|
# The new dashboard definition, as specified in a JSON literal. For
|
5630
|
-
# detailed information, see [Creating dashboards (CLI)][1] in the *
|
5631
|
-
#
|
6013
|
+
# detailed information, see [Creating dashboards (CLI)][1] in the *IoT
|
6014
|
+
# SiteWise User Guide*.
|
5632
6015
|
#
|
5633
6016
|
#
|
5634
6017
|
#
|
@@ -5671,16 +6054,16 @@ module Aws::IoTSiteWise
|
|
5671
6054
|
#
|
5672
6055
|
# @!attribute [rw] capability_namespace
|
5673
6056
|
# The namespace of the gateway capability configuration to be updated.
|
5674
|
-
# For example, if you configure OPC-UA sources from the
|
5675
|
-
#
|
5676
|
-
#
|
5677
|
-
#
|
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`.
|
5678
6061
|
# @return [String]
|
5679
6062
|
#
|
5680
6063
|
# @!attribute [rw] capability_configuration
|
5681
6064
|
# The JSON document that defines the configuration for the gateway
|
5682
6065
|
# capability. For more information, see [Configuring data sources
|
5683
|
-
# (CLI)][1] in the *
|
6066
|
+
# (CLI)][1] in the *IoT SiteWise User Guide*.
|
5684
6067
|
#
|
5685
6068
|
#
|
5686
6069
|
#
|
@@ -5762,6 +6145,11 @@ module Aws::IoTSiteWise
|
|
5762
6145
|
# },
|
5763
6146
|
# role_arn: "ARN", # required
|
5764
6147
|
# client_token: "ClientToken",
|
6148
|
+
# notification_sender_email: "Email",
|
6149
|
+
# alarms: {
|
6150
|
+
# alarm_role_arn: "ARN", # required
|
6151
|
+
# notification_lambda_arn: "ARN",
|
6152
|
+
# },
|
5765
6153
|
# }
|
5766
6154
|
#
|
5767
6155
|
# @!attribute [rw] portal_id
|
@@ -5777,7 +6165,7 @@ module Aws::IoTSiteWise
|
|
5777
6165
|
# @return [String]
|
5778
6166
|
#
|
5779
6167
|
# @!attribute [rw] portal_contact_email
|
5780
|
-
# The
|
6168
|
+
# The Amazon Web Services administrator's contact email address.
|
5781
6169
|
# @return [String]
|
5782
6170
|
#
|
5783
6171
|
# @!attribute [rw] portal_logo_image
|
@@ -5791,9 +6179,9 @@ module Aws::IoTSiteWise
|
|
5791
6179
|
#
|
5792
6180
|
# @!attribute [rw] role_arn
|
5793
6181
|
# The [ARN][1] of a service role that allows the portal's users to
|
5794
|
-
# access your
|
5795
|
-
# information, see [Using service roles for
|
5796
|
-
#
|
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*.
|
5797
6185
|
#
|
5798
6186
|
#
|
5799
6187
|
#
|
@@ -5810,6 +6198,22 @@ module Aws::IoTSiteWise
|
|
5810
6198
|
# not need to pass this option.
|
5811
6199
|
# @return [String]
|
5812
6200
|
#
|
6201
|
+
# @!attribute [rw] notification_sender_email
|
6202
|
+
# The email address that sends alarm notifications.
|
6203
|
+
# @return [String]
|
6204
|
+
#
|
6205
|
+
# @!attribute [rw] alarms
|
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
|
6215
|
+
# @return [Types::Alarms]
|
6216
|
+
#
|
5813
6217
|
class UpdatePortalRequest < Struct.new(
|
5814
6218
|
:portal_id,
|
5815
6219
|
:portal_name,
|
@@ -5817,7 +6221,9 @@ module Aws::IoTSiteWise
|
|
5817
6221
|
:portal_contact_email,
|
5818
6222
|
:portal_logo_image,
|
5819
6223
|
:role_arn,
|
5820
|
-
:client_token
|
6224
|
+
:client_token,
|
6225
|
+
:notification_sender_email,
|
6226
|
+
:alarms)
|
5821
6227
|
SENSITIVE = []
|
5822
6228
|
include Aws::Structure
|
5823
6229
|
end
|
@@ -5885,7 +6291,7 @@ module Aws::IoTSiteWise
|
|
5885
6291
|
# }
|
5886
6292
|
#
|
5887
6293
|
# @!attribute [rw] id
|
5888
|
-
# The
|
6294
|
+
# The Amazon Web Services SSO ID of the user.
|
5889
6295
|
# @return [String]
|
5890
6296
|
#
|
5891
6297
|
class UserIdentity < Struct.new(
|
@@ -5917,7 +6323,7 @@ module Aws::IoTSiteWise
|
|
5917
6323
|
# several hierarchies using the same model and therefore the same
|
5918
6324
|
# `propertyId`. For example, you might have separately grouped assets
|
5919
6325
|
# that come from the same asset model. For more information, see
|
5920
|
-
# [Asset hierarchies][1] in the *
|
6326
|
+
# [Asset hierarchies][1] in the *IoT SiteWise User Guide*.
|
5921
6327
|
#
|
5922
6328
|
#
|
5923
6329
|
#
|