cdk-lambda-subminute 2.0.305 → 2.0.307

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 (46) hide show
  1. package/.jsii +3 -3
  2. package/lib/cdk-lambda-subminute.js +3 -3
  3. package/node_modules/aws-sdk/CHANGELOG.md +14 -1
  4. package/node_modules/aws-sdk/README.md +1 -1
  5. package/node_modules/aws-sdk/apis/cloudfront-2020-05-31.examples.json +251 -0
  6. package/node_modules/aws-sdk/apis/cloudfront-2020-05-31.min.json +349 -106
  7. package/node_modules/aws-sdk/apis/cloudfront-2020-05-31.paginators.json +6 -0
  8. package/node_modules/aws-sdk/apis/cloudfront-keyvaluestore-2022-07-26.examples.json +5 -0
  9. package/node_modules/aws-sdk/apis/cloudfront-keyvaluestore-2022-07-26.min.json +359 -0
  10. package/node_modules/aws-sdk/apis/cloudfront-keyvaluestore-2022-07-26.paginators.json +10 -0
  11. package/node_modules/aws-sdk/apis/inspector-scan-2023-08-08.examples.json +174 -0
  12. package/node_modules/aws-sdk/apis/inspector-scan-2023-08-08.min.json +51 -0
  13. package/node_modules/aws-sdk/apis/inspector-scan-2023-08-08.paginators.json +4 -0
  14. package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.min.json +989 -176
  15. package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.paginators.json +24 -0
  16. package/node_modules/aws-sdk/apis/iottwinmaker-2021-11-29.min.json +729 -131
  17. package/node_modules/aws-sdk/apis/iottwinmaker-2021-11-29.paginators.json +15 -0
  18. package/node_modules/aws-sdk/apis/kinesis-2013-12-02.min.json +92 -21
  19. package/node_modules/aws-sdk/apis/metadata.json +8 -0
  20. package/node_modules/aws-sdk/apis/s3-2006-03-01.examples.json +152 -152
  21. package/node_modules/aws-sdk/apis/s3-2006-03-01.min.json +109 -92
  22. package/node_modules/aws-sdk/apis/s3control-2018-08-20.min.json +112 -84
  23. package/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json +544 -533
  24. package/node_modules/aws-sdk/clients/all.d.ts +2 -0
  25. package/node_modules/aws-sdk/clients/all.js +3 -1
  26. package/node_modules/aws-sdk/clients/cloudfront.d.ts +220 -2
  27. package/node_modules/aws-sdk/clients/cloudfrontkeyvaluestore.d.ts +294 -0
  28. package/node_modules/aws-sdk/clients/cloudfrontkeyvaluestore.js +18 -0
  29. package/node_modules/aws-sdk/clients/ec2.d.ts +12 -12
  30. package/node_modules/aws-sdk/clients/inspectorscan.d.ts +59 -0
  31. package/node_modules/aws-sdk/clients/inspectorscan.js +18 -0
  32. package/node_modules/aws-sdk/clients/iotsitewise.d.ts +1080 -179
  33. package/node_modules/aws-sdk/clients/iottwinmaker.d.ts +666 -9
  34. package/node_modules/aws-sdk/clients/kinesis.d.ts +96 -42
  35. package/node_modules/aws-sdk/clients/s3.d.ts +38 -15
  36. package/node_modules/aws-sdk/clients/s3control.d.ts +35 -3
  37. package/node_modules/aws-sdk/clients/sagemaker.d.ts +13 -2
  38. package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +2 -2
  39. package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +89 -15
  40. package/node_modules/aws-sdk/dist/aws-sdk.js +601 -225
  41. package/node_modules/aws-sdk/dist/aws-sdk.min.js +93 -92
  42. package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +4 -0
  43. package/node_modules/aws-sdk/lib/core.js +1 -1
  44. package/node_modules/aws-sdk/lib/services/s3.js +1 -1
  45. package/node_modules/aws-sdk/package.json +1 -1
  46. package/package.json +3 -4
@@ -93,19 +93,27 @@ declare class IoTSiteWise extends Service {
93
93
  */
94
94
  createAsset(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetResponse) => void): Request<IoTSiteWise.Types.CreateAssetResponse, AWSError>;
95
95
  /**
96
- * Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.
96
+ * Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide. You can create two types of asset models, ASSET_MODEL or COMPONENT_MODEL. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
97
97
  */
98
98
  createAssetModel(params: IoTSiteWise.Types.CreateAssetModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetModelResponse) => void): Request<IoTSiteWise.Types.CreateAssetModelResponse, AWSError>;
99
99
  /**
100
- * Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.
100
+ * Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide. You can create two types of asset models, ASSET_MODEL or COMPONENT_MODEL. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
101
101
  */
102
102
  createAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetModelResponse) => void): Request<IoTSiteWise.Types.CreateAssetModelResponse, AWSError>;
103
103
  /**
104
- * Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide. You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For more information about how to configure storage settings, see PutStorageConfiguration.
104
+ * Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and component-model-based. Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provides its associated properties to any created assets. For more information, see Custom composite models (Components) in the IoT SiteWise User Guide. Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are included and can't be used to create multiple assets. To create a component-model-based model, specify the composedAssetModelId of an existing asset model with assetModelType of COMPONENT_MODEL. To create an inline model, specify the assetModelCompositeModelProperties and don't include an composedAssetModelId.
105
+ */
106
+ createAssetModelCompositeModel(params: IoTSiteWise.Types.CreateAssetModelCompositeModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetModelCompositeModelResponse) => void): Request<IoTSiteWise.Types.CreateAssetModelCompositeModelResponse, AWSError>;
107
+ /**
108
+ * Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and component-model-based. Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provides its associated properties to any created assets. For more information, see Custom composite models (Components) in the IoT SiteWise User Guide. Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are included and can't be used to create multiple assets. To create a component-model-based model, specify the composedAssetModelId of an existing asset model with assetModelType of COMPONENT_MODEL. To create an inline model, specify the assetModelCompositeModelProperties and don't include an composedAssetModelId.
109
+ */
110
+ createAssetModelCompositeModel(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetModelCompositeModelResponse) => void): Request<IoTSiteWise.Types.CreateAssetModelCompositeModelResponse, AWSError>;
111
+ /**
112
+ * Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide. Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration. Bulk import is designed to store historical data to IoT SiteWise. It does not trigger computations or notifications on IoT SiteWise warm or cold tier storage.
105
113
  */
106
114
  createBulkImportJob(params: IoTSiteWise.Types.CreateBulkImportJobRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateBulkImportJobResponse) => void): Request<IoTSiteWise.Types.CreateBulkImportJobResponse, AWSError>;
107
115
  /**
108
- * Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide. You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For more information about how to configure storage settings, see PutStorageConfiguration.
116
+ * Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide. Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration. Bulk import is designed to store historical data to IoT SiteWise. It does not trigger computations or notifications on IoT SiteWise warm or cold tier storage.
109
117
  */
110
118
  createBulkImportJob(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateBulkImportJobResponse) => void): Request<IoTSiteWise.Types.CreateBulkImportJobResponse, AWSError>;
111
119
  /**
@@ -149,11 +157,11 @@ declare class IoTSiteWise extends Service {
149
157
  */
150
158
  deleteAccessPolicy(callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAccessPolicyResponse) => void): Request<IoTSiteWise.Types.DeleteAccessPolicyResponse, AWSError>;
151
159
  /**
152
- * Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide. You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.
160
+ * Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide. You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.
153
161
  */
154
162
  deleteAsset(params: IoTSiteWise.Types.DeleteAssetRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAssetResponse) => void): Request<IoTSiteWise.Types.DeleteAssetResponse, AWSError>;
155
163
  /**
156
- * Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide. You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.
164
+ * Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide. You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.
157
165
  */
158
166
  deleteAsset(callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAssetResponse) => void): Request<IoTSiteWise.Types.DeleteAssetResponse, AWSError>;
159
167
  /**
@@ -164,6 +172,14 @@ declare class IoTSiteWise extends Service {
164
172
  * Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
165
173
  */
166
174
  deleteAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAssetModelResponse) => void): Request<IoTSiteWise.Types.DeleteAssetModelResponse, AWSError>;
175
+ /**
176
+ * Deletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can't delete a composite model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
177
+ */
178
+ deleteAssetModelCompositeModel(params: IoTSiteWise.Types.DeleteAssetModelCompositeModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAssetModelCompositeModelResponse) => void): Request<IoTSiteWise.Types.DeleteAssetModelCompositeModelResponse, AWSError>;
179
+ /**
180
+ * Deletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can't delete a composite model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
181
+ */
182
+ deleteAssetModelCompositeModel(callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAssetModelCompositeModelResponse) => void): Request<IoTSiteWise.Types.DeleteAssetModelCompositeModelResponse, AWSError>;
167
183
  /**
168
184
  * Deletes a dashboard from IoT SiteWise Monitor.
169
185
  */
@@ -212,6 +228,14 @@ declare class IoTSiteWise extends Service {
212
228
  * Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
213
229
  */
214
230
  describeAccessPolicy(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAccessPolicyResponse) => void): Request<IoTSiteWise.Types.DescribeAccessPolicyResponse, AWSError>;
231
+ /**
232
+ * Retrieves information about an action.
233
+ */
234
+ describeAction(params: IoTSiteWise.Types.DescribeActionRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeActionResponse) => void): Request<IoTSiteWise.Types.DescribeActionResponse, AWSError>;
235
+ /**
236
+ * Retrieves information about an action.
237
+ */
238
+ describeAction(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeActionResponse) => void): Request<IoTSiteWise.Types.DescribeActionResponse, AWSError>;
215
239
  /**
216
240
  * Retrieves information about an asset.
217
241
  */
@@ -220,6 +244,14 @@ declare class IoTSiteWise extends Service {
220
244
  * Retrieves information about an asset.
221
245
  */
222
246
  describeAsset(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetResponse) => void): Request<IoTSiteWise.Types.DescribeAssetResponse, AWSError>;
247
+ /**
248
+ * Retrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.
249
+ */
250
+ describeAssetCompositeModel(params: IoTSiteWise.Types.DescribeAssetCompositeModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetCompositeModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetCompositeModelResponse, AWSError>;
251
+ /**
252
+ * Retrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.
253
+ */
254
+ describeAssetCompositeModel(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetCompositeModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetCompositeModelResponse, AWSError>;
223
255
  /**
224
256
  * Retrieves information about an asset model.
225
257
  */
@@ -228,6 +260,14 @@ declare class IoTSiteWise extends Service {
228
260
  * Retrieves information about an asset model.
229
261
  */
230
262
  describeAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetModelResponse, AWSError>;
263
+ /**
264
+ * Retrieves information about an asset model composite model (also known as an asset model component). For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.
265
+ */
266
+ describeAssetModelCompositeModel(params: IoTSiteWise.Types.DescribeAssetModelCompositeModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetModelCompositeModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetModelCompositeModelResponse, AWSError>;
267
+ /**
268
+ * Retrieves information about an asset model composite model (also known as an asset model component). For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.
269
+ */
270
+ describeAssetModelCompositeModel(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetModelCompositeModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetModelCompositeModelResponse, AWSError>;
231
271
  /**
232
272
  * Retrieves information about an asset property. When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value. This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.
233
273
  */
@@ -332,6 +372,22 @@ declare class IoTSiteWise extends Service {
332
372
  * Disassociates a time series (data stream) from an asset property.
333
373
  */
334
374
  disassociateTimeSeriesFromAssetProperty(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
375
+ /**
376
+ * Executes an action on a target resource.
377
+ */
378
+ executeAction(params: IoTSiteWise.Types.ExecuteActionRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ExecuteActionResponse) => void): Request<IoTSiteWise.Types.ExecuteActionResponse, AWSError>;
379
+ /**
380
+ * Executes an action on a target resource.
381
+ */
382
+ executeAction(callback?: (err: AWSError, data: IoTSiteWise.Types.ExecuteActionResponse) => void): Request<IoTSiteWise.Types.ExecuteActionResponse, AWSError>;
383
+ /**
384
+ * Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.
385
+ */
386
+ executeQuery(params: IoTSiteWise.Types.ExecuteQueryRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ExecuteQueryResponse) => void): Request<IoTSiteWise.Types.ExecuteQueryResponse, AWSError>;
387
+ /**
388
+ * Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.
389
+ */
390
+ executeQuery(callback?: (err: AWSError, data: IoTSiteWise.Types.ExecuteQueryResponse) => void): Request<IoTSiteWise.Types.ExecuteQueryResponse, AWSError>;
335
391
  /**
336
392
  * Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
337
393
  */
@@ -372,6 +428,22 @@ declare class IoTSiteWise extends Service {
372
428
  * Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).
373
429
  */
374
430
  listAccessPolicies(callback?: (err: AWSError, data: IoTSiteWise.Types.ListAccessPoliciesResponse) => void): Request<IoTSiteWise.Types.ListAccessPoliciesResponse, AWSError>;
431
+ /**
432
+ * Retrieves a paginated list of actions for a specific target resource.
433
+ */
434
+ listActions(params: IoTSiteWise.Types.ListActionsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListActionsResponse) => void): Request<IoTSiteWise.Types.ListActionsResponse, AWSError>;
435
+ /**
436
+ * Retrieves a paginated list of actions for a specific target resource.
437
+ */
438
+ listActions(callback?: (err: AWSError, data: IoTSiteWise.Types.ListActionsResponse) => void): Request<IoTSiteWise.Types.ListActionsResponse, AWSError>;
439
+ /**
440
+ * Retrieves a paginated list of composite models associated with the asset model
441
+ */
442
+ listAssetModelCompositeModels(params: IoTSiteWise.Types.ListAssetModelCompositeModelsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssetModelCompositeModelsResponse) => void): Request<IoTSiteWise.Types.ListAssetModelCompositeModelsResponse, AWSError>;
443
+ /**
444
+ * Retrieves a paginated list of composite models associated with the asset model
445
+ */
446
+ listAssetModelCompositeModels(callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssetModelCompositeModelsResponse) => void): Request<IoTSiteWise.Types.ListAssetModelCompositeModelsResponse, AWSError>;
375
447
  /**
376
448
  * Retrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.
377
449
  */
@@ -428,6 +500,14 @@ declare class IoTSiteWise extends Service {
428
500
  * Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.
429
501
  */
430
502
  listBulkImportJobs(callback?: (err: AWSError, data: IoTSiteWise.Types.ListBulkImportJobsResponse) => void): Request<IoTSiteWise.Types.ListBulkImportJobsResponse, AWSError>;
503
+ /**
504
+ * Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.
505
+ */
506
+ listCompositionRelationships(params: IoTSiteWise.Types.ListCompositionRelationshipsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListCompositionRelationshipsResponse) => void): Request<IoTSiteWise.Types.ListCompositionRelationshipsResponse, AWSError>;
507
+ /**
508
+ * Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.
509
+ */
510
+ listCompositionRelationships(callback?: (err: AWSError, data: IoTSiteWise.Types.ListCompositionRelationshipsResponse) => void): Request<IoTSiteWise.Types.ListCompositionRelationshipsResponse, AWSError>;
431
511
  /**
432
512
  * Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
433
513
  */
@@ -548,6 +628,14 @@ declare class IoTSiteWise extends Service {
548
628
  * Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide. This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel. If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.
549
629
  */
550
630
  updateAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetModelResponse) => void): Request<IoTSiteWise.Types.UpdateAssetModelResponse, AWSError>;
631
+ /**
632
+ * Updates a composite model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide. If you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property. To replace an existing composite asset model property with a new one with the same name, do the following: Submit an UpdateAssetModelCompositeModel request with the entire existing property removed. Submit a second UpdateAssetModelCompositeModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.
633
+ */
634
+ updateAssetModelCompositeModel(params: IoTSiteWise.Types.UpdateAssetModelCompositeModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetModelCompositeModelResponse) => void): Request<IoTSiteWise.Types.UpdateAssetModelCompositeModelResponse, AWSError>;
635
+ /**
636
+ * Updates a composite model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide. If you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property. To replace an existing composite asset model property with a new one with the same name, do the following: Submit an UpdateAssetModelCompositeModel request with the entire existing property removed. Submit a second UpdateAssetModelCompositeModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.
637
+ */
638
+ updateAssetModelCompositeModel(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetModelCompositeModelResponse) => void): Request<IoTSiteWise.Types.UpdateAssetModelCompositeModelResponse, AWSError>;
551
639
  /**
552
640
  * Updates an asset property's alias and notification state. This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.
553
641
  */
@@ -674,6 +762,44 @@ declare namespace IoTSiteWise {
674
762
  */
675
763
  lastUpdateDate?: Timestamp;
676
764
  }
765
+ export interface ActionDefinition {
766
+ /**
767
+ * The ID of the action definition.
768
+ */
769
+ actionDefinitionId: ID;
770
+ /**
771
+ * The name of the action definition.
772
+ */
773
+ actionName: Name;
774
+ /**
775
+ * The type of the action definition.
776
+ */
777
+ actionType: Name;
778
+ }
779
+ export type ActionDefinitions = ActionDefinition[];
780
+ export interface ActionPayload {
781
+ /**
782
+ * The payload of the action in a JSON string.
783
+ */
784
+ stringValue: ActionPayloadString;
785
+ }
786
+ export type ActionPayloadString = string;
787
+ export type ActionSummaries = ActionSummary[];
788
+ export interface ActionSummary {
789
+ /**
790
+ * The ID of the action.
791
+ */
792
+ actionId?: ID;
793
+ /**
794
+ * The ID of the action definition.
795
+ */
796
+ actionDefinitionId?: ID;
797
+ /**
798
+ * The resource the action will be taken on.
799
+ */
800
+ targetResource?: TargetResource;
801
+ }
802
+ export type AdaptiveIngestion = boolean;
677
803
  export type AggregateType = "AVERAGE"|"COUNT"|"MAXIMUM"|"MINIMUM"|"SUM"|"STANDARD_DEVIATION"|string;
678
804
  export type AggregateTypes = AggregateType[];
679
805
  export type AggregatedDoubleValue = number;
@@ -750,12 +876,54 @@ declare namespace IoTSiteWise {
750
876
  * The ID of the asset composite model.
751
877
  */
752
878
  id?: ID;
879
+ /**
880
+ * The external ID of the asset composite model. For more information, see Using external IDs in the IoT SiteWise User Guide.
881
+ */
882
+ externalId?: ExternalId;
883
+ }
884
+ export type AssetCompositeModelPath = AssetCompositeModelPathSegment[];
885
+ export interface AssetCompositeModelPathSegment {
886
+ /**
887
+ * The ID of the path segment.
888
+ */
889
+ id?: ID;
890
+ /**
891
+ * The name of the path segment.
892
+ */
893
+ name?: Name;
894
+ }
895
+ export type AssetCompositeModelSummaries = AssetCompositeModelSummary[];
896
+ export interface AssetCompositeModelSummary {
897
+ /**
898
+ * The ID of the composite model that this summary describes.
899
+ */
900
+ id: ID;
901
+ /**
902
+ * An external ID to assign to the asset model. If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.
903
+ */
904
+ externalId?: ExternalId;
905
+ /**
906
+ * The name of the composite model that this summary describes.
907
+ */
908
+ name: Name;
909
+ /**
910
+ * The type of asset model. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
911
+ */
912
+ type: Name;
913
+ /**
914
+ * A description of the composite model that this summary describes.
915
+ */
916
+ description: Description;
917
+ /**
918
+ * The path that includes all the components of the asset model for the asset.
919
+ */
920
+ path: AssetCompositeModelPath;
753
921
  }
754
922
  export type AssetCompositeModels = AssetCompositeModel[];
755
923
  export type AssetErrorCode = "INTERNAL_FAILURE"|string;
756
924
  export interface AssetErrorDetails {
757
925
  /**
758
- * The ID of the asset.
926
+ * The ID of the asset, in UUID format.
759
927
  */
760
928
  assetId: ID;
761
929
  /**
@@ -778,6 +946,10 @@ declare namespace IoTSiteWise {
778
946
  * The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.
779
947
  */
780
948
  name: Name;
949
+ /**
950
+ * The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you may assign an external ID if it doesn't already have one. You can't change the external ID of an asset hierarchy that already has one. For more information, see Using external IDs in the IoT SiteWise User Guide.
951
+ */
952
+ externalId?: ExternalId;
781
953
  }
782
954
  export interface AssetHierarchyInfo {
783
955
  /**
@@ -810,7 +982,11 @@ declare namespace IoTSiteWise {
810
982
  /**
811
983
  * The ID of the asset model composite model.
812
984
  */
813
- id?: ID;
985
+ id?: CustomID;
986
+ /**
987
+ * The external ID of the asset model composite model. For more information, see Using external IDs in the IoT SiteWise User Guide.
988
+ */
989
+ externalId?: ExternalId;
814
990
  }
815
991
  export interface AssetModelCompositeModelDefinition {
816
992
  /**
@@ -829,23 +1005,73 @@ declare namespace IoTSiteWise {
829
1005
  * The asset property definitions for this composite model.
830
1006
  */
831
1007
  properties?: AssetModelPropertyDefinitions;
1008
+ /**
1009
+ * The ID to assign to the composite model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
1010
+ */
1011
+ id?: ID;
1012
+ /**
1013
+ * An external ID to assign to the composite model. The external ID must be unique among composite models within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
1014
+ */
1015
+ externalId?: ExternalId;
832
1016
  }
833
1017
  export type AssetModelCompositeModelDefinitions = AssetModelCompositeModelDefinition[];
1018
+ export type AssetModelCompositeModelPath = AssetModelCompositeModelPathSegment[];
1019
+ export interface AssetModelCompositeModelPathSegment {
1020
+ /**
1021
+ * The ID of the path segment.
1022
+ */
1023
+ id?: ID;
1024
+ /**
1025
+ * The name of the path segment.
1026
+ */
1027
+ name?: Name;
1028
+ }
1029
+ export type AssetModelCompositeModelSummaries = AssetModelCompositeModelSummary[];
1030
+ export interface AssetModelCompositeModelSummary {
1031
+ /**
1032
+ * The ID of the the composite model that this summary describes..
1033
+ */
1034
+ id: ID;
1035
+ /**
1036
+ * The external ID of a composite model on this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
1037
+ */
1038
+ externalId?: ExternalId;
1039
+ /**
1040
+ * The name of the the composite model that this summary describes..
1041
+ */
1042
+ name: Name;
1043
+ /**
1044
+ * The type of asset model. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
1045
+ */
1046
+ type: Name;
1047
+ /**
1048
+ * The description of the the composite model that this summary describes..
1049
+ */
1050
+ description?: Description;
1051
+ /**
1052
+ * The path that includes all the pieces that make up the composite model.
1053
+ */
1054
+ path?: AssetModelCompositeModelPath;
1055
+ }
834
1056
  export type AssetModelCompositeModels = AssetModelCompositeModel[];
835
1057
  export type AssetModelHierarchies = AssetModelHierarchy[];
836
1058
  export interface AssetModelHierarchy {
837
1059
  /**
838
- * The ID of the asset model hierarchy. This ID is a hierarchyId.
1060
+ * The ID of the asset model hierarchy. This ID is a hierarchyId. If you are callling UpdateAssetModel to create a new hierarchy: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique. If you are calling UpdateAssetModel to modify an existing hierarchy: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
839
1061
  */
840
- id?: ID;
1062
+ id?: CustomID;
841
1063
  /**
842
1064
  * The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
843
1065
  */
844
1066
  name: Name;
845
1067
  /**
846
- * The ID of the asset model. All assets in this hierarchy must be instances of the childAssetModelId asset model.
1068
+ * The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the childAssetModelId asset model. IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to UpdateAssetModel, you may provide either the asset model ID or else externalId: followed by the asset model's external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
1069
+ */
1070
+ childAssetModelId: CustomID;
1071
+ /**
1072
+ * The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
847
1073
  */
848
- childAssetModelId: ID;
1074
+ externalId?: ExternalId;
849
1075
  }
850
1076
  export interface AssetModelHierarchyDefinition {
851
1077
  /**
@@ -853,17 +1079,25 @@ declare namespace IoTSiteWise {
853
1079
  */
854
1080
  name: Name;
855
1081
  /**
856
- * The ID of an asset model for this hierarchy.
1082
+ * The ID of an asset model for this hierarchy. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
1083
+ */
1084
+ childAssetModelId: CustomID;
1085
+ /**
1086
+ * The ID to assign to the asset model hierarchy, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
857
1087
  */
858
- childAssetModelId: ID;
1088
+ id?: ID;
1089
+ /**
1090
+ * An external ID to assign to the asset model hierarchy. The external ID must be unique among asset model hierarchies within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
1091
+ */
1092
+ externalId?: ExternalId;
859
1093
  }
860
1094
  export type AssetModelHierarchyDefinitions = AssetModelHierarchyDefinition[];
861
1095
  export type AssetModelProperties = AssetModelProperty[];
862
1096
  export interface AssetModelProperty {
863
1097
  /**
864
- * The ID of the asset model property.
1098
+ * The ID of the asset model property. If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique. If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
865
1099
  */
866
- id?: ID;
1100
+ id?: CustomID;
867
1101
  /**
868
1102
  * The name of the asset model property.
869
1103
  */
@@ -884,6 +1118,14 @@ declare namespace IoTSiteWise {
884
1118
  * The property type (see PropertyType).
885
1119
  */
886
1120
  type: PropertyType;
1121
+ /**
1122
+ * The structured path to the property from the root of the asset model.
1123
+ */
1124
+ path?: AssetModelPropertyPath;
1125
+ /**
1126
+ * The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
1127
+ */
1128
+ externalId?: ExternalId;
887
1129
  }
888
1130
  export interface AssetModelPropertyDefinition {
889
1131
  /**
@@ -906,8 +1148,27 @@ declare namespace IoTSiteWise {
906
1148
  * The property definition type (see PropertyType). You can only specify one type in a property definition.
907
1149
  */
908
1150
  type: PropertyType;
1151
+ /**
1152
+ * The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
1153
+ */
1154
+ id?: ID;
1155
+ /**
1156
+ * An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
1157
+ */
1158
+ externalId?: ExternalId;
909
1159
  }
910
1160
  export type AssetModelPropertyDefinitions = AssetModelPropertyDefinition[];
1161
+ export type AssetModelPropertyPath = AssetModelPropertyPathSegment[];
1162
+ export interface AssetModelPropertyPathSegment {
1163
+ /**
1164
+ * The ID of the path segment.
1165
+ */
1166
+ id?: ID;
1167
+ /**
1168
+ * The name of the path segment.
1169
+ */
1170
+ name?: Name;
1171
+ }
911
1172
  export type AssetModelPropertySummaries = AssetModelPropertySummary[];
912
1173
  export interface AssetModelPropertySummary {
913
1174
  /**
@@ -935,6 +1196,14 @@ declare namespace IoTSiteWise {
935
1196
  * The ID of the composite model that contains the asset model property.
936
1197
  */
937
1198
  assetModelCompositeModelId?: ID;
1199
+ /**
1200
+ * The structured path to the property from the root of the asset model.
1201
+ */
1202
+ path?: AssetModelPropertyPath;
1203
+ /**
1204
+ * The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
1205
+ */
1206
+ externalId?: ExternalId;
938
1207
  }
939
1208
  export type AssetModelState = "CREATING"|"ACTIVE"|"UPDATING"|"PROPAGATING"|"DELETING"|"FAILED"|string;
940
1209
  export interface AssetModelStatus {
@@ -950,7 +1219,7 @@ declare namespace IoTSiteWise {
950
1219
  export type AssetModelSummaries = AssetModelSummary[];
951
1220
  export interface AssetModelSummary {
952
1221
  /**
953
- * The ID of the asset model (used with IoT SiteWise APIs).
1222
+ * The ID of the asset model (used with IoT SiteWise API operations).
954
1223
  */
955
1224
  id: ID;
956
1225
  /**
@@ -977,7 +1246,16 @@ declare namespace IoTSiteWise {
977
1246
  * The current status of the asset model.
978
1247
  */
979
1248
  status: AssetModelStatus;
1249
+ /**
1250
+ * The type of asset model. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
1251
+ */
1252
+ assetModelType?: AssetModelType;
1253
+ /**
1254
+ * The external ID of the asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
1255
+ */
1256
+ externalId?: ExternalId;
980
1257
  }
1258
+ export type AssetModelType = "ASSET_MODEL"|"COMPONENT_MODEL"|string;
981
1259
  export type AssetProperties = AssetProperty[];
982
1260
  export interface AssetProperty {
983
1261
  /**
@@ -1008,14 +1286,33 @@ declare namespace IoTSiteWise {
1008
1286
  * The unit (such as Newtons or RPM) of the asset property.
1009
1287
  */
1010
1288
  unit?: PropertyUnit;
1289
+ /**
1290
+ * The structured path to the property from the root of the asset.
1291
+ */
1292
+ path?: AssetPropertyPath;
1293
+ /**
1294
+ * The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
1295
+ */
1296
+ externalId?: ExternalId;
1011
1297
  }
1012
1298
  export type AssetPropertyAlias = string;
1299
+ export type AssetPropertyPath = AssetPropertyPathSegment[];
1300
+ export interface AssetPropertyPathSegment {
1301
+ /**
1302
+ * The ID of the path segment.
1303
+ */
1304
+ id?: ID;
1305
+ /**
1306
+ * The name of the path segment.
1307
+ */
1308
+ name?: Name;
1309
+ }
1013
1310
  export type AssetPropertySummaries = AssetPropertySummary[];
1014
1311
  export interface AssetPropertySummary {
1015
1312
  /**
1016
1313
  * The ID of the property.
1017
1314
  */
1018
- id?: ID;
1315
+ id: ID;
1019
1316
  /**
1020
1317
  * The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
1021
1318
  */
@@ -1029,6 +1326,14 @@ declare namespace IoTSiteWise {
1029
1326
  * The ID of the composite model that contains the asset property.
1030
1327
  */
1031
1328
  assetCompositeModelId?: ID;
1329
+ /**
1330
+ * The structured path to the property from the root of the asset.
1331
+ */
1332
+ path?: AssetPropertyPath;
1333
+ /**
1334
+ * The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
1335
+ */
1336
+ externalId?: ExternalId;
1032
1337
  }
1033
1338
  export interface AssetPropertyValue {
1034
1339
  /**
@@ -1072,7 +1377,7 @@ declare namespace IoTSiteWise {
1072
1377
  export type AssetSummaries = AssetSummary[];
1073
1378
  export interface AssetSummary {
1074
1379
  /**
1075
- * The ID of the asset.
1380
+ * The ID of the asset, in UUID format.
1076
1381
  */
1077
1382
  id: ID;
1078
1383
  /**
@@ -1107,20 +1412,24 @@ declare namespace IoTSiteWise {
1107
1412
  * A description for the asset.
1108
1413
  */
1109
1414
  description?: Description;
1415
+ /**
1416
+ * The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.
1417
+ */
1418
+ externalId?: ExternalId;
1110
1419
  }
1111
1420
  export interface AssociateAssetsRequest {
1112
1421
  /**
1113
- * The ID of the parent asset.
1422
+ * The ID of the parent asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
1114
1423
  */
1115
- assetId: ID;
1424
+ assetId: CustomID;
1116
1425
  /**
1117
- * The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
1426
+ * The ID of a hierarchy in the parent asset's model. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
1118
1427
  */
1119
- hierarchyId: ID;
1428
+ hierarchyId: CustomID;
1120
1429
  /**
1121
- * The ID of the child asset to be associated.
1430
+ * The ID of the child asset to be associated. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
1122
1431
  */
1123
- childAssetId: ID;
1432
+ childAssetId: CustomID;
1124
1433
  /**
1125
1434
  * 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.
1126
1435
  */
@@ -1132,13 +1441,13 @@ declare namespace IoTSiteWise {
1132
1441
  */
1133
1442
  alias: PropertyAlias;
1134
1443
  /**
1135
- * The ID of the asset in which the asset property was created.
1444
+ * The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
1136
1445
  */
1137
- assetId: ID;
1446
+ assetId: CustomID;
1138
1447
  /**
1139
- * The ID of the asset property.
1448
+ * The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
1140
1449
  */
1141
- propertyId: ID;
1450
+ propertyId: CustomID;
1142
1451
  /**
1143
1452
  * 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.
1144
1453
  */
@@ -1147,7 +1456,7 @@ declare namespace IoTSiteWise {
1147
1456
  export type AssociatedAssetsSummaries = AssociatedAssetsSummary[];
1148
1457
  export interface AssociatedAssetsSummary {
1149
1458
  /**
1150
- * The ID of the asset.
1459
+ * The ID of the asset, in UUID format.
1151
1460
  */
1152
1461
  id: ID;
1153
1462
  /**
@@ -1182,6 +1491,10 @@ declare namespace IoTSiteWise {
1182
1491
  * A description for the asset.
1183
1492
  */
1184
1493
  description?: Description;
1494
+ /**
1495
+ * The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.
1496
+ */
1497
+ externalId?: ExternalId;
1185
1498
  }
1186
1499
  export interface Attribute {
1187
1500
  /**
@@ -1244,7 +1557,7 @@ declare namespace IoTSiteWise {
1244
1557
  */
1245
1558
  assetId?: ID;
1246
1559
  /**
1247
- * The ID of the asset property.
1560
+ * The ID of the asset property, in UUID format.
1248
1561
  */
1249
1562
  propertyId?: ID;
1250
1563
  /**
@@ -1372,7 +1685,7 @@ declare namespace IoTSiteWise {
1372
1685
  */
1373
1686
  assetId?: ID;
1374
1687
  /**
1375
- * The ID of the asset property.
1688
+ * The ID of the asset property, in UUID format.
1376
1689
  */
1377
1690
  propertyId?: ID;
1378
1691
  /**
@@ -1417,7 +1730,7 @@ declare namespace IoTSiteWise {
1417
1730
  */
1418
1731
  assetId?: ID;
1419
1732
  /**
1420
- * The ID of the asset property.
1733
+ * The ID of the asset property, in UUID format.
1421
1734
  */
1422
1735
  propertyId?: ID;
1423
1736
  /**
@@ -1621,8 +1934,25 @@ declare namespace IoTSiteWise {
1621
1934
  export type CapabilityNamespace = string;
1622
1935
  export type CapabilitySyncStatus = "IN_SYNC"|"OUT_OF_SYNC"|"SYNC_FAILED"|"UNKNOWN"|string;
1623
1936
  export type ClientToken = string;
1937
+ export interface ColumnInfo {
1938
+ /**
1939
+ * The name of the column description.
1940
+ */
1941
+ name?: String;
1942
+ /**
1943
+ * The type of the column description.
1944
+ */
1945
+ type?: ColumnType;
1946
+ }
1624
1947
  export type ColumnName = "ALIAS"|"ASSET_ID"|"PROPERTY_ID"|"DATA_TYPE"|"TIMESTAMP_SECONDS"|"TIMESTAMP_NANO_OFFSET"|"QUALITY"|"VALUE"|string;
1625
1948
  export type ColumnNames = ColumnName[];
1949
+ export interface ColumnType {
1950
+ /**
1951
+ * The allowed data types that the column has as it's value.
1952
+ */
1953
+ scalarType?: ScalarType;
1954
+ }
1955
+ export type ColumnsList = ColumnInfo[];
1626
1956
  export interface CompositeModelProperty {
1627
1957
  /**
1628
1958
  * The name of the property.
@@ -1637,6 +1967,38 @@ declare namespace IoTSiteWise {
1637
1967
  * The ID of the composite model that contains the property.
1638
1968
  */
1639
1969
  id?: ID;
1970
+ /**
1971
+ * The external ID of the composite model that contains the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
1972
+ */
1973
+ externalId?: ExternalId;
1974
+ }
1975
+ export interface CompositionDetails {
1976
+ /**
1977
+ * An array detailing the composition relationship for this composite model.
1978
+ */
1979
+ compositionRelationship?: CompositionRelationship;
1980
+ }
1981
+ export type CompositionRelationship = CompositionRelationshipItem[];
1982
+ export interface CompositionRelationshipItem {
1983
+ /**
1984
+ * The ID of the component.
1985
+ */
1986
+ id?: ID;
1987
+ }
1988
+ export type CompositionRelationshipSummaries = CompositionRelationshipSummary[];
1989
+ export interface CompositionRelationshipSummary {
1990
+ /**
1991
+ * The ID of the asset model, in UUID format.
1992
+ */
1993
+ assetModelId: ID;
1994
+ /**
1995
+ * The ID of a composite model on this asset model.
1996
+ */
1997
+ assetModelCompositeModelId: ID;
1998
+ /**
1999
+ * The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
2000
+ */
2001
+ assetModelCompositeModelType: Name;
1640
2002
  }
1641
2003
  export type ComputeLocation = "EDGE"|"CLOUD"|string;
1642
2004
  export interface ConfigurationErrorDetails {
@@ -1693,6 +2055,59 @@ declare namespace IoTSiteWise {
1693
2055
  */
1694
2056
  accessPolicyArn: ARN;
1695
2057
  }
2058
+ export interface CreateAssetModelCompositeModelRequest {
2059
+ /**
2060
+ * The ID of the asset model this composite model is a part of.
2061
+ */
2062
+ assetModelId: CustomID;
2063
+ /**
2064
+ * The ID of the parent composite model in this asset model relationship.
2065
+ */
2066
+ parentAssetModelCompositeModelId?: CustomID;
2067
+ /**
2068
+ * An external ID to assign to the composite model. If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.
2069
+ */
2070
+ assetModelCompositeModelExternalId?: ExternalId;
2071
+ /**
2072
+ * The ID of the composite model. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
2073
+ */
2074
+ assetModelCompositeModelId?: ID;
2075
+ /**
2076
+ * A description for the composite model.
2077
+ */
2078
+ assetModelCompositeModelDescription?: Description;
2079
+ /**
2080
+ * A unique, friendly name for the composite model.
2081
+ */
2082
+ assetModelCompositeModelName: Name;
2083
+ /**
2084
+ * The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
2085
+ */
2086
+ assetModelCompositeModelType: Name;
2087
+ /**
2088
+ * 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.
2089
+ */
2090
+ clientToken?: ClientToken;
2091
+ /**
2092
+ * The ID of a composite model on this asset.
2093
+ */
2094
+ composedAssetModelId?: CustomID;
2095
+ /**
2096
+ * The property definitions of the composite model. For more information, see &lt;LINK&gt;. You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.
2097
+ */
2098
+ assetModelCompositeModelProperties?: AssetModelPropertyDefinitions;
2099
+ }
2100
+ export interface CreateAssetModelCompositeModelResponse {
2101
+ /**
2102
+ * The ID of the composed asset model. You can use this ID when you call other IoT SiteWise APIs.
2103
+ */
2104
+ assetModelCompositeModelId: ID;
2105
+ /**
2106
+ * The path to the composite model listing the parent composite models.
2107
+ */
2108
+ assetModelCompositeModelPath: AssetModelCompositeModelPath;
2109
+ assetModelStatus: AssetModelStatus;
2110
+ }
1696
2111
  export interface CreateAssetModelRequest {
1697
2112
  /**
1698
2113
  * A unique, friendly name for the asset model.
@@ -1711,7 +2126,7 @@ declare namespace IoTSiteWise {
1711
2126
  */
1712
2127
  assetModelHierarchies?: AssetModelHierarchyDefinitions;
1713
2128
  /**
1714
- * The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.
2129
+ * The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model. When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see &lt;LINK&gt;.
1715
2130
  */
1716
2131
  assetModelCompositeModels?: AssetModelCompositeModelDefinitions;
1717
2132
  /**
@@ -1722,10 +2137,22 @@ declare namespace IoTSiteWise {
1722
2137
  * A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
1723
2138
  */
1724
2139
  tags?: TagMap;
2140
+ /**
2141
+ * The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
2142
+ */
2143
+ assetModelId?: ID;
2144
+ /**
2145
+ * An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
2146
+ */
2147
+ assetModelExternalId?: ExternalId;
2148
+ /**
2149
+ * The type of asset model. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
2150
+ */
2151
+ assetModelType?: AssetModelType;
1725
2152
  }
1726
2153
  export interface CreateAssetModelResponse {
1727
2154
  /**
1728
- * The ID of the asset model. You can use this ID when you call other IoT SiteWise APIs.
2155
+ * The ID of the asset model, in UUID format. You can use this ID when you call other IoT SiteWise API operations.
1729
2156
  */
1730
2157
  assetModelId: ID;
1731
2158
  /**
@@ -1743,9 +2170,9 @@ declare namespace IoTSiteWise {
1743
2170
  */
1744
2171
  assetName: Name;
1745
2172
  /**
1746
- * The ID of the asset model from which to create the asset.
2173
+ * The ID of the asset model from which to create the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
1747
2174
  */
1748
- assetModelId: ID;
2175
+ assetModelId: CustomID;
1749
2176
  /**
1750
2177
  * 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.
1751
2178
  */
@@ -1758,10 +2185,18 @@ declare namespace IoTSiteWise {
1758
2185
  * A description for the asset.
1759
2186
  */
1760
2187
  assetDescription?: Description;
2188
+ /**
2189
+ * The ID to assign to the asset, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
2190
+ */
2191
+ assetId?: ID;
2192
+ /**
2193
+ * An external ID to assign to the asset. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
2194
+ */
2195
+ assetExternalId?: ExternalId;
1761
2196
  }
1762
2197
  export interface CreateAssetResponse {
1763
2198
  /**
1764
- * The ID of the asset. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs.
2199
+ * The ID of the asset, in UUID format. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise API operations.
1765
2200
  */
1766
2201
  assetId: ID;
1767
2202
  /**
@@ -1794,6 +2229,14 @@ declare namespace IoTSiteWise {
1794
2229
  * Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
1795
2230
  */
1796
2231
  jobConfiguration: JobConfiguration;
2232
+ /**
2233
+ * If set to true, ingest new data into IoT SiteWise storage. Measurements with notifications, metrics and transforms are computed. If set to false, historical data is ingested into IoT SiteWise as is.
2234
+ */
2235
+ adaptiveIngestion?: AdaptiveIngestion;
2236
+ /**
2237
+ * If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.
2238
+ */
2239
+ deleteFilesAfterImport?: DeleteFilesAfterImport;
1797
2240
  }
1798
2241
  export interface CreateBulkImportJobResponse {
1799
2242
  /**
@@ -1805,7 +2248,7 @@ declare namespace IoTSiteWise {
1805
2248
  */
1806
2249
  jobName: Name;
1807
2250
  /**
1808
- * The status of the bulk import job can be one of following values. PENDING – IoT SiteWise is waiting for the current bulk import job to finish. CANCELLED – The bulk import job has been canceled. RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3. COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3. FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues. COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
2251
+ * The status of the bulk import job can be one of following values: PENDING – IoT SiteWise is waiting for the current bulk import job to finish. CANCELLED – The bulk import job has been canceled. RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3. COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3. FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues. COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
1809
2252
  */
1810
2253
  jobStatus: JobStatus;
1811
2254
  }
@@ -1861,7 +2304,7 @@ declare namespace IoTSiteWise {
1861
2304
  }
1862
2305
  export interface CreateGatewayResponse {
1863
2306
  /**
1864
- * The ID of the gateway device. You can use this ID when you call other IoT SiteWise APIs.
2307
+ * The ID of the gateway device. You can use this ID when you call other IoT SiteWise API operations.
1865
2308
  */
1866
2309
  gatewayId: ID;
1867
2310
  /**
@@ -1899,7 +2342,7 @@ declare namespace IoTSiteWise {
1899
2342
  */
1900
2343
  tags?: TagMap;
1901
2344
  /**
1902
- * The service to use to authenticate users to the portal. Choose from the following options: SSO – The portal uses IAM Identity Center (successor to Single Sign-On) to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see Enabling IAM Identity Center in the IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions. IAM – The portal uses Identity and Access Management to authenticate users and manage user permissions. You can't change this value after you create a portal. Default: SSO
2345
+ * The service to use to authenticate users to the portal. Choose from the following options: SSO – The portal uses IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see Enabling IAM Identity Center in the IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions. IAM – The portal uses Identity and Access Management to authenticate users and manage user permissions. You can't change this value after you create a portal. Default: SSO
1903
2346
  */
1904
2347
  portalAuthMode?: AuthMode;
1905
2348
  /**
@@ -1969,8 +2412,9 @@ declare namespace IoTSiteWise {
1969
2412
  /**
1970
2413
  * The column names specified in the .csv file.
1971
2414
  */
1972
- columnNames?: ColumnNames;
2415
+ columnNames: ColumnNames;
1973
2416
  }
2417
+ export type CustomID = string;
1974
2418
  export interface CustomerManagedS3Storage {
1975
2419
  /**
1976
2420
  * The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see Amazon S3 resources in the Amazon Simple Storage Service User Guide.
@@ -2005,6 +2449,25 @@ declare namespace IoTSiteWise {
2005
2449
  */
2006
2450
  lastUpdateDate?: Timestamp;
2007
2451
  }
2452
+ export interface Datum {
2453
+ /**
2454
+ * Indicates if the data point is a scalar value such as integer, string, double, or Boolean.
2455
+ */
2456
+ scalarValue?: ScalarValue;
2457
+ /**
2458
+ * Indicates if the data point is an array.
2459
+ */
2460
+ arrayValue?: DatumList;
2461
+ /**
2462
+ * Indicates if the data point is a row.
2463
+ */
2464
+ rowValue?: Row;
2465
+ /**
2466
+ * Indicates if the data point is null.
2467
+ */
2468
+ nullValue?: NullableBoolean;
2469
+ }
2470
+ export type DatumList = Datum[];
2008
2471
  export type DefaultValue = string;
2009
2472
  export interface DeleteAccessPolicyRequest {
2010
2473
  /**
@@ -2018,11 +2481,28 @@ declare namespace IoTSiteWise {
2018
2481
  }
2019
2482
  export interface DeleteAccessPolicyResponse {
2020
2483
  }
2484
+ export interface DeleteAssetModelCompositeModelRequest {
2485
+ /**
2486
+ * The ID of the asset model, in UUID format.
2487
+ */
2488
+ assetModelId: CustomID;
2489
+ /**
2490
+ * The ID of a composite model on this asset model.
2491
+ */
2492
+ assetModelCompositeModelId: CustomID;
2493
+ /**
2494
+ * 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.
2495
+ */
2496
+ clientToken?: ClientToken;
2497
+ }
2498
+ export interface DeleteAssetModelCompositeModelResponse {
2499
+ assetModelStatus: AssetModelStatus;
2500
+ }
2021
2501
  export interface DeleteAssetModelRequest {
2022
2502
  /**
2023
- * The ID of the asset model to delete.
2503
+ * The ID of the asset model to delete. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2024
2504
  */
2025
- assetModelId: ID;
2505
+ assetModelId: CustomID;
2026
2506
  /**
2027
2507
  * 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.
2028
2508
  */
@@ -2036,9 +2516,9 @@ declare namespace IoTSiteWise {
2036
2516
  }
2037
2517
  export interface DeleteAssetRequest {
2038
2518
  /**
2039
- * The ID of the asset to delete.
2519
+ * The ID of the asset to delete. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2040
2520
  */
2041
- assetId: ID;
2521
+ assetId: CustomID;
2042
2522
  /**
2043
2523
  * 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.
2044
2524
  */
@@ -2046,115 +2526,252 @@ declare namespace IoTSiteWise {
2046
2526
  }
2047
2527
  export interface DeleteAssetResponse {
2048
2528
  /**
2049
- * The status of the asset, which contains a state (DELETING after successfully calling this operation) and any error message.
2529
+ * The status of the asset, which contains a state (DELETING after successfully calling this operation) and any error message.
2530
+ */
2531
+ assetStatus: AssetStatus;
2532
+ }
2533
+ export interface DeleteDashboardRequest {
2534
+ /**
2535
+ * The ID of the dashboard to delete.
2536
+ */
2537
+ dashboardId: ID;
2538
+ /**
2539
+ * 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.
2540
+ */
2541
+ clientToken?: ClientToken;
2542
+ }
2543
+ export interface DeleteDashboardResponse {
2544
+ }
2545
+ export type DeleteFilesAfterImport = boolean;
2546
+ export interface DeleteGatewayRequest {
2547
+ /**
2548
+ * The ID of the gateway to delete.
2549
+ */
2550
+ gatewayId: ID;
2551
+ }
2552
+ export interface DeletePortalRequest {
2553
+ /**
2554
+ * The ID of the portal to delete.
2555
+ */
2556
+ portalId: ID;
2557
+ /**
2558
+ * 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.
2559
+ */
2560
+ clientToken?: ClientToken;
2561
+ }
2562
+ export interface DeletePortalResponse {
2563
+ /**
2564
+ * The status of the portal, which contains a state (DELETING after successfully calling this operation) and any error message.
2565
+ */
2566
+ portalStatus: PortalStatus;
2567
+ }
2568
+ export interface DeleteProjectRequest {
2569
+ /**
2570
+ * The ID of the project.
2571
+ */
2572
+ projectId: ID;
2573
+ /**
2574
+ * 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.
2575
+ */
2576
+ clientToken?: ClientToken;
2577
+ }
2578
+ export interface DeleteProjectResponse {
2579
+ }
2580
+ export interface DeleteTimeSeriesRequest {
2581
+ /**
2582
+ * The alias that identifies the time series.
2583
+ */
2584
+ alias?: PropertyAlias;
2585
+ /**
2586
+ * The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2587
+ */
2588
+ assetId?: CustomID;
2589
+ /**
2590
+ * The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2591
+ */
2592
+ propertyId?: CustomID;
2593
+ /**
2594
+ * 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.
2595
+ */
2596
+ clientToken?: ClientToken;
2597
+ }
2598
+ export interface DescribeAccessPolicyRequest {
2599
+ /**
2600
+ * The ID of the access policy.
2601
+ */
2602
+ accessPolicyId: ID;
2603
+ }
2604
+ export interface DescribeAccessPolicyResponse {
2605
+ /**
2606
+ * The ID of the access policy.
2607
+ */
2608
+ accessPolicyId: ID;
2609
+ /**
2610
+ * The ARN of the access policy, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
2611
+ */
2612
+ accessPolicyArn: ARN;
2613
+ /**
2614
+ * The identity (IAM Identity Center user, IAM Identity Center group, or IAM user) to which this access policy applies.
2615
+ */
2616
+ accessPolicyIdentity: Identity;
2617
+ /**
2618
+ * The IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.
2619
+ */
2620
+ accessPolicyResource: Resource;
2621
+ /**
2622
+ * The access policy permission. Note that a project ADMINISTRATOR is also known as a project owner.
2623
+ */
2624
+ accessPolicyPermission: Permission;
2625
+ /**
2626
+ * The date the access policy was created, in Unix epoch time.
2627
+ */
2628
+ accessPolicyCreationDate: Timestamp;
2629
+ /**
2630
+ * The date the access policy was last updated, in Unix epoch time.
2631
+ */
2632
+ accessPolicyLastUpdateDate: Timestamp;
2633
+ }
2634
+ export interface DescribeActionRequest {
2635
+ /**
2636
+ * The ID of the action.
2637
+ */
2638
+ actionId: ID;
2639
+ }
2640
+ export interface DescribeActionResponse {
2641
+ /**
2642
+ * The ID of the action.
2643
+ */
2644
+ actionId: ID;
2645
+ /**
2646
+ * The resource the action will be taken on.
2647
+ */
2648
+ targetResource: TargetResource;
2649
+ /**
2650
+ * The ID of the action definition.
2651
+ */
2652
+ actionDefinitionId: ID;
2653
+ /**
2654
+ * The JSON payload of the action.
2655
+ */
2656
+ actionPayload: ActionPayload;
2657
+ /**
2658
+ * The time the action was executed.
2659
+ */
2660
+ executionTime: Timestamp;
2661
+ }
2662
+ export interface DescribeAssetCompositeModelRequest {
2663
+ /**
2664
+ * The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2665
+ */
2666
+ assetId: CustomID;
2667
+ /**
2668
+ * The ID of a composite model on this asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2669
+ */
2670
+ assetCompositeModelId: CustomID;
2671
+ }
2672
+ export interface DescribeAssetCompositeModelResponse {
2673
+ /**
2674
+ * The ID of the asset, in UUID format. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs.
2675
+ */
2676
+ assetId: ID;
2677
+ /**
2678
+ * The ID of a composite model on this asset.
2050
2679
  */
2051
- assetStatus: AssetStatus;
2052
- }
2053
- export interface DeleteDashboardRequest {
2680
+ assetCompositeModelId: ID;
2054
2681
  /**
2055
- * The ID of the dashboard to delete.
2682
+ * An external ID to assign to the asset model. If the composite model is a component-based composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.
2056
2683
  */
2057
- dashboardId: ID;
2684
+ assetCompositeModelExternalId?: ExternalId;
2058
2685
  /**
2059
- * 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.
2686
+ * The path to the composite model listing the parent composite models.
2060
2687
  */
2061
- clientToken?: ClientToken;
2062
- }
2063
- export interface DeleteDashboardResponse {
2064
- }
2065
- export interface DeleteGatewayRequest {
2688
+ assetCompositeModelPath: AssetCompositeModelPath;
2066
2689
  /**
2067
- * The ID of the gateway to delete.
2690
+ * The unique, friendly name for the composite model.
2068
2691
  */
2069
- gatewayId: ID;
2070
- }
2071
- export interface DeletePortalRequest {
2692
+ assetCompositeModelName: Name;
2072
2693
  /**
2073
- * The ID of the portal to delete.
2694
+ * A description for the composite model.
2074
2695
  */
2075
- portalId: ID;
2696
+ assetCompositeModelDescription: Description;
2076
2697
  /**
2077
- * 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.
2698
+ * The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
2078
2699
  */
2079
- clientToken?: ClientToken;
2080
- }
2081
- export interface DeletePortalResponse {
2700
+ assetCompositeModelType: Name;
2082
2701
  /**
2083
- * The status of the portal, which contains a state (DELETING after successfully calling this operation) and any error message.
2702
+ * The property definitions of the composite model that was used to create the asset.
2084
2703
  */
2085
- portalStatus: PortalStatus;
2086
- }
2087
- export interface DeleteProjectRequest {
2704
+ assetCompositeModelProperties: AssetProperties;
2088
2705
  /**
2089
- * The ID of the project.
2706
+ * The list of composite model summaries.
2090
2707
  */
2091
- projectId: ID;
2708
+ assetCompositeModelSummaries: AssetCompositeModelSummaries;
2092
2709
  /**
2093
- * 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.
2710
+ * The available actions for a composite model on this asset.
2094
2711
  */
2095
- clientToken?: ClientToken;
2096
- }
2097
- export interface DeleteProjectResponse {
2712
+ actionDefinitions?: ActionDefinitions;
2098
2713
  }
2099
- export interface DeleteTimeSeriesRequest {
2714
+ export interface DescribeAssetModelCompositeModelRequest {
2100
2715
  /**
2101
- * The alias that identifies the time series.
2716
+ * The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2102
2717
  */
2103
- alias?: PropertyAlias;
2718
+ assetModelId: CustomID;
2104
2719
  /**
2105
- * The ID of the asset in which the asset property was created.
2720
+ * The ID of a composite model on this asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2106
2721
  */
2107
- assetId?: ID;
2722
+ assetModelCompositeModelId: CustomID;
2723
+ }
2724
+ export interface DescribeAssetModelCompositeModelResponse {
2108
2725
  /**
2109
- * The ID of the asset property.
2726
+ * The ID of the asset model, in UUID format.
2110
2727
  */
2111
- propertyId?: ID;
2728
+ assetModelId: ID;
2112
2729
  /**
2113
- * 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.
2730
+ * The ID of a composite model on this asset model.
2114
2731
  */
2115
- clientToken?: ClientToken;
2116
- }
2117
- export interface DescribeAccessPolicyRequest {
2732
+ assetModelCompositeModelId: ID;
2118
2733
  /**
2119
- * The ID of the access policy.
2734
+ * The external ID of a composite model on this asset model.
2120
2735
  */
2121
- accessPolicyId: ID;
2122
- }
2123
- export interface DescribeAccessPolicyResponse {
2736
+ assetModelCompositeModelExternalId?: ExternalId;
2124
2737
  /**
2125
- * The ID of the access policy.
2738
+ * The path to the composite model listing the parent composite models.
2126
2739
  */
2127
- accessPolicyId: ID;
2740
+ assetModelCompositeModelPath: AssetModelCompositeModelPath;
2128
2741
  /**
2129
- * The ARN of the access policy, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
2742
+ * The unique, friendly name for the composite model.
2130
2743
  */
2131
- accessPolicyArn: ARN;
2744
+ assetModelCompositeModelName: Name;
2132
2745
  /**
2133
- * The identity (IAM Identity Center user, IAM Identity Center group, or IAM user) to which this access policy applies.
2746
+ * The description for the composite model.
2134
2747
  */
2135
- accessPolicyIdentity: Identity;
2748
+ assetModelCompositeModelDescription: Description;
2136
2749
  /**
2137
- * The IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.
2750
+ * The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
2138
2751
  */
2139
- accessPolicyResource: Resource;
2752
+ assetModelCompositeModelType: Name;
2140
2753
  /**
2141
- * The access policy permission. Note that a project ADMINISTRATOR is also known as a project owner.
2754
+ * The property definitions of the composite model.
2142
2755
  */
2143
- accessPolicyPermission: Permission;
2756
+ assetModelCompositeModelProperties: AssetModelProperties;
2144
2757
  /**
2145
- * The date the access policy was created, in Unix epoch time.
2758
+ * Metadata for the composition relationship established by using composedAssetModelId in CreateAssetModelCompositeModel . For instance, an array detailing the path of the composition relationship for this composite model.
2146
2759
  */
2147
- accessPolicyCreationDate: Timestamp;
2760
+ compositionDetails?: CompositionDetails;
2148
2761
  /**
2149
- * The date the access policy was last updated, in Unix epoch time.
2762
+ * The list of composite model summaries for the composite model.
2150
2763
  */
2151
- accessPolicyLastUpdateDate: Timestamp;
2764
+ assetModelCompositeModelSummaries: AssetModelCompositeModelSummaries;
2765
+ /**
2766
+ * The available actions for a composite model on this asset model.
2767
+ */
2768
+ actionDefinitions?: ActionDefinitions;
2152
2769
  }
2153
2770
  export interface DescribeAssetModelRequest {
2154
2771
  /**
2155
- * The ID of the asset model.
2772
+ * The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2156
2773
  */
2157
- assetModelId: ID;
2774
+ assetModelId: CustomID;
2158
2775
  /**
2159
2776
  * Whether or not to exclude asset model properties from the response.
2160
2777
  */
@@ -2162,7 +2779,7 @@ declare namespace IoTSiteWise {
2162
2779
  }
2163
2780
  export interface DescribeAssetModelResponse {
2164
2781
  /**
2165
- * The ID of the asset model.
2782
+ * The ID of the asset model, in UUID format.
2166
2783
  */
2167
2784
  assetModelId: ID;
2168
2785
  /**
@@ -2186,7 +2803,7 @@ declare namespace IoTSiteWise {
2186
2803
  */
2187
2804
  assetModelHierarchies: AssetModelHierarchies;
2188
2805
  /**
2189
- * The list of composite asset models for the asset model.
2806
+ * The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.
2190
2807
  */
2191
2808
  assetModelCompositeModels?: AssetModelCompositeModels;
2192
2809
  /**
@@ -2201,20 +2818,32 @@ declare namespace IoTSiteWise {
2201
2818
  * The current status of the asset model, which contains a state and any error message.
2202
2819
  */
2203
2820
  assetModelStatus: AssetModelStatus;
2821
+ /**
2822
+ * The type of asset model. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
2823
+ */
2824
+ assetModelType?: AssetModelType;
2825
+ /**
2826
+ * The list of the immediate child custom composite model summaries for the asset model.
2827
+ */
2828
+ assetModelCompositeModelSummaries?: AssetModelCompositeModelSummaries;
2829
+ /**
2830
+ * The external ID of the asset model, if any.
2831
+ */
2832
+ assetModelExternalId?: ExternalId;
2204
2833
  }
2205
2834
  export interface DescribeAssetPropertyRequest {
2206
2835
  /**
2207
- * The ID of the asset.
2836
+ * The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2208
2837
  */
2209
- assetId: ID;
2838
+ assetId: CustomID;
2210
2839
  /**
2211
- * The ID of the asset property.
2840
+ * The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2212
2841
  */
2213
- propertyId: ID;
2842
+ propertyId: CustomID;
2214
2843
  }
2215
2844
  export interface DescribeAssetPropertyResponse {
2216
2845
  /**
2217
- * The ID of the asset.
2846
+ * The ID of the asset, in UUID format.
2218
2847
  */
2219
2848
  assetId: ID;
2220
2849
  /**
@@ -2222,7 +2851,7 @@ declare namespace IoTSiteWise {
2222
2851
  */
2223
2852
  assetName: Name;
2224
2853
  /**
2225
- * The ID of the asset model.
2854
+ * The ID of the asset model, in UUID format.
2226
2855
  */
2227
2856
  assetModelId: ID;
2228
2857
  /**
@@ -2230,15 +2859,19 @@ declare namespace IoTSiteWise {
2230
2859
  */
2231
2860
  assetProperty?: Property;
2232
2861
  /**
2233
- * The composite asset model that declares this asset property, if this asset property exists in a composite model.
2862
+ * The composite model that declares this asset property, if this asset property exists in a composite model.
2234
2863
  */
2235
2864
  compositeModel?: CompositeModelProperty;
2865
+ /**
2866
+ * The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.
2867
+ */
2868
+ assetExternalId?: ExternalId;
2236
2869
  }
2237
2870
  export interface DescribeAssetRequest {
2238
2871
  /**
2239
- * The ID of the asset.
2872
+ * The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2240
2873
  */
2241
- assetId: ID;
2874
+ assetId: CustomID;
2242
2875
  /**
2243
2876
  * Whether or not to exclude asset properties from the response.
2244
2877
  */
@@ -2246,7 +2879,7 @@ declare namespace IoTSiteWise {
2246
2879
  }
2247
2880
  export interface DescribeAssetResponse {
2248
2881
  /**
2249
- * The ID of the asset.
2882
+ * The ID of the asset, in UUID format.
2250
2883
  */
2251
2884
  assetId: ID;
2252
2885
  /**
@@ -2289,6 +2922,14 @@ declare namespace IoTSiteWise {
2289
2922
  * A description for the asset.
2290
2923
  */
2291
2924
  assetDescription?: Description;
2925
+ /**
2926
+ * The list of the immediate child custom composite model summaries for the asset.
2927
+ */
2928
+ assetCompositeModelSummaries?: AssetCompositeModelSummaries;
2929
+ /**
2930
+ * The external ID of the asset, if any.
2931
+ */
2932
+ assetExternalId?: ExternalId;
2292
2933
  }
2293
2934
  export interface DescribeBulkImportJobRequest {
2294
2935
  /**
@@ -2306,7 +2947,7 @@ declare namespace IoTSiteWise {
2306
2947
  */
2307
2948
  jobName: Name;
2308
2949
  /**
2309
- * The status of the bulk import job can be one of following values. PENDING – IoT SiteWise is waiting for the current bulk import job to finish. CANCELLED – The bulk import job has been canceled. RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3. COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3. FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues. COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
2950
+ * The status of the bulk import job can be one of following values: PENDING – IoT SiteWise is waiting for the current bulk import job to finish. CANCELLED – The bulk import job has been canceled. RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3. COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3. FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues. COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
2310
2951
  */
2311
2952
  jobStatus: JobStatus;
2312
2953
  /**
@@ -2333,6 +2974,14 @@ declare namespace IoTSiteWise {
2333
2974
  * The date the job was last updated, in Unix epoch time.
2334
2975
  */
2335
2976
  jobLastUpdateDate: Timestamp;
2977
+ /**
2978
+ * If set to true, ingest new data into IoT SiteWise storage. Measurements with notifications, metrics and transforms are computed. If set to false, historical data is ingested into IoT SiteWise as is.
2979
+ */
2980
+ adaptiveIngestion?: AdaptiveIngestion;
2981
+ /**
2982
+ * If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.
2983
+ */
2984
+ deleteFilesAfterImport?: DeleteFilesAfterImport;
2336
2985
  }
2337
2986
  export interface DescribeDashboardRequest {
2338
2987
  /**
@@ -2486,7 +3135,7 @@ declare namespace IoTSiteWise {
2486
3135
  */
2487
3136
  portalDescription?: Description;
2488
3137
  /**
2489
- * The IAM Identity Center application generated client ID (used with IAM Identity Center APIs). IoT SiteWise includes portalClientId for only portals that use IAM Identity Center to authenticate users.
3138
+ * The IAM Identity Center application generated client ID (used with IAM Identity Center API operations). IoT SiteWise includes portalClientId for only portals that use IAM Identity Center to authenticate users.
2490
3139
  */
2491
3140
  portalClientId: PortalClientId;
2492
3141
  /**
@@ -2582,7 +3231,7 @@ declare namespace IoTSiteWise {
2582
3231
  */
2583
3232
  disassociatedDataStorage?: DisassociatedDataStorageState;
2584
3233
  /**
2585
- * How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
3234
+ * The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
2586
3235
  */
2587
3236
  retentionPeriod?: RetentionPeriod;
2588
3237
  configurationStatus: ConfigurationStatus;
@@ -2590,6 +3239,14 @@ declare namespace IoTSiteWise {
2590
3239
  * The date the storage configuration was last updated, in Unix epoch time.
2591
3240
  */
2592
3241
  lastUpdateDate?: Timestamp;
3242
+ /**
3243
+ * A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.
3244
+ */
3245
+ warmTier?: WarmTierState;
3246
+ /**
3247
+ * Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.
3248
+ */
3249
+ warmTierRetentionPeriod?: WarmTierRetentionPeriod;
2593
3250
  }
2594
3251
  export interface DescribeTimeSeriesRequest {
2595
3252
  /**
@@ -2597,13 +3254,13 @@ declare namespace IoTSiteWise {
2597
3254
  */
2598
3255
  alias?: PropertyAlias;
2599
3256
  /**
2600
- * The ID of the asset in which the asset property was created.
3257
+ * The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2601
3258
  */
2602
- assetId?: ID;
3259
+ assetId?: CustomID;
2603
3260
  /**
2604
- * The ID of the asset property.
3261
+ * The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2605
3262
  */
2606
- propertyId?: ID;
3263
+ propertyId?: CustomID;
2607
3264
  }
2608
3265
  export interface DescribeTimeSeriesResponse {
2609
3266
  /**
@@ -2611,7 +3268,7 @@ declare namespace IoTSiteWise {
2611
3268
  */
2612
3269
  assetId?: ID;
2613
3270
  /**
2614
- * The ID of the asset property.
3271
+ * The ID of the asset property, in UUID format.
2615
3272
  */
2616
3273
  propertyId?: ID;
2617
3274
  /**
@@ -2659,17 +3316,17 @@ declare namespace IoTSiteWise {
2659
3316
  export type DetailedErrors = DetailedError[];
2660
3317
  export interface DisassociateAssetsRequest {
2661
3318
  /**
2662
- * The ID of the parent asset from which to disassociate the child asset.
3319
+ * The ID of the parent asset from which to disassociate the child asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2663
3320
  */
2664
- assetId: ID;
3321
+ assetId: CustomID;
2665
3322
  /**
2666
- * The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. You can use the hierarchy ID to identify the correct asset to disassociate. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
3323
+ * The ID of a hierarchy in the parent asset's model. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) Hierarchies allow different groupings of assets to be formed that all come from the same asset model. You can use the hierarchy ID to identify the correct asset to disassociate. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
2667
3324
  */
2668
- hierarchyId: ID;
3325
+ hierarchyId: CustomID;
2669
3326
  /**
2670
- * The ID of the child asset to disassociate.
3327
+ * The ID of the child asset to disassociate. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2671
3328
  */
2672
- childAssetId: ID;
3329
+ childAssetId: CustomID;
2673
3330
  /**
2674
3331
  * 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.
2675
3332
  */
@@ -2681,13 +3338,13 @@ declare namespace IoTSiteWise {
2681
3338
  */
2682
3339
  alias: PropertyAlias;
2683
3340
  /**
2684
- * The ID of the asset in which the asset property was created.
3341
+ * The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2685
3342
  */
2686
- assetId: ID;
3343
+ assetId: CustomID;
2687
3344
  /**
2688
- * The ID of the asset property.
3345
+ * The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
2689
3346
  */
2690
- propertyId: ID;
3347
+ propertyId: CustomID;
2691
3348
  /**
2692
3349
  * 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.
2693
3350
  */
@@ -2724,6 +3381,60 @@ declare namespace IoTSiteWise {
2724
3381
  prefix: String;
2725
3382
  }
2726
3383
  export type ExcludeProperties = boolean;
3384
+ export interface ExecuteActionRequest {
3385
+ /**
3386
+ * The resource the action will be taken on.
3387
+ */
3388
+ targetResource: TargetResource;
3389
+ /**
3390
+ * The ID of the action definition.
3391
+ */
3392
+ actionDefinitionId: ID;
3393
+ /**
3394
+ * The JSON payload of the action.
3395
+ */
3396
+ actionPayload: ActionPayload;
3397
+ /**
3398
+ * 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.
3399
+ */
3400
+ clientToken?: ClientToken;
3401
+ }
3402
+ export interface ExecuteActionResponse {
3403
+ /**
3404
+ * The ID of the action.
3405
+ */
3406
+ actionId: ID;
3407
+ }
3408
+ export type ExecuteQueryMaxResults = number;
3409
+ export type ExecuteQueryNextToken = string;
3410
+ export interface ExecuteQueryRequest {
3411
+ /**
3412
+ * The IoT SiteWise query statement.
3413
+ */
3414
+ queryStatement: QueryStatement;
3415
+ /**
3416
+ * The string that specifies the next page of results.
3417
+ */
3418
+ nextToken?: ExecuteQueryNextToken;
3419
+ /**
3420
+ * The maximum number of results to return at one time. The default is 25.
3421
+ */
3422
+ maxResults?: ExecuteQueryMaxResults;
3423
+ }
3424
+ export interface ExecuteQueryResponse {
3425
+ /**
3426
+ * Represents a single column in the query results.
3427
+ */
3428
+ columns?: ColumnsList;
3429
+ /**
3430
+ * Represents a single row in the query results.
3431
+ */
3432
+ rows?: Rows;
3433
+ /**
3434
+ * The string that specifies the next page of results.
3435
+ */
3436
+ nextToken?: ExecuteQueryNextToken;
3437
+ }
2727
3438
  export type Expression = string;
2728
3439
  export interface ExpressionVariable {
2729
3440
  /**
@@ -2736,6 +3447,7 @@ declare namespace IoTSiteWise {
2736
3447
  value: VariableValue;
2737
3448
  }
2738
3449
  export type ExpressionVariables = ExpressionVariable[];
3450
+ export type ExternalId = string;
2739
3451
  export interface File {
2740
3452
  /**
2741
3453
  * The name of the Amazon S3 bucket from which data is imported.
@@ -2752,9 +3464,13 @@ declare namespace IoTSiteWise {
2752
3464
  }
2753
3465
  export interface FileFormat {
2754
3466
  /**
2755
- * The .csv file format.
3467
+ * The file is in .CSV format.
2756
3468
  */
2757
3469
  csv?: Csv;
3470
+ /**
3471
+ * The file is in parquet format.
3472
+ */
3473
+ parquet?: Parquet;
2758
3474
  }
2759
3475
  export type Files = File[];
2760
3476
  export interface ForwardingConfig {
@@ -2811,11 +3527,11 @@ declare namespace IoTSiteWise {
2811
3527
  }
2812
3528
  export interface GetAssetPropertyAggregatesRequest {
2813
3529
  /**
2814
- * The ID of the asset.
3530
+ * The ID of the asset, in UUID format.
2815
3531
  */
2816
3532
  assetId?: ID;
2817
3533
  /**
2818
- * The ID of the asset property.
3534
+ * The ID of the asset property, in UUID format.
2819
3535
  */
2820
3536
  propertyId?: ID;
2821
3537
  /**
@@ -2851,7 +3567,7 @@ declare namespace IoTSiteWise {
2851
3567
  */
2852
3568
  nextToken?: NextToken;
2853
3569
  /**
2854
- * The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first. The size of the result set is equal to 1 MB. The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 250.
3570
+ * The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first. The size of the result set is equal to 1 MB. The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 2500.
2855
3571
  */
2856
3572
  maxResults?: GetAssetPropertyValueAggregatesMaxResults;
2857
3573
  }
@@ -2869,11 +3585,11 @@ declare namespace IoTSiteWise {
2869
3585
  export type GetAssetPropertyValueHistoryMaxResults = number;
2870
3586
  export interface GetAssetPropertyValueHistoryRequest {
2871
3587
  /**
2872
- * The ID of the asset.
3588
+ * The ID of the asset, in UUID format.
2873
3589
  */
2874
3590
  assetId?: ID;
2875
3591
  /**
2876
- * The ID of the asset property.
3592
+ * The ID of the asset property, in UUID format.
2877
3593
  */
2878
3594
  propertyId?: ID;
2879
3595
  /**
@@ -2917,11 +3633,11 @@ declare namespace IoTSiteWise {
2917
3633
  }
2918
3634
  export interface GetAssetPropertyValueRequest {
2919
3635
  /**
2920
- * The ID of the asset.
3636
+ * The ID of the asset, in UUID format.
2921
3637
  */
2922
3638
  assetId?: ID;
2923
3639
  /**
2924
- * The ID of the asset property.
3640
+ * The ID of the asset property, in UUID format.
2925
3641
  */
2926
3642
  propertyId?: ID;
2927
3643
  /**
@@ -2937,11 +3653,11 @@ declare namespace IoTSiteWise {
2937
3653
  }
2938
3654
  export interface GetInterpolatedAssetPropertyValuesRequest {
2939
3655
  /**
2940
- * The ID of the asset.
3656
+ * The ID of the asset, in UUID format.
2941
3657
  */
2942
3658
  assetId?: ID;
2943
3659
  /**
2944
- * The ID of the asset property.
3660
+ * The ID of the asset property, in UUID format.
2945
3661
  */
2946
3662
  propertyId?: ID;
2947
3663
  /**
@@ -3091,7 +3807,7 @@ declare namespace IoTSiteWise {
3091
3807
  export type IntervalWindowInSeconds = number;
3092
3808
  export interface JobConfiguration {
3093
3809
  /**
3094
- * The file format of the data in Amazon S3.
3810
+ * The file format of the data in S3.
3095
3811
  */
3096
3812
  fileFormat: FileFormat;
3097
3813
  }
@@ -3107,7 +3823,7 @@ declare namespace IoTSiteWise {
3107
3823
  */
3108
3824
  name: Name;
3109
3825
  /**
3110
- * The status of the bulk import job can be one of following values. PENDING – IoT SiteWise is waiting for the current bulk import job to finish. CANCELLED – The bulk import job has been canceled. RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3. COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3. FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues. COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
3826
+ * The status of the bulk import job can be one of following values: PENDING – IoT SiteWise is waiting for the current bulk import job to finish. CANCELLED – The bulk import job has been canceled. RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3. COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3. FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues. COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
3111
3827
  */
3112
3828
  status: JobStatus;
3113
3829
  }
@@ -3152,12 +3868,64 @@ declare namespace IoTSiteWise {
3152
3868
  */
3153
3869
  nextToken?: NextToken;
3154
3870
  }
3871
+ export interface ListActionsRequest {
3872
+ /**
3873
+ * The type of resource.
3874
+ */
3875
+ targetResourceType: TargetResourceType;
3876
+ /**
3877
+ * The ID of the target resource.
3878
+ */
3879
+ targetResourceId: CustomID;
3880
+ /**
3881
+ * The token to be used for the next set of paginated results.
3882
+ */
3883
+ nextToken?: NextToken;
3884
+ /**
3885
+ * The maximum number of results to return for each paginated request.
3886
+ */
3887
+ maxResults?: MaxResults;
3888
+ }
3889
+ export interface ListActionsResponse {
3890
+ /**
3891
+ * A list that summarizes the actions associated with the specified asset.
3892
+ */
3893
+ actionSummaries: ActionSummaries;
3894
+ /**
3895
+ * The token for the next set of results, or null if there are no additional results.
3896
+ */
3897
+ nextToken: NextToken;
3898
+ }
3899
+ export interface ListAssetModelCompositeModelsRequest {
3900
+ /**
3901
+ * The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
3902
+ */
3903
+ assetModelId: CustomID;
3904
+ /**
3905
+ * The token to be used for the next set of paginated results.
3906
+ */
3907
+ nextToken?: NextToken;
3908
+ /**
3909
+ * The maximum number of results to return for each paginated request. Default: 50
3910
+ */
3911
+ maxResults?: MaxResults;
3912
+ }
3913
+ export interface ListAssetModelCompositeModelsResponse {
3914
+ /**
3915
+ * A list that summarizes each composite model.
3916
+ */
3917
+ assetModelCompositeModelSummaries: AssetModelCompositeModelSummaries;
3918
+ /**
3919
+ * The token for the next set of results, or null if there are no additional results.
3920
+ */
3921
+ nextToken?: NextToken;
3922
+ }
3155
3923
  export type ListAssetModelPropertiesFilter = "ALL"|"BASE"|string;
3156
3924
  export interface ListAssetModelPropertiesRequest {
3157
3925
  /**
3158
- * The ID of the asset model.
3926
+ * The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
3159
3927
  */
3160
- assetModelId: ID;
3928
+ assetModelId: CustomID;
3161
3929
  /**
3162
3930
  * The token to be used for the next set of paginated results.
3163
3931
  */
@@ -3190,6 +3958,10 @@ declare namespace IoTSiteWise {
3190
3958
  * The maximum number of results to return for each paginated request. Default: 50
3191
3959
  */
3192
3960
  maxResults?: MaxResults;
3961
+ /**
3962
+ * The type of asset model. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
3963
+ */
3964
+ assetModelTypes?: ListAssetModelsTypeFilter;
3193
3965
  }
3194
3966
  export interface ListAssetModelsResponse {
3195
3967
  /**
@@ -3201,12 +3973,13 @@ declare namespace IoTSiteWise {
3201
3973
  */
3202
3974
  nextToken?: NextToken;
3203
3975
  }
3976
+ export type ListAssetModelsTypeFilter = AssetModelType[];
3204
3977
  export type ListAssetPropertiesFilter = "ALL"|"BASE"|string;
3205
3978
  export interface ListAssetPropertiesRequest {
3206
3979
  /**
3207
- * The ID of the asset.
3980
+ * The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
3208
3981
  */
3209
- assetId: ID;
3982
+ assetId: CustomID;
3210
3983
  /**
3211
3984
  * The token to be used for the next set of paginated results.
3212
3985
  */
@@ -3232,9 +4005,9 @@ declare namespace IoTSiteWise {
3232
4005
  }
3233
4006
  export interface ListAssetRelationshipsRequest {
3234
4007
  /**
3235
- * The ID of the asset.
4008
+ * The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
3236
4009
  */
3237
- assetId: ID;
4010
+ assetId: CustomID;
3238
4011
  /**
3239
4012
  * The type of traversal to use to identify asset relationships. Choose the following option: PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.
3240
4013
  */
@@ -3269,9 +4042,9 @@ declare namespace IoTSiteWise {
3269
4042
  */
3270
4043
  maxResults?: MaxResults;
3271
4044
  /**
3272
- * The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter.
4045
+ * The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
3273
4046
  */
3274
- assetModelId?: ID;
4047
+ assetModelId?: CustomID;
3275
4048
  /**
3276
4049
  * The filter for the requested list of assets. Choose one of the following options: ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL. TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree. Default: ALL
3277
4050
  */
@@ -3289,13 +4062,13 @@ declare namespace IoTSiteWise {
3289
4062
  }
3290
4063
  export interface ListAssociatedAssetsRequest {
3291
4064
  /**
3292
- * The ID of the asset to query.
4065
+ * The ID of the asset to query. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
3293
4066
  */
3294
- assetId: ID;
4067
+ assetId: CustomID;
3295
4068
  /**
3296
- * The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
4069
+ * The ID of the hierarchy by which child assets are associated to the asset. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
3297
4070
  */
3298
- hierarchyId?: ID;
4071
+ hierarchyId?: CustomID;
3299
4072
  /**
3300
4073
  * The direction to list associated assets. Choose one of the following options: CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD. PARENT – The list includes the asset's parent asset. Default: CHILD
3301
4074
  */
@@ -3344,6 +4117,30 @@ declare namespace IoTSiteWise {
3344
4117
  */
3345
4118
  nextToken?: NextToken;
3346
4119
  }
4120
+ export interface ListCompositionRelationshipsRequest {
4121
+ /**
4122
+ * The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
4123
+ */
4124
+ assetModelId: ID;
4125
+ /**
4126
+ * The token to be used for the next set of paginated results.
4127
+ */
4128
+ nextToken?: NextToken;
4129
+ /**
4130
+ * The maximum number of results to return for each paginated request. Default: 50
4131
+ */
4132
+ maxResults?: MaxResults;
4133
+ }
4134
+ export interface ListCompositionRelationshipsResponse {
4135
+ /**
4136
+ * A list that summarizes each composition relationship.
4137
+ */
4138
+ compositionRelationshipSummaries: CompositionRelationshipSummaries;
4139
+ /**
4140
+ * The token for the next set of results, or null if there are no additional results.
4141
+ */
4142
+ nextToken?: NextToken;
4143
+ }
3347
4144
  export interface ListDashboardsRequest {
3348
4145
  /**
3349
4146
  * The ID of the project.
@@ -3478,9 +4275,9 @@ declare namespace IoTSiteWise {
3478
4275
  */
3479
4276
  maxResults?: MaxResults;
3480
4277
  /**
3481
- * The ID of the asset in which the asset property was created.
4278
+ * The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
3482
4279
  */
3483
- assetId?: ID;
4280
+ assetId?: CustomID;
3484
4281
  /**
3485
4282
  * The alias prefix of the time series.
3486
4283
  */
@@ -3573,9 +4370,12 @@ declare namespace IoTSiteWise {
3573
4370
  }
3574
4371
  export type Name = string;
3575
4372
  export type NextToken = string;
4373
+ export type NullableBoolean = boolean;
3576
4374
  export type NumberOfDays = number;
3577
4375
  export type Offset = string;
3578
4376
  export type OffsetInNanos = number;
4377
+ export interface Parquet {
4378
+ }
3579
4379
  export type Permission = "ADMINISTRATOR"|"VIEWER"|string;
3580
4380
  export type PortalClientId = string;
3581
4381
  export interface PortalResource {
@@ -3685,6 +4485,14 @@ declare namespace IoTSiteWise {
3685
4485
  * The property type (see PropertyType). A property contains one type.
3686
4486
  */
3687
4487
  type?: PropertyType;
4488
+ /**
4489
+ * The structured path to the property from the root of the asset.
4490
+ */
4491
+ path?: AssetPropertyPath;
4492
+ /**
4493
+ * The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
4494
+ */
4495
+ externalId?: ExternalId;
3688
4496
  }
3689
4497
  export type PropertyAlias = string;
3690
4498
  export type PropertyDataType = "STRING"|"INTEGER"|"DOUBLE"|"BOOLEAN"|"STRUCT"|string;
@@ -3792,6 +4600,14 @@ declare namespace IoTSiteWise {
3792
4600
  */
3793
4601
  disassociatedDataStorage?: DisassociatedDataStorageState;
3794
4602
  retentionPeriod?: RetentionPeriod;
4603
+ /**
4604
+ * A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.
4605
+ */
4606
+ warmTier?: WarmTierState;
4607
+ /**
4608
+ * Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.
4609
+ */
4610
+ warmTierRetentionPeriod?: WarmTierRetentionPeriod;
3795
4611
  }
3796
4612
  export interface PutStorageConfigurationResponse {
3797
4613
  /**
@@ -3808,9 +4624,18 @@ declare namespace IoTSiteWise {
3808
4624
  disassociatedDataStorage?: DisassociatedDataStorageState;
3809
4625
  retentionPeriod?: RetentionPeriod;
3810
4626
  configurationStatus: ConfigurationStatus;
4627
+ /**
4628
+ * A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.
4629
+ */
4630
+ warmTier?: WarmTierState;
4631
+ /**
4632
+ * Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.
4633
+ */
4634
+ warmTierRetentionPeriod?: WarmTierRetentionPeriod;
3811
4635
  }
3812
4636
  export type Qualities = Quality[];
3813
4637
  export type Quality = "GOOD"|"BAD"|"UNCERTAIN"|string;
4638
+ export type QueryStatement = string;
3814
4639
  export type Resolution = string;
3815
4640
  export interface Resource {
3816
4641
  /**
@@ -3833,7 +4658,16 @@ declare namespace IoTSiteWise {
3833
4658
  */
3834
4659
  unlimited?: Unlimited;
3835
4660
  }
4661
+ export interface Row {
4662
+ /**
4663
+ * List of data points in a single row of the result set.
4664
+ */
4665
+ data: DatumList;
4666
+ }
4667
+ export type Rows = Row[];
3836
4668
  export type SSOApplicationId = string;
4669
+ export type ScalarType = "BOOLEAN"|"INT"|"DOUBLE"|"TIMESTAMP"|"STRING"|string;
4670
+ export type ScalarValue = string;
3837
4671
  export type StorageType = "SITEWISE_DEFAULT_STORAGE"|"MULTI_LAYER_STORAGE"|string;
3838
4672
  export type String = string;
3839
4673
  export type TagKey = string;
@@ -3852,6 +4686,13 @@ declare namespace IoTSiteWise {
3852
4686
  export interface TagResourceResponse {
3853
4687
  }
3854
4688
  export type TagValue = string;
4689
+ export interface TargetResource {
4690
+ /**
4691
+ * The ID of the asset, in UUID format.
4692
+ */
4693
+ assetId: CustomID;
4694
+ }
4695
+ export type TargetResourceType = "ASSET"|string;
3855
4696
  export interface TimeInNanos {
3856
4697
  /**
3857
4698
  * The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
@@ -3872,7 +4713,7 @@ declare namespace IoTSiteWise {
3872
4713
  */
3873
4714
  assetId?: ID;
3874
4715
  /**
3875
- * The ID of the asset property.
4716
+ * The ID of the asset property, in UUID format.
3876
4717
  */
3877
4718
  propertyId?: ID;
3878
4719
  /**
@@ -3976,11 +4817,48 @@ declare namespace IoTSiteWise {
3976
4817
  }
3977
4818
  export interface UpdateAccessPolicyResponse {
3978
4819
  }
4820
+ export interface UpdateAssetModelCompositeModelRequest {
4821
+ /**
4822
+ * The ID of the asset model, in UUID format.
4823
+ */
4824
+ assetModelId: CustomID;
4825
+ /**
4826
+ * The ID of a composite model on this asset model.
4827
+ */
4828
+ assetModelCompositeModelId: CustomID;
4829
+ /**
4830
+ * An external ID to assign to the asset model. You can only set the external ID of the asset model if it wasn't set when it was created, or you're setting it to the exact same thing as when it was created.
4831
+ */
4832
+ assetModelCompositeModelExternalId?: ExternalId;
4833
+ /**
4834
+ * A description for the composite model.
4835
+ */
4836
+ assetModelCompositeModelDescription?: Description;
4837
+ /**
4838
+ * A unique, friendly name for the composite model.
4839
+ */
4840
+ assetModelCompositeModelName: Name;
4841
+ /**
4842
+ * 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.
4843
+ */
4844
+ clientToken?: ClientToken;
4845
+ /**
4846
+ * The property definitions of the composite model. For more information, see &lt;LINK&gt;. You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.
4847
+ */
4848
+ assetModelCompositeModelProperties?: AssetModelProperties;
4849
+ }
4850
+ export interface UpdateAssetModelCompositeModelResponse {
4851
+ /**
4852
+ * The path to the composite model listing the parent composite models.
4853
+ */
4854
+ assetModelCompositeModelPath: AssetModelCompositeModelPath;
4855
+ assetModelStatus: AssetModelStatus;
4856
+ }
3979
4857
  export interface UpdateAssetModelRequest {
3980
4858
  /**
3981
- * The ID of the asset model to update.
4859
+ * The ID of the asset model to update. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
3982
4860
  */
3983
- assetModelId: ID;
4861
+ assetModelId: CustomID;
3984
4862
  /**
3985
4863
  * A unique, friendly name for the asset model.
3986
4864
  */
@@ -3998,13 +4876,17 @@ declare namespace IoTSiteWise {
3998
4876
  */
3999
4877
  assetModelHierarchies?: AssetModelHierarchies;
4000
4878
  /**
4001
- * The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.
4879
+ * The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model. When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see &lt;LINK&gt;.
4002
4880
  */
4003
4881
  assetModelCompositeModels?: AssetModelCompositeModels;
4004
4882
  /**
4005
4883
  * 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.
4006
4884
  */
4007
4885
  clientToken?: ClientToken;
4886
+ /**
4887
+ * An external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
4888
+ */
4889
+ assetModelExternalId?: ExternalId;
4008
4890
  }
4009
4891
  export interface UpdateAssetModelResponse {
4010
4892
  /**
@@ -4014,13 +4896,13 @@ declare namespace IoTSiteWise {
4014
4896
  }
4015
4897
  export interface UpdateAssetPropertyRequest {
4016
4898
  /**
4017
- * The ID of the asset to be updated.
4899
+ * The ID of the asset to be updated. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
4018
4900
  */
4019
- assetId: ID;
4901
+ assetId: CustomID;
4020
4902
  /**
4021
- * The ID of the asset property to be updated.
4903
+ * The ID of the asset property to be updated. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
4022
4904
  */
4023
- propertyId: ID;
4905
+ propertyId: CustomID;
4024
4906
  /**
4025
4907
  * The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. If you omit this parameter, the alias is removed from the property.
4026
4908
  */
@@ -4040,9 +4922,9 @@ declare namespace IoTSiteWise {
4040
4922
  }
4041
4923
  export interface UpdateAssetRequest {
4042
4924
  /**
4043
- * The ID of the asset to update.
4925
+ * The ID of the asset to update. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
4044
4926
  */
4045
- assetId: ID;
4927
+ assetId: CustomID;
4046
4928
  /**
4047
4929
  * A friendly name for the asset.
4048
4930
  */
@@ -4055,6 +4937,10 @@ declare namespace IoTSiteWise {
4055
4937
  * A description for the asset.
4056
4938
  */
4057
4939
  assetDescription?: Description;
4940
+ /**
4941
+ * An external ID to assign to the asset. The asset must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
4942
+ */
4943
+ assetExternalId?: ExternalId;
4058
4944
  }
4059
4945
  export interface UpdateAssetResponse {
4060
4946
  /**
@@ -4191,13 +5077,17 @@ declare namespace IoTSiteWise {
4191
5077
  export type VariableName = string;
4192
5078
  export interface VariableValue {
4193
5079
  /**
4194
- * The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
5080
+ * The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
4195
5081
  */
4196
- propertyId: Macro;
5082
+ propertyId?: Macro;
4197
5083
  /**
4198
- * The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
5084
+ * The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide. You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
4199
5085
  */
4200
5086
  hierarchyId?: Macro;
5087
+ /**
5088
+ * The path of the property.
5089
+ */
5090
+ propertyPath?: AssetModelPropertyPath;
4201
5091
  }
4202
5092
  export interface Variant {
4203
5093
  /**
@@ -4205,7 +5095,7 @@ declare namespace IoTSiteWise {
4205
5095
  */
4206
5096
  stringValue?: PropertyValueStringValue;
4207
5097
  /**
4208
- * Asset property data of type integer (whole number).
5098
+ * Asset property data of type integer (number that's greater than or equal to zero).
4209
5099
  */
4210
5100
  integerValue?: PropertyValueIntegerValue;
4211
5101
  /**
@@ -4217,6 +5107,17 @@ declare namespace IoTSiteWise {
4217
5107
  */
4218
5108
  booleanValue?: PropertyValueBooleanValue;
4219
5109
  }
5110
+ export interface WarmTierRetentionPeriod {
5111
+ /**
5112
+ * The number of days the data is stored in the warm tier.
5113
+ */
5114
+ numberOfDays?: NumberOfDays;
5115
+ /**
5116
+ * If set to true, the data is stored indefinitely in the warm tier.
5117
+ */
5118
+ unlimited?: Unlimited;
5119
+ }
5120
+ export type WarmTierState = "ENABLED"|"DISABLED"|string;
4220
5121
  /**
4221
5122
  * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
4222
5123
  */