@aws-sdk/client-iotsitewise 3.614.0 → 3.619.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.
- package/dist-cjs/index.js +6 -5
- package/dist-es/IoTSiteWiseClient.js +5 -5
- package/dist-es/models/models_0.js +1 -0
- package/dist-types/IoTSiteWiseClient.d.ts +2 -2
- package/dist-types/commands/CreateAssetModelCommand.d.ts +8 -5
- package/dist-types/commands/CreateAssetModelCompositeModelCommand.d.ts +17 -11
- package/dist-types/commands/CreateBulkImportJobCommand.d.ts +2 -2
- package/dist-types/commands/CreateGatewayCommand.d.ts +3 -0
- package/dist-types/commands/DeleteAssetModelCompositeModelCommand.d.ts +4 -4
- package/dist-types/commands/DeleteGatewayCommand.d.ts +4 -0
- package/dist-types/commands/DescribeAssetCompositeModelCommand.d.ts +4 -2
- package/dist-types/commands/DescribeAssetModelCompositeModelCommand.d.ts +3 -1
- package/dist-types/commands/DescribeGatewayCapabilityConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGatewayCommand.d.ts +4 -1
- package/dist-types/commands/ExecuteQueryCommand.d.ts +2 -1
- package/dist-types/commands/ListCompositionRelationshipsCommand.d.ts +2 -1
- package/dist-types/commands/ListGatewaysCommand.d.ts +4 -1
- package/dist-types/commands/ListTimeSeriesCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAssetModelCommand.d.ts +14 -6
- package/dist-types/commands/UpdateAssetModelCompositeModelCommand.d.ts +13 -9
- package/dist-types/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +116 -124
- package/dist-types/models/models_1.d.ts +32 -11
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +2 -2
- package/dist-types/ts3.4/commands/ListTimeSeriesCommand.d.ts +2 -4
- package/dist-types/ts3.4/models/models_0.d.ts +5 -4
- package/dist-types/ts3.4/models/models_1.d.ts +5 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
- package/package.json +17 -17
|
@@ -67,8 +67,8 @@ export interface UserIdentity {
|
|
|
67
67
|
/**
|
|
68
68
|
* <p>Contains an identity that can access an IoT SiteWise Monitor resource.</p>
|
|
69
69
|
* <note>
|
|
70
|
-
* <p>Currently, you can't use Amazon Web Services API operations to retrieve IAM Identity Center identity IDs. You can
|
|
71
|
-
* IAM Identity Center identity IDs in the URL of user and group pages in the <a href="https://console.aws.amazon.com/singlesignon">IAM Identity Center console</a>.</p>
|
|
70
|
+
* <p>Currently, you can't use Amazon Web Services API operations to retrieve IAM Identity Center identity IDs. You can
|
|
71
|
+
* find the IAM Identity Center identity IDs in the URL of user and group pages in the <a href="https://console.aws.amazon.com/singlesignon">IAM Identity Center console</a>.</p>
|
|
72
72
|
* </note>
|
|
73
73
|
* @public
|
|
74
74
|
*/
|
|
@@ -497,9 +497,7 @@ export interface AssetCompositeModel {
|
|
|
497
497
|
*/
|
|
498
498
|
properties: AssetProperty[] | undefined;
|
|
499
499
|
/**
|
|
500
|
-
* <p>
|
|
501
|
-
* The ID of the asset composite model.
|
|
502
|
-
* </p>
|
|
500
|
+
* <p> The ID of the asset composite model. </p>
|
|
503
501
|
* @public
|
|
504
502
|
*/
|
|
505
503
|
id?: string;
|
|
@@ -537,8 +535,10 @@ export interface AssetCompositeModelSummary {
|
|
|
537
535
|
id: string | undefined;
|
|
538
536
|
/**
|
|
539
537
|
* <p>An external ID to assign to the asset model.</p>
|
|
540
|
-
* <p>If the composite model is a derived composite model, or one nested inside a component
|
|
541
|
-
*
|
|
538
|
+
* <p>If the composite model is a derived composite model, or one nested inside a component
|
|
539
|
+
* model, you can only set the external ID using <code>UpdateAssetModelCompositeModel</code> and
|
|
540
|
+
* specifying the derived ID of the model or property from the created model it's a part
|
|
541
|
+
* of.</p>
|
|
542
542
|
* @public
|
|
543
543
|
*/
|
|
544
544
|
externalId?: string;
|
|
@@ -624,9 +624,9 @@ export interface AssetHierarchy {
|
|
|
624
624
|
*/
|
|
625
625
|
name: string | undefined;
|
|
626
626
|
/**
|
|
627
|
-
* <p>The external ID of the hierarchy, if it has one. When you update an asset hierarchy,
|
|
628
|
-
*
|
|
629
|
-
*
|
|
627
|
+
* <p>The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you
|
|
628
|
+
* may assign an external ID if it doesn't already have one. You can't change the external ID of
|
|
629
|
+
* an asset hierarchy that already has one. 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>
|
|
630
630
|
* @public
|
|
631
631
|
*/
|
|
632
632
|
externalId?: string;
|
|
@@ -762,14 +762,14 @@ export interface VariableValue {
|
|
|
762
762
|
/**
|
|
763
763
|
* <p>The ID of the property to use as the variable. You can use the property <code>name</code>
|
|
764
764
|
* if it's from the same asset model. If the property has an external ID, you can specify
|
|
765
|
-
*
|
|
765
|
+
* <code>externalId:</code> followed by the external ID. 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>
|
|
766
766
|
* @public
|
|
767
767
|
*/
|
|
768
768
|
propertyId?: string;
|
|
769
769
|
/**
|
|
770
770
|
* <p>The ID of the hierarchy to query for the property ID. You can use the hierarchy's name
|
|
771
|
-
* instead of the hierarchy's ID.
|
|
772
|
-
*
|
|
771
|
+
* instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify
|
|
772
|
+
* <code>externalId:</code> followed by the external ID. 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>
|
|
773
773
|
* <p>You use a hierarchy ID instead of a model ID because you can have several hierarchies
|
|
774
774
|
* using the same model and therefore the same <code>propertyId</code>. For example, you might
|
|
775
775
|
* have separately grouped assets that come from the same asset model. For more information, see
|
|
@@ -1032,15 +1032,15 @@ export interface AssetModelProperty {
|
|
|
1032
1032
|
* <p>The ID of the asset model property.</p>
|
|
1033
1033
|
* <ul>
|
|
1034
1034
|
* <li>
|
|
1035
|
-
* <p>If you are callling <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>
|
|
1036
|
-
*
|
|
1037
|
-
*
|
|
1035
|
+
* <p>If you are callling <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a> to create a
|
|
1036
|
+
* <i>new</i> property: You can specify its ID here, if desired.
|
|
1037
|
+
* IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.
|
|
1038
1038
|
* However, if you prefer to supply your own ID instead, you can specify it here in UUID format.
|
|
1039
1039
|
* If you specify your own ID, it must be globally unique.</p>
|
|
1040
1040
|
* </li>
|
|
1041
1041
|
* <li>
|
|
1042
1042
|
* <p>If you are calling UpdateAssetModel to modify an <i>existing</i>
|
|
1043
|
-
*
|
|
1043
|
+
* property: This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
1044
1044
|
* 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>
|
|
1045
1045
|
* </li>
|
|
1046
1046
|
* </ul>
|
|
@@ -1115,9 +1115,7 @@ export interface AssetModelCompositeModel {
|
|
|
1115
1115
|
*/
|
|
1116
1116
|
properties?: AssetModelProperty[];
|
|
1117
1117
|
/**
|
|
1118
|
-
* <p>
|
|
1119
|
-
* The ID of the asset model composite model.
|
|
1120
|
-
* </p>
|
|
1118
|
+
* <p> The ID of the asset model composite model. </p>
|
|
1121
1119
|
* @public
|
|
1122
1120
|
*/
|
|
1123
1121
|
id?: string;
|
|
@@ -1243,7 +1241,7 @@ export interface AssetModelCompositeModelPathSegment {
|
|
|
1243
1241
|
*/
|
|
1244
1242
|
export interface AssetModelCompositeModelSummary {
|
|
1245
1243
|
/**
|
|
1246
|
-
* <p>The ID of the
|
|
1244
|
+
* <p>The ID of the composite model that this summary describes..</p>
|
|
1247
1245
|
* @public
|
|
1248
1246
|
*/
|
|
1249
1247
|
id: string | undefined;
|
|
@@ -1253,29 +1251,17 @@ export interface AssetModelCompositeModelSummary {
|
|
|
1253
1251
|
*/
|
|
1254
1252
|
externalId?: string;
|
|
1255
1253
|
/**
|
|
1256
|
-
* <p>The name of the
|
|
1254
|
+
* <p>The name of the composite model that this summary describes..</p>
|
|
1257
1255
|
* @public
|
|
1258
1256
|
*/
|
|
1259
1257
|
name: string | undefined;
|
|
1260
1258
|
/**
|
|
1261
|
-
* <p>The type
|
|
1262
|
-
* <ul>
|
|
1263
|
-
* <li>
|
|
1264
|
-
* <p>
|
|
1265
|
-
* <b>ASSET_MODEL</b> – (default) An asset model that you can use to create assets.
|
|
1266
|
-
* Can't be included as a component in another asset model.</p>
|
|
1267
|
-
* </li>
|
|
1268
|
-
* <li>
|
|
1269
|
-
* <p>
|
|
1270
|
-
* <b>COMPONENT_MODEL</b> – A reusable component that you can include in the composite
|
|
1271
|
-
* models of other asset models. You can't create assets directly from this type of asset model. </p>
|
|
1272
|
-
* </li>
|
|
1273
|
-
* </ul>
|
|
1259
|
+
* <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or <code> AWS/L4E_ANOMALY</code>.</p>
|
|
1274
1260
|
* @public
|
|
1275
1261
|
*/
|
|
1276
1262
|
type: string | undefined;
|
|
1277
1263
|
/**
|
|
1278
|
-
* <p>The description of the
|
|
1264
|
+
* <p>The description of the composite model that this summary describes..</p>
|
|
1279
1265
|
* @public
|
|
1280
1266
|
*/
|
|
1281
1267
|
description?: string;
|
|
@@ -1295,8 +1281,8 @@ export interface AssetModelHierarchy {
|
|
|
1295
1281
|
* <p>The ID of the asset model hierarchy. This ID is a <code>hierarchyId</code>.</p>
|
|
1296
1282
|
* <ul>
|
|
1297
1283
|
* <li>
|
|
1298
|
-
* <p>If you are callling <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>
|
|
1299
|
-
*
|
|
1284
|
+
* <p>If you are callling <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a> to create a
|
|
1285
|
+
* <i>new</i> hierarchy: You can specify its ID here, if desired.
|
|
1300
1286
|
* IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.
|
|
1301
1287
|
* However, if you prefer to supply your own ID instead, you can specify it here in UUID format.
|
|
1302
1288
|
* If you specify your own ID, it must be globally unique.</p>
|
|
@@ -1318,7 +1304,7 @@ export interface AssetModelHierarchy {
|
|
|
1318
1304
|
name: string | undefined;
|
|
1319
1305
|
/**
|
|
1320
1306
|
* <p>The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the
|
|
1321
|
-
*
|
|
1307
|
+
* <code>childAssetModelId</code> asset model. IoT SiteWise will always return the actual
|
|
1322
1308
|
* asset model ID for this value. However, when you are specifying this value as part of a call to
|
|
1323
1309
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>, you may provide either the asset model ID or else <code>externalId:</code>
|
|
1324
1310
|
* followed by the asset model's external ID. 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>.
|
|
@@ -1360,8 +1346,8 @@ export interface AssetModelHierarchyDefinition {
|
|
|
1360
1346
|
*/
|
|
1361
1347
|
id?: string;
|
|
1362
1348
|
/**
|
|
1363
|
-
* <p>An external ID to assign to the asset model hierarchy. The external ID must be unique
|
|
1364
|
-
* asset model hierarchies within this asset model. 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>
|
|
1349
|
+
* <p>An external ID to assign to the asset model hierarchy. The external ID must be unique
|
|
1350
|
+
* among asset model hierarchies within this asset model. 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>
|
|
1365
1351
|
* @public
|
|
1366
1352
|
*/
|
|
1367
1353
|
externalId?: string;
|
|
@@ -1404,9 +1390,7 @@ export interface AssetModelPropertySummary {
|
|
|
1404
1390
|
*/
|
|
1405
1391
|
type: PropertyType | undefined;
|
|
1406
1392
|
/**
|
|
1407
|
-
* <p>
|
|
1408
|
-
* The ID of the composite model that contains the asset model property.
|
|
1409
|
-
* </p>
|
|
1393
|
+
* <p> The ID of the composite model that contains the asset model property. </p>
|
|
1410
1394
|
* @public
|
|
1411
1395
|
*/
|
|
1412
1396
|
assetModelCompositeModelId?: string;
|
|
@@ -1612,9 +1596,7 @@ export interface AssetPropertySummary {
|
|
|
1612
1596
|
*/
|
|
1613
1597
|
alias?: string;
|
|
1614
1598
|
/**
|
|
1615
|
-
* <p>
|
|
1616
|
-
* The unit of measure (such as Newtons or RPM) of the asset property.
|
|
1617
|
-
* </p>
|
|
1599
|
+
* <p> The unit of measure (such as Newtons or RPM) of the asset property. </p>
|
|
1618
1600
|
* @public
|
|
1619
1601
|
*/
|
|
1620
1602
|
unit?: string;
|
|
@@ -1625,9 +1607,7 @@ export interface AssetPropertySummary {
|
|
|
1625
1607
|
*/
|
|
1626
1608
|
notification?: PropertyNotification;
|
|
1627
1609
|
/**
|
|
1628
|
-
* <p>
|
|
1629
|
-
* The ID of the composite model that contains the asset property.
|
|
1630
|
-
* </p>
|
|
1610
|
+
* <p> The ID of the composite model that contains the asset property. </p>
|
|
1631
1611
|
* @public
|
|
1632
1612
|
*/
|
|
1633
1613
|
assetCompositeModelId?: string;
|
|
@@ -1670,7 +1650,7 @@ export interface Variant {
|
|
|
1670
1650
|
*/
|
|
1671
1651
|
stringValue?: string;
|
|
1672
1652
|
/**
|
|
1673
|
-
* <p>Asset property data of type integer (number
|
|
1653
|
+
* <p>Asset property data of type integer (whole number).</p>
|
|
1674
1654
|
* @public
|
|
1675
1655
|
*/
|
|
1676
1656
|
integerValue?: number;
|
|
@@ -1848,9 +1828,9 @@ export interface AssociateAssetsRequest {
|
|
|
1848
1828
|
assetId: string | undefined;
|
|
1849
1829
|
/**
|
|
1850
1830
|
* <p>The ID of a hierarchy in the parent asset's 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.
|
|
1851
|
-
* 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>.) Hierarchies allow
|
|
1852
|
-
* of assets to be formed that all come from the same asset model. For more
|
|
1853
|
-
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1831
|
+
* 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>.) Hierarchies allow
|
|
1832
|
+
* different groupings of assets to be formed that all come from the same asset model. For more
|
|
1833
|
+
* information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1854
1834
|
* @public
|
|
1855
1835
|
*/
|
|
1856
1836
|
hierarchyId: string | undefined;
|
|
@@ -2244,7 +2224,7 @@ export interface BatchGetAssetPropertyAggregatesRequest {
|
|
|
2244
2224
|
* </li>
|
|
2245
2225
|
* <li>
|
|
2246
2226
|
* <p>The number of data points in the result set is equal to the value of
|
|
2247
|
-
*
|
|
2227
|
+
* <code>maxResults</code>. The maximum value of <code>maxResults</code> is 4000.</p>
|
|
2248
2228
|
* </li>
|
|
2249
2229
|
* </ul>
|
|
2250
2230
|
* @public
|
|
@@ -3018,7 +2998,7 @@ export interface CreateAssetResponse {
|
|
|
3018
2998
|
*/
|
|
3019
2999
|
export interface CreateAssetModelRequest {
|
|
3020
3000
|
/**
|
|
3021
|
-
* <p>A unique
|
|
3001
|
+
* <p>A unique name for the asset model.</p>
|
|
3022
3002
|
* @public
|
|
3023
3003
|
*/
|
|
3024
3004
|
assetModelName: string | undefined;
|
|
@@ -3051,7 +3031,8 @@ export interface CreateAssetModelRequest {
|
|
|
3051
3031
|
* properties that the composite model supports. Use composite models to define alarms on this asset model.</p>
|
|
3052
3032
|
* <note>
|
|
3053
3033
|
* <p>When creating custom composite models, you need to use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html">CreateAssetModelCompositeModel</a>. For more information,
|
|
3054
|
-
* see <
|
|
3034
|
+
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html">Creating custom composite models (Components)</a> in the
|
|
3035
|
+
* <i>IoT SiteWise User Guide</i>.</p>
|
|
3055
3036
|
* </note>
|
|
3056
3037
|
* @public
|
|
3057
3038
|
*/
|
|
@@ -3138,14 +3119,17 @@ export interface CreateAssetModelCompositeModelRequest {
|
|
|
3138
3119
|
parentAssetModelCompositeModelId?: string;
|
|
3139
3120
|
/**
|
|
3140
3121
|
* <p>An external ID to assign to the composite model.</p>
|
|
3141
|
-
* <p>If the composite model is a derived composite model, or one nested inside a component
|
|
3142
|
-
*
|
|
3122
|
+
* <p>If the composite model is a derived composite model, or one nested inside a component
|
|
3123
|
+
* model, you can only set the external ID using <code>UpdateAssetModelCompositeModel</code> and
|
|
3124
|
+
* specifying the derived ID of the model or property from the created model it's a part
|
|
3125
|
+
* of.</p>
|
|
3143
3126
|
* @public
|
|
3144
3127
|
*/
|
|
3145
3128
|
assetModelCompositeModelExternalId?: string;
|
|
3146
3129
|
/**
|
|
3147
|
-
* <p>The ID of the composite model.
|
|
3148
|
-
* if you prefer to supply your own ID instead, you can
|
|
3130
|
+
* <p>The ID of the composite model. IoT SiteWise automatically generates a unique ID for you, so this
|
|
3131
|
+
* parameter is never required. However, if you prefer to supply your own ID instead, you can
|
|
3132
|
+
* specify it here in UUID format. If you specify your own ID, it must be globally unique.</p>
|
|
3149
3133
|
* @public
|
|
3150
3134
|
*/
|
|
3151
3135
|
assetModelCompositeModelId?: string;
|
|
@@ -3155,7 +3139,7 @@ export interface CreateAssetModelCompositeModelRequest {
|
|
|
3155
3139
|
*/
|
|
3156
3140
|
assetModelCompositeModelDescription?: string;
|
|
3157
3141
|
/**
|
|
3158
|
-
* <p>A unique
|
|
3142
|
+
* <p>A unique name for the composite model.</p>
|
|
3159
3143
|
* @public
|
|
3160
3144
|
*/
|
|
3161
3145
|
assetModelCompositeModelName: string | undefined;
|
|
@@ -3170,12 +3154,13 @@ export interface CreateAssetModelCompositeModelRequest {
|
|
|
3170
3154
|
*/
|
|
3171
3155
|
clientToken?: string;
|
|
3172
3156
|
/**
|
|
3173
|
-
* <p>The ID of a
|
|
3157
|
+
* <p>The ID of a component model which is reused to create this composite model.</p>
|
|
3174
3158
|
* @public
|
|
3175
3159
|
*/
|
|
3176
3160
|
composedAssetModelId?: string;
|
|
3177
3161
|
/**
|
|
3178
|
-
* <p>The property definitions of the composite model. For more information, see <
|
|
3162
|
+
* <p>The property definitions of the composite model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models">
|
|
3163
|
+
* Inline custom composite models</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3179
3164
|
* <p>You can specify up to 200 properties per composite model. For more
|
|
3180
3165
|
* 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>
|
|
3181
3166
|
* @public
|
|
@@ -3187,7 +3172,8 @@ export interface CreateAssetModelCompositeModelRequest {
|
|
|
3187
3172
|
*/
|
|
3188
3173
|
export interface CreateAssetModelCompositeModelResponse {
|
|
3189
3174
|
/**
|
|
3190
|
-
* <p>The ID of the composed asset model. You can use this ID when you call other IoT SiteWise
|
|
3175
|
+
* <p>The ID of the composed asset model. You can use this ID when you call other IoT SiteWise
|
|
3176
|
+
* APIs.</p>
|
|
3191
3177
|
* @public
|
|
3192
3178
|
*/
|
|
3193
3179
|
assetModelCompositeModelId: string | undefined;
|
|
@@ -3479,15 +3465,15 @@ export interface CreateDashboardResponse {
|
|
|
3479
3465
|
export interface Greengrass {
|
|
3480
3466
|
/**
|
|
3481
3467
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Greengrass group. For more information about how to find a group's
|
|
3482
|
-
* ARN, see <a href="https://docs.aws.amazon.com/greengrass/
|
|
3483
|
-
*
|
|
3468
|
+
* ARN, see <a href="https://docs.aws.amazon.com/greengrass/v1/apireference/listgroups-get.html">ListGroups</a> and <a href="https://docs.aws.amazon.com/greengrass/v1/apireference/getgroup-get.html">GetGroup</a> in the <i>IoT Greengrass V1
|
|
3469
|
+
* API Reference</i>.</p>
|
|
3484
3470
|
* @public
|
|
3485
3471
|
*/
|
|
3486
3472
|
groupArn: string | undefined;
|
|
3487
3473
|
}
|
|
3488
3474
|
/**
|
|
3489
|
-
* <p>Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass
|
|
3490
|
-
*
|
|
3475
|
+
* <p>Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass V2,
|
|
3476
|
+
* you must deploy the IoT SiteWise Edge component to your gateway device. Your <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html">Greengrass
|
|
3491
3477
|
* device role</a> must use the <code>AWSIoTSiteWiseEdgeAccess</code> policy. For more
|
|
3492
3478
|
* information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html">Using IoT SiteWise at the edge</a> in the
|
|
3493
3479
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
@@ -3500,6 +3486,17 @@ export interface GreengrassV2 {
|
|
|
3500
3486
|
*/
|
|
3501
3487
|
coreDeviceThingName: string | undefined;
|
|
3502
3488
|
}
|
|
3489
|
+
/**
|
|
3490
|
+
* <p>Contains details for a SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.</p>
|
|
3491
|
+
* @public
|
|
3492
|
+
*/
|
|
3493
|
+
export interface SiemensIE {
|
|
3494
|
+
/**
|
|
3495
|
+
* <p>The name of the IoT Thing for your SiteWise Edge gateway.</p>
|
|
3496
|
+
* @public
|
|
3497
|
+
*/
|
|
3498
|
+
iotCoreThingName: string | undefined;
|
|
3499
|
+
}
|
|
3503
3500
|
/**
|
|
3504
3501
|
* <p>Contains a gateway's platform information.</p>
|
|
3505
3502
|
* @public
|
|
@@ -3515,13 +3512,18 @@ export interface GatewayPlatform {
|
|
|
3515
3512
|
* @public
|
|
3516
3513
|
*/
|
|
3517
3514
|
greengrassV2?: GreengrassV2;
|
|
3515
|
+
/**
|
|
3516
|
+
* <p>A SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.</p>
|
|
3517
|
+
* @public
|
|
3518
|
+
*/
|
|
3519
|
+
siemensIE?: SiemensIE;
|
|
3518
3520
|
}
|
|
3519
3521
|
/**
|
|
3520
3522
|
* @public
|
|
3521
3523
|
*/
|
|
3522
3524
|
export interface CreateGatewayRequest {
|
|
3523
3525
|
/**
|
|
3524
|
-
* <p>A unique
|
|
3526
|
+
* <p>A unique name for the gateway.</p>
|
|
3525
3527
|
* @public
|
|
3526
3528
|
*/
|
|
3527
3529
|
gatewayName: string | undefined;
|
|
@@ -4131,9 +4133,7 @@ export interface DescribeAssetRequest {
|
|
|
4131
4133
|
*/
|
|
4132
4134
|
assetId: string | undefined;
|
|
4133
4135
|
/**
|
|
4134
|
-
* <p>
|
|
4135
|
-
* Whether or not to exclude asset properties from the response.
|
|
4136
|
-
* </p>
|
|
4136
|
+
* <p> Whether or not to exclude asset properties from the response. </p>
|
|
4137
4137
|
* @public
|
|
4138
4138
|
*/
|
|
4139
4139
|
excludeProperties?: boolean;
|
|
@@ -4247,8 +4247,10 @@ export interface DescribeAssetCompositeModelResponse {
|
|
|
4247
4247
|
assetCompositeModelId: string | undefined;
|
|
4248
4248
|
/**
|
|
4249
4249
|
* <p>An external ID to assign to the asset model.</p>
|
|
4250
|
-
* <p>If the composite model is a component-based composite model, or one nested inside a
|
|
4251
|
-
*
|
|
4250
|
+
* <p>If the composite model is a component-based composite model, or one nested inside a
|
|
4251
|
+
* component model, you can only set the external ID using
|
|
4252
|
+
* <code>UpdateAssetModelCompositeModel</code> and specifying the derived ID of the model or
|
|
4253
|
+
* property from the created model it's a part of.</p>
|
|
4252
4254
|
* @public
|
|
4253
4255
|
*/
|
|
4254
4256
|
assetCompositeModelExternalId?: string;
|
|
@@ -4268,7 +4270,8 @@ export interface DescribeAssetCompositeModelResponse {
|
|
|
4268
4270
|
*/
|
|
4269
4271
|
assetCompositeModelDescription: string | undefined;
|
|
4270
4272
|
/**
|
|
4271
|
-
* <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or
|
|
4273
|
+
* <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or
|
|
4274
|
+
* <code> AWS/L4E_ANOMALY</code>.</p>
|
|
4272
4275
|
* @public
|
|
4273
4276
|
*/
|
|
4274
4277
|
assetCompositeModelType: string | undefined;
|
|
@@ -4299,9 +4302,7 @@ export interface DescribeAssetModelRequest {
|
|
|
4299
4302
|
*/
|
|
4300
4303
|
assetModelId: string | undefined;
|
|
4301
4304
|
/**
|
|
4302
|
-
* <p>
|
|
4303
|
-
* Whether or not to exclude asset model properties from the response.
|
|
4304
|
-
* </p>
|
|
4305
|
+
* <p> Whether or not to exclude asset model properties from the response. </p>
|
|
4305
4306
|
* @public
|
|
4306
4307
|
*/
|
|
4307
4308
|
excludeProperties?: boolean;
|
|
@@ -4348,7 +4349,8 @@ export interface DescribeAssetModelResponse {
|
|
|
4348
4349
|
*/
|
|
4349
4350
|
assetModelHierarchies: AssetModelHierarchy[] | undefined;
|
|
4350
4351
|
/**
|
|
4351
|
-
* <p>The list of built-in composite models for the asset model, such as those with those of
|
|
4352
|
+
* <p>The list of built-in composite models for the asset model, such as those with those of
|
|
4353
|
+
* type <code>AWS/ALARMS</code>.</p>
|
|
4352
4354
|
* @public
|
|
4353
4355
|
*/
|
|
4354
4356
|
assetModelCompositeModels?: AssetModelCompositeModel[];
|
|
@@ -4386,7 +4388,8 @@ export interface DescribeAssetModelResponse {
|
|
|
4386
4388
|
*/
|
|
4387
4389
|
assetModelType?: AssetModelType;
|
|
4388
4390
|
/**
|
|
4389
|
-
* <p>The list of the immediate child custom composite model summaries for the asset
|
|
4391
|
+
* <p>The list of the immediate child custom composite model summaries for the asset
|
|
4392
|
+
* model.</p>
|
|
4390
4393
|
* @public
|
|
4391
4394
|
*/
|
|
4392
4395
|
assetModelCompositeModelSummaries?: AssetModelCompositeModelSummary[];
|
|
@@ -4414,7 +4417,8 @@ export interface DescribeAssetModelCompositeModelRequest {
|
|
|
4414
4417
|
assetModelCompositeModelId: string | undefined;
|
|
4415
4418
|
}
|
|
4416
4419
|
/**
|
|
4417
|
-
* <p>Represents a composite model that composed an asset model of type
|
|
4420
|
+
* <p>Represents a composite model that composed an asset model of type
|
|
4421
|
+
* <code>COMPONENT_MODEL</code>.</p>
|
|
4418
4422
|
* @public
|
|
4419
4423
|
*/
|
|
4420
4424
|
export interface CompositionRelationshipItem {
|
|
@@ -4425,7 +4429,8 @@ export interface CompositionRelationshipItem {
|
|
|
4425
4429
|
id?: string;
|
|
4426
4430
|
}
|
|
4427
4431
|
/**
|
|
4428
|
-
* <p>Metadata for the composition relationship established by using
|
|
4432
|
+
* <p>Metadata for the composition relationship established by using
|
|
4433
|
+
* <code>composedAssetModelId</code> in <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html">
|
|
4429
4434
|
* <code>CreateAssetModelCompositeModel</code>
|
|
4430
4435
|
* </a>.</p>
|
|
4431
4436
|
* @public
|
|
@@ -4472,7 +4477,8 @@ export interface DescribeAssetModelCompositeModelResponse {
|
|
|
4472
4477
|
*/
|
|
4473
4478
|
assetModelCompositeModelDescription: string | undefined;
|
|
4474
4479
|
/**
|
|
4475
|
-
* <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or
|
|
4480
|
+
* <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or
|
|
4481
|
+
* <code> AWS/L4E_ANOMALY</code>.</p>
|
|
4476
4482
|
* @public
|
|
4477
4483
|
*/
|
|
4478
4484
|
assetModelCompositeModelType: string | undefined;
|
|
@@ -4482,10 +4488,11 @@ export interface DescribeAssetModelCompositeModelResponse {
|
|
|
4482
4488
|
*/
|
|
4483
4489
|
assetModelCompositeModelProperties: AssetModelProperty[] | undefined;
|
|
4484
4490
|
/**
|
|
4485
|
-
* <p>Metadata for the composition relationship established by using
|
|
4491
|
+
* <p>Metadata for the composition relationship established by using
|
|
4492
|
+
* <code>composedAssetModelId</code> in <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html">
|
|
4486
4493
|
* <code>CreateAssetModelCompositeModel</code>
|
|
4487
|
-
* </a>.
|
|
4488
|
-
*
|
|
4494
|
+
* </a>. For instance, an array detailing the
|
|
4495
|
+
* path of the composition relationship for this composite model.</p>
|
|
4489
4496
|
* @public
|
|
4490
4497
|
*/
|
|
4491
4498
|
compositionDetails?: CompositionDetails;
|
|
@@ -4592,9 +4599,7 @@ export interface CompositeModelProperty {
|
|
|
4592
4599
|
*/
|
|
4593
4600
|
assetProperty: Property | undefined;
|
|
4594
4601
|
/**
|
|
4595
|
-
* <p>
|
|
4596
|
-
* The ID of the composite model that contains the property.
|
|
4597
|
-
* </p>
|
|
4602
|
+
* <p> The ID of the composite model that contains the property. </p>
|
|
4598
4603
|
* @public
|
|
4599
4604
|
*/
|
|
4600
4605
|
id?: string;
|
|
@@ -4632,8 +4637,8 @@ export interface DescribeAssetPropertyResponse {
|
|
|
4632
4637
|
*/
|
|
4633
4638
|
assetProperty?: Property;
|
|
4634
4639
|
/**
|
|
4635
|
-
* <p>The composite model that declares this asset property, if this asset property exists
|
|
4636
|
-
*
|
|
4640
|
+
* <p>The composite model that declares this asset property, if this asset property exists in a
|
|
4641
|
+
* composite model.</p>
|
|
4637
4642
|
* @public
|
|
4638
4643
|
*/
|
|
4639
4644
|
compositeModel?: CompositeModelProperty;
|
|
@@ -4902,6 +4907,7 @@ export interface DescribeGatewayRequest {
|
|
|
4902
4907
|
*/
|
|
4903
4908
|
export declare const CapabilitySyncStatus: {
|
|
4904
4909
|
readonly IN_SYNC: "IN_SYNC";
|
|
4910
|
+
readonly NOT_APPLICABLE: "NOT_APPLICABLE";
|
|
4905
4911
|
readonly OUT_OF_SYNC: "OUT_OF_SYNC";
|
|
4906
4912
|
readonly SYNC_FAILED: "SYNC_FAILED";
|
|
4907
4913
|
readonly UNKNOWN: "UNKNOWN";
|
|
@@ -5524,16 +5530,17 @@ export interface DescribeTimeSeriesResponse {
|
|
|
5524
5530
|
*/
|
|
5525
5531
|
export interface DisassociateAssetsRequest {
|
|
5526
5532
|
/**
|
|
5527
|
-
* <p>The ID of the parent asset from which to disassociate the child asset.
|
|
5533
|
+
* <p>The ID of the parent asset from which to disassociate the child asset.
|
|
5534
|
+
* This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
5528
5535
|
* 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>
|
|
5529
5536
|
* @public
|
|
5530
5537
|
*/
|
|
5531
5538
|
assetId: string | undefined;
|
|
5532
5539
|
/**
|
|
5533
5540
|
* <p>The ID of a hierarchy in the parent asset's 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.
|
|
5534
|
-
* 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>.) Hierarchies allow
|
|
5535
|
-
* of assets to be formed that all come from the same asset model. You can
|
|
5536
|
-
* to identify the correct asset to disassociate. For more information, see
|
|
5541
|
+
* 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>.) Hierarchies allow
|
|
5542
|
+
* different groupings of assets to be formed that all come from the same asset model. You can
|
|
5543
|
+
* use the hierarchy ID to identify the correct asset to disassociate. For more information, see
|
|
5537
5544
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
5538
5545
|
* @public
|
|
5539
5546
|
*/
|
|
@@ -5766,7 +5773,7 @@ export interface GetAssetPropertyAggregatesRequest {
|
|
|
5766
5773
|
* </li>
|
|
5767
5774
|
* <li>
|
|
5768
5775
|
* <p>The number of data points in the result set is equal to the value of
|
|
5769
|
-
*
|
|
5776
|
+
* <code>maxResults</code>. The maximum value of <code>maxResults</code> is 2500.</p>
|
|
5770
5777
|
* </li>
|
|
5771
5778
|
* </ul>
|
|
5772
5779
|
* @public
|
|
@@ -5879,7 +5886,7 @@ export interface GetAssetPropertyValueHistoryRequest {
|
|
|
5879
5886
|
* </li>
|
|
5880
5887
|
* <li>
|
|
5881
5888
|
* <p>The number of data points in the result set is equal to the value of
|
|
5882
|
-
*
|
|
5889
|
+
* <code>maxResults</code>. The maximum value of <code>maxResults</code> is 20000.</p>
|
|
5883
5890
|
* </li>
|
|
5884
5891
|
* </ul>
|
|
5885
5892
|
* @public
|
|
@@ -6387,13 +6394,13 @@ export interface ListAssetPropertiesRequest {
|
|
|
6387
6394
|
* <ul>
|
|
6388
6395
|
* <li>
|
|
6389
6396
|
* <p>
|
|
6390
|
-
* <code>ALL</code> – The list includes all asset properties for a given asset
|
|
6391
|
-
*
|
|
6397
|
+
* <code>ALL</code> – The list includes all asset properties for a given asset model ID.
|
|
6398
|
+
* </p>
|
|
6392
6399
|
* </li>
|
|
6393
6400
|
* <li>
|
|
6394
6401
|
* <p>
|
|
6395
|
-
* <code>BASE</code> – The list includes only base asset properties for a given
|
|
6396
|
-
*
|
|
6402
|
+
* <code>BASE</code> – The list includes only base asset properties for a given asset
|
|
6403
|
+
* model ID. </p>
|
|
6397
6404
|
* </li>
|
|
6398
6405
|
* </ul>
|
|
6399
6406
|
* <p>Default: <code>BASE</code>
|
|
@@ -6571,11 +6578,10 @@ export interface ListAssociatedAssetsRequest {
|
|
|
6571
6578
|
*/
|
|
6572
6579
|
assetId: string | undefined;
|
|
6573
6580
|
/**
|
|
6574
|
-
* <p>The ID of the hierarchy by which child assets are associated to the asset.
|
|
6575
|
-
*
|
|
6576
|
-
*
|
|
6577
|
-
*
|
|
6578
|
-
* <code>traversalDirection</code>.</p>
|
|
6581
|
+
* <p>The ID of the hierarchy by which child assets are associated to the asset.
|
|
6582
|
+
* (This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
6583
|
+
* 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>.) To find a hierarchy ID, use the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html">DescribeAsset</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html">DescribeAssetModel</a> operations. This parameter is required if you choose
|
|
6584
|
+
* <code>CHILD</code> for <code>traversalDirection</code>.</p>
|
|
6579
6585
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6580
6586
|
* @public
|
|
6581
6587
|
*/
|
|
@@ -6765,7 +6771,8 @@ export interface CompositionRelationshipSummary {
|
|
|
6765
6771
|
*/
|
|
6766
6772
|
assetModelCompositeModelId: string | undefined;
|
|
6767
6773
|
/**
|
|
6768
|
-
* <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or
|
|
6774
|
+
* <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or
|
|
6775
|
+
* <code> AWS/L4E_ANOMALY</code>.</p>
|
|
6769
6776
|
* @public
|
|
6770
6777
|
*/
|
|
6771
6778
|
assetModelCompositeModelType: string | undefined;
|
|
@@ -6879,7 +6886,7 @@ export interface GatewaySummary {
|
|
|
6879
6886
|
*/
|
|
6880
6887
|
gatewayId: string | undefined;
|
|
6881
6888
|
/**
|
|
6882
|
-
* <p>The name of the
|
|
6889
|
+
* <p>The name of the gateway.</p>
|
|
6883
6890
|
* @public
|
|
6884
6891
|
*/
|
|
6885
6892
|
gatewayName: string | undefined;
|
|
@@ -7254,18 +7261,3 @@ export interface TimeSeriesSummary {
|
|
|
7254
7261
|
*/
|
|
7255
7262
|
timeSeriesArn: string | undefined;
|
|
7256
7263
|
}
|
|
7257
|
-
/**
|
|
7258
|
-
* @public
|
|
7259
|
-
*/
|
|
7260
|
-
export interface ListTimeSeriesResponse {
|
|
7261
|
-
/**
|
|
7262
|
-
* <p>One or more time series summaries to list.</p>
|
|
7263
|
-
* @public
|
|
7264
|
-
*/
|
|
7265
|
-
TimeSeriesSummaries: TimeSeriesSummary[] | undefined;
|
|
7266
|
-
/**
|
|
7267
|
-
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
7268
|
-
* @public
|
|
7269
|
-
*/
|
|
7270
|
-
nextToken?: string;
|
|
7271
|
-
}
|