aws-sdk-iotsitewise 1.40.0 → 1.43.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.
@@ -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
@@ -1123,6 +1128,10 @@ module Aws::IoTSiteWise
1123
1128
  # hierarchy specifies allowed parent/child asset relationships.
1124
1129
  # @return [Array<Types::AssetHierarchy>]
1125
1130
  #
1131
+ # @!attribute [rw] description
1132
+ # A description for the asset.
1133
+ # @return [String]
1134
+ #
1126
1135
  class AssociatedAssetsSummary < Struct.new(
1127
1136
  :id,
1128
1137
  :arn,
@@ -1131,7 +1140,8 @@ module Aws::IoTSiteWise
1131
1140
  :creation_date,
1132
1141
  :last_update_date,
1133
1142
  :status,
1134
- :hierarchies)
1143
+ :hierarchies,
1144
+ :description)
1135
1145
  SENSITIVE = []
1136
1146
  include Aws::Structure
1137
1147
  end
@@ -1221,37 +1231,802 @@ module Aws::IoTSiteWise
1221
1231
  # client_token: "ClientToken",
1222
1232
  # }
1223
1233
  #
1224
- # @!attribute [rw] project_id
1225
- # The ID of the project from which to disassociate the assets.
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.
1753
+ # @return [String]
1754
+ #
1755
+ # @!attribute [rw] entry_id
1756
+ # The ID of the entry.
1757
+ # @return [String]
1758
+ #
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.
1768
+ #
1769
+ # @!attribute [rw] error_code
1770
+ # The error code.
1771
+ # @return [String]
1772
+ #
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)
1780
+ SENSITIVE = []
1781
+ include Aws::Structure
1782
+ end
1783
+
1784
+ # @note When making an API call, you may pass BatchGetAssetPropertyValueHistoryRequest
1785
+ # data as a hash:
1786
+ #
1787
+ # {
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,
1802
+ # }
1803
+ #
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>]
1808
+ #
1809
+ # @!attribute [rw] next_token
1810
+ # The token to be used for the next set of paginated results.
1811
+ # @return [String]
1812
+ #
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.
1816
+ #
1817
+ # * The size of the result set is less than 1 MB.
1818
+ #
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]
1822
+ #
1823
+ class BatchGetAssetPropertyValueHistoryRequest < Struct.new(
1824
+ :entries,
1825
+ :next_token,
1826
+ :max_results)
1827
+ SENSITIVE = []
1828
+ include Aws::Structure
1829
+ end
1830
+
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>]
1835
+ #
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>]
1841
+ #
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>]
1848
+ #
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]
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.
1865
+ #
1866
+ #
1867
+ #
1868
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
1869
+ #
1870
+ # @!attribute [rw] entry_id
1871
+ # The ID of the entry.
1872
+ # @return [String]
1873
+ #
1874
+ # @!attribute [rw] completion_status
1875
+ # The completion status of each entry that is associated with the
1876
+ # [BatchGetAssetPropertyValueHistory][1] API.
1877
+ #
1878
+ #
1879
+ #
1880
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html
1881
+ # @return [String]
1882
+ #
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)
1891
+ SENSITIVE = []
1892
+ include Aws::Structure
1893
+ end
1894
+
1895
+ # Contains success information for an entry that is associated with the
1896
+ # [BatchGetAssetPropertyValueHistory][1] API.
1897
+ #
1898
+ #
1899
+ #
1900
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
1901
+ #
1902
+ # @!attribute [rw] entry_id
1903
+ # The ID of the entry.
1904
+ # @return [String]
1905
+ #
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)
1913
+ SENSITIVE = []
1914
+ include Aws::Structure
1915
+ end
1916
+
1917
+ # @note When making an API call, you may pass BatchGetAssetPropertyValueRequest
1918
+ # data as a hash:
1919
+ #
1920
+ # {
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",
1930
+ # }
1931
+ #
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>]
1936
+ #
1937
+ # @!attribute [rw] next_token
1938
+ # The token to be used for the next set of paginated results.
1939
+ # @return [String]
1940
+ #
1941
+ class BatchGetAssetPropertyValueRequest < Struct.new(
1942
+ :entries,
1943
+ :next_token)
1944
+ SENSITIVE = []
1945
+ include Aws::Structure
1946
+ end
1947
+
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>]
1952
+ #
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)
1976
+ SENSITIVE = []
1977
+ include Aws::Structure
1978
+ end
1979
+
1980
+ # Contains information for an entry that has been processed by the
1981
+ # previous [BatchGetAssetPropertyValue][1] request.
1982
+ #
1983
+ #
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] asset_ids
1229
- # The IDs of the assets to be disassociated from the project.
1230
- # @return [Array<String>]
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
- # **A suitable default value is auto-generated.** You should normally
1238
- # not need to pass this option.
1996
+ #
1997
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
1239
1998
  # @return [String]
1240
1999
  #
1241
- class BatchDisassociateProjectAssetsRequest < Struct.new(
1242
- :project_id,
1243
- :asset_ids,
1244
- :client_token)
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
- # @!attribute [rw] errors
1250
- # A list of associated error information, if any.
1251
- # @return [Array<Types::AssetErrorDetails>]
2012
+ # Contains success information for an entry that is associated with the
2013
+ # [BatchGetAssetPropertyValue][1] API.
1252
2014
  #
1253
- class BatchDisassociateProjectAssetsResponse < Struct.new(
1254
- :errors)
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
@@ -1851,6 +2632,109 @@ module Aws::IoTSiteWise
1851
2632
  include Aws::Structure
1852
2633
  end
1853
2634
 
2635
+ # @note When making an API call, you may pass CreateBulkImportJobRequest
2636
+ # data as a hash:
2637
+ #
2638
+ # {
2639
+ # job_name: "Name", # required
2640
+ # job_role_arn: "ARN", # required
2641
+ # files: [ # required
2642
+ # {
2643
+ # bucket: "Bucket", # required
2644
+ # key: "String", # required
2645
+ # version_id: "String",
2646
+ # },
2647
+ # ],
2648
+ # error_report_location: { # required
2649
+ # bucket: "Bucket", # required
2650
+ # prefix: "String", # required
2651
+ # },
2652
+ # job_configuration: { # required
2653
+ # file_format: { # required
2654
+ # csv: {
2655
+ # column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
2656
+ # },
2657
+ # },
2658
+ # },
2659
+ # }
2660
+ #
2661
+ # @!attribute [rw] job_name
2662
+ # The unique name that helps identify the job request.
2663
+ # @return [String]
2664
+ #
2665
+ # @!attribute [rw] job_role_arn
2666
+ # The [ARN][1] of the IAM role that allows IoT SiteWise to read Amazon
2667
+ # S3 data.
2668
+ #
2669
+ #
2670
+ #
2671
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
2672
+ # @return [String]
2673
+ #
2674
+ # @!attribute [rw] files
2675
+ # The files in the specified Amazon S3 bucket that contain your data.
2676
+ # @return [Array<Types::File>]
2677
+ #
2678
+ # @!attribute [rw] error_report_location
2679
+ # The Amazon S3 destination where errors associated with the job
2680
+ # creation request are saved.
2681
+ # @return [Types::ErrorReportLocation]
2682
+ #
2683
+ # @!attribute [rw] job_configuration
2684
+ # Contains the configuration information of a job, such as the file
2685
+ # format used to save data in Amazon S3.
2686
+ # @return [Types::JobConfiguration]
2687
+ #
2688
+ class CreateBulkImportJobRequest < Struct.new(
2689
+ :job_name,
2690
+ :job_role_arn,
2691
+ :files,
2692
+ :error_report_location,
2693
+ :job_configuration)
2694
+ SENSITIVE = []
2695
+ include Aws::Structure
2696
+ end
2697
+
2698
+ # @!attribute [rw] job_id
2699
+ # The ID of the job.
2700
+ # @return [String]
2701
+ #
2702
+ # @!attribute [rw] job_name
2703
+ # The unique name that helps identify the job request.
2704
+ # @return [String]
2705
+ #
2706
+ # @!attribute [rw] job_status
2707
+ # The status of the bulk import job can be one of following values.
2708
+ #
2709
+ # * `PENDING` – IoT SiteWise is waiting for the current bulk import
2710
+ # job to finish.
2711
+ #
2712
+ # * `CANCELLED` – The bulk import job has been canceled.
2713
+ #
2714
+ # * `RUNNING` – IoT SiteWise is processing your request to import your
2715
+ # data from Amazon S3.
2716
+ #
2717
+ # * `COMPLETED` – IoT SiteWise successfully completed your request to
2718
+ # import data from Amazon S3.
2719
+ #
2720
+ # * `FAILED` – IoT SiteWise couldn't process your request to import
2721
+ # data from Amazon S3. You can use logs saved in the specified error
2722
+ # report location in Amazon S3 to troubleshoot issues.
2723
+ #
2724
+ # * `COMPLETED_WITH_FAILURES` – IoT SiteWise completed your request to
2725
+ # import data from Amazon S3 with errors. You can use logs saved in
2726
+ # the specified error report location in Amazon S3 to troubleshoot
2727
+ # issues.
2728
+ # @return [String]
2729
+ #
2730
+ class CreateBulkImportJobResponse < Struct.new(
2731
+ :job_id,
2732
+ :job_name,
2733
+ :job_status)
2734
+ SENSITIVE = []
2735
+ include Aws::Structure
2736
+ end
2737
+
1854
2738
  # @note When making an API call, you may pass CreateDashboardRequest
1855
2739
  # data as a hash:
1856
2740
  #
@@ -2257,6 +3141,25 @@ module Aws::IoTSiteWise
2257
3141
  include Aws::Structure
2258
3142
  end
2259
3143
 
3144
+ # A .csv file.
3145
+ #
3146
+ # @note When making an API call, you may pass Csv
3147
+ # data as a hash:
3148
+ #
3149
+ # {
3150
+ # column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
3151
+ # }
3152
+ #
3153
+ # @!attribute [rw] column_names
3154
+ # The column names specified in the .csv file.
3155
+ # @return [Array<String>]
3156
+ #
3157
+ class Csv < Struct.new(
3158
+ :column_names)
3159
+ SENSITIVE = []
3160
+ include Aws::Structure
3161
+ end
3162
+
2260
3163
  # Contains information about a customer managed Amazon S3 bucket.
2261
3164
  #
2262
3165
  # @note When making an API call, you may pass CustomerManagedS3Storage
@@ -2869,6 +3772,10 @@ module Aws::IoTSiteWise
2869
3772
  # error message.
2870
3773
  # @return [Types::AssetStatus]
2871
3774
  #
3775
+ # @!attribute [rw] asset_description
3776
+ # A description for the asset.
3777
+ # @return [String]
3778
+ #
2872
3779
  class DescribeAssetResponse < Struct.new(
2873
3780
  :asset_id,
2874
3781
  :asset_arn,
@@ -2879,7 +3786,102 @@ module Aws::IoTSiteWise
2879
3786
  :asset_composite_models,
2880
3787
  :asset_creation_date,
2881
3788
  :asset_last_update_date,
2882
- :asset_status)
3789
+ :asset_status,
3790
+ :asset_description)
3791
+ SENSITIVE = []
3792
+ include Aws::Structure
3793
+ end
3794
+
3795
+ # @note When making an API call, you may pass DescribeBulkImportJobRequest
3796
+ # data as a hash:
3797
+ #
3798
+ # {
3799
+ # job_id: "ID", # required
3800
+ # }
3801
+ #
3802
+ # @!attribute [rw] job_id
3803
+ # The ID of the job.
3804
+ # @return [String]
3805
+ #
3806
+ class DescribeBulkImportJobRequest < Struct.new(
3807
+ :job_id)
3808
+ SENSITIVE = []
3809
+ include Aws::Structure
3810
+ end
3811
+
3812
+ # @!attribute [rw] job_id
3813
+ # The ID of the job.
3814
+ # @return [String]
3815
+ #
3816
+ # @!attribute [rw] job_name
3817
+ # The unique name that helps identify the job request.
3818
+ # @return [String]
3819
+ #
3820
+ # @!attribute [rw] job_status
3821
+ # The status of the bulk import job can be one of following values.
3822
+ #
3823
+ # * `PENDING` – IoT SiteWise is waiting for the current bulk import
3824
+ # job to finish.
3825
+ #
3826
+ # * `CANCELLED` – The bulk import job has been canceled.
3827
+ #
3828
+ # * `RUNNING` – IoT SiteWise is processing your request to import your
3829
+ # data from Amazon S3.
3830
+ #
3831
+ # * `COMPLETED` – IoT SiteWise successfully completed your request to
3832
+ # import data from Amazon S3.
3833
+ #
3834
+ # * `FAILED` – IoT SiteWise couldn't process your request to import
3835
+ # data from Amazon S3. You can use logs saved in the specified error
3836
+ # report location in Amazon S3 to troubleshoot issues.
3837
+ #
3838
+ # * `COMPLETED_WITH_FAILURES` – IoT SiteWise completed your request to
3839
+ # import data from Amazon S3 with errors. You can use logs saved in
3840
+ # the specified error report location in Amazon S3 to troubleshoot
3841
+ # issues.
3842
+ # @return [String]
3843
+ #
3844
+ # @!attribute [rw] job_role_arn
3845
+ # The [ARN][1] of the IAM role that allows IoT SiteWise to read Amazon
3846
+ # S3 data.
3847
+ #
3848
+ #
3849
+ #
3850
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
3851
+ # @return [String]
3852
+ #
3853
+ # @!attribute [rw] files
3854
+ # The files in the specified Amazon S3 bucket that contain your data.
3855
+ # @return [Array<Types::File>]
3856
+ #
3857
+ # @!attribute [rw] error_report_location
3858
+ # The Amazon S3 destination where errors associated with the job
3859
+ # creation request are saved.
3860
+ # @return [Types::ErrorReportLocation]
3861
+ #
3862
+ # @!attribute [rw] job_configuration
3863
+ # Contains the configuration information of a job, such as the file
3864
+ # format used to save data in Amazon S3.
3865
+ # @return [Types::JobConfiguration]
3866
+ #
3867
+ # @!attribute [rw] job_creation_date
3868
+ # The date the job was created, in Unix epoch TIME.
3869
+ # @return [Time]
3870
+ #
3871
+ # @!attribute [rw] job_last_update_date
3872
+ # The date the job was last updated, in Unix epoch time.
3873
+ # @return [Time]
3874
+ #
3875
+ class DescribeBulkImportJobResponse < Struct.new(
3876
+ :job_id,
3877
+ :job_name,
3878
+ :job_status,
3879
+ :job_role_arn,
3880
+ :files,
3881
+ :error_report_location,
3882
+ :job_configuration,
3883
+ :job_creation_date,
3884
+ :job_last_update_date)
2883
3885
  SENSITIVE = []
2884
3886
  include Aws::Structure
2885
3887
  end
@@ -3328,7 +4330,7 @@ module Aws::IoTSiteWise
3328
4330
  # hot tier. The hot tier is a service-managed database.
3329
4331
  #
3330
4332
  # * `MULTI_LAYER_STORAGE` – IoT SiteWise saves your data in both the
3331
- # cold tier and the cold tier. The cold tier is a customer-managed
4333
+ # cold tier and the hot tier. The cold tier is a customer-managed
3332
4334
  # Amazon S3 bucket.
3333
4335
  # @return [String]
3334
4336
  #
@@ -3594,6 +4596,42 @@ module Aws::IoTSiteWise
3594
4596
  include Aws::Structure
3595
4597
  end
3596
4598
 
4599
+ # The Amazon S3 destination where errors associated with the job
4600
+ # creation request are saved.
4601
+ #
4602
+ # @note When making an API call, you may pass ErrorReportLocation
4603
+ # data as a hash:
4604
+ #
4605
+ # {
4606
+ # bucket: "Bucket", # required
4607
+ # prefix: "String", # required
4608
+ # }
4609
+ #
4610
+ # @!attribute [rw] bucket
4611
+ # The name of the Amazon S3 bucket to which errors associated with the
4612
+ # bulk import job are sent.
4613
+ # @return [String]
4614
+ #
4615
+ # @!attribute [rw] prefix
4616
+ # Amazon S3 uses the prefix as a folder name to organize data in the
4617
+ # bucket. Each Amazon S3 object has a key that is its unique
4618
+ # identifier in the bucket. Each object in a bucket has exactly one
4619
+ # key. The prefix must end with a forward slash (/). For more
4620
+ # information, see [Organizing objects using prefixes][1] in the
4621
+ # *Amazon Simple Storage Service User Guide*.
4622
+ #
4623
+ #
4624
+ #
4625
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html
4626
+ # @return [String]
4627
+ #
4628
+ class ErrorReportLocation < Struct.new(
4629
+ :bucket,
4630
+ :prefix)
4631
+ SENSITIVE = []
4632
+ include Aws::Structure
4633
+ end
4634
+
3597
4635
  # Contains expression variable information.
3598
4636
  #
3599
4637
  # @note When making an API call, you may pass ExpressionVariable
@@ -3623,6 +4661,61 @@ module Aws::IoTSiteWise
3623
4661
  include Aws::Structure
3624
4662
  end
3625
4663
 
4664
+ # The file in Amazon S3 where your data is saved.
4665
+ #
4666
+ # @note When making an API call, you may pass File
4667
+ # data as a hash:
4668
+ #
4669
+ # {
4670
+ # bucket: "Bucket", # required
4671
+ # key: "String", # required
4672
+ # version_id: "String",
4673
+ # }
4674
+ #
4675
+ # @!attribute [rw] bucket
4676
+ # The name of the Amazon S3 bucket from which data is imported.
4677
+ # @return [String]
4678
+ #
4679
+ # @!attribute [rw] key
4680
+ # The key of the Amazon S3 object that contains your data. Each object
4681
+ # has a key that is a unique identifier. Each object has exactly one
4682
+ # key.
4683
+ # @return [String]
4684
+ #
4685
+ # @!attribute [rw] version_id
4686
+ # The version ID to identify a specific version of the Amazon S3
4687
+ # object that contains your data.
4688
+ # @return [String]
4689
+ #
4690
+ class File < Struct.new(
4691
+ :bucket,
4692
+ :key,
4693
+ :version_id)
4694
+ SENSITIVE = []
4695
+ include Aws::Structure
4696
+ end
4697
+
4698
+ # The file format of the data.
4699
+ #
4700
+ # @note When making an API call, you may pass FileFormat
4701
+ # data as a hash:
4702
+ #
4703
+ # {
4704
+ # csv: {
4705
+ # column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
4706
+ # },
4707
+ # }
4708
+ #
4709
+ # @!attribute [rw] csv
4710
+ # The .csv file format.
4711
+ # @return [Types::Csv]
4712
+ #
4713
+ class FileFormat < Struct.new(
4714
+ :csv)
4715
+ SENSITIVE = []
4716
+ include Aws::Structure
4717
+ end
4718
+
3626
4719
  # The forwarding configuration for a given property.
3627
4720
  #
3628
4721
  # @note When making an API call, you may pass ForwardingConfig
@@ -4485,6 +5578,72 @@ module Aws::IoTSiteWise
4485
5578
  include Aws::Structure
4486
5579
  end
4487
5580
 
5581
+ # Contains the configuration information of a job, such as the file
5582
+ # format used to save data in Amazon S3.
5583
+ #
5584
+ # @note When making an API call, you may pass JobConfiguration
5585
+ # data as a hash:
5586
+ #
5587
+ # {
5588
+ # file_format: { # required
5589
+ # csv: {
5590
+ # column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
5591
+ # },
5592
+ # },
5593
+ # }
5594
+ #
5595
+ # @!attribute [rw] file_format
5596
+ # The file format of the data in Amazon S3.
5597
+ # @return [Types::FileFormat]
5598
+ #
5599
+ class JobConfiguration < Struct.new(
5600
+ :file_format)
5601
+ SENSITIVE = []
5602
+ include Aws::Structure
5603
+ end
5604
+
5605
+ # Contains a job summary information.
5606
+ #
5607
+ # @!attribute [rw] id
5608
+ # The ID of the job.
5609
+ # @return [String]
5610
+ #
5611
+ # @!attribute [rw] name
5612
+ # The unique name that helps identify the job request.
5613
+ # @return [String]
5614
+ #
5615
+ # @!attribute [rw] status
5616
+ # The status of the bulk import job can be one of following values.
5617
+ #
5618
+ # * `PENDING` – IoT SiteWise is waiting for the current bulk import
5619
+ # job to finish.
5620
+ #
5621
+ # * `CANCELLED` – The bulk import job has been canceled.
5622
+ #
5623
+ # * `RUNNING` – IoT SiteWise is processing your request to import your
5624
+ # data from Amazon S3.
5625
+ #
5626
+ # * `COMPLETED` – IoT SiteWise successfully completed your request to
5627
+ # import data from Amazon S3.
5628
+ #
5629
+ # * `FAILED` – IoT SiteWise couldn't process your request to import
5630
+ # data from Amazon S3. You can use logs saved in the specified error
5631
+ # report location in Amazon S3 to troubleshoot issues.
5632
+ #
5633
+ # * `COMPLETED_WITH_FAILURES` – IoT SiteWise completed your request to
5634
+ # import data from Amazon S3 with errors. You can use logs saved in
5635
+ # the specified error report location in Amazon S3 to troubleshoot
5636
+ # issues.
5637
+ # @return [String]
5638
+ #
5639
+ class JobSummary < Struct.new(
5640
+ :id,
5641
+ :name,
5642
+ :status)
5643
+ SENSITIVE = []
5644
+ include Aws::Structure
5645
+ end
5646
+
4488
5647
  # You've reached the limit for a resource. For example, this can occur
4489
5648
  # if you're trying to associate more than the allowed number of child
4490
5649
  # assets or attempting to create more than the allowed number of
@@ -4831,6 +5990,52 @@ module Aws::IoTSiteWise
4831
5990
  include Aws::Structure
4832
5991
  end
4833
5992
 
5993
+ # @note When making an API call, you may pass ListBulkImportJobsRequest
5994
+ # data as a hash:
5995
+ #
5996
+ # {
5997
+ # next_token: "NextToken",
5998
+ # max_results: 1,
5999
+ # filter: "ALL", # accepts ALL, PENDING, RUNNING, CANCELLED, FAILED, COMPLETED_WITH_FAILURES, COMPLETED
6000
+ # }
6001
+ #
6002
+ # @!attribute [rw] next_token
6003
+ # The token to be used for the next set of paginated results.
6004
+ # @return [String]
6005
+ #
6006
+ # @!attribute [rw] max_results
6007
+ # The maximum number of results to return for each paginated request.
6008
+ # @return [Integer]
6009
+ #
6010
+ # @!attribute [rw] filter
6011
+ # You can use a filter to select the bulk import jobs that you want to
6012
+ # retrieve.
6013
+ # @return [String]
6014
+ #
6015
+ class ListBulkImportJobsRequest < Struct.new(
6016
+ :next_token,
6017
+ :max_results,
6018
+ :filter)
6019
+ SENSITIVE = []
6020
+ include Aws::Structure
6021
+ end
6022
+
6023
+ # @!attribute [rw] job_summaries
6024
+ # One or more job summaries to list.
6025
+ # @return [Array<Types::JobSummary>]
6026
+ #
6027
+ # @!attribute [rw] next_token
6028
+ # The token for the next set of results, or null if there are no
6029
+ # additional results.
6030
+ # @return [String]
6031
+ #
6032
+ class ListBulkImportJobsResponse < Struct.new(
6033
+ :job_summaries,
6034
+ :next_token)
6035
+ SENSITIVE = []
6036
+ include Aws::Structure
6037
+ end
6038
+
4834
6039
  # @note When making an API call, you may pass ListDashboardsRequest
4835
6040
  # data as a hash:
4836
6041
  #
@@ -5884,7 +7089,7 @@ module Aws::IoTSiteWise
5884
7089
  # hot tier. The hot tier is a service-managed database.
5885
7090
  #
5886
7091
  # * `MULTI_LAYER_STORAGE` – IoT SiteWise saves your data in both the
5887
- # cold tier and the cold tier. The cold tier is a customer-managed
7092
+ # cold tier and the hot tier. The cold tier is a customer-managed
5888
7093
  # Amazon S3 bucket.
5889
7094
  # @return [String]
5890
7095
  #
@@ -5938,7 +7143,7 @@ module Aws::IoTSiteWise
5938
7143
  # hot tier. The hot tier is a service-managed database.
5939
7144
  #
5940
7145
  # * `MULTI_LAYER_STORAGE` – IoT SiteWise saves your data in both the
5941
- # cold tier and the cold tier. The cold tier is a customer-managed
7146
+ # cold tier and the hot tier. The cold tier is a customer-managed
5942
7147
  # Amazon S3 bucket.
5943
7148
  # @return [String]
5944
7149
  #
@@ -6863,6 +8068,7 @@ module Aws::IoTSiteWise
6863
8068
  # asset_id: "ID", # required
6864
8069
  # asset_name: "Name", # required
6865
8070
  # client_token: "ClientToken",
8071
+ # asset_description: "Description",
6866
8072
  # }
6867
8073
  #
6868
8074
  # @!attribute [rw] asset_id
@@ -6882,10 +8088,15 @@ module Aws::IoTSiteWise
6882
8088
  # not need to pass this option.
6883
8089
  # @return [String]
6884
8090
  #
8091
+ # @!attribute [rw] asset_description
8092
+ # A description for the asset.
8093
+ # @return [String]
8094
+ #
6885
8095
  class UpdateAssetRequest < Struct.new(
6886
8096
  :asset_id,
6887
8097
  :asset_name,
6888
- :client_token)
8098
+ :client_token,
8099
+ :asset_description)
6889
8100
  SENSITIVE = []
6890
8101
  include Aws::Structure
6891
8102
  end