@aws-sdk/client-iotsitewise 3.693.0 → 3.695.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 (86) hide show
  1. package/README.md +48 -0
  2. package/dist-cjs/index.js +616 -10
  3. package/dist-cjs/runtimeConfig.browser.js +2 -0
  4. package/dist-cjs/runtimeConfig.js +2 -0
  5. package/dist-es/IoTSiteWise.js +12 -0
  6. package/dist-es/IoTSiteWiseClient.js +6 -4
  7. package/dist-es/commands/CreateDatasetCommand.js +22 -0
  8. package/dist-es/commands/CreatePortalCommand.js +2 -1
  9. package/dist-es/commands/DeleteDatasetCommand.js +22 -0
  10. package/dist-es/commands/DescribeDatasetCommand.js +22 -0
  11. package/dist-es/commands/DescribePortalCommand.js +2 -1
  12. package/dist-es/commands/InvokeAssistantCommand.js +27 -0
  13. package/dist-es/commands/ListDatasetsCommand.js +22 -0
  14. package/dist-es/commands/UpdateDatasetCommand.js +22 -0
  15. package/dist-es/commands/UpdatePortalCommand.js +2 -1
  16. package/dist-es/commands/index.js +6 -0
  17. package/dist-es/models/models_0.js +83 -25
  18. package/dist-es/models/models_1.js +31 -0
  19. package/dist-es/pagination/ListDatasetsPaginator.js +4 -0
  20. package/dist-es/pagination/index.js +1 -0
  21. package/dist-es/protocols/Aws_restJson1.js +370 -2
  22. package/dist-es/runtimeConfig.browser.js +2 -0
  23. package/dist-es/runtimeConfig.js +2 -0
  24. package/dist-types/IoTSiteWise.d.ts +42 -0
  25. package/dist-types/IoTSiteWiseClient.d.ts +16 -5
  26. package/dist-types/commands/CreateAssetModelCompositeModelCommand.d.ts +2 -1
  27. package/dist-types/commands/CreateDatasetCommand.d.ts +130 -0
  28. package/dist-types/commands/CreatePortalCommand.d.ts +9 -1
  29. package/dist-types/commands/DeleteAssetModelCommand.d.ts +2 -1
  30. package/dist-types/commands/DeleteAssetModelCompositeModelCommand.d.ts +2 -1
  31. package/dist-types/commands/DeleteDatasetCommand.d.ts +104 -0
  32. package/dist-types/commands/DeletePortalCommand.d.ts +2 -2
  33. package/dist-types/commands/DescribeDatasetCommand.d.ts +116 -0
  34. package/dist-types/commands/DescribePortalCommand.d.ts +9 -1
  35. package/dist-types/commands/ExecuteQueryCommand.d.ts +1 -0
  36. package/dist-types/commands/InvokeAssistantCommand.d.ts +151 -0
  37. package/dist-types/commands/ListAssociatedAssetsCommand.d.ts +2 -1
  38. package/dist-types/commands/ListBulkImportJobsCommand.d.ts +1 -1
  39. package/dist-types/commands/ListCompositionRelationshipsCommand.d.ts +1 -1
  40. package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
  41. package/dist-types/commands/ListDatasetsCommand.d.ts +109 -0
  42. package/dist-types/commands/ListGatewaysCommand.d.ts +1 -1
  43. package/dist-types/commands/ListPortalsCommand.d.ts +3 -2
  44. package/dist-types/commands/ListProjectAssetsCommand.d.ts +1 -1
  45. package/dist-types/commands/ListProjectsCommand.d.ts +1 -1
  46. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  47. package/dist-types/commands/UpdateAssetModelCommand.d.ts +2 -1
  48. package/dist-types/commands/UpdateAssetModelCompositeModelCommand.d.ts +2 -1
  49. package/dist-types/commands/UpdateDatasetCommand.d.ts +124 -0
  50. package/dist-types/commands/UpdatePortalCommand.d.ts +9 -1
  51. package/dist-types/commands/index.d.ts +6 -0
  52. package/dist-types/models/models_0.d.ts +711 -560
  53. package/dist-types/models/models_1.d.ts +713 -3
  54. package/dist-types/pagination/ListDatasetsPaginator.d.ts +7 -0
  55. package/dist-types/pagination/index.d.ts +1 -0
  56. package/dist-types/protocols/Aws_restJson1.d.ts +55 -1
  57. package/dist-types/runtimeConfig.browser.d.ts +1 -0
  58. package/dist-types/runtimeConfig.d.ts +1 -0
  59. package/dist-types/runtimeConfig.native.d.ts +1 -0
  60. package/dist-types/ts3.4/IoTSiteWise.d.ts +102 -0
  61. package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +44 -0
  62. package/dist-types/ts3.4/commands/CreateDatasetCommand.d.ts +50 -0
  63. package/dist-types/ts3.4/commands/DeleteDatasetCommand.d.ts +50 -0
  64. package/dist-types/ts3.4/commands/DescribeDatasetCommand.d.ts +50 -0
  65. package/dist-types/ts3.4/commands/InvokeAssistantCommand.d.ts +50 -0
  66. package/dist-types/ts3.4/commands/ListAssociatedAssetsCommand.d.ts +2 -4
  67. package/dist-types/ts3.4/commands/ListBulkImportJobsCommand.d.ts +1 -1
  68. package/dist-types/ts3.4/commands/ListCompositionRelationshipsCommand.d.ts +1 -1
  69. package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +1 -1
  70. package/dist-types/ts3.4/commands/ListDatasetsCommand.d.ts +47 -0
  71. package/dist-types/ts3.4/commands/ListGatewaysCommand.d.ts +1 -1
  72. package/dist-types/ts3.4/commands/ListPortalsCommand.d.ts +1 -1
  73. package/dist-types/ts3.4/commands/ListProjectAssetsCommand.d.ts +1 -1
  74. package/dist-types/ts3.4/commands/ListProjectsCommand.d.ts +1 -1
  75. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
  76. package/dist-types/ts3.4/commands/UpdateDatasetCommand.d.ts +50 -0
  77. package/dist-types/ts3.4/commands/index.d.ts +6 -0
  78. package/dist-types/ts3.4/models/models_0.d.ts +280 -139
  79. package/dist-types/ts3.4/models/models_1.d.ts +184 -1
  80. package/dist-types/ts3.4/pagination/ListDatasetsPaginator.d.ts +11 -0
  81. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  82. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +76 -1
  83. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -0
  84. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -0
  85. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
  86. package/package.json +4 -1
@@ -1,6 +1,630 @@
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, CapabilitySyncStatus, ColumnInfo, ConfigurationStatus, DisassociatedDataStorageState, EncryptionType, Identity, ImageFile, ListTimeSeriesType, LoggingOptions, MultiLayerStorage, Permission, PortalStatus, PropertyDataType, PropertyNotificationState, Resource, RetentionPeriod, StorageType, WarmTierRetentionPeriod, WarmTierState } from "./models_0";
3
+ import { Alarms, AssetModelCompositeModel, AssetModelCompositeModelPathSegment, AssetModelHierarchy, AssetModelProperty, AssetModelStatus, AssetModelVersionType, AssetStatus, 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";
4
+ /**
5
+ * @public
6
+ */
7
+ export interface ListAssociatedAssetsResponse {
8
+ /**
9
+ * <p>A list that summarizes the associated assets.</p>
10
+ * @public
11
+ */
12
+ assetSummaries: AssociatedAssetsSummary[] | undefined;
13
+ /**
14
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
15
+ * @public
16
+ */
17
+ nextToken?: string | undefined;
18
+ }
19
+ /**
20
+ * @public
21
+ * @enum
22
+ */
23
+ export declare const ListBulkImportJobsFilter: {
24
+ readonly ALL: "ALL";
25
+ readonly CANCELLED: "CANCELLED";
26
+ readonly COMPLETED: "COMPLETED";
27
+ readonly COMPLETED_WITH_FAILURES: "COMPLETED_WITH_FAILURES";
28
+ readonly FAILED: "FAILED";
29
+ readonly PENDING: "PENDING";
30
+ readonly RUNNING: "RUNNING";
31
+ };
32
+ /**
33
+ * @public
34
+ */
35
+ export type ListBulkImportJobsFilter = (typeof ListBulkImportJobsFilter)[keyof typeof ListBulkImportJobsFilter];
36
+ /**
37
+ * @public
38
+ */
39
+ export interface ListBulkImportJobsRequest {
40
+ /**
41
+ * <p>The token to be used for the next set of paginated results.</p>
42
+ * @public
43
+ */
44
+ nextToken?: string | undefined;
45
+ /**
46
+ * <p>The maximum number of results to return for each paginated request.</p>
47
+ * @public
48
+ */
49
+ maxResults?: number | undefined;
50
+ /**
51
+ * <p>You can use a filter to select the bulk import jobs that you want to retrieve.</p>
52
+ * @public
53
+ */
54
+ filter?: ListBulkImportJobsFilter | undefined;
55
+ }
56
+ /**
57
+ * <p>Contains the job summary information.</p>
58
+ * @public
59
+ */
60
+ export interface JobSummary {
61
+ /**
62
+ * <p>The ID of the job.</p>
63
+ * @public
64
+ */
65
+ id: string | undefined;
66
+ /**
67
+ * <p>The unique name that helps identify the job request.</p>
68
+ * @public
69
+ */
70
+ name: string | undefined;
71
+ /**
72
+ * <p>The status of the bulk import job can be one of following values:</p>
73
+ * <ul>
74
+ * <li>
75
+ * <p>
76
+ * <code>PENDING</code> – IoT SiteWise is waiting for the current bulk import job to finish.</p>
77
+ * </li>
78
+ * <li>
79
+ * <p>
80
+ * <code>CANCELLED</code> – The bulk import job has been canceled.</p>
81
+ * </li>
82
+ * <li>
83
+ * <p>
84
+ * <code>RUNNING</code> – IoT SiteWise is processing your request to import your data from Amazon S3.</p>
85
+ * </li>
86
+ * <li>
87
+ * <p>
88
+ * <code>COMPLETED</code> – IoT SiteWise successfully completed your request to import data from Amazon S3.</p>
89
+ * </li>
90
+ * <li>
91
+ * <p>
92
+ * <code>FAILED</code> – IoT SiteWise couldn't process your request to import data from Amazon S3.
93
+ * You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.</p>
94
+ * </li>
95
+ * <li>
96
+ * <p>
97
+ * <code>COMPLETED_WITH_FAILURES</code> – IoT SiteWise completed your request to import data from Amazon S3 with errors.
98
+ * You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.</p>
99
+ * </li>
100
+ * </ul>
101
+ * @public
102
+ */
103
+ status: JobStatus | undefined;
104
+ }
105
+ /**
106
+ * @public
107
+ */
108
+ export interface ListBulkImportJobsResponse {
109
+ /**
110
+ * <p>One or more job summaries to list.</p>
111
+ * @public
112
+ */
113
+ jobSummaries: JobSummary[] | undefined;
114
+ /**
115
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
116
+ * @public
117
+ */
118
+ nextToken?: string | undefined;
119
+ }
120
+ /**
121
+ * @public
122
+ */
123
+ export interface ListCompositionRelationshipsRequest {
124
+ /**
125
+ * <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.
126
+ * 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>
127
+ * @public
128
+ */
129
+ assetModelId: string | undefined;
130
+ /**
131
+ * <p>The token to be used for the next set of paginated results.</p>
132
+ * @public
133
+ */
134
+ nextToken?: string | undefined;
135
+ /**
136
+ * <p>The maximum number of results to return for each paginated request.</p>
137
+ * <p>Default: 50</p>
138
+ * @public
139
+ */
140
+ maxResults?: number | undefined;
141
+ }
142
+ /**
143
+ * <p>Contains a summary of the components of the composite model.</p>
144
+ * @public
145
+ */
146
+ export interface CompositionRelationshipSummary {
147
+ /**
148
+ * <p>The ID of the asset model, in UUID format.</p>
149
+ * @public
150
+ */
151
+ assetModelId: string | undefined;
152
+ /**
153
+ * <p>The ID of a composite model on this asset model.</p>
154
+ * @public
155
+ */
156
+ assetModelCompositeModelId: string | undefined;
157
+ /**
158
+ * <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or
159
+ * <code> AWS/L4E_ANOMALY</code>.</p>
160
+ * @public
161
+ */
162
+ assetModelCompositeModelType: string | undefined;
163
+ }
164
+ /**
165
+ * @public
166
+ */
167
+ export interface ListCompositionRelationshipsResponse {
168
+ /**
169
+ * <p>A list that summarizes each composition relationship.</p>
170
+ * @public
171
+ */
172
+ compositionRelationshipSummaries: CompositionRelationshipSummary[] | undefined;
173
+ /**
174
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
175
+ * @public
176
+ */
177
+ nextToken?: string | undefined;
178
+ }
179
+ /**
180
+ * @public
181
+ */
182
+ export interface ListDashboardsRequest {
183
+ /**
184
+ * <p>The ID of the project.</p>
185
+ * @public
186
+ */
187
+ projectId: string | undefined;
188
+ /**
189
+ * <p>The token to be used for the next set of paginated results.</p>
190
+ * @public
191
+ */
192
+ nextToken?: string | undefined;
193
+ /**
194
+ * <p>The maximum number of results to return for each paginated request.</p>
195
+ * <p>Default: 50</p>
196
+ * @public
197
+ */
198
+ maxResults?: number | undefined;
199
+ }
200
+ /**
201
+ * <p>Contains a dashboard summary.</p>
202
+ * @public
203
+ */
204
+ export interface DashboardSummary {
205
+ /**
206
+ * <p>The ID of the dashboard.</p>
207
+ * @public
208
+ */
209
+ id: string | undefined;
210
+ /**
211
+ * <p>The name of the dashboard</p>
212
+ * @public
213
+ */
214
+ name: string | undefined;
215
+ /**
216
+ * <p>The dashboard's description.</p>
217
+ * @public
218
+ */
219
+ description?: string | undefined;
220
+ /**
221
+ * <p>The date the dashboard was created, in Unix epoch time.</p>
222
+ * @public
223
+ */
224
+ creationDate?: Date | undefined;
225
+ /**
226
+ * <p>The date the dashboard was last updated, in Unix epoch time.</p>
227
+ * @public
228
+ */
229
+ lastUpdateDate?: Date | undefined;
230
+ }
231
+ /**
232
+ * @public
233
+ */
234
+ export interface ListDashboardsResponse {
235
+ /**
236
+ * <p>A list that summarizes each dashboard in the project.</p>
237
+ * @public
238
+ */
239
+ dashboardSummaries: DashboardSummary[] | undefined;
240
+ /**
241
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
242
+ * @public
243
+ */
244
+ nextToken?: string | undefined;
245
+ }
246
+ /**
247
+ * @public
248
+ */
249
+ export interface ListDatasetsRequest {
250
+ /**
251
+ * <p>The type of data source for the dataset.</p>
252
+ * @public
253
+ */
254
+ sourceType: DatasetSourceType | undefined;
255
+ /**
256
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
257
+ * @public
258
+ */
259
+ nextToken?: string | undefined;
260
+ /**
261
+ * <p>The maximum number of results to return for each paginated request.</p>
262
+ * @public
263
+ */
264
+ maxResults?: number | undefined;
265
+ }
266
+ /**
267
+ * <p>The summary details for the dataset.</p>
268
+ * @public
269
+ */
270
+ export interface DatasetSummary {
271
+ /**
272
+ * <p>The ID of the dataset.</p>
273
+ * @public
274
+ */
275
+ id: string | undefined;
276
+ /**
277
+ * <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">ARN</a> of the dataset.
278
+ * The format is <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:dataset/$\{DatasetId\}</code>.</p>
279
+ * @public
280
+ */
281
+ arn: string | undefined;
282
+ /**
283
+ * <p>The name of the dataset.</p>
284
+ * @public
285
+ */
286
+ name: string | undefined;
287
+ /**
288
+ * <p>A description about the dataset, and its functionality.</p>
289
+ * @public
290
+ */
291
+ description: string | undefined;
292
+ /**
293
+ * <p>The dataset creation date, in Unix epoch time.</p>
294
+ * @public
295
+ */
296
+ creationDate: Date | undefined;
297
+ /**
298
+ * <p>The date the dataset was last updated, in Unix epoch time.</p>
299
+ * @public
300
+ */
301
+ lastUpdateDate: Date | undefined;
302
+ /**
303
+ * <p>The status of the dataset. This contains the state and any error messages. The state is
304
+ * <code>ACTIVE</code> when ready to use.</p>
305
+ * @public
306
+ */
307
+ status: DatasetStatus | undefined;
308
+ }
309
+ /**
310
+ * @public
311
+ */
312
+ export interface ListDatasetsResponse {
313
+ /**
314
+ * <p>A list that summarizes the dataset response.</p>
315
+ * @public
316
+ */
317
+ datasetSummaries: DatasetSummary[] | undefined;
318
+ /**
319
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
320
+ * @public
321
+ */
322
+ nextToken?: string | undefined;
323
+ }
324
+ /**
325
+ * @public
326
+ */
327
+ export interface ListGatewaysRequest {
328
+ /**
329
+ * <p>The token to be used for the next set of paginated results.</p>
330
+ * @public
331
+ */
332
+ nextToken?: string | undefined;
333
+ /**
334
+ * <p>The maximum number of results to return for each paginated request.</p>
335
+ * <p>Default: 50</p>
336
+ * @public
337
+ */
338
+ maxResults?: number | undefined;
339
+ }
340
+ /**
341
+ * <p>Contains a summary of a gateway.</p>
342
+ * @public
343
+ */
344
+ export interface GatewaySummary {
345
+ /**
346
+ * <p>The ID of the gateway device.</p>
347
+ * @public
348
+ */
349
+ gatewayId: string | undefined;
350
+ /**
351
+ * <p>The name of the gateway.</p>
352
+ * @public
353
+ */
354
+ gatewayName: string | undefined;
355
+ /**
356
+ * <p>Contains a gateway's platform information.</p>
357
+ * @public
358
+ */
359
+ gatewayPlatform?: GatewayPlatform | undefined;
360
+ /**
361
+ * <p>A list of gateway capability summaries that each contain a namespace and status. Each
362
+ * gateway capability defines data sources for the gateway. To retrieve a capability
363
+ * configuration's definition, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.</p>
364
+ * @public
365
+ */
366
+ gatewayCapabilitySummaries?: GatewayCapabilitySummary[] | undefined;
367
+ /**
368
+ * <p>The date the gateway was created, in Unix epoch time.</p>
369
+ * @public
370
+ */
371
+ creationDate: Date | undefined;
372
+ /**
373
+ * <p>The date the gateway was last updated, in Unix epoch time.</p>
374
+ * @public
375
+ */
376
+ lastUpdateDate: Date | undefined;
377
+ }
378
+ /**
379
+ * @public
380
+ */
381
+ export interface ListGatewaysResponse {
382
+ /**
383
+ * <p>A list that summarizes each gateway.</p>
384
+ * @public
385
+ */
386
+ gatewaySummaries: GatewaySummary[] | undefined;
387
+ /**
388
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
389
+ * @public
390
+ */
391
+ nextToken?: string | undefined;
392
+ }
393
+ /**
394
+ * @public
395
+ */
396
+ export interface ListPortalsRequest {
397
+ /**
398
+ * <p>The token to be used for the next set of paginated results.</p>
399
+ * @public
400
+ */
401
+ nextToken?: string | undefined;
402
+ /**
403
+ * <p>The maximum number of results to return for each paginated request.</p>
404
+ * <p>Default: 50</p>
405
+ * @public
406
+ */
407
+ maxResults?: number | undefined;
408
+ }
409
+ /**
410
+ * <p>Contains a portal summary.</p>
411
+ * @public
412
+ */
413
+ export interface PortalSummary {
414
+ /**
415
+ * <p>The ID of the portal.</p>
416
+ * @public
417
+ */
418
+ id: string | undefined;
419
+ /**
420
+ * <p>The name of the portal.</p>
421
+ * @public
422
+ */
423
+ name: string | undefined;
424
+ /**
425
+ * <p>The portal's description.</p>
426
+ * @public
427
+ */
428
+ description?: string | undefined;
429
+ /**
430
+ * <p>The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that
431
+ * use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the
432
+ * IoT SiteWise console to get a URL that you can use to access the portal.</p>
433
+ * @public
434
+ */
435
+ startUrl: string | undefined;
436
+ /**
437
+ * <p>The date the portal was created, in Unix epoch time.</p>
438
+ * @public
439
+ */
440
+ creationDate?: Date | undefined;
441
+ /**
442
+ * <p>The date the portal was last updated, in Unix epoch time.</p>
443
+ * @public
444
+ */
445
+ lastUpdateDate?: Date | undefined;
446
+ /**
447
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the service role that allows the portal's users to access your IoT SiteWise
448
+ * resources on your behalf. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html">Using service roles for IoT SiteWise Monitor</a> in the
449
+ * <i>IoT SiteWise User Guide</i>.</p>
450
+ * @public
451
+ */
452
+ roleArn?: string | undefined;
453
+ /**
454
+ * <p>Contains information about the current status of a portal.</p>
455
+ * @public
456
+ */
457
+ status: PortalStatus | undefined;
458
+ /**
459
+ * <p>Define the type of portal. The value for IoT SiteWise Monitor (Classic) is <code>SITEWISE_PORTAL_V1</code>. The value for IoT SiteWise Monitor (AI-aware) is <code>SITEWISE_PORTAL_V2</code>.</p>
460
+ * @public
461
+ */
462
+ portalType?: PortalType | undefined;
463
+ }
464
+ /**
465
+ * @public
466
+ */
467
+ export interface ListPortalsResponse {
468
+ /**
469
+ * <p>A list that summarizes each portal.</p>
470
+ * @public
471
+ */
472
+ portalSummaries?: PortalSummary[] | undefined;
473
+ /**
474
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
475
+ * @public
476
+ */
477
+ nextToken?: string | undefined;
478
+ }
479
+ /**
480
+ * @public
481
+ */
482
+ export interface ListProjectAssetsRequest {
483
+ /**
484
+ * <p>The ID of the project.</p>
485
+ * @public
486
+ */
487
+ projectId: string | undefined;
488
+ /**
489
+ * <p>The token to be used for the next set of paginated results.</p>
490
+ * @public
491
+ */
492
+ nextToken?: string | undefined;
493
+ /**
494
+ * <p>The maximum number of results to return for each paginated request.</p>
495
+ * <p>Default: 50</p>
496
+ * @public
497
+ */
498
+ maxResults?: number | undefined;
499
+ }
500
+ /**
501
+ * @public
502
+ */
503
+ export interface ListProjectAssetsResponse {
504
+ /**
505
+ * <p>A list that contains the IDs of each asset associated with the project.</p>
506
+ * @public
507
+ */
508
+ assetIds: string[] | undefined;
509
+ /**
510
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
511
+ * @public
512
+ */
513
+ nextToken?: string | undefined;
514
+ }
515
+ /**
516
+ * @public
517
+ */
518
+ export interface ListProjectsRequest {
519
+ /**
520
+ * <p>The ID of the portal.</p>
521
+ * @public
522
+ */
523
+ portalId: string | undefined;
524
+ /**
525
+ * <p>The token to be used for the next set of paginated results.</p>
526
+ * @public
527
+ */
528
+ nextToken?: string | undefined;
529
+ /**
530
+ * <p>The maximum number of results to return for each paginated request.</p>
531
+ * <p>Default: 50</p>
532
+ * @public
533
+ */
534
+ maxResults?: number | undefined;
535
+ }
536
+ /**
537
+ * <p>Contains project summary information.</p>
538
+ * @public
539
+ */
540
+ export interface ProjectSummary {
541
+ /**
542
+ * <p>The ID of the project.</p>
543
+ * @public
544
+ */
545
+ id: string | undefined;
546
+ /**
547
+ * <p>The name of the project.</p>
548
+ * @public
549
+ */
550
+ name: string | undefined;
551
+ /**
552
+ * <p>The project's description.</p>
553
+ * @public
554
+ */
555
+ description?: string | undefined;
556
+ /**
557
+ * <p>The date the project was created, in Unix epoch time.</p>
558
+ * @public
559
+ */
560
+ creationDate?: Date | undefined;
561
+ /**
562
+ * <p>The date the project was last updated, in Unix epoch time.</p>
563
+ * @public
564
+ */
565
+ lastUpdateDate?: Date | undefined;
566
+ }
567
+ /**
568
+ * @public
569
+ */
570
+ export interface ListProjectsResponse {
571
+ /**
572
+ * <p>A list that summarizes each project in the portal.</p>
573
+ * @public
574
+ */
575
+ projectSummaries: ProjectSummary[] | undefined;
576
+ /**
577
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
578
+ * @public
579
+ */
580
+ nextToken?: string | undefined;
581
+ }
582
+ /**
583
+ * @public
584
+ */
585
+ export interface ListTagsForResourceRequest {
586
+ /**
587
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource.</p>
588
+ * @public
589
+ */
590
+ resourceArn: string | undefined;
591
+ }
592
+ /**
593
+ * @public
594
+ */
595
+ export interface ListTagsForResourceResponse {
596
+ /**
597
+ * <p>The list of key-value pairs that contain metadata for the resource. For more information,
598
+ * see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
599
+ * resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
600
+ * @public
601
+ */
602
+ tags?: Record<string, string> | undefined;
603
+ }
604
+ /**
605
+ * <p>You are not authorized.</p>
606
+ * @public
607
+ */
608
+ export declare class UnauthorizedException extends __BaseException {
609
+ readonly name: "UnauthorizedException";
610
+ readonly $fault: "client";
611
+ /**
612
+ * @internal
613
+ */
614
+ constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
615
+ }
616
+ /**
617
+ * @public
618
+ * @enum
619
+ */
620
+ export declare const ListTimeSeriesType: {
621
+ readonly ASSOCIATED: "ASSOCIATED";
622
+ readonly DISASSOCIATED: "DISASSOCIATED";
623
+ };
624
+ /**
625
+ * @public
626
+ */
627
+ export type ListTimeSeriesType = (typeof ListTimeSeriesType)[keyof typeof ListTimeSeriesType];
4
628
  /**
5
629
  * @public
6
630
  */
@@ -686,8 +1310,19 @@ export interface UpdateDashboardRequest {
686
1310
  */
687
1311
  dashboardDescription?: string | undefined;
688
1312
  /**
689
- * <p>The new dashboard definition, as specified in a JSON literal. For detailed information,
690
- * see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Creating dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
1313
+ * <p>The new dashboard definition, as specified in a JSON literal.</p>
1314
+ * <ul>
1315
+ * <li>
1316
+ * <p>IoT SiteWise Monitor (Classic) see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Create dashboards (CLI)</a>
1317
+ * </p>
1318
+ * </li>
1319
+ * <li>
1320
+ * <p>IoT SiteWise Monitor (AI-aware) see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-ai-dashboard-cli.html">Create dashboards (CLI)</a>
1321
+ * </p>
1322
+ * </li>
1323
+ * </ul>
1324
+ * <p>in the <i>IoT SiteWise User Guide</i>
1325
+ * </p>
691
1326
  * @public
692
1327
  */
693
1328
  dashboardDefinition: string | undefined;
@@ -702,6 +1337,59 @@ export interface UpdateDashboardRequest {
702
1337
  */
703
1338
  export interface UpdateDashboardResponse {
704
1339
  }
1340
+ /**
1341
+ * @public
1342
+ */
1343
+ export interface UpdateDatasetRequest {
1344
+ /**
1345
+ * <p>The ID of the dataset.</p>
1346
+ * @public
1347
+ */
1348
+ datasetId: string | undefined;
1349
+ /**
1350
+ * <p>The name of the dataset.</p>
1351
+ * @public
1352
+ */
1353
+ datasetName: string | undefined;
1354
+ /**
1355
+ * <p>A description about the dataset, and its functionality.</p>
1356
+ * @public
1357
+ */
1358
+ datasetDescription?: string | undefined;
1359
+ /**
1360
+ * <p>The data source for the dataset.</p>
1361
+ * @public
1362
+ */
1363
+ datasetSource: DatasetSource | undefined;
1364
+ /**
1365
+ * <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>
1366
+ * @public
1367
+ */
1368
+ clientToken?: string | undefined;
1369
+ }
1370
+ /**
1371
+ * @public
1372
+ */
1373
+ export interface UpdateDatasetResponse {
1374
+ /**
1375
+ * <p>The ID of the dataset.</p>
1376
+ * @public
1377
+ */
1378
+ datasetId?: string | undefined;
1379
+ /**
1380
+ * <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">ARN</a> of the dataset.
1381
+ * The format is <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:dataset/$\{DatasetId\}</code>.</p>
1382
+ * @public
1383
+ */
1384
+ datasetArn?: string | undefined;
1385
+ /**
1386
+ * <p>The status of the dataset. This contains the state and any error messages.
1387
+ * State is <code>UPDATING</code> after a successfull call to this API, and any associated error message. The state is
1388
+ * <code>ACTIVE</code> when ready to use.</p>
1389
+ * @public
1390
+ */
1391
+ datasetStatus?: DatasetStatus | undefined;
1392
+ }
705
1393
  /**
706
1394
  * @public
707
1395
  */
@@ -760,12 +1448,20 @@ export interface UpdateGatewayCapabilityConfigurationResponse {
760
1448
  * </li>
761
1449
  * <li>
762
1450
  * <p>
1451
+ * <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>
1452
+ * </li>
1453
+ * <li>
1454
+ * <p>
763
1455
  * <code>OUT_OF_SYNC</code> – The gateway hasn't received the capability configuration.</p>
764
1456
  * </li>
765
1457
  * <li>
766
1458
  * <p>
767
1459
  * <code>SYNC_FAILED</code> – The gateway rejected the capability configuration.</p>
768
1460
  * </li>
1461
+ * <li>
1462
+ * <p>
1463
+ * <code>UNKNOWN</code> – The synchronization status is currently unknown due to an undetermined or temporary error.</p>
1464
+ * </li>
769
1465
  * </ul>
770
1466
  * <p>After you update a capability configuration, its sync status is <code>OUT_OF_SYNC</code>
771
1467
  * until the gateway receives and applies or rejects the updated configuration.</p>
@@ -858,6 +1554,16 @@ export interface UpdatePortalRequest {
858
1554
  * @public
859
1555
  */
860
1556
  alarms?: Alarms | undefined;
1557
+ /**
1558
+ * <p>Define the type of portal. The value for IoT SiteWise Monitor (Classic) is <code>SITEWISE_PORTAL_V1</code>. The value for IoT SiteWise Monitor (AI-aware) is <code>SITEWISE_PORTAL_V2</code>.</p>
1559
+ * @public
1560
+ */
1561
+ portalType?: PortalType | undefined;
1562
+ /**
1563
+ * <p>The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is <code>SITEWISE_PORTAL_V1</code>. The value for IoT SiteWise Monitor (AI-aware) is <code>SITEWISE_PORTAL_V2</code>.</p>
1564
+ * @public
1565
+ */
1566
+ portalTypeConfiguration?: Record<string, PortalTypeEntry> | undefined;
861
1567
  }
862
1568
  /**
863
1569
  * @public
@@ -958,3 +1664,7 @@ export interface ExecuteQueryResponse {
958
1664
  */
959
1665
  nextToken?: string | undefined;
960
1666
  }
1667
+ /**
1668
+ * @internal
1669
+ */
1670
+ export declare const UpdatePortalRequestFilterSensitiveLog: (obj: UpdatePortalRequest) => any;