@aws-sdk/client-iotsitewise 3.933.0 → 3.935.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 (59) hide show
  1. package/dist-cjs/index.js +290 -290
  2. package/dist-es/index.js +2 -1
  3. package/dist-es/models/enums.js +278 -0
  4. package/dist-es/models/errors.js +183 -0
  5. package/dist-es/models/models_0.js +1 -387
  6. package/dist-es/models/models_1.js +1 -75
  7. package/dist-es/schemas/schemas_0.js +1 -1
  8. package/dist-types/commands/InvokeAssistantCommand.d.ts +1 -2
  9. package/dist-types/commands/ListAccessPoliciesCommand.d.ts +1 -1
  10. package/dist-types/commands/ListActionsCommand.d.ts +1 -1
  11. package/dist-types/commands/ListAssetModelCompositeModelsCommand.d.ts +1 -1
  12. package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +1 -1
  13. package/dist-types/commands/ListAssetModelsCommand.d.ts +1 -1
  14. package/dist-types/commands/ListAssetPropertiesCommand.d.ts +1 -1
  15. package/dist-types/commands/ListAssetRelationshipsCommand.d.ts +1 -1
  16. package/dist-types/commands/ListAssetsCommand.d.ts +1 -1
  17. package/dist-types/commands/ListAssociatedAssetsCommand.d.ts +1 -1
  18. package/dist-types/commands/ListBulkImportJobsCommand.d.ts +1 -1
  19. package/dist-types/commands/ListCompositionRelationshipsCommand.d.ts +1 -1
  20. package/dist-types/commands/ListComputationModelDataBindingUsagesCommand.d.ts +1 -1
  21. package/dist-types/commands/ListComputationModelResolveToResourcesCommand.d.ts +1 -1
  22. package/dist-types/commands/ListComputationModelsCommand.d.ts +1 -1
  23. package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
  24. package/dist-types/commands/ListDatasetsCommand.d.ts +1 -1
  25. package/dist-types/commands/ListExecutionsCommand.d.ts +1 -1
  26. package/dist-types/commands/ListGatewaysCommand.d.ts +1 -1
  27. package/dist-types/index.d.ts +4 -1
  28. package/dist-types/models/enums.d.ts +718 -0
  29. package/dist-types/models/errors.d.ts +216 -0
  30. package/dist-types/models/models_0.d.ts +1544 -767
  31. package/dist-types/models/models_1.d.ts +2 -1712
  32. package/dist-types/ts3.4/commands/InvokeAssistantCommand.d.ts +4 -2
  33. package/dist-types/ts3.4/commands/ListAccessPoliciesCommand.d.ts +1 -1
  34. package/dist-types/ts3.4/commands/ListActionsCommand.d.ts +1 -1
  35. package/dist-types/ts3.4/commands/ListAssetModelCompositeModelsCommand.d.ts +1 -1
  36. package/dist-types/ts3.4/commands/ListAssetModelPropertiesCommand.d.ts +1 -1
  37. package/dist-types/ts3.4/commands/ListAssetModelsCommand.d.ts +1 -1
  38. package/dist-types/ts3.4/commands/ListAssetPropertiesCommand.d.ts +1 -1
  39. package/dist-types/ts3.4/commands/ListAssetRelationshipsCommand.d.ts +1 -1
  40. package/dist-types/ts3.4/commands/ListAssetsCommand.d.ts +1 -1
  41. package/dist-types/ts3.4/commands/ListAssociatedAssetsCommand.d.ts +1 -1
  42. package/dist-types/ts3.4/commands/ListBulkImportJobsCommand.d.ts +1 -1
  43. package/dist-types/ts3.4/commands/ListCompositionRelationshipsCommand.d.ts +1 -1
  44. package/dist-types/ts3.4/commands/ListComputationModelDataBindingUsagesCommand.d.ts +1 -1
  45. package/dist-types/ts3.4/commands/ListComputationModelResolveToResourcesCommand.d.ts +1 -1
  46. package/dist-types/ts3.4/commands/ListComputationModelsCommand.d.ts +1 -1
  47. package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +1 -1
  48. package/dist-types/ts3.4/commands/ListDatasetsCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/commands/ListExecutionsCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/ListGatewaysCommand.d.ts +1 -1
  51. package/dist-types/ts3.4/index.d.ts +4 -1
  52. package/dist-types/ts3.4/models/enums.d.ts +367 -0
  53. package/dist-types/ts3.4/models/errors.d.ts +107 -0
  54. package/dist-types/ts3.4/models/models_0.d.ts +502 -392
  55. package/dist-types/ts3.4/models/models_1.d.ts +13 -562
  56. package/package.json +12 -12
  57. package/dist-es/models/index.js +0 -2
  58. package/dist-types/models/index.d.ts +0 -2
  59. package/dist-types/ts3.4/models/index.d.ts +0 -2
@@ -1,1672 +1,5 @@
1
- import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
- import { IoTSiteWiseServiceException as __BaseException } from "./IoTSiteWiseServiceException";
3
- import { AccessDeniedException, 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, ConflictingOperationException, Content, DatasetSource, DatasetSourceType, DatasetStatus, DisassociatedDataStorageState, EncryptionType, ExecutionStatus, GatewayCapabilitySummary, GatewayPlatform, Identity, ImageFile, InternalFailureException, InvalidRequestException, JobStatus, LimitExceededException, Location, LoggingOptions, MultiLayerStorage, Permission, PortalStatus, PortalType, PortalTypeEntry, PropertyDataType, PropertyMapping, PropertyNotificationState, ResolveTo, ResolveToResourceType, Resource, ResourceNotFoundException, RetentionPeriod, StorageType, TargetResource, ThrottlingException, WarmTierRetentionPeriod, WarmTierState } from "./models_0";
4
- /**
5
- * <p>The data source for the dataset.</p>
6
- * @public
7
- */
8
- export interface Source {
9
- /**
10
- * <p>Contains the ARN of the dataset. If the source is Kendra, it's the ARN of the Kendra index.</p>
11
- * @public
12
- */
13
- arn?: string | undefined;
14
- /**
15
- * <p>Contains the location information where the cited text is originally stored.
16
- * For example, if the data source is Kendra, and the text synchronized is from an S3 bucket, then the location refers to an S3 object.</p>
17
- * @public
18
- */
19
- location?: Location | undefined;
20
- }
21
- /**
22
- * <p>Contains information about the dataset use and it's source.</p>
23
- * @public
24
- */
25
- export interface DataSetReference {
26
- /**
27
- * <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">ARN</a> of the dataset.
28
- * The format is <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:dataset/$\{DatasetId\}</code>.</p>
29
- * @public
30
- */
31
- datasetArn?: string | undefined;
32
- /**
33
- * <p>The data source for the dataset.</p>
34
- * @public
35
- */
36
- source?: Source | undefined;
37
- }
38
- /**
39
- * <p>Contains the reference information.</p>
40
- * @public
41
- */
42
- export interface Reference {
43
- /**
44
- * <p>Contains the dataset reference information.</p>
45
- * @public
46
- */
47
- dataset?: DataSetReference | undefined;
48
- }
49
- /**
50
- * <p>Contains text content to which the SiteWise Assistant refers to, and generate the final response.
51
- * It also contains information about the source.</p>
52
- * @public
53
- */
54
- export interface Citation {
55
- /**
56
- * <p>Contains information about the data source.</p>
57
- * @public
58
- */
59
- reference?: Reference | undefined;
60
- /**
61
- * <p>Contains the cited text from the data source.</p>
62
- * @public
63
- */
64
- content?: Content | undefined;
65
- }
66
- /**
67
- * <p>This contains the SiteWise Assistant's response and the corresponding citation.</p>
68
- * @public
69
- */
70
- export interface InvocationOutput {
71
- /**
72
- * <p>The text message of the SiteWise Assistant's response.</p>
73
- * @public
74
- */
75
- message?: string | undefined;
76
- /**
77
- * <p>A list of citations, and related information for the SiteWise Assistant's response.</p>
78
- * @public
79
- */
80
- citations?: Citation[] | undefined;
81
- }
82
- /**
83
- * <p>Contains tracing information of the SiteWise Assistant's reasoning and data access.</p>
84
- * @public
85
- */
86
- export interface Trace {
87
- /**
88
- * <p>The cited text from the data source.</p>
89
- * @public
90
- */
91
- text?: string | undefined;
92
- }
93
- /**
94
- * <p>Contains the response, citation, and trace from the SiteWise Assistant.</p>
95
- * @public
96
- */
97
- export type ResponseStream = ResponseStream.AccessDeniedExceptionMember | ResponseStream.ConflictingOperationExceptionMember | ResponseStream.InternalFailureExceptionMember | ResponseStream.InvalidRequestExceptionMember | ResponseStream.LimitExceededExceptionMember | ResponseStream.OutputMember | ResponseStream.ResourceNotFoundExceptionMember | ResponseStream.ThrottlingExceptionMember | ResponseStream.TraceMember | ResponseStream.$UnknownMember;
98
- /**
99
- * @public
100
- */
101
- export declare namespace ResponseStream {
102
- /**
103
- * <p>Contains tracing information of the SiteWise Assistant's reasoning and data access.</p>
104
- * @public
105
- */
106
- interface TraceMember {
107
- trace: Trace;
108
- output?: never;
109
- accessDeniedException?: never;
110
- conflictingOperationException?: never;
111
- internalFailureException?: never;
112
- invalidRequestException?: never;
113
- limitExceededException?: never;
114
- resourceNotFoundException?: never;
115
- throttlingException?: never;
116
- $unknown?: never;
117
- }
118
- /**
119
- * <p>Contains the SiteWise Assistant's response.</p>
120
- * @public
121
- */
122
- interface OutputMember {
123
- trace?: never;
124
- output: InvocationOutput;
125
- accessDeniedException?: never;
126
- conflictingOperationException?: never;
127
- internalFailureException?: never;
128
- invalidRequestException?: never;
129
- limitExceededException?: never;
130
- resourceNotFoundException?: never;
131
- throttlingException?: never;
132
- $unknown?: never;
133
- }
134
- /**
135
- * <p>Access is denied.</p>
136
- * @public
137
- */
138
- interface AccessDeniedExceptionMember {
139
- trace?: never;
140
- output?: never;
141
- accessDeniedException: AccessDeniedException;
142
- conflictingOperationException?: never;
143
- internalFailureException?: never;
144
- invalidRequestException?: never;
145
- limitExceededException?: never;
146
- resourceNotFoundException?: never;
147
- throttlingException?: never;
148
- $unknown?: never;
149
- }
150
- /**
151
- * <p>Your request has conflicting operations. This can occur if you're trying to perform more
152
- * than one operation on the same resource at the same time.</p>
153
- * @public
154
- */
155
- interface ConflictingOperationExceptionMember {
156
- trace?: never;
157
- output?: never;
158
- accessDeniedException?: never;
159
- conflictingOperationException: ConflictingOperationException;
160
- internalFailureException?: never;
161
- invalidRequestException?: never;
162
- limitExceededException?: never;
163
- resourceNotFoundException?: never;
164
- throttlingException?: never;
165
- $unknown?: never;
166
- }
167
- /**
168
- * <p>IoT SiteWise can't process your request right now. Try again later.</p>
169
- * @public
170
- */
171
- interface InternalFailureExceptionMember {
172
- trace?: never;
173
- output?: never;
174
- accessDeniedException?: never;
175
- conflictingOperationException?: never;
176
- internalFailureException: InternalFailureException;
177
- invalidRequestException?: never;
178
- limitExceededException?: never;
179
- resourceNotFoundException?: never;
180
- throttlingException?: never;
181
- $unknown?: never;
182
- }
183
- /**
184
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
185
- * unsupported characters. Check your request and try again.</p>
186
- * @public
187
- */
188
- interface InvalidRequestExceptionMember {
189
- trace?: never;
190
- output?: never;
191
- accessDeniedException?: never;
192
- conflictingOperationException?: never;
193
- internalFailureException?: never;
194
- invalidRequestException: InvalidRequestException;
195
- limitExceededException?: never;
196
- resourceNotFoundException?: never;
197
- throttlingException?: never;
198
- $unknown?: never;
199
- }
200
- /**
201
- * <p>You've reached the quota for a resource. For example, this can occur if you're trying to
202
- * associate more than the allowed number of child assets or attempting to create more than the
203
- * allowed number of properties for an asset model.</p>
204
- * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
205
- * @public
206
- */
207
- interface LimitExceededExceptionMember {
208
- trace?: never;
209
- output?: never;
210
- accessDeniedException?: never;
211
- conflictingOperationException?: never;
212
- internalFailureException?: never;
213
- invalidRequestException?: never;
214
- limitExceededException: LimitExceededException;
215
- resourceNotFoundException?: never;
216
- throttlingException?: never;
217
- $unknown?: never;
218
- }
219
- /**
220
- * <p>The requested resource can't be found.</p>
221
- * @public
222
- */
223
- interface ResourceNotFoundExceptionMember {
224
- trace?: never;
225
- output?: never;
226
- accessDeniedException?: never;
227
- conflictingOperationException?: never;
228
- internalFailureException?: never;
229
- invalidRequestException?: never;
230
- limitExceededException?: never;
231
- resourceNotFoundException: ResourceNotFoundException;
232
- throttlingException?: never;
233
- $unknown?: never;
234
- }
235
- /**
236
- * <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
237
- * IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
238
- * on.</p>
239
- * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
240
- * @public
241
- */
242
- interface ThrottlingExceptionMember {
243
- trace?: never;
244
- output?: never;
245
- accessDeniedException?: never;
246
- conflictingOperationException?: never;
247
- internalFailureException?: never;
248
- invalidRequestException?: never;
249
- limitExceededException?: never;
250
- resourceNotFoundException?: never;
251
- throttlingException: ThrottlingException;
252
- $unknown?: never;
253
- }
254
- /**
255
- * @public
256
- */
257
- interface $UnknownMember {
258
- trace?: never;
259
- output?: never;
260
- accessDeniedException?: never;
261
- conflictingOperationException?: never;
262
- internalFailureException?: never;
263
- invalidRequestException?: never;
264
- limitExceededException?: never;
265
- resourceNotFoundException?: never;
266
- throttlingException?: never;
267
- $unknown: [string, any];
268
- }
269
- /**
270
- * @deprecated unused in schema-serde mode.
271
- *
272
- */
273
- interface Visitor<T> {
274
- trace: (value: Trace) => T;
275
- output: (value: InvocationOutput) => T;
276
- accessDeniedException: (value: AccessDeniedException) => T;
277
- conflictingOperationException: (value: ConflictingOperationException) => T;
278
- internalFailureException: (value: InternalFailureException) => T;
279
- invalidRequestException: (value: InvalidRequestException) => T;
280
- limitExceededException: (value: LimitExceededException) => T;
281
- resourceNotFoundException: (value: ResourceNotFoundException) => T;
282
- throttlingException: (value: ThrottlingException) => T;
283
- _: (name: string, value: any) => T;
284
- }
285
- }
286
- /**
287
- * @public
288
- */
289
- export interface InvokeAssistantResponse {
290
- /**
291
- * <p>Contains the response, citation, and trace from the SiteWise Assistant.</p>
292
- * @public
293
- */
294
- body: AsyncIterable<ResponseStream> | undefined;
295
- /**
296
- * <p>The ID of the conversation, in UUID format. This ID uniquely identifies the conversation within IoT SiteWise.</p>
297
- * @public
298
- */
299
- conversationId: string | undefined;
300
- }
301
- /**
302
- * @public
303
- * @enum
304
- */
305
- export declare const IdentityType: {
306
- readonly GROUP: "GROUP";
307
- readonly IAM: "IAM";
308
- readonly USER: "USER";
309
- };
310
- /**
311
- * @public
312
- */
313
- export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
314
- /**
315
- * @public
316
- * @enum
317
- */
318
- export declare const ResourceType: {
319
- readonly PORTAL: "PORTAL";
320
- readonly PROJECT: "PROJECT";
321
- };
322
- /**
323
- * @public
324
- */
325
- export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
326
- /**
327
- * @public
328
- */
329
- export interface ListAccessPoliciesRequest {
330
- /**
331
- * <p>The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required
332
- * if you specify <code>identityId</code>.</p>
333
- * @public
334
- */
335
- identityType?: IdentityType | undefined;
336
- /**
337
- * <p>The ID of the identity. This parameter is required if you specify <code>USER</code> or
338
- * <code>GROUP</code> for <code>identityType</code>.</p>
339
- * @public
340
- */
341
- identityId?: string | undefined;
342
- /**
343
- * <p>The type of resource (portal or project). This parameter is required if you specify
344
- * <code>resourceId</code>.</p>
345
- * @public
346
- */
347
- resourceType?: ResourceType | undefined;
348
- /**
349
- * <p>The ID of the resource. This parameter is required if you specify
350
- * <code>resourceType</code>.</p>
351
- * @public
352
- */
353
- resourceId?: string | undefined;
354
- /**
355
- * <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
356
- * <i>IAM User Guide</i>. This parameter is required if you specify
357
- * <code>IAM</code> for <code>identityType</code>.</p>
358
- * @public
359
- */
360
- iamArn?: string | undefined;
361
- /**
362
- * <p>The token to be used for the next set of paginated results.</p>
363
- * @public
364
- */
365
- nextToken?: string | undefined;
366
- /**
367
- * <p>The maximum number of results to return for each paginated request.</p>
368
- * <p>Default: 50</p>
369
- * @public
370
- */
371
- maxResults?: number | undefined;
372
- }
373
- /**
374
- * @public
375
- */
376
- export interface ListAccessPoliciesResponse {
377
- /**
378
- * <p>A list that summarizes each access policy.</p>
379
- * @public
380
- */
381
- accessPolicySummaries: AccessPolicySummary[] | undefined;
382
- /**
383
- * <p>The token for the next set of results, or null if there are no additional results.</p>
384
- * @public
385
- */
386
- nextToken?: string | undefined;
387
- }
388
- /**
389
- * @public
390
- * @enum
391
- */
392
- export declare const TargetResourceType: {
393
- readonly ASSET: "ASSET";
394
- readonly COMPUTATION_MODEL: "COMPUTATION_MODEL";
395
- };
396
- /**
397
- * @public
398
- */
399
- export type TargetResourceType = (typeof TargetResourceType)[keyof typeof TargetResourceType];
400
- /**
401
- * @public
402
- */
403
- export interface ListActionsRequest {
404
- /**
405
- * <p>The type of resource.</p>
406
- * @public
407
- */
408
- targetResourceType: TargetResourceType | undefined;
409
- /**
410
- * <p>The ID of the target resource.</p>
411
- * @public
412
- */
413
- targetResourceId: string | undefined;
414
- /**
415
- * <p>The token to be used for the next set of paginated results.</p>
416
- * @public
417
- */
418
- nextToken?: string | undefined;
419
- /**
420
- * <p>The maximum number of results to return for each paginated request.</p>
421
- * @public
422
- */
423
- maxResults?: number | undefined;
424
- /**
425
- * <p>The type of the resolved resource.</p>
426
- * @public
427
- */
428
- resolveToResourceType?: ResolveToResourceType | undefined;
429
- /**
430
- * <p>The ID of the resolved resource.</p>
431
- * @public
432
- */
433
- resolveToResourceId?: string | undefined;
434
- }
435
- /**
436
- * @public
437
- */
438
- export interface ListActionsResponse {
439
- /**
440
- * <p>A list that summarizes the actions associated with the specified asset.</p>
441
- * @public
442
- */
443
- actionSummaries: ActionSummary[] | undefined;
444
- /**
445
- * <p>The token for the next set of results, or null if there are no additional results.</p>
446
- * @public
447
- */
448
- nextToken: string | undefined;
449
- }
450
- /**
451
- * @public
452
- */
453
- export interface ListAssetModelCompositeModelsRequest {
454
- /**
455
- * <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.
456
- * 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>
457
- * @public
458
- */
459
- assetModelId: string | undefined;
460
- /**
461
- * <p>The token to be used for the next set of paginated results.</p>
462
- * @public
463
- */
464
- nextToken?: string | undefined;
465
- /**
466
- * <p>The maximum number of results to return for each paginated request.</p>
467
- * <p>Default: 50</p>
468
- * @public
469
- */
470
- maxResults?: number | undefined;
471
- /**
472
- * <p>The version alias that specifies the latest or active version of the asset model.
473
- * 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">
474
- * Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
475
- * @public
476
- */
477
- assetModelVersion?: string | undefined;
478
- }
479
- /**
480
- * @public
481
- */
482
- export interface ListAssetModelCompositeModelsResponse {
483
- /**
484
- * <p>A list that summarizes each composite model.</p>
485
- * @public
486
- */
487
- assetModelCompositeModelSummaries: AssetModelCompositeModelSummary[] | undefined;
488
- /**
489
- * <p>The token for the next set of results, or null if there are no additional results.</p>
490
- * @public
491
- */
492
- nextToken?: string | undefined;
493
- }
494
- /**
495
- * @public
496
- * @enum
497
- */
498
- export declare const ListAssetModelPropertiesFilter: {
499
- readonly ALL: "ALL";
500
- readonly BASE: "BASE";
501
- };
502
- /**
503
- * @public
504
- */
505
- export type ListAssetModelPropertiesFilter = (typeof ListAssetModelPropertiesFilter)[keyof typeof ListAssetModelPropertiesFilter];
506
- /**
507
- * @public
508
- */
509
- export interface ListAssetModelPropertiesRequest {
510
- /**
511
- * <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.
512
- * 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>
513
- * @public
514
- */
515
- assetModelId: string | undefined;
516
- /**
517
- * <p>The token to be used for the next set of paginated results.</p>
518
- * @public
519
- */
520
- nextToken?: string | undefined;
521
- /**
522
- * <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
523
- * @public
524
- */
525
- maxResults?: number | undefined;
526
- /**
527
- * <p> Filters the requested list of asset model properties. You can choose one of the following
528
- * options:</p>
529
- * <ul>
530
- * <li>
531
- * <p>
532
- * <code>ALL</code> – The list includes all asset model properties for a given asset
533
- * model ID. </p>
534
- * </li>
535
- * <li>
536
- * <p>
537
- * <code>BASE</code> – The list includes only base asset model properties for a given
538
- * asset model ID. </p>
539
- * </li>
540
- * </ul>
541
- * <p>Default: <code>BASE</code>
542
- * </p>
543
- * @public
544
- */
545
- filter?: ListAssetModelPropertiesFilter | undefined;
546
- /**
547
- * <p>The version alias that specifies the latest or active version of the asset model.
548
- * 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">
549
- * Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
550
- * @public
551
- */
552
- assetModelVersion?: string | undefined;
553
- }
554
- /**
555
- * @public
556
- */
557
- export interface ListAssetModelPropertiesResponse {
558
- /**
559
- * <p>A list that summarizes the properties associated with the specified asset model.</p>
560
- * @public
561
- */
562
- assetModelPropertySummaries: AssetModelPropertySummary[] | undefined;
563
- /**
564
- * <p>The token for the next set of results, or null if there are no additional results.</p>
565
- * @public
566
- */
567
- nextToken?: string | undefined;
568
- }
569
- /**
570
- * @public
571
- */
572
- export interface ListAssetModelsRequest {
573
- /**
574
- * <p>The type of asset model. If you don't provide an <code>assetModelTypes</code>, all types
575
- * of asset models are returned.</p>
576
- * <ul>
577
- * <li>
578
- * <p>
579
- * <b>ASSET_MODEL</b> – An asset model that you can use
580
- * to create assets. Can't be included as a component in another asset model.</p>
581
- * </li>
582
- * <li>
583
- * <p>
584
- * <b>COMPONENT_MODEL</b> – A reusable component that
585
- * you can include in the composite models of other asset models. You can't create
586
- * assets directly from this type of asset model. </p>
587
- * </li>
588
- * <li>
589
- * <p>
590
- * <b>INTERFACE</b> – An interface is a type of model
591
- * that defines a standard structure that can be applied to different asset models.</p>
592
- * </li>
593
- * </ul>
594
- * @public
595
- */
596
- assetModelTypes?: AssetModelType[] | undefined;
597
- /**
598
- * <p>The token to be used for the next set of paginated results.</p>
599
- * @public
600
- */
601
- nextToken?: string | undefined;
602
- /**
603
- * <p>The maximum number of results to return for each paginated request.</p>
604
- * <p>Default: 50</p>
605
- * @public
606
- */
607
- maxResults?: number | undefined;
608
- /**
609
- * <p>The version alias that specifies the latest or active version of the asset model.
610
- * 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">
611
- * Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
612
- * @public
613
- */
614
- assetModelVersion?: string | undefined;
615
- }
616
- /**
617
- * @public
618
- */
619
- export interface ListAssetModelsResponse {
620
- /**
621
- * <p>A list that summarizes each asset model.</p>
622
- * @public
623
- */
624
- assetModelSummaries: AssetModelSummary[] | undefined;
625
- /**
626
- * <p>The token for the next set of results, or null if there are no additional results.</p>
627
- * @public
628
- */
629
- nextToken?: string | undefined;
630
- }
631
- /**
632
- * @public
633
- * @enum
634
- */
635
- export declare const ListAssetPropertiesFilter: {
636
- readonly ALL: "ALL";
637
- readonly BASE: "BASE";
638
- };
639
- /**
640
- * @public
641
- */
642
- export type ListAssetPropertiesFilter = (typeof ListAssetPropertiesFilter)[keyof typeof ListAssetPropertiesFilter];
643
- /**
644
- * @public
645
- */
646
- export interface ListAssetPropertiesRequest {
647
- /**
648
- * <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.
649
- * 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>
650
- * @public
651
- */
652
- assetId: string | undefined;
653
- /**
654
- * <p>The token to be used for the next set of paginated results.</p>
655
- * @public
656
- */
657
- nextToken?: string | undefined;
658
- /**
659
- * <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
660
- * @public
661
- */
662
- maxResults?: number | undefined;
663
- /**
664
- * <p> Filters the requested list of asset properties. You can choose one of the following
665
- * options:</p>
666
- * <ul>
667
- * <li>
668
- * <p>
669
- * <code>ALL</code> – The list includes all asset properties for a given asset model ID.
670
- * </p>
671
- * </li>
672
- * <li>
673
- * <p>
674
- * <code>BASE</code> – The list includes only base asset properties for a given asset
675
- * model ID. </p>
676
- * </li>
677
- * </ul>
678
- * <p>Default: <code>BASE</code>
679
- * </p>
680
- * @public
681
- */
682
- filter?: ListAssetPropertiesFilter | undefined;
683
- }
684
- /**
685
- * @public
686
- */
687
- export interface ListAssetPropertiesResponse {
688
- /**
689
- * <p>A list that summarizes the properties associated with the specified asset.</p>
690
- * @public
691
- */
692
- assetPropertySummaries: AssetPropertySummary[] | undefined;
693
- /**
694
- * <p>The token for the next set of results, or null if there are no additional results.</p>
695
- * @public
696
- */
697
- nextToken?: string | undefined;
698
- }
699
- /**
700
- * @public
701
- * @enum
702
- */
703
- export declare const TraversalType: {
704
- readonly PATH_TO_ROOT: "PATH_TO_ROOT";
705
- };
706
- /**
707
- * @public
708
- */
709
- export type TraversalType = (typeof TraversalType)[keyof typeof TraversalType];
710
- /**
711
- * @public
712
- */
713
- export interface ListAssetRelationshipsRequest {
714
- /**
715
- * <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.
716
- * 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>
717
- * @public
718
- */
719
- assetId: string | undefined;
720
- /**
721
- * <p>The type of traversal to use to identify asset relationships. Choose the following
722
- * option:</p>
723
- * <ul>
724
- * <li>
725
- * <p>
726
- * <code>PATH_TO_ROOT</code> – Identify the asset's parent assets up to the root
727
- * asset. The asset that you specify in <code>assetId</code> is the first result in the list
728
- * of <code>assetRelationshipSummaries</code>, and the root asset is the last result.</p>
729
- * </li>
730
- * </ul>
731
- * @public
732
- */
733
- traversalType: TraversalType | undefined;
734
- /**
735
- * <p>The token to be used for the next set of paginated results.</p>
736
- * @public
737
- */
738
- nextToken?: string | undefined;
739
- /**
740
- * <p>The maximum number of results to return for each paginated request.</p>
741
- * @public
742
- */
743
- maxResults?: number | undefined;
744
- }
745
- /**
746
- * @public
747
- */
748
- export interface ListAssetRelationshipsResponse {
749
- /**
750
- * <p>A list that summarizes each asset relationship.</p>
751
- * @public
752
- */
753
- assetRelationshipSummaries: AssetRelationshipSummary[] | undefined;
754
- /**
755
- * <p>The token for the next set of results, or null if there are no additional results.</p>
756
- * @public
757
- */
758
- nextToken?: string | undefined;
759
- }
760
- /**
761
- * @public
762
- * @enum
763
- */
764
- export declare const ListAssetsFilter: {
765
- readonly ALL: "ALL";
766
- readonly TOP_LEVEL: "TOP_LEVEL";
767
- };
768
- /**
769
- * @public
770
- */
771
- export type ListAssetsFilter = (typeof ListAssetsFilter)[keyof typeof ListAssetsFilter];
772
- /**
773
- * @public
774
- */
775
- export interface ListAssetsRequest {
776
- /**
777
- * <p>The token to be used for the next set of paginated results.</p>
778
- * @public
779
- */
780
- nextToken?: string | undefined;
781
- /**
782
- * <p>The maximum number of results to return for each paginated request.</p>
783
- * <p>Default: 50</p>
784
- * @public
785
- */
786
- maxResults?: number | undefined;
787
- /**
788
- * <p>The ID of the asset model by which to filter the list of assets. This parameter is
789
- * 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.
790
- * 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>
791
- * @public
792
- */
793
- assetModelId?: string | undefined;
794
- /**
795
- * <p>The filter for the requested list of assets. Choose one of the following options:</p>
796
- * <ul>
797
- * <li>
798
- * <p>
799
- * <code>ALL</code> – The list includes all assets for a given asset model ID. The
800
- * <code>assetModelId</code> parameter is required if you filter by
801
- * <code>ALL</code>.</p>
802
- * </li>
803
- * <li>
804
- * <p>
805
- * <code>TOP_LEVEL</code> – The list includes only top-level assets in the asset
806
- * hierarchy tree.</p>
807
- * </li>
808
- * </ul>
809
- * <p>Default: <code>ALL</code>
810
- * </p>
811
- * @public
812
- */
813
- filter?: ListAssetsFilter | undefined;
814
- }
815
- /**
816
- * @public
817
- */
818
- export interface ListAssetsResponse {
819
- /**
820
- * <p>A list that summarizes each asset.</p>
821
- * @public
822
- */
823
- assetSummaries: AssetSummary[] | undefined;
824
- /**
825
- * <p>The token for the next set of results, or null if there are no additional results.</p>
826
- * @public
827
- */
828
- nextToken?: string | undefined;
829
- }
830
- /**
831
- * @public
832
- * @enum
833
- */
834
- export declare const TraversalDirection: {
835
- readonly CHILD: "CHILD";
836
- readonly PARENT: "PARENT";
837
- };
838
- /**
839
- * @public
840
- */
841
- export type TraversalDirection = (typeof TraversalDirection)[keyof typeof TraversalDirection];
842
- /**
843
- * @public
844
- */
845
- export interface ListAssociatedAssetsRequest {
846
- /**
847
- * <p>The ID of the asset to query. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
848
- * 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>
849
- * @public
850
- */
851
- assetId: string | undefined;
852
- /**
853
- * <p>(Optional) If you don't provide a <code>hierarchyId</code>, all the immediate assets in
854
- * the <code>traversalDirection</code> will be returned. </p>
855
- * <p> The ID of the hierarchy by which child assets are associated to the asset.
856
- * (This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
857
- * 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>
858
- * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
859
- * @public
860
- */
861
- hierarchyId?: string | undefined;
862
- /**
863
- * <p>The direction to list associated assets. Choose one of the following options:</p>
864
- * <ul>
865
- * <li>
866
- * <p>
867
- * <code>CHILD</code> – The list includes all child assets associated to the
868
- * asset.</p>
869
- * </li>
870
- * <li>
871
- * <p>
872
- * <code>PARENT</code> – The list includes the asset's parent asset.</p>
873
- * </li>
874
- * </ul>
875
- * <p>Default: <code>CHILD</code>
876
- * </p>
877
- * @public
878
- */
879
- traversalDirection?: TraversalDirection | undefined;
880
- /**
881
- * <p>The token to be used for the next set of paginated results.</p>
882
- * @public
883
- */
884
- nextToken?: string | undefined;
885
- /**
886
- * <p>The maximum number of results to return for each paginated request.</p>
887
- * <p>Default: 50</p>
888
- * @public
889
- */
890
- maxResults?: number | undefined;
891
- }
892
- /**
893
- * @public
894
- */
895
- export interface ListAssociatedAssetsResponse {
896
- /**
897
- * <p>A list that summarizes the associated assets.</p>
898
- * @public
899
- */
900
- assetSummaries: AssociatedAssetsSummary[] | undefined;
901
- /**
902
- * <p>The token for the next set of results, or null if there are no additional results.</p>
903
- * @public
904
- */
905
- nextToken?: string | undefined;
906
- }
907
- /**
908
- * @public
909
- * @enum
910
- */
911
- export declare const ListBulkImportJobsFilter: {
912
- readonly ALL: "ALL";
913
- readonly CANCELLED: "CANCELLED";
914
- readonly COMPLETED: "COMPLETED";
915
- readonly COMPLETED_WITH_FAILURES: "COMPLETED_WITH_FAILURES";
916
- readonly FAILED: "FAILED";
917
- readonly PENDING: "PENDING";
918
- readonly RUNNING: "RUNNING";
919
- };
920
- /**
921
- * @public
922
- */
923
- export type ListBulkImportJobsFilter = (typeof ListBulkImportJobsFilter)[keyof typeof ListBulkImportJobsFilter];
924
- /**
925
- * @public
926
- */
927
- export interface ListBulkImportJobsRequest {
928
- /**
929
- * <p>The token to be used for the next set of paginated results.</p>
930
- * @public
931
- */
932
- nextToken?: string | undefined;
933
- /**
934
- * <p>The maximum number of results to return for each paginated request.</p>
935
- * @public
936
- */
937
- maxResults?: number | undefined;
938
- /**
939
- * <p>You can use a filter to select the bulk import jobs that you want to retrieve.</p>
940
- * @public
941
- */
942
- filter?: ListBulkImportJobsFilter | undefined;
943
- }
944
- /**
945
- * <p>Contains the job summary information.</p>
946
- * @public
947
- */
948
- export interface JobSummary {
949
- /**
950
- * <p>The ID of the job.</p>
951
- * @public
952
- */
953
- id: string | undefined;
954
- /**
955
- * <p>The unique name that helps identify the job request.</p>
956
- * @public
957
- */
958
- name: string | undefined;
959
- /**
960
- * <p>The status of the bulk import job can be one of following values:</p>
961
- * <ul>
962
- * <li>
963
- * <p>
964
- * <code>PENDING</code> – IoT SiteWise is waiting for the current bulk import job to finish.</p>
965
- * </li>
966
- * <li>
967
- * <p>
968
- * <code>CANCELLED</code> – The bulk import job has been canceled.</p>
969
- * </li>
970
- * <li>
971
- * <p>
972
- * <code>RUNNING</code> – IoT SiteWise is processing your request to import your data from Amazon S3.</p>
973
- * </li>
974
- * <li>
975
- * <p>
976
- * <code>COMPLETED</code> – IoT SiteWise successfully completed your request to import data from Amazon S3.</p>
977
- * </li>
978
- * <li>
979
- * <p>
980
- * <code>FAILED</code> – IoT SiteWise couldn't process your request to import data from Amazon S3.
981
- * You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.</p>
982
- * </li>
983
- * <li>
984
- * <p>
985
- * <code>COMPLETED_WITH_FAILURES</code> – IoT SiteWise completed your request to import data from Amazon S3 with errors.
986
- * You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.</p>
987
- * </li>
988
- * </ul>
989
- * @public
990
- */
991
- status: JobStatus | undefined;
992
- }
993
- /**
994
- * @public
995
- */
996
- export interface ListBulkImportJobsResponse {
997
- /**
998
- * <p>One or more job summaries to list.</p>
999
- * @public
1000
- */
1001
- jobSummaries: JobSummary[] | undefined;
1002
- /**
1003
- * <p>The token for the next set of results, or null if there are no additional results.</p>
1004
- * @public
1005
- */
1006
- nextToken?: string | undefined;
1007
- }
1008
- /**
1009
- * @public
1010
- */
1011
- export interface ListCompositionRelationshipsRequest {
1012
- /**
1013
- * <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.
1014
- * 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>
1015
- * @public
1016
- */
1017
- assetModelId: string | undefined;
1018
- /**
1019
- * <p>The token to be used for the next set of paginated results.</p>
1020
- * @public
1021
- */
1022
- nextToken?: string | undefined;
1023
- /**
1024
- * <p>The maximum number of results to return for each paginated request.</p>
1025
- * <p>Default: 50</p>
1026
- * @public
1027
- */
1028
- maxResults?: number | undefined;
1029
- }
1030
- /**
1031
- * <p>Contains a summary of the components of the composite model.</p>
1032
- * @public
1033
- */
1034
- export interface CompositionRelationshipSummary {
1035
- /**
1036
- * <p>The ID of the asset model, in UUID format.</p>
1037
- * @public
1038
- */
1039
- assetModelId: string | undefined;
1040
- /**
1041
- * <p>The ID of a composite model on this asset model.</p>
1042
- * @public
1043
- */
1044
- assetModelCompositeModelId: string | undefined;
1045
- /**
1046
- * <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or
1047
- * <code> AWS/L4E_ANOMALY</code>.</p>
1048
- * @public
1049
- */
1050
- assetModelCompositeModelType: string | undefined;
1051
- }
1052
- /**
1053
- * @public
1054
- */
1055
- export interface ListCompositionRelationshipsResponse {
1056
- /**
1057
- * <p>A list that summarizes each composition relationship.</p>
1058
- * @public
1059
- */
1060
- compositionRelationshipSummaries: CompositionRelationshipSummary[] | undefined;
1061
- /**
1062
- * <p>The token for the next set of results, or null if there are no additional results.</p>
1063
- * @public
1064
- */
1065
- nextToken?: string | undefined;
1066
- }
1067
- /**
1068
- * <p>A filter used to match specific data binding values based on criteria. This filter allows
1069
- * searching for data bindings by asset, asset model, asset property, or asset model
1070
- * property.</p>
1071
- * @public
1072
- */
1073
- export interface DataBindingValueFilter {
1074
- /**
1075
- * <p>Filter criteria for matching data bindings based on a specific asset. Used to list all
1076
- * data bindings referencing a particular asset or its properties.</p>
1077
- * @public
1078
- */
1079
- asset?: AssetBindingValueFilter | undefined;
1080
- /**
1081
- * <p>Filter criteria for matching data bindings based on a specific asset model. Used to list
1082
- * all data bindings referencing a particular asset model or its properties.</p>
1083
- * @public
1084
- */
1085
- assetModel?: AssetModelBindingValueFilter | undefined;
1086
- /**
1087
- * <p>Filter criteria for matching data bindings based on a specific asset property. Used to
1088
- * list all data bindings referencing a particular property of an asset.</p>
1089
- * @public
1090
- */
1091
- assetProperty?: AssetPropertyBindingValueFilter | undefined;
1092
- /**
1093
- * <p>Filter criteria for matching data bindings based on a specific asset model property. Used
1094
- * to list all data bindings referencing a particular property of an asset model.</p>
1095
- * @public
1096
- */
1097
- assetModelProperty?: AssetModelPropertyBindingValueFilter | undefined;
1098
- }
1099
- /**
1100
- * @public
1101
- */
1102
- export interface ListComputationModelDataBindingUsagesRequest {
1103
- /**
1104
- * <p>A filter used to limit the returned data binding usages based on specific data binding
1105
- * values. You can filter by asset, asset model, asset property, or asset model property to find
1106
- * all computation models using these specific data sources.</p>
1107
- * @public
1108
- */
1109
- dataBindingValueFilter: DataBindingValueFilter | undefined;
1110
- /**
1111
- * <p>The token used for the next set of paginated results.</p>
1112
- * @public
1113
- */
1114
- nextToken?: string | undefined;
1115
- /**
1116
- * <p>The maximum number of results returned for each paginated request.</p>
1117
- * @public
1118
- */
1119
- maxResults?: number | undefined;
1120
- }
1121
- /**
1122
- * <p>Represents a value used in a data binding. It can be an asset property or an asset model
1123
- * property.</p>
1124
- * @public
1125
- */
1126
- export interface DataBindingValue {
1127
- /**
1128
- * <p>Contains information about an <code>assetModelProperty</code> binding value.</p>
1129
- * @public
1130
- */
1131
- assetModelProperty?: AssetModelPropertyBindingValue | undefined;
1132
- /**
1133
- * <p>The asset property value used in the data binding.</p>
1134
- * @public
1135
- */
1136
- assetProperty?: AssetPropertyBindingValue | undefined;
1137
- }
1138
- /**
1139
- * <p>Represents a data binding that matches the specified filter criteria.</p>
1140
- * @public
1141
- */
1142
- export interface MatchedDataBinding {
1143
- /**
1144
- * <p>The value of the matched data binding.</p>
1145
- * @public
1146
- */
1147
- value: DataBindingValue | undefined;
1148
- }
1149
- /**
1150
- * <p>A summary of how a specific data binding is used across computation models. This tracks
1151
- * dependencies between data sources and computation models, allowing you to understand the
1152
- * impact of changes to data sources.</p>
1153
- * @public
1154
- */
1155
- export interface ComputationModelDataBindingUsageSummary {
1156
- /**
1157
- * <p>The list of computation model IDs that use this data binding. This allows identification
1158
- * of all computation models affected by changes to the referenced data source.</p>
1159
- * @public
1160
- */
1161
- computationModelIds: string[] | undefined;
1162
- /**
1163
- * <p>The data binding matched by the filter criteria. Contains details about specific data
1164
- * binding values used by the computation models.</p>
1165
- * @public
1166
- */
1167
- matchedDataBinding: MatchedDataBinding | undefined;
1168
- }
1169
- /**
1170
- * @public
1171
- */
1172
- export interface ListComputationModelDataBindingUsagesResponse {
1173
- /**
1174
- * <p>A list of summaries describing the data binding usages across computation models. Each
1175
- * summary includes the computation model IDs and the matched data binding details.</p>
1176
- * @public
1177
- */
1178
- dataBindingUsageSummaries: ComputationModelDataBindingUsageSummary[] | undefined;
1179
- /**
1180
- * <p>The token for the next set of paginated results, or null if there are no additional
1181
- * results.</p>
1182
- * @public
1183
- */
1184
- nextToken?: string | undefined;
1185
- }
1186
- /**
1187
- * @public
1188
- */
1189
- export interface ListComputationModelResolveToResourcesRequest {
1190
- /**
1191
- * <p>The ID of the computation model for which to list resolved resources.</p>
1192
- * @public
1193
- */
1194
- computationModelId: string | undefined;
1195
- /**
1196
- * <p>The token used for the next set of paginated results.</p>
1197
- * @public
1198
- */
1199
- nextToken?: string | undefined;
1200
- /**
1201
- * <p>The maximum number of results returned for each paginated request.</p>
1202
- * @public
1203
- */
1204
- maxResults?: number | undefined;
1205
- }
1206
- /**
1207
- * <p>A summary of the resource that a computation model resolves to.</p>
1208
- * @public
1209
- */
1210
- export interface ComputationModelResolveToResourceSummary {
1211
- /**
1212
- * <p>The detailed resource this execution summary resolves to.</p>
1213
- * @public
1214
- */
1215
- resolveTo?: ResolveTo | undefined;
1216
- }
1217
- /**
1218
- * @public
1219
- */
1220
- export interface ListComputationModelResolveToResourcesResponse {
1221
- /**
1222
- * <p>A list of summaries describing the distinct resources that this computation model resolves
1223
- * to when actions were executed.</p>
1224
- * @public
1225
- */
1226
- computationModelResolveToResourceSummaries: ComputationModelResolveToResourceSummary[] | undefined;
1227
- /**
1228
- * <p>The token for the next set of paginated results, or null if there are no additional
1229
- * results.</p>
1230
- * @public
1231
- */
1232
- nextToken?: string | undefined;
1233
- }
1234
- /**
1235
- * @public
1236
- * @enum
1237
- */
1238
- export declare const ComputationModelType: {
1239
- readonly ANOMALY_DETECTION: "ANOMALY_DETECTION";
1240
- };
1241
- /**
1242
- * @public
1243
- */
1244
- export type ComputationModelType = (typeof ComputationModelType)[keyof typeof ComputationModelType];
1245
- /**
1246
- * @public
1247
- */
1248
- export interface ListComputationModelsRequest {
1249
- /**
1250
- * <p>The type of computation model. If a <code>computationModelType</code> is not provided, all
1251
- * types of computation models are returned.</p>
1252
- * @public
1253
- */
1254
- computationModelType?: ComputationModelType | undefined;
1255
- /**
1256
- * <p>The token to be used for the next set of paginated results.</p>
1257
- * @public
1258
- */
1259
- nextToken?: string | undefined;
1260
- /**
1261
- * <p>The maximum number of results to return for each paginated request.</p>
1262
- * @public
1263
- */
1264
- maxResults?: number | undefined;
1265
- }
1266
- /**
1267
- * <p>Contains a summary of a computation model.</p>
1268
- * @public
1269
- */
1270
- export interface ComputationModelSummary {
1271
- /**
1272
- * <p>The ID of the computation model.</p>
1273
- * @public
1274
- */
1275
- id: string | undefined;
1276
- /**
1277
- * <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>
1278
- * <p>
1279
- * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:computation-model/$\{ComputationModelId\}</code>
1280
- * </p>
1281
- * @public
1282
- */
1283
- arn: string | undefined;
1284
- /**
1285
- * <p>The name of the computation model.</p>
1286
- * @public
1287
- */
1288
- name: string | undefined;
1289
- /**
1290
- * <p>The description of the computation model.</p>
1291
- * @public
1292
- */
1293
- description?: string | undefined;
1294
- /**
1295
- * <p>The type of the computation model.</p>
1296
- * @public
1297
- */
1298
- type: ComputationModelType | undefined;
1299
- /**
1300
- * <p>The model creation date, in Unix epoch time.</p>
1301
- * @public
1302
- */
1303
- creationDate: Date | undefined;
1304
- /**
1305
- * <p>The time the model was last updated, in Unix epoch time.</p>
1306
- * @public
1307
- */
1308
- lastUpdateDate: Date | undefined;
1309
- /**
1310
- * <p>The current status of the computation model.</p>
1311
- * @public
1312
- */
1313
- status: ComputationModelStatus | undefined;
1314
- /**
1315
- * <p>The version of the computation model.</p>
1316
- * @public
1317
- */
1318
- version: string | undefined;
1319
- }
1320
- /**
1321
- * @public
1322
- */
1323
- export interface ListComputationModelsResponse {
1324
- /**
1325
- * <p>A list summarizing each computation model.</p>
1326
- * @public
1327
- */
1328
- computationModelSummaries: ComputationModelSummary[] | undefined;
1329
- /**
1330
- * <p>The token for the next set of results, or null if there are no additional results.</p>
1331
- * @public
1332
- */
1333
- nextToken?: string | undefined;
1334
- }
1335
- /**
1336
- * @public
1337
- */
1338
- export interface ListDashboardsRequest {
1339
- /**
1340
- * <p>The ID of the project.</p>
1341
- * @public
1342
- */
1343
- projectId: string | undefined;
1344
- /**
1345
- * <p>The token to be used for the next set of paginated results.</p>
1346
- * @public
1347
- */
1348
- nextToken?: string | undefined;
1349
- /**
1350
- * <p>The maximum number of results to return for each paginated request.</p>
1351
- * <p>Default: 50</p>
1352
- * @public
1353
- */
1354
- maxResults?: number | undefined;
1355
- }
1356
- /**
1357
- * <p>Contains a dashboard summary.</p>
1358
- * @public
1359
- */
1360
- export interface DashboardSummary {
1361
- /**
1362
- * <p>The ID of the dashboard.</p>
1363
- * @public
1364
- */
1365
- id: string | undefined;
1366
- /**
1367
- * <p>The name of the dashboard</p>
1368
- * @public
1369
- */
1370
- name: string | undefined;
1371
- /**
1372
- * <p>The dashboard's description.</p>
1373
- * @public
1374
- */
1375
- description?: string | undefined;
1376
- /**
1377
- * <p>The date the dashboard was created, in Unix epoch time.</p>
1378
- * @public
1379
- */
1380
- creationDate?: Date | undefined;
1381
- /**
1382
- * <p>The date the dashboard was last updated, in Unix epoch time.</p>
1383
- * @public
1384
- */
1385
- lastUpdateDate?: Date | undefined;
1386
- }
1387
- /**
1388
- * @public
1389
- */
1390
- export interface ListDashboardsResponse {
1391
- /**
1392
- * <p>A list that summarizes each dashboard in the project.</p>
1393
- * @public
1394
- */
1395
- dashboardSummaries: DashboardSummary[] | undefined;
1396
- /**
1397
- * <p>The token for the next set of results, or null if there are no additional results.</p>
1398
- * @public
1399
- */
1400
- nextToken?: string | undefined;
1401
- }
1402
- /**
1403
- * @public
1404
- */
1405
- export interface ListDatasetsRequest {
1406
- /**
1407
- * <p>The type of data source for the dataset.</p>
1408
- * @public
1409
- */
1410
- sourceType: DatasetSourceType | undefined;
1411
- /**
1412
- * <p>The token for the next set of results, or null if there are no additional results.</p>
1413
- * @public
1414
- */
1415
- nextToken?: string | undefined;
1416
- /**
1417
- * <p>The maximum number of results to return for each paginated request.</p>
1418
- * @public
1419
- */
1420
- maxResults?: number | undefined;
1421
- }
1422
- /**
1423
- * <p>The summary details for the dataset.</p>
1424
- * @public
1425
- */
1426
- export interface DatasetSummary {
1427
- /**
1428
- * <p>The ID of the dataset.</p>
1429
- * @public
1430
- */
1431
- id: string | undefined;
1432
- /**
1433
- * <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">ARN</a> of the dataset.
1434
- * The format is <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:dataset/$\{DatasetId\}</code>.</p>
1435
- * @public
1436
- */
1437
- arn: string | undefined;
1438
- /**
1439
- * <p>The name of the dataset.</p>
1440
- * @public
1441
- */
1442
- name: string | undefined;
1443
- /**
1444
- * <p>A description about the dataset, and its functionality.</p>
1445
- * @public
1446
- */
1447
- description: string | undefined;
1448
- /**
1449
- * <p>The dataset creation date, in Unix epoch time.</p>
1450
- * @public
1451
- */
1452
- creationDate: Date | undefined;
1453
- /**
1454
- * <p>The date the dataset was last updated, in Unix epoch time.</p>
1455
- * @public
1456
- */
1457
- lastUpdateDate: Date | undefined;
1458
- /**
1459
- * <p>The status of the dataset. This contains the state and any error messages. The state is
1460
- * <code>ACTIVE</code> when ready to use.</p>
1461
- * @public
1462
- */
1463
- status: DatasetStatus | undefined;
1464
- }
1465
- /**
1466
- * @public
1467
- */
1468
- export interface ListDatasetsResponse {
1469
- /**
1470
- * <p>A list that summarizes the dataset response.</p>
1471
- * @public
1472
- */
1473
- datasetSummaries: DatasetSummary[] | undefined;
1474
- /**
1475
- * <p>The token for the next set of results, or null if there are no additional results.</p>
1476
- * @public
1477
- */
1478
- nextToken?: string | undefined;
1479
- }
1480
- /**
1481
- * @public
1482
- */
1483
- export interface ListExecutionsRequest {
1484
- /**
1485
- * <p>The type of the target resource.</p>
1486
- * @public
1487
- */
1488
- targetResourceType: TargetResourceType | undefined;
1489
- /**
1490
- * <p>The ID of the target resource.</p>
1491
- * @public
1492
- */
1493
- targetResourceId: string | undefined;
1494
- /**
1495
- * <p>The type of the resolved resource.</p>
1496
- * @public
1497
- */
1498
- resolveToResourceType?: ResolveToResourceType | undefined;
1499
- /**
1500
- * <p>The ID of the resolved resource.</p>
1501
- * @public
1502
- */
1503
- resolveToResourceId?: string | undefined;
1504
- /**
1505
- * <p>The token used for the next set of paginated results.</p>
1506
- * @public
1507
- */
1508
- nextToken?: string | undefined;
1509
- /**
1510
- * <p>The maximum number of results returned for each paginated request.</p>
1511
- * @public
1512
- */
1513
- maxResults?: number | undefined;
1514
- /**
1515
- * <p>The type of action exectued.</p>
1516
- * @public
1517
- */
1518
- actionType?: string | undefined;
1519
- }
1520
- /**
1521
- * <p>Contains the execution summary of the computation model.</p>
1522
- * @public
1523
- */
1524
- export interface ExecutionSummary {
1525
- /**
1526
- * <p>The ID of the execution.</p>
1527
- * @public
1528
- */
1529
- executionId: string | undefined;
1530
- /**
1531
- * <p>The type of action exectued.</p>
1532
- * @public
1533
- */
1534
- actionType?: string | undefined;
1535
- /**
1536
- * <p>The resource the action will be taken on. This can include asset-based resources and
1537
- * computation model resources.</p>
1538
- * @public
1539
- */
1540
- targetResource: TargetResource | undefined;
1541
- /**
1542
- * <p>The version of the target resource.</p>
1543
- * @public
1544
- */
1545
- targetResourceVersion: string | undefined;
1546
- /**
1547
- * <p>The detailed resource this execution resolves to.</p>
1548
- * @public
1549
- */
1550
- resolveTo?: ResolveTo | undefined;
1551
- /**
1552
- * <p>The time the process started.</p>
1553
- * @public
1554
- */
1555
- executionStartTime: Date | undefined;
1556
- /**
1557
- * <p>The time the process ended.</p>
1558
- * @public
1559
- */
1560
- executionEndTime?: Date | undefined;
1561
- /**
1562
- * <p>The status of the execution process.</p>
1563
- * @public
1564
- */
1565
- executionStatus: ExecutionStatus | undefined;
1566
- /**
1567
- * <p>The execution entity version associated with the summary.</p>
1568
- * @public
1569
- */
1570
- executionEntityVersion?: string | undefined;
1571
- }
1572
- /**
1573
- * @public
1574
- */
1575
- export interface ListExecutionsResponse {
1576
- /**
1577
- * <p>Contains the list of execution summaries of the computation models.</p>
1578
- * @public
1579
- */
1580
- executionSummaries: ExecutionSummary[] | undefined;
1581
- /**
1582
- * <p>The token for the next set of results, or null if there are no additional results.</p>
1583
- * @public
1584
- */
1585
- nextToken?: string | undefined;
1586
- }
1587
- /**
1588
- * @public
1589
- */
1590
- export interface ListGatewaysRequest {
1591
- /**
1592
- * <p>The token to be used for the next set of paginated results.</p>
1593
- * @public
1594
- */
1595
- nextToken?: string | undefined;
1596
- /**
1597
- * <p>The maximum number of results to return for each paginated request.</p>
1598
- * <p>Default: 50</p>
1599
- * @public
1600
- */
1601
- maxResults?: number | undefined;
1602
- }
1603
- /**
1604
- * <p>Contains a summary of a gateway.</p>
1605
- * @public
1606
- */
1607
- export interface GatewaySummary {
1608
- /**
1609
- * <p>The ID of the gateway device.</p>
1610
- * @public
1611
- */
1612
- gatewayId: string | undefined;
1613
- /**
1614
- * <p>The name of the gateway.</p>
1615
- * @public
1616
- */
1617
- gatewayName: string | undefined;
1618
- /**
1619
- * <p>The gateway's platform configuration. You can only specify one platform type in a
1620
- * gateway.</p>
1621
- * <p>(Legacy only) For Greengrass V1 gateways, specify the <code>greengrass</code> parameter
1622
- * with a valid Greengrass group ARN.</p>
1623
- * <p>For Greengrass V2 gateways, specify the <code>greengrassV2</code> parameter with a valid
1624
- * core device thing name. If creating a V3 gateway (<code>gatewayVersion=3</code>), you must
1625
- * also specify the <code>coreDeviceOperatingSystem</code>.</p>
1626
- * <p>For Siemens Industrial Edge gateways, specify the <code>siemensIE</code> parameter with a
1627
- * valid IoT Core thing name.</p>
1628
- * @public
1629
- */
1630
- gatewayPlatform?: GatewayPlatform | undefined;
1631
- /**
1632
- * <p>The version of the gateway. A value of <code>3</code> indicates an MQTT-enabled, V3
1633
- * gateway, while <code>2</code> indicates a Classic streams, V2 gateway.</p>
1634
- * @public
1635
- */
1636
- gatewayVersion?: string | undefined;
1637
- /**
1638
- * <p>A list of gateway capability summaries that each contain a namespace and status. Each
1639
- * gateway capability defines data sources for the gateway. To retrieve a capability
1640
- * configuration's definition, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.</p>
1641
- * @public
1642
- */
1643
- gatewayCapabilitySummaries?: GatewayCapabilitySummary[] | undefined;
1644
- /**
1645
- * <p>The date the gateway was created, in Unix epoch time.</p>
1646
- * @public
1647
- */
1648
- creationDate: Date | undefined;
1649
- /**
1650
- * <p>The date the gateway was last updated, in Unix epoch time.</p>
1651
- * @public
1652
- */
1653
- lastUpdateDate: Date | undefined;
1654
- }
1655
- /**
1656
- * @public
1657
- */
1658
- export interface ListGatewaysResponse {
1659
- /**
1660
- * <p>A list that summarizes each gateway.</p>
1661
- * @public
1662
- */
1663
- gatewaySummaries: GatewaySummary[] | undefined;
1664
- /**
1665
- * <p>The token for the next set of results, or null if there are no additional results.</p>
1666
- * @public
1667
- */
1668
- nextToken?: string | undefined;
1669
- }
1
+ import { AssetModelVersionType, CapabilitySyncStatus, DisassociatedDataStorageState, EncryptionType, ListTimeSeriesType, Permission, PortalType, PropertyDataType, PropertyNotificationState, StorageType, WarmTierState } from "./enums";
2
+ import { ActionDefinition, Alarms, AssetModelCompositeModel, AssetModelCompositeModelPathSegment, AssetModelHierarchy, AssetModelProperty, AssetModelPropertyBindingValue, AssetModelStatus, AssetPropertyBindingValue, AssetStatus, ColumnInfo, ComputationModelConfiguration, ComputationModelStatus, ConfigurationStatus, DatasetSource, DatasetStatus, Identity, ImageFile, LoggingOptions, MultiLayerStorage, PortalStatus, PortalTypeEntry, PropertyMapping, Resource, RetentionPeriod, WarmTierRetentionPeriod } from "./models_0";
1670
3
  /**
1671
4
  * @public
1672
5
  */
@@ -1927,30 +260,6 @@ export interface ListTagsForResourceResponse {
1927
260
  */
1928
261
  tags?: Record<string, string> | undefined;
1929
262
  }
1930
- /**
1931
- * <p>You are not authorized.</p>
1932
- * @public
1933
- */
1934
- export declare class UnauthorizedException extends __BaseException {
1935
- readonly name: "UnauthorizedException";
1936
- readonly $fault: "client";
1937
- /**
1938
- * @internal
1939
- */
1940
- constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
1941
- }
1942
- /**
1943
- * @public
1944
- * @enum
1945
- */
1946
- export declare const ListTimeSeriesType: {
1947
- readonly ASSOCIATED: "ASSOCIATED";
1948
- readonly DISASSOCIATED: "DISASSOCIATED";
1949
- };
1950
- /**
1951
- * @public
1952
- */
1953
- export type ListTimeSeriesType = (typeof ListTimeSeriesType)[keyof typeof ListTimeSeriesType];
1954
263
  /**
1955
264
  * @public
1956
265
  */
@@ -2374,25 +683,6 @@ export interface TagResourceRequest {
2374
683
  */
2375
684
  export interface TagResourceResponse {
2376
685
  }
2377
- /**
2378
- * <p>You've reached the quota for the number of tags allowed for a resource. For more
2379
- * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions">Tag naming limits and
2380
- * requirements</a> in the <i>Amazon Web Services General Reference</i>.</p>
2381
- * @public
2382
- */
2383
- export declare class TooManyTagsException extends __BaseException {
2384
- readonly name: "TooManyTagsException";
2385
- readonly $fault: "client";
2386
- /**
2387
- * <p>The name of the resource with too many tags.</p>
2388
- * @public
2389
- */
2390
- resourceName?: string | undefined;
2391
- /**
2392
- * @internal
2393
- */
2394
- constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
2395
- }
2396
686
  /**
2397
687
  * @public
2398
688
  */