aws-sdk-iotsitewise 1.38.0 → 1.41.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +239 -1
- data/lib/aws-sdk-iotsitewise/client_api.rb +239 -0
- data/lib/aws-sdk-iotsitewise/types.rb +765 -0
- data/lib/aws-sdk-iotsitewise.rb +1 -1
- metadata +4 -4
@@ -1256,6 +1256,771 @@ module Aws::IoTSiteWise
|
|
1256
1256
|
include Aws::Structure
|
1257
1257
|
end
|
1258
1258
|
|
1259
|
+
# Contains information for an asset property aggregate entry that is
|
1260
|
+
# associated with the [BatchGetAssetPropertyAggregates][1] API.
|
1261
|
+
#
|
1262
|
+
# To identify an asset property, you must specify one of the following:
|
1263
|
+
#
|
1264
|
+
# * The `assetId` and `propertyId` of an asset property.
|
1265
|
+
#
|
1266
|
+
# * A `propertyAlias`, which is a data stream alias (for example,
|
1267
|
+
# `/company/windfarm/3/turbine/7/temperature`). To define an asset
|
1268
|
+
# property's alias, see [UpdateAssetProperty][2].
|
1269
|
+
#
|
1270
|
+
#
|
1271
|
+
#
|
1272
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
|
1273
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
|
1274
|
+
#
|
1275
|
+
# @note When making an API call, you may pass BatchGetAssetPropertyAggregatesEntry
|
1276
|
+
# data as a hash:
|
1277
|
+
#
|
1278
|
+
# {
|
1279
|
+
# entry_id: "EntryId", # required
|
1280
|
+
# asset_id: "ID",
|
1281
|
+
# property_id: "ID",
|
1282
|
+
# property_alias: "AssetPropertyAlias",
|
1283
|
+
# aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
|
1284
|
+
# resolution: "Resolution", # required
|
1285
|
+
# start_date: Time.now, # required
|
1286
|
+
# end_date: Time.now, # required
|
1287
|
+
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
1288
|
+
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1289
|
+
# }
|
1290
|
+
#
|
1291
|
+
# @!attribute [rw] entry_id
|
1292
|
+
# The ID of the entry.
|
1293
|
+
# @return [String]
|
1294
|
+
#
|
1295
|
+
# @!attribute [rw] asset_id
|
1296
|
+
# The ID of the asset in which the asset property was created.
|
1297
|
+
# @return [String]
|
1298
|
+
#
|
1299
|
+
# @!attribute [rw] property_id
|
1300
|
+
# The ID of the asset property.
|
1301
|
+
# @return [String]
|
1302
|
+
#
|
1303
|
+
# @!attribute [rw] property_alias
|
1304
|
+
# The alias that identifies the property, such as an OPC-UA server
|
1305
|
+
# data stream path (for example,
|
1306
|
+
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
1307
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
1308
|
+
# *IoT SiteWise User Guide*.
|
1309
|
+
#
|
1310
|
+
#
|
1311
|
+
#
|
1312
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
|
1313
|
+
# @return [String]
|
1314
|
+
#
|
1315
|
+
# @!attribute [rw] aggregate_types
|
1316
|
+
# The data aggregating function.
|
1317
|
+
# @return [Array<String>]
|
1318
|
+
#
|
1319
|
+
# @!attribute [rw] resolution
|
1320
|
+
# The time interval over which to aggregate data.
|
1321
|
+
# @return [String]
|
1322
|
+
#
|
1323
|
+
# @!attribute [rw] start_date
|
1324
|
+
# The exclusive start of the range from which to query historical
|
1325
|
+
# data, expressed in seconds in Unix epoch time.
|
1326
|
+
# @return [Time]
|
1327
|
+
#
|
1328
|
+
# @!attribute [rw] end_date
|
1329
|
+
# The inclusive end of the range from which to query historical data,
|
1330
|
+
# expressed in seconds in Unix epoch time.
|
1331
|
+
# @return [Time]
|
1332
|
+
#
|
1333
|
+
# @!attribute [rw] qualities
|
1334
|
+
# The quality by which to filter asset data.
|
1335
|
+
# @return [Array<String>]
|
1336
|
+
#
|
1337
|
+
# @!attribute [rw] time_ordering
|
1338
|
+
# The chronological sorting order of the requested information.
|
1339
|
+
#
|
1340
|
+
# Default: `ASCENDING`
|
1341
|
+
# @return [String]
|
1342
|
+
#
|
1343
|
+
class BatchGetAssetPropertyAggregatesEntry < Struct.new(
|
1344
|
+
:entry_id,
|
1345
|
+
:asset_id,
|
1346
|
+
:property_id,
|
1347
|
+
:property_alias,
|
1348
|
+
:aggregate_types,
|
1349
|
+
:resolution,
|
1350
|
+
:start_date,
|
1351
|
+
:end_date,
|
1352
|
+
:qualities,
|
1353
|
+
:time_ordering)
|
1354
|
+
SENSITIVE = []
|
1355
|
+
include Aws::Structure
|
1356
|
+
end
|
1357
|
+
|
1358
|
+
# Contains error information for an asset property aggregate entry that
|
1359
|
+
# is associated with the [BatchGetAssetPropertyAggregates][1] API.
|
1360
|
+
#
|
1361
|
+
#
|
1362
|
+
#
|
1363
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
|
1364
|
+
#
|
1365
|
+
# @!attribute [rw] error_code
|
1366
|
+
# The error code.
|
1367
|
+
# @return [String]
|
1368
|
+
#
|
1369
|
+
# @!attribute [rw] error_message
|
1370
|
+
# The associated error message.
|
1371
|
+
# @return [String]
|
1372
|
+
#
|
1373
|
+
# @!attribute [rw] entry_id
|
1374
|
+
# The ID of the entry.
|
1375
|
+
# @return [String]
|
1376
|
+
#
|
1377
|
+
class BatchGetAssetPropertyAggregatesErrorEntry < Struct.new(
|
1378
|
+
:error_code,
|
1379
|
+
:error_message,
|
1380
|
+
:entry_id)
|
1381
|
+
SENSITIVE = []
|
1382
|
+
include Aws::Structure
|
1383
|
+
end
|
1384
|
+
|
1385
|
+
# Contains the error code and the timestamp for an asset property
|
1386
|
+
# aggregate entry that is associated with the
|
1387
|
+
# [BatchGetAssetPropertyAggregates][1] API.
|
1388
|
+
#
|
1389
|
+
#
|
1390
|
+
#
|
1391
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
|
1392
|
+
#
|
1393
|
+
# @!attribute [rw] error_code
|
1394
|
+
# The error code.
|
1395
|
+
# @return [String]
|
1396
|
+
#
|
1397
|
+
# @!attribute [rw] error_timestamp
|
1398
|
+
# The date the error occurred, in Unix epoch time.
|
1399
|
+
# @return [Time]
|
1400
|
+
#
|
1401
|
+
class BatchGetAssetPropertyAggregatesErrorInfo < Struct.new(
|
1402
|
+
:error_code,
|
1403
|
+
:error_timestamp)
|
1404
|
+
SENSITIVE = []
|
1405
|
+
include Aws::Structure
|
1406
|
+
end
|
1407
|
+
|
1408
|
+
# @note When making an API call, you may pass BatchGetAssetPropertyAggregatesRequest
|
1409
|
+
# data as a hash:
|
1410
|
+
#
|
1411
|
+
# {
|
1412
|
+
# entries: [ # required
|
1413
|
+
# {
|
1414
|
+
# entry_id: "EntryId", # required
|
1415
|
+
# asset_id: "ID",
|
1416
|
+
# property_id: "ID",
|
1417
|
+
# property_alias: "AssetPropertyAlias",
|
1418
|
+
# aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
|
1419
|
+
# resolution: "Resolution", # required
|
1420
|
+
# start_date: Time.now, # required
|
1421
|
+
# end_date: Time.now, # required
|
1422
|
+
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
1423
|
+
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1424
|
+
# },
|
1425
|
+
# ],
|
1426
|
+
# next_token: "NextToken",
|
1427
|
+
# max_results: 1,
|
1428
|
+
# }
|
1429
|
+
#
|
1430
|
+
# @!attribute [rw] entries
|
1431
|
+
# The list of asset property aggregate entries for the batch get
|
1432
|
+
# request. You can specify up to 16 entries per request.
|
1433
|
+
# @return [Array<Types::BatchGetAssetPropertyAggregatesEntry>]
|
1434
|
+
#
|
1435
|
+
# @!attribute [rw] next_token
|
1436
|
+
# The token to be used for the next set of paginated results.
|
1437
|
+
# @return [String]
|
1438
|
+
#
|
1439
|
+
# @!attribute [rw] max_results
|
1440
|
+
# The maximum number of results to return for each paginated request.
|
1441
|
+
# A result set is returned in the two cases, whichever occurs first.
|
1442
|
+
#
|
1443
|
+
# * The size of the result set is less than 1 MB.
|
1444
|
+
#
|
1445
|
+
# * The number of data points in the result set is less than the value
|
1446
|
+
# of `maxResults`. The maximum value of `maxResults` is 4000.
|
1447
|
+
# @return [Integer]
|
1448
|
+
#
|
1449
|
+
class BatchGetAssetPropertyAggregatesRequest < Struct.new(
|
1450
|
+
:entries,
|
1451
|
+
:next_token,
|
1452
|
+
:max_results)
|
1453
|
+
SENSITIVE = []
|
1454
|
+
include Aws::Structure
|
1455
|
+
end
|
1456
|
+
|
1457
|
+
# @!attribute [rw] error_entries
|
1458
|
+
# A list of the errors (if any) associated with the batch request.
|
1459
|
+
# Each error entry contains the `entryId` of the entry that failed.
|
1460
|
+
# @return [Array<Types::BatchGetAssetPropertyAggregatesErrorEntry>]
|
1461
|
+
#
|
1462
|
+
# @!attribute [rw] success_entries
|
1463
|
+
# A list of entries that were processed successfully by this batch
|
1464
|
+
# request. Each success entry contains the `entryId` of the entry that
|
1465
|
+
# succeeded and the latest query result.
|
1466
|
+
# @return [Array<Types::BatchGetAssetPropertyAggregatesSuccessEntry>]
|
1467
|
+
#
|
1468
|
+
# @!attribute [rw] skipped_entries
|
1469
|
+
# A list of entries that were not processed by this batch request.
|
1470
|
+
# because these entries had been completely processed by previous
|
1471
|
+
# paginated requests. Each skipped entry contains the `entryId` of the
|
1472
|
+
# entry that skipped.
|
1473
|
+
# @return [Array<Types::BatchGetAssetPropertyAggregatesSkippedEntry>]
|
1474
|
+
#
|
1475
|
+
# @!attribute [rw] next_token
|
1476
|
+
# The token for the next set of results, or null if there are no
|
1477
|
+
# additional results.
|
1478
|
+
# @return [String]
|
1479
|
+
#
|
1480
|
+
class BatchGetAssetPropertyAggregatesResponse < Struct.new(
|
1481
|
+
:error_entries,
|
1482
|
+
:success_entries,
|
1483
|
+
:skipped_entries,
|
1484
|
+
:next_token)
|
1485
|
+
SENSITIVE = []
|
1486
|
+
include Aws::Structure
|
1487
|
+
end
|
1488
|
+
|
1489
|
+
# Contains information for an entry that has been processed by the
|
1490
|
+
# previous [BatchGetAssetPropertyAggregates][1] request.
|
1491
|
+
#
|
1492
|
+
#
|
1493
|
+
#
|
1494
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
|
1495
|
+
#
|
1496
|
+
# @!attribute [rw] entry_id
|
1497
|
+
# The ID of the entry.
|
1498
|
+
# @return [String]
|
1499
|
+
#
|
1500
|
+
# @!attribute [rw] completion_status
|
1501
|
+
# The completion status of each entry that is associated with the
|
1502
|
+
# [BatchGetAssetPropertyAggregates][1] API.
|
1503
|
+
#
|
1504
|
+
#
|
1505
|
+
#
|
1506
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
|
1507
|
+
# @return [String]
|
1508
|
+
#
|
1509
|
+
# @!attribute [rw] error_info
|
1510
|
+
# The error information, such as the error code and the timestamp.
|
1511
|
+
# @return [Types::BatchGetAssetPropertyAggregatesErrorInfo]
|
1512
|
+
#
|
1513
|
+
class BatchGetAssetPropertyAggregatesSkippedEntry < Struct.new(
|
1514
|
+
:entry_id,
|
1515
|
+
:completion_status,
|
1516
|
+
:error_info)
|
1517
|
+
SENSITIVE = []
|
1518
|
+
include Aws::Structure
|
1519
|
+
end
|
1520
|
+
|
1521
|
+
# Contains success information for an entry that is associated with the
|
1522
|
+
# [BatchGetAssetPropertyAggregates][1] API.
|
1523
|
+
#
|
1524
|
+
#
|
1525
|
+
#
|
1526
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
|
1527
|
+
#
|
1528
|
+
# @!attribute [rw] entry_id
|
1529
|
+
# The ID of the entry.
|
1530
|
+
# @return [String]
|
1531
|
+
#
|
1532
|
+
# @!attribute [rw] aggregated_values
|
1533
|
+
# The requested aggregated asset property values (for example,
|
1534
|
+
# average, minimum, and maximum).
|
1535
|
+
# @return [Array<Types::AggregatedValue>]
|
1536
|
+
#
|
1537
|
+
class BatchGetAssetPropertyAggregatesSuccessEntry < Struct.new(
|
1538
|
+
:entry_id,
|
1539
|
+
:aggregated_values)
|
1540
|
+
SENSITIVE = []
|
1541
|
+
include Aws::Structure
|
1542
|
+
end
|
1543
|
+
|
1544
|
+
# Contains information for an asset property value entry that is
|
1545
|
+
# associated with the [BatchGetAssetPropertyValue][1] API.
|
1546
|
+
#
|
1547
|
+
# To identify an asset property, you must specify one of the following:
|
1548
|
+
#
|
1549
|
+
# * The `assetId` and `propertyId` of an asset property.
|
1550
|
+
#
|
1551
|
+
# * A `propertyAlias`, which is a data stream alias (for example,
|
1552
|
+
# `/company/windfarm/3/turbine/7/temperature`). To define an asset
|
1553
|
+
# property's alias, see [UpdateAssetProperty][2].
|
1554
|
+
#
|
1555
|
+
#
|
1556
|
+
#
|
1557
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1558
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
|
1559
|
+
#
|
1560
|
+
# @note When making an API call, you may pass BatchGetAssetPropertyValueEntry
|
1561
|
+
# data as a hash:
|
1562
|
+
#
|
1563
|
+
# {
|
1564
|
+
# entry_id: "EntryId", # required
|
1565
|
+
# asset_id: "ID",
|
1566
|
+
# property_id: "ID",
|
1567
|
+
# property_alias: "AssetPropertyAlias",
|
1568
|
+
# }
|
1569
|
+
#
|
1570
|
+
# @!attribute [rw] entry_id
|
1571
|
+
# The ID of the entry.
|
1572
|
+
# @return [String]
|
1573
|
+
#
|
1574
|
+
# @!attribute [rw] asset_id
|
1575
|
+
# The ID of the asset in which the asset property was created.
|
1576
|
+
# @return [String]
|
1577
|
+
#
|
1578
|
+
# @!attribute [rw] property_id
|
1579
|
+
# The ID of the asset property.
|
1580
|
+
# @return [String]
|
1581
|
+
#
|
1582
|
+
# @!attribute [rw] property_alias
|
1583
|
+
# The alias that identifies the property, such as an OPC-UA server
|
1584
|
+
# data stream path (for example,
|
1585
|
+
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
1586
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
1587
|
+
# *IoT SiteWise User Guide*.
|
1588
|
+
#
|
1589
|
+
#
|
1590
|
+
#
|
1591
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
|
1592
|
+
# @return [String]
|
1593
|
+
#
|
1594
|
+
class BatchGetAssetPropertyValueEntry < Struct.new(
|
1595
|
+
:entry_id,
|
1596
|
+
:asset_id,
|
1597
|
+
:property_id,
|
1598
|
+
:property_alias)
|
1599
|
+
SENSITIVE = []
|
1600
|
+
include Aws::Structure
|
1601
|
+
end
|
1602
|
+
|
1603
|
+
# Contains error information for an asset property value entry that is
|
1604
|
+
# associated with the [BatchGetAssetPropertyValue][1] API.
|
1605
|
+
#
|
1606
|
+
#
|
1607
|
+
#
|
1608
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1609
|
+
#
|
1610
|
+
# @!attribute [rw] error_code
|
1611
|
+
# The error code.
|
1612
|
+
# @return [String]
|
1613
|
+
#
|
1614
|
+
# @!attribute [rw] error_message
|
1615
|
+
# The associated error message.
|
1616
|
+
# @return [String]
|
1617
|
+
#
|
1618
|
+
# @!attribute [rw] entry_id
|
1619
|
+
# The ID of the entry.
|
1620
|
+
# @return [String]
|
1621
|
+
#
|
1622
|
+
class BatchGetAssetPropertyValueErrorEntry < Struct.new(
|
1623
|
+
:error_code,
|
1624
|
+
:error_message,
|
1625
|
+
:entry_id)
|
1626
|
+
SENSITIVE = []
|
1627
|
+
include Aws::Structure
|
1628
|
+
end
|
1629
|
+
|
1630
|
+
# The error information, such as the error code and the timestamp.
|
1631
|
+
#
|
1632
|
+
# @!attribute [rw] error_code
|
1633
|
+
# The error code.
|
1634
|
+
# @return [String]
|
1635
|
+
#
|
1636
|
+
# @!attribute [rw] error_timestamp
|
1637
|
+
# The date the error occurred, in Unix epoch time.
|
1638
|
+
# @return [Time]
|
1639
|
+
#
|
1640
|
+
class BatchGetAssetPropertyValueErrorInfo < Struct.new(
|
1641
|
+
:error_code,
|
1642
|
+
:error_timestamp)
|
1643
|
+
SENSITIVE = []
|
1644
|
+
include Aws::Structure
|
1645
|
+
end
|
1646
|
+
|
1647
|
+
# Contains information for an asset property historical value entry that
|
1648
|
+
# is associated with the [BatchGetAssetPropertyValueHistory][1] API.
|
1649
|
+
#
|
1650
|
+
# To identify an asset property, you must specify one of the following:
|
1651
|
+
#
|
1652
|
+
# * The `assetId` and `propertyId` of an asset property.
|
1653
|
+
#
|
1654
|
+
# * A `propertyAlias`, which is a data stream alias (for example,
|
1655
|
+
# `/company/windfarm/3/turbine/7/temperature`). To define an asset
|
1656
|
+
# property's alias, see [UpdateAssetProperty][2].
|
1657
|
+
#
|
1658
|
+
#
|
1659
|
+
#
|
1660
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1661
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
|
1662
|
+
#
|
1663
|
+
# @note When making an API call, you may pass BatchGetAssetPropertyValueHistoryEntry
|
1664
|
+
# data as a hash:
|
1665
|
+
#
|
1666
|
+
# {
|
1667
|
+
# entry_id: "EntryId", # required
|
1668
|
+
# asset_id: "ID",
|
1669
|
+
# property_id: "ID",
|
1670
|
+
# property_alias: "AssetPropertyAlias",
|
1671
|
+
# start_date: Time.now,
|
1672
|
+
# end_date: Time.now,
|
1673
|
+
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
1674
|
+
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1675
|
+
# }
|
1676
|
+
#
|
1677
|
+
# @!attribute [rw] entry_id
|
1678
|
+
# The ID of the entry.
|
1679
|
+
# @return [String]
|
1680
|
+
#
|
1681
|
+
# @!attribute [rw] asset_id
|
1682
|
+
# The ID of the asset in which the asset property was created.
|
1683
|
+
# @return [String]
|
1684
|
+
#
|
1685
|
+
# @!attribute [rw] property_id
|
1686
|
+
# The ID of the asset property.
|
1687
|
+
# @return [String]
|
1688
|
+
#
|
1689
|
+
# @!attribute [rw] property_alias
|
1690
|
+
# The alias that identifies the property, such as an OPC-UA server
|
1691
|
+
# data stream path (for example,
|
1692
|
+
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
1693
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
1694
|
+
# *IoT SiteWise User Guide*.
|
1695
|
+
#
|
1696
|
+
#
|
1697
|
+
#
|
1698
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
|
1699
|
+
# @return [String]
|
1700
|
+
#
|
1701
|
+
# @!attribute [rw] start_date
|
1702
|
+
# The exclusive start of the range from which to query historical
|
1703
|
+
# data, expressed in seconds in Unix epoch time.
|
1704
|
+
# @return [Time]
|
1705
|
+
#
|
1706
|
+
# @!attribute [rw] end_date
|
1707
|
+
# The inclusive end of the range from which to query historical data,
|
1708
|
+
# expressed in seconds in Unix epoch time.
|
1709
|
+
# @return [Time]
|
1710
|
+
#
|
1711
|
+
# @!attribute [rw] qualities
|
1712
|
+
# The quality by which to filter asset data.
|
1713
|
+
# @return [Array<String>]
|
1714
|
+
#
|
1715
|
+
# @!attribute [rw] time_ordering
|
1716
|
+
# The chronological sorting order of the requested information.
|
1717
|
+
#
|
1718
|
+
# Default: `ASCENDING`
|
1719
|
+
# @return [String]
|
1720
|
+
#
|
1721
|
+
class BatchGetAssetPropertyValueHistoryEntry < Struct.new(
|
1722
|
+
:entry_id,
|
1723
|
+
:asset_id,
|
1724
|
+
:property_id,
|
1725
|
+
:property_alias,
|
1726
|
+
:start_date,
|
1727
|
+
:end_date,
|
1728
|
+
:qualities,
|
1729
|
+
:time_ordering)
|
1730
|
+
SENSITIVE = []
|
1731
|
+
include Aws::Structure
|
1732
|
+
end
|
1733
|
+
|
1734
|
+
# A list of the errors (if any) associated with the batch request. Each
|
1735
|
+
# error entry contains the `entryId` of the entry that failed.
|
1736
|
+
#
|
1737
|
+
# @!attribute [rw] error_code
|
1738
|
+
# The error code.
|
1739
|
+
# @return [String]
|
1740
|
+
#
|
1741
|
+
# @!attribute [rw] error_message
|
1742
|
+
# The associated error message.
|
1743
|
+
# @return [String]
|
1744
|
+
#
|
1745
|
+
# @!attribute [rw] entry_id
|
1746
|
+
# The ID of the entry.
|
1747
|
+
# @return [String]
|
1748
|
+
#
|
1749
|
+
class BatchGetAssetPropertyValueHistoryErrorEntry < Struct.new(
|
1750
|
+
:error_code,
|
1751
|
+
:error_message,
|
1752
|
+
:entry_id)
|
1753
|
+
SENSITIVE = []
|
1754
|
+
include Aws::Structure
|
1755
|
+
end
|
1756
|
+
|
1757
|
+
# The error information, such as the error code and the timestamp.
|
1758
|
+
#
|
1759
|
+
# @!attribute [rw] error_code
|
1760
|
+
# The error code.
|
1761
|
+
# @return [String]
|
1762
|
+
#
|
1763
|
+
# @!attribute [rw] error_timestamp
|
1764
|
+
# The date the error occurred, in Unix epoch time.
|
1765
|
+
# @return [Time]
|
1766
|
+
#
|
1767
|
+
class BatchGetAssetPropertyValueHistoryErrorInfo < Struct.new(
|
1768
|
+
:error_code,
|
1769
|
+
:error_timestamp)
|
1770
|
+
SENSITIVE = []
|
1771
|
+
include Aws::Structure
|
1772
|
+
end
|
1773
|
+
|
1774
|
+
# @note When making an API call, you may pass BatchGetAssetPropertyValueHistoryRequest
|
1775
|
+
# data as a hash:
|
1776
|
+
#
|
1777
|
+
# {
|
1778
|
+
# entries: [ # required
|
1779
|
+
# {
|
1780
|
+
# entry_id: "EntryId", # required
|
1781
|
+
# asset_id: "ID",
|
1782
|
+
# property_id: "ID",
|
1783
|
+
# property_alias: "AssetPropertyAlias",
|
1784
|
+
# start_date: Time.now,
|
1785
|
+
# end_date: Time.now,
|
1786
|
+
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
1787
|
+
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1788
|
+
# },
|
1789
|
+
# ],
|
1790
|
+
# next_token: "NextToken",
|
1791
|
+
# max_results: 1,
|
1792
|
+
# }
|
1793
|
+
#
|
1794
|
+
# @!attribute [rw] entries
|
1795
|
+
# The list of asset property historical value entries for the batch
|
1796
|
+
# get request. You can specify up to 16 entries per request.
|
1797
|
+
# @return [Array<Types::BatchGetAssetPropertyValueHistoryEntry>]
|
1798
|
+
#
|
1799
|
+
# @!attribute [rw] next_token
|
1800
|
+
# The token to be used for the next set of paginated results.
|
1801
|
+
# @return [String]
|
1802
|
+
#
|
1803
|
+
# @!attribute [rw] max_results
|
1804
|
+
# The maximum number of results to return for each paginated request.
|
1805
|
+
# A result set is returned in the two cases, whichever occurs first.
|
1806
|
+
#
|
1807
|
+
# * The size of the result set is less than 1 MB.
|
1808
|
+
#
|
1809
|
+
# * The number of data points in the result set is less than the value
|
1810
|
+
# of `maxResults`. The maximum value of `maxResults` is 4000.
|
1811
|
+
# @return [Integer]
|
1812
|
+
#
|
1813
|
+
class BatchGetAssetPropertyValueHistoryRequest < Struct.new(
|
1814
|
+
:entries,
|
1815
|
+
:next_token,
|
1816
|
+
:max_results)
|
1817
|
+
SENSITIVE = []
|
1818
|
+
include Aws::Structure
|
1819
|
+
end
|
1820
|
+
|
1821
|
+
# @!attribute [rw] error_entries
|
1822
|
+
# A list of the errors (if any) associated with the batch request.
|
1823
|
+
# Each error entry contains the `entryId` of the entry that failed.
|
1824
|
+
# @return [Array<Types::BatchGetAssetPropertyValueHistoryErrorEntry>]
|
1825
|
+
#
|
1826
|
+
# @!attribute [rw] success_entries
|
1827
|
+
# A list of entries that were processed successfully by this batch
|
1828
|
+
# request. Each success entry contains the `entryId` of the entry that
|
1829
|
+
# succeeded and the latest query result.
|
1830
|
+
# @return [Array<Types::BatchGetAssetPropertyValueHistorySuccessEntry>]
|
1831
|
+
#
|
1832
|
+
# @!attribute [rw] skipped_entries
|
1833
|
+
# A list of entries that were not processed by this batch request.
|
1834
|
+
# because these entries had been completely processed by previous
|
1835
|
+
# paginated requests. Each skipped entry contains the `entryId` of the
|
1836
|
+
# entry that skipped.
|
1837
|
+
# @return [Array<Types::BatchGetAssetPropertyValueHistorySkippedEntry>]
|
1838
|
+
#
|
1839
|
+
# @!attribute [rw] next_token
|
1840
|
+
# The token for the next set of results, or null if there are no
|
1841
|
+
# additional results.
|
1842
|
+
# @return [String]
|
1843
|
+
#
|
1844
|
+
class BatchGetAssetPropertyValueHistoryResponse < Struct.new(
|
1845
|
+
:error_entries,
|
1846
|
+
:success_entries,
|
1847
|
+
:skipped_entries,
|
1848
|
+
:next_token)
|
1849
|
+
SENSITIVE = []
|
1850
|
+
include Aws::Structure
|
1851
|
+
end
|
1852
|
+
|
1853
|
+
# Contains information for an entry that has been processed by the
|
1854
|
+
# previous [BatchGetAssetPropertyValueHistory][1] request.
|
1855
|
+
#
|
1856
|
+
#
|
1857
|
+
#
|
1858
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1859
|
+
#
|
1860
|
+
# @!attribute [rw] entry_id
|
1861
|
+
# The ID of the entry.
|
1862
|
+
# @return [String]
|
1863
|
+
#
|
1864
|
+
# @!attribute [rw] completion_status
|
1865
|
+
# The completion status of each entry that is associated with the
|
1866
|
+
# [BatchGetAssetPropertyValueHistory][1] API.
|
1867
|
+
#
|
1868
|
+
#
|
1869
|
+
#
|
1870
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html
|
1871
|
+
# @return [String]
|
1872
|
+
#
|
1873
|
+
# @!attribute [rw] error_info
|
1874
|
+
# The error information, such as the error code and the timestamp.
|
1875
|
+
# @return [Types::BatchGetAssetPropertyValueHistoryErrorInfo]
|
1876
|
+
#
|
1877
|
+
class BatchGetAssetPropertyValueHistorySkippedEntry < Struct.new(
|
1878
|
+
:entry_id,
|
1879
|
+
:completion_status,
|
1880
|
+
:error_info)
|
1881
|
+
SENSITIVE = []
|
1882
|
+
include Aws::Structure
|
1883
|
+
end
|
1884
|
+
|
1885
|
+
# Contains success information for an entry that is associated with the
|
1886
|
+
# [BatchGetAssetPropertyValueHistory][1] API.
|
1887
|
+
#
|
1888
|
+
#
|
1889
|
+
#
|
1890
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1891
|
+
#
|
1892
|
+
# @!attribute [rw] entry_id
|
1893
|
+
# The ID of the entry.
|
1894
|
+
# @return [String]
|
1895
|
+
#
|
1896
|
+
# @!attribute [rw] asset_property_value_history
|
1897
|
+
# The requested historical values for the specified asset property.
|
1898
|
+
# @return [Array<Types::AssetPropertyValue>]
|
1899
|
+
#
|
1900
|
+
class BatchGetAssetPropertyValueHistorySuccessEntry < Struct.new(
|
1901
|
+
:entry_id,
|
1902
|
+
:asset_property_value_history)
|
1903
|
+
SENSITIVE = []
|
1904
|
+
include Aws::Structure
|
1905
|
+
end
|
1906
|
+
|
1907
|
+
# @note When making an API call, you may pass BatchGetAssetPropertyValueRequest
|
1908
|
+
# data as a hash:
|
1909
|
+
#
|
1910
|
+
# {
|
1911
|
+
# entries: [ # required
|
1912
|
+
# {
|
1913
|
+
# entry_id: "EntryId", # required
|
1914
|
+
# asset_id: "ID",
|
1915
|
+
# property_id: "ID",
|
1916
|
+
# property_alias: "AssetPropertyAlias",
|
1917
|
+
# },
|
1918
|
+
# ],
|
1919
|
+
# next_token: "NextToken",
|
1920
|
+
# }
|
1921
|
+
#
|
1922
|
+
# @!attribute [rw] entries
|
1923
|
+
# The list of asset property value entries for the batch get request.
|
1924
|
+
# You can specify up to 16 entries per request.
|
1925
|
+
# @return [Array<Types::BatchGetAssetPropertyValueEntry>]
|
1926
|
+
#
|
1927
|
+
# @!attribute [rw] next_token
|
1928
|
+
# The token to be used for the next set of paginated results.
|
1929
|
+
# @return [String]
|
1930
|
+
#
|
1931
|
+
class BatchGetAssetPropertyValueRequest < Struct.new(
|
1932
|
+
:entries,
|
1933
|
+
:next_token)
|
1934
|
+
SENSITIVE = []
|
1935
|
+
include Aws::Structure
|
1936
|
+
end
|
1937
|
+
|
1938
|
+
# @!attribute [rw] error_entries
|
1939
|
+
# A list of the errors (if any) associated with the batch request.
|
1940
|
+
# Each error entry contains the `entryId` of the entry that failed.
|
1941
|
+
# @return [Array<Types::BatchGetAssetPropertyValueErrorEntry>]
|
1942
|
+
#
|
1943
|
+
# @!attribute [rw] success_entries
|
1944
|
+
# A list of entries that were processed successfully by this batch
|
1945
|
+
# request. Each success entry contains the `entryId` of the entry that
|
1946
|
+
# succeeded and the latest query result.
|
1947
|
+
# @return [Array<Types::BatchGetAssetPropertyValueSuccessEntry>]
|
1948
|
+
#
|
1949
|
+
# @!attribute [rw] skipped_entries
|
1950
|
+
# A list of entries that were not processed by this batch request.
|
1951
|
+
# because these entries had been completely processed by previous
|
1952
|
+
# paginated requests. Each skipped entry contains the `entryId` of the
|
1953
|
+
# entry that skipped.
|
1954
|
+
# @return [Array<Types::BatchGetAssetPropertyValueSkippedEntry>]
|
1955
|
+
#
|
1956
|
+
# @!attribute [rw] next_token
|
1957
|
+
# The token for the next set of results, or null if there are no
|
1958
|
+
# additional results.
|
1959
|
+
# @return [String]
|
1960
|
+
#
|
1961
|
+
class BatchGetAssetPropertyValueResponse < Struct.new(
|
1962
|
+
:error_entries,
|
1963
|
+
:success_entries,
|
1964
|
+
:skipped_entries,
|
1965
|
+
:next_token)
|
1966
|
+
SENSITIVE = []
|
1967
|
+
include Aws::Structure
|
1968
|
+
end
|
1969
|
+
|
1970
|
+
# Contains information for an entry that has been processed by the
|
1971
|
+
# previous [BatchGetAssetPropertyValue][1] request.
|
1972
|
+
#
|
1973
|
+
#
|
1974
|
+
#
|
1975
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1976
|
+
#
|
1977
|
+
# @!attribute [rw] entry_id
|
1978
|
+
# The ID of the entry.
|
1979
|
+
# @return [String]
|
1980
|
+
#
|
1981
|
+
# @!attribute [rw] completion_status
|
1982
|
+
# The completion status of each entry that is associated with the
|
1983
|
+
# [BatchGetAssetPropertyValue][1] request.
|
1984
|
+
#
|
1985
|
+
#
|
1986
|
+
#
|
1987
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
1988
|
+
# @return [String]
|
1989
|
+
#
|
1990
|
+
# @!attribute [rw] error_info
|
1991
|
+
# The error information, such as the error code and the timestamp.
|
1992
|
+
# @return [Types::BatchGetAssetPropertyValueErrorInfo]
|
1993
|
+
#
|
1994
|
+
class BatchGetAssetPropertyValueSkippedEntry < Struct.new(
|
1995
|
+
:entry_id,
|
1996
|
+
:completion_status,
|
1997
|
+
:error_info)
|
1998
|
+
SENSITIVE = []
|
1999
|
+
include Aws::Structure
|
2000
|
+
end
|
2001
|
+
|
2002
|
+
# Contains success information for an entry that is associated with the
|
2003
|
+
# [BatchGetAssetPropertyValue][1] API.
|
2004
|
+
#
|
2005
|
+
#
|
2006
|
+
#
|
2007
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
|
2008
|
+
#
|
2009
|
+
# @!attribute [rw] entry_id
|
2010
|
+
# The ID of the entry.
|
2011
|
+
# @return [String]
|
2012
|
+
#
|
2013
|
+
# @!attribute [rw] asset_property_value
|
2014
|
+
# Contains asset property value information.
|
2015
|
+
# @return [Types::AssetPropertyValue]
|
2016
|
+
#
|
2017
|
+
class BatchGetAssetPropertyValueSuccessEntry < Struct.new(
|
2018
|
+
:entry_id,
|
2019
|
+
:asset_property_value)
|
2020
|
+
SENSITIVE = []
|
2021
|
+
include Aws::Structure
|
2022
|
+
end
|
2023
|
+
|
1259
2024
|
# Contains error information from updating a batch of asset property
|
1260
2025
|
# values.
|
1261
2026
|
#
|