@aws-sdk/client-iotsitewise 3.848.0 → 3.855.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 (113) hide show
  1. package/README.md +80 -0
  2. package/dist-cjs/index.js +749 -35
  3. package/dist-es/IoTSiteWise.js +20 -0
  4. package/dist-es/commands/CreateComputationModelCommand.js +22 -0
  5. package/dist-es/commands/DeleteComputationModelCommand.js +22 -0
  6. package/dist-es/commands/DescribeComputationModelCommand.js +22 -0
  7. package/dist-es/commands/DescribeComputationModelExecutionSummaryCommand.js +22 -0
  8. package/dist-es/commands/DescribeExecutionCommand.js +22 -0
  9. package/dist-es/commands/ListComputationModelDataBindingUsagesCommand.js +22 -0
  10. package/dist-es/commands/ListComputationModelResolveToResourcesCommand.js +22 -0
  11. package/dist-es/commands/ListComputationModelsCommand.js +22 -0
  12. package/dist-es/commands/ListExecutionsCommand.js +22 -0
  13. package/dist-es/commands/UpdateComputationModelCommand.js +22 -0
  14. package/dist-es/commands/index.js +10 -0
  15. package/dist-es/models/models_0.js +15 -27
  16. package/dist-es/models/models_1.js +31 -0
  17. package/dist-es/pagination/ListComputationModelDataBindingUsagesPaginator.js +4 -0
  18. package/dist-es/pagination/ListComputationModelResolveToResourcesPaginator.js +4 -0
  19. package/dist-es/pagination/ListComputationModelsPaginator.js +4 -0
  20. package/dist-es/pagination/ListExecutionsPaginator.js +4 -0
  21. package/dist-es/pagination/index.js +4 -0
  22. package/dist-es/protocols/Aws_restJson1.js +482 -0
  23. package/dist-types/IoTSiteWise.d.ts +71 -0
  24. package/dist-types/IoTSiteWiseClient.d.ts +12 -2
  25. package/dist-types/commands/AssociateAssetsCommand.d.ts +1 -1
  26. package/dist-types/commands/BatchAssociateProjectAssetsCommand.d.ts +1 -1
  27. package/dist-types/commands/BatchPutAssetPropertyValueCommand.d.ts +1 -1
  28. package/dist-types/commands/CreateAccessPolicyCommand.d.ts +1 -1
  29. package/dist-types/commands/CreateAssetCommand.d.ts +3 -3
  30. package/dist-types/commands/CreateAssetModelCommand.d.ts +1 -1
  31. package/dist-types/commands/CreateAssetModelCompositeModelCommand.d.ts +1 -1
  32. package/dist-types/commands/CreateBulkImportJobCommand.d.ts +14 -3
  33. package/dist-types/commands/CreateComputationModelCommand.d.ts +154 -0
  34. package/dist-types/commands/CreateDashboardCommand.d.ts +1 -1
  35. package/dist-types/commands/CreateDatasetCommand.d.ts +1 -1
  36. package/dist-types/commands/CreateGatewayCommand.d.ts +1 -1
  37. package/dist-types/commands/CreatePortalCommand.d.ts +1 -1
  38. package/dist-types/commands/CreateProjectCommand.d.ts +1 -1
  39. package/dist-types/commands/DeleteComputationModelCommand.d.ts +105 -0
  40. package/dist-types/commands/DescribeActionCommand.d.ts +5 -1
  41. package/dist-types/commands/DescribeAssetCommand.d.ts +4 -4
  42. package/dist-types/commands/DescribeAssetCompositeModelCommand.d.ts +1 -1
  43. package/dist-types/commands/DescribeAssetPropertyCommand.d.ts +3 -3
  44. package/dist-types/commands/DescribeComputationModelCommand.d.ts +148 -0
  45. package/dist-types/commands/DescribeComputationModelExecutionSummaryCommand.d.ts +96 -0
  46. package/dist-types/commands/DescribeExecutionCommand.d.ts +109 -0
  47. package/dist-types/commands/DescribeGatewayCapabilityConfigurationCommand.d.ts +18 -5
  48. package/dist-types/commands/DescribeStorageConfigurationCommand.d.ts +1 -1
  49. package/dist-types/commands/ExecuteActionCommand.d.ts +6 -2
  50. package/dist-types/commands/InvokeAssistantCommand.d.ts +1 -1
  51. package/dist-types/commands/ListAccessPoliciesCommand.d.ts +1 -1
  52. package/dist-types/commands/ListActionsCommand.d.ts +8 -2
  53. package/dist-types/commands/ListAssetModelCompositeModelsCommand.d.ts +1 -1
  54. package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +1 -1
  55. package/dist-types/commands/ListAssetModelsCommand.d.ts +1 -1
  56. package/dist-types/commands/ListAssetPropertiesCommand.d.ts +2 -2
  57. package/dist-types/commands/ListAssetRelationshipsCommand.d.ts +1 -1
  58. package/dist-types/commands/ListAssetsCommand.d.ts +3 -4
  59. package/dist-types/commands/ListAssociatedAssetsCommand.d.ts +2 -2
  60. package/dist-types/commands/ListComputationModelDataBindingUsagesCommand.d.ts +126 -0
  61. package/dist-types/commands/ListComputationModelResolveToResourcesCommand.d.ts +97 -0
  62. package/dist-types/commands/ListComputationModelsCommand.d.ts +112 -0
  63. package/dist-types/commands/ListExecutionsCommand.d.ts +114 -0
  64. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  65. package/dist-types/commands/PutDefaultEncryptionConfigurationCommand.d.ts +1 -1
  66. package/dist-types/commands/PutStorageConfigurationCommand.d.ts +1 -1
  67. package/dist-types/commands/TagResourceCommand.d.ts +2 -2
  68. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  69. package/dist-types/commands/UpdateAssetCommand.d.ts +1 -1
  70. package/dist-types/commands/UpdateAssetModelCommand.d.ts +1 -1
  71. package/dist-types/commands/UpdateAssetModelCompositeModelCommand.d.ts +1 -1
  72. package/dist-types/commands/UpdateComputationModelCommand.d.ts +149 -0
  73. package/dist-types/commands/UpdateDatasetCommand.d.ts +1 -1
  74. package/dist-types/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +21 -6
  75. package/dist-types/commands/index.d.ts +10 -0
  76. package/dist-types/models/models_0.d.ts +521 -596
  77. package/dist-types/models/models_1.d.ts +1095 -45
  78. package/dist-types/pagination/ListComputationModelDataBindingUsagesPaginator.d.ts +7 -0
  79. package/dist-types/pagination/ListComputationModelResolveToResourcesPaginator.d.ts +7 -0
  80. package/dist-types/pagination/ListComputationModelsPaginator.d.ts +7 -0
  81. package/dist-types/pagination/ListExecutionsPaginator.d.ts +7 -0
  82. package/dist-types/pagination/index.d.ts +4 -0
  83. package/dist-types/protocols/Aws_restJson1.d.ts +90 -0
  84. package/dist-types/ts3.4/IoTSiteWise.d.ts +189 -0
  85. package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +60 -0
  86. package/dist-types/ts3.4/commands/CreateComputationModelCommand.d.ts +49 -0
  87. package/dist-types/ts3.4/commands/DeleteComputationModelCommand.d.ts +51 -0
  88. package/dist-types/ts3.4/commands/DescribeComputationModelCommand.d.ts +49 -0
  89. package/dist-types/ts3.4/commands/DescribeComputationModelExecutionSummaryCommand.d.ts +51 -0
  90. package/dist-types/ts3.4/commands/DescribeExecutionCommand.d.ts +51 -0
  91. package/dist-types/ts3.4/commands/ListAccessPoliciesCommand.d.ts +1 -1
  92. package/dist-types/ts3.4/commands/ListActionsCommand.d.ts +1 -1
  93. package/dist-types/ts3.4/commands/ListAssetModelCompositeModelsCommand.d.ts +1 -1
  94. package/dist-types/ts3.4/commands/ListAssetModelPropertiesCommand.d.ts +1 -1
  95. package/dist-types/ts3.4/commands/ListAssetModelsCommand.d.ts +1 -1
  96. package/dist-types/ts3.4/commands/ListAssetPropertiesCommand.d.ts +1 -1
  97. package/dist-types/ts3.4/commands/ListAssetRelationshipsCommand.d.ts +1 -1
  98. package/dist-types/ts3.4/commands/ListAssetsCommand.d.ts +1 -2
  99. package/dist-types/ts3.4/commands/ListComputationModelDataBindingUsagesCommand.d.ts +51 -0
  100. package/dist-types/ts3.4/commands/ListComputationModelResolveToResourcesCommand.d.ts +51 -0
  101. package/dist-types/ts3.4/commands/ListComputationModelsCommand.d.ts +51 -0
  102. package/dist-types/ts3.4/commands/ListExecutionsCommand.d.ts +50 -0
  103. package/dist-types/ts3.4/commands/UpdateComputationModelCommand.d.ts +51 -0
  104. package/dist-types/ts3.4/commands/index.d.ts +10 -0
  105. package/dist-types/ts3.4/models/models_0.d.ts +116 -131
  106. package/dist-types/ts3.4/models/models_1.d.ts +279 -1
  107. package/dist-types/ts3.4/pagination/ListComputationModelDataBindingUsagesPaginator.d.ts +11 -0
  108. package/dist-types/ts3.4/pagination/ListComputationModelResolveToResourcesPaginator.d.ts +11 -0
  109. package/dist-types/ts3.4/pagination/ListComputationModelsPaginator.d.ts +11 -0
  110. package/dist-types/ts3.4/pagination/ListExecutionsPaginator.d.ts +11 -0
  111. package/dist-types/ts3.4/pagination/index.d.ts +4 -0
  112. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +120 -0
  113. package/package.json +5 -5
@@ -214,6 +214,17 @@ export interface ActionPayload {
214
214
  */
215
215
  stringValue: string | undefined;
216
216
  }
217
+ /**
218
+ * <p>The detailed resource this execution summary resolves to.</p>
219
+ * @public
220
+ */
221
+ export interface ResolveTo {
222
+ /**
223
+ * <p>The ID of the asset that the resource resolves to.</p>
224
+ * @public
225
+ */
226
+ assetId: string | undefined;
227
+ }
217
228
  /**
218
229
  * <p>The resource the action will be taken on.</p>
219
230
  * @public
@@ -223,7 +234,12 @@ export interface TargetResource {
223
234
  * <p>The ID of the asset, in UUID format.</p>
224
235
  * @public
225
236
  */
226
- assetId: string | undefined;
237
+ assetId?: string | undefined;
238
+ /**
239
+ * <p>The ID of the computation model.</p>
240
+ * @public
241
+ */
242
+ computationModelId?: string | undefined;
227
243
  }
228
244
  /**
229
245
  * <p>Contains the summary of the actions.</p>
@@ -245,6 +261,11 @@ export interface ActionSummary {
245
261
  * @public
246
262
  */
247
263
  targetResource?: TargetResource | undefined;
264
+ /**
265
+ * <p>The detailed resource this action resolves to.</p>
266
+ * @public
267
+ */
268
+ resolveTo?: ResolveTo | undefined;
248
269
  }
249
270
  /**
250
271
  * @public
@@ -354,6 +375,19 @@ export interface Alarms {
354
375
  */
355
376
  notificationLambdaArn?: string | undefined;
356
377
  }
378
+ /**
379
+ * <p>A filter used to match data bindings based on a specific asset.
380
+ * This filter identifies all computation models referencing a particular asset in their data bindings.</p>
381
+ * @public
382
+ */
383
+ export interface AssetBindingValueFilter {
384
+ /**
385
+ * <p>The ID of the asset to filter data bindings by.
386
+ * Only data bindings referencing this specific asset are matched.</p>
387
+ * @public
388
+ */
389
+ assetId: string | undefined;
390
+ }
357
391
  /**
358
392
  * @public
359
393
  * @enum
@@ -424,6 +458,11 @@ export interface AssetProperty {
424
458
  * @public
425
459
  */
426
460
  id: string | undefined;
461
+ /**
462
+ * <p>The external ID of the asset property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
463
+ * @public
464
+ */
465
+ externalId?: string | undefined;
427
466
  /**
428
467
  * <p>The name of the property.</p>
429
468
  * @public
@@ -463,11 +502,6 @@ export interface AssetProperty {
463
502
  * @public
464
503
  */
465
504
  path?: AssetPropertyPathSegment[] | undefined;
466
- /**
467
- * <p>The external ID of the asset property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
468
- * @public
469
- */
470
- externalId?: string | undefined;
471
505
  }
472
506
  /**
473
507
  * <p>Contains information about a composite model in an asset. This object contains the asset's
@@ -617,12 +651,6 @@ export interface AssetHierarchy {
617
651
  * @public
618
652
  */
619
653
  id?: string | undefined;
620
- /**
621
- * <p>The hierarchy name provided in the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html">CreateAssetModel</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>
622
- * API operation.</p>
623
- * @public
624
- */
625
- name: string | undefined;
626
654
  /**
627
655
  * <p>The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you
628
656
  * may assign an external ID if it doesn't already have one. You can't change the external ID of
@@ -630,6 +658,12 @@ export interface AssetHierarchy {
630
658
  * @public
631
659
  */
632
660
  externalId?: string | undefined;
661
+ /**
662
+ * <p>The hierarchy name provided in the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html">CreateAssetModel</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>
663
+ * API operation.</p>
664
+ * @public
665
+ */
666
+ name: string | undefined;
633
667
  }
634
668
  /**
635
669
  * <p>Contains information about a parent asset and a child asset that are related through an
@@ -648,6 +682,19 @@ export interface AssetHierarchyInfo {
648
682
  */
649
683
  childAssetId?: string | undefined;
650
684
  }
685
+ /**
686
+ * <p>A filter used to match data bindings based on a specific asset model.
687
+ * This filter identifies all computation models referencing a particular asset model in their data bindings.</p>
688
+ * @public
689
+ */
690
+ export interface AssetModelBindingValueFilter {
691
+ /**
692
+ * <p>The ID of the asset model to filter data bindings by.
693
+ * Only data bindings referemncing this specific asset model are matched.</p>
694
+ * @public
695
+ */
696
+ assetModelId: string | undefined;
697
+ }
651
698
  /**
652
699
  * <p>Represents one level between a property and the root of the asset model.</p>
653
700
  * @public
@@ -1354,6 +1401,42 @@ export interface AssetModelHierarchyDefinition {
1354
1401
  */
1355
1402
  childAssetModelId: string | undefined;
1356
1403
  }
1404
+ /**
1405
+ * <p>Contains information about an <code>assetModelProperty</code> binding value.</p>
1406
+ * @public
1407
+ */
1408
+ export interface AssetModelPropertyBindingValue {
1409
+ /**
1410
+ * <p>The ID of the asset model, in UUID format.</p>
1411
+ * @public
1412
+ */
1413
+ assetModelId: string | undefined;
1414
+ /**
1415
+ * <p>The ID of the asset model property used in data binding value.</p>
1416
+ * @public
1417
+ */
1418
+ propertyId: string | undefined;
1419
+ }
1420
+ /**
1421
+ * <p>A filter used to match data bindings based on a specific asset model property.
1422
+ * This filter identifies all computation models that
1423
+ * reference a particular property of an asset model in their data bindings.</p>
1424
+ * @public
1425
+ */
1426
+ export interface AssetModelPropertyBindingValueFilter {
1427
+ /**
1428
+ * <p>The ID of the asset model containing the filter property.
1429
+ * This identifies the specific asset model that contains the property of interest.</p>
1430
+ * @public
1431
+ */
1432
+ assetModelId: string | undefined;
1433
+ /**
1434
+ * <p>The ID of the property within the asset model to filter by.
1435
+ * Only data bindings referencing this specific property of the specified asset model are matched.</p>
1436
+ * @public
1437
+ */
1438
+ propertyId: string | undefined;
1439
+ }
1357
1440
  /**
1358
1441
  * <p>Contains a summary of a property associated with a model.</p>
1359
1442
  * @public
@@ -1596,6 +1679,45 @@ export declare const AssetModelVersionType: {
1596
1679
  * @public
1597
1680
  */
1598
1681
  export type AssetModelVersionType = (typeof AssetModelVersionType)[keyof typeof AssetModelVersionType];
1682
+ /**
1683
+ * <p>Represents a data binding value referencing a specific asset property.
1684
+ * It's used to bind computation model variables to actual asset property values for processing.</p>
1685
+ * @public
1686
+ */
1687
+ export interface AssetPropertyBindingValue {
1688
+ /**
1689
+ * <p>The ID of the asset containing the property.
1690
+ * This identifies the specific asset instance's property value used in the computation model.</p>
1691
+ * @public
1692
+ */
1693
+ assetId: string | undefined;
1694
+ /**
1695
+ * <p>The ID of the property within the asset. This identifies the specific property's
1696
+ * value used in the computation model.</p>
1697
+ * @public
1698
+ */
1699
+ propertyId: string | undefined;
1700
+ }
1701
+ /**
1702
+ * <p>A filter used to match data bindings based on a specific asset property.
1703
+ * This filter helps identify all computation models referencing a
1704
+ * particular property of an asset in their data bindings.</p>
1705
+ * @public
1706
+ */
1707
+ export interface AssetPropertyBindingValueFilter {
1708
+ /**
1709
+ * <p>The ID of the asset containing the property to filter by.
1710
+ * This identifies the specific asset instance containing the property of interest.</p>
1711
+ * @public
1712
+ */
1713
+ assetId: string | undefined;
1714
+ /**
1715
+ * <p>The ID of the property within the asset to filter by.
1716
+ * Only data bindings referencing this specific property of the specified asset are matched.</p>
1717
+ * @public
1718
+ */
1719
+ propertyId: string | undefined;
1720
+ }
1599
1721
  /**
1600
1722
  * <p>Contains a summary of a property associated with an asset.</p>
1601
1723
  * @public
@@ -1606,6 +1728,11 @@ export interface AssetPropertySummary {
1606
1728
  * @public
1607
1729
  */
1608
1730
  id: string | undefined;
1731
+ /**
1732
+ * <p>The external ID of the property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
1733
+ * @public
1734
+ */
1735
+ externalId?: string | undefined;
1609
1736
  /**
1610
1737
  * <p>The alias that identifies the property, such as an OPC-UA server data stream path
1611
1738
  * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
@@ -1635,11 +1762,6 @@ export interface AssetPropertySummary {
1635
1762
  * @public
1636
1763
  */
1637
1764
  path?: AssetPropertyPathSegment[] | undefined;
1638
- /**
1639
- * <p>The external ID of the property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
1640
- * @public
1641
- */
1642
- externalId?: string | undefined;
1643
1765
  }
1644
1766
  /**
1645
1767
  * <p>Contains a timestamp with optional nanosecond granularity.</p>
@@ -1690,10 +1812,8 @@ export interface PropertyValueNullValue {
1690
1812
  */
1691
1813
  export interface Variant {
1692
1814
  /**
1693
- * <p>
1694
- * Asset property data of type string (sequence of characters).
1695
- * The allowed pattern: "^$|[^\u0000-\u001F\u007F]+". The max length is 1024.
1696
- * </p>
1815
+ * <p> Asset property data of type string (sequence of characters). The allowed pattern:
1816
+ * "^$|[^\u0000-\u001F\u007F]+". The max length is 1024. </p>
1697
1817
  * @public
1698
1818
  */
1699
1819
  stringValue?: string | undefined;
@@ -1703,10 +1823,8 @@ export interface Variant {
1703
1823
  */
1704
1824
  integerValue?: number | undefined;
1705
1825
  /**
1706
- * <p>
1707
- * Asset property data of type double (floating point number). The min value is -10^10.
1708
- * The max value is 10^10. Double.NaN is allowed.
1709
- * </p>
1826
+ * <p> Asset property data of type double (floating point number). The min value is -10^10. The
1827
+ * max value is 10^10. Double.NaN is allowed. </p>
1710
1828
  * @public
1711
1829
  */
1712
1830
  doubleValue?: number | undefined;
@@ -1823,6 +1941,11 @@ export interface AssetSummary {
1823
1941
  * @public
1824
1942
  */
1825
1943
  id: string | undefined;
1944
+ /**
1945
+ * <p>The external ID of the asset. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
1946
+ * @public
1947
+ */
1948
+ externalId?: string | undefined;
1826
1949
  /**
1827
1950
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset, which has the following format.</p>
1828
1951
  * <p>
@@ -1866,11 +1989,6 @@ export interface AssetSummary {
1866
1989
  * @public
1867
1990
  */
1868
1991
  description?: string | undefined;
1869
- /**
1870
- * <p>The external ID of the asset. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
1871
- * @public
1872
- */
1873
- externalId?: string | undefined;
1874
1992
  }
1875
1993
  /**
1876
1994
  * @public
@@ -1951,7 +2069,7 @@ export declare class InvalidRequestException extends __BaseException {
1951
2069
  constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
1952
2070
  }
1953
2071
  /**
1954
- * <p>You've reached the limit for a resource. For example, this can occur if you're trying to
2072
+ * <p>You've reached the quota for a resource. For example, this can occur if you're trying to
1955
2073
  * associate more than the allowed number of child assets or attempting to create more than the
1956
2074
  * allowed number of properties for an asset model.</p>
1957
2075
  * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
@@ -2024,6 +2142,11 @@ export interface AssociatedAssetsSummary {
2024
2142
  * @public
2025
2143
  */
2026
2144
  id: string | undefined;
2145
+ /**
2146
+ * <p>The external ID of the asset. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
2147
+ * @public
2148
+ */
2149
+ externalId?: string | undefined;
2027
2150
  /**
2028
2151
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset, which has the following format.</p>
2029
2152
  * <p>
@@ -2067,11 +2190,6 @@ export interface AssociatedAssetsSummary {
2067
2190
  * @public
2068
2191
  */
2069
2192
  description?: string | undefined;
2070
- /**
2071
- * <p>The external ID of the asset. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
2072
- * @public
2073
- */
2074
- externalId?: string | undefined;
2075
2193
  }
2076
2194
  /**
2077
2195
  * @public
@@ -2855,8 +2973,9 @@ export interface PutAssetPropertyValueEntry {
2855
2973
  */
2856
2974
  export interface BatchPutAssetPropertyValueRequest {
2857
2975
  /**
2858
- * <p>This setting enables partial ingestion at entry-level. If set to <code>true</code>, we ingest all TQVs not resulting in an error. If set to
2859
- * <code>false</code>, an invalid TQV fails ingestion of the entire entry that contains it.</p>
2976
+ * <p>This setting enables partial ingestion at entry-level. If set to <code>true</code>, we
2977
+ * ingest all TQVs not resulting in an error. If set to <code>false</code>, an invalid TQV fails
2978
+ * ingestion of the entire entry that contains it.</p>
2860
2979
  * @public
2861
2980
  */
2862
2981
  enablePartialEntryProcessing?: boolean | undefined;
@@ -3000,6 +3119,18 @@ export interface CreateAssetRequest {
3000
3119
  * @public
3001
3120
  */
3002
3121
  assetModelId: string | undefined;
3122
+ /**
3123
+ * <p>The ID to assign to the asset, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.
3124
+ * However, if you prefer to supply your own ID instead, you can specify it here in UUID format.
3125
+ * If you specify your own ID, it must be globally unique.</p>
3126
+ * @public
3127
+ */
3128
+ assetId?: string | undefined;
3129
+ /**
3130
+ * <p>An external ID to assign to the asset. The external ID must be unique within your Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
3131
+ * @public
3132
+ */
3133
+ assetExternalId?: string | undefined;
3003
3134
  /**
3004
3135
  * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
3005
3136
  * @public
@@ -3017,18 +3148,6 @@ export interface CreateAssetRequest {
3017
3148
  * @public
3018
3149
  */
3019
3150
  assetDescription?: string | undefined;
3020
- /**
3021
- * <p>The ID to assign to the asset, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.
3022
- * However, if you prefer to supply your own ID instead, you can specify it here in UUID format.
3023
- * If you specify your own ID, it must be globally unique.</p>
3024
- * @public
3025
- */
3026
- assetId?: string | undefined;
3027
- /**
3028
- * <p>An external ID to assign to the asset. The external ID must be unique within your Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
3029
- * @public
3030
- */
3031
- assetExternalId?: string | undefined;
3032
3151
  }
3033
3152
  /**
3034
3153
  * @public
@@ -3504,6 +3623,87 @@ export interface CreateBulkImportJobResponse {
3504
3623
  */
3505
3624
  jobStatus: JobStatus | undefined;
3506
3625
  }
3626
+ /**
3627
+ * <p>Contains the configuration of the type of anomaly detection computation model.</p>
3628
+ * @public
3629
+ */
3630
+ export interface ComputationModelAnomalyDetectionConfiguration {
3631
+ /**
3632
+ * <p>Define the variable name associated with input properties, with the following format <code>$\{VariableName\}</code>.</p>
3633
+ * @public
3634
+ */
3635
+ inputProperties: string | undefined;
3636
+ /**
3637
+ * <p>Define the variable name associated with the result property, and the following format <code>$\{VariableName\}</code>.</p>
3638
+ * @public
3639
+ */
3640
+ resultProperty: string | undefined;
3641
+ }
3642
+ /**
3643
+ * <p>The configuration for the computation model.</p>
3644
+ * @public
3645
+ */
3646
+ export interface ComputationModelConfiguration {
3647
+ /**
3648
+ * <p>The configuration for the anomaly detection type of computation model.</p>
3649
+ * @public
3650
+ */
3651
+ anomalyDetection?: ComputationModelAnomalyDetectionConfiguration | undefined;
3652
+ }
3653
+ /**
3654
+ * @public
3655
+ * @enum
3656
+ */
3657
+ export declare const ComputationModelState: {
3658
+ readonly ACTIVE: "ACTIVE";
3659
+ readonly CREATING: "CREATING";
3660
+ readonly DELETING: "DELETING";
3661
+ readonly FAILED: "FAILED";
3662
+ readonly UPDATING: "UPDATING";
3663
+ };
3664
+ /**
3665
+ * @public
3666
+ */
3667
+ export type ComputationModelState = (typeof ComputationModelState)[keyof typeof ComputationModelState];
3668
+ /**
3669
+ * <p>Contains current status information for a computation model.</p>
3670
+ * @public
3671
+ */
3672
+ export interface ComputationModelStatus {
3673
+ /**
3674
+ * <p>The current state of the computation model.</p>
3675
+ * @public
3676
+ */
3677
+ state: ComputationModelState | undefined;
3678
+ /**
3679
+ * <p>Contains the details of an IoT SiteWise error.</p>
3680
+ * @public
3681
+ */
3682
+ error?: ErrorDetails | undefined;
3683
+ }
3684
+ /**
3685
+ * @public
3686
+ */
3687
+ export interface CreateComputationModelResponse {
3688
+ /**
3689
+ * <p>The ID of the computation model.</p>
3690
+ * @public
3691
+ */
3692
+ computationModelId: string | undefined;
3693
+ /**
3694
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the computation model, which has the following format.</p>
3695
+ * <p>
3696
+ * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:computation-model/$\{ComputationModelId\}</code>
3697
+ * </p>
3698
+ * @public
3699
+ */
3700
+ computationModelArn: string | undefined;
3701
+ /**
3702
+ * <p>The status of the computation model, containing a state (CREATING after successfully calling this operation) and any error messages.</p>
3703
+ * @public
3704
+ */
3705
+ computationModelStatus: ComputationModelStatus | undefined;
3706
+ }
3507
3707
  /**
3508
3708
  * @public
3509
3709
  */
@@ -3777,7 +3977,11 @@ export interface GreengrassV2 {
3777
3977
  */
3778
3978
  coreDeviceThingName: string | undefined;
3779
3979
  /**
3780
- * <p>The operating system of the core device in IoT Greengrass V2.</p>
3980
+ * <p>The operating system of the core device in IoT Greengrass V2. Specifying the operating system is
3981
+ * required for MQTT-enabled, V3 gateways (<code>gatewayVersion</code>
3982
+ * <code>3</code>) and not applicable for Classic stream, V2 gateways
3983
+ * (<code>gatewayVersion</code>
3984
+ * <code>2</code>).</p>
3781
3985
  * @public
3782
3986
  */
3783
3987
  coreDeviceOperatingSystem?: CoreDeviceOperatingSystem | undefined;
@@ -3795,7 +3999,10 @@ export interface SiemensIE {
3795
3999
  iotCoreThingName: string | undefined;
3796
4000
  }
3797
4001
  /**
3798
- * <p>Contains a gateway's platform information.</p>
4002
+ * <p>The gateway's platform configuration. You can only specify one platform type in a gateway.</p>
4003
+ * <p>(Legacy only) For Greengrass V1 gateways, specify the <code>greengrass</code> parameter with a valid Greengrass group ARN.</p>
4004
+ * <p>For Greengrass V2 gateways, specify the <code>greengrassV2</code> parameter with a valid core device thing name. If creating a V3 gateway (<code>gatewayVersion=3</code>), you must also specify the <code>coreDeviceOperatingSystem</code>.</p>
4005
+ * <p>For Siemens Industrial Edge gateways, specify the <code>siemensIE</code> parameter with a valid IoT Core thing name.</p>
3799
4006
  * @public
3800
4007
  */
3801
4008
  export interface GatewayPlatform {
@@ -3830,13 +4037,12 @@ export interface CreateGatewayRequest {
3830
4037
  */
3831
4038
  gatewayPlatform: GatewayPlatform | undefined;
3832
4039
  /**
3833
- * <p>The version of the gateway to create. Specify <code>3</code> to create an MQTT-enabled, V3
3834
- * gateway and <code>2</code> To create a Classic streams, V2 gateway. If the version isn't
3835
- * specified, a Classic streams, V2 gateway is created by default.</p>
3836
- * <p> We recommend creating an MQTT-enabled, V3 gateway for self-hosted gateways. SiteWise Edge
3837
- * gateways on Siemens Industrial Edge should use gateway version <code>2</code>. For more information on
3838
- * gateway versions, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gw-self-host-gg2.html"> Self-host a SiteWise Edge
3839
- * gateway with IoT Greengrass V2</a>.</p>
4040
+ * <p>The version of the gateway to create. Specify <code>3</code> to create an MQTT-enabled, V3 gateway and <code>2</code> to create a Classic streams, V2 gateway. If not specified, the default is <code>2</code> (Classic streams, V2 gateway).</p>
4041
+ * <note>
4042
+ * <p>When creating a V3 gateway (<code>gatewayVersion=3</code>) with the <code>GreengrassV2</code> platform, you must also specify the <code>coreDeviceOperatingSystem</code> parameter.</p>
4043
+ * </note>
4044
+ * <p> We recommend creating an MQTT-enabled gateway for self-hosted gateways and Siemens Industrial Edge gateways. For more
4045
+ * information on gateway versions, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html">Use Amazon Web Services IoT SiteWise Edge Edge gateways</a>.</p>
3840
4046
  * @public
3841
4047
  */
3842
4048
  gatewayVersion?: string | undefined;
@@ -4306,6 +4512,31 @@ export interface DeleteAssetModelCompositeModelResponse {
4306
4512
  */
4307
4513
  assetModelStatus: AssetModelStatus | undefined;
4308
4514
  }
4515
+ /**
4516
+ * @public
4517
+ */
4518
+ export interface DeleteComputationModelRequest {
4519
+ /**
4520
+ * <p>The ID of the computation model.</p>
4521
+ * @public
4522
+ */
4523
+ computationModelId: string | undefined;
4524
+ /**
4525
+ * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
4526
+ * @public
4527
+ */
4528
+ clientToken?: string | undefined;
4529
+ }
4530
+ /**
4531
+ * @public
4532
+ */
4533
+ export interface DeleteComputationModelResponse {
4534
+ /**
4535
+ * <p>The status of the computation model. It contains a state (DELETING after successfully calling this operation) and any error messages.</p>
4536
+ * @public
4537
+ */
4538
+ computationModelStatus: ComputationModelStatus | undefined;
4539
+ }
4309
4540
  /**
4310
4541
  * @public
4311
4542
  */
@@ -4530,6 +4761,11 @@ export interface DescribeActionResponse {
4530
4761
  * @public
4531
4762
  */
4532
4763
  executionTime: Date | undefined;
4764
+ /**
4765
+ * <p>The detailed resource this action resolves to.</p>
4766
+ * @public
4767
+ */
4768
+ resolveTo?: ResolveTo | undefined;
4533
4769
  }
4534
4770
  /**
4535
4771
  * @public
@@ -4556,6 +4792,11 @@ export interface DescribeAssetResponse {
4556
4792
  * @public
4557
4793
  */
4558
4794
  assetId: string | undefined;
4795
+ /**
4796
+ * <p>The external ID of the asset, if any.</p>
4797
+ * @public
4798
+ */
4799
+ assetExternalId?: string | undefined;
4559
4800
  /**
4560
4801
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset, which has the following format.</p>
4561
4802
  * <p>
@@ -4616,11 +4857,6 @@ export interface DescribeAssetResponse {
4616
4857
  * @public
4617
4858
  */
4618
4859
  assetCompositeModelSummaries?: AssetCompositeModelSummary[] | undefined;
4619
- /**
4620
- * <p>The external ID of the asset, if any.</p>
4621
- * @public
4622
- */
4623
- assetExternalId?: string | undefined;
4624
4860
  }
4625
4861
  /**
4626
4862
  * @public
@@ -4973,6 +5209,11 @@ export interface Property {
4973
5209
  * @public
4974
5210
  */
4975
5211
  id: string | undefined;
5212
+ /**
5213
+ * <p>The external ID of the asset property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
5214
+ * @public
5215
+ */
5216
+ externalId?: string | undefined;
4976
5217
  /**
4977
5218
  * <p>The name of the property.</p>
4978
5219
  * @public
@@ -5011,11 +5252,6 @@ export interface Property {
5011
5252
  * @public
5012
5253
  */
5013
5254
  path?: AssetPropertyPathSegment[] | undefined;
5014
- /**
5015
- * <p>The external ID of the asset property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
5016
- * @public
5017
- */
5018
- externalId?: string | undefined;
5019
5255
  }
5020
5256
  /**
5021
5257
  * <p>Contains information about a composite model property on an asset.</p>
@@ -5057,6 +5293,11 @@ export interface DescribeAssetPropertyResponse {
5057
5293
  * @public
5058
5294
  */
5059
5295
  assetId: string | undefined;
5296
+ /**
5297
+ * <p>The external ID of the asset. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
5298
+ * @public
5299
+ */
5300
+ assetExternalId?: string | undefined;
5060
5301
  /**
5061
5302
  * <p>The name of the asset.</p>
5062
5303
  * @public
@@ -5081,11 +5322,6 @@ export interface DescribeAssetPropertyResponse {
5081
5322
  * @public
5082
5323
  */
5083
5324
  compositeModel?: CompositeModelProperty | undefined;
5084
- /**
5085
- * <p>The external ID of the asset. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
5086
- * @public
5087
- */
5088
- assetExternalId?: string | undefined;
5089
5325
  }
5090
5326
  /**
5091
5327
  * @public
@@ -5186,6 +5422,67 @@ export interface DescribeBulkImportJobResponse {
5186
5422
  */
5187
5423
  deleteFilesAfterImport?: boolean | undefined;
5188
5424
  }
5425
+ /**
5426
+ * @public
5427
+ */
5428
+ export interface DescribeComputationModelRequest {
5429
+ /**
5430
+ * <p>The ID of the computation model.</p>
5431
+ * @public
5432
+ */
5433
+ computationModelId: string | undefined;
5434
+ }
5435
+ /**
5436
+ * @public
5437
+ * @enum
5438
+ */
5439
+ export declare const ResolveToResourceType: {
5440
+ readonly ASSET: "ASSET";
5441
+ };
5442
+ /**
5443
+ * @public
5444
+ */
5445
+ export type ResolveToResourceType = (typeof ResolveToResourceType)[keyof typeof ResolveToResourceType];
5446
+ /**
5447
+ * @public
5448
+ */
5449
+ export interface DescribeComputationModelExecutionSummaryRequest {
5450
+ /**
5451
+ * <p>The ID of the computation model.</p>
5452
+ * @public
5453
+ */
5454
+ computationModelId: string | undefined;
5455
+ /**
5456
+ * <p>The type of the resolved resource.</p>
5457
+ * @public
5458
+ */
5459
+ resolveToResourceType?: ResolveToResourceType | undefined;
5460
+ /**
5461
+ * <p>The ID of the resolved resource.</p>
5462
+ * @public
5463
+ */
5464
+ resolveToResourceId?: string | undefined;
5465
+ }
5466
+ /**
5467
+ * @public
5468
+ */
5469
+ export interface DescribeComputationModelExecutionSummaryResponse {
5470
+ /**
5471
+ * <p>The ID of the computation model.</p>
5472
+ * @public
5473
+ */
5474
+ computationModelId: string | undefined;
5475
+ /**
5476
+ * <p>The detailed resource this execution summary resolves to.</p>
5477
+ * @public
5478
+ */
5479
+ resolveTo?: ResolveTo | undefined;
5480
+ /**
5481
+ * <p>Contains the execution summary of the computation model.</p>
5482
+ * @public
5483
+ */
5484
+ computationModelExecutionSummary: Record<string, string> | undefined;
5485
+ }
5189
5486
  /**
5190
5487
  * @public
5191
5488
  */
@@ -5393,6 +5690,118 @@ export interface DescribeDefaultEncryptionConfigurationResponse {
5393
5690
  */
5394
5691
  configurationStatus: ConfigurationStatus | undefined;
5395
5692
  }
5693
+ /**
5694
+ * @public
5695
+ */
5696
+ export interface DescribeExecutionRequest {
5697
+ /**
5698
+ * <p>The ID of the execution.</p>
5699
+ * @public
5700
+ */
5701
+ executionId: string | undefined;
5702
+ }
5703
+ /**
5704
+ * @public
5705
+ * @enum
5706
+ */
5707
+ export declare const ExecutionState: {
5708
+ readonly COMPLETED: "COMPLETED";
5709
+ readonly FAILED: "FAILED";
5710
+ readonly RUNNING: "RUNNING";
5711
+ };
5712
+ /**
5713
+ * @public
5714
+ */
5715
+ export type ExecutionState = (typeof ExecutionState)[keyof typeof ExecutionState];
5716
+ /**
5717
+ * <p>The status of the execution.</p>
5718
+ * @public
5719
+ */
5720
+ export interface ExecutionStatus {
5721
+ /**
5722
+ * <p>The current state of the computation model.</p>
5723
+ * @public
5724
+ */
5725
+ state: ExecutionState | undefined;
5726
+ }
5727
+ /**
5728
+ * @public
5729
+ */
5730
+ export interface DescribeExecutionResponse {
5731
+ /**
5732
+ * <p>The ID of the execution.</p>
5733
+ * @public
5734
+ */
5735
+ executionId: string | undefined;
5736
+ /**
5737
+ * <p>The type of action exectued.</p>
5738
+ * @public
5739
+ */
5740
+ actionType?: string | undefined;
5741
+ /**
5742
+ * <p>The resource the action will be taken on.</p>
5743
+ * @public
5744
+ */
5745
+ targetResource: TargetResource | undefined;
5746
+ /**
5747
+ * <p>The version of the target resource.</p>
5748
+ * @public
5749
+ */
5750
+ targetResourceVersion: string | undefined;
5751
+ /**
5752
+ * <p>The detailed resource this execution resolves to.</p>
5753
+ * @public
5754
+ */
5755
+ resolveTo?: ResolveTo | undefined;
5756
+ /**
5757
+ * <p>The time the process started.</p>
5758
+ * @public
5759
+ */
5760
+ executionStartTime: Date | undefined;
5761
+ /**
5762
+ * <p>The time the process ended.</p>
5763
+ * @public
5764
+ */
5765
+ executionEndTime?: Date | undefined;
5766
+ /**
5767
+ * <p>The status of the execution process.</p>
5768
+ * @public
5769
+ */
5770
+ executionStatus: ExecutionStatus | undefined;
5771
+ /**
5772
+ * <p>The result of the execution.</p>
5773
+ * @public
5774
+ */
5775
+ executionResult?: Record<string, string> | undefined;
5776
+ /**
5777
+ * <p>Provides detailed information about the execution of your anomaly detection models.
5778
+ * This includes model metrics and training timestamps for both training and inference actions.</p>
5779
+ * <ul>
5780
+ * <li>
5781
+ * <p>
5782
+ * The training action (Amazon Web Services/ANOMALY_DETECTION_TRAINING),
5783
+ * includes performance metrics that help you
5784
+ * compare different versions of your anomaly detection models.
5785
+ * These metrics provide insights into the model's performance during the training process.
5786
+ * </p>
5787
+ * </li>
5788
+ * <li>
5789
+ * <p>
5790
+ * The inference action (Amazon Web Services/ANOMALY_DETECTION_INFERENCE), includes information
5791
+ * about the results of executing your anomaly detection models.
5792
+ * This helps you understand the output of your models and assess their performance.
5793
+ * </p>
5794
+ * </li>
5795
+ * </ul>
5796
+ * @public
5797
+ */
5798
+ executionDetails?: Record<string, string> | undefined;
5799
+ /**
5800
+ * <p>Entity version used for the execution.</p>
5801
+ * @public
5802
+ */
5803
+ executionEntityVersion?: string | undefined;
5804
+ }
5396
5805
  /**
5397
5806
  * @public
5398
5807
  */
@@ -5425,35 +5834,34 @@ export type CapabilitySyncStatus = (typeof CapabilitySyncStatus)[keyof typeof Ca
5425
5834
  export interface GatewayCapabilitySummary {
5426
5835
  /**
5427
5836
  * <p>The namespace of the capability configuration.
5428
- * For example, if you configure OPC-UA
5429
- * sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace
5430
- * <code>iotsitewise:opcuacollector:version</code>, where <code>version</code> is a number such as
5431
- * <code>1</code>.</p>
5837
+ * For example, if you configure OPC UA
5838
+ * sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace
5839
+ * <code>iotsitewise:opcuacollector:3</code>.</p>
5432
5840
  * @public
5433
5841
  */
5434
5842
  capabilityNamespace: string | undefined;
5435
5843
  /**
5436
- * <p>The synchronization status of the capability configuration. The sync status can be one of the following:</p>
5844
+ * <p>The synchronization status of the gateway capability configuration. The sync status can be one of the following:</p>
5437
5845
  * <ul>
5438
5846
  * <li>
5439
5847
  * <p>
5440
- * <code>IN_SYNC</code> The gateway is running the capability configuration.</p>
5848
+ * <code>IN_SYNC</code> - The gateway is running with the latest configuration.</p>
5441
5849
  * </li>
5442
5850
  * <li>
5443
5851
  * <p>
5444
- * <code>NOT_APPLICABLE</code> Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.</p>
5852
+ * <code>OUT_OF_SYNC</code> - The gateway hasn't received the latest configuration.</p>
5445
5853
  * </li>
5446
5854
  * <li>
5447
5855
  * <p>
5448
- * <code>OUT_OF_SYNC</code> The gateway hasn't received the capability configuration.</p>
5856
+ * <code>SYNC_FAILED</code> - The gateway rejected the latest configuration.</p>
5449
5857
  * </li>
5450
5858
  * <li>
5451
5859
  * <p>
5452
- * <code>SYNC_FAILED</code> The gateway rejected the capability configuration.</p>
5860
+ * <code>UNKNOWN</code> - The gateway hasn't reported its sync status.</p>
5453
5861
  * </li>
5454
5862
  * <li>
5455
5863
  * <p>
5456
- * <code>UNKNOWN</code> The synchronization status is currently unknown due to an undetermined or temporary error.</p>
5864
+ * <code>NOT_APPLICABLE</code> - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.</p>
5457
5865
  * </li>
5458
5866
  * </ul>
5459
5867
  * @public
@@ -5522,10 +5930,9 @@ export interface DescribeGatewayCapabilityConfigurationRequest {
5522
5930
  gatewayId: string | undefined;
5523
5931
  /**
5524
5932
  * <p>The namespace of the capability configuration.
5525
- * For example, if you configure OPC-UA
5526
- * sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace
5527
- * <code>iotsitewise:opcuacollector:version</code>, where <code>version</code> is a number such as
5528
- * <code>1</code>.</p>
5933
+ * For example, if you configure OPC UA
5934
+ * sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace
5935
+ * <code>iotsitewise:opcuacollector:3</code>.</p>
5529
5936
  * @public
5530
5937
  */
5531
5938
  capabilityNamespace: string | undefined;
@@ -5551,27 +5958,27 @@ export interface DescribeGatewayCapabilityConfigurationResponse {
5551
5958
  */
5552
5959
  capabilityConfiguration: string | undefined;
5553
5960
  /**
5554
- * <p>The synchronization status of the capability configuration. The sync status can be one of the following:</p>
5961
+ * <p>The synchronization status of the gateway capability configuration. The sync status can be one of the following:</p>
5555
5962
  * <ul>
5556
5963
  * <li>
5557
5964
  * <p>
5558
- * <code>IN_SYNC</code> The gateway is running the capability configuration.</p>
5965
+ * <code>IN_SYNC</code> - The gateway is running with the latest configuration.</p>
5559
5966
  * </li>
5560
5967
  * <li>
5561
5968
  * <p>
5562
- * <code>NOT_APPLICABLE</code> Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.</p>
5969
+ * <code>OUT_OF_SYNC</code> - The gateway hasn't received the latest configuration.</p>
5563
5970
  * </li>
5564
5971
  * <li>
5565
5972
  * <p>
5566
- * <code>OUT_OF_SYNC</code> The gateway hasn't received the capability configuration.</p>
5973
+ * <code>SYNC_FAILED</code> - The gateway rejected the latest configuration.</p>
5567
5974
  * </li>
5568
5975
  * <li>
5569
5976
  * <p>
5570
- * <code>SYNC_FAILED</code> The gateway rejected the capability configuration.</p>
5977
+ * <code>UNKNOWN</code> - The gateway hasn't reported its sync status.</p>
5571
5978
  * </li>
5572
5979
  * <li>
5573
5980
  * <p>
5574
- * <code>UNKNOWN</code> The synchronization status is currently unknown due to an undetermined or temporary error.</p>
5981
+ * <code>NOT_APPLICABLE</code> - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.</p>
5575
5982
  * </li>
5576
5983
  * </ul>
5577
5984
  * @public
@@ -5979,8 +6386,8 @@ export interface DescribeStorageConfigurationResponse {
5979
6386
  */
5980
6387
  warmTierRetentionPeriod?: WarmTierRetentionPeriod | undefined;
5981
6388
  /**
5982
- * <p>Describes the configuration for ingesting NULL and NaN data.
5983
- * By default the feature is allowed. The feature is disallowed if the value is <code>true</code>.</p>
6389
+ * <p>Describes the configuration for ingesting NULL and NaN data. By default the feature is
6390
+ * allowed. The feature is disallowed if the value is <code>true</code>.</p>
5984
6391
  * @public
5985
6392
  */
5986
6393
  disallowIngestNullNaN?: boolean | undefined;
@@ -6148,6 +6555,11 @@ export interface ExecuteActionRequest {
6148
6555
  * @public
6149
6556
  */
6150
6557
  clientToken?: string | undefined;
6558
+ /**
6559
+ * <p>The detailed resource this action resolves to.</p>
6560
+ * @public
6561
+ */
6562
+ resolveTo?: ResolveTo | undefined;
6151
6563
  }
6152
6564
  /**
6153
6565
  * @public
@@ -6174,7 +6586,18 @@ export interface ExecuteQueryRequest {
6174
6586
  */
6175
6587
  nextToken?: string | undefined;
6176
6588
  /**
6177
- * <p>The maximum number of results to return at one time. The default is 25.</p>
6589
+ * <p>The maximum number of results to return at one time.</p>
6590
+ * <ul>
6591
+ * <li>
6592
+ * <p>Minimum is 1</p>
6593
+ * </li>
6594
+ * <li>
6595
+ * <p>Maximum is 20000</p>
6596
+ * </li>
6597
+ * <li>
6598
+ * <p>Default is 250</p>
6599
+ * </li>
6600
+ * </ul>
6178
6601
  * @public
6179
6602
  */
6180
6603
  maxResults?: number | undefined;
@@ -6851,7 +7274,7 @@ export declare namespace ResponseStream {
6851
7274
  $unknown?: never;
6852
7275
  }
6853
7276
  /**
6854
- * <p>You've reached the limit for a resource. For example, this can occur if you're trying to
7277
+ * <p>You've reached the quota for a resource. For example, this can occur if you're trying to
6855
7278
  * associate more than the allowed number of child assets or attempting to create more than the
6856
7279
  * allowed number of properties for an asset model.</p>
6857
7280
  * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
@@ -6948,504 +7371,6 @@ export interface InvokeAssistantResponse {
6948
7371
  */
6949
7372
  conversationId: string | undefined;
6950
7373
  }
6951
- /**
6952
- * @public
6953
- * @enum
6954
- */
6955
- export declare const IdentityType: {
6956
- readonly GROUP: "GROUP";
6957
- readonly IAM: "IAM";
6958
- readonly USER: "USER";
6959
- };
6960
- /**
6961
- * @public
6962
- */
6963
- export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
6964
- /**
6965
- * @public
6966
- * @enum
6967
- */
6968
- export declare const ResourceType: {
6969
- readonly PORTAL: "PORTAL";
6970
- readonly PROJECT: "PROJECT";
6971
- };
6972
- /**
6973
- * @public
6974
- */
6975
- export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
6976
- /**
6977
- * @public
6978
- */
6979
- export interface ListAccessPoliciesRequest {
6980
- /**
6981
- * <p>The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required
6982
- * if you specify <code>identityId</code>.</p>
6983
- * @public
6984
- */
6985
- identityType?: IdentityType | undefined;
6986
- /**
6987
- * <p>The ID of the identity. This parameter is required if you specify <code>USER</code> or
6988
- * <code>GROUP</code> for <code>identityType</code>.</p>
6989
- * @public
6990
- */
6991
- identityId?: string | undefined;
6992
- /**
6993
- * <p>The type of resource (portal or project). This parameter is required if you specify
6994
- * <code>resourceId</code>.</p>
6995
- * @public
6996
- */
6997
- resourceType?: ResourceType | undefined;
6998
- /**
6999
- * <p>The ID of the resource. This parameter is required if you specify
7000
- * <code>resourceType</code>.</p>
7001
- * @public
7002
- */
7003
- resourceId?: string | undefined;
7004
- /**
7005
- * <p>The ARN of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM ARNs</a> in the
7006
- * <i>IAM User Guide</i>. This parameter is required if you specify
7007
- * <code>IAM</code> for <code>identityType</code>.</p>
7008
- * @public
7009
- */
7010
- iamArn?: string | undefined;
7011
- /**
7012
- * <p>The token to be used for the next set of paginated results.</p>
7013
- * @public
7014
- */
7015
- nextToken?: string | undefined;
7016
- /**
7017
- * <p>The maximum number of results to return for each paginated request.</p>
7018
- * <p>Default: 50</p>
7019
- * @public
7020
- */
7021
- maxResults?: number | undefined;
7022
- }
7023
- /**
7024
- * @public
7025
- */
7026
- export interface ListAccessPoliciesResponse {
7027
- /**
7028
- * <p>A list that summarizes each access policy.</p>
7029
- * @public
7030
- */
7031
- accessPolicySummaries: AccessPolicySummary[] | undefined;
7032
- /**
7033
- * <p>The token for the next set of results, or null if there are no additional results.</p>
7034
- * @public
7035
- */
7036
- nextToken?: string | undefined;
7037
- }
7038
- /**
7039
- * @public
7040
- * @enum
7041
- */
7042
- export declare const TargetResourceType: {
7043
- readonly ASSET: "ASSET";
7044
- };
7045
- /**
7046
- * @public
7047
- */
7048
- export type TargetResourceType = (typeof TargetResourceType)[keyof typeof TargetResourceType];
7049
- /**
7050
- * @public
7051
- */
7052
- export interface ListActionsRequest {
7053
- /**
7054
- * <p>The type of resource.</p>
7055
- * @public
7056
- */
7057
- targetResourceType: TargetResourceType | undefined;
7058
- /**
7059
- * <p>The ID of the target resource.</p>
7060
- * @public
7061
- */
7062
- targetResourceId: string | undefined;
7063
- /**
7064
- * <p>The token to be used for the next set of paginated results.</p>
7065
- * @public
7066
- */
7067
- nextToken?: string | undefined;
7068
- /**
7069
- * <p>The maximum number of results to return for each paginated request.</p>
7070
- * @public
7071
- */
7072
- maxResults?: number | undefined;
7073
- }
7074
- /**
7075
- * @public
7076
- */
7077
- export interface ListActionsResponse {
7078
- /**
7079
- * <p>A list that summarizes the actions associated with the specified asset.</p>
7080
- * @public
7081
- */
7082
- actionSummaries: ActionSummary[] | undefined;
7083
- /**
7084
- * <p>The token for the next set of results, or null if there are no additional results.</p>
7085
- * @public
7086
- */
7087
- nextToken: string | undefined;
7088
- }
7089
- /**
7090
- * @public
7091
- */
7092
- export interface ListAssetModelCompositeModelsRequest {
7093
- /**
7094
- * <p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
7095
- * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
7096
- * @public
7097
- */
7098
- assetModelId: string | undefined;
7099
- /**
7100
- * <p>The token to be used for the next set of paginated results.</p>
7101
- * @public
7102
- */
7103
- nextToken?: string | undefined;
7104
- /**
7105
- * <p>The maximum number of results to return for each paginated request.</p>
7106
- * <p>Default: 50</p>
7107
- * @public
7108
- */
7109
- maxResults?: number | undefined;
7110
- /**
7111
- * <p>The version alias that specifies the latest or active version of the asset model.
7112
- * The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html">
7113
- * Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
7114
- * @public
7115
- */
7116
- assetModelVersion?: string | undefined;
7117
- }
7118
- /**
7119
- * @public
7120
- */
7121
- export interface ListAssetModelCompositeModelsResponse {
7122
- /**
7123
- * <p>A list that summarizes each composite model.</p>
7124
- * @public
7125
- */
7126
- assetModelCompositeModelSummaries: AssetModelCompositeModelSummary[] | undefined;
7127
- /**
7128
- * <p>The token for the next set of results, or null if there are no additional results.</p>
7129
- * @public
7130
- */
7131
- nextToken?: string | undefined;
7132
- }
7133
- /**
7134
- * @public
7135
- * @enum
7136
- */
7137
- export declare const ListAssetModelPropertiesFilter: {
7138
- readonly ALL: "ALL";
7139
- readonly BASE: "BASE";
7140
- };
7141
- /**
7142
- * @public
7143
- */
7144
- export type ListAssetModelPropertiesFilter = (typeof ListAssetModelPropertiesFilter)[keyof typeof ListAssetModelPropertiesFilter];
7145
- /**
7146
- * @public
7147
- */
7148
- export interface ListAssetModelPropertiesRequest {
7149
- /**
7150
- * <p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
7151
- * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
7152
- * @public
7153
- */
7154
- assetModelId: string | undefined;
7155
- /**
7156
- * <p>The token to be used for the next set of paginated results.</p>
7157
- * @public
7158
- */
7159
- nextToken?: string | undefined;
7160
- /**
7161
- * <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
7162
- * @public
7163
- */
7164
- maxResults?: number | undefined;
7165
- /**
7166
- * <p> Filters the requested list of asset model properties. You can choose one of the following
7167
- * options:</p>
7168
- * <ul>
7169
- * <li>
7170
- * <p>
7171
- * <code>ALL</code> – The list includes all asset model properties for a given asset
7172
- * model ID. </p>
7173
- * </li>
7174
- * <li>
7175
- * <p>
7176
- * <code>BASE</code> – The list includes only base asset model properties for a given
7177
- * asset model ID. </p>
7178
- * </li>
7179
- * </ul>
7180
- * <p>Default: <code>BASE</code>
7181
- * </p>
7182
- * @public
7183
- */
7184
- filter?: ListAssetModelPropertiesFilter | undefined;
7185
- /**
7186
- * <p>The version alias that specifies the latest or active version of the asset model.
7187
- * The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html">
7188
- * Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
7189
- * @public
7190
- */
7191
- assetModelVersion?: string | undefined;
7192
- }
7193
- /**
7194
- * @public
7195
- */
7196
- export interface ListAssetModelPropertiesResponse {
7197
- /**
7198
- * <p>A list that summarizes the properties associated with the specified asset model.</p>
7199
- * @public
7200
- */
7201
- assetModelPropertySummaries: AssetModelPropertySummary[] | undefined;
7202
- /**
7203
- * <p>The token for the next set of results, or null if there are no additional results.</p>
7204
- * @public
7205
- */
7206
- nextToken?: string | undefined;
7207
- }
7208
- /**
7209
- * @public
7210
- */
7211
- export interface ListAssetModelsRequest {
7212
- /**
7213
- * <p>The type of asset model. If you don't provide an <code>assetModelTypes</code>, all types
7214
- * of asset models are returned.</p>
7215
- * <ul>
7216
- * <li>
7217
- * <p>
7218
- * <b>ASSET_MODEL</b> – An asset model that you can use
7219
- * to create assets. Can't be included as a component in another asset model.</p>
7220
- * </li>
7221
- * <li>
7222
- * <p>
7223
- * <b>COMPONENT_MODEL</b> – A reusable component that
7224
- * you can include in the composite models of other asset models. You can't create
7225
- * assets directly from this type of asset model. </p>
7226
- * </li>
7227
- * </ul>
7228
- * @public
7229
- */
7230
- assetModelTypes?: AssetModelType[] | undefined;
7231
- /**
7232
- * <p>The token to be used for the next set of paginated results.</p>
7233
- * @public
7234
- */
7235
- nextToken?: string | undefined;
7236
- /**
7237
- * <p>The maximum number of results to return for each paginated request.</p>
7238
- * <p>Default: 50</p>
7239
- * @public
7240
- */
7241
- maxResults?: number | undefined;
7242
- /**
7243
- * <p>The version alias that specifies the latest or active version of the asset model.
7244
- * The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html">
7245
- * Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
7246
- * @public
7247
- */
7248
- assetModelVersion?: string | undefined;
7249
- }
7250
- /**
7251
- * @public
7252
- */
7253
- export interface ListAssetModelsResponse {
7254
- /**
7255
- * <p>A list that summarizes each asset model.</p>
7256
- * @public
7257
- */
7258
- assetModelSummaries: AssetModelSummary[] | undefined;
7259
- /**
7260
- * <p>The token for the next set of results, or null if there are no additional results.</p>
7261
- * @public
7262
- */
7263
- nextToken?: string | undefined;
7264
- }
7265
- /**
7266
- * @public
7267
- * @enum
7268
- */
7269
- export declare const ListAssetPropertiesFilter: {
7270
- readonly ALL: "ALL";
7271
- readonly BASE: "BASE";
7272
- };
7273
- /**
7274
- * @public
7275
- */
7276
- export type ListAssetPropertiesFilter = (typeof ListAssetPropertiesFilter)[keyof typeof ListAssetPropertiesFilter];
7277
- /**
7278
- * @public
7279
- */
7280
- export interface ListAssetPropertiesRequest {
7281
- /**
7282
- * <p>The ID of the asset. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
7283
- * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
7284
- * @public
7285
- */
7286
- assetId: string | undefined;
7287
- /**
7288
- * <p>The token to be used for the next set of paginated results.</p>
7289
- * @public
7290
- */
7291
- nextToken?: string | undefined;
7292
- /**
7293
- * <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
7294
- * @public
7295
- */
7296
- maxResults?: number | undefined;
7297
- /**
7298
- * <p> Filters the requested list of asset properties. You can choose one of the following
7299
- * options:</p>
7300
- * <ul>
7301
- * <li>
7302
- * <p>
7303
- * <code>ALL</code> – The list includes all asset properties for a given asset model ID.
7304
- * </p>
7305
- * </li>
7306
- * <li>
7307
- * <p>
7308
- * <code>BASE</code> – The list includes only base asset properties for a given asset
7309
- * model ID. </p>
7310
- * </li>
7311
- * </ul>
7312
- * <p>Default: <code>BASE</code>
7313
- * </p>
7314
- * @public
7315
- */
7316
- filter?: ListAssetPropertiesFilter | undefined;
7317
- }
7318
- /**
7319
- * @public
7320
- */
7321
- export interface ListAssetPropertiesResponse {
7322
- /**
7323
- * <p>A list that summarizes the properties associated with the specified asset.</p>
7324
- * @public
7325
- */
7326
- assetPropertySummaries: AssetPropertySummary[] | undefined;
7327
- /**
7328
- * <p>The token for the next set of results, or null if there are no additional results.</p>
7329
- * @public
7330
- */
7331
- nextToken?: string | undefined;
7332
- }
7333
- /**
7334
- * @public
7335
- * @enum
7336
- */
7337
- export declare const TraversalType: {
7338
- readonly PATH_TO_ROOT: "PATH_TO_ROOT";
7339
- };
7340
- /**
7341
- * @public
7342
- */
7343
- export type TraversalType = (typeof TraversalType)[keyof typeof TraversalType];
7344
- /**
7345
- * @public
7346
- */
7347
- export interface ListAssetRelationshipsRequest {
7348
- /**
7349
- * <p>The ID of the asset. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
7350
- * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
7351
- * @public
7352
- */
7353
- assetId: string | undefined;
7354
- /**
7355
- * <p>The type of traversal to use to identify asset relationships. Choose the following
7356
- * option:</p>
7357
- * <ul>
7358
- * <li>
7359
- * <p>
7360
- * <code>PATH_TO_ROOT</code> – Identify the asset's parent assets up to the root
7361
- * asset. The asset that you specify in <code>assetId</code> is the first result in the list
7362
- * of <code>assetRelationshipSummaries</code>, and the root asset is the last result.</p>
7363
- * </li>
7364
- * </ul>
7365
- * @public
7366
- */
7367
- traversalType: TraversalType | undefined;
7368
- /**
7369
- * <p>The token to be used for the next set of paginated results.</p>
7370
- * @public
7371
- */
7372
- nextToken?: string | undefined;
7373
- /**
7374
- * <p>The maximum number of results to return for each paginated request.</p>
7375
- * @public
7376
- */
7377
- maxResults?: number | undefined;
7378
- }
7379
- /**
7380
- * @public
7381
- */
7382
- export interface ListAssetRelationshipsResponse {
7383
- /**
7384
- * <p>A list that summarizes each asset relationship.</p>
7385
- * @public
7386
- */
7387
- assetRelationshipSummaries: AssetRelationshipSummary[] | undefined;
7388
- /**
7389
- * <p>The token for the next set of results, or null if there are no additional results.</p>
7390
- * @public
7391
- */
7392
- nextToken?: string | undefined;
7393
- }
7394
- /**
7395
- * @public
7396
- * @enum
7397
- */
7398
- export declare const ListAssetsFilter: {
7399
- readonly ALL: "ALL";
7400
- readonly TOP_LEVEL: "TOP_LEVEL";
7401
- };
7402
- /**
7403
- * @public
7404
- */
7405
- export type ListAssetsFilter = (typeof ListAssetsFilter)[keyof typeof ListAssetsFilter];
7406
- /**
7407
- * @public
7408
- */
7409
- export interface ListAssetsRequest {
7410
- /**
7411
- * <p>The token to be used for the next set of paginated results.</p>
7412
- * @public
7413
- */
7414
- nextToken?: string | undefined;
7415
- /**
7416
- * <p>The maximum number of results to return for each paginated request.</p>
7417
- * <p>Default: 50</p>
7418
- * @public
7419
- */
7420
- maxResults?: number | undefined;
7421
- /**
7422
- * <p>The ID of the asset model by which to filter the list of assets. This parameter is
7423
- * required if you choose <code>ALL</code> for <code>filter</code>. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
7424
- * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
7425
- * @public
7426
- */
7427
- assetModelId?: string | undefined;
7428
- /**
7429
- * <p>The filter for the requested list of assets. Choose one of the following options:</p>
7430
- * <ul>
7431
- * <li>
7432
- * <p>
7433
- * <code>ALL</code> – The list includes all assets for a given asset model ID. The
7434
- * <code>assetModelId</code> parameter is required if you filter by
7435
- * <code>ALL</code>.</p>
7436
- * </li>
7437
- * <li>
7438
- * <p>
7439
- * <code>TOP_LEVEL</code> – The list includes only top-level assets in the asset
7440
- * hierarchy tree.</p>
7441
- * </li>
7442
- * </ul>
7443
- * <p>Default: <code>ALL</code>
7444
- * </p>
7445
- * @public
7446
- */
7447
- filter?: ListAssetsFilter | undefined;
7448
- }
7449
7374
  /**
7450
7375
  * @internal
7451
7376
  */