aws-sdk-iotsitewise 1.39.0 → 1.42.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +250 -2
- data/lib/aws-sdk-iotsitewise/client_api.rb +244 -0
- data/lib/aws-sdk-iotsitewise/types.rb +950 -158
- data/lib/aws-sdk-iotsitewise.rb +1 -1
- metadata +4 -4
@@ -982,6 +982,10 @@ module Aws::IoTSiteWise
|
|
982
982
|
# hierarchy specifies allowed parent/child asset relationships.
|
983
983
|
# @return [Array<Types::AssetHierarchy>]
|
984
984
|
#
|
985
|
+
# @!attribute [rw] description
|
986
|
+
# A description for the asset.
|
987
|
+
# @return [String]
|
988
|
+
#
|
985
989
|
class AssetSummary < Struct.new(
|
986
990
|
:id,
|
987
991
|
:arn,
|
@@ -990,7 +994,8 @@ module Aws::IoTSiteWise
|
|
990
994
|
:creation_date,
|
991
995
|
:last_update_date,
|
992
996
|
:status,
|
993
|
-
:hierarchies
|
997
|
+
:hierarchies,
|
998
|
+
:description)
|
994
999
|
SENSITIVE = []
|
995
1000
|
include Aws::Structure
|
996
1001
|
end
|
@@ -1017,241 +1022,1011 @@ module Aws::IoTSiteWise
|
|
1017
1022
|
#
|
1018
1023
|
#
|
1019
1024
|
#
|
1020
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
|
1025
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
|
1026
|
+
# @return [String]
|
1027
|
+
#
|
1028
|
+
# @!attribute [rw] child_asset_id
|
1029
|
+
# The ID of the child asset to be associated.
|
1030
|
+
# @return [String]
|
1031
|
+
#
|
1032
|
+
# @!attribute [rw] client_token
|
1033
|
+
# A unique case-sensitive identifier that you can provide to ensure
|
1034
|
+
# the idempotency of the request. Don't reuse this client token if a
|
1035
|
+
# new idempotent request is required.
|
1036
|
+
#
|
1037
|
+
# **A suitable default value is auto-generated.** You should normally
|
1038
|
+
# not need to pass this option.
|
1039
|
+
# @return [String]
|
1040
|
+
#
|
1041
|
+
class AssociateAssetsRequest < Struct.new(
|
1042
|
+
:asset_id,
|
1043
|
+
:hierarchy_id,
|
1044
|
+
:child_asset_id,
|
1045
|
+
:client_token)
|
1046
|
+
SENSITIVE = []
|
1047
|
+
include Aws::Structure
|
1048
|
+
end
|
1049
|
+
|
1050
|
+
# @note When making an API call, you may pass AssociateTimeSeriesToAssetPropertyRequest
|
1051
|
+
# data as a hash:
|
1052
|
+
#
|
1053
|
+
# {
|
1054
|
+
# alias: "PropertyAlias", # required
|
1055
|
+
# asset_id: "ID", # required
|
1056
|
+
# property_id: "ID", # required
|
1057
|
+
# client_token: "ClientToken",
|
1058
|
+
# }
|
1059
|
+
#
|
1060
|
+
# @!attribute [rw] alias
|
1061
|
+
# The alias that identifies the time series.
|
1062
|
+
# @return [String]
|
1063
|
+
#
|
1064
|
+
# @!attribute [rw] asset_id
|
1065
|
+
# The ID of the asset in which the asset property was created.
|
1066
|
+
# @return [String]
|
1067
|
+
#
|
1068
|
+
# @!attribute [rw] property_id
|
1069
|
+
# The ID of the asset property.
|
1070
|
+
# @return [String]
|
1071
|
+
#
|
1072
|
+
# @!attribute [rw] client_token
|
1073
|
+
# A unique case-sensitive identifier that you can provide to ensure
|
1074
|
+
# the idempotency of the request. Don't reuse this client token if a
|
1075
|
+
# new idempotent request is required.
|
1076
|
+
#
|
1077
|
+
# **A suitable default value is auto-generated.** You should normally
|
1078
|
+
# not need to pass this option.
|
1079
|
+
# @return [String]
|
1080
|
+
#
|
1081
|
+
class AssociateTimeSeriesToAssetPropertyRequest < Struct.new(
|
1082
|
+
:alias,
|
1083
|
+
:asset_id,
|
1084
|
+
:property_id,
|
1085
|
+
:client_token)
|
1086
|
+
SENSITIVE = []
|
1087
|
+
include Aws::Structure
|
1088
|
+
end
|
1089
|
+
|
1090
|
+
# Contains a summary of an associated asset.
|
1091
|
+
#
|
1092
|
+
# @!attribute [rw] id
|
1093
|
+
# The ID of the asset.
|
1094
|
+
# @return [String]
|
1095
|
+
#
|
1096
|
+
# @!attribute [rw] arn
|
1097
|
+
# The [ARN][1] of the asset, which has the following format.
|
1098
|
+
#
|
1099
|
+
# `arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset/$\{AssetId\}`
|
1100
|
+
#
|
1101
|
+
#
|
1102
|
+
#
|
1103
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1104
|
+
# @return [String]
|
1105
|
+
#
|
1106
|
+
# @!attribute [rw] name
|
1107
|
+
# The name of the asset.
|
1108
|
+
# @return [String]
|
1109
|
+
#
|
1110
|
+
# @!attribute [rw] asset_model_id
|
1111
|
+
# The ID of the asset model used to create the asset.
|
1112
|
+
# @return [String]
|
1113
|
+
#
|
1114
|
+
# @!attribute [rw] creation_date
|
1115
|
+
# The date the asset was created, in Unix epoch time.
|
1116
|
+
# @return [Time]
|
1117
|
+
#
|
1118
|
+
# @!attribute [rw] last_update_date
|
1119
|
+
# The date the asset was last updated, in Unix epoch time.
|
1120
|
+
# @return [Time]
|
1121
|
+
#
|
1122
|
+
# @!attribute [rw] status
|
1123
|
+
# The current status of the asset.
|
1124
|
+
# @return [Types::AssetStatus]
|
1125
|
+
#
|
1126
|
+
# @!attribute [rw] hierarchies
|
1127
|
+
# A list of asset hierarchies that each contain a `hierarchyId`. A
|
1128
|
+
# hierarchy specifies allowed parent/child asset relationships.
|
1129
|
+
# @return [Array<Types::AssetHierarchy>]
|
1130
|
+
#
|
1131
|
+
# @!attribute [rw] description
|
1132
|
+
# A description for the asset.
|
1133
|
+
# @return [String]
|
1134
|
+
#
|
1135
|
+
class AssociatedAssetsSummary < Struct.new(
|
1136
|
+
:id,
|
1137
|
+
:arn,
|
1138
|
+
:name,
|
1139
|
+
:asset_model_id,
|
1140
|
+
:creation_date,
|
1141
|
+
:last_update_date,
|
1142
|
+
:status,
|
1143
|
+
:hierarchies,
|
1144
|
+
:description)
|
1145
|
+
SENSITIVE = []
|
1146
|
+
include Aws::Structure
|
1147
|
+
end
|
1148
|
+
|
1149
|
+
# Contains an asset attribute property. For more information, see
|
1150
|
+
# [Attributes][1] in the *IoT SiteWise User Guide*.
|
1151
|
+
#
|
1152
|
+
#
|
1153
|
+
#
|
1154
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#attributes
|
1155
|
+
#
|
1156
|
+
# @note When making an API call, you may pass Attribute
|
1157
|
+
# data as a hash:
|
1158
|
+
#
|
1159
|
+
# {
|
1160
|
+
# default_value: "DefaultValue",
|
1161
|
+
# }
|
1162
|
+
#
|
1163
|
+
# @!attribute [rw] default_value
|
1164
|
+
# The default value of the asset model property attribute. All assets
|
1165
|
+
# that you create from the asset model contain this attribute value.
|
1166
|
+
# You can update an attribute's value after you create an asset. For
|
1167
|
+
# more information, see [Updating attribute values][1] in the *IoT
|
1168
|
+
# SiteWise User Guide*.
|
1169
|
+
#
|
1170
|
+
#
|
1171
|
+
#
|
1172
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-attribute-values.html
|
1173
|
+
# @return [String]
|
1174
|
+
#
|
1175
|
+
class Attribute < Struct.new(
|
1176
|
+
:default_value)
|
1177
|
+
SENSITIVE = []
|
1178
|
+
include Aws::Structure
|
1179
|
+
end
|
1180
|
+
|
1181
|
+
# @note When making an API call, you may pass BatchAssociateProjectAssetsRequest
|
1182
|
+
# data as a hash:
|
1183
|
+
#
|
1184
|
+
# {
|
1185
|
+
# project_id: "ID", # required
|
1186
|
+
# asset_ids: ["ID"], # required
|
1187
|
+
# client_token: "ClientToken",
|
1188
|
+
# }
|
1189
|
+
#
|
1190
|
+
# @!attribute [rw] project_id
|
1191
|
+
# The ID of the project to which to associate the assets.
|
1192
|
+
# @return [String]
|
1193
|
+
#
|
1194
|
+
# @!attribute [rw] asset_ids
|
1195
|
+
# The IDs of the assets to be associated to the project.
|
1196
|
+
# @return [Array<String>]
|
1197
|
+
#
|
1198
|
+
# @!attribute [rw] client_token
|
1199
|
+
# A unique case-sensitive identifier that you can provide to ensure
|
1200
|
+
# the idempotency of the request. Don't reuse this client token if a
|
1201
|
+
# new idempotent request is required.
|
1202
|
+
#
|
1203
|
+
# **A suitable default value is auto-generated.** You should normally
|
1204
|
+
# not need to pass this option.
|
1205
|
+
# @return [String]
|
1206
|
+
#
|
1207
|
+
class BatchAssociateProjectAssetsRequest < Struct.new(
|
1208
|
+
:project_id,
|
1209
|
+
:asset_ids,
|
1210
|
+
:client_token)
|
1211
|
+
SENSITIVE = []
|
1212
|
+
include Aws::Structure
|
1213
|
+
end
|
1214
|
+
|
1215
|
+
# @!attribute [rw] errors
|
1216
|
+
# A list of associated error information, if any.
|
1217
|
+
# @return [Array<Types::AssetErrorDetails>]
|
1218
|
+
#
|
1219
|
+
class BatchAssociateProjectAssetsResponse < Struct.new(
|
1220
|
+
:errors)
|
1221
|
+
SENSITIVE = []
|
1222
|
+
include Aws::Structure
|
1223
|
+
end
|
1224
|
+
|
1225
|
+
# @note When making an API call, you may pass BatchDisassociateProjectAssetsRequest
|
1226
|
+
# data as a hash:
|
1227
|
+
#
|
1228
|
+
# {
|
1229
|
+
# project_id: "ID", # required
|
1230
|
+
# asset_ids: ["ID"], # required
|
1231
|
+
# client_token: "ClientToken",
|
1232
|
+
# }
|
1233
|
+
#
|
1234
|
+
# @!attribute [rw] project_id
|
1235
|
+
# The ID of the project from which to disassociate the assets.
|
1236
|
+
# @return [String]
|
1237
|
+
#
|
1238
|
+
# @!attribute [rw] asset_ids
|
1239
|
+
# The IDs of the assets to be disassociated from the project.
|
1240
|
+
# @return [Array<String>]
|
1241
|
+
#
|
1242
|
+
# @!attribute [rw] client_token
|
1243
|
+
# A unique case-sensitive identifier that you can provide to ensure
|
1244
|
+
# the idempotency of the request. Don't reuse this client token if a
|
1245
|
+
# new idempotent request is required.
|
1246
|
+
#
|
1247
|
+
# **A suitable default value is auto-generated.** You should normally
|
1248
|
+
# not need to pass this option.
|
1249
|
+
# @return [String]
|
1250
|
+
#
|
1251
|
+
class BatchDisassociateProjectAssetsRequest < Struct.new(
|
1252
|
+
:project_id,
|
1253
|
+
:asset_ids,
|
1254
|
+
:client_token)
|
1255
|
+
SENSITIVE = []
|
1256
|
+
include Aws::Structure
|
1257
|
+
end
|
1258
|
+
|
1259
|
+
# @!attribute [rw] errors
|
1260
|
+
# A list of associated error information, if any.
|
1261
|
+
# @return [Array<Types::AssetErrorDetails>]
|
1262
|
+
#
|
1263
|
+
class BatchDisassociateProjectAssetsResponse < Struct.new(
|
1264
|
+
:errors)
|
1265
|
+
SENSITIVE = []
|
1266
|
+
include Aws::Structure
|
1267
|
+
end
|
1268
|
+
|
1269
|
+
# Contains information for an asset property aggregate entry that is
|
1270
|
+
# associated with the [BatchGetAssetPropertyAggregates][1] API.
|
1271
|
+
#
|
1272
|
+
# To identify an asset property, you must specify one of the following:
|
1273
|
+
#
|
1274
|
+
# * The `assetId` and `propertyId` of an asset property.
|
1275
|
+
#
|
1276
|
+
# * A `propertyAlias`, which is a data stream alias (for example,
|
1277
|
+
# `/company/windfarm/3/turbine/7/temperature`). To define an asset
|
1278
|
+
# property's alias, see [UpdateAssetProperty][2].
|
1279
|
+
#
|
1280
|
+
#
|
1281
|
+
#
|
1282
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
|
1283
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
|
1284
|
+
#
|
1285
|
+
# @note When making an API call, you may pass BatchGetAssetPropertyAggregatesEntry
|
1286
|
+
# data as a hash:
|
1287
|
+
#
|
1288
|
+
# {
|
1289
|
+
# entry_id: "EntryId", # required
|
1290
|
+
# asset_id: "ID",
|
1291
|
+
# property_id: "ID",
|
1292
|
+
# property_alias: "AssetPropertyAlias",
|
1293
|
+
# aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
|
1294
|
+
# resolution: "Resolution", # required
|
1295
|
+
# start_date: Time.now, # required
|
1296
|
+
# end_date: Time.now, # required
|
1297
|
+
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
1298
|
+
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1299
|
+
# }
|
1300
|
+
#
|
1301
|
+
# @!attribute [rw] entry_id
|
1302
|
+
# The ID of the entry.
|
1303
|
+
# @return [String]
|
1304
|
+
#
|
1305
|
+
# @!attribute [rw] asset_id
|
1306
|
+
# The ID of the asset in which the asset property was created.
|
1307
|
+
# @return [String]
|
1308
|
+
#
|
1309
|
+
# @!attribute [rw] property_id
|
1310
|
+
# The ID of the asset property.
|
1311
|
+
# @return [String]
|
1312
|
+
#
|
1313
|
+
# @!attribute [rw] property_alias
|
1314
|
+
# The alias that identifies the property, such as an OPC-UA server
|
1315
|
+
# data stream path (for example,
|
1316
|
+
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
1317
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
1318
|
+
# *IoT SiteWise User Guide*.
|
1319
|
+
#
|
1320
|
+
#
|
1321
|
+
#
|
1322
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
|
1323
|
+
# @return [String]
|
1324
|
+
#
|
1325
|
+
# @!attribute [rw] aggregate_types
|
1326
|
+
# The data aggregating function.
|
1327
|
+
# @return [Array<String>]
|
1328
|
+
#
|
1329
|
+
# @!attribute [rw] resolution
|
1330
|
+
# The time interval over which to aggregate data.
|
1331
|
+
# @return [String]
|
1332
|
+
#
|
1333
|
+
# @!attribute [rw] start_date
|
1334
|
+
# The exclusive start of the range from which to query historical
|
1335
|
+
# data, expressed in seconds in Unix epoch time.
|
1336
|
+
# @return [Time]
|
1337
|
+
#
|
1338
|
+
# @!attribute [rw] end_date
|
1339
|
+
# The inclusive end of the range from which to query historical data,
|
1340
|
+
# expressed in seconds in Unix epoch time.
|
1341
|
+
# @return [Time]
|
1342
|
+
#
|
1343
|
+
# @!attribute [rw] qualities
|
1344
|
+
# The quality by which to filter asset data.
|
1345
|
+
# @return [Array<String>]
|
1346
|
+
#
|
1347
|
+
# @!attribute [rw] time_ordering
|
1348
|
+
# The chronological sorting order of the requested information.
|
1349
|
+
#
|
1350
|
+
# Default: `ASCENDING`
|
1351
|
+
# @return [String]
|
1352
|
+
#
|
1353
|
+
class BatchGetAssetPropertyAggregatesEntry < Struct.new(
|
1354
|
+
:entry_id,
|
1355
|
+
:asset_id,
|
1356
|
+
:property_id,
|
1357
|
+
:property_alias,
|
1358
|
+
:aggregate_types,
|
1359
|
+
:resolution,
|
1360
|
+
:start_date,
|
1361
|
+
:end_date,
|
1362
|
+
:qualities,
|
1363
|
+
:time_ordering)
|
1364
|
+
SENSITIVE = []
|
1365
|
+
include Aws::Structure
|
1366
|
+
end
|
1367
|
+
|
1368
|
+
# Contains error information for an asset property aggregate entry that
|
1369
|
+
# is associated with the [BatchGetAssetPropertyAggregates][1] API.
|
1370
|
+
#
|
1371
|
+
#
|
1372
|
+
#
|
1373
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
|
1374
|
+
#
|
1375
|
+
# @!attribute [rw] error_code
|
1376
|
+
# The error code.
|
1377
|
+
# @return [String]
|
1378
|
+
#
|
1379
|
+
# @!attribute [rw] error_message
|
1380
|
+
# The associated error message.
|
1381
|
+
# @return [String]
|
1382
|
+
#
|
1383
|
+
# @!attribute [rw] entry_id
|
1384
|
+
# The ID of the entry.
|
1385
|
+
# @return [String]
|
1386
|
+
#
|
1387
|
+
class BatchGetAssetPropertyAggregatesErrorEntry < Struct.new(
|
1388
|
+
:error_code,
|
1389
|
+
:error_message,
|
1390
|
+
:entry_id)
|
1391
|
+
SENSITIVE = []
|
1392
|
+
include Aws::Structure
|
1393
|
+
end
|
1394
|
+
|
1395
|
+
# Contains the error code and the timestamp for an asset property
|
1396
|
+
# aggregate entry that is associated with the
|
1397
|
+
# [BatchGetAssetPropertyAggregates][1] API.
|
1398
|
+
#
|
1399
|
+
#
|
1400
|
+
#
|
1401
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
|
1402
|
+
#
|
1403
|
+
# @!attribute [rw] error_code
|
1404
|
+
# The error code.
|
1405
|
+
# @return [String]
|
1406
|
+
#
|
1407
|
+
# @!attribute [rw] error_timestamp
|
1408
|
+
# The date the error occurred, in Unix epoch time.
|
1409
|
+
# @return [Time]
|
1410
|
+
#
|
1411
|
+
class BatchGetAssetPropertyAggregatesErrorInfo < Struct.new(
|
1412
|
+
:error_code,
|
1413
|
+
:error_timestamp)
|
1414
|
+
SENSITIVE = []
|
1415
|
+
include Aws::Structure
|
1416
|
+
end
|
1417
|
+
|
1418
|
+
# @note When making an API call, you may pass BatchGetAssetPropertyAggregatesRequest
|
1419
|
+
# data as a hash:
|
1420
|
+
#
|
1421
|
+
# {
|
1422
|
+
# entries: [ # required
|
1423
|
+
# {
|
1424
|
+
# entry_id: "EntryId", # required
|
1425
|
+
# asset_id: "ID",
|
1426
|
+
# property_id: "ID",
|
1427
|
+
# property_alias: "AssetPropertyAlias",
|
1428
|
+
# aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
|
1429
|
+
# resolution: "Resolution", # required
|
1430
|
+
# start_date: Time.now, # required
|
1431
|
+
# end_date: Time.now, # required
|
1432
|
+
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
1433
|
+
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1434
|
+
# },
|
1435
|
+
# ],
|
1436
|
+
# next_token: "NextToken",
|
1437
|
+
# max_results: 1,
|
1438
|
+
# }
|
1439
|
+
#
|
1440
|
+
# @!attribute [rw] entries
|
1441
|
+
# The list of asset property aggregate entries for the batch get
|
1442
|
+
# request. You can specify up to 16 entries per request.
|
1443
|
+
# @return [Array<Types::BatchGetAssetPropertyAggregatesEntry>]
|
1444
|
+
#
|
1445
|
+
# @!attribute [rw] next_token
|
1446
|
+
# The token to be used for the next set of paginated results.
|
1447
|
+
# @return [String]
|
1448
|
+
#
|
1449
|
+
# @!attribute [rw] max_results
|
1450
|
+
# The maximum number of results to return for each paginated request.
|
1451
|
+
# A result set is returned in the two cases, whichever occurs first.
|
1452
|
+
#
|
1453
|
+
# * The size of the result set is less than 1 MB.
|
1454
|
+
#
|
1455
|
+
# * The number of data points in the result set is less than the value
|
1456
|
+
# of `maxResults`. The maximum value of `maxResults` is 4000.
|
1457
|
+
# @return [Integer]
|
1458
|
+
#
|
1459
|
+
class BatchGetAssetPropertyAggregatesRequest < Struct.new(
|
1460
|
+
:entries,
|
1461
|
+
:next_token,
|
1462
|
+
:max_results)
|
1463
|
+
SENSITIVE = []
|
1464
|
+
include Aws::Structure
|
1465
|
+
end
|
1466
|
+
|
1467
|
+
# @!attribute [rw] error_entries
|
1468
|
+
# A list of the errors (if any) associated with the batch request.
|
1469
|
+
# Each error entry contains the `entryId` of the entry that failed.
|
1470
|
+
# @return [Array<Types::BatchGetAssetPropertyAggregatesErrorEntry>]
|
1471
|
+
#
|
1472
|
+
# @!attribute [rw] success_entries
|
1473
|
+
# A list of entries that were processed successfully by this batch
|
1474
|
+
# request. Each success entry contains the `entryId` of the entry that
|
1475
|
+
# succeeded and the latest query result.
|
1476
|
+
# @return [Array<Types::BatchGetAssetPropertyAggregatesSuccessEntry>]
|
1477
|
+
#
|
1478
|
+
# @!attribute [rw] skipped_entries
|
1479
|
+
# A list of entries that were not processed by this batch request.
|
1480
|
+
# because these entries had been completely processed by previous
|
1481
|
+
# paginated requests. Each skipped entry contains the `entryId` of the
|
1482
|
+
# entry that skipped.
|
1483
|
+
# @return [Array<Types::BatchGetAssetPropertyAggregatesSkippedEntry>]
|
1484
|
+
#
|
1485
|
+
# @!attribute [rw] next_token
|
1486
|
+
# The token for the next set of results, or null if there are no
|
1487
|
+
# additional results.
|
1488
|
+
# @return [String]
|
1489
|
+
#
|
1490
|
+
class BatchGetAssetPropertyAggregatesResponse < Struct.new(
|
1491
|
+
:error_entries,
|
1492
|
+
:success_entries,
|
1493
|
+
:skipped_entries,
|
1494
|
+
:next_token)
|
1495
|
+
SENSITIVE = []
|
1496
|
+
include Aws::Structure
|
1497
|
+
end
|
1498
|
+
|
1499
|
+
# Contains information for an entry that has been processed by the
|
1500
|
+
# previous [BatchGetAssetPropertyAggregates][1] request.
|
1501
|
+
#
|
1502
|
+
#
|
1503
|
+
#
|
1504
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
|
1505
|
+
#
|
1506
|
+
# @!attribute [rw] entry_id
|
1507
|
+
# The ID of the entry.
|
1508
|
+
# @return [String]
|
1509
|
+
#
|
1510
|
+
# @!attribute [rw] completion_status
|
1511
|
+
# The completion status of each entry that is associated with the
|
1512
|
+
# [BatchGetAssetPropertyAggregates][1] API.
|
1513
|
+
#
|
1514
|
+
#
|
1515
|
+
#
|
1516
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
|
1517
|
+
# @return [String]
|
1518
|
+
#
|
1519
|
+
# @!attribute [rw] error_info
|
1520
|
+
# The error information, such as the error code and the timestamp.
|
1521
|
+
# @return [Types::BatchGetAssetPropertyAggregatesErrorInfo]
|
1522
|
+
#
|
1523
|
+
class BatchGetAssetPropertyAggregatesSkippedEntry < Struct.new(
|
1524
|
+
:entry_id,
|
1525
|
+
:completion_status,
|
1526
|
+
:error_info)
|
1527
|
+
SENSITIVE = []
|
1528
|
+
include Aws::Structure
|
1529
|
+
end
|
1530
|
+
|
1531
|
+
# Contains success information for an entry that is associated with the
|
1532
|
+
# [BatchGetAssetPropertyAggregates][1] API.
|
1533
|
+
#
|
1534
|
+
#
|
1535
|
+
#
|
1536
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
|
1537
|
+
#
|
1538
|
+
# @!attribute [rw] entry_id
|
1539
|
+
# The ID of the entry.
|
1540
|
+
# @return [String]
|
1541
|
+
#
|
1542
|
+
# @!attribute [rw] aggregated_values
|
1543
|
+
# The requested aggregated asset property values (for example,
|
1544
|
+
# average, minimum, and maximum).
|
1545
|
+
# @return [Array<Types::AggregatedValue>]
|
1546
|
+
#
|
1547
|
+
class BatchGetAssetPropertyAggregatesSuccessEntry < Struct.new(
|
1548
|
+
:entry_id,
|
1549
|
+
:aggregated_values)
|
1550
|
+
SENSITIVE = []
|
1551
|
+
include Aws::Structure
|
1552
|
+
end
|
1553
|
+
|
1554
|
+
# Contains information for an asset property value entry that is
|
1555
|
+
# associated with the [BatchGetAssetPropertyValue][1] API.
|
1556
|
+
#
|
1557
|
+
# To identify an asset property, you must specify one of the following:
|
1558
|
+
#
|
1559
|
+
# * The `assetId` and `propertyId` of an asset property.
|
1560
|
+
#
|
1561
|
+
# * A `propertyAlias`, which is a data stream alias (for example,
|
1562
|
+
# `/company/windfarm/3/turbine/7/temperature`). To define an asset
|
1563
|
+
# property's alias, see [UpdateAssetProperty][2].
|
1564
|
+
#
|
1565
|
+
#
|
1566
|
+
#
|
1567
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1568
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
|
1569
|
+
#
|
1570
|
+
# @note When making an API call, you may pass BatchGetAssetPropertyValueEntry
|
1571
|
+
# data as a hash:
|
1572
|
+
#
|
1573
|
+
# {
|
1574
|
+
# entry_id: "EntryId", # required
|
1575
|
+
# asset_id: "ID",
|
1576
|
+
# property_id: "ID",
|
1577
|
+
# property_alias: "AssetPropertyAlias",
|
1578
|
+
# }
|
1579
|
+
#
|
1580
|
+
# @!attribute [rw] entry_id
|
1581
|
+
# The ID of the entry.
|
1582
|
+
# @return [String]
|
1583
|
+
#
|
1584
|
+
# @!attribute [rw] asset_id
|
1585
|
+
# The ID of the asset in which the asset property was created.
|
1586
|
+
# @return [String]
|
1587
|
+
#
|
1588
|
+
# @!attribute [rw] property_id
|
1589
|
+
# The ID of the asset property.
|
1590
|
+
# @return [String]
|
1591
|
+
#
|
1592
|
+
# @!attribute [rw] property_alias
|
1593
|
+
# The alias that identifies the property, such as an OPC-UA server
|
1594
|
+
# data stream path (for example,
|
1595
|
+
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
1596
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
1597
|
+
# *IoT SiteWise User Guide*.
|
1598
|
+
#
|
1599
|
+
#
|
1600
|
+
#
|
1601
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
|
1602
|
+
# @return [String]
|
1603
|
+
#
|
1604
|
+
class BatchGetAssetPropertyValueEntry < Struct.new(
|
1605
|
+
:entry_id,
|
1606
|
+
:asset_id,
|
1607
|
+
:property_id,
|
1608
|
+
:property_alias)
|
1609
|
+
SENSITIVE = []
|
1610
|
+
include Aws::Structure
|
1611
|
+
end
|
1612
|
+
|
1613
|
+
# Contains error information for an asset property value entry that is
|
1614
|
+
# associated with the [BatchGetAssetPropertyValue][1] API.
|
1615
|
+
#
|
1616
|
+
#
|
1617
|
+
#
|
1618
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1619
|
+
#
|
1620
|
+
# @!attribute [rw] error_code
|
1621
|
+
# The error code.
|
1622
|
+
# @return [String]
|
1623
|
+
#
|
1624
|
+
# @!attribute [rw] error_message
|
1625
|
+
# The associated error message.
|
1626
|
+
# @return [String]
|
1627
|
+
#
|
1628
|
+
# @!attribute [rw] entry_id
|
1629
|
+
# The ID of the entry.
|
1630
|
+
# @return [String]
|
1631
|
+
#
|
1632
|
+
class BatchGetAssetPropertyValueErrorEntry < Struct.new(
|
1633
|
+
:error_code,
|
1634
|
+
:error_message,
|
1635
|
+
:entry_id)
|
1636
|
+
SENSITIVE = []
|
1637
|
+
include Aws::Structure
|
1638
|
+
end
|
1639
|
+
|
1640
|
+
# The error information, such as the error code and the timestamp.
|
1641
|
+
#
|
1642
|
+
# @!attribute [rw] error_code
|
1643
|
+
# The error code.
|
1644
|
+
# @return [String]
|
1645
|
+
#
|
1646
|
+
# @!attribute [rw] error_timestamp
|
1647
|
+
# The date the error occurred, in Unix epoch time.
|
1648
|
+
# @return [Time]
|
1649
|
+
#
|
1650
|
+
class BatchGetAssetPropertyValueErrorInfo < Struct.new(
|
1651
|
+
:error_code,
|
1652
|
+
:error_timestamp)
|
1653
|
+
SENSITIVE = []
|
1654
|
+
include Aws::Structure
|
1655
|
+
end
|
1656
|
+
|
1657
|
+
# Contains information for an asset property historical value entry that
|
1658
|
+
# is associated with the [BatchGetAssetPropertyValueHistory][1] API.
|
1659
|
+
#
|
1660
|
+
# To identify an asset property, you must specify one of the following:
|
1661
|
+
#
|
1662
|
+
# * The `assetId` and `propertyId` of an asset property.
|
1663
|
+
#
|
1664
|
+
# * A `propertyAlias`, which is a data stream alias (for example,
|
1665
|
+
# `/company/windfarm/3/turbine/7/temperature`). To define an asset
|
1666
|
+
# property's alias, see [UpdateAssetProperty][2].
|
1667
|
+
#
|
1668
|
+
#
|
1669
|
+
#
|
1670
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1671
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
|
1672
|
+
#
|
1673
|
+
# @note When making an API call, you may pass BatchGetAssetPropertyValueHistoryEntry
|
1674
|
+
# data as a hash:
|
1675
|
+
#
|
1676
|
+
# {
|
1677
|
+
# entry_id: "EntryId", # required
|
1678
|
+
# asset_id: "ID",
|
1679
|
+
# property_id: "ID",
|
1680
|
+
# property_alias: "AssetPropertyAlias",
|
1681
|
+
# start_date: Time.now,
|
1682
|
+
# end_date: Time.now,
|
1683
|
+
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
1684
|
+
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1685
|
+
# }
|
1686
|
+
#
|
1687
|
+
# @!attribute [rw] entry_id
|
1688
|
+
# The ID of the entry.
|
1689
|
+
# @return [String]
|
1690
|
+
#
|
1691
|
+
# @!attribute [rw] asset_id
|
1692
|
+
# The ID of the asset in which the asset property was created.
|
1693
|
+
# @return [String]
|
1694
|
+
#
|
1695
|
+
# @!attribute [rw] property_id
|
1696
|
+
# The ID of the asset property.
|
1697
|
+
# @return [String]
|
1698
|
+
#
|
1699
|
+
# @!attribute [rw] property_alias
|
1700
|
+
# The alias that identifies the property, such as an OPC-UA server
|
1701
|
+
# data stream path (for example,
|
1702
|
+
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
1703
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
1704
|
+
# *IoT SiteWise User Guide*.
|
1705
|
+
#
|
1706
|
+
#
|
1707
|
+
#
|
1708
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
|
1709
|
+
# @return [String]
|
1710
|
+
#
|
1711
|
+
# @!attribute [rw] start_date
|
1712
|
+
# The exclusive start of the range from which to query historical
|
1713
|
+
# data, expressed in seconds in Unix epoch time.
|
1714
|
+
# @return [Time]
|
1715
|
+
#
|
1716
|
+
# @!attribute [rw] end_date
|
1717
|
+
# The inclusive end of the range from which to query historical data,
|
1718
|
+
# expressed in seconds in Unix epoch time.
|
1719
|
+
# @return [Time]
|
1720
|
+
#
|
1721
|
+
# @!attribute [rw] qualities
|
1722
|
+
# The quality by which to filter asset data.
|
1723
|
+
# @return [Array<String>]
|
1724
|
+
#
|
1725
|
+
# @!attribute [rw] time_ordering
|
1726
|
+
# The chronological sorting order of the requested information.
|
1727
|
+
#
|
1728
|
+
# Default: `ASCENDING`
|
1729
|
+
# @return [String]
|
1730
|
+
#
|
1731
|
+
class BatchGetAssetPropertyValueHistoryEntry < Struct.new(
|
1732
|
+
:entry_id,
|
1733
|
+
:asset_id,
|
1734
|
+
:property_id,
|
1735
|
+
:property_alias,
|
1736
|
+
:start_date,
|
1737
|
+
:end_date,
|
1738
|
+
:qualities,
|
1739
|
+
:time_ordering)
|
1740
|
+
SENSITIVE = []
|
1741
|
+
include Aws::Structure
|
1742
|
+
end
|
1743
|
+
|
1744
|
+
# A list of the errors (if any) associated with the batch request. Each
|
1745
|
+
# error entry contains the `entryId` of the entry that failed.
|
1746
|
+
#
|
1747
|
+
# @!attribute [rw] error_code
|
1748
|
+
# The error code.
|
1749
|
+
# @return [String]
|
1750
|
+
#
|
1751
|
+
# @!attribute [rw] error_message
|
1752
|
+
# The associated error message.
|
1021
1753
|
# @return [String]
|
1022
1754
|
#
|
1023
|
-
# @!attribute [rw]
|
1024
|
-
# The ID of the
|
1755
|
+
# @!attribute [rw] entry_id
|
1756
|
+
# The ID of the entry.
|
1025
1757
|
# @return [String]
|
1026
1758
|
#
|
1027
|
-
|
1028
|
-
|
1029
|
-
|
1030
|
-
|
1759
|
+
class BatchGetAssetPropertyValueHistoryErrorEntry < Struct.new(
|
1760
|
+
:error_code,
|
1761
|
+
:error_message,
|
1762
|
+
:entry_id)
|
1763
|
+
SENSITIVE = []
|
1764
|
+
include Aws::Structure
|
1765
|
+
end
|
1766
|
+
|
1767
|
+
# The error information, such as the error code and the timestamp.
|
1031
1768
|
#
|
1032
|
-
#
|
1033
|
-
#
|
1769
|
+
# @!attribute [rw] error_code
|
1770
|
+
# The error code.
|
1034
1771
|
# @return [String]
|
1035
1772
|
#
|
1036
|
-
|
1037
|
-
|
1038
|
-
|
1039
|
-
|
1040
|
-
|
1773
|
+
# @!attribute [rw] error_timestamp
|
1774
|
+
# The date the error occurred, in Unix epoch time.
|
1775
|
+
# @return [Time]
|
1776
|
+
#
|
1777
|
+
class BatchGetAssetPropertyValueHistoryErrorInfo < Struct.new(
|
1778
|
+
:error_code,
|
1779
|
+
:error_timestamp)
|
1041
1780
|
SENSITIVE = []
|
1042
1781
|
include Aws::Structure
|
1043
1782
|
end
|
1044
1783
|
|
1045
|
-
# @note When making an API call, you may pass
|
1784
|
+
# @note When making an API call, you may pass BatchGetAssetPropertyValueHistoryRequest
|
1046
1785
|
# data as a hash:
|
1047
1786
|
#
|
1048
1787
|
# {
|
1049
|
-
#
|
1050
|
-
#
|
1051
|
-
#
|
1052
|
-
#
|
1788
|
+
# entries: [ # required
|
1789
|
+
# {
|
1790
|
+
# entry_id: "EntryId", # required
|
1791
|
+
# asset_id: "ID",
|
1792
|
+
# property_id: "ID",
|
1793
|
+
# property_alias: "AssetPropertyAlias",
|
1794
|
+
# start_date: Time.now,
|
1795
|
+
# end_date: Time.now,
|
1796
|
+
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
1797
|
+
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1798
|
+
# },
|
1799
|
+
# ],
|
1800
|
+
# next_token: "NextToken",
|
1801
|
+
# max_results: 1,
|
1053
1802
|
# }
|
1054
1803
|
#
|
1055
|
-
# @!attribute [rw]
|
1056
|
-
# The
|
1057
|
-
#
|
1804
|
+
# @!attribute [rw] entries
|
1805
|
+
# The list of asset property historical value entries for the batch
|
1806
|
+
# get request. You can specify up to 16 entries per request.
|
1807
|
+
# @return [Array<Types::BatchGetAssetPropertyValueHistoryEntry>]
|
1058
1808
|
#
|
1059
|
-
# @!attribute [rw]
|
1060
|
-
# The
|
1809
|
+
# @!attribute [rw] next_token
|
1810
|
+
# The token to be used for the next set of paginated results.
|
1061
1811
|
# @return [String]
|
1062
1812
|
#
|
1063
|
-
# @!attribute [rw]
|
1064
|
-
# The
|
1065
|
-
#
|
1813
|
+
# @!attribute [rw] max_results
|
1814
|
+
# The maximum number of results to return for each paginated request.
|
1815
|
+
# A result set is returned in the two cases, whichever occurs first.
|
1066
1816
|
#
|
1067
|
-
#
|
1068
|
-
# A unique case-sensitive identifier that you can provide to ensure
|
1069
|
-
# the idempotency of the request. Don't reuse this client token if a
|
1070
|
-
# new idempotent request is required.
|
1817
|
+
# * The size of the result set is less than 1 MB.
|
1071
1818
|
#
|
1072
|
-
#
|
1073
|
-
#
|
1074
|
-
# @return [
|
1819
|
+
# * The number of data points in the result set is less than the value
|
1820
|
+
# of `maxResults`. The maximum value of `maxResults` is 4000.
|
1821
|
+
# @return [Integer]
|
1075
1822
|
#
|
1076
|
-
class
|
1077
|
-
:
|
1078
|
-
:
|
1079
|
-
:
|
1080
|
-
:client_token)
|
1823
|
+
class BatchGetAssetPropertyValueHistoryRequest < Struct.new(
|
1824
|
+
:entries,
|
1825
|
+
:next_token,
|
1826
|
+
:max_results)
|
1081
1827
|
SENSITIVE = []
|
1082
1828
|
include Aws::Structure
|
1083
1829
|
end
|
1084
1830
|
|
1085
|
-
#
|
1831
|
+
# @!attribute [rw] error_entries
|
1832
|
+
# A list of the errors (if any) associated with the batch request.
|
1833
|
+
# Each error entry contains the `entryId` of the entry that failed.
|
1834
|
+
# @return [Array<Types::BatchGetAssetPropertyValueHistoryErrorEntry>]
|
1086
1835
|
#
|
1087
|
-
# @!attribute [rw]
|
1088
|
-
#
|
1089
|
-
#
|
1836
|
+
# @!attribute [rw] success_entries
|
1837
|
+
# A list of entries that were processed successfully by this batch
|
1838
|
+
# request. Each success entry contains the `entryId` of the entry that
|
1839
|
+
# succeeded and the latest query result.
|
1840
|
+
# @return [Array<Types::BatchGetAssetPropertyValueHistorySuccessEntry>]
|
1090
1841
|
#
|
1091
|
-
# @!attribute [rw]
|
1092
|
-
#
|
1842
|
+
# @!attribute [rw] skipped_entries
|
1843
|
+
# A list of entries that were not processed by this batch request.
|
1844
|
+
# because these entries had been completely processed by previous
|
1845
|
+
# paginated requests. Each skipped entry contains the `entryId` of the
|
1846
|
+
# entry that skipped.
|
1847
|
+
# @return [Array<Types::BatchGetAssetPropertyValueHistorySkippedEntry>]
|
1093
1848
|
#
|
1094
|
-
#
|
1849
|
+
# @!attribute [rw] next_token
|
1850
|
+
# The token for the next set of results, or null if there are no
|
1851
|
+
# additional results.
|
1852
|
+
# @return [String]
|
1095
1853
|
#
|
1854
|
+
class BatchGetAssetPropertyValueHistoryResponse < Struct.new(
|
1855
|
+
:error_entries,
|
1856
|
+
:success_entries,
|
1857
|
+
:skipped_entries,
|
1858
|
+
:next_token)
|
1859
|
+
SENSITIVE = []
|
1860
|
+
include Aws::Structure
|
1861
|
+
end
|
1862
|
+
|
1863
|
+
# Contains information for an entry that has been processed by the
|
1864
|
+
# previous [BatchGetAssetPropertyValueHistory][1] request.
|
1096
1865
|
#
|
1097
1866
|
#
|
1098
|
-
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1099
|
-
# @return [String]
|
1100
1867
|
#
|
1101
|
-
#
|
1102
|
-
# The name of the asset.
|
1103
|
-
# @return [String]
|
1868
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1104
1869
|
#
|
1105
|
-
# @!attribute [rw]
|
1106
|
-
# The ID of the
|
1870
|
+
# @!attribute [rw] entry_id
|
1871
|
+
# The ID of the entry.
|
1107
1872
|
# @return [String]
|
1108
1873
|
#
|
1109
|
-
# @!attribute [rw]
|
1110
|
-
# The
|
1111
|
-
#
|
1874
|
+
# @!attribute [rw] completion_status
|
1875
|
+
# The completion status of each entry that is associated with the
|
1876
|
+
# [BatchGetAssetPropertyValueHistory][1] API.
|
1112
1877
|
#
|
1113
|
-
# @!attribute [rw] last_update_date
|
1114
|
-
# The date the asset was last updated, in Unix epoch time.
|
1115
|
-
# @return [Time]
|
1116
1878
|
#
|
1117
|
-
# @!attribute [rw] status
|
1118
|
-
# The current status of the asset.
|
1119
|
-
# @return [Types::AssetStatus]
|
1120
1879
|
#
|
1121
|
-
#
|
1122
|
-
#
|
1123
|
-
# hierarchy specifies allowed parent/child asset relationships.
|
1124
|
-
# @return [Array<Types::AssetHierarchy>]
|
1880
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html
|
1881
|
+
# @return [String]
|
1125
1882
|
#
|
1126
|
-
|
1127
|
-
|
1128
|
-
|
1129
|
-
|
1130
|
-
|
1131
|
-
:
|
1132
|
-
:
|
1133
|
-
:
|
1134
|
-
:hierarchies)
|
1883
|
+
# @!attribute [rw] error_info
|
1884
|
+
# The error information, such as the error code and the timestamp.
|
1885
|
+
# @return [Types::BatchGetAssetPropertyValueHistoryErrorInfo]
|
1886
|
+
#
|
1887
|
+
class BatchGetAssetPropertyValueHistorySkippedEntry < Struct.new(
|
1888
|
+
:entry_id,
|
1889
|
+
:completion_status,
|
1890
|
+
:error_info)
|
1135
1891
|
SENSITIVE = []
|
1136
1892
|
include Aws::Structure
|
1137
1893
|
end
|
1138
1894
|
|
1139
|
-
# Contains an
|
1140
|
-
# [
|
1895
|
+
# Contains success information for an entry that is associated with the
|
1896
|
+
# [BatchGetAssetPropertyValueHistory][1] API.
|
1141
1897
|
#
|
1142
1898
|
#
|
1143
1899
|
#
|
1144
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/
|
1145
|
-
#
|
1146
|
-
# @note When making an API call, you may pass Attribute
|
1147
|
-
# data as a hash:
|
1148
|
-
#
|
1149
|
-
# {
|
1150
|
-
# default_value: "DefaultValue",
|
1151
|
-
# }
|
1152
|
-
#
|
1153
|
-
# @!attribute [rw] default_value
|
1154
|
-
# The default value of the asset model property attribute. All assets
|
1155
|
-
# that you create from the asset model contain this attribute value.
|
1156
|
-
# You can update an attribute's value after you create an asset. For
|
1157
|
-
# more information, see [Updating attribute values][1] in the *IoT
|
1158
|
-
# SiteWise User Guide*.
|
1159
|
-
#
|
1900
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1160
1901
|
#
|
1161
|
-
#
|
1162
|
-
#
|
1902
|
+
# @!attribute [rw] entry_id
|
1903
|
+
# The ID of the entry.
|
1163
1904
|
# @return [String]
|
1164
1905
|
#
|
1165
|
-
|
1166
|
-
|
1906
|
+
# @!attribute [rw] asset_property_value_history
|
1907
|
+
# The requested historical values for the specified asset property.
|
1908
|
+
# @return [Array<Types::AssetPropertyValue>]
|
1909
|
+
#
|
1910
|
+
class BatchGetAssetPropertyValueHistorySuccessEntry < Struct.new(
|
1911
|
+
:entry_id,
|
1912
|
+
:asset_property_value_history)
|
1167
1913
|
SENSITIVE = []
|
1168
1914
|
include Aws::Structure
|
1169
1915
|
end
|
1170
1916
|
|
1171
|
-
# @note When making an API call, you may pass
|
1917
|
+
# @note When making an API call, you may pass BatchGetAssetPropertyValueRequest
|
1172
1918
|
# data as a hash:
|
1173
1919
|
#
|
1174
1920
|
# {
|
1175
|
-
#
|
1176
|
-
#
|
1177
|
-
#
|
1921
|
+
# entries: [ # required
|
1922
|
+
# {
|
1923
|
+
# entry_id: "EntryId", # required
|
1924
|
+
# asset_id: "ID",
|
1925
|
+
# property_id: "ID",
|
1926
|
+
# property_alias: "AssetPropertyAlias",
|
1927
|
+
# },
|
1928
|
+
# ],
|
1929
|
+
# next_token: "NextToken",
|
1178
1930
|
# }
|
1179
1931
|
#
|
1180
|
-
# @!attribute [rw]
|
1181
|
-
# The
|
1182
|
-
#
|
1183
|
-
#
|
1184
|
-
# @!attribute [rw] asset_ids
|
1185
|
-
# The IDs of the assets to be associated to the project.
|
1186
|
-
# @return [Array<String>]
|
1187
|
-
#
|
1188
|
-
# @!attribute [rw] client_token
|
1189
|
-
# A unique case-sensitive identifier that you can provide to ensure
|
1190
|
-
# the idempotency of the request. Don't reuse this client token if a
|
1191
|
-
# new idempotent request is required.
|
1932
|
+
# @!attribute [rw] entries
|
1933
|
+
# The list of asset property value entries for the batch get request.
|
1934
|
+
# You can specify up to 16 entries per request.
|
1935
|
+
# @return [Array<Types::BatchGetAssetPropertyValueEntry>]
|
1192
1936
|
#
|
1193
|
-
#
|
1194
|
-
#
|
1937
|
+
# @!attribute [rw] next_token
|
1938
|
+
# The token to be used for the next set of paginated results.
|
1195
1939
|
# @return [String]
|
1196
1940
|
#
|
1197
|
-
class
|
1198
|
-
:
|
1199
|
-
:
|
1200
|
-
:client_token)
|
1941
|
+
class BatchGetAssetPropertyValueRequest < Struct.new(
|
1942
|
+
:entries,
|
1943
|
+
:next_token)
|
1201
1944
|
SENSITIVE = []
|
1202
1945
|
include Aws::Structure
|
1203
1946
|
end
|
1204
1947
|
|
1205
|
-
# @!attribute [rw]
|
1206
|
-
# A list of associated
|
1207
|
-
#
|
1948
|
+
# @!attribute [rw] error_entries
|
1949
|
+
# A list of the errors (if any) associated with the batch request.
|
1950
|
+
# Each error entry contains the `entryId` of the entry that failed.
|
1951
|
+
# @return [Array<Types::BatchGetAssetPropertyValueErrorEntry>]
|
1208
1952
|
#
|
1209
|
-
|
1210
|
-
|
1953
|
+
# @!attribute [rw] success_entries
|
1954
|
+
# A list of entries that were processed successfully by this batch
|
1955
|
+
# request. Each success entry contains the `entryId` of the entry that
|
1956
|
+
# succeeded and the latest query result.
|
1957
|
+
# @return [Array<Types::BatchGetAssetPropertyValueSuccessEntry>]
|
1958
|
+
#
|
1959
|
+
# @!attribute [rw] skipped_entries
|
1960
|
+
# A list of entries that were not processed by this batch request.
|
1961
|
+
# because these entries had been completely processed by previous
|
1962
|
+
# paginated requests. Each skipped entry contains the `entryId` of the
|
1963
|
+
# entry that skipped.
|
1964
|
+
# @return [Array<Types::BatchGetAssetPropertyValueSkippedEntry>]
|
1965
|
+
#
|
1966
|
+
# @!attribute [rw] next_token
|
1967
|
+
# The token for the next set of results, or null if there are no
|
1968
|
+
# additional results.
|
1969
|
+
# @return [String]
|
1970
|
+
#
|
1971
|
+
class BatchGetAssetPropertyValueResponse < Struct.new(
|
1972
|
+
:error_entries,
|
1973
|
+
:success_entries,
|
1974
|
+
:skipped_entries,
|
1975
|
+
:next_token)
|
1211
1976
|
SENSITIVE = []
|
1212
1977
|
include Aws::Structure
|
1213
1978
|
end
|
1214
1979
|
|
1215
|
-
#
|
1216
|
-
#
|
1980
|
+
# Contains information for an entry that has been processed by the
|
1981
|
+
# previous [BatchGetAssetPropertyValue][1] request.
|
1217
1982
|
#
|
1218
|
-
# {
|
1219
|
-
# project_id: "ID", # required
|
1220
|
-
# asset_ids: ["ID"], # required
|
1221
|
-
# client_token: "ClientToken",
|
1222
|
-
# }
|
1223
1983
|
#
|
1224
|
-
#
|
1225
|
-
#
|
1984
|
+
#
|
1985
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1986
|
+
#
|
1987
|
+
# @!attribute [rw] entry_id
|
1988
|
+
# The ID of the entry.
|
1226
1989
|
# @return [String]
|
1227
1990
|
#
|
1228
|
-
# @!attribute [rw]
|
1229
|
-
# The
|
1230
|
-
#
|
1991
|
+
# @!attribute [rw] completion_status
|
1992
|
+
# The completion status of each entry that is associated with the
|
1993
|
+
# [BatchGetAssetPropertyValue][1] request.
|
1231
1994
|
#
|
1232
|
-
# @!attribute [rw] client_token
|
1233
|
-
# A unique case-sensitive identifier that you can provide to ensure
|
1234
|
-
# the idempotency of the request. Don't reuse this client token if a
|
1235
|
-
# new idempotent request is required.
|
1236
1995
|
#
|
1237
|
-
#
|
1238
|
-
#
|
1996
|
+
#
|
1997
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1239
1998
|
# @return [String]
|
1240
1999
|
#
|
1241
|
-
|
1242
|
-
|
1243
|
-
|
1244
|
-
|
2000
|
+
# @!attribute [rw] error_info
|
2001
|
+
# The error information, such as the error code and the timestamp.
|
2002
|
+
# @return [Types::BatchGetAssetPropertyValueErrorInfo]
|
2003
|
+
#
|
2004
|
+
class BatchGetAssetPropertyValueSkippedEntry < Struct.new(
|
2005
|
+
:entry_id,
|
2006
|
+
:completion_status,
|
2007
|
+
:error_info)
|
1245
2008
|
SENSITIVE = []
|
1246
2009
|
include Aws::Structure
|
1247
2010
|
end
|
1248
2011
|
|
1249
|
-
#
|
1250
|
-
#
|
1251
|
-
# @return [Array<Types::AssetErrorDetails>]
|
2012
|
+
# Contains success information for an entry that is associated with the
|
2013
|
+
# [BatchGetAssetPropertyValue][1] API.
|
1252
2014
|
#
|
1253
|
-
|
1254
|
-
|
2015
|
+
#
|
2016
|
+
#
|
2017
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
2018
|
+
#
|
2019
|
+
# @!attribute [rw] entry_id
|
2020
|
+
# The ID of the entry.
|
2021
|
+
# @return [String]
|
2022
|
+
#
|
2023
|
+
# @!attribute [rw] asset_property_value
|
2024
|
+
# Contains asset property value information.
|
2025
|
+
# @return [Types::AssetPropertyValue]
|
2026
|
+
#
|
2027
|
+
class BatchGetAssetPropertyValueSuccessEntry < Struct.new(
|
2028
|
+
:entry_id,
|
2029
|
+
:asset_property_value)
|
1255
2030
|
SENSITIVE = []
|
1256
2031
|
include Aws::Structure
|
1257
2032
|
end
|
@@ -1785,6 +2560,7 @@ module Aws::IoTSiteWise
|
|
1785
2560
|
# tags: {
|
1786
2561
|
# "TagKey" => "TagValue",
|
1787
2562
|
# },
|
2563
|
+
# asset_description: "Description",
|
1788
2564
|
# }
|
1789
2565
|
#
|
1790
2566
|
# @!attribute [rw] asset_name
|
@@ -1814,11 +2590,16 @@ module Aws::IoTSiteWise
|
|
1814
2590
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
|
1815
2591
|
# @return [Hash<String,String>]
|
1816
2592
|
#
|
2593
|
+
# @!attribute [rw] asset_description
|
2594
|
+
# A description for the asset.
|
2595
|
+
# @return [String]
|
2596
|
+
#
|
1817
2597
|
class CreateAssetRequest < Struct.new(
|
1818
2598
|
:asset_name,
|
1819
2599
|
:asset_model_id,
|
1820
2600
|
:client_token,
|
1821
|
-
:tags
|
2601
|
+
:tags,
|
2602
|
+
:asset_description)
|
1822
2603
|
SENSITIVE = []
|
1823
2604
|
include Aws::Structure
|
1824
2605
|
end
|
@@ -2869,6 +3650,10 @@ module Aws::IoTSiteWise
|
|
2869
3650
|
# error message.
|
2870
3651
|
# @return [Types::AssetStatus]
|
2871
3652
|
#
|
3653
|
+
# @!attribute [rw] asset_description
|
3654
|
+
# A description for the asset.
|
3655
|
+
# @return [String]
|
3656
|
+
#
|
2872
3657
|
class DescribeAssetResponse < Struct.new(
|
2873
3658
|
:asset_id,
|
2874
3659
|
:asset_arn,
|
@@ -2879,7 +3664,8 @@ module Aws::IoTSiteWise
|
|
2879
3664
|
:asset_composite_models,
|
2880
3665
|
:asset_creation_date,
|
2881
3666
|
:asset_last_update_date,
|
2882
|
-
:asset_status
|
3667
|
+
:asset_status,
|
3668
|
+
:asset_description)
|
2883
3669
|
SENSITIVE = []
|
2884
3670
|
include Aws::Structure
|
2885
3671
|
end
|
@@ -3328,7 +4114,7 @@ module Aws::IoTSiteWise
|
|
3328
4114
|
# hot tier. The hot tier is a service-managed database.
|
3329
4115
|
#
|
3330
4116
|
# * `MULTI_LAYER_STORAGE` – IoT SiteWise saves your data in both the
|
3331
|
-
# cold tier and the
|
4117
|
+
# cold tier and the hot tier. The cold tier is a customer-managed
|
3332
4118
|
# Amazon S3 bucket.
|
3333
4119
|
# @return [String]
|
3334
4120
|
#
|
@@ -5884,7 +6670,7 @@ module Aws::IoTSiteWise
|
|
5884
6670
|
# hot tier. The hot tier is a service-managed database.
|
5885
6671
|
#
|
5886
6672
|
# * `MULTI_LAYER_STORAGE` – IoT SiteWise saves your data in both the
|
5887
|
-
# cold tier and the
|
6673
|
+
# cold tier and the hot tier. The cold tier is a customer-managed
|
5888
6674
|
# Amazon S3 bucket.
|
5889
6675
|
# @return [String]
|
5890
6676
|
#
|
@@ -5938,7 +6724,7 @@ module Aws::IoTSiteWise
|
|
5938
6724
|
# hot tier. The hot tier is a service-managed database.
|
5939
6725
|
#
|
5940
6726
|
# * `MULTI_LAYER_STORAGE` – IoT SiteWise saves your data in both the
|
5941
|
-
# cold tier and the
|
6727
|
+
# cold tier and the hot tier. The cold tier is a customer-managed
|
5942
6728
|
# Amazon S3 bucket.
|
5943
6729
|
# @return [String]
|
5944
6730
|
#
|
@@ -6863,6 +7649,7 @@ module Aws::IoTSiteWise
|
|
6863
7649
|
# asset_id: "ID", # required
|
6864
7650
|
# asset_name: "Name", # required
|
6865
7651
|
# client_token: "ClientToken",
|
7652
|
+
# asset_description: "Description",
|
6866
7653
|
# }
|
6867
7654
|
#
|
6868
7655
|
# @!attribute [rw] asset_id
|
@@ -6882,10 +7669,15 @@ module Aws::IoTSiteWise
|
|
6882
7669
|
# not need to pass this option.
|
6883
7670
|
# @return [String]
|
6884
7671
|
#
|
7672
|
+
# @!attribute [rw] asset_description
|
7673
|
+
# A description for the asset.
|
7674
|
+
# @return [String]
|
7675
|
+
#
|
6885
7676
|
class UpdateAssetRequest < Struct.new(
|
6886
7677
|
:asset_id,
|
6887
7678
|
:asset_name,
|
6888
|
-
:client_token
|
7679
|
+
:client_token,
|
7680
|
+
:asset_description)
|
6889
7681
|
SENSITIVE = []
|
6890
7682
|
include Aws::Structure
|
6891
7683
|
end
|