@aws-sdk/client-iotsitewise 3.201.0 → 3.202.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.
Files changed (49) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist-cjs/IoTSiteWise.js +30 -0
  3. package/dist-cjs/commands/ListAssetModelPropertiesCommand.js +46 -0
  4. package/dist-cjs/commands/ListAssetPropertiesCommand.js +46 -0
  5. package/dist-cjs/commands/index.js +2 -0
  6. package/dist-cjs/models/models_0.js +40 -6
  7. package/dist-cjs/pagination/ListAssetModelPropertiesPaginator.js +36 -0
  8. package/dist-cjs/pagination/ListAssetPropertiesPaginator.js +36 -0
  9. package/dist-cjs/pagination/index.js +2 -0
  10. package/dist-cjs/protocols/Aws_restJson1.js +211 -3
  11. package/dist-es/IoTSiteWise.js +30 -0
  12. package/dist-es/commands/ListAssetModelPropertiesCommand.js +42 -0
  13. package/dist-es/commands/ListAssetPropertiesCommand.js +42 -0
  14. package/dist-es/commands/index.js +2 -0
  15. package/dist-es/models/models_0.js +28 -0
  16. package/dist-es/pagination/ListAssetModelPropertiesPaginator.js +32 -0
  17. package/dist-es/pagination/ListAssetPropertiesPaginator.js +32 -0
  18. package/dist-es/pagination/index.js +2 -0
  19. package/dist-es/protocols/Aws_restJson1.js +204 -0
  20. package/dist-types/IoTSiteWise.d.ts +35 -21
  21. package/dist-types/IoTSiteWiseClient.d.ts +4 -2
  22. package/dist-types/commands/BatchGetAssetPropertyAggregatesCommand.d.ts +3 -3
  23. package/dist-types/commands/BatchGetAssetPropertyValueCommand.d.ts +1 -1
  24. package/dist-types/commands/BatchGetAssetPropertyValueHistoryCommand.d.ts +2 -2
  25. package/dist-types/commands/CreateAccessPolicyCommand.d.ts +1 -1
  26. package/dist-types/commands/CreateBulkImportJobCommand.d.ts +4 -6
  27. package/dist-types/commands/CreatePortalCommand.d.ts +1 -1
  28. package/dist-types/commands/DescribeBulkImportJobCommand.d.ts +2 -3
  29. package/dist-types/commands/ListAccessPoliciesCommand.d.ts +1 -1
  30. package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +39 -0
  31. package/dist-types/commands/ListAssetPropertiesCommand.d.ts +39 -0
  32. package/dist-types/commands/ListBulkImportJobsCommand.d.ts +2 -3
  33. package/dist-types/commands/index.d.ts +2 -0
  34. package/dist-types/models/models_0.d.ts +285 -72
  35. package/dist-types/pagination/ListAssetModelPropertiesPaginator.d.ts +4 -0
  36. package/dist-types/pagination/ListAssetPropertiesPaginator.d.ts +4 -0
  37. package/dist-types/pagination/index.d.ts +2 -0
  38. package/dist-types/protocols/Aws_restJson1.d.ts +6 -0
  39. package/dist-types/ts3.4/IoTSiteWise.d.ts +34 -0
  40. package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +12 -0
  41. package/dist-types/ts3.4/commands/ListAssetModelPropertiesCommand.d.ts +41 -0
  42. package/dist-types/ts3.4/commands/ListAssetPropertiesCommand.d.ts +38 -0
  43. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  44. package/dist-types/ts3.4/models/models_0.d.ts +67 -0
  45. package/dist-types/ts3.4/pagination/ListAssetModelPropertiesPaginator.d.ts +11 -0
  46. package/dist-types/ts3.4/pagination/ListAssetPropertiesPaginator.d.ts +11 -0
  47. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  48. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
  49. package/package.json +4 -4
@@ -5,7 +5,7 @@ import { IoTSiteWiseServiceException as __BaseException } from "./IoTSiteWiseSer
5
5
  */
6
6
  export interface GroupIdentity {
7
7
  /**
8
- * <p>The Amazon Web Services SSO ID of the group.</p>
8
+ * <p>The IAM Identity Center ID of the group.</p>
9
9
  */
10
10
  id: string | undefined;
11
11
  }
@@ -40,24 +40,24 @@ export interface IAMUserIdentity {
40
40
  */
41
41
  export interface UserIdentity {
42
42
  /**
43
- * <p>The Amazon Web Services SSO ID of the user.</p>
43
+ * <p>The IAM Identity Center ID of the user.</p>
44
44
  */
45
45
  id: string | undefined;
46
46
  }
47
47
  /**
48
48
  * <p>Contains an identity that can access an IoT SiteWise Monitor resource.</p>
49
49
  * <note>
50
- * <p>Currently, you can't use Amazon Web Services APIs to retrieve Amazon Web Services SSO identity IDs. You can find the
51
- * Amazon Web Services SSO identity IDs in the URL of user and group pages in the <a href="https://console.aws.amazon.com/singlesignon">Amazon Web Services SSO console</a>.</p>
50
+ * <p>Currently, you can't use Amazon Web Services APIs to retrieve IAM Identity Center identity IDs. You can find the
51
+ * IAM Identity Center identity IDs in the URL of user and group pages in the <a href="https://console.aws.amazon.com/singlesignon">IAM Identity Center console</a>.</p>
52
52
  * </note>
53
53
  */
54
54
  export interface Identity {
55
55
  /**
56
- * <p>An Amazon Web Services SSO user identity.</p>
56
+ * <p>An IAM Identity Center user identity.</p>
57
57
  */
58
58
  user?: UserIdentity;
59
59
  /**
60
- * <p>An Amazon Web Services SSO group identity.</p>
60
+ * <p>An IAM Identity Center group identity.</p>
61
61
  */
62
62
  group?: GroupIdentity;
63
63
  /**
@@ -114,7 +114,7 @@ export interface AccessPolicySummary {
114
114
  */
115
115
  id: string | undefined;
116
116
  /**
117
- * <p>The identity (an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user).</p>
117
+ * <p>The identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user).</p>
118
118
  */
119
119
  identity: Identity | undefined;
120
120
  /**
@@ -297,6 +297,12 @@ export interface AssetCompositeModel {
297
297
  * <p>The asset properties that this composite model defines.</p>
298
298
  */
299
299
  properties: AssetProperty[] | undefined;
300
+ /**
301
+ * <p>
302
+ * The ID of the asset composite model.
303
+ * </p>
304
+ */
305
+ id?: string;
300
306
  }
301
307
  export declare enum AssetErrorCode {
302
308
  INTERNAL_FAILURE = "INTERNAL_FAILURE"
@@ -697,6 +703,12 @@ export interface AssetModelCompositeModel {
697
703
  * <p>The asset property definitions for this composite model.</p>
698
704
  */
699
705
  properties?: AssetModelProperty[];
706
+ /**
707
+ * <p>
708
+ * The ID of the asset model composite model.
709
+ * </p>
710
+ */
711
+ id?: string;
700
712
  }
701
713
  /**
702
714
  * <p>Contains an asset model property definition. This property definition is applied to all
@@ -790,6 +802,43 @@ export interface AssetModelHierarchyDefinition {
790
802
  */
791
803
  childAssetModelId: string | undefined;
792
804
  }
805
+ /**
806
+ * <p>Contains a summary of a property associated with a model.</p>
807
+ */
808
+ export interface AssetModelPropertySummary {
809
+ /**
810
+ * <p>The ID of the property.</p>
811
+ */
812
+ id?: string;
813
+ /**
814
+ * <p>The name of the property.</p>
815
+ */
816
+ name: string | undefined;
817
+ /**
818
+ * <p>The data type of the property.</p>
819
+ */
820
+ dataType: PropertyDataType | string | undefined;
821
+ /**
822
+ * <p>The data type of the structure for this property. This parameter exists on properties that
823
+ * have the <code>STRUCT</code> data type.</p>
824
+ */
825
+ dataTypeSpec?: string;
826
+ /**
827
+ * <p>The unit (such as <code>Newtons</code> or <code>RPM</code>) of the property.</p>
828
+ */
829
+ unit?: string;
830
+ /**
831
+ * <p>Contains a property type, which can be one of <code>attribute</code>,
832
+ * <code>measurement</code>, <code>metric</code>, or <code>transform</code>.</p>
833
+ */
834
+ type: PropertyType | undefined;
835
+ /**
836
+ * <p>
837
+ * The ID of the composite model that contains the asset model property.
838
+ * </p>
839
+ */
840
+ assetModelCompositeModelId?: string;
841
+ }
793
842
  export declare enum AssetModelState {
794
843
  ACTIVE = "ACTIVE",
795
844
  CREATING = "CREATING",
@@ -886,6 +935,39 @@ export interface AssetModelSummary {
886
935
  */
887
936
  status: AssetModelStatus | undefined;
888
937
  }
938
+ /**
939
+ * <p>Contains a summary of a property associated with an asset.</p>
940
+ */
941
+ export interface AssetPropertySummary {
942
+ /**
943
+ * <p>The ID of the property.</p>
944
+ */
945
+ id?: string;
946
+ /**
947
+ * <p>The alias that identifies the property, such as an OPC-UA server data stream path
948
+ * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
949
+ * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
950
+ * <i>IoT SiteWise User Guide</i>.</p>
951
+ */
952
+ alias?: string;
953
+ /**
954
+ * <p>
955
+ * The unit of measure (such as Newtons or RPM) of the asset property.
956
+ * </p>
957
+ */
958
+ unit?: string;
959
+ /**
960
+ * <p>Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value
961
+ * updates to a unique MQTT topic. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html">Interacting with other services</a> in the <i>IoT SiteWise User Guide</i>.</p>
962
+ */
963
+ notification?: PropertyNotification;
964
+ /**
965
+ * <p>
966
+ * The ID of the composite model that contains the asset property.
967
+ * </p>
968
+ */
969
+ assetCompositeModelId?: string;
970
+ }
889
971
  /**
890
972
  * <p>Contains a timestamp with optional nanosecond granularity.</p>
891
973
  */
@@ -1264,7 +1346,7 @@ export declare enum TimeOrdering {
1264
1346
  }
1265
1347
  /**
1266
1348
  * <p>Contains information for an asset property aggregate entry that is associated with the
1267
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
1349
+ * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
1268
1350
  * <p>To identify an asset property, you must specify one of the following:</p>
1269
1351
  * <ul>
1270
1352
  * <li>
@@ -1325,8 +1407,8 @@ export interface BatchGetAssetPropertyAggregatesEntry {
1325
1407
  }
1326
1408
  export interface BatchGetAssetPropertyAggregatesRequest {
1327
1409
  /**
1328
- * <p>The list of asset property aggregate entries for the batch get request.
1329
- * You can specify up to 16 entries per request.</p>
1410
+ * <p>The list of asset property aggregate entries for the batch get request. You can specify up
1411
+ * to 16 entries per request.</p>
1330
1412
  */
1331
1413
  entries: BatchGetAssetPropertyAggregatesEntry[] | undefined;
1332
1414
  /**
@@ -1334,14 +1416,15 @@ export interface BatchGetAssetPropertyAggregatesRequest {
1334
1416
  */
1335
1417
  nextToken?: string;
1336
1418
  /**
1337
- * <p>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.</p>
1419
+ * <p>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs
1420
+ * first.</p>
1338
1421
  * <ul>
1339
1422
  * <li>
1340
1423
  * <p>The size of the result set is less than 1 MB.</p>
1341
1424
  * </li>
1342
1425
  * <li>
1343
- * <p>The number of data points in the result set is less than the value of <code>maxResults</code>.
1344
- * The maximum value of <code>maxResults</code> is 4000.</p>
1426
+ * <p>The number of data points in the result set is less than the value of
1427
+ * <code>maxResults</code>. The maximum value of <code>maxResults</code> is 4000.</p>
1345
1428
  * </li>
1346
1429
  * </ul>
1347
1430
  */
@@ -1353,8 +1436,8 @@ export declare enum BatchGetAssetPropertyAggregatesErrorCode {
1353
1436
  ResourceNotFoundException = "ResourceNotFoundException"
1354
1437
  }
1355
1438
  /**
1356
- * <p>Contains error information for an asset property aggregate entry that is associated with the
1357
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
1439
+ * <p>Contains error information for an asset property aggregate entry that is associated with
1440
+ * the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
1358
1441
  */
1359
1442
  export interface BatchGetAssetPropertyAggregatesErrorEntry {
1360
1443
  /**
@@ -1375,8 +1458,8 @@ export declare enum BatchEntryCompletionStatus {
1375
1458
  SUCCESS = "SUCCESS"
1376
1459
  }
1377
1460
  /**
1378
- * <p>Contains the error code and the timestamp for an asset property aggregate entry that is associated with the
1379
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
1461
+ * <p>Contains the error code and the timestamp for an asset property aggregate entry that is
1462
+ * associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
1380
1463
  */
1381
1464
  export interface BatchGetAssetPropertyAggregatesErrorInfo {
1382
1465
  /**
@@ -1389,8 +1472,7 @@ export interface BatchGetAssetPropertyAggregatesErrorInfo {
1389
1472
  errorTimestamp: Date | undefined;
1390
1473
  }
1391
1474
  /**
1392
- * <p>Contains information for an entry that has been processed by the previous
1393
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> request.</p>
1475
+ * <p>Contains information for an entry that has been processed by the previous <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> request.</p>
1394
1476
  */
1395
1477
  export interface BatchGetAssetPropertyAggregatesSkippedEntry {
1396
1478
  /**
@@ -1398,8 +1480,7 @@ export interface BatchGetAssetPropertyAggregatesSkippedEntry {
1398
1480
  */
1399
1481
  entryId: string | undefined;
1400
1482
  /**
1401
- * <p>The completion status of each entry that is associated with the
1402
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
1483
+ * <p>The completion status of each entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
1403
1484
  */
1404
1485
  completionStatus: BatchEntryCompletionStatus | string | undefined;
1405
1486
  /**
@@ -1408,8 +1489,7 @@ export interface BatchGetAssetPropertyAggregatesSkippedEntry {
1408
1489
  errorInfo?: BatchGetAssetPropertyAggregatesErrorInfo;
1409
1490
  }
1410
1491
  /**
1411
- * <p>Contains success information for an entry that is associated with the
1412
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
1492
+ * <p>Contains success information for an entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
1413
1493
  */
1414
1494
  export interface BatchGetAssetPropertyAggregatesSuccessEntry {
1415
1495
  /**
@@ -1417,7 +1497,8 @@ export interface BatchGetAssetPropertyAggregatesSuccessEntry {
1417
1497
  */
1418
1498
  entryId: string | undefined;
1419
1499
  /**
1420
- * <p>The requested aggregated asset property values (for example, average, minimum, and maximum).</p>
1500
+ * <p>The requested aggregated asset property values (for example, average, minimum, and
1501
+ * maximum).</p>
1421
1502
  */
1422
1503
  aggregatedValues: AggregatedValue[] | undefined;
1423
1504
  }
@@ -1455,8 +1536,7 @@ export declare class ServiceUnavailableException extends __BaseException {
1455
1536
  constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
1456
1537
  }
1457
1538
  /**
1458
- * <p>Contains information for an asset property value entry that is associated with the
1459
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> API.</p>
1539
+ * <p>Contains information for an asset property value entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> API.</p>
1460
1540
  * <p>To identify an asset property, you must specify one of the following:</p>
1461
1541
  * <ul>
1462
1542
  * <li>
@@ -1491,8 +1571,8 @@ export interface BatchGetAssetPropertyValueEntry {
1491
1571
  }
1492
1572
  export interface BatchGetAssetPropertyValueRequest {
1493
1573
  /**
1494
- * <p>The list of asset property value entries for the batch get request.
1495
- * You can specify up to 16 entries per request.</p>
1574
+ * <p>The list of asset property value entries for the batch get request. You can specify up to
1575
+ * 16 entries per request.</p>
1496
1576
  */
1497
1577
  entries: BatchGetAssetPropertyValueEntry[] | undefined;
1498
1578
  /**
@@ -1507,7 +1587,7 @@ export declare enum BatchGetAssetPropertyValueErrorCode {
1507
1587
  }
1508
1588
  /**
1509
1589
  * <p>Contains error information for an asset property value entry that is associated with the
1510
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> API.</p>
1590
+ * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> API.</p>
1511
1591
  */
1512
1592
  export interface BatchGetAssetPropertyValueErrorEntry {
1513
1593
  /**
@@ -1537,8 +1617,7 @@ export interface BatchGetAssetPropertyValueErrorInfo {
1537
1617
  errorTimestamp: Date | undefined;
1538
1618
  }
1539
1619
  /**
1540
- * <p>Contains information for an entry that has been processed by the previous
1541
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> request.</p>
1620
+ * <p>Contains information for an entry that has been processed by the previous <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> request.</p>
1542
1621
  */
1543
1622
  export interface BatchGetAssetPropertyValueSkippedEntry {
1544
1623
  /**
@@ -1546,8 +1625,7 @@ export interface BatchGetAssetPropertyValueSkippedEntry {
1546
1625
  */
1547
1626
  entryId: string | undefined;
1548
1627
  /**
1549
- * <p>The completion status of each entry that is associated with the
1550
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> request.</p>
1628
+ * <p>The completion status of each entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> request.</p>
1551
1629
  */
1552
1630
  completionStatus: BatchEntryCompletionStatus | string | undefined;
1553
1631
  /**
@@ -1556,8 +1634,7 @@ export interface BatchGetAssetPropertyValueSkippedEntry {
1556
1634
  errorInfo?: BatchGetAssetPropertyValueErrorInfo;
1557
1635
  }
1558
1636
  /**
1559
- * <p>Contains success information for an entry that is associated with the
1560
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> API.</p>
1637
+ * <p>Contains success information for an entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> API.</p>
1561
1638
  */
1562
1639
  export interface BatchGetAssetPropertyValueSuccessEntry {
1563
1640
  /**
@@ -1592,8 +1669,8 @@ export interface BatchGetAssetPropertyValueResponse {
1592
1669
  nextToken?: string;
1593
1670
  }
1594
1671
  /**
1595
- * <p>Contains information for an asset property historical value entry that is associated with the
1596
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValueHistory</a> API.</p>
1672
+ * <p>Contains information for an asset property historical value entry that is associated with
1673
+ * the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValueHistory</a> API.</p>
1597
1674
  * <p>To identify an asset property, you must specify one of the following:</p>
1598
1675
  * <ul>
1599
1676
  * <li>
@@ -1646,8 +1723,8 @@ export interface BatchGetAssetPropertyValueHistoryEntry {
1646
1723
  }
1647
1724
  export interface BatchGetAssetPropertyValueHistoryRequest {
1648
1725
  /**
1649
- * <p>The list of asset property historical value entries for the batch get request.
1650
- * You can specify up to 16 entries per request.</p>
1726
+ * <p>The list of asset property historical value entries for the batch get request. You can
1727
+ * specify up to 16 entries per request.</p>
1651
1728
  */
1652
1729
  entries: BatchGetAssetPropertyValueHistoryEntry[] | undefined;
1653
1730
  /**
@@ -1655,14 +1732,15 @@ export interface BatchGetAssetPropertyValueHistoryRequest {
1655
1732
  */
1656
1733
  nextToken?: string;
1657
1734
  /**
1658
- * <p>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.</p>
1735
+ * <p>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs
1736
+ * first.</p>
1659
1737
  * <ul>
1660
1738
  * <li>
1661
1739
  * <p>The size of the result set is less than 1 MB.</p>
1662
1740
  * </li>
1663
1741
  * <li>
1664
- * <p>The number of data points in the result set is less than the value of <code>maxResults</code>.
1665
- * The maximum value of <code>maxResults</code> is 4000.</p>
1742
+ * <p>The number of data points in the result set is less than the value of
1743
+ * <code>maxResults</code>. The maximum value of <code>maxResults</code> is 4000.</p>
1666
1744
  * </li>
1667
1745
  * </ul>
1668
1746
  */
@@ -1705,8 +1783,7 @@ export interface BatchGetAssetPropertyValueHistoryErrorInfo {
1705
1783
  errorTimestamp: Date | undefined;
1706
1784
  }
1707
1785
  /**
1708
- * <p>Contains information for an entry that has been processed by the previous
1709
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValueHistory</a> request.</p>
1786
+ * <p>Contains information for an entry that has been processed by the previous <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValueHistory</a> request.</p>
1710
1787
  */
1711
1788
  export interface BatchGetAssetPropertyValueHistorySkippedEntry {
1712
1789
  /**
@@ -1714,8 +1791,7 @@ export interface BatchGetAssetPropertyValueHistorySkippedEntry {
1714
1791
  */
1715
1792
  entryId: string | undefined;
1716
1793
  /**
1717
- * <p>The completion status of each entry that is associated with the
1718
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html">BatchGetAssetPropertyValueHistory</a> API.</p>
1794
+ * <p>The completion status of each entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html">BatchGetAssetPropertyValueHistory</a> API.</p>
1719
1795
  */
1720
1796
  completionStatus: BatchEntryCompletionStatus | string | undefined;
1721
1797
  /**
@@ -1724,8 +1800,7 @@ export interface BatchGetAssetPropertyValueHistorySkippedEntry {
1724
1800
  errorInfo?: BatchGetAssetPropertyValueHistoryErrorInfo;
1725
1801
  }
1726
1802
  /**
1727
- * <p>Contains success information for an entry that is associated with the
1728
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValueHistory</a> API.</p>
1803
+ * <p>Contains success information for an entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValueHistory</a> API.</p>
1729
1804
  */
1730
1805
  export interface BatchGetAssetPropertyValueHistorySuccessEntry {
1731
1806
  /**
@@ -1849,7 +1924,7 @@ export interface BatchPutAssetPropertyValueResponse {
1849
1924
  }
1850
1925
  export interface CreateAccessPolicyRequest {
1851
1926
  /**
1852
- * <p>The identity for this access policy. Choose an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user.</p>
1927
+ * <p>The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.</p>
1853
1928
  */
1854
1929
  accessPolicyIdentity: Identity | undefined;
1855
1930
  /**
@@ -1992,15 +2067,15 @@ export interface CreateAssetModelResponse {
1992
2067
  */
1993
2068
  export interface ErrorReportLocation {
1994
2069
  /**
1995
- * <p>The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent.</p>
2070
+ * <p>The name of the Amazon S3 bucket to which errors associated with the bulk import job are
2071
+ * sent.</p>
1996
2072
  */
1997
2073
  bucket: string | undefined;
1998
2074
  /**
1999
- * <p>Amazon S3 uses the prefix as a folder name to organize data in the bucket.
2000
- * Each Amazon S3 object has a key that is its unique identifier in the bucket.
2001
- * Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
2002
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a>
2003
- * in the <i>Amazon Simple Storage Service User Guide</i>.</p>
2075
+ * <p>Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each Amazon S3 object has
2076
+ * a key that is its unique identifier in the bucket. Each object in a bucket has exactly one
2077
+ * key. The prefix must end with a forward slash (/). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects
2078
+ * using prefixes</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
2004
2079
  */
2005
2080
  prefix: string | undefined;
2006
2081
  }
@@ -2013,12 +2088,13 @@ export interface File {
2013
2088
  */
2014
2089
  bucket: string | undefined;
2015
2090
  /**
2016
- * <p>The key of the Amazon S3 object that contains your data. Each object has a key that is a
2017
- * unique identifier. Each object has exactly one key.</p>
2091
+ * <p>The key of the Amazon S3 object that contains your data. Each object has a key that is a unique
2092
+ * identifier. Each object has exactly one key.</p>
2018
2093
  */
2019
2094
  key: string | undefined;
2020
2095
  /**
2021
- * <p>The version ID to identify a specific version of the Amazon S3 object that contains your data.</p>
2096
+ * <p>The version ID to identify a specific version of the Amazon S3 object that contains your
2097
+ * data.</p>
2022
2098
  */
2023
2099
  versionId?: string;
2024
2100
  }
@@ -2299,9 +2375,9 @@ export interface CreatePortalRequest {
2299
2375
  * <ul>
2300
2376
  * <li>
2301
2377
  * <p>
2302
- * <code>SSO</code> – The portal uses Amazon Web Services Single Sign On to authenticate users and manage
2303
- * user permissions. Before you can create a portal that uses Amazon Web Services SSO, you must enable Amazon Web Services SSO.
2304
- * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso">Enabling Amazon Web Services SSO</a> in the
2378
+ * <code>SSO</code> – The portal uses IAM Identity Center (successor to Single Sign-On) to authenticate users and manage
2379
+ * user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center.
2380
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso">Enabling IAM Identity Center</a> in the
2305
2381
  * <i>IoT SiteWise User Guide</i>. This option is only available in Amazon Web Services Regions other than
2306
2382
  * the China Regions.</p>
2307
2383
  * </li>
@@ -2384,7 +2460,7 @@ export interface CreatePortalResponse {
2384
2460
  portalArn: string | undefined;
2385
2461
  /**
2386
2462
  * <p>The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that
2387
- * use Amazon Web Services SSO for authentication. For portals that use IAM for authentication, you must use the
2463
+ * use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the
2388
2464
  * IoT SiteWise console to get a URL that you can use to access the portal.</p>
2389
2465
  */
2390
2466
  portalStartUrl: string | undefined;
@@ -2394,7 +2470,7 @@ export interface CreatePortalResponse {
2394
2470
  */
2395
2471
  portalStatus: PortalStatus | undefined;
2396
2472
  /**
2397
- * <p>The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.</p>
2473
+ * <p>The associated IAM Identity Center application ID, if the portal uses IAM Identity Center.</p>
2398
2474
  */
2399
2475
  ssoApplicationId: string | undefined;
2400
2476
  }
@@ -2565,7 +2641,7 @@ export interface DescribeAccessPolicyResponse {
2565
2641
  */
2566
2642
  accessPolicyArn: string | undefined;
2567
2643
  /**
2568
- * <p>The identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user) to which this access policy
2644
+ * <p>The identity (IAM Identity Center user, IAM Identity Center group, or IAM user) to which this access policy
2569
2645
  * applies.</p>
2570
2646
  */
2571
2647
  accessPolicyIdentity: Identity | undefined;
@@ -2593,6 +2669,12 @@ export interface DescribeAssetRequest {
2593
2669
  * <p>The ID of the asset.</p>
2594
2670
  */
2595
2671
  assetId: string | undefined;
2672
+ /**
2673
+ * <p>
2674
+ * Whether or not to exclude asset properties from the response.
2675
+ * </p>
2676
+ */
2677
+ excludeProperties?: boolean;
2596
2678
  }
2597
2679
  export interface DescribeAssetResponse {
2598
2680
  /**
@@ -2650,6 +2732,12 @@ export interface DescribeAssetModelRequest {
2650
2732
  * <p>The ID of the asset model.</p>
2651
2733
  */
2652
2734
  assetModelId: string | undefined;
2735
+ /**
2736
+ * <p>
2737
+ * Whether or not to exclude asset model properties from the response.
2738
+ * </p>
2739
+ */
2740
+ excludeProperties?: boolean;
2653
2741
  }
2654
2742
  export interface DescribeAssetModelResponse {
2655
2743
  /**
@@ -2763,6 +2851,12 @@ export interface CompositeModelProperty {
2763
2851
  * <p>Contains asset property information.</p>
2764
2852
  */
2765
2853
  assetProperty: Property | undefined;
2854
+ /**
2855
+ * <p>
2856
+ * The ID of the composite model that contains the property.
2857
+ * </p>
2858
+ */
2859
+ id?: string;
2766
2860
  }
2767
2861
  export interface DescribeAssetPropertyResponse {
2768
2862
  /**
@@ -3148,13 +3242,13 @@ export interface DescribePortalResponse {
3148
3242
  */
3149
3243
  portalDescription?: string;
3150
3244
  /**
3151
- * <p>The Amazon Web Services SSO application generated client ID (used with Amazon Web Services SSO APIs). IoT SiteWise includes
3152
- * <code>portalClientId</code> for only portals that use Amazon Web Services SSO to authenticate users.</p>
3245
+ * <p>The IAM Identity Center application generated client ID (used with IAM Identity Center APIs). IoT SiteWise includes
3246
+ * <code>portalClientId</code> for only portals that use IAM Identity Center to authenticate users.</p>
3153
3247
  */
3154
3248
  portalClientId: string | undefined;
3155
3249
  /**
3156
3250
  * <p>The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that
3157
- * use Amazon Web Services SSO for authentication. For portals that use IAM for authentication, you must use the
3251
+ * use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the
3158
3252
  * IoT SiteWise console to get a URL that you can use to access the portal.</p>
3159
3253
  */
3160
3254
  portalStartUrl: string | undefined;
@@ -3721,7 +3815,7 @@ export declare enum ResourceType {
3721
3815
  }
3722
3816
  export interface ListAccessPoliciesRequest {
3723
3817
  /**
3724
- * <p>The type of identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user). This parameter is required
3818
+ * <p>The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required
3725
3819
  * if you specify <code>identityId</code>.</p>
3726
3820
  */
3727
3821
  identityType?: IdentityType | string;
@@ -3766,6 +3860,53 @@ export interface ListAccessPoliciesResponse {
3766
3860
  */
3767
3861
  nextToken?: string;
3768
3862
  }
3863
+ export declare enum ListAssetModelPropertiesFilter {
3864
+ ALL = "ALL",
3865
+ BASE = "BASE"
3866
+ }
3867
+ export interface ListAssetModelPropertiesRequest {
3868
+ /**
3869
+ * <p>The ID of the asset model.</p>
3870
+ */
3871
+ assetModelId: string | undefined;
3872
+ /**
3873
+ * <p>The token to be used for the next set of paginated results.</p>
3874
+ */
3875
+ nextToken?: string;
3876
+ /**
3877
+ * <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
3878
+ */
3879
+ maxResults?: number;
3880
+ /**
3881
+ * <p> Filters the requested list of asset model properties. You can choose one of the following
3882
+ * options:</p>
3883
+ * <ul>
3884
+ * <li>
3885
+ * <p>
3886
+ * <code>ALL</code> – The list includes all asset model properties for a given asset
3887
+ * model ID. </p>
3888
+ * </li>
3889
+ * <li>
3890
+ * <p>
3891
+ * <code>BASE</code> – The list includes only base asset model properties for a given
3892
+ * asset model ID. </p>
3893
+ * </li>
3894
+ * </ul>
3895
+ * <p>Default: <code>BASE</code>
3896
+ * </p>
3897
+ */
3898
+ filter?: ListAssetModelPropertiesFilter | string;
3899
+ }
3900
+ export interface ListAssetModelPropertiesResponse {
3901
+ /**
3902
+ * <p>A list that summarizes the properties associated with the specified asset model.</p>
3903
+ */
3904
+ assetModelPropertySummaries: AssetModelPropertySummary[] | undefined;
3905
+ /**
3906
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
3907
+ */
3908
+ nextToken?: string;
3909
+ }
3769
3910
  export interface ListAssetModelsRequest {
3770
3911
  /**
3771
3912
  * <p>The token to be used for the next set of paginated results.</p>
@@ -3787,6 +3928,53 @@ export interface ListAssetModelsResponse {
3787
3928
  */
3788
3929
  nextToken?: string;
3789
3930
  }
3931
+ export declare enum ListAssetPropertiesFilter {
3932
+ ALL = "ALL",
3933
+ BASE = "BASE"
3934
+ }
3935
+ export interface ListAssetPropertiesRequest {
3936
+ /**
3937
+ * <p>The ID of the asset.</p>
3938
+ */
3939
+ assetId: string | undefined;
3940
+ /**
3941
+ * <p>The token to be used for the next set of paginated results.</p>
3942
+ */
3943
+ nextToken?: string;
3944
+ /**
3945
+ * <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
3946
+ */
3947
+ maxResults?: number;
3948
+ /**
3949
+ * <p> Filters the requested list of asset properties. You can choose one of the following
3950
+ * options:</p>
3951
+ * <ul>
3952
+ * <li>
3953
+ * <p>
3954
+ * <code>ALL</code> – The list includes all asset properties for a given asset
3955
+ * model ID. </p>
3956
+ * </li>
3957
+ * <li>
3958
+ * <p>
3959
+ * <code>BASE</code> – The list includes only base asset properties for a given
3960
+ * asset model ID. </p>
3961
+ * </li>
3962
+ * </ul>
3963
+ * <p>Default: <code>BASE</code>
3964
+ * </p>
3965
+ */
3966
+ filter?: ListAssetPropertiesFilter | string;
3967
+ }
3968
+ export interface ListAssetPropertiesResponse {
3969
+ /**
3970
+ * <p>A list that summarizes the properties associated with the specified asset.</p>
3971
+ */
3972
+ assetPropertySummaries: AssetPropertySummary[] | undefined;
3973
+ /**
3974
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
3975
+ */
3976
+ nextToken?: string;
3977
+ }
3790
3978
  export declare enum TraversalType {
3791
3979
  PATH_TO_ROOT = "PATH_TO_ROOT"
3792
3980
  }
@@ -4140,7 +4328,7 @@ export interface PortalSummary {
4140
4328
  description?: string;
4141
4329
  /**
4142
4330
  * <p>The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that
4143
- * use Amazon Web Services SSO for authentication. For portals that use IAM for authentication, you must use the
4331
+ * use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the
4144
4332
  * IoT SiteWise console to get a URL that you can use to access the portal.</p>
4145
4333
  */
4146
4334
  startUrl: string | undefined;
@@ -4548,7 +4736,7 @@ export interface UpdateAccessPolicyRequest {
4548
4736
  */
4549
4737
  accessPolicyId: string | undefined;
4550
4738
  /**
4551
- * <p>The identity for this access policy. Choose an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user.</p>
4739
+ * <p>The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.</p>
4552
4740
  */
4553
4741
  accessPolicyIdentity: Identity | undefined;
4554
4742
  /**
@@ -4667,8 +4855,9 @@ export interface UpdateAssetPropertyRequest {
4667
4855
  */
4668
4856
  clientToken?: string;
4669
4857
  /**
4670
- * <p>The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the
4671
- * value of the <code>assetModelProperty</code> in the asset model.</p>
4858
+ * <p>The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a
4859
+ * value for this parameter, the service uses the value of the <code>assetModelProperty</code> in
4860
+ * the asset model.</p>
4672
4861
  */
4673
4862
  propertyUnit?: string;
4674
4863
  }
@@ -4998,6 +5187,10 @@ export declare const AssetModelHierarchyFilterSensitiveLog: (obj: AssetModelHier
4998
5187
  * @internal
4999
5188
  */
5000
5189
  export declare const AssetModelHierarchyDefinitionFilterSensitiveLog: (obj: AssetModelHierarchyDefinition) => any;
5190
+ /**
5191
+ * @internal
5192
+ */
5193
+ export declare const AssetModelPropertySummaryFilterSensitiveLog: (obj: AssetModelPropertySummary) => any;
5001
5194
  /**
5002
5195
  * @internal
5003
5196
  */
@@ -5014,6 +5207,10 @@ export declare const AssetModelStatusFilterSensitiveLog: (obj: AssetModelStatus)
5014
5207
  * @internal
5015
5208
  */
5016
5209
  export declare const AssetModelSummaryFilterSensitiveLog: (obj: AssetModelSummary) => any;
5210
+ /**
5211
+ * @internal
5212
+ */
5213
+ export declare const AssetPropertySummaryFilterSensitiveLog: (obj: AssetPropertySummary) => any;
5017
5214
  /**
5018
5215
  * @internal
5019
5216
  */
@@ -5538,6 +5735,14 @@ export declare const ListAccessPoliciesRequestFilterSensitiveLog: (obj: ListAcce
5538
5735
  * @internal
5539
5736
  */
5540
5737
  export declare const ListAccessPoliciesResponseFilterSensitiveLog: (obj: ListAccessPoliciesResponse) => any;
5738
+ /**
5739
+ * @internal
5740
+ */
5741
+ export declare const ListAssetModelPropertiesRequestFilterSensitiveLog: (obj: ListAssetModelPropertiesRequest) => any;
5742
+ /**
5743
+ * @internal
5744
+ */
5745
+ export declare const ListAssetModelPropertiesResponseFilterSensitiveLog: (obj: ListAssetModelPropertiesResponse) => any;
5541
5746
  /**
5542
5747
  * @internal
5543
5748
  */
@@ -5546,6 +5751,14 @@ export declare const ListAssetModelsRequestFilterSensitiveLog: (obj: ListAssetMo
5546
5751
  * @internal
5547
5752
  */
5548
5753
  export declare const ListAssetModelsResponseFilterSensitiveLog: (obj: ListAssetModelsResponse) => any;
5754
+ /**
5755
+ * @internal
5756
+ */
5757
+ export declare const ListAssetPropertiesRequestFilterSensitiveLog: (obj: ListAssetPropertiesRequest) => any;
5758
+ /**
5759
+ * @internal
5760
+ */
5761
+ export declare const ListAssetPropertiesResponseFilterSensitiveLog: (obj: ListAssetPropertiesResponse) => any;
5549
5762
  /**
5550
5763
  * @internal
5551
5764
  */