@aws-sdk/client-iotsitewise 3.859.0 → 3.862.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 (53) hide show
  1. package/README.md +32 -0
  2. package/dist-cjs/index.js +271 -39
  3. package/dist-es/IoTSiteWise.js +8 -0
  4. package/dist-es/commands/DeleteAssetModelInterfaceRelationshipCommand.js +22 -0
  5. package/dist-es/commands/DescribeAssetModelInterfaceRelationshipCommand.js +22 -0
  6. package/dist-es/commands/InvokeAssistantCommand.js +2 -1
  7. package/dist-es/commands/ListInterfaceRelationshipsCommand.js +22 -0
  8. package/dist-es/commands/PutAssetModelInterfaceRelationshipCommand.js +22 -0
  9. package/dist-es/commands/index.js +4 -0
  10. package/dist-es/models/models_0.js +1 -50
  11. package/dist-es/models/models_1.js +50 -0
  12. package/dist-es/pagination/ListInterfaceRelationshipsPaginator.js +4 -0
  13. package/dist-es/pagination/index.js +1 -0
  14. package/dist-es/protocols/Aws_restJson1.js +151 -0
  15. package/dist-types/IoTSiteWise.d.ts +28 -0
  16. package/dist-types/IoTSiteWiseClient.d.ts +6 -2
  17. package/dist-types/commands/CreateAssetModelCommand.d.ts +12 -7
  18. package/dist-types/commands/CreateAssetModelCompositeModelCommand.d.ts +2 -2
  19. package/dist-types/commands/CreateBulkImportJobCommand.d.ts +2 -2
  20. package/dist-types/commands/DeleteAssetModelInterfaceRelationshipCommand.d.ts +110 -0
  21. package/dist-types/commands/DescribeAssetModelCommand.d.ts +13 -6
  22. package/dist-types/commands/DescribeAssetModelCompositeModelCommand.d.ts +2 -2
  23. package/dist-types/commands/DescribeAssetModelInterfaceRelationshipCommand.d.ts +103 -0
  24. package/dist-types/commands/DescribeAssetPropertyCommand.d.ts +4 -4
  25. package/dist-types/commands/InvokeAssistantCommand.d.ts +2 -1
  26. package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +8 -2
  27. package/dist-types/commands/ListAssetModelsCommand.d.ts +2 -2
  28. package/dist-types/commands/ListComputationModelDataBindingUsagesCommand.d.ts +3 -6
  29. package/dist-types/commands/ListComputationModelResolveToResourcesCommand.d.ts +2 -1
  30. package/dist-types/commands/ListInterfaceRelationshipsCommand.d.ts +96 -0
  31. package/dist-types/commands/PutAssetModelInterfaceRelationshipCommand.d.ts +126 -0
  32. package/dist-types/commands/UpdateAssetModelCommand.d.ts +4 -4
  33. package/dist-types/commands/UpdateAssetModelCompositeModelCommand.d.ts +2 -2
  34. package/dist-types/commands/index.d.ts +4 -0
  35. package/dist-types/models/models_0.d.ts +245 -361
  36. package/dist-types/models/models_1.d.ts +494 -41
  37. package/dist-types/pagination/ListInterfaceRelationshipsPaginator.d.ts +7 -0
  38. package/dist-types/pagination/index.d.ts +1 -0
  39. package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
  40. package/dist-types/ts3.4/IoTSiteWise.d.ts +86 -0
  41. package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +24 -0
  42. package/dist-types/ts3.4/commands/DeleteAssetModelInterfaceRelationshipCommand.d.ts +51 -0
  43. package/dist-types/ts3.4/commands/DescribeAssetModelInterfaceRelationshipCommand.d.ts +51 -0
  44. package/dist-types/ts3.4/commands/InvokeAssistantCommand.d.ts +2 -4
  45. package/dist-types/ts3.4/commands/ListInterfaceRelationshipsCommand.d.ts +51 -0
  46. package/dist-types/ts3.4/commands/PutAssetModelInterfaceRelationshipCommand.d.ts +51 -0
  47. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  48. package/dist-types/ts3.4/models/models_0.d.ts +41 -180
  49. package/dist-types/ts3.4/models/models_1.d.ts +217 -0
  50. package/dist-types/ts3.4/pagination/ListInterfaceRelationshipsPaginator.d.ts +11 -0
  51. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  52. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +48 -0
  53. package/package.json +37 -37
@@ -226,7 +226,8 @@ export interface ResolveTo {
226
226
  assetId: string | undefined;
227
227
  }
228
228
  /**
229
- * <p>The resource the action will be taken on.</p>
229
+ * <p>The resource the action will be taken on. This can include asset-based resources and
230
+ * computation model resources.</p>
230
231
  * @public
231
232
  */
232
233
  export interface TargetResource {
@@ -242,7 +243,8 @@ export interface TargetResource {
242
243
  computationModelId?: string | undefined;
243
244
  }
244
245
  /**
245
- * <p>Contains the summary of the actions.</p>
246
+ * <p>Contains the summary of the actions, including information about where the action resolves
247
+ * to.</p>
246
248
  * @public
247
249
  */
248
250
  export interface ActionSummary {
@@ -376,14 +378,14 @@ export interface Alarms {
376
378
  notificationLambdaArn?: string | undefined;
377
379
  }
378
380
  /**
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
+ * <p>A filter used to match data bindings based on a specific asset. This filter identifies all
382
+ * computation models referencing a particular asset in their data bindings.</p>
381
383
  * @public
382
384
  */
383
385
  export interface AssetBindingValueFilter {
384
386
  /**
385
- * <p>The ID of the asset to filter data bindings by.
386
- * Only data bindings referencing this specific asset are matched.</p>
387
+ * <p>The ID of the asset to filter data bindings by. Only data bindings referencing this
388
+ * specific asset are matched.</p>
387
389
  * @public
388
390
  */
389
391
  assetId: string | undefined;
@@ -683,14 +685,15 @@ export interface AssetHierarchyInfo {
683
685
  childAssetId?: string | undefined;
684
686
  }
685
687
  /**
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
+ * <p>A filter used to match data bindings based on a specific asset model. This filter
689
+ * identifies all computation models referencing a particular asset model in their data
690
+ * bindings.</p>
688
691
  * @public
689
692
  */
690
693
  export interface AssetModelBindingValueFilter {
691
694
  /**
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>
695
+ * <p>The ID of the asset model to filter data bindings by. Only data bindings referemncing this
696
+ * specific asset model are matched.</p>
694
697
  * @public
695
698
  */
696
699
  assetModelId: string | undefined;
@@ -968,12 +971,12 @@ export interface Metric {
968
971
  * <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>
969
972
  * @public
970
973
  */
971
- expression: string | undefined;
974
+ expression?: string | undefined;
972
975
  /**
973
976
  * <p>The list of variables used in the expression.</p>
974
977
  * @public
975
978
  */
976
- variables: ExpressionVariable[] | undefined;
979
+ variables?: ExpressionVariable[] | undefined;
977
980
  /**
978
981
  * <p>The window (time interval) over which IoT SiteWise computes the metric's aggregation expression.
979
982
  * IoT SiteWise computes one data point per <code>window</code>.</p>
@@ -1418,27 +1421,45 @@ export interface AssetModelPropertyBindingValue {
1418
1421
  propertyId: string | undefined;
1419
1422
  }
1420
1423
  /**
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
+ * <p>A filter used to match data bindings based on a specific asset model property. This filter
1425
+ * identifies all computation models that reference a particular property of an asset model in
1426
+ * their data bindings.</p>
1424
1427
  * @public
1425
1428
  */
1426
1429
  export interface AssetModelPropertyBindingValueFilter {
1427
1430
  /**
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>
1431
+ * <p>The ID of the asset model containing the filter property. This identifies the specific
1432
+ * asset model that contains the property of interest.</p>
1430
1433
  * @public
1431
1434
  */
1432
1435
  assetModelId: string | undefined;
1433
1436
  /**
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>
1437
+ * <p>The ID of the property within the asset model to filter by. Only data bindings referencing
1438
+ * this specific property of the specified asset model are matched.</p>
1436
1439
  * @public
1437
1440
  */
1438
1441
  propertyId: string | undefined;
1439
1442
  }
1440
1443
  /**
1441
- * <p>Contains a summary of a property associated with a model.</p>
1444
+ * <p>Contains summary information about an interface that a property belongs to.</p>
1445
+ * @public
1446
+ */
1447
+ export interface InterfaceSummary {
1448
+ /**
1449
+ * <p>The ID of the interface asset model that contains this property.</p>
1450
+ * @public
1451
+ */
1452
+ interfaceAssetModelId: string | undefined;
1453
+ /**
1454
+ * <p>The ID of the property in the interface asset model that corresponds to this
1455
+ * property.</p>
1456
+ * @public
1457
+ */
1458
+ interfaceAssetModelPropertyId: string | undefined;
1459
+ }
1460
+ /**
1461
+ * <p>Contains a summary of a property associated with a model. This includes information about
1462
+ * which interfaces the property belongs to, if any.</p>
1442
1463
  * @public
1443
1464
  */
1444
1465
  export interface AssetModelPropertySummary {
@@ -1489,6 +1510,13 @@ export interface AssetModelPropertySummary {
1489
1510
  * @public
1490
1511
  */
1491
1512
  path?: AssetModelPropertyPathSegment[] | undefined;
1513
+ /**
1514
+ * <p>A list of interface summaries that describe which interfaces this property belongs to,
1515
+ * including the interface asset model ID and the corresponding property ID in the
1516
+ * interface.</p>
1517
+ * @public
1518
+ */
1519
+ interfaceSummaries?: InterfaceSummary[] | undefined;
1492
1520
  }
1493
1521
  /**
1494
1522
  * @public
@@ -1591,6 +1619,7 @@ export interface AssetModelStatus {
1591
1619
  export declare const AssetModelType: {
1592
1620
  readonly ASSET_MODEL: "ASSET_MODEL";
1593
1621
  readonly COMPONENT_MODEL: "COMPONENT_MODEL";
1622
+ readonly INTERFACE: "INTERFACE";
1594
1623
  };
1595
1624
  /**
1596
1625
  * @public
@@ -1680,40 +1709,40 @@ export declare const AssetModelVersionType: {
1680
1709
  */
1681
1710
  export type AssetModelVersionType = (typeof AssetModelVersionType)[keyof typeof AssetModelVersionType];
1682
1711
  /**
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>
1712
+ * <p>Represents a data binding value referencing a specific asset property. It's used to bind
1713
+ * computation model variables to actual asset property values for processing.</p>
1685
1714
  * @public
1686
1715
  */
1687
1716
  export interface AssetPropertyBindingValue {
1688
1717
  /**
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>
1718
+ * <p>The ID of the asset containing the property. This identifies the specific asset instance's
1719
+ * property value used in the computation model.</p>
1691
1720
  * @public
1692
1721
  */
1693
1722
  assetId: string | undefined;
1694
1723
  /**
1695
- * <p>The ID of the property within the asset. This identifies the specific property's
1696
- * value used in the computation model.</p>
1724
+ * <p>The ID of the property within the asset. This identifies the specific property's value
1725
+ * used in the computation model.</p>
1697
1726
  * @public
1698
1727
  */
1699
1728
  propertyId: string | undefined;
1700
1729
  }
1701
1730
  /**
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>
1731
+ * <p>A filter used to match data bindings based on a specific asset property. This filter helps
1732
+ * identify all computation models referencing a particular property of an asset in their data
1733
+ * bindings.</p>
1705
1734
  * @public
1706
1735
  */
1707
1736
  export interface AssetPropertyBindingValueFilter {
1708
1737
  /**
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>
1738
+ * <p>The ID of the asset containing the property to filter by. This identifies the specific
1739
+ * asset instance containing the property of interest.</p>
1711
1740
  * @public
1712
1741
  */
1713
1742
  assetId: string | undefined;
1714
1743
  /**
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>
1744
+ * <p>The ID of the property within the asset to filter by. Only data bindings referencing this
1745
+ * specific property of the specified asset are matched.</p>
1717
1746
  * @public
1718
1747
  */
1719
1748
  propertyId: string | undefined;
@@ -3629,12 +3658,14 @@ export interface CreateBulkImportJobResponse {
3629
3658
  */
3630
3659
  export interface ComputationModelAnomalyDetectionConfiguration {
3631
3660
  /**
3632
- * <p>Define the variable name associated with input properties, with the following format <code>$\{VariableName\}</code>.</p>
3661
+ * <p>Define the variable name associated with input properties, with the following format
3662
+ * <code>$\{VariableName\}</code>.</p>
3633
3663
  * @public
3634
3664
  */
3635
3665
  inputProperties: string | undefined;
3636
3666
  /**
3637
- * <p>Define the variable name associated with the result property, and the following format <code>$\{VariableName\}</code>.</p>
3667
+ * <p>Define the variable name associated with the result property, and the following format
3668
+ * <code>$\{VariableName\}</code>.</p>
3638
3669
  * @public
3639
3670
  */
3640
3671
  resultProperty: string | undefined;
@@ -3699,7 +3730,8 @@ export interface CreateComputationModelResponse {
3699
3730
  */
3700
3731
  computationModelArn: string | undefined;
3701
3732
  /**
3702
- * <p>The status of the computation model, containing a state (CREATING after successfully calling this operation) and any error messages.</p>
3733
+ * <p>The status of the computation model, containing a state (CREATING after successfully
3734
+ * calling this operation) and any error messages.</p>
3703
3735
  * @public
3704
3736
  */
3705
3737
  computationModelStatus: ComputationModelStatus | undefined;
@@ -3999,10 +4031,15 @@ export interface SiemensIE {
3999
4031
  iotCoreThingName: string | undefined;
4000
4032
  }
4001
4033
  /**
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>
4034
+ * <p>The gateway's platform configuration. You can only specify one platform type in a
4035
+ * gateway.</p>
4036
+ * <p>(Legacy only) For Greengrass V1 gateways, specify the <code>greengrass</code> parameter
4037
+ * with a valid Greengrass group ARN.</p>
4038
+ * <p>For Greengrass V2 gateways, specify the <code>greengrassV2</code> parameter with a valid
4039
+ * core device thing name. If creating a V3 gateway (<code>gatewayVersion=3</code>), you must
4040
+ * also specify the <code>coreDeviceOperatingSystem</code>.</p>
4041
+ * <p>For Siemens Industrial Edge gateways, specify the <code>siemensIE</code> parameter with a
4042
+ * valid IoT Core thing name.</p>
4006
4043
  * @public
4007
4044
  */
4008
4045
  export interface GatewayPlatform {
@@ -4037,12 +4074,17 @@ export interface CreateGatewayRequest {
4037
4074
  */
4038
4075
  gatewayPlatform: GatewayPlatform | undefined;
4039
4076
  /**
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>
4077
+ * <p>The version of the gateway to create. Specify <code>3</code> to create an MQTT-enabled, V3
4078
+ * gateway and <code>2</code> to create a Classic streams, V2 gateway. If not specified, the
4079
+ * default is <code>2</code> (Classic streams, V2 gateway).</p>
4041
4080
  * <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>
4081
+ * <p>When creating a V3 gateway (<code>gatewayVersion=3</code>) with the
4082
+ * <code>GreengrassV2</code> platform, you must also specify the
4083
+ * <code>coreDeviceOperatingSystem</code> parameter.</p>
4043
4084
  * </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>
4085
+ * <p> We recommend creating an MQTT-enabled gateway for self-hosted gateways and Siemens
4086
+ * Industrial Edge gateways. For more 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
4087
+ * gateways</a>.</p>
4046
4088
  * @public
4047
4089
  */
4048
4090
  gatewayVersion?: string | undefined;
@@ -4512,6 +4554,57 @@ export interface DeleteAssetModelCompositeModelResponse {
4512
4554
  */
4513
4555
  assetModelStatus: AssetModelStatus | undefined;
4514
4556
  }
4557
+ /**
4558
+ * @public
4559
+ */
4560
+ export interface DeleteAssetModelInterfaceRelationshipRequest {
4561
+ /**
4562
+ * <p>The ID of the asset model. This can be either the actual ID in UUID format, or else
4563
+ * externalId: followed by the external ID.</p>
4564
+ * @public
4565
+ */
4566
+ assetModelId: string | undefined;
4567
+ /**
4568
+ * <p>The ID of the interface asset model. This can be either the actual ID in UUID format, or
4569
+ * else externalId: followed by the external ID.</p>
4570
+ * @public
4571
+ */
4572
+ interfaceAssetModelId: string | undefined;
4573
+ /**
4574
+ * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the
4575
+ * request. Don't reuse this client token if a new idempotent request is required.</p>
4576
+ * @public
4577
+ */
4578
+ clientToken?: string | undefined;
4579
+ }
4580
+ /**
4581
+ * @public
4582
+ */
4583
+ export interface DeleteAssetModelInterfaceRelationshipResponse {
4584
+ /**
4585
+ * <p>The ID of the asset model.</p>
4586
+ * @public
4587
+ */
4588
+ assetModelId: string | undefined;
4589
+ /**
4590
+ * <p>The ID of the interface asset model.</p>
4591
+ * @public
4592
+ */
4593
+ interfaceAssetModelId: string | undefined;
4594
+ /**
4595
+ * <p>The ARN of the asset model, which has the following format.
4596
+ * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset-model/$\{AssetModelId\}</code>
4597
+ * </p>
4598
+ * @public
4599
+ */
4600
+ assetModelArn: string | undefined;
4601
+ /**
4602
+ * <p>Contains current status information for an asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html">Asset and model
4603
+ * states</a> in the <i>IoT SiteWise User Guide</i>.</p>
4604
+ * @public
4605
+ */
4606
+ assetModelStatus: AssetModelStatus | undefined;
4607
+ }
4515
4608
  /**
4516
4609
  * @public
4517
4610
  */
@@ -4532,7 +4625,8 @@ export interface DeleteComputationModelRequest {
4532
4625
  */
4533
4626
  export interface DeleteComputationModelResponse {
4534
4627
  /**
4535
- * <p>The status of the computation model. It contains a state (DELETING after successfully calling this operation) and any error messages.</p>
4628
+ * <p>The status of the computation model. It contains a state (DELETING after successfully
4629
+ * calling this operation) and any error messages.</p>
4536
4630
  * @public
4537
4631
  */
4538
4632
  computationModelStatus: ComputationModelStatus | undefined;
@@ -4959,6 +5053,18 @@ export interface DescribeAssetModelRequest {
4959
5053
  */
4960
5054
  assetModelVersion?: string | undefined;
4961
5055
  }
5056
+ /**
5057
+ * <p>Contains information about the relationship between an asset model and an interface asset
5058
+ * model that is applied to it.</p>
5059
+ * @public
5060
+ */
5061
+ export interface InterfaceRelationship {
5062
+ /**
5063
+ * <p>The ID of the asset model that has the interface applied to it.</p>
5064
+ * @public
5065
+ */
5066
+ id: string | undefined;
5067
+ }
4962
5068
  /**
4963
5069
  * @public
4964
5070
  */
@@ -5056,6 +5162,12 @@ export interface DescribeAssetModelResponse {
5056
5162
  * @public
5057
5163
  */
5058
5164
  assetModelVersion?: string | undefined;
5165
+ /**
5166
+ * <p>A list of interface details that describe the interfaces implemented by this asset model,
5167
+ * including interface asset model IDs and property mappings.</p>
5168
+ * @public
5169
+ */
5170
+ interfaceDetails?: InterfaceRelationship[] | undefined;
5059
5171
  /**
5060
5172
  * <p>The entity tag (ETag) is a hash of the retrieved version of the asset model. It's used to make
5061
5173
  * concurrent updates safely to the resource. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html">Optimistic locking for asset model writes</a>
@@ -5182,6 +5294,84 @@ export interface DescribeAssetModelCompositeModelResponse {
5182
5294
  */
5183
5295
  actionDefinitions?: ActionDefinition[] | undefined;
5184
5296
  }
5297
+ /**
5298
+ * @public
5299
+ */
5300
+ export interface DescribeAssetModelInterfaceRelationshipRequest {
5301
+ /**
5302
+ * <p>The ID of the asset model. This can be either the actual ID in UUID format, or else
5303
+ * externalId: followed by the external ID.</p>
5304
+ * @public
5305
+ */
5306
+ assetModelId: string | undefined;
5307
+ /**
5308
+ * <p>The ID of the interface asset model. This can be either the actual ID in UUID format, or
5309
+ * else externalId: followed by the external ID.</p>
5310
+ * @public
5311
+ */
5312
+ interfaceAssetModelId: string | undefined;
5313
+ }
5314
+ /**
5315
+ * <p>Maps a hierarchy from an interface asset model to a hierarchy in the asset model where the
5316
+ * interface is applied.</p>
5317
+ * @public
5318
+ */
5319
+ export interface HierarchyMapping {
5320
+ /**
5321
+ * <p>The ID of the hierarchy in the asset model where the interface is applied.</p>
5322
+ * @public
5323
+ */
5324
+ assetModelHierarchyId: string | undefined;
5325
+ /**
5326
+ * <p>The ID of the hierarchy in the interface asset model.</p>
5327
+ * @public
5328
+ */
5329
+ interfaceAssetModelHierarchyId: string | undefined;
5330
+ }
5331
+ /**
5332
+ * <p>Maps a property from an interface asset model to a property in the asset model where the
5333
+ * interface is applied.</p>
5334
+ * @public
5335
+ */
5336
+ export interface PropertyMapping {
5337
+ /**
5338
+ * <p>The ID of the property in the asset model where the interface is applied.</p>
5339
+ * @public
5340
+ */
5341
+ assetModelPropertyId: string | undefined;
5342
+ /**
5343
+ * <p>The ID of the property in the interface asset model.</p>
5344
+ * @public
5345
+ */
5346
+ interfaceAssetModelPropertyId: string | undefined;
5347
+ }
5348
+ /**
5349
+ * @public
5350
+ */
5351
+ export interface DescribeAssetModelInterfaceRelationshipResponse {
5352
+ /**
5353
+ * <p>The ID of the asset model.</p>
5354
+ * @public
5355
+ */
5356
+ assetModelId: string | undefined;
5357
+ /**
5358
+ * <p>The ID of the interface asset model.</p>
5359
+ * @public
5360
+ */
5361
+ interfaceAssetModelId: string | undefined;
5362
+ /**
5363
+ * <p>A list of property mappings between the interface asset model and the asset model where
5364
+ * the interface is applied.</p>
5365
+ * @public
5366
+ */
5367
+ propertyMappings: PropertyMapping[] | undefined;
5368
+ /**
5369
+ * <p>A list of hierarchy mappings between the interface asset model and the asset model where
5370
+ * the interface is applied.</p>
5371
+ * @public
5372
+ */
5373
+ hierarchyMappings: HierarchyMapping[] | undefined;
5374
+ }
5185
5375
  /**
5186
5376
  * @public
5187
5377
  */
@@ -5739,7 +5929,8 @@ export interface DescribeExecutionResponse {
5739
5929
  */
5740
5930
  actionType?: string | undefined;
5741
5931
  /**
5742
- * <p>The resource the action will be taken on.</p>
5932
+ * <p>The resource the action will be taken on. This can include asset-based resources and
5933
+ * computation model resources.</p>
5743
5934
  * @public
5744
5935
  */
5745
5936
  targetResource: TargetResource | undefined;
@@ -5774,23 +5965,18 @@ export interface DescribeExecutionResponse {
5774
5965
  */
5775
5966
  executionResult?: Record<string, string> | undefined;
5776
5967
  /**
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>
5968
+ * <p>Provides detailed information about the execution of your anomaly detection models. This
5969
+ * includes model metrics and training timestamps for both training and inference actions.</p>
5779
5970
  * <ul>
5780
5971
  * <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>
5972
+ * <p> The training action (Amazon Web Services/ANOMALY_DETECTION_TRAINING), includes performance metrics
5973
+ * that help you compare different versions of your anomaly detection models. These metrics
5974
+ * provide insights into the model's performance during the training process. </p>
5787
5975
  * </li>
5788
5976
  * <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>
5977
+ * <p> The inference action (Amazon Web Services/ANOMALY_DETECTION_INFERENCE), includes information about
5978
+ * the results of executing your anomaly detection models. This helps you understand the
5979
+ * output of your models and assess their performance. </p>
5794
5980
  * </li>
5795
5981
  * </ul>
5796
5982
  * @public
@@ -7077,300 +7263,6 @@ export interface Location {
7077
7263
  */
7078
7264
  uri?: string | undefined;
7079
7265
  }
7080
- /**
7081
- * <p>The data source for the dataset.</p>
7082
- * @public
7083
- */
7084
- export interface Source {
7085
- /**
7086
- * <p>Contains the ARN of the dataset. If the source is Kendra, it's the ARN of the Kendra index.</p>
7087
- * @public
7088
- */
7089
- arn?: string | undefined;
7090
- /**
7091
- * <p>Contains the location information where the cited text is originally stored.
7092
- * For example, if the data source is Kendra, and the text synchronized is from an S3 bucket, then the location refers to an S3 object.</p>
7093
- * @public
7094
- */
7095
- location?: Location | undefined;
7096
- }
7097
- /**
7098
- * <p>Contains information about the dataset use and it's source.</p>
7099
- * @public
7100
- */
7101
- export interface DataSetReference {
7102
- /**
7103
- * <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">ARN</a> of the dataset.
7104
- * The format is <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:dataset/$\{DatasetId\}</code>.</p>
7105
- * @public
7106
- */
7107
- datasetArn?: string | undefined;
7108
- /**
7109
- * <p>The data source for the dataset.</p>
7110
- * @public
7111
- */
7112
- source?: Source | undefined;
7113
- }
7114
- /**
7115
- * <p>Contains the reference information.</p>
7116
- * @public
7117
- */
7118
- export interface Reference {
7119
- /**
7120
- * <p>Contains the dataset reference information.</p>
7121
- * @public
7122
- */
7123
- dataset?: DataSetReference | undefined;
7124
- }
7125
- /**
7126
- * <p>Contains text content to which the SiteWise Assistant refers to, and generate the final response.
7127
- * It also contains information about the source.</p>
7128
- * @public
7129
- */
7130
- export interface Citation {
7131
- /**
7132
- * <p>Contains information about the data source.</p>
7133
- * @public
7134
- */
7135
- reference?: Reference | undefined;
7136
- /**
7137
- * <p>Contains the cited text from the data source.</p>
7138
- * @public
7139
- */
7140
- content?: Content | undefined;
7141
- }
7142
- /**
7143
- * <p>This contains the SiteWise Assistant's response and the corresponding citation.</p>
7144
- * @public
7145
- */
7146
- export interface InvocationOutput {
7147
- /**
7148
- * <p>The text message of the SiteWise Assistant's response.</p>
7149
- * @public
7150
- */
7151
- message?: string | undefined;
7152
- /**
7153
- * <p>A list of citations, and related information for the SiteWise Assistant's response.</p>
7154
- * @public
7155
- */
7156
- citations?: Citation[] | undefined;
7157
- }
7158
- /**
7159
- * <p>Contains tracing information of the SiteWise Assistant's reasoning and data access.</p>
7160
- * @public
7161
- */
7162
- export interface Trace {
7163
- /**
7164
- * <p>The cited text from the data source.</p>
7165
- * @public
7166
- */
7167
- text?: string | undefined;
7168
- }
7169
- /**
7170
- * <p>Contains the response, citation, and trace from the SiteWise Assistant.</p>
7171
- * @public
7172
- */
7173
- export type ResponseStream = ResponseStream.AccessDeniedExceptionMember | ResponseStream.ConflictingOperationExceptionMember | ResponseStream.InternalFailureExceptionMember | ResponseStream.InvalidRequestExceptionMember | ResponseStream.LimitExceededExceptionMember | ResponseStream.OutputMember | ResponseStream.ResourceNotFoundExceptionMember | ResponseStream.ThrottlingExceptionMember | ResponseStream.TraceMember | ResponseStream.$UnknownMember;
7174
- /**
7175
- * @public
7176
- */
7177
- export declare namespace ResponseStream {
7178
- /**
7179
- * <p>Contains tracing information of the SiteWise Assistant's reasoning and data access.</p>
7180
- * @public
7181
- */
7182
- interface TraceMember {
7183
- trace: Trace;
7184
- output?: never;
7185
- accessDeniedException?: never;
7186
- conflictingOperationException?: never;
7187
- internalFailureException?: never;
7188
- invalidRequestException?: never;
7189
- limitExceededException?: never;
7190
- resourceNotFoundException?: never;
7191
- throttlingException?: never;
7192
- $unknown?: never;
7193
- }
7194
- /**
7195
- * <p>Contains the SiteWise Assistant's response.</p>
7196
- * @public
7197
- */
7198
- interface OutputMember {
7199
- trace?: never;
7200
- output: InvocationOutput;
7201
- accessDeniedException?: never;
7202
- conflictingOperationException?: never;
7203
- internalFailureException?: never;
7204
- invalidRequestException?: never;
7205
- limitExceededException?: never;
7206
- resourceNotFoundException?: never;
7207
- throttlingException?: never;
7208
- $unknown?: never;
7209
- }
7210
- /**
7211
- * <p>Access is denied.</p>
7212
- * @public
7213
- */
7214
- interface AccessDeniedExceptionMember {
7215
- trace?: never;
7216
- output?: never;
7217
- accessDeniedException: AccessDeniedException;
7218
- conflictingOperationException?: never;
7219
- internalFailureException?: never;
7220
- invalidRequestException?: never;
7221
- limitExceededException?: never;
7222
- resourceNotFoundException?: never;
7223
- throttlingException?: never;
7224
- $unknown?: never;
7225
- }
7226
- /**
7227
- * <p>Your request has conflicting operations. This can occur if you're trying to perform more
7228
- * than one operation on the same resource at the same time.</p>
7229
- * @public
7230
- */
7231
- interface ConflictingOperationExceptionMember {
7232
- trace?: never;
7233
- output?: never;
7234
- accessDeniedException?: never;
7235
- conflictingOperationException: ConflictingOperationException;
7236
- internalFailureException?: never;
7237
- invalidRequestException?: never;
7238
- limitExceededException?: never;
7239
- resourceNotFoundException?: never;
7240
- throttlingException?: never;
7241
- $unknown?: never;
7242
- }
7243
- /**
7244
- * <p>IoT SiteWise can't process your request right now. Try again later.</p>
7245
- * @public
7246
- */
7247
- interface InternalFailureExceptionMember {
7248
- trace?: never;
7249
- output?: never;
7250
- accessDeniedException?: never;
7251
- conflictingOperationException?: never;
7252
- internalFailureException: InternalFailureException;
7253
- invalidRequestException?: never;
7254
- limitExceededException?: never;
7255
- resourceNotFoundException?: never;
7256
- throttlingException?: never;
7257
- $unknown?: never;
7258
- }
7259
- /**
7260
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
7261
- * unsupported characters. Check your request and try again.</p>
7262
- * @public
7263
- */
7264
- interface InvalidRequestExceptionMember {
7265
- trace?: never;
7266
- output?: never;
7267
- accessDeniedException?: never;
7268
- conflictingOperationException?: never;
7269
- internalFailureException?: never;
7270
- invalidRequestException: InvalidRequestException;
7271
- limitExceededException?: never;
7272
- resourceNotFoundException?: never;
7273
- throttlingException?: never;
7274
- $unknown?: never;
7275
- }
7276
- /**
7277
- * <p>You've reached the quota for a resource. For example, this can occur if you're trying to
7278
- * associate more than the allowed number of child assets or attempting to create more than the
7279
- * allowed number of properties for an asset model.</p>
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>
7281
- * @public
7282
- */
7283
- interface LimitExceededExceptionMember {
7284
- trace?: never;
7285
- output?: never;
7286
- accessDeniedException?: never;
7287
- conflictingOperationException?: never;
7288
- internalFailureException?: never;
7289
- invalidRequestException?: never;
7290
- limitExceededException: LimitExceededException;
7291
- resourceNotFoundException?: never;
7292
- throttlingException?: never;
7293
- $unknown?: never;
7294
- }
7295
- /**
7296
- * <p>The requested resource can't be found.</p>
7297
- * @public
7298
- */
7299
- interface ResourceNotFoundExceptionMember {
7300
- trace?: never;
7301
- output?: never;
7302
- accessDeniedException?: never;
7303
- conflictingOperationException?: never;
7304
- internalFailureException?: never;
7305
- invalidRequestException?: never;
7306
- limitExceededException?: never;
7307
- resourceNotFoundException: ResourceNotFoundException;
7308
- throttlingException?: never;
7309
- $unknown?: never;
7310
- }
7311
- /**
7312
- * <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
7313
- * IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
7314
- * on.</p>
7315
- * <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>
7316
- * @public
7317
- */
7318
- interface ThrottlingExceptionMember {
7319
- trace?: never;
7320
- output?: never;
7321
- accessDeniedException?: never;
7322
- conflictingOperationException?: never;
7323
- internalFailureException?: never;
7324
- invalidRequestException?: never;
7325
- limitExceededException?: never;
7326
- resourceNotFoundException?: never;
7327
- throttlingException: ThrottlingException;
7328
- $unknown?: never;
7329
- }
7330
- /**
7331
- * @public
7332
- */
7333
- interface $UnknownMember {
7334
- trace?: never;
7335
- output?: never;
7336
- accessDeniedException?: never;
7337
- conflictingOperationException?: never;
7338
- internalFailureException?: never;
7339
- invalidRequestException?: never;
7340
- limitExceededException?: never;
7341
- resourceNotFoundException?: never;
7342
- throttlingException?: never;
7343
- $unknown: [string, any];
7344
- }
7345
- interface Visitor<T> {
7346
- trace: (value: Trace) => T;
7347
- output: (value: InvocationOutput) => T;
7348
- accessDeniedException: (value: AccessDeniedException) => T;
7349
- conflictingOperationException: (value: ConflictingOperationException) => T;
7350
- internalFailureException: (value: InternalFailureException) => T;
7351
- invalidRequestException: (value: InvalidRequestException) => T;
7352
- limitExceededException: (value: LimitExceededException) => T;
7353
- resourceNotFoundException: (value: ResourceNotFoundException) => T;
7354
- throttlingException: (value: ThrottlingException) => T;
7355
- _: (name: string, value: any) => T;
7356
- }
7357
- const visit: <T>(value: ResponseStream, visitor: Visitor<T>) => T;
7358
- }
7359
- /**
7360
- * @public
7361
- */
7362
- export interface InvokeAssistantResponse {
7363
- /**
7364
- * <p>Contains the response, citation, and trace from the SiteWise Assistant.</p>
7365
- * @public
7366
- */
7367
- body: AsyncIterable<ResponseStream> | undefined;
7368
- /**
7369
- * <p>The ID of the conversation, in UUID format. This ID uniquely identifies the conversation within IoT SiteWise.</p>
7370
- * @public
7371
- */
7372
- conversationId: string | undefined;
7373
- }
7374
7266
  /**
7375
7267
  * @internal
7376
7268
  */
@@ -7383,11 +7275,3 @@ export declare const DescribePortalResponseFilterSensitiveLog: (obj: DescribePor
7383
7275
  * @internal
7384
7276
  */
7385
7277
  export declare const InvokeAssistantRequestFilterSensitiveLog: (obj: InvokeAssistantRequest) => any;
7386
- /**
7387
- * @internal
7388
- */
7389
- export declare const ResponseStreamFilterSensitiveLog: (obj: ResponseStream) => any;
7390
- /**
7391
- * @internal
7392
- */
7393
- export declare const InvokeAssistantResponseFilterSensitiveLog: (obj: InvokeAssistantResponse) => any;