@aws-sdk/client-iotsitewise 3.848.0 → 3.856.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (113) hide show
  1. package/README.md +80 -0
  2. package/dist-cjs/index.js +749 -35
  3. package/dist-es/IoTSiteWise.js +20 -0
  4. package/dist-es/commands/CreateComputationModelCommand.js +22 -0
  5. package/dist-es/commands/DeleteComputationModelCommand.js +22 -0
  6. package/dist-es/commands/DescribeComputationModelCommand.js +22 -0
  7. package/dist-es/commands/DescribeComputationModelExecutionSummaryCommand.js +22 -0
  8. package/dist-es/commands/DescribeExecutionCommand.js +22 -0
  9. package/dist-es/commands/ListComputationModelDataBindingUsagesCommand.js +22 -0
  10. package/dist-es/commands/ListComputationModelResolveToResourcesCommand.js +22 -0
  11. package/dist-es/commands/ListComputationModelsCommand.js +22 -0
  12. package/dist-es/commands/ListExecutionsCommand.js +22 -0
  13. package/dist-es/commands/UpdateComputationModelCommand.js +22 -0
  14. package/dist-es/commands/index.js +10 -0
  15. package/dist-es/models/models_0.js +15 -27
  16. package/dist-es/models/models_1.js +31 -0
  17. package/dist-es/pagination/ListComputationModelDataBindingUsagesPaginator.js +4 -0
  18. package/dist-es/pagination/ListComputationModelResolveToResourcesPaginator.js +4 -0
  19. package/dist-es/pagination/ListComputationModelsPaginator.js +4 -0
  20. package/dist-es/pagination/ListExecutionsPaginator.js +4 -0
  21. package/dist-es/pagination/index.js +4 -0
  22. package/dist-es/protocols/Aws_restJson1.js +482 -0
  23. package/dist-types/IoTSiteWise.d.ts +71 -0
  24. package/dist-types/IoTSiteWiseClient.d.ts +12 -2
  25. package/dist-types/commands/AssociateAssetsCommand.d.ts +1 -1
  26. package/dist-types/commands/BatchAssociateProjectAssetsCommand.d.ts +1 -1
  27. package/dist-types/commands/BatchPutAssetPropertyValueCommand.d.ts +1 -1
  28. package/dist-types/commands/CreateAccessPolicyCommand.d.ts +1 -1
  29. package/dist-types/commands/CreateAssetCommand.d.ts +3 -3
  30. package/dist-types/commands/CreateAssetModelCommand.d.ts +1 -1
  31. package/dist-types/commands/CreateAssetModelCompositeModelCommand.d.ts +1 -1
  32. package/dist-types/commands/CreateBulkImportJobCommand.d.ts +14 -3
  33. package/dist-types/commands/CreateComputationModelCommand.d.ts +154 -0
  34. package/dist-types/commands/CreateDashboardCommand.d.ts +1 -1
  35. package/dist-types/commands/CreateDatasetCommand.d.ts +1 -1
  36. package/dist-types/commands/CreateGatewayCommand.d.ts +1 -1
  37. package/dist-types/commands/CreatePortalCommand.d.ts +1 -1
  38. package/dist-types/commands/CreateProjectCommand.d.ts +1 -1
  39. package/dist-types/commands/DeleteComputationModelCommand.d.ts +105 -0
  40. package/dist-types/commands/DescribeActionCommand.d.ts +5 -1
  41. package/dist-types/commands/DescribeAssetCommand.d.ts +4 -4
  42. package/dist-types/commands/DescribeAssetCompositeModelCommand.d.ts +1 -1
  43. package/dist-types/commands/DescribeAssetPropertyCommand.d.ts +3 -3
  44. package/dist-types/commands/DescribeComputationModelCommand.d.ts +148 -0
  45. package/dist-types/commands/DescribeComputationModelExecutionSummaryCommand.d.ts +96 -0
  46. package/dist-types/commands/DescribeExecutionCommand.d.ts +109 -0
  47. package/dist-types/commands/DescribeGatewayCapabilityConfigurationCommand.d.ts +18 -5
  48. package/dist-types/commands/DescribeStorageConfigurationCommand.d.ts +1 -1
  49. package/dist-types/commands/ExecuteActionCommand.d.ts +6 -2
  50. package/dist-types/commands/InvokeAssistantCommand.d.ts +1 -1
  51. package/dist-types/commands/ListAccessPoliciesCommand.d.ts +1 -1
  52. package/dist-types/commands/ListActionsCommand.d.ts +8 -2
  53. package/dist-types/commands/ListAssetModelCompositeModelsCommand.d.ts +1 -1
  54. package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +1 -1
  55. package/dist-types/commands/ListAssetModelsCommand.d.ts +1 -1
  56. package/dist-types/commands/ListAssetPropertiesCommand.d.ts +2 -2
  57. package/dist-types/commands/ListAssetRelationshipsCommand.d.ts +1 -1
  58. package/dist-types/commands/ListAssetsCommand.d.ts +3 -4
  59. package/dist-types/commands/ListAssociatedAssetsCommand.d.ts +2 -2
  60. package/dist-types/commands/ListComputationModelDataBindingUsagesCommand.d.ts +126 -0
  61. package/dist-types/commands/ListComputationModelResolveToResourcesCommand.d.ts +97 -0
  62. package/dist-types/commands/ListComputationModelsCommand.d.ts +112 -0
  63. package/dist-types/commands/ListExecutionsCommand.d.ts +114 -0
  64. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  65. package/dist-types/commands/PutDefaultEncryptionConfigurationCommand.d.ts +1 -1
  66. package/dist-types/commands/PutStorageConfigurationCommand.d.ts +1 -1
  67. package/dist-types/commands/TagResourceCommand.d.ts +2 -2
  68. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  69. package/dist-types/commands/UpdateAssetCommand.d.ts +1 -1
  70. package/dist-types/commands/UpdateAssetModelCommand.d.ts +1 -1
  71. package/dist-types/commands/UpdateAssetModelCompositeModelCommand.d.ts +1 -1
  72. package/dist-types/commands/UpdateComputationModelCommand.d.ts +149 -0
  73. package/dist-types/commands/UpdateDatasetCommand.d.ts +1 -1
  74. package/dist-types/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +21 -6
  75. package/dist-types/commands/index.d.ts +10 -0
  76. package/dist-types/models/models_0.d.ts +521 -596
  77. package/dist-types/models/models_1.d.ts +1095 -45
  78. package/dist-types/pagination/ListComputationModelDataBindingUsagesPaginator.d.ts +7 -0
  79. package/dist-types/pagination/ListComputationModelResolveToResourcesPaginator.d.ts +7 -0
  80. package/dist-types/pagination/ListComputationModelsPaginator.d.ts +7 -0
  81. package/dist-types/pagination/ListExecutionsPaginator.d.ts +7 -0
  82. package/dist-types/pagination/index.d.ts +4 -0
  83. package/dist-types/protocols/Aws_restJson1.d.ts +90 -0
  84. package/dist-types/ts3.4/IoTSiteWise.d.ts +189 -0
  85. package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +60 -0
  86. package/dist-types/ts3.4/commands/CreateComputationModelCommand.d.ts +49 -0
  87. package/dist-types/ts3.4/commands/DeleteComputationModelCommand.d.ts +51 -0
  88. package/dist-types/ts3.4/commands/DescribeComputationModelCommand.d.ts +49 -0
  89. package/dist-types/ts3.4/commands/DescribeComputationModelExecutionSummaryCommand.d.ts +51 -0
  90. package/dist-types/ts3.4/commands/DescribeExecutionCommand.d.ts +51 -0
  91. package/dist-types/ts3.4/commands/ListAccessPoliciesCommand.d.ts +1 -1
  92. package/dist-types/ts3.4/commands/ListActionsCommand.d.ts +1 -1
  93. package/dist-types/ts3.4/commands/ListAssetModelCompositeModelsCommand.d.ts +1 -1
  94. package/dist-types/ts3.4/commands/ListAssetModelPropertiesCommand.d.ts +1 -1
  95. package/dist-types/ts3.4/commands/ListAssetModelsCommand.d.ts +1 -1
  96. package/dist-types/ts3.4/commands/ListAssetPropertiesCommand.d.ts +1 -1
  97. package/dist-types/ts3.4/commands/ListAssetRelationshipsCommand.d.ts +1 -1
  98. package/dist-types/ts3.4/commands/ListAssetsCommand.d.ts +1 -2
  99. package/dist-types/ts3.4/commands/ListComputationModelDataBindingUsagesCommand.d.ts +51 -0
  100. package/dist-types/ts3.4/commands/ListComputationModelResolveToResourcesCommand.d.ts +51 -0
  101. package/dist-types/ts3.4/commands/ListComputationModelsCommand.d.ts +51 -0
  102. package/dist-types/ts3.4/commands/ListExecutionsCommand.d.ts +50 -0
  103. package/dist-types/ts3.4/commands/UpdateComputationModelCommand.d.ts +51 -0
  104. package/dist-types/ts3.4/commands/index.d.ts +10 -0
  105. package/dist-types/ts3.4/models/models_0.d.ts +116 -131
  106. package/dist-types/ts3.4/models/models_1.d.ts +279 -1
  107. package/dist-types/ts3.4/pagination/ListComputationModelDataBindingUsagesPaginator.d.ts +11 -0
  108. package/dist-types/ts3.4/pagination/ListComputationModelResolveToResourcesPaginator.d.ts +11 -0
  109. package/dist-types/ts3.4/pagination/ListComputationModelsPaginator.d.ts +11 -0
  110. package/dist-types/ts3.4/pagination/ListExecutionsPaginator.d.ts +11 -0
  111. package/dist-types/ts3.4/pagination/index.d.ts +4 -0
  112. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +120 -0
  113. package/package.json +5 -5
@@ -1,6 +1,515 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { IoTSiteWiseServiceException as __BaseException } from "./IoTSiteWiseServiceException";
3
- import { Alarms, AssetModelCompositeModel, AssetModelCompositeModelPathSegment, AssetModelHierarchy, AssetModelProperty, AssetModelStatus, AssetModelVersionType, AssetStatus, AssetSummary, AssociatedAssetsSummary, CapabilitySyncStatus, ColumnInfo, ConfigurationStatus, DatasetSource, DatasetSourceType, DatasetStatus, DisassociatedDataStorageState, EncryptionType, GatewayCapabilitySummary, GatewayPlatform, Identity, ImageFile, JobStatus, LoggingOptions, MultiLayerStorage, Permission, PortalStatus, PortalType, PortalTypeEntry, PropertyDataType, PropertyNotificationState, Resource, RetentionPeriod, StorageType, WarmTierRetentionPeriod, WarmTierState } from "./models_0";
3
+ import { AccessPolicySummary, ActionDefinition, ActionSummary, Alarms, AssetBindingValueFilter, AssetModelBindingValueFilter, AssetModelCompositeModel, AssetModelCompositeModelPathSegment, AssetModelCompositeModelSummary, AssetModelHierarchy, AssetModelProperty, AssetModelPropertyBindingValue, AssetModelPropertyBindingValueFilter, AssetModelPropertySummary, AssetModelStatus, AssetModelSummary, AssetModelType, AssetModelVersionType, AssetPropertyBindingValue, AssetPropertyBindingValueFilter, AssetPropertySummary, AssetRelationshipSummary, AssetStatus, AssetSummary, AssociatedAssetsSummary, CapabilitySyncStatus, ColumnInfo, ComputationModelConfiguration, ComputationModelStatus, ConfigurationStatus, DatasetSource, DatasetSourceType, DatasetStatus, DisassociatedDataStorageState, EncryptionType, ExecutionStatus, GatewayCapabilitySummary, GatewayPlatform, Identity, ImageFile, JobStatus, LoggingOptions, MultiLayerStorage, Permission, PortalStatus, PortalType, PortalTypeEntry, PropertyDataType, PropertyNotificationState, ResolveTo, ResolveToResourceType, Resource, RetentionPeriod, StorageType, TargetResource, WarmTierRetentionPeriod, WarmTierState } from "./models_0";
4
+ /**
5
+ * @public
6
+ * @enum
7
+ */
8
+ export declare const IdentityType: {
9
+ readonly GROUP: "GROUP";
10
+ readonly IAM: "IAM";
11
+ readonly USER: "USER";
12
+ };
13
+ /**
14
+ * @public
15
+ */
16
+ export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
17
+ /**
18
+ * @public
19
+ * @enum
20
+ */
21
+ export declare const ResourceType: {
22
+ readonly PORTAL: "PORTAL";
23
+ readonly PROJECT: "PROJECT";
24
+ };
25
+ /**
26
+ * @public
27
+ */
28
+ export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
29
+ /**
30
+ * @public
31
+ */
32
+ export interface ListAccessPoliciesRequest {
33
+ /**
34
+ * <p>The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required
35
+ * if you specify <code>identityId</code>.</p>
36
+ * @public
37
+ */
38
+ identityType?: IdentityType | undefined;
39
+ /**
40
+ * <p>The ID of the identity. This parameter is required if you specify <code>USER</code> or
41
+ * <code>GROUP</code> for <code>identityType</code>.</p>
42
+ * @public
43
+ */
44
+ identityId?: string | undefined;
45
+ /**
46
+ * <p>The type of resource (portal or project). This parameter is required if you specify
47
+ * <code>resourceId</code>.</p>
48
+ * @public
49
+ */
50
+ resourceType?: ResourceType | undefined;
51
+ /**
52
+ * <p>The ID of the resource. This parameter is required if you specify
53
+ * <code>resourceType</code>.</p>
54
+ * @public
55
+ */
56
+ resourceId?: string | undefined;
57
+ /**
58
+ * <p>The ARN of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM ARNs</a> in the
59
+ * <i>IAM User Guide</i>. This parameter is required if you specify
60
+ * <code>IAM</code> for <code>identityType</code>.</p>
61
+ * @public
62
+ */
63
+ iamArn?: string | undefined;
64
+ /**
65
+ * <p>The token to be used for the next set of paginated results.</p>
66
+ * @public
67
+ */
68
+ nextToken?: string | undefined;
69
+ /**
70
+ * <p>The maximum number of results to return for each paginated request.</p>
71
+ * <p>Default: 50</p>
72
+ * @public
73
+ */
74
+ maxResults?: number | undefined;
75
+ }
76
+ /**
77
+ * @public
78
+ */
79
+ export interface ListAccessPoliciesResponse {
80
+ /**
81
+ * <p>A list that summarizes each access policy.</p>
82
+ * @public
83
+ */
84
+ accessPolicySummaries: AccessPolicySummary[] | undefined;
85
+ /**
86
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
87
+ * @public
88
+ */
89
+ nextToken?: string | undefined;
90
+ }
91
+ /**
92
+ * @public
93
+ * @enum
94
+ */
95
+ export declare const TargetResourceType: {
96
+ readonly ASSET: "ASSET";
97
+ readonly COMPUTATION_MODEL: "COMPUTATION_MODEL";
98
+ };
99
+ /**
100
+ * @public
101
+ */
102
+ export type TargetResourceType = (typeof TargetResourceType)[keyof typeof TargetResourceType];
103
+ /**
104
+ * @public
105
+ */
106
+ export interface ListActionsRequest {
107
+ /**
108
+ * <p>The type of resource.</p>
109
+ * @public
110
+ */
111
+ targetResourceType: TargetResourceType | undefined;
112
+ /**
113
+ * <p>The ID of the target resource.</p>
114
+ * @public
115
+ */
116
+ targetResourceId: string | undefined;
117
+ /**
118
+ * <p>The token to be used for the next set of paginated results.</p>
119
+ * @public
120
+ */
121
+ nextToken?: string | undefined;
122
+ /**
123
+ * <p>The maximum number of results to return for each paginated request.</p>
124
+ * @public
125
+ */
126
+ maxResults?: number | undefined;
127
+ /**
128
+ * <p>The type of the resolved resource.</p>
129
+ * @public
130
+ */
131
+ resolveToResourceType?: ResolveToResourceType | undefined;
132
+ /**
133
+ * <p>The ID of the resolved resource.</p>
134
+ * @public
135
+ */
136
+ resolveToResourceId?: string | undefined;
137
+ }
138
+ /**
139
+ * @public
140
+ */
141
+ export interface ListActionsResponse {
142
+ /**
143
+ * <p>A list that summarizes the actions associated with the specified asset.</p>
144
+ * @public
145
+ */
146
+ actionSummaries: ActionSummary[] | undefined;
147
+ /**
148
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
149
+ * @public
150
+ */
151
+ nextToken: string | undefined;
152
+ }
153
+ /**
154
+ * @public
155
+ */
156
+ export interface ListAssetModelCompositeModelsRequest {
157
+ /**
158
+ * <p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
159
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
160
+ * @public
161
+ */
162
+ assetModelId: string | undefined;
163
+ /**
164
+ * <p>The token to be used for the next set of paginated results.</p>
165
+ * @public
166
+ */
167
+ nextToken?: string | undefined;
168
+ /**
169
+ * <p>The maximum number of results to return for each paginated request.</p>
170
+ * <p>Default: 50</p>
171
+ * @public
172
+ */
173
+ maxResults?: number | undefined;
174
+ /**
175
+ * <p>The version alias that specifies the latest or active version of the asset model.
176
+ * The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html">
177
+ * Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
178
+ * @public
179
+ */
180
+ assetModelVersion?: string | undefined;
181
+ }
182
+ /**
183
+ * @public
184
+ */
185
+ export interface ListAssetModelCompositeModelsResponse {
186
+ /**
187
+ * <p>A list that summarizes each composite model.</p>
188
+ * @public
189
+ */
190
+ assetModelCompositeModelSummaries: AssetModelCompositeModelSummary[] | undefined;
191
+ /**
192
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
193
+ * @public
194
+ */
195
+ nextToken?: string | undefined;
196
+ }
197
+ /**
198
+ * @public
199
+ * @enum
200
+ */
201
+ export declare const ListAssetModelPropertiesFilter: {
202
+ readonly ALL: "ALL";
203
+ readonly BASE: "BASE";
204
+ };
205
+ /**
206
+ * @public
207
+ */
208
+ export type ListAssetModelPropertiesFilter = (typeof ListAssetModelPropertiesFilter)[keyof typeof ListAssetModelPropertiesFilter];
209
+ /**
210
+ * @public
211
+ */
212
+ export interface ListAssetModelPropertiesRequest {
213
+ /**
214
+ * <p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
215
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
216
+ * @public
217
+ */
218
+ assetModelId: string | undefined;
219
+ /**
220
+ * <p>The token to be used for the next set of paginated results.</p>
221
+ * @public
222
+ */
223
+ nextToken?: string | undefined;
224
+ /**
225
+ * <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
226
+ * @public
227
+ */
228
+ maxResults?: number | undefined;
229
+ /**
230
+ * <p> Filters the requested list of asset model properties. You can choose one of the following
231
+ * options:</p>
232
+ * <ul>
233
+ * <li>
234
+ * <p>
235
+ * <code>ALL</code> – The list includes all asset model properties for a given asset
236
+ * model ID. </p>
237
+ * </li>
238
+ * <li>
239
+ * <p>
240
+ * <code>BASE</code> – The list includes only base asset model properties for a given
241
+ * asset model ID. </p>
242
+ * </li>
243
+ * </ul>
244
+ * <p>Default: <code>BASE</code>
245
+ * </p>
246
+ * @public
247
+ */
248
+ filter?: ListAssetModelPropertiesFilter | undefined;
249
+ /**
250
+ * <p>The version alias that specifies the latest or active version of the asset model.
251
+ * The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html">
252
+ * Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
253
+ * @public
254
+ */
255
+ assetModelVersion?: string | undefined;
256
+ }
257
+ /**
258
+ * @public
259
+ */
260
+ export interface ListAssetModelPropertiesResponse {
261
+ /**
262
+ * <p>A list that summarizes the properties associated with the specified asset model.</p>
263
+ * @public
264
+ */
265
+ assetModelPropertySummaries: AssetModelPropertySummary[] | undefined;
266
+ /**
267
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
268
+ * @public
269
+ */
270
+ nextToken?: string | undefined;
271
+ }
272
+ /**
273
+ * @public
274
+ */
275
+ export interface ListAssetModelsRequest {
276
+ /**
277
+ * <p>The type of asset model. If you don't provide an <code>assetModelTypes</code>, all types
278
+ * of asset models are returned.</p>
279
+ * <ul>
280
+ * <li>
281
+ * <p>
282
+ * <b>ASSET_MODEL</b> – An asset model that you can use
283
+ * to create assets. Can't be included as a component in another asset model.</p>
284
+ * </li>
285
+ * <li>
286
+ * <p>
287
+ * <b>COMPONENT_MODEL</b> – A reusable component that
288
+ * you can include in the composite models of other asset models. You can't create
289
+ * assets directly from this type of asset model. </p>
290
+ * </li>
291
+ * </ul>
292
+ * @public
293
+ */
294
+ assetModelTypes?: AssetModelType[] | undefined;
295
+ /**
296
+ * <p>The token to be used for the next set of paginated results.</p>
297
+ * @public
298
+ */
299
+ nextToken?: string | undefined;
300
+ /**
301
+ * <p>The maximum number of results to return for each paginated request.</p>
302
+ * <p>Default: 50</p>
303
+ * @public
304
+ */
305
+ maxResults?: number | undefined;
306
+ /**
307
+ * <p>The version alias that specifies the latest or active version of the asset model.
308
+ * The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html">
309
+ * Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
310
+ * @public
311
+ */
312
+ assetModelVersion?: string | undefined;
313
+ }
314
+ /**
315
+ * @public
316
+ */
317
+ export interface ListAssetModelsResponse {
318
+ /**
319
+ * <p>A list that summarizes each asset model.</p>
320
+ * @public
321
+ */
322
+ assetModelSummaries: AssetModelSummary[] | undefined;
323
+ /**
324
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
325
+ * @public
326
+ */
327
+ nextToken?: string | undefined;
328
+ }
329
+ /**
330
+ * @public
331
+ * @enum
332
+ */
333
+ export declare const ListAssetPropertiesFilter: {
334
+ readonly ALL: "ALL";
335
+ readonly BASE: "BASE";
336
+ };
337
+ /**
338
+ * @public
339
+ */
340
+ export type ListAssetPropertiesFilter = (typeof ListAssetPropertiesFilter)[keyof typeof ListAssetPropertiesFilter];
341
+ /**
342
+ * @public
343
+ */
344
+ export interface ListAssetPropertiesRequest {
345
+ /**
346
+ * <p>The ID of the asset. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
347
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
348
+ * @public
349
+ */
350
+ assetId: string | undefined;
351
+ /**
352
+ * <p>The token to be used for the next set of paginated results.</p>
353
+ * @public
354
+ */
355
+ nextToken?: string | undefined;
356
+ /**
357
+ * <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
358
+ * @public
359
+ */
360
+ maxResults?: number | undefined;
361
+ /**
362
+ * <p> Filters the requested list of asset properties. You can choose one of the following
363
+ * options:</p>
364
+ * <ul>
365
+ * <li>
366
+ * <p>
367
+ * <code>ALL</code> – The list includes all asset properties for a given asset model ID.
368
+ * </p>
369
+ * </li>
370
+ * <li>
371
+ * <p>
372
+ * <code>BASE</code> – The list includes only base asset properties for a given asset
373
+ * model ID. </p>
374
+ * </li>
375
+ * </ul>
376
+ * <p>Default: <code>BASE</code>
377
+ * </p>
378
+ * @public
379
+ */
380
+ filter?: ListAssetPropertiesFilter | undefined;
381
+ }
382
+ /**
383
+ * @public
384
+ */
385
+ export interface ListAssetPropertiesResponse {
386
+ /**
387
+ * <p>A list that summarizes the properties associated with the specified asset.</p>
388
+ * @public
389
+ */
390
+ assetPropertySummaries: AssetPropertySummary[] | undefined;
391
+ /**
392
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
393
+ * @public
394
+ */
395
+ nextToken?: string | undefined;
396
+ }
397
+ /**
398
+ * @public
399
+ * @enum
400
+ */
401
+ export declare const TraversalType: {
402
+ readonly PATH_TO_ROOT: "PATH_TO_ROOT";
403
+ };
404
+ /**
405
+ * @public
406
+ */
407
+ export type TraversalType = (typeof TraversalType)[keyof typeof TraversalType];
408
+ /**
409
+ * @public
410
+ */
411
+ export interface ListAssetRelationshipsRequest {
412
+ /**
413
+ * <p>The ID of the asset. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
414
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
415
+ * @public
416
+ */
417
+ assetId: string | undefined;
418
+ /**
419
+ * <p>The type of traversal to use to identify asset relationships. Choose the following
420
+ * option:</p>
421
+ * <ul>
422
+ * <li>
423
+ * <p>
424
+ * <code>PATH_TO_ROOT</code> – Identify the asset's parent assets up to the root
425
+ * asset. The asset that you specify in <code>assetId</code> is the first result in the list
426
+ * of <code>assetRelationshipSummaries</code>, and the root asset is the last result.</p>
427
+ * </li>
428
+ * </ul>
429
+ * @public
430
+ */
431
+ traversalType: TraversalType | undefined;
432
+ /**
433
+ * <p>The token to be used for the next set of paginated results.</p>
434
+ * @public
435
+ */
436
+ nextToken?: string | undefined;
437
+ /**
438
+ * <p>The maximum number of results to return for each paginated request.</p>
439
+ * @public
440
+ */
441
+ maxResults?: number | undefined;
442
+ }
443
+ /**
444
+ * @public
445
+ */
446
+ export interface ListAssetRelationshipsResponse {
447
+ /**
448
+ * <p>A list that summarizes each asset relationship.</p>
449
+ * @public
450
+ */
451
+ assetRelationshipSummaries: AssetRelationshipSummary[] | undefined;
452
+ /**
453
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
454
+ * @public
455
+ */
456
+ nextToken?: string | undefined;
457
+ }
458
+ /**
459
+ * @public
460
+ * @enum
461
+ */
462
+ export declare const ListAssetsFilter: {
463
+ readonly ALL: "ALL";
464
+ readonly TOP_LEVEL: "TOP_LEVEL";
465
+ };
466
+ /**
467
+ * @public
468
+ */
469
+ export type ListAssetsFilter = (typeof ListAssetsFilter)[keyof typeof ListAssetsFilter];
470
+ /**
471
+ * @public
472
+ */
473
+ export interface ListAssetsRequest {
474
+ /**
475
+ * <p>The token to be used for the next set of paginated results.</p>
476
+ * @public
477
+ */
478
+ nextToken?: string | undefined;
479
+ /**
480
+ * <p>The maximum number of results to return for each paginated request.</p>
481
+ * <p>Default: 50</p>
482
+ * @public
483
+ */
484
+ maxResults?: number | undefined;
485
+ /**
486
+ * <p>The ID of the asset model by which to filter the list of assets. This parameter is
487
+ * required if you choose <code>ALL</code> for <code>filter</code>. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
488
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
489
+ * @public
490
+ */
491
+ assetModelId?: string | undefined;
492
+ /**
493
+ * <p>The filter for the requested list of assets. Choose one of the following options:</p>
494
+ * <ul>
495
+ * <li>
496
+ * <p>
497
+ * <code>ALL</code> – The list includes all assets for a given asset model ID. The
498
+ * <code>assetModelId</code> parameter is required if you filter by
499
+ * <code>ALL</code>.</p>
500
+ * </li>
501
+ * <li>
502
+ * <p>
503
+ * <code>TOP_LEVEL</code> – The list includes only top-level assets in the asset
504
+ * hierarchy tree.</p>
505
+ * </li>
506
+ * </ul>
507
+ * <p>Default: <code>ALL</code>
508
+ * </p>
509
+ * @public
510
+ */
511
+ filter?: ListAssetsFilter | undefined;
512
+ }
4
513
  /**
5
514
  * @public
6
515
  */
@@ -177,33 +686,266 @@ export interface JobSummary {
177
686
  * </ul>
178
687
  * @public
179
688
  */
180
- status: JobStatus | undefined;
689
+ status: JobStatus | undefined;
690
+ }
691
+ /**
692
+ * @public
693
+ */
694
+ export interface ListBulkImportJobsResponse {
695
+ /**
696
+ * <p>One or more job summaries to list.</p>
697
+ * @public
698
+ */
699
+ jobSummaries: JobSummary[] | undefined;
700
+ /**
701
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
702
+ * @public
703
+ */
704
+ nextToken?: string | undefined;
705
+ }
706
+ /**
707
+ * @public
708
+ */
709
+ export interface ListCompositionRelationshipsRequest {
710
+ /**
711
+ * <p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
712
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
713
+ * @public
714
+ */
715
+ assetModelId: string | undefined;
716
+ /**
717
+ * <p>The token to be used for the next set of paginated results.</p>
718
+ * @public
719
+ */
720
+ nextToken?: string | undefined;
721
+ /**
722
+ * <p>The maximum number of results to return for each paginated request.</p>
723
+ * <p>Default: 50</p>
724
+ * @public
725
+ */
726
+ maxResults?: number | undefined;
727
+ }
728
+ /**
729
+ * <p>Contains a summary of the components of the composite model.</p>
730
+ * @public
731
+ */
732
+ export interface CompositionRelationshipSummary {
733
+ /**
734
+ * <p>The ID of the asset model, in UUID format.</p>
735
+ * @public
736
+ */
737
+ assetModelId: string | undefined;
738
+ /**
739
+ * <p>The ID of a composite model on this asset model.</p>
740
+ * @public
741
+ */
742
+ assetModelCompositeModelId: string | undefined;
743
+ /**
744
+ * <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or
745
+ * <code> AWS/L4E_ANOMALY</code>.</p>
746
+ * @public
747
+ */
748
+ assetModelCompositeModelType: string | undefined;
749
+ }
750
+ /**
751
+ * @public
752
+ */
753
+ export interface ListCompositionRelationshipsResponse {
754
+ /**
755
+ * <p>A list that summarizes each composition relationship.</p>
756
+ * @public
757
+ */
758
+ compositionRelationshipSummaries: CompositionRelationshipSummary[] | undefined;
759
+ /**
760
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
761
+ * @public
762
+ */
763
+ nextToken?: string | undefined;
764
+ }
765
+ /**
766
+ * <p>A filter used to match specific data binding values based on criteria.
767
+ * This filter allows searching for data bindings by asset, asset model, asset property, or asset model property.</p>
768
+ * @public
769
+ */
770
+ export interface DataBindingValueFilter {
771
+ /**
772
+ * <p>Filter criteria for matching data bindings based on a specific asset.
773
+ * Used to list all data bindings referencing a particular asset or its properties.</p>
774
+ * @public
775
+ */
776
+ asset?: AssetBindingValueFilter | undefined;
777
+ /**
778
+ * <p>Filter criteria for matching data bindings based on a specific asset model.
779
+ * Used to list all data bindings referencing a particular asset model or its properties.</p>
780
+ * @public
781
+ */
782
+ assetModel?: AssetModelBindingValueFilter | undefined;
783
+ /**
784
+ * <p>Filter criteria for matching data bindings based on a specific asset property.
785
+ * Used to list all data bindings referencing a particular property of an asset.</p>
786
+ * @public
787
+ */
788
+ assetProperty?: AssetPropertyBindingValueFilter | undefined;
789
+ /**
790
+ * <p>Filter criteria for matching data bindings based on a specific asset model property.
791
+ * Used to list all data bindings referencing a particular property of an asset model.</p>
792
+ * @public
793
+ */
794
+ assetModelProperty?: AssetModelPropertyBindingValueFilter | undefined;
795
+ }
796
+ /**
797
+ * @public
798
+ */
799
+ export interface ListComputationModelDataBindingUsagesRequest {
800
+ /**
801
+ * <p>A filter used to limit the returned data binding usages based on
802
+ * specific data binding values.
803
+ * You can filter by asset, asset model, asset property,
804
+ * or asset model property to find all computation models
805
+ * using these specific data sources.</p>
806
+ * @public
807
+ */
808
+ dataBindingValueFilter: DataBindingValueFilter | undefined;
809
+ /**
810
+ * <p>The token used for the next set of paginated results.</p>
811
+ * @public
812
+ */
813
+ nextToken?: string | undefined;
814
+ /**
815
+ * <p>The maximum number of results returned for each paginated request.</p>
816
+ * @public
817
+ */
818
+ maxResults?: number | undefined;
819
+ }
820
+ /**
821
+ * <p>Represents a value used in a data binding. It can be an asset property or an asset model property.</p>
822
+ * @public
823
+ */
824
+ export interface DataBindingValue {
825
+ /**
826
+ * <p>Contains information about an <code>assetModelProperty</code> binding value.</p>
827
+ * @public
828
+ */
829
+ assetModelProperty?: AssetModelPropertyBindingValue | undefined;
830
+ /**
831
+ * <p>The asset property value used in the data binding.</p>
832
+ * @public
833
+ */
834
+ assetProperty?: AssetPropertyBindingValue | undefined;
835
+ }
836
+ /**
837
+ * <p>Represents a data binding that matches the specified filter criteria.</p>
838
+ * @public
839
+ */
840
+ export interface MatchedDataBinding {
841
+ /**
842
+ * <p>The value of the matched data binding.</p>
843
+ * @public
844
+ */
845
+ value: DataBindingValue | undefined;
846
+ }
847
+ /**
848
+ * <p>A summary of how a specific data binding is used across computation models.
849
+ * This tracks dependencies between data sources and computation models,
850
+ * allowing you to understand the impact of changes to data sources.</p>
851
+ * @public
852
+ */
853
+ export interface ComputationModelDataBindingUsageSummary {
854
+ /**
855
+ * <p>The list of computation model IDs that use this data binding.
856
+ * This allows identification of all computation models affected by changes to the referenced data source.</p>
857
+ * @public
858
+ */
859
+ computationModelIds: string[] | undefined;
860
+ /**
861
+ * <p>The data binding matched by the filter criteria. Contains details
862
+ * about specific data binding values used by the computation models.</p>
863
+ * @public
864
+ */
865
+ matchedDataBinding: MatchedDataBinding | undefined;
866
+ }
867
+ /**
868
+ * @public
869
+ */
870
+ export interface ListComputationModelDataBindingUsagesResponse {
871
+ /**
872
+ * <p>A list of summaries describing the data binding usages across computation models.
873
+ * Each summary includes the computation model IDs and the matched data binding details.</p>
874
+ * @public
875
+ */
876
+ dataBindingUsageSummaries: ComputationModelDataBindingUsageSummary[] | undefined;
877
+ /**
878
+ * <p>The token for the next set of paginated results, or null if there are no additional results.</p>
879
+ * @public
880
+ */
881
+ nextToken?: string | undefined;
882
+ }
883
+ /**
884
+ * @public
885
+ */
886
+ export interface ListComputationModelResolveToResourcesRequest {
887
+ /**
888
+ * <p>The ID of the computation model for which to list resolved resources.</p>
889
+ * @public
890
+ */
891
+ computationModelId: string | undefined;
892
+ /**
893
+ * <p>The token used for the next set of paginated results.</p>
894
+ * @public
895
+ */
896
+ nextToken?: string | undefined;
897
+ /**
898
+ * <p>The maximum number of results returned for each paginated request.</p>
899
+ * @public
900
+ */
901
+ maxResults?: number | undefined;
181
902
  }
182
903
  /**
904
+ * <p>A summary of the resource that a computation model resolves to.</p>
183
905
  * @public
184
906
  */
185
- export interface ListBulkImportJobsResponse {
907
+ export interface ComputationModelResolveToResourceSummary {
186
908
  /**
187
- * <p>One or more job summaries to list.</p>
909
+ * <p>The detailed resource this execution summary resolves to.</p>
188
910
  * @public
189
911
  */
190
- jobSummaries: JobSummary[] | undefined;
912
+ resolveTo?: ResolveTo | undefined;
913
+ }
914
+ /**
915
+ * @public
916
+ */
917
+ export interface ListComputationModelResolveToResourcesResponse {
191
918
  /**
192
- * <p>The token for the next set of results, or null if there are no additional results.</p>
919
+ * <p>A list of summaries describing the distinct resources that this computation model resolves to when actions were executed.</p>
920
+ * @public
921
+ */
922
+ computationModelResolveToResourceSummaries: ComputationModelResolveToResourceSummary[] | undefined;
923
+ /**
924
+ * <p>The token for the next set of paginated results, or null if there are no additional results.</p>
193
925
  * @public
194
926
  */
195
927
  nextToken?: string | undefined;
196
928
  }
929
+ /**
930
+ * @public
931
+ * @enum
932
+ */
933
+ export declare const ComputationModelType: {
934
+ readonly ANOMALY_DETECTION: "ANOMALY_DETECTION";
935
+ };
197
936
  /**
198
937
  * @public
199
938
  */
200
- export interface ListCompositionRelationshipsRequest {
939
+ export type ComputationModelType = (typeof ComputationModelType)[keyof typeof ComputationModelType];
940
+ /**
941
+ * @public
942
+ */
943
+ export interface ListComputationModelsRequest {
201
944
  /**
202
- * <p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
203
- * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
945
+ * <p>The type of computation model. If a <code>computationModelType</code> is not provided, all types of computation models are returned.</p>
204
946
  * @public
205
947
  */
206
- assetModelId: string | undefined;
948
+ computationModelType?: ComputationModelType | undefined;
207
949
  /**
208
950
  * <p>The token to be used for the next set of paginated results.</p>
209
951
  * @public
@@ -211,42 +953,73 @@ export interface ListCompositionRelationshipsRequest {
211
953
  nextToken?: string | undefined;
212
954
  /**
213
955
  * <p>The maximum number of results to return for each paginated request.</p>
214
- * <p>Default: 50</p>
215
956
  * @public
216
957
  */
217
958
  maxResults?: number | undefined;
218
959
  }
219
960
  /**
220
- * <p>Contains a summary of the components of the composite model.</p>
961
+ * <p>Contains a summary of a computation model.</p>
221
962
  * @public
222
963
  */
223
- export interface CompositionRelationshipSummary {
964
+ export interface ComputationModelSummary {
224
965
  /**
225
- * <p>The ID of the asset model, in UUID format.</p>
966
+ * <p>The ID of the computation model.</p>
226
967
  * @public
227
968
  */
228
- assetModelId: string | undefined;
969
+ id: string | undefined;
229
970
  /**
230
- * <p>The ID of a composite model on this asset model.</p>
971
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the computation model, which has the following format.</p>
972
+ * <p>
973
+ * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:computation-model/$\{ComputationModelId\}</code>
974
+ * </p>
231
975
  * @public
232
976
  */
233
- assetModelCompositeModelId: string | undefined;
977
+ arn: string | undefined;
234
978
  /**
235
- * <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or
236
- * <code> AWS/L4E_ANOMALY</code>.</p>
979
+ * <p>The name of the computation model.</p>
237
980
  * @public
238
981
  */
239
- assetModelCompositeModelType: string | undefined;
982
+ name: string | undefined;
983
+ /**
984
+ * <p>The description of the computation model.</p>
985
+ * @public
986
+ */
987
+ description?: string | undefined;
988
+ /**
989
+ * <p>The type of the computation model.</p>
990
+ * @public
991
+ */
992
+ type: ComputationModelType | undefined;
993
+ /**
994
+ * <p>The model creation date, in Unix epoch time.</p>
995
+ * @public
996
+ */
997
+ creationDate: Date | undefined;
998
+ /**
999
+ * <p>The time the model was last updated, in Unix epoch time.</p>
1000
+ * @public
1001
+ */
1002
+ lastUpdateDate: Date | undefined;
1003
+ /**
1004
+ * <p>The current status of the computation model.</p>
1005
+ * @public
1006
+ */
1007
+ status: ComputationModelStatus | undefined;
1008
+ /**
1009
+ * <p>The version of the computation model.</p>
1010
+ * @public
1011
+ */
1012
+ version: string | undefined;
240
1013
  }
241
1014
  /**
242
1015
  * @public
243
1016
  */
244
- export interface ListCompositionRelationshipsResponse {
1017
+ export interface ListComputationModelsResponse {
245
1018
  /**
246
- * <p>A list that summarizes each composition relationship.</p>
1019
+ * <p>A list summarizing each computation model.</p>
247
1020
  * @public
248
1021
  */
249
- compositionRelationshipSummaries: CompositionRelationshipSummary[] | undefined;
1022
+ computationModelSummaries: ComputationModelSummary[] | undefined;
250
1023
  /**
251
1024
  * <p>The token for the next set of results, or null if there are no additional results.</p>
252
1025
  * @public
@@ -398,6 +1171,112 @@ export interface ListDatasetsResponse {
398
1171
  */
399
1172
  nextToken?: string | undefined;
400
1173
  }
1174
+ /**
1175
+ * @public
1176
+ */
1177
+ export interface ListExecutionsRequest {
1178
+ /**
1179
+ * <p>The type of the target resource.</p>
1180
+ * @public
1181
+ */
1182
+ targetResourceType: TargetResourceType | undefined;
1183
+ /**
1184
+ * <p>The ID of the target resource.</p>
1185
+ * @public
1186
+ */
1187
+ targetResourceId: string | undefined;
1188
+ /**
1189
+ * <p>The type of the resolved resource.</p>
1190
+ * @public
1191
+ */
1192
+ resolveToResourceType?: ResolveToResourceType | undefined;
1193
+ /**
1194
+ * <p>The ID of the resolved resource.</p>
1195
+ * @public
1196
+ */
1197
+ resolveToResourceId?: string | undefined;
1198
+ /**
1199
+ * <p>The token used for the next set of paginated results.</p>
1200
+ * @public
1201
+ */
1202
+ nextToken?: string | undefined;
1203
+ /**
1204
+ * <p>The maximum number of results returned for each paginated request.</p>
1205
+ * @public
1206
+ */
1207
+ maxResults?: number | undefined;
1208
+ /**
1209
+ * <p>The type of action exectued.</p>
1210
+ * @public
1211
+ */
1212
+ actionType?: string | undefined;
1213
+ }
1214
+ /**
1215
+ * <p>Contains the execution summary of the computation model.</p>
1216
+ * @public
1217
+ */
1218
+ export interface ExecutionSummary {
1219
+ /**
1220
+ * <p>The ID of the execution.</p>
1221
+ * @public
1222
+ */
1223
+ executionId: string | undefined;
1224
+ /**
1225
+ * <p>The type of action exectued.</p>
1226
+ * @public
1227
+ */
1228
+ actionType?: string | undefined;
1229
+ /**
1230
+ * <p>The resource the action will be taken on.</p>
1231
+ * @public
1232
+ */
1233
+ targetResource: TargetResource | undefined;
1234
+ /**
1235
+ * <p>The version of the target resource.</p>
1236
+ * @public
1237
+ */
1238
+ targetResourceVersion: string | undefined;
1239
+ /**
1240
+ * <p>The detailed resource this execution resolves to.</p>
1241
+ * @public
1242
+ */
1243
+ resolveTo?: ResolveTo | undefined;
1244
+ /**
1245
+ * <p>The time the process started.</p>
1246
+ * @public
1247
+ */
1248
+ executionStartTime: Date | undefined;
1249
+ /**
1250
+ * <p>The time the process ended.</p>
1251
+ * @public
1252
+ */
1253
+ executionEndTime?: Date | undefined;
1254
+ /**
1255
+ * <p>The status of the execution process.</p>
1256
+ * @public
1257
+ */
1258
+ executionStatus: ExecutionStatus | undefined;
1259
+ /**
1260
+ * <p>The execution entity version associated with the summary.</p>
1261
+ * @public
1262
+ */
1263
+ executionEntityVersion?: string | undefined;
1264
+ }
1265
+ /**
1266
+ * @public
1267
+ */
1268
+ export interface ListExecutionsResponse {
1269
+ /**
1270
+ * <p>Contains the list of execution summaries of the computation models.</p>
1271
+ * @public
1272
+ */
1273
+ executionSummaries: ExecutionSummary[] | undefined;
1274
+ /**
1275
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
1276
+ * @public
1277
+ */
1278
+ nextToken?: string | undefined;
1279
+ }
401
1280
  /**
402
1281
  * @public
403
1282
  */
@@ -430,7 +1309,10 @@ export interface GatewaySummary {
430
1309
  */
431
1310
  gatewayName: string | undefined;
432
1311
  /**
433
- * <p>Contains a gateway's platform information.</p>
1312
+ * <p>The gateway's platform configuration. You can only specify one platform type in a gateway.</p>
1313
+ * <p>(Legacy only) For Greengrass V1 gateways, specify the <code>greengrass</code> parameter with a valid Greengrass group ARN.</p>
1314
+ * <p>For Greengrass V2 gateways, specify the <code>greengrassV2</code> parameter with a valid core device thing name. If creating a V3 gateway (<code>gatewayVersion=3</code>), you must also specify the <code>coreDeviceOperatingSystem</code>.</p>
1315
+ * <p>For Siemens Industrial Edge gateways, specify the <code>siemensIE</code> parameter with a valid IoT Core thing name.</p>
434
1316
  * @public
435
1317
  */
436
1318
  gatewayPlatform?: GatewayPlatform | undefined;
@@ -945,8 +1827,8 @@ export interface PutStorageConfigurationRequest {
945
1827
  */
946
1828
  warmTierRetentionPeriod?: WarmTierRetentionPeriod | undefined;
947
1829
  /**
948
- * <p>Describes the configuration for ingesting NULL and NaN data.
949
- * By default the feature is allowed. The feature is disallowed if the value is <code>true</code>.</p>
1830
+ * <p>Describes the configuration for ingesting NULL and NaN data. By default the feature is
1831
+ * allowed. The feature is disallowed if the value is <code>true</code>.</p>
950
1832
  * @public
951
1833
  */
952
1834
  disallowIngestNullNaN?: boolean | undefined;
@@ -1020,8 +1902,8 @@ export interface PutStorageConfigurationResponse {
1020
1902
  */
1021
1903
  warmTierRetentionPeriod?: WarmTierRetentionPeriod | undefined;
1022
1904
  /**
1023
- * <p>Describes the configuration for ingesting NULL and NaN data.
1024
- * By default the feature is allowed. The feature is disallowed if the value is <code>true</code>.</p>
1905
+ * <p>Describes the configuration for ingesting NULL and NaN data. By default the feature is
1906
+ * allowed. The feature is disallowed if the value is <code>true</code>.</p>
1025
1907
  * @public
1026
1908
  */
1027
1909
  disallowIngestNullNaN?: boolean | undefined;
@@ -1049,7 +1931,7 @@ export interface TagResourceRequest {
1049
1931
  export interface TagResourceResponse {
1050
1932
  }
1051
1933
  /**
1052
- * <p>You've reached the limit for the number of tags allowed for a resource. For more
1934
+ * <p>You've reached the quota for the number of tags allowed for a resource. For more
1053
1935
  * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions">Tag naming limits and
1054
1936
  * requirements</a> in the <i>Amazon Web Services General Reference</i>.</p>
1055
1937
  * @public
@@ -1132,6 +2014,12 @@ export interface UpdateAssetRequest {
1132
2014
  * @public
1133
2015
  */
1134
2016
  assetId: string | undefined;
2017
+ /**
2018
+ * <p>An external ID to assign to the asset. The asset must not already have an external ID.
2019
+ * The external ID must be unique within your Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
2020
+ * @public
2021
+ */
2022
+ assetExternalId?: string | undefined;
1135
2023
  /**
1136
2024
  * <p>A friendly name for the asset.</p>
1137
2025
  * @public
@@ -1147,12 +2035,6 @@ export interface UpdateAssetRequest {
1147
2035
  * @public
1148
2036
  */
1149
2037
  assetDescription?: string | undefined;
1150
- /**
1151
- * <p>An external ID to assign to the asset. The asset must not already have an external ID.
1152
- * The external ID must be unique within your Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
1153
- * @public
1154
- */
1155
- assetExternalId?: string | undefined;
1156
2038
  }
1157
2039
  /**
1158
2040
  * @public
@@ -1385,6 +2267,16 @@ export interface UpdateAssetPropertyRequest {
1385
2267
  */
1386
2268
  propertyUnit?: string | undefined;
1387
2269
  }
2270
+ /**
2271
+ * @public
2272
+ */
2273
+ export interface UpdateComputationModelResponse {
2274
+ /**
2275
+ * <p>The status of the computation model. It contains a state (UPDATING after successfully calling this operation) and an error message if any.</p>
2276
+ * @public
2277
+ */
2278
+ computationModelStatus: ComputationModelStatus | undefined;
2279
+ }
1388
2280
  /**
1389
2281
  * @public
1390
2282
  */
@@ -1511,10 +2403,9 @@ export interface UpdateGatewayCapabilityConfigurationRequest {
1511
2403
  gatewayId: string | undefined;
1512
2404
  /**
1513
2405
  * <p>The namespace of the gateway capability configuration to be updated.
1514
- * For example, if you configure OPC-UA
1515
- * sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace
1516
- * <code>iotsitewise:opcuacollector:version</code>, where <code>version</code> is a number such as
1517
- * <code>1</code>.</p>
2406
+ * For example, if you configure OPC UA
2407
+ * sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace
2408
+ * <code>iotsitewise:opcuacollector:3</code>.</p>
1518
2409
  * @public
1519
2410
  */
1520
2411
  capabilityNamespace: string | undefined;
@@ -1535,27 +2426,27 @@ export interface UpdateGatewayCapabilityConfigurationResponse {
1535
2426
  */
1536
2427
  capabilityNamespace: string | undefined;
1537
2428
  /**
1538
- * <p>The synchronization status of the capability configuration. The sync status can be one of the following:</p>
2429
+ * <p>The synchronization status of the gateway capability configuration. The sync status can be one of the following:</p>
1539
2430
  * <ul>
1540
2431
  * <li>
1541
2432
  * <p>
1542
- * <code>IN_SYNC</code> The gateway is running the capability configuration.</p>
2433
+ * <code>IN_SYNC</code> - The gateway is running with the latest configuration.</p>
1543
2434
  * </li>
1544
2435
  * <li>
1545
2436
  * <p>
1546
- * <code>NOT_APPLICABLE</code> Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.</p>
2437
+ * <code>OUT_OF_SYNC</code> - The gateway hasn't received the latest configuration.</p>
1547
2438
  * </li>
1548
2439
  * <li>
1549
2440
  * <p>
1550
- * <code>OUT_OF_SYNC</code> The gateway hasn't received the capability configuration.</p>
2441
+ * <code>SYNC_FAILED</code> - The gateway rejected the latest configuration.</p>
1551
2442
  * </li>
1552
2443
  * <li>
1553
2444
  * <p>
1554
- * <code>SYNC_FAILED</code> The gateway rejected the capability configuration.</p>
2445
+ * <code>UNKNOWN</code> - The gateway hasn't reported its sync status.</p>
1555
2446
  * </li>
1556
2447
  * <li>
1557
2448
  * <p>
1558
- * <code>UNKNOWN</code> The synchronization status is currently unknown due to an undetermined or temporary error.</p>
2449
+ * <code>NOT_APPLICABLE</code> - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.</p>
1559
2450
  * </li>
1560
2451
  * </ul>
1561
2452
  * <p>After you update a capability configuration, its sync status is <code>OUT_OF_SYNC</code>
@@ -1701,6 +2592,165 @@ export interface UpdateProjectRequest {
1701
2592
  */
1702
2593
  export interface UpdateProjectResponse {
1703
2594
  }
2595
+ /**
2596
+ * <p>Contains computation model data binding value information, which can be one of <code>assetModelProperty</code>, <code>list</code>.</p>
2597
+ * @public
2598
+ */
2599
+ export interface ComputationModelDataBindingValue {
2600
+ /**
2601
+ * <p>Specifies an asset model property data binding value.</p>
2602
+ * @public
2603
+ */
2604
+ assetModelProperty?: AssetModelPropertyBindingValue | undefined;
2605
+ /**
2606
+ * <p>The asset property value used for computation model data binding.</p>
2607
+ * @public
2608
+ */
2609
+ assetProperty?: AssetPropertyBindingValue | undefined;
2610
+ /**
2611
+ * <p>Specifies a list of data binding value.</p>
2612
+ * @public
2613
+ */
2614
+ list?: ComputationModelDataBindingValue[] | undefined;
2615
+ }
2616
+ /**
2617
+ * @public
2618
+ */
2619
+ export interface CreateComputationModelRequest {
2620
+ /**
2621
+ * <p>The name of the computation model.</p>
2622
+ * @public
2623
+ */
2624
+ computationModelName: string | undefined;
2625
+ /**
2626
+ * <p>The description of the computation model.</p>
2627
+ * @public
2628
+ */
2629
+ computationModelDescription?: string | undefined;
2630
+ /**
2631
+ * <p>The configuration for the computation model.</p>
2632
+ * @public
2633
+ */
2634
+ computationModelConfiguration: ComputationModelConfiguration | undefined;
2635
+ /**
2636
+ * <p>The data binding for the computation model. Key is a variable name defined in configuration.
2637
+ * Value is a <code>ComputationModelDataBindingValue</code> referenced by the variable.</p>
2638
+ * @public
2639
+ */
2640
+ computationModelDataBinding: Record<string, ComputationModelDataBindingValue> | undefined;
2641
+ /**
2642
+ * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
2643
+ * @public
2644
+ */
2645
+ clientToken?: string | undefined;
2646
+ /**
2647
+ * <p>A list of key-value pairs that contain metadata for the asset. For more information, see
2648
+ * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
2649
+ * resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
2650
+ * @public
2651
+ */
2652
+ tags?: Record<string, string> | undefined;
2653
+ }
2654
+ /**
2655
+ * @public
2656
+ */
2657
+ export interface DescribeComputationModelResponse {
2658
+ /**
2659
+ * <p>The ID of the computation model.</p>
2660
+ * @public
2661
+ */
2662
+ computationModelId: string | undefined;
2663
+ /**
2664
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the computation model, which has the following format.</p>
2665
+ * <p>
2666
+ * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:computation-model/$\{ComputationModelId\}</code>
2667
+ * </p>
2668
+ * @public
2669
+ */
2670
+ computationModelArn: string | undefined;
2671
+ /**
2672
+ * <p>The name of the computation model.</p>
2673
+ * @public
2674
+ */
2675
+ computationModelName: string | undefined;
2676
+ /**
2677
+ * <p>The description of the computation model.</p>
2678
+ * @public
2679
+ */
2680
+ computationModelDescription?: string | undefined;
2681
+ /**
2682
+ * <p>The configuration for the computation model.</p>
2683
+ * @public
2684
+ */
2685
+ computationModelConfiguration: ComputationModelConfiguration | undefined;
2686
+ /**
2687
+ * <p>The data binding for the computation model. Key is a variable name defined in configuration.
2688
+ * Value is a <code>ComputationModelDataBindingValue</code> referenced by the variable.</p>
2689
+ * @public
2690
+ */
2691
+ computationModelDataBinding: Record<string, ComputationModelDataBindingValue> | undefined;
2692
+ /**
2693
+ * <p>The model creation date, in Unix epoch time.</p>
2694
+ * @public
2695
+ */
2696
+ computationModelCreationDate: Date | undefined;
2697
+ /**
2698
+ * <p>The date the model was last updated, in Unix epoch time.</p>
2699
+ * @public
2700
+ */
2701
+ computationModelLastUpdateDate: Date | undefined;
2702
+ /**
2703
+ * <p>The current status of the asset model, which contains a state and an error message if any.</p>
2704
+ * @public
2705
+ */
2706
+ computationModelStatus: ComputationModelStatus | undefined;
2707
+ /**
2708
+ * <p>The version of the computation model.</p>
2709
+ * @public
2710
+ */
2711
+ computationModelVersion: string | undefined;
2712
+ /**
2713
+ * <p>The available actions for this computation model.</p>
2714
+ * @public
2715
+ */
2716
+ actionDefinitions: ActionDefinition[] | undefined;
2717
+ }
2718
+ /**
2719
+ * @public
2720
+ */
2721
+ export interface UpdateComputationModelRequest {
2722
+ /**
2723
+ * <p>The ID of the computation model.</p>
2724
+ * @public
2725
+ */
2726
+ computationModelId: string | undefined;
2727
+ /**
2728
+ * <p>The name of the computation model.</p>
2729
+ * @public
2730
+ */
2731
+ computationModelName: string | undefined;
2732
+ /**
2733
+ * <p>The description of the computation model.</p>
2734
+ * @public
2735
+ */
2736
+ computationModelDescription?: string | undefined;
2737
+ /**
2738
+ * <p>The configuration for the computation model.</p>
2739
+ * @public
2740
+ */
2741
+ computationModelConfiguration: ComputationModelConfiguration | undefined;
2742
+ /**
2743
+ * <p>The data binding for the computation model. Key is a variable name defined in configuration.
2744
+ * Value is a <code>ComputationModelDataBindingValue</code> referenced by the variable.</p>
2745
+ * @public
2746
+ */
2747
+ computationModelDataBinding: Record<string, ComputationModelDataBindingValue> | undefined;
2748
+ /**
2749
+ * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
2750
+ * @public
2751
+ */
2752
+ clientToken?: string | undefined;
2753
+ }
1704
2754
  /**
1705
2755
  * <p>Represents a single data point in a query result. </p>
1706
2756
  * @public