@aws-sdk/client-iottwinmaker 3.533.0 → 3.535.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 (85) hide show
  1. package/dist-types/IoTTwinMaker.d.ts +3 -1
  2. package/dist-types/IoTTwinMakerClient.d.ts +1 -1
  3. package/dist-types/commands/BatchPutPropertyValuesCommand.d.ts +2 -1
  4. package/dist-types/commands/CancelMetadataTransferJobCommand.d.ts +2 -1
  5. package/dist-types/commands/CreateComponentTypeCommand.d.ts +2 -1
  6. package/dist-types/commands/CreateEntityCommand.d.ts +2 -1
  7. package/dist-types/commands/CreateMetadataTransferJobCommand.d.ts +2 -1
  8. package/dist-types/commands/CreateSceneCommand.d.ts +2 -1
  9. package/dist-types/commands/CreateSyncJobCommand.d.ts +2 -1
  10. package/dist-types/commands/CreateWorkspaceCommand.d.ts +2 -1
  11. package/dist-types/commands/DeleteComponentTypeCommand.d.ts +2 -1
  12. package/dist-types/commands/DeleteEntityCommand.d.ts +2 -1
  13. package/dist-types/commands/DeleteSceneCommand.d.ts +2 -1
  14. package/dist-types/commands/DeleteSyncJobCommand.d.ts +2 -1
  15. package/dist-types/commands/DeleteWorkspaceCommand.d.ts +2 -1
  16. package/dist-types/commands/ExecuteQueryCommand.d.ts +2 -1
  17. package/dist-types/commands/GetComponentTypeCommand.d.ts +2 -1
  18. package/dist-types/commands/GetEntityCommand.d.ts +2 -1
  19. package/dist-types/commands/GetMetadataTransferJobCommand.d.ts +2 -1
  20. package/dist-types/commands/GetPricingPlanCommand.d.ts +2 -1
  21. package/dist-types/commands/GetPropertyValueCommand.d.ts +2 -1
  22. package/dist-types/commands/GetPropertyValueHistoryCommand.d.ts +2 -1
  23. package/dist-types/commands/GetSceneCommand.d.ts +2 -1
  24. package/dist-types/commands/GetSyncJobCommand.d.ts +2 -1
  25. package/dist-types/commands/GetWorkspaceCommand.d.ts +2 -1
  26. package/dist-types/commands/ListComponentTypesCommand.d.ts +2 -1
  27. package/dist-types/commands/ListComponentsCommand.d.ts +2 -1
  28. package/dist-types/commands/ListEntitiesCommand.d.ts +2 -1
  29. package/dist-types/commands/ListMetadataTransferJobsCommand.d.ts +2 -1
  30. package/dist-types/commands/ListPropertiesCommand.d.ts +2 -1
  31. package/dist-types/commands/ListScenesCommand.d.ts +2 -1
  32. package/dist-types/commands/ListSyncJobsCommand.d.ts +2 -1
  33. package/dist-types/commands/ListSyncResourcesCommand.d.ts +2 -1
  34. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  35. package/dist-types/commands/ListWorkspacesCommand.d.ts +2 -1
  36. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  37. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  38. package/dist-types/commands/UpdateComponentTypeCommand.d.ts +2 -1
  39. package/dist-types/commands/UpdateEntityCommand.d.ts +2 -1
  40. package/dist-types/commands/UpdatePricingPlanCommand.d.ts +2 -1
  41. package/dist-types/commands/UpdateSceneCommand.d.ts +2 -1
  42. package/dist-types/commands/UpdateWorkspaceCommand.d.ts +2 -1
  43. package/dist-types/models/models_0.d.ts +631 -631
  44. package/dist-types/ts3.4/IoTTwinMaker.d.ts +2 -0
  45. package/dist-types/ts3.4/commands/BatchPutPropertyValuesCommand.d.ts +9 -0
  46. package/dist-types/ts3.4/commands/CancelMetadataTransferJobCommand.d.ts +9 -0
  47. package/dist-types/ts3.4/commands/CreateComponentTypeCommand.d.ts +9 -0
  48. package/dist-types/ts3.4/commands/CreateEntityCommand.d.ts +9 -0
  49. package/dist-types/ts3.4/commands/CreateMetadataTransferJobCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/CreateSceneCommand.d.ts +9 -0
  51. package/dist-types/ts3.4/commands/CreateSyncJobCommand.d.ts +9 -0
  52. package/dist-types/ts3.4/commands/CreateWorkspaceCommand.d.ts +9 -0
  53. package/dist-types/ts3.4/commands/DeleteComponentTypeCommand.d.ts +9 -0
  54. package/dist-types/ts3.4/commands/DeleteEntityCommand.d.ts +9 -0
  55. package/dist-types/ts3.4/commands/DeleteSceneCommand.d.ts +9 -0
  56. package/dist-types/ts3.4/commands/DeleteSyncJobCommand.d.ts +9 -0
  57. package/dist-types/ts3.4/commands/DeleteWorkspaceCommand.d.ts +9 -0
  58. package/dist-types/ts3.4/commands/ExecuteQueryCommand.d.ts +9 -0
  59. package/dist-types/ts3.4/commands/GetComponentTypeCommand.d.ts +9 -0
  60. package/dist-types/ts3.4/commands/GetEntityCommand.d.ts +9 -0
  61. package/dist-types/ts3.4/commands/GetMetadataTransferJobCommand.d.ts +9 -0
  62. package/dist-types/ts3.4/commands/GetPricingPlanCommand.d.ts +9 -0
  63. package/dist-types/ts3.4/commands/GetPropertyValueCommand.d.ts +9 -0
  64. package/dist-types/ts3.4/commands/GetPropertyValueHistoryCommand.d.ts +9 -0
  65. package/dist-types/ts3.4/commands/GetSceneCommand.d.ts +9 -0
  66. package/dist-types/ts3.4/commands/GetSyncJobCommand.d.ts +9 -0
  67. package/dist-types/ts3.4/commands/GetWorkspaceCommand.d.ts +9 -0
  68. package/dist-types/ts3.4/commands/ListComponentTypesCommand.d.ts +9 -0
  69. package/dist-types/ts3.4/commands/ListComponentsCommand.d.ts +9 -0
  70. package/dist-types/ts3.4/commands/ListEntitiesCommand.d.ts +9 -0
  71. package/dist-types/ts3.4/commands/ListMetadataTransferJobsCommand.d.ts +9 -0
  72. package/dist-types/ts3.4/commands/ListPropertiesCommand.d.ts +9 -0
  73. package/dist-types/ts3.4/commands/ListScenesCommand.d.ts +9 -0
  74. package/dist-types/ts3.4/commands/ListSyncJobsCommand.d.ts +9 -0
  75. package/dist-types/ts3.4/commands/ListSyncResourcesCommand.d.ts +9 -0
  76. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  77. package/dist-types/ts3.4/commands/ListWorkspacesCommand.d.ts +9 -0
  78. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  79. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  80. package/dist-types/ts3.4/commands/UpdateComponentTypeCommand.d.ts +9 -0
  81. package/dist-types/ts3.4/commands/UpdateEntityCommand.d.ts +9 -0
  82. package/dist-types/ts3.4/commands/UpdatePricingPlanCommand.d.ts +9 -0
  83. package/dist-types/ts3.4/commands/UpdateSceneCommand.d.ts +9 -0
  84. package/dist-types/ts3.4/commands/UpdateWorkspaceCommand.d.ts +9 -0
  85. package/package.json +40 -40
@@ -2,8 +2,8 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
2
2
  import { DocumentType as __DocumentType } from "@smithy/types";
3
3
  import { IoTTwinMakerServiceException as __BaseException } from "./IoTTwinMakerServiceException";
4
4
  /**
5
- * @public
6
5
  * <p>Access is denied.</p>
6
+ * @public
7
7
  */
8
8
  export declare class AccessDeniedException extends __BaseException {
9
9
  readonly name: "AccessDeniedException";
@@ -14,56 +14,56 @@ export declare class AccessDeniedException extends __BaseException {
14
14
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
15
15
  }
16
16
  /**
17
- * @public
18
17
  * <p>An object that uniquely identifies an entity property.</p>
18
+ * @public
19
19
  */
20
20
  export interface EntityPropertyReference {
21
21
  /**
22
- * @public
23
22
  * <p>The name of the component.</p>
23
+ * @public
24
24
  */
25
25
  componentName?: string;
26
26
  /**
27
- * @public
28
27
  * <p>This string specifies the path to the composite component, starting from the top-level component.</p>
28
+ * @public
29
29
  */
30
30
  componentPath?: string;
31
31
  /**
32
- * @public
33
32
  * <p>A mapping of external IDs to property names. External IDs uniquely identify properties
34
33
  * from external data stores.</p>
34
+ * @public
35
35
  */
36
36
  externalIdProperty?: Record<string, string>;
37
37
  /**
38
- * @public
39
38
  * <p>The ID of the entity.</p>
39
+ * @public
40
40
  */
41
41
  entityId?: string;
42
42
  /**
43
- * @public
44
43
  * <p>The name of the property.</p>
44
+ * @public
45
45
  */
46
46
  propertyName: string | undefined;
47
47
  }
48
48
  /**
49
- * @public
50
49
  * <p>A value that associates a component and an entity.</p>
50
+ * @public
51
51
  */
52
52
  export interface RelationshipValue {
53
53
  /**
54
- * @public
55
54
  * <p>The ID of the target entity associated with this relationship value.</p>
55
+ * @public
56
56
  */
57
57
  targetEntityId?: string;
58
58
  /**
59
- * @public
60
59
  * <p>The name of the target component associated with the relationship value.</p>
60
+ * @public
61
61
  */
62
62
  targetComponentName?: string;
63
63
  }
64
64
  /**
65
- * @public
66
65
  * <p>An unexpected error has occurred.</p>
66
+ * @public
67
67
  */
68
68
  export declare class InternalServerException extends __BaseException {
69
69
  readonly name: "InternalServerException";
@@ -74,8 +74,8 @@ export declare class InternalServerException extends __BaseException {
74
74
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
75
75
  }
76
76
  /**
77
- * @public
78
77
  * <p>The resource wasn't found.</p>
78
+ * @public
79
79
  */
80
80
  export declare class ResourceNotFoundException extends __BaseException {
81
81
  readonly name: "ResourceNotFoundException";
@@ -86,8 +86,8 @@ export declare class ResourceNotFoundException extends __BaseException {
86
86
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
87
87
  }
88
88
  /**
89
- * @public
90
89
  * <p>The rate exceeds the limit.</p>
90
+ * @public
91
91
  */
92
92
  export declare class ThrottlingException extends __BaseException {
93
93
  readonly name: "ThrottlingException";
@@ -98,8 +98,8 @@ export declare class ThrottlingException extends __BaseException {
98
98
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
99
99
  }
100
100
  /**
101
- * @public
102
101
  * <p>Failed</p>
102
+ * @public
103
103
  */
104
104
  export declare class ValidationException extends __BaseException {
105
105
  readonly name: "ValidationException";
@@ -114,34 +114,34 @@ export declare class ValidationException extends __BaseException {
114
114
  */
115
115
  export interface CancelMetadataTransferJobRequest {
116
116
  /**
117
- * @public
118
117
  * <p>The metadata transfer job Id.</p>
118
+ * @public
119
119
  */
120
120
  metadataTransferJobId: string | undefined;
121
121
  }
122
122
  /**
123
- * @public
124
123
  * <p>The metadata transfer job's progress.</p>
124
+ * @public
125
125
  */
126
126
  export interface MetadataTransferJobProgress {
127
127
  /**
128
- * @public
129
128
  * <p>The total count. [of what]</p>
129
+ * @public
130
130
  */
131
131
  totalCount?: number;
132
132
  /**
133
- * @public
134
133
  * <p>The succeeded count.</p>
134
+ * @public
135
135
  */
136
136
  succeededCount?: number;
137
137
  /**
138
- * @public
139
138
  * <p>The skipped count.</p>
139
+ * @public
140
140
  */
141
141
  skippedCount?: number;
142
142
  /**
143
- * @public
144
143
  * <p>The failed count.</p>
144
+ * @public
145
145
  */
146
146
  failedCount?: number;
147
147
  }
@@ -164,18 +164,18 @@ export declare const ErrorCode: {
164
164
  */
165
165
  export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
166
166
  /**
167
- * @public
168
167
  * <p>The error details.</p>
168
+ * @public
169
169
  */
170
170
  export interface ErrorDetails {
171
171
  /**
172
- * @public
173
172
  * <p>The error code.</p>
173
+ * @public
174
174
  */
175
175
  code?: ErrorCode;
176
176
  /**
177
- * @public
178
177
  * <p>The error message.</p>
178
+ * @public
179
179
  */
180
180
  message?: string;
181
181
  }
@@ -197,23 +197,23 @@ export declare const MetadataTransferJobState: {
197
197
  */
198
198
  export type MetadataTransferJobState = (typeof MetadataTransferJobState)[keyof typeof MetadataTransferJobState];
199
199
  /**
200
- * @public
201
200
  * <p>The metadata transfer job status.</p>
201
+ * @public
202
202
  */
203
203
  export interface MetadataTransferJobStatus {
204
204
  /**
205
- * @public
206
205
  * <p>The metadata transfer job state.</p>
206
+ * @public
207
207
  */
208
208
  state?: MetadataTransferJobState;
209
209
  /**
210
- * @public
211
210
  * <p>The metadata transfer job error.</p>
211
+ * @public
212
212
  */
213
213
  error?: ErrorDetails;
214
214
  /**
215
- * @public
216
215
  * <p>The queued position.</p>
216
+ * @public
217
217
  */
218
218
  queuedPosition?: number;
219
219
  }
@@ -222,34 +222,34 @@ export interface MetadataTransferJobStatus {
222
222
  */
223
223
  export interface CancelMetadataTransferJobResponse {
224
224
  /**
225
- * @public
226
225
  * <p>The metadata transfer job Id.</p>
226
+ * @public
227
227
  */
228
228
  metadataTransferJobId: string | undefined;
229
229
  /**
230
- * @public
231
230
  * <p>The metadata transfer job ARN.</p>
231
+ * @public
232
232
  */
233
233
  arn: string | undefined;
234
234
  /**
235
- * @public
236
235
  * <p>Used to update the DateTime property.</p>
236
+ * @public
237
237
  */
238
238
  updateDateTime: Date | undefined;
239
239
  /**
240
- * @public
241
240
  * <p>The metadata transfer job's status.</p>
241
+ * @public
242
242
  */
243
243
  status: MetadataTransferJobStatus | undefined;
244
244
  /**
245
- * @public
246
245
  * <p>The metadata transfer job's progress.</p>
246
+ * @public
247
247
  */
248
248
  progress?: MetadataTransferJobProgress;
249
249
  }
250
250
  /**
251
- * @public
252
251
  * <p>A conflict occurred.</p>
252
+ * @public
253
253
  */
254
254
  export declare class ConflictException extends __BaseException {
255
255
  readonly name: "ConflictException";
@@ -260,41 +260,41 @@ export declare class ConflictException extends __BaseException {
260
260
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
261
261
  }
262
262
  /**
263
- * @public
264
263
  * <p>An object that sets information about the composite component types of a component type.</p>
264
+ * @public
265
265
  */
266
266
  export interface CompositeComponentTypeRequest {
267
267
  /**
268
- * @public
269
268
  * <p>This is the <code>componentTypeId</code> that the <code>compositeComponentType</code> refers to.</p>
269
+ * @public
270
270
  */
271
271
  componentTypeId?: string;
272
272
  }
273
273
  /**
274
- * @public
275
274
  * <p>The Lambda function.</p>
275
+ * @public
276
276
  */
277
277
  export interface LambdaFunction {
278
278
  /**
279
- * @public
280
279
  * <p>The ARN of the Lambda function.</p>
280
+ * @public
281
281
  */
282
282
  arn: string | undefined;
283
283
  }
284
284
  /**
285
- * @public
286
285
  * <p>The data connector.</p>
286
+ * @public
287
287
  */
288
288
  export interface DataConnector {
289
289
  /**
290
- * @public
291
290
  * <p>The Lambda function associated with this data connector.</p>
291
+ * @public
292
292
  */
293
293
  lambda?: LambdaFunction;
294
294
  /**
295
- * @public
296
295
  * <p>A Boolean value that specifies whether the data connector is native to IoT
297
296
  * TwinMaker.</p>
297
+ * @public
298
298
  */
299
299
  isNative?: boolean;
300
300
  }
@@ -311,39 +311,39 @@ export declare const Scope: {
311
311
  */
312
312
  export type Scope = (typeof Scope)[keyof typeof Scope];
313
313
  /**
314
- * @public
315
314
  * <p>The function request body.</p>
315
+ * @public
316
316
  */
317
317
  export interface FunctionRequest {
318
318
  /**
319
- * @public
320
319
  * <p>The required properties of the function.</p>
320
+ * @public
321
321
  */
322
322
  requiredProperties?: string[];
323
323
  /**
324
- * @public
325
324
  * <p>The scope of the function.</p>
325
+ * @public
326
326
  */
327
327
  scope?: Scope;
328
328
  /**
329
- * @public
330
329
  * <p>The data connector.</p>
330
+ * @public
331
331
  */
332
332
  implementedBy?: DataConnector;
333
333
  }
334
334
  /**
335
- * @public
336
335
  * <p>An object that specifies a relationship with another component type.</p>
336
+ * @public
337
337
  */
338
338
  export interface Relationship {
339
339
  /**
340
- * @public
341
340
  * <p>The ID of the target component type associated with this relationship.</p>
341
+ * @public
342
342
  */
343
343
  targetComponentTypeId?: string;
344
344
  /**
345
- * @public
346
345
  * <p>The type of the relationship.</p>
346
+ * @public
347
347
  */
348
348
  relationshipType?: string;
349
349
  }
@@ -377,18 +377,18 @@ export declare const GroupType: {
377
377
  */
378
378
  export type GroupType = (typeof GroupType)[keyof typeof GroupType];
379
379
  /**
380
- * @public
381
380
  * <p/>
381
+ * @public
382
382
  */
383
383
  export interface PropertyGroupRequest {
384
384
  /**
385
- * @public
386
385
  * <p>The group type.</p>
386
+ * @public
387
387
  */
388
388
  groupType?: GroupType;
389
389
  /**
390
- * @public
391
390
  * <p>The names of properties.</p>
391
+ * @public
392
392
  */
393
393
  propertyNames?: string[];
394
394
  }
@@ -412,24 +412,24 @@ export type State = (typeof State)[keyof typeof State];
412
412
  */
413
413
  export interface CreateComponentTypeResponse {
414
414
  /**
415
- * @public
416
415
  * <p>The ARN of the component type.</p>
416
+ * @public
417
417
  */
418
418
  arn: string | undefined;
419
419
  /**
420
- * @public
421
420
  * <p>The date and time when the entity was created.</p>
421
+ * @public
422
422
  */
423
423
  creationDateTime: Date | undefined;
424
424
  /**
425
- * @public
426
425
  * <p>The current state of the component type.</p>
426
+ * @public
427
427
  */
428
428
  state: State | undefined;
429
429
  }
430
430
  /**
431
- * @public
432
431
  * <p>The service quota was exceeded.</p>
432
+ * @public
433
433
  */
434
434
  export declare class ServiceQuotaExceededException extends __BaseException {
435
435
  readonly name: "ServiceQuotaExceededException";
@@ -466,23 +466,23 @@ export declare const PropertyGroupUpdateType: {
466
466
  */
467
467
  export type PropertyGroupUpdateType = (typeof PropertyGroupUpdateType)[keyof typeof PropertyGroupUpdateType];
468
468
  /**
469
- * @public
470
469
  * <p>The component property group request.</p>
470
+ * @public
471
471
  */
472
472
  export interface ComponentPropertyGroupRequest {
473
473
  /**
474
- * @public
475
474
  * <p>The group type.</p>
475
+ * @public
476
476
  */
477
477
  groupType?: GroupType;
478
478
  /**
479
- * @public
480
479
  * <p>The property names.</p>
480
+ * @public
481
481
  */
482
482
  propertyNames?: string[];
483
483
  /**
484
- * @public
485
484
  * <p>The update type.</p>
485
+ * @public
486
486
  */
487
487
  updateType?: PropertyGroupUpdateType;
488
488
  }
@@ -491,45 +491,45 @@ export interface ComponentPropertyGroupRequest {
491
491
  */
492
492
  export interface CreateEntityResponse {
493
493
  /**
494
- * @public
495
494
  * <p>The ID of the entity.</p>
495
+ * @public
496
496
  */
497
497
  entityId: string | undefined;
498
498
  /**
499
- * @public
500
499
  * <p>The ARN of the entity.</p>
500
+ * @public
501
501
  */
502
502
  arn: string | undefined;
503
503
  /**
504
- * @public
505
504
  * <p>The date and time when the entity was created.</p>
505
+ * @public
506
506
  */
507
507
  creationDateTime: Date | undefined;
508
508
  /**
509
- * @public
510
509
  * <p>The current state of the entity.</p>
510
+ * @public
511
511
  */
512
512
  state: State | undefined;
513
513
  }
514
514
  /**
515
- * @public
516
515
  * <p>The metadata transfer job AWS IoT TwinMaker destination configuration.</p>
516
+ * @public
517
517
  */
518
518
  export interface IotTwinMakerDestinationConfiguration {
519
519
  /**
520
- * @public
521
520
  * <p>The IoT TwinMaker workspace.</p>
521
+ * @public
522
522
  */
523
523
  workspace: string | undefined;
524
524
  }
525
525
  /**
526
- * @public
527
526
  * <p>The S3 destination configuration.</p>
527
+ * @public
528
528
  */
529
529
  export interface S3DestinationConfiguration {
530
530
  /**
531
- * @public
532
531
  * <p>The S3 destination configuration location.</p>
532
+ * @public
533
533
  */
534
534
  location: string | undefined;
535
535
  }
@@ -547,81 +547,81 @@ export declare const DestinationType: {
547
547
  */
548
548
  export type DestinationType = (typeof DestinationType)[keyof typeof DestinationType];
549
549
  /**
550
- * @public
551
550
  * <p>The [link to action] metadata transfer job destination configuration.</p>
551
+ * @public
552
552
  */
553
553
  export interface DestinationConfiguration {
554
554
  /**
555
- * @public
556
555
  * <p>The destination type.</p>
556
+ * @public
557
557
  */
558
558
  type: DestinationType | undefined;
559
559
  /**
560
- * @public
561
560
  * <p>The metadata transfer job S3 configuration. [need to add S3 entity]</p>
561
+ * @public
562
562
  */
563
563
  s3Configuration?: S3DestinationConfiguration;
564
564
  /**
565
- * @public
566
565
  * <p>The metadata transfer job Amazon Web Services IoT TwinMaker configuration.</p>
566
+ * @public
567
567
  */
568
568
  iotTwinMakerConfiguration?: IotTwinMakerDestinationConfiguration;
569
569
  }
570
570
  /**
571
- * @public
572
571
  * <p>Filter by asset. [TwinMaker asset]</p>
572
+ * @public
573
573
  */
574
574
  export interface FilterByAsset {
575
575
  /**
576
- * @public
577
576
  * <p>Filter by asset Id.</p>
577
+ * @public
578
578
  */
579
579
  assetId?: string;
580
580
  /**
581
- * @public
582
581
  * <p>The external-Id property of an asset. </p>
582
+ * @public
583
583
  */
584
584
  assetExternalId?: string;
585
585
  /**
586
- * @public
587
586
  * <p>Includes sub-assets.[need description hekp for this]</p>
587
+ * @public
588
588
  */
589
589
  includeOffspring?: boolean;
590
590
  /**
591
- * @public
592
591
  * <p>Boolean to include the asset model.</p>
592
+ * @public
593
593
  */
594
594
  includeAssetModel?: boolean;
595
595
  }
596
596
  /**
597
- * @public
598
597
  * <p>Filter by asset model.</p>
598
+ * @public
599
599
  */
600
600
  export interface FilterByAssetModel {
601
601
  /**
602
- * @public
603
602
  * <p>The asset model Id.</p>
603
+ * @public
604
604
  */
605
605
  assetModelId?: string;
606
606
  /**
607
- * @public
608
607
  * <p>The external-Id property of an asset model.</p>
608
+ * @public
609
609
  */
610
610
  assetModelExternalId?: string;
611
611
  /**
612
- * @public
613
612
  * <p>Include asset offspring. [need desc.]</p>
613
+ * @public
614
614
  */
615
615
  includeOffspring?: boolean;
616
616
  /**
617
- * @public
618
617
  * <p>Bolean to include assets.</p>
618
+ * @public
619
619
  */
620
620
  includeAssets?: boolean;
621
621
  }
622
622
  /**
623
- * @public
624
623
  * <p>The AWS IoT SiteWise soucre configuration filter.[need held with desc here]</p>
624
+ * @public
625
625
  */
626
626
  export type IotSiteWiseSourceConfigurationFilter = IotSiteWiseSourceConfigurationFilter.FilterByAssetMember | IotSiteWiseSourceConfigurationFilter.FilterByAssetModelMember | IotSiteWiseSourceConfigurationFilter.$UnknownMember;
627
627
  /**
@@ -629,8 +629,8 @@ export type IotSiteWiseSourceConfigurationFilter = IotSiteWiseSourceConfiguratio
629
629
  */
630
630
  export declare namespace IotSiteWiseSourceConfigurationFilter {
631
631
  /**
632
- * @public
633
632
  * <p>Filter by asset model.</p>
633
+ * @public
634
634
  */
635
635
  interface FilterByAssetModelMember {
636
636
  filterByAssetModel: FilterByAssetModel;
@@ -638,8 +638,8 @@ export declare namespace IotSiteWiseSourceConfigurationFilter {
638
638
  $unknown?: never;
639
639
  }
640
640
  /**
641
- * @public
642
641
  * <p>Filter by asset.</p>
642
+ * @public
643
643
  */
644
644
  interface FilterByAssetMember {
645
645
  filterByAssetModel?: never;
@@ -662,41 +662,41 @@ export declare namespace IotSiteWiseSourceConfigurationFilter {
662
662
  const visit: <T>(value: IotSiteWiseSourceConfigurationFilter, visitor: Visitor<T>) => T;
663
663
  }
664
664
  /**
665
- * @public
666
665
  * <p>The metadata transfer job AWS IoT SiteWise source configuration.</p>
666
+ * @public
667
667
  */
668
668
  export interface IotSiteWiseSourceConfiguration {
669
669
  /**
670
- * @public
671
670
  * <p>The AWS IoT SiteWise soucre configuration filters.</p>
671
+ * @public
672
672
  */
673
673
  filters?: IotSiteWiseSourceConfigurationFilter[];
674
674
  }
675
675
  /**
676
- * @public
677
676
  * <p>Filter by component type.</p>
677
+ * @public
678
678
  */
679
679
  export interface FilterByComponentType {
680
680
  /**
681
- * @public
682
681
  * <p>The component type Id.</p>
682
+ * @public
683
683
  */
684
684
  componentTypeId: string | undefined;
685
685
  }
686
686
  /**
687
- * @public
688
687
  * <p>Vilter by entity.</p>
688
+ * @public
689
689
  */
690
690
  export interface FilterByEntity {
691
691
  /**
692
- * @public
693
692
  * <p>The entity Id.</p>
693
+ * @public
694
694
  */
695
695
  entityId: string | undefined;
696
696
  }
697
697
  /**
698
- * @public
699
698
  * <p>The metadata transfer job AWS IoT TwinMaker source configuration filter.</p>
699
+ * @public
700
700
  */
701
701
  export type IotTwinMakerSourceConfigurationFilter = IotTwinMakerSourceConfigurationFilter.FilterByComponentTypeMember | IotTwinMakerSourceConfigurationFilter.FilterByEntityMember | IotTwinMakerSourceConfigurationFilter.$UnknownMember;
702
702
  /**
@@ -704,8 +704,8 @@ export type IotTwinMakerSourceConfigurationFilter = IotTwinMakerSourceConfigurat
704
704
  */
705
705
  export declare namespace IotTwinMakerSourceConfigurationFilter {
706
706
  /**
707
- * @public
708
707
  * <p>Filter by component type.</p>
708
+ * @public
709
709
  */
710
710
  interface FilterByComponentTypeMember {
711
711
  filterByComponentType: FilterByComponentType;
@@ -713,8 +713,8 @@ export declare namespace IotTwinMakerSourceConfigurationFilter {
713
713
  $unknown?: never;
714
714
  }
715
715
  /**
716
- * @public
717
716
  * <p>Filter by entity.</p>
717
+ * @public
718
718
  */
719
719
  interface FilterByEntityMember {
720
720
  filterByComponentType?: never;
@@ -737,29 +737,29 @@ export declare namespace IotTwinMakerSourceConfigurationFilter {
737
737
  const visit: <T>(value: IotTwinMakerSourceConfigurationFilter, visitor: Visitor<T>) => T;
738
738
  }
739
739
  /**
740
- * @public
741
740
  * <p>The metadata transfer job AWS IoT TwinMaker source configuration.</p>
741
+ * @public
742
742
  */
743
743
  export interface IotTwinMakerSourceConfiguration {
744
744
  /**
745
- * @public
746
745
  * <p>The IoT TwinMaker workspace.</p>
746
+ * @public
747
747
  */
748
748
  workspace: string | undefined;
749
749
  /**
750
- * @public
751
750
  * <p>The metadata transfer job AWS IoT TwinMaker source configuration filters.</p>
751
+ * @public
752
752
  */
753
753
  filters?: IotTwinMakerSourceConfigurationFilter[];
754
754
  }
755
755
  /**
756
- * @public
757
756
  * <p>The S3 destination source configuration.</p>
757
+ * @public
758
758
  */
759
759
  export interface S3SourceConfiguration {
760
760
  /**
761
- * @public
762
761
  * <p>The S3 destination source configuration location.</p>
762
+ * @public
763
763
  */
764
764
  location: string | undefined;
765
765
  }
@@ -777,28 +777,28 @@ export declare const SourceType: {
777
777
  */
778
778
  export type SourceType = (typeof SourceType)[keyof typeof SourceType];
779
779
  /**
780
- * @public
781
780
  * <p>The source configuration.</p>
781
+ * @public
782
782
  */
783
783
  export interface SourceConfiguration {
784
784
  /**
785
- * @public
786
785
  * <p>The source configuration type.</p>
786
+ * @public
787
787
  */
788
788
  type: SourceType | undefined;
789
789
  /**
790
- * @public
791
790
  * <p>The source configuration S3 configuration.</p>
791
+ * @public
792
792
  */
793
793
  s3Configuration?: S3SourceConfiguration;
794
794
  /**
795
- * @public
796
795
  * <p>The source configuration IoT SiteWise configuration.</p>
796
+ * @public
797
797
  */
798
798
  iotSiteWiseConfiguration?: IotSiteWiseSourceConfiguration;
799
799
  /**
800
- * @public
801
800
  * <p>The source configuration IoT TwinMaker configuration.</p>
801
+ * @public
802
802
  */
803
803
  iotTwinMakerConfiguration?: IotTwinMakerSourceConfiguration;
804
804
  }
@@ -807,23 +807,23 @@ export interface SourceConfiguration {
807
807
  */
808
808
  export interface CreateMetadataTransferJobRequest {
809
809
  /**
810
- * @public
811
810
  * <p>The metadata transfer job Id.</p>
811
+ * @public
812
812
  */
813
813
  metadataTransferJobId?: string;
814
814
  /**
815
- * @public
816
815
  * <p>The metadata transfer job description.</p>
816
+ * @public
817
817
  */
818
818
  description?: string;
819
819
  /**
820
- * @public
821
820
  * <p>The metadata transfer job sources.</p>
821
+ * @public
822
822
  */
823
823
  sources: SourceConfiguration[] | undefined;
824
824
  /**
825
- * @public
826
825
  * <p>The metadata transfer job destination.</p>
826
+ * @public
827
827
  */
828
828
  destination: DestinationConfiguration | undefined;
829
829
  }
@@ -832,23 +832,23 @@ export interface CreateMetadataTransferJobRequest {
832
832
  */
833
833
  export interface CreateMetadataTransferJobResponse {
834
834
  /**
835
- * @public
836
835
  * <p>The metadata transfer job Id.</p>
836
+ * @public
837
837
  */
838
838
  metadataTransferJobId: string | undefined;
839
839
  /**
840
- * @public
841
840
  * <p>The metadata transfer job ARN.</p>
841
+ * @public
842
842
  */
843
843
  arn: string | undefined;
844
844
  /**
845
- * @public
846
845
  * <p>The The metadata transfer job creation DateTime property.</p>
846
+ * @public
847
847
  */
848
848
  creationDateTime: Date | undefined;
849
849
  /**
850
- * @public
851
850
  * <p>The metadata transfer job response status.</p>
851
+ * @public
852
852
  */
853
853
  status: MetadataTransferJobStatus | undefined;
854
854
  }
@@ -857,38 +857,38 @@ export interface CreateMetadataTransferJobResponse {
857
857
  */
858
858
  export interface CreateSceneRequest {
859
859
  /**
860
- * @public
861
860
  * <p>The ID of the workspace that contains the scene.</p>
861
+ * @public
862
862
  */
863
863
  workspaceId: string | undefined;
864
864
  /**
865
- * @public
866
865
  * <p>The ID of the scene.</p>
866
+ * @public
867
867
  */
868
868
  sceneId: string | undefined;
869
869
  /**
870
- * @public
871
870
  * <p>The relative path that specifies the location of the content definition file.</p>
871
+ * @public
872
872
  */
873
873
  contentLocation: string | undefined;
874
874
  /**
875
- * @public
876
875
  * <p>The description for this scene.</p>
876
+ * @public
877
877
  */
878
878
  description?: string;
879
879
  /**
880
- * @public
881
880
  * <p>A list of capabilities that the scene uses to render itself.</p>
881
+ * @public
882
882
  */
883
883
  capabilities?: string[];
884
884
  /**
885
- * @public
886
885
  * <p>Metadata that you can use to manage the scene.</p>
886
+ * @public
887
887
  */
888
888
  tags?: Record<string, string>;
889
889
  /**
890
- * @public
891
890
  * <p>The request metadata.</p>
891
+ * @public
892
892
  */
893
893
  sceneMetadata?: Record<string, string>;
894
894
  }
@@ -897,13 +897,13 @@ export interface CreateSceneRequest {
897
897
  */
898
898
  export interface CreateSceneResponse {
899
899
  /**
900
- * @public
901
900
  * <p>The ARN of the scene.</p>
901
+ * @public
902
902
  */
903
903
  arn: string | undefined;
904
904
  /**
905
- * @public
906
905
  * <p>The date and time when the scene was created.</p>
906
+ * @public
907
907
  */
908
908
  creationDateTime: Date | undefined;
909
909
  }
@@ -912,27 +912,27 @@ export interface CreateSceneResponse {
912
912
  */
913
913
  export interface CreateSyncJobRequest {
914
914
  /**
915
- * @public
916
915
  * <p>The workspace ID.</p>
916
+ * @public
917
917
  */
918
918
  workspaceId: string | undefined;
919
919
  /**
920
- * @public
921
920
  * <p>The sync source.</p>
922
921
  * <note>
923
922
  * <p>Currently the only supported syncSoource is <code>SITEWISE </code>.</p>
924
923
  * </note>
924
+ * @public
925
925
  */
926
926
  syncSource: string | undefined;
927
927
  /**
928
- * @public
929
928
  * <p>The SyncJob IAM role. This IAM role is used by the SyncJob to read from the syncSource,
930
929
  * and create, update, or delete the corresponding resources.</p>
930
+ * @public
931
931
  */
932
932
  syncRole: string | undefined;
933
933
  /**
934
- * @public
935
934
  * <p>The SyncJob tags.</p>
935
+ * @public
936
936
  */
937
937
  tags?: Record<string, string>;
938
938
  }
@@ -956,18 +956,18 @@ export type SyncJobState = (typeof SyncJobState)[keyof typeof SyncJobState];
956
956
  */
957
957
  export interface CreateSyncJobResponse {
958
958
  /**
959
- * @public
960
959
  * <p>The SyncJob ARN.</p>
960
+ * @public
961
961
  */
962
962
  arn: string | undefined;
963
963
  /**
964
- * @public
965
964
  * <p>The date and time for the SyncJob creation.</p>
965
+ * @public
966
966
  */
967
967
  creationDateTime: Date | undefined;
968
968
  /**
969
- * @public
970
969
  * <p>The SyncJob response state.</p>
970
+ * @public
971
971
  */
972
972
  state: SyncJobState | undefined;
973
973
  }
@@ -976,29 +976,29 @@ export interface CreateSyncJobResponse {
976
976
  */
977
977
  export interface CreateWorkspaceRequest {
978
978
  /**
979
- * @public
980
979
  * <p>The ID of the workspace.</p>
980
+ * @public
981
981
  */
982
982
  workspaceId: string | undefined;
983
983
  /**
984
- * @public
985
984
  * <p>The description of the workspace.</p>
985
+ * @public
986
986
  */
987
987
  description?: string;
988
988
  /**
989
- * @public
990
989
  * <p>The ARN of the S3 bucket where resources associated with the workspace are
991
990
  * stored.</p>
991
+ * @public
992
992
  */
993
993
  s3Location?: string;
994
994
  /**
995
- * @public
996
995
  * <p>The ARN of the execution role associated with the workspace.</p>
996
+ * @public
997
997
  */
998
998
  role?: string;
999
999
  /**
1000
- * @public
1001
1000
  * <p>Metadata that you can use to manage the workspace</p>
1001
+ * @public
1002
1002
  */
1003
1003
  tags?: Record<string, string>;
1004
1004
  }
@@ -1007,13 +1007,13 @@ export interface CreateWorkspaceRequest {
1007
1007
  */
1008
1008
  export interface CreateWorkspaceResponse {
1009
1009
  /**
1010
- * @public
1011
1010
  * <p>The ARN of the workspace.</p>
1011
+ * @public
1012
1012
  */
1013
1013
  arn: string | undefined;
1014
1014
  /**
1015
- * @public
1016
1015
  * <p>The date and time when the workspace was created.</p>
1016
+ * @public
1017
1017
  */
1018
1018
  creationDateTime: Date | undefined;
1019
1019
  }
@@ -1022,13 +1022,13 @@ export interface CreateWorkspaceResponse {
1022
1022
  */
1023
1023
  export interface DeleteComponentTypeRequest {
1024
1024
  /**
1025
- * @public
1026
1025
  * <p>The ID of the workspace that contains the component type.</p>
1026
+ * @public
1027
1027
  */
1028
1028
  workspaceId: string | undefined;
1029
1029
  /**
1030
- * @public
1031
1030
  * <p>The ID of the component type to delete.</p>
1031
+ * @public
1032
1032
  */
1033
1033
  componentTypeId: string | undefined;
1034
1034
  }
@@ -1037,8 +1037,8 @@ export interface DeleteComponentTypeRequest {
1037
1037
  */
1038
1038
  export interface DeleteComponentTypeResponse {
1039
1039
  /**
1040
- * @public
1041
1040
  * <p>The current state of the component type to be deleted.</p>
1041
+ * @public
1042
1042
  */
1043
1043
  state: State | undefined;
1044
1044
  }
@@ -1047,18 +1047,18 @@ export interface DeleteComponentTypeResponse {
1047
1047
  */
1048
1048
  export interface DeleteEntityRequest {
1049
1049
  /**
1050
- * @public
1051
1050
  * <p>The ID of the workspace that contains the entity to delete.</p>
1051
+ * @public
1052
1052
  */
1053
1053
  workspaceId: string | undefined;
1054
1054
  /**
1055
- * @public
1056
1055
  * <p>The ID of the entity to delete.</p>
1056
+ * @public
1057
1057
  */
1058
1058
  entityId: string | undefined;
1059
1059
  /**
1060
- * @public
1061
1060
  * <p>A Boolean value that specifies whether the operation deletes child entities.</p>
1061
+ * @public
1062
1062
  */
1063
1063
  isRecursive?: boolean;
1064
1064
  }
@@ -1067,8 +1067,8 @@ export interface DeleteEntityRequest {
1067
1067
  */
1068
1068
  export interface DeleteEntityResponse {
1069
1069
  /**
1070
- * @public
1071
1070
  * <p>The current state of the deleted entity.</p>
1071
+ * @public
1072
1072
  */
1073
1073
  state: State | undefined;
1074
1074
  }
@@ -1077,13 +1077,13 @@ export interface DeleteEntityResponse {
1077
1077
  */
1078
1078
  export interface DeleteSceneRequest {
1079
1079
  /**
1080
- * @public
1081
1080
  * <p>The ID of the workspace.</p>
1081
+ * @public
1082
1082
  */
1083
1083
  workspaceId: string | undefined;
1084
1084
  /**
1085
- * @public
1086
1085
  * <p>The ID of the scene to delete.</p>
1086
+ * @public
1087
1087
  */
1088
1088
  sceneId: string | undefined;
1089
1089
  }
@@ -1097,16 +1097,16 @@ export interface DeleteSceneResponse {
1097
1097
  */
1098
1098
  export interface DeleteSyncJobRequest {
1099
1099
  /**
1100
- * @public
1101
1100
  * <p>The workspace ID.</p>
1101
+ * @public
1102
1102
  */
1103
1103
  workspaceId: string | undefined;
1104
1104
  /**
1105
- * @public
1106
1105
  * <p>The sync source.</p>
1107
1106
  * <note>
1108
1107
  * <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p>
1109
1108
  * </note>
1109
+ * @public
1110
1110
  */
1111
1111
  syncSource: string | undefined;
1112
1112
  }
@@ -1115,8 +1115,8 @@ export interface DeleteSyncJobRequest {
1115
1115
  */
1116
1116
  export interface DeleteSyncJobResponse {
1117
1117
  /**
1118
- * @public
1119
1118
  * <p>The SyncJob response state.</p>
1119
+ * @public
1120
1120
  */
1121
1121
  state: SyncJobState | undefined;
1122
1122
  }
@@ -1125,8 +1125,8 @@ export interface DeleteSyncJobResponse {
1125
1125
  */
1126
1126
  export interface DeleteWorkspaceRequest {
1127
1127
  /**
1128
- * @public
1129
1128
  * <p>The ID of the workspace to delete.</p>
1129
+ * @public
1130
1130
  */
1131
1131
  workspaceId: string | undefined;
1132
1132
  }
@@ -1135,8 +1135,8 @@ export interface DeleteWorkspaceRequest {
1135
1135
  */
1136
1136
  export interface DeleteWorkspaceResponse {
1137
1137
  /**
1138
- * @public
1139
1138
  * <p>The string that specifies the delete result for the workspace.</p>
1139
+ * @public
1140
1140
  */
1141
1141
  message?: string;
1142
1142
  }
@@ -1145,23 +1145,23 @@ export interface DeleteWorkspaceResponse {
1145
1145
  */
1146
1146
  export interface ExecuteQueryRequest {
1147
1147
  /**
1148
- * @public
1149
1148
  * <p>The ID of the workspace.</p>
1149
+ * @public
1150
1150
  */
1151
1151
  workspaceId: string | undefined;
1152
1152
  /**
1153
- * @public
1154
1153
  * <p>The query statement.</p>
1154
+ * @public
1155
1155
  */
1156
1156
  queryStatement: string | undefined;
1157
1157
  /**
1158
- * @public
1159
1158
  * <p>The maximum number of results to return at one time. The default is 50.</p>
1159
+ * @public
1160
1160
  */
1161
1161
  maxResults?: number;
1162
1162
  /**
1163
- * @public
1164
1163
  * <p>The string that specifies the next page of results.</p>
1164
+ * @public
1165
1165
  */
1166
1166
  nextToken?: string;
1167
1167
  }
@@ -1179,29 +1179,29 @@ export declare const ColumnType: {
1179
1179
  */
1180
1180
  export type ColumnType = (typeof ColumnType)[keyof typeof ColumnType];
1181
1181
  /**
1182
- * @public
1183
1182
  * <p>A description of the column in the query results.</p>
1183
+ * @public
1184
1184
  */
1185
1185
  export interface ColumnDescription {
1186
1186
  /**
1187
- * @public
1188
1187
  * <p>The name of the column description.</p>
1188
+ * @public
1189
1189
  */
1190
1190
  name?: string;
1191
1191
  /**
1192
- * @public
1193
1192
  * <p>The type of the column description.</p>
1193
+ * @public
1194
1194
  */
1195
1195
  type?: ColumnType;
1196
1196
  }
1197
1197
  /**
1198
- * @public
1199
1198
  * <p>Represents a single row in the query results.</p>
1199
+ * @public
1200
1200
  */
1201
1201
  export interface Row {
1202
1202
  /**
1203
- * @public
1204
1203
  * <p>The data in a row of query results.</p>
1204
+ * @public
1205
1205
  */
1206
1206
  rowData?: __DocumentType[];
1207
1207
  }
@@ -1210,24 +1210,24 @@ export interface Row {
1210
1210
  */
1211
1211
  export interface ExecuteQueryResponse {
1212
1212
  /**
1213
- * @public
1214
1213
  * <p>A list of ColumnDescription objects.</p>
1214
+ * @public
1215
1215
  */
1216
1216
  columnDescriptions?: ColumnDescription[];
1217
1217
  /**
1218
- * @public
1219
1218
  * <p>Represents a single row in the query results.</p>
1219
+ * @public
1220
1220
  */
1221
1221
  rows?: Row[];
1222
1222
  /**
1223
- * @public
1224
1223
  * <p>The string that specifies the next page of results.</p>
1224
+ * @public
1225
1225
  */
1226
1226
  nextToken?: string;
1227
1227
  }
1228
1228
  /**
1229
- * @public
1230
1229
  * <p>The query timeout exception.</p>
1230
+ * @public
1231
1231
  */
1232
1232
  export declare class QueryTimeoutException extends __BaseException {
1233
1233
  readonly name: "QueryTimeoutException";
@@ -1243,94 +1243,94 @@ export declare class QueryTimeoutException extends __BaseException {
1243
1243
  */
1244
1244
  export interface GetComponentTypeRequest {
1245
1245
  /**
1246
- * @public
1247
1246
  * <p>The ID of the workspace that contains the component type.</p>
1247
+ * @public
1248
1248
  */
1249
1249
  workspaceId: string | undefined;
1250
1250
  /**
1251
- * @public
1252
1251
  * <p>The ID of the component type.</p>
1252
+ * @public
1253
1253
  */
1254
1254
  componentTypeId: string | undefined;
1255
1255
  }
1256
1256
  /**
1257
- * @public
1258
1257
  * <p>An object that returns information about the composite component types of a component type.</p>
1258
+ * @public
1259
1259
  */
1260
1260
  export interface CompositeComponentTypeResponse {
1261
1261
  /**
1262
- * @public
1263
1262
  * <p>This is the <code>componentTypeId</code> that this <code>compositeComponentType</code> refers to.</p>
1263
+ * @public
1264
1264
  */
1265
1265
  componentTypeId?: string;
1266
1266
  /**
1267
- * @public
1268
1267
  * <p>This boolean indicates whether this <code>compositeComponentType</code> is inherited from its parent.</p>
1268
+ * @public
1269
1269
  */
1270
1270
  isInherited?: boolean;
1271
1271
  }
1272
1272
  /**
1273
- * @public
1274
1273
  * <p>The function response.</p>
1274
+ * @public
1275
1275
  */
1276
1276
  export interface FunctionResponse {
1277
1277
  /**
1278
- * @public
1279
1278
  * <p>The required properties of the function.</p>
1279
+ * @public
1280
1280
  */
1281
1281
  requiredProperties?: string[];
1282
1282
  /**
1283
- * @public
1284
1283
  * <p>The scope of the function.</p>
1284
+ * @public
1285
1285
  */
1286
1286
  scope?: Scope;
1287
1287
  /**
1288
- * @public
1289
1288
  * <p>The data connector.</p>
1289
+ * @public
1290
1290
  */
1291
1291
  implementedBy?: DataConnector;
1292
1292
  /**
1293
- * @public
1294
1293
  * <p>Indicates whether this function is inherited.</p>
1294
+ * @public
1295
1295
  */
1296
1296
  isInherited?: boolean;
1297
1297
  }
1298
1298
  /**
1299
- * @public
1300
1299
  * <p>The property group response</p>
1300
+ * @public
1301
1301
  */
1302
1302
  export interface PropertyGroupResponse {
1303
1303
  /**
1304
- * @public
1305
1304
  * <p>The group types.</p>
1305
+ * @public
1306
1306
  */
1307
1307
  groupType: GroupType | undefined;
1308
1308
  /**
1309
- * @public
1310
1309
  * <p>The names of properties.</p>
1310
+ * @public
1311
1311
  */
1312
1312
  propertyNames: string[] | undefined;
1313
1313
  /**
1314
- * @public
1315
1314
  * <p>A Boolean value that specifies whether the property group is inherited from a parent
1316
1315
  * entity</p>
1316
+ * @public
1317
1317
  */
1318
1318
  isInherited: boolean | undefined;
1319
1319
  }
1320
1320
  /**
1321
- * @public
1322
1321
  * <p>An object that represents the status of an entity, component, component type, or
1323
1322
  * workspace.</p>
1323
+ * @public
1324
1324
  */
1325
1325
  export interface Status {
1326
1326
  /**
1327
- * @public
1328
1327
  * <p>The current state of the entity, component, component type, or workspace.</p>
1328
+ * @public
1329
1329
  */
1330
1330
  state?: State;
1331
1331
  /**
1332
- * @public
1333
1332
  * <p>The error message.</p>
1333
+ * @public
1334
1334
  */
1335
1335
  error?: ErrorDetails;
1336
1336
  }
@@ -1339,81 +1339,81 @@ export interface Status {
1339
1339
  */
1340
1340
  export interface GetEntityRequest {
1341
1341
  /**
1342
- * @public
1343
1342
  * <p>The ID of the workspace.</p>
1343
+ * @public
1344
1344
  */
1345
1345
  workspaceId: string | undefined;
1346
1346
  /**
1347
- * @public
1348
1347
  * <p>The ID of the entity.</p>
1348
+ * @public
1349
1349
  */
1350
1350
  entityId: string | undefined;
1351
1351
  }
1352
1352
  /**
1353
- * @public
1354
1353
  * <p>The component property group response.</p>
1354
+ * @public
1355
1355
  */
1356
1356
  export interface ComponentPropertyGroupResponse {
1357
1357
  /**
1358
- * @public
1359
1358
  * <p>The group type.</p>
1359
+ * @public
1360
1360
  */
1361
1361
  groupType: GroupType | undefined;
1362
1362
  /**
1363
- * @public
1364
1363
  * <p>The names of properties</p>
1364
+ * @public
1365
1365
  */
1366
1366
  propertyNames: string[] | undefined;
1367
1367
  /**
1368
- * @public
1369
1368
  * <p>A Boolean value that specifies whether the property group is inherited from a parent
1370
1369
  * entity</p>
1370
+ * @public
1371
1371
  */
1372
1372
  isInherited: boolean | undefined;
1373
1373
  }
1374
1374
  /**
1375
- * @public
1376
1375
  * <p>An object that returns information about a component summary.</p>
1376
+ * @public
1377
1377
  */
1378
1378
  export interface ComponentSummary {
1379
1379
  /**
1380
- * @public
1381
1380
  * <p>The name of the component.</p>
1381
+ * @public
1382
1382
  */
1383
1383
  componentName: string | undefined;
1384
1384
  /**
1385
- * @public
1386
1385
  * <p>The ID of the component type.</p>
1386
+ * @public
1387
1387
  */
1388
1388
  componentTypeId: string | undefined;
1389
1389
  /**
1390
- * @public
1391
1390
  * <p>The name of the property definition set in the request.</p>
1391
+ * @public
1392
1392
  */
1393
1393
  definedIn?: string;
1394
1394
  /**
1395
- * @public
1396
1395
  * <p>The description of the component request.</p>
1396
+ * @public
1397
1397
  */
1398
1398
  description?: string;
1399
1399
  /**
1400
- * @public
1401
1400
  * <p>The property groups.</p>
1401
+ * @public
1402
1402
  */
1403
1403
  propertyGroups?: Record<string, ComponentPropertyGroupResponse>;
1404
1404
  /**
1405
- * @public
1406
1405
  * <p>The status of the component type.</p>
1406
+ * @public
1407
1407
  */
1408
1408
  status: Status | undefined;
1409
1409
  /**
1410
- * @public
1411
1410
  * <p>The <code>syncSource</code> of the sync job, if this entity was created by a sync job.</p>
1411
+ * @public
1412
1412
  */
1413
1413
  syncSource?: string;
1414
1414
  /**
1415
- * @public
1416
1415
  * <p>This string specifies the path to the composite component, starting from the top-level component.</p>
1416
+ * @public
1417
1417
  */
1418
1418
  componentPath?: string;
1419
1419
  }
@@ -1422,8 +1422,8 @@ export interface ComponentSummary {
1422
1422
  */
1423
1423
  export interface GetMetadataTransferJobRequest {
1424
1424
  /**
1425
- * @public
1426
1425
  * <p>The metadata transfer job Id.</p>
1426
+ * @public
1427
1427
  */
1428
1428
  metadataTransferJobId: string | undefined;
1429
1429
  }
@@ -1432,58 +1432,58 @@ export interface GetMetadataTransferJobRequest {
1432
1432
  */
1433
1433
  export interface GetMetadataTransferJobResponse {
1434
1434
  /**
1435
- * @public
1436
1435
  * <p>The metadata transfer job Id.</p>
1436
+ * @public
1437
1437
  */
1438
1438
  metadataTransferJobId: string | undefined;
1439
1439
  /**
1440
- * @public
1441
1440
  * <p>The metadata transfer job ARN.</p>
1441
+ * @public
1442
1442
  */
1443
1443
  arn: string | undefined;
1444
1444
  /**
1445
- * @public
1446
1445
  * <p>The metadata transfer job description.</p>
1446
+ * @public
1447
1447
  */
1448
1448
  description?: string;
1449
1449
  /**
1450
- * @public
1451
1450
  * <p>The metadata transfer job's sources.</p>
1451
+ * @public
1452
1452
  */
1453
1453
  sources: SourceConfiguration[] | undefined;
1454
1454
  /**
1455
- * @public
1456
1455
  * <p>The metadata transfer job's destination.</p>
1456
+ * @public
1457
1457
  */
1458
1458
  destination: DestinationConfiguration | undefined;
1459
1459
  /**
1460
- * @public
1461
1460
  * <p>The metadata transfer job's role.</p>
1461
+ * @public
1462
1462
  */
1463
1463
  metadataTransferJobRole: string | undefined;
1464
1464
  /**
1465
- * @public
1466
1465
  * <p>The metadata transfer job's report URL.</p>
1466
+ * @public
1467
1467
  */
1468
1468
  reportUrl?: string;
1469
1469
  /**
1470
- * @public
1471
1470
  * <p>The metadata transfer job's creation DateTime property.</p>
1471
+ * @public
1472
1472
  */
1473
1473
  creationDateTime: Date | undefined;
1474
1474
  /**
1475
- * @public
1476
1475
  * <p>The metadata transfer job's update DateTime property.</p>
1476
+ * @public
1477
1477
  */
1478
1478
  updateDateTime: Date | undefined;
1479
1479
  /**
1480
- * @public
1481
1480
  * <p>The metadata transfer job's status.</p>
1481
+ * @public
1482
1482
  */
1483
1483
  status: MetadataTransferJobStatus | undefined;
1484
1484
  /**
1485
- * @public
1486
1485
  * <p>The metadata transfer job's progress.</p>
1486
+ * @public
1487
1487
  */
1488
1488
  progress?: MetadataTransferJobProgress;
1489
1489
  }
@@ -1507,18 +1507,18 @@ export declare const PricingTier: {
1507
1507
  */
1508
1508
  export type PricingTier = (typeof PricingTier)[keyof typeof PricingTier];
1509
1509
  /**
1510
- * @public
1511
1510
  * <p>Information about the pricing bundle.</p>
1511
+ * @public
1512
1512
  */
1513
1513
  export interface BundleInformation {
1514
1514
  /**
1515
- * @public
1516
1515
  * <p>The bundle names.</p>
1516
+ * @public
1517
1517
  */
1518
1518
  bundleNames: string[] | undefined;
1519
1519
  /**
1520
- * @public
1521
1520
  * <p>The pricing tier.</p>
1521
+ * @public
1522
1522
  */
1523
1523
  pricingTier?: PricingTier;
1524
1524
  }
@@ -1551,38 +1551,38 @@ export declare const UpdateReason: {
1551
1551
  */
1552
1552
  export type UpdateReason = (typeof UpdateReason)[keyof typeof UpdateReason];
1553
1553
  /**
1554
- * @public
1555
1554
  * <p>The pricing plan.</p>
1555
+ * @public
1556
1556
  */
1557
1557
  export interface PricingPlan {
1558
1558
  /**
1559
- * @public
1560
1559
  * <p>The billable entity count.</p>
1560
+ * @public
1561
1561
  */
1562
1562
  billableEntityCount?: number;
1563
1563
  /**
1564
- * @public
1565
1564
  * <p>The pricing plan's bundle information.</p>
1565
+ * @public
1566
1566
  */
1567
1567
  bundleInformation?: BundleInformation;
1568
1568
  /**
1569
- * @public
1570
1569
  * <p>The effective date and time of the pricing plan.</p>
1570
+ * @public
1571
1571
  */
1572
1572
  effectiveDateTime: Date | undefined;
1573
1573
  /**
1574
- * @public
1575
1574
  * <p>The pricing mode.</p>
1575
+ * @public
1576
1576
  */
1577
1577
  pricingMode: PricingMode | undefined;
1578
1578
  /**
1579
- * @public
1580
1579
  * <p>The set date and time for updating a pricing plan.</p>
1580
+ * @public
1581
1581
  */
1582
1582
  updateDateTime: Date | undefined;
1583
1583
  /**
1584
- * @public
1585
1584
  * <p>The update reason for changing a pricing plan.</p>
1585
+ * @public
1586
1586
  */
1587
1587
  updateReason: UpdateReason | undefined;
1588
1588
  }
@@ -1591,19 +1591,19 @@ export interface PricingPlan {
1591
1591
  */
1592
1592
  export interface GetPricingPlanResponse {
1593
1593
  /**
1594
- * @public
1595
1594
  * <p>The chosen pricing plan for the current billing cycle.</p>
1595
+ * @public
1596
1596
  */
1597
1597
  currentPricingPlan: PricingPlan | undefined;
1598
1598
  /**
1599
- * @public
1600
1599
  * <p>The pending pricing plan.</p>
1600
+ * @public
1601
1601
  */
1602
1602
  pendingPricingPlan?: PricingPlan;
1603
1603
  }
1604
1604
  /**
1605
- * @public
1606
1605
  * <p>The connector failed.</p>
1606
+ * @public
1607
1607
  */
1608
1608
  export declare class ConnectorFailureException extends __BaseException {
1609
1609
  readonly name: "ConnectorFailureException";
@@ -1614,8 +1614,8 @@ export declare class ConnectorFailureException extends __BaseException {
1614
1614
  constructor(opts: __ExceptionOptionType<ConnectorFailureException, __BaseException>);
1615
1615
  }
1616
1616
  /**
1617
- * @public
1618
1617
  * <p>The connector timed out.</p>
1618
+ * @public
1619
1619
  */
1620
1620
  export declare class ConnectorTimeoutException extends __BaseException {
1621
1621
  readonly name: "ConnectorTimeoutException";
@@ -1638,19 +1638,19 @@ export declare const Order: {
1638
1638
  */
1639
1639
  export type Order = (typeof Order)[keyof typeof Order];
1640
1640
  /**
1641
- * @public
1642
1641
  * <p>Filter criteria that orders the return output. It can be sorted in ascending or
1643
1642
  * descending order.</p>
1643
+ * @public
1644
1644
  */
1645
1645
  export interface OrderBy {
1646
1646
  /**
1647
- * @public
1648
1647
  * <p>The set order that filters results.</p>
1648
+ * @public
1649
1649
  */
1650
1650
  order?: Order;
1651
1651
  /**
1652
- * @public
1653
1652
  * <p>The property name.</p>
1653
+ * @public
1654
1654
  */
1655
1655
  propertyName: string | undefined;
1656
1656
  }
@@ -1666,18 +1666,18 @@ export declare const InterpolationType: {
1666
1666
  */
1667
1667
  export type InterpolationType = (typeof InterpolationType)[keyof typeof InterpolationType];
1668
1668
  /**
1669
- * @public
1670
1669
  * <p>An object that specifies how to interpolate data in a list.</p>
1670
+ * @public
1671
1671
  */
1672
1672
  export interface InterpolationParameters {
1673
1673
  /**
1674
- * @public
1675
1674
  * <p>The interpolation type.</p>
1675
+ * @public
1676
1676
  */
1677
1677
  interpolationType?: InterpolationType;
1678
1678
  /**
1679
- * @public
1680
1679
  * <p>The interpolation time interval in seconds.</p>
1680
+ * @public
1681
1681
  */
1682
1682
  intervalInSeconds?: number;
1683
1683
  }
@@ -1698,13 +1698,13 @@ export type OrderByTime = (typeof OrderByTime)[keyof typeof OrderByTime];
1698
1698
  */
1699
1699
  export interface GetSceneRequest {
1700
1700
  /**
1701
- * @public
1702
1701
  * <p>The ID of the workspace that contains the scene.</p>
1702
+ * @public
1703
1703
  */
1704
1704
  workspaceId: string | undefined;
1705
1705
  /**
1706
- * @public
1707
1706
  * <p>The ID of the scene.</p>
1707
+ * @public
1708
1708
  */
1709
1709
  sceneId: string | undefined;
1710
1710
  }
@@ -1720,18 +1720,18 @@ export declare const SceneErrorCode: {
1720
1720
  */
1721
1721
  export type SceneErrorCode = (typeof SceneErrorCode)[keyof typeof SceneErrorCode];
1722
1722
  /**
1723
- * @public
1724
1723
  * <p>The scene error.</p>
1724
+ * @public
1725
1725
  */
1726
1726
  export interface SceneError {
1727
1727
  /**
1728
- * @public
1729
1728
  * <p>The SceneError code.</p>
1729
+ * @public
1730
1730
  */
1731
1731
  code?: SceneErrorCode;
1732
1732
  /**
1733
- * @public
1734
1733
  * <p>The SceneError message.</p>
1734
+ * @public
1735
1735
  */
1736
1736
  message?: string;
1737
1737
  }
@@ -1740,58 +1740,58 @@ export interface SceneError {
1740
1740
  */
1741
1741
  export interface GetSceneResponse {
1742
1742
  /**
1743
- * @public
1744
1743
  * <p>The ID of the workspace that contains the scene.</p>
1744
+ * @public
1745
1745
  */
1746
1746
  workspaceId: string | undefined;
1747
1747
  /**
1748
- * @public
1749
1748
  * <p>The ID of the scene.</p>
1749
+ * @public
1750
1750
  */
1751
1751
  sceneId: string | undefined;
1752
1752
  /**
1753
- * @public
1754
1753
  * <p>The relative path that specifies the location of the content definition file.</p>
1754
+ * @public
1755
1755
  */
1756
1756
  contentLocation: string | undefined;
1757
1757
  /**
1758
- * @public
1759
1758
  * <p>The ARN of the scene.</p>
1759
+ * @public
1760
1760
  */
1761
1761
  arn: string | undefined;
1762
1762
  /**
1763
- * @public
1764
1763
  * <p>The date and time when the scene was created.</p>
1764
+ * @public
1765
1765
  */
1766
1766
  creationDateTime: Date | undefined;
1767
1767
  /**
1768
- * @public
1769
1768
  * <p>The date and time when the scene was last updated.</p>
1769
+ * @public
1770
1770
  */
1771
1771
  updateDateTime: Date | undefined;
1772
1772
  /**
1773
- * @public
1774
1773
  * <p>The description of the scene.</p>
1774
+ * @public
1775
1775
  */
1776
1776
  description?: string;
1777
1777
  /**
1778
- * @public
1779
1778
  * <p>A list of capabilities that the scene uses to render.</p>
1779
+ * @public
1780
1780
  */
1781
1781
  capabilities?: string[];
1782
1782
  /**
1783
- * @public
1784
1783
  * <p>The response metadata.</p>
1784
+ * @public
1785
1785
  */
1786
1786
  sceneMetadata?: Record<string, string>;
1787
1787
  /**
1788
- * @public
1789
1788
  * <p>The generated scene metadata.</p>
1789
+ * @public
1790
1790
  */
1791
1791
  generatedSceneMetadata?: Record<string, string>;
1792
1792
  /**
1793
- * @public
1794
1793
  * <p>The SceneResponse error.</p>
1794
+ * @public
1795
1795
  */
1796
1796
  error?: SceneError;
1797
1797
  }
@@ -1800,32 +1800,32 @@ export interface GetSceneResponse {
1800
1800
  */
1801
1801
  export interface GetSyncJobRequest {
1802
1802
  /**
1803
- * @public
1804
1803
  * <p>The sync source.</p>
1805
1804
  * <note>
1806
1805
  * <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p>
1807
1806
  * </note>
1807
+ * @public
1808
1808
  */
1809
1809
  syncSource: string | undefined;
1810
1810
  /**
1811
- * @public
1812
1811
  * <p>The workspace ID.</p>
1812
+ * @public
1813
1813
  */
1814
1814
  workspaceId?: string;
1815
1815
  }
1816
1816
  /**
1817
- * @public
1818
1817
  * <p>The SyncJob status.</p>
1818
+ * @public
1819
1819
  */
1820
1820
  export interface SyncJobStatus {
1821
1821
  /**
1822
- * @public
1823
1822
  * <p>The SyncJob status state.</p>
1823
+ * @public
1824
1824
  */
1825
1825
  state?: SyncJobState;
1826
1826
  /**
1827
- * @public
1828
1827
  * <p>The SyncJob error.</p>
1828
+ * @public
1829
1829
  */
1830
1830
  error?: ErrorDetails;
1831
1831
  }
@@ -1834,41 +1834,41 @@ export interface SyncJobStatus {
1834
1834
  */
1835
1835
  export interface GetSyncJobResponse {
1836
1836
  /**
1837
- * @public
1838
1837
  * <p>The sync job ARN.</p>
1838
+ * @public
1839
1839
  */
1840
1840
  arn: string | undefined;
1841
1841
  /**
1842
- * @public
1843
1842
  * <p>The ID of the workspace that contains the sync job.</p>
1843
+ * @public
1844
1844
  */
1845
1845
  workspaceId: string | undefined;
1846
1846
  /**
1847
- * @public
1848
1847
  * <p>The sync soucre.</p>
1849
1848
  * <note>
1850
1849
  * <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p>
1851
1850
  * </note>
1851
+ * @public
1852
1852
  */
1853
1853
  syncSource: string | undefined;
1854
1854
  /**
1855
- * @public
1856
1855
  * <p>The sync IAM role.</p>
1856
+ * @public
1857
1857
  */
1858
1858
  syncRole: string | undefined;
1859
1859
  /**
1860
- * @public
1861
1860
  * <p>The SyncJob response status.</p>
1861
+ * @public
1862
1862
  */
1863
1863
  status: SyncJobStatus | undefined;
1864
1864
  /**
1865
- * @public
1866
1865
  * <p>The creation date and time.</p>
1866
+ * @public
1867
1867
  */
1868
1868
  creationDateTime: Date | undefined;
1869
1869
  /**
1870
- * @public
1871
1870
  * <p>The update date and time.</p>
1871
+ * @public
1872
1872
  */
1873
1873
  updateDateTime: Date | undefined;
1874
1874
  }
@@ -1877,8 +1877,8 @@ export interface GetSyncJobResponse {
1877
1877
  */
1878
1878
  export interface GetWorkspaceRequest {
1879
1879
  /**
1880
- * @public
1881
1880
  * <p>The ID of the workspace.</p>
1881
+ * @public
1882
1882
  */
1883
1883
  workspaceId: string | undefined;
1884
1884
  }
@@ -1887,44 +1887,44 @@ export interface GetWorkspaceRequest {
1887
1887
  */
1888
1888
  export interface GetWorkspaceResponse {
1889
1889
  /**
1890
- * @public
1891
1890
  * <p>The ID of the workspace.</p>
1891
+ * @public
1892
1892
  */
1893
1893
  workspaceId: string | undefined;
1894
1894
  /**
1895
- * @public
1896
1895
  * <p>The ARN of the workspace.</p>
1896
+ * @public
1897
1897
  */
1898
1898
  arn: string | undefined;
1899
1899
  /**
1900
- * @public
1901
1900
  * <p>The description of the workspace.</p>
1901
+ * @public
1902
1902
  */
1903
1903
  description?: string;
1904
1904
  /**
1905
- * @public
1906
1905
  * <p>A list of services that are linked to the workspace.</p>
1906
+ * @public
1907
1907
  */
1908
1908
  linkedServices?: string[];
1909
1909
  /**
1910
- * @public
1911
1910
  * <p>The ARN of the S3 bucket where resources associated with the workspace are
1912
1911
  * stored.</p>
1912
+ * @public
1913
1913
  */
1914
1914
  s3Location?: string;
1915
1915
  /**
1916
- * @public
1917
1916
  * <p>The ARN of the execution role associated with the workspace.</p>
1917
+ * @public
1918
1918
  */
1919
1919
  role?: string;
1920
1920
  /**
1921
- * @public
1922
1921
  * <p>The date and time when the workspace was created.</p>
1922
+ * @public
1923
1923
  */
1924
1924
  creationDateTime: Date | undefined;
1925
1925
  /**
1926
- * @public
1927
1926
  * <p>The date and time when the workspace was last updated.</p>
1927
+ * @public
1928
1928
  */
1929
1929
  updateDateTime: Date | undefined;
1930
1930
  }
@@ -1933,28 +1933,28 @@ export interface GetWorkspaceResponse {
1933
1933
  */
1934
1934
  export interface ListComponentsRequest {
1935
1935
  /**
1936
- * @public
1937
1936
  * <p>The workspace ID.</p>
1937
+ * @public
1938
1938
  */
1939
1939
  workspaceId: string | undefined;
1940
1940
  /**
1941
- * @public
1942
1941
  * <p>The ID for the entity whose metadata (component/properties) is returned by the operation.</p>
1942
+ * @public
1943
1943
  */
1944
1944
  entityId: string | undefined;
1945
1945
  /**
1946
- * @public
1947
1946
  * <p>This string specifies the path to the composite component, starting from the top-level component.</p>
1947
+ * @public
1948
1948
  */
1949
1949
  componentPath?: string;
1950
1950
  /**
1951
- * @public
1952
1951
  * <p>The maximum number of results returned at one time. The default is 25.</p>
1952
+ * @public
1953
1953
  */
1954
1954
  maxResults?: number;
1955
1955
  /**
1956
- * @public
1957
1956
  * <p>The string that specifies the next page of results.</p>
1957
+ * @public
1958
1958
  */
1959
1959
  nextToken?: string;
1960
1960
  }
@@ -1963,22 +1963,22 @@ export interface ListComponentsRequest {
1963
1963
  */
1964
1964
  export interface ListComponentsResponse {
1965
1965
  /**
1966
- * @public
1967
1966
  * <p>A list of objects that contain information about the components.</p>
1967
+ * @public
1968
1968
  */
1969
1969
  componentSummaries: ComponentSummary[] | undefined;
1970
1970
  /**
1971
- * @public
1972
1971
  * <p>The string that specifies the next page of component results.</p>
1972
+ * @public
1973
1973
  */
1974
1974
  nextToken?: string;
1975
1975
  }
1976
1976
  /**
1977
- * @public
1978
1977
  * <p>An object that filters items in a list of component types.</p>
1979
1978
  * <note>
1980
1979
  * <p>Only one object is accepted as a valid input.</p>
1981
1980
  * </note>
1981
+ * @public
1982
1982
  */
1983
1983
  export type ListComponentTypesFilter = ListComponentTypesFilter.ExtendsFromMember | ListComponentTypesFilter.IsAbstractMember | ListComponentTypesFilter.NamespaceMember | ListComponentTypesFilter.$UnknownMember;
1984
1984
  /**
@@ -1986,8 +1986,8 @@ export type ListComponentTypesFilter = ListComponentTypesFilter.ExtendsFromMembe
1986
1986
  */
1987
1987
  export declare namespace ListComponentTypesFilter {
1988
1988
  /**
1989
- * @public
1990
1989
  * <p>The component type that the component types in the list extend.</p>
1990
+ * @public
1991
1991
  */
1992
1992
  interface ExtendsFromMember {
1993
1993
  extendsFrom: string;
@@ -1996,8 +1996,8 @@ export declare namespace ListComponentTypesFilter {
1996
1996
  $unknown?: never;
1997
1997
  }
1998
1998
  /**
1999
- * @public
2000
1999
  * <p>The namespace to which the component types in the list belong.</p>
2000
+ * @public
2001
2001
  */
2002
2002
  interface NamespaceMember {
2003
2003
  extendsFrom?: never;
@@ -2006,9 +2006,9 @@ export declare namespace ListComponentTypesFilter {
2006
2006
  $unknown?: never;
2007
2007
  }
2008
2008
  /**
2009
- * @public
2010
2009
  * <p>A Boolean value that specifies whether the component types in the list are
2011
2010
  * abstract.</p>
2011
+ * @public
2012
2012
  */
2013
2013
  interface IsAbstractMember {
2014
2014
  extendsFrom?: never;
@@ -2038,65 +2038,65 @@ export declare namespace ListComponentTypesFilter {
2038
2038
  */
2039
2039
  export interface ListComponentTypesRequest {
2040
2040
  /**
2041
- * @public
2042
2041
  * <p>The ID of the workspace.</p>
2042
+ * @public
2043
2043
  */
2044
2044
  workspaceId: string | undefined;
2045
2045
  /**
2046
- * @public
2047
2046
  * <p>A list of objects that filter the request.</p>
2047
+ * @public
2048
2048
  */
2049
2049
  filters?: ListComponentTypesFilter[];
2050
2050
  /**
2051
- * @public
2052
2051
  * <p>The string that specifies the next page of results.</p>
2052
+ * @public
2053
2053
  */
2054
2054
  nextToken?: string;
2055
2055
  /**
2056
- * @public
2057
2056
  * <p>The maximum number of results to return at one time. The default is 25.</p>
2058
2057
  * <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
2058
+ * @public
2059
2059
  */
2060
2060
  maxResults?: number;
2061
2061
  }
2062
2062
  /**
2063
- * @public
2064
2063
  * <p>An object that contains information about a component type.</p>
2064
+ * @public
2065
2065
  */
2066
2066
  export interface ComponentTypeSummary {
2067
2067
  /**
2068
- * @public
2069
2068
  * <p>The ARN of the component type.</p>
2069
+ * @public
2070
2070
  */
2071
2071
  arn: string | undefined;
2072
2072
  /**
2073
- * @public
2074
2073
  * <p>The ID of the component type.</p>
2074
+ * @public
2075
2075
  */
2076
2076
  componentTypeId: string | undefined;
2077
2077
  /**
2078
- * @public
2079
2078
  * <p>The date and time when the component type was created.</p>
2079
+ * @public
2080
2080
  */
2081
2081
  creationDateTime: Date | undefined;
2082
2082
  /**
2083
- * @public
2084
2083
  * <p>The date and time when the component type was last updated.</p>
2084
+ * @public
2085
2085
  */
2086
2086
  updateDateTime: Date | undefined;
2087
2087
  /**
2088
- * @public
2089
2088
  * <p>The description of the component type.</p>
2089
+ * @public
2090
2090
  */
2091
2091
  description?: string;
2092
2092
  /**
2093
- * @public
2094
2093
  * <p>The current status of the component type.</p>
2094
+ * @public
2095
2095
  */
2096
2096
  status?: Status;
2097
2097
  /**
2098
- * @public
2099
2098
  * <p>The component type name.</p>
2099
+ * @public
2100
2100
  */
2101
2101
  componentTypeName?: string;
2102
2102
  }
@@ -2105,29 +2105,29 @@ export interface ComponentTypeSummary {
2105
2105
  */
2106
2106
  export interface ListComponentTypesResponse {
2107
2107
  /**
2108
- * @public
2109
2108
  * <p>The ID of the workspace.</p>
2109
+ * @public
2110
2110
  */
2111
2111
  workspaceId: string | undefined;
2112
2112
  /**
2113
- * @public
2114
2113
  * <p>A list of objects that contain information about the component types.</p>
2114
+ * @public
2115
2115
  */
2116
2116
  componentTypeSummaries: ComponentTypeSummary[] | undefined;
2117
2117
  /**
2118
- * @public
2119
2118
  * <p>The string that specifies the next page of results.</p>
2119
+ * @public
2120
2120
  */
2121
2121
  nextToken?: string;
2122
2122
  /**
2123
- * @public
2124
2123
  * <p>Specifies the maximum number of results to display.</p>
2124
+ * @public
2125
2125
  */
2126
2126
  maxResults?: number;
2127
2127
  }
2128
2128
  /**
2129
- * @public
2130
2129
  * <p>An object that filters items in a list of entities.</p>
2130
+ * @public
2131
2131
  */
2132
2132
  export type ListEntitiesFilter = ListEntitiesFilter.ComponentTypeIdMember | ListEntitiesFilter.ExternalIdMember | ListEntitiesFilter.ParentEntityIdMember | ListEntitiesFilter.$UnknownMember;
2133
2133
  /**
@@ -2135,8 +2135,8 @@ export type ListEntitiesFilter = ListEntitiesFilter.ComponentTypeIdMember | List
2135
2135
  */
2136
2136
  export declare namespace ListEntitiesFilter {
2137
2137
  /**
2138
- * @public
2139
2138
  * <p>The parent of the entities in the list.</p>
2139
+ * @public
2140
2140
  */
2141
2141
  interface ParentEntityIdMember {
2142
2142
  parentEntityId: string;
@@ -2145,8 +2145,8 @@ export declare namespace ListEntitiesFilter {
2145
2145
  $unknown?: never;
2146
2146
  }
2147
2147
  /**
2148
- * @public
2149
2148
  * <p>The ID of the component type in the entities in the list.</p>
2149
+ * @public
2150
2150
  */
2151
2151
  interface ComponentTypeIdMember {
2152
2152
  parentEntityId?: never;
@@ -2155,9 +2155,9 @@ export declare namespace ListEntitiesFilter {
2155
2155
  $unknown?: never;
2156
2156
  }
2157
2157
  /**
2158
- * @public
2159
2158
  * <p>The external-Id property of a component. The external-Id property is the primary key of
2160
2159
  * an external storage system.</p>
2160
+ * @public
2161
2161
  */
2162
2162
  interface ExternalIdMember {
2163
2163
  parentEntityId?: never;
@@ -2187,78 +2187,78 @@ export declare namespace ListEntitiesFilter {
2187
2187
  */
2188
2188
  export interface ListEntitiesRequest {
2189
2189
  /**
2190
- * @public
2191
2190
  * <p>The ID of the workspace.</p>
2191
+ * @public
2192
2192
  */
2193
2193
  workspaceId: string | undefined;
2194
2194
  /**
2195
- * @public
2196
2195
  * <p>A list of objects that filter the request.</p>
2197
2196
  * <note>
2198
2197
  * <p>Only one object is accepted as a valid input.</p>
2199
2198
  * </note>
2199
+ * @public
2200
2200
  */
2201
2201
  filters?: ListEntitiesFilter[];
2202
2202
  /**
2203
- * @public
2204
2203
  * <p>The maximum number of results to return at one time. The default is 25.</p>
2205
2204
  * <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
2205
+ * @public
2206
2206
  */
2207
2207
  maxResults?: number;
2208
2208
  /**
2209
- * @public
2210
2209
  * <p>The string that specifies the next page of results.</p>
2210
+ * @public
2211
2211
  */
2212
2212
  nextToken?: string;
2213
2213
  }
2214
2214
  /**
2215
- * @public
2216
2215
  * <p>An object that contains information about an entity.</p>
2216
+ * @public
2217
2217
  */
2218
2218
  export interface EntitySummary {
2219
2219
  /**
2220
- * @public
2221
2220
  * <p>The ID of the entity.</p>
2221
+ * @public
2222
2222
  */
2223
2223
  entityId: string | undefined;
2224
2224
  /**
2225
- * @public
2226
2225
  * <p>The name of the entity.</p>
2226
+ * @public
2227
2227
  */
2228
2228
  entityName: string | undefined;
2229
2229
  /**
2230
- * @public
2231
2230
  * <p>The ARN of the entity.</p>
2231
+ * @public
2232
2232
  */
2233
2233
  arn: string | undefined;
2234
2234
  /**
2235
- * @public
2236
2235
  * <p>The ID of the parent entity.</p>
2236
+ * @public
2237
2237
  */
2238
2238
  parentEntityId?: string;
2239
2239
  /**
2240
- * @public
2241
2240
  * <p>The current status of the entity.</p>
2241
+ * @public
2242
2242
  */
2243
2243
  status: Status | undefined;
2244
2244
  /**
2245
- * @public
2246
2245
  * <p>The description of the entity.</p>
2246
+ * @public
2247
2247
  */
2248
2248
  description?: string;
2249
2249
  /**
2250
- * @public
2251
2250
  * <p>An <b>eventual</b> Boolean value that specifies whether the entity has child entities or not.</p>
2251
+ * @public
2252
2252
  */
2253
2253
  hasChildEntities?: boolean;
2254
2254
  /**
2255
- * @public
2256
2255
  * <p>The date and time when the entity was created.</p>
2256
+ * @public
2257
2257
  */
2258
2258
  creationDateTime: Date | undefined;
2259
2259
  /**
2260
- * @public
2261
2260
  * <p>The last date and time when the entity was updated.</p>
2261
+ * @public
2262
2262
  */
2263
2263
  updateDateTime: Date | undefined;
2264
2264
  }
@@ -2267,19 +2267,19 @@ export interface EntitySummary {
2267
2267
  */
2268
2268
  export interface ListEntitiesResponse {
2269
2269
  /**
2270
- * @public
2271
2270
  * <p>A list of objects that contain information about the entities.</p>
2271
+ * @public
2272
2272
  */
2273
2273
  entitySummaries?: EntitySummary[];
2274
2274
  /**
2275
- * @public
2276
2275
  * <p>The string that specifies the next page of results.</p>
2276
+ * @public
2277
2277
  */
2278
2278
  nextToken?: string;
2279
2279
  }
2280
2280
  /**
2281
- * @public
2282
2281
  * <p>The ListMetadataTransferJobs filter.</p>
2282
+ * @public
2283
2283
  */
2284
2284
  export type ListMetadataTransferJobsFilter = ListMetadataTransferJobsFilter.StateMember | ListMetadataTransferJobsFilter.WorkspaceIdMember | ListMetadataTransferJobsFilter.$UnknownMember;
2285
2285
  /**
@@ -2287,8 +2287,8 @@ export type ListMetadataTransferJobsFilter = ListMetadataTransferJobsFilter.Stat
2287
2287
  */
2288
2288
  export declare namespace ListMetadataTransferJobsFilter {
2289
2289
  /**
2290
- * @public
2291
2290
  * <p>The workspace Id.</p>
2291
+ * @public
2292
2292
  */
2293
2293
  interface WorkspaceIdMember {
2294
2294
  workspaceId: string;
@@ -2296,8 +2296,8 @@ export declare namespace ListMetadataTransferJobsFilter {
2296
2296
  $unknown?: never;
2297
2297
  }
2298
2298
  /**
2299
- * @public
2300
2299
  * <p>The filter state.</p>
2300
+ * @public
2301
2301
  */
2302
2302
  interface StateMember {
2303
2303
  workspaceId?: never;
@@ -2324,64 +2324,64 @@ export declare namespace ListMetadataTransferJobsFilter {
2324
2324
  */
2325
2325
  export interface ListMetadataTransferJobsRequest {
2326
2326
  /**
2327
- * @public
2328
2327
  * <p>The metadata transfer job's source type.</p>
2328
+ * @public
2329
2329
  */
2330
2330
  sourceType: SourceType | undefined;
2331
2331
  /**
2332
- * @public
2333
2332
  * <p>The metadata transfer job's destination type.</p>
2333
+ * @public
2334
2334
  */
2335
2335
  destinationType: DestinationType | undefined;
2336
2336
  /**
2337
- * @public
2338
2337
  * <p>An object that filters metadata transfer jobs.</p>
2338
+ * @public
2339
2339
  */
2340
2340
  filters?: ListMetadataTransferJobsFilter[];
2341
2341
  /**
2342
- * @public
2343
2342
  * <p>The string that specifies the next page of results.</p>
2343
+ * @public
2344
2344
  */
2345
2345
  nextToken?: string;
2346
2346
  /**
2347
- * @public
2348
2347
  * <p>The maximum number of results to return at one time.</p>
2348
+ * @public
2349
2349
  */
2350
2350
  maxResults?: number;
2351
2351
  }
2352
2352
  /**
2353
- * @public
2354
2353
  * <p>The metadata transfer job summary.</p>
2354
+ * @public
2355
2355
  */
2356
2356
  export interface MetadataTransferJobSummary {
2357
2357
  /**
2358
- * @public
2359
2358
  * <p>The metadata transfer job summary Id.</p>
2359
+ * @public
2360
2360
  */
2361
2361
  metadataTransferJobId: string | undefined;
2362
2362
  /**
2363
- * @public
2364
2363
  * <p>The metadata transfer job summary ARN.</p>
2364
+ * @public
2365
2365
  */
2366
2366
  arn: string | undefined;
2367
2367
  /**
2368
- * @public
2369
2368
  * <p>The metadata transfer job summary creation DateTime object.</p>
2369
+ * @public
2370
2370
  */
2371
2371
  creationDateTime: Date | undefined;
2372
2372
  /**
2373
- * @public
2374
2373
  * <p>The metadata transfer job summary update DateTime object</p>
2374
+ * @public
2375
2375
  */
2376
2376
  updateDateTime: Date | undefined;
2377
2377
  /**
2378
- * @public
2379
2378
  * <p>The metadata transfer job summary status.</p>
2379
+ * @public
2380
2380
  */
2381
2381
  status: MetadataTransferJobStatus | undefined;
2382
2382
  /**
2383
- * @public
2384
2383
  * <p>The metadata transfer job summary progess.</p>
2384
+ * @public
2385
2385
  */
2386
2386
  progress?: MetadataTransferJobProgress;
2387
2387
  }
@@ -2390,13 +2390,13 @@ export interface MetadataTransferJobSummary {
2390
2390
  */
2391
2391
  export interface ListMetadataTransferJobsResponse {
2392
2392
  /**
2393
- * @public
2394
2393
  * <p>The metadata transfer job summaries.</p>
2394
+ * @public
2395
2395
  */
2396
2396
  metadataTransferJobSummaries: MetadataTransferJobSummary[] | undefined;
2397
2397
  /**
2398
- * @public
2399
2398
  * <p>The string that specifies the next page of results.</p>
2399
+ * @public
2400
2400
  */
2401
2401
  nextToken?: string;
2402
2402
  }
@@ -2405,33 +2405,33 @@ export interface ListMetadataTransferJobsResponse {
2405
2405
  */
2406
2406
  export interface ListPropertiesRequest {
2407
2407
  /**
2408
- * @public
2409
2408
  * <p>The workspace ID.</p>
2409
+ * @public
2410
2410
  */
2411
2411
  workspaceId: string | undefined;
2412
2412
  /**
2413
- * @public
2414
2413
  * <p>The name of the component whose properties are returned by the operation.</p>
2414
+ * @public
2415
2415
  */
2416
2416
  componentName?: string;
2417
2417
  /**
2418
- * @public
2419
2418
  * <p>This string specifies the path to the composite component, starting from the top-level component.</p>
2419
+ * @public
2420
2420
  */
2421
2421
  componentPath?: string;
2422
2422
  /**
2423
- * @public
2424
2423
  * <p>The ID for the entity whose metadata (component/properties) is returned by the operation.</p>
2424
+ * @public
2425
2425
  */
2426
2426
  entityId: string | undefined;
2427
2427
  /**
2428
- * @public
2429
2428
  * <p>The maximum number of results returned at one time. The default is 25.</p>
2429
+ * @public
2430
2430
  */
2431
2431
  maxResults?: number;
2432
2432
  /**
2433
- * @public
2434
2433
  * <p>The string that specifies the next page of results.</p>
2434
+ * @public
2435
2435
  */
2436
2436
  nextToken?: string;
2437
2437
  }
@@ -2440,54 +2440,54 @@ export interface ListPropertiesRequest {
2440
2440
  */
2441
2441
  export interface ListScenesRequest {
2442
2442
  /**
2443
- * @public
2444
2443
  * <p>The ID of the workspace that contains the scenes.</p>
2444
+ * @public
2445
2445
  */
2446
2446
  workspaceId: string | undefined;
2447
2447
  /**
2448
- * @public
2449
2448
  * <p>Specifies the maximum number of results to display.</p>
2449
+ * @public
2450
2450
  */
2451
2451
  maxResults?: number;
2452
2452
  /**
2453
- * @public
2454
2453
  * <p>The string that specifies the next page of results.</p>
2454
+ * @public
2455
2455
  */
2456
2456
  nextToken?: string;
2457
2457
  }
2458
2458
  /**
2459
- * @public
2460
2459
  * <p>An object that contains information about a scene.</p>
2460
+ * @public
2461
2461
  */
2462
2462
  export interface SceneSummary {
2463
2463
  /**
2464
- * @public
2465
2464
  * <p>The ID of the scene.</p>
2465
+ * @public
2466
2466
  */
2467
2467
  sceneId: string | undefined;
2468
2468
  /**
2469
- * @public
2470
2469
  * <p>The relative path that specifies the location of the content definition file.</p>
2470
+ * @public
2471
2471
  */
2472
2472
  contentLocation: string | undefined;
2473
2473
  /**
2474
- * @public
2475
2474
  * <p>The ARN of the scene.</p>
2475
+ * @public
2476
2476
  */
2477
2477
  arn: string | undefined;
2478
2478
  /**
2479
- * @public
2480
2479
  * <p>The date and time when the scene was created.</p>
2480
+ * @public
2481
2481
  */
2482
2482
  creationDateTime: Date | undefined;
2483
2483
  /**
2484
- * @public
2485
2484
  * <p>The date and time when the scene was last updated.</p>
2485
+ * @public
2486
2486
  */
2487
2487
  updateDateTime: Date | undefined;
2488
2488
  /**
2489
- * @public
2490
2489
  * <p>The scene description.</p>
2490
+ * @public
2491
2491
  */
2492
2492
  description?: string;
2493
2493
  }
@@ -2496,13 +2496,13 @@ export interface SceneSummary {
2496
2496
  */
2497
2497
  export interface ListScenesResponse {
2498
2498
  /**
2499
- * @public
2500
2499
  * <p>A list of objects that contain information about the scenes.</p>
2500
+ * @public
2501
2501
  */
2502
2502
  sceneSummaries?: SceneSummary[];
2503
2503
  /**
2504
- * @public
2505
2504
  * <p>The string that specifies the next page of results.</p>
2505
+ * @public
2506
2506
  */
2507
2507
  nextToken?: string;
2508
2508
  }
@@ -2511,55 +2511,55 @@ export interface ListScenesResponse {
2511
2511
  */
2512
2512
  export interface ListSyncJobsRequest {
2513
2513
  /**
2514
- * @public
2515
2514
  * <p>The ID of the workspace that contains the sync job.</p>
2515
+ * @public
2516
2516
  */
2517
2517
  workspaceId: string | undefined;
2518
2518
  /**
2519
- * @public
2520
2519
  * <p>The maximum number of results to return at one time. The default is 50.</p>
2521
2520
  * <p>Valid Range: Minimum value of 0. Maximum value of 200.</p>
2521
+ * @public
2522
2522
  */
2523
2523
  maxResults?: number;
2524
2524
  /**
2525
- * @public
2526
2525
  * <p>The string that specifies the next page of results.</p>
2526
+ * @public
2527
2527
  */
2528
2528
  nextToken?: string;
2529
2529
  }
2530
2530
  /**
2531
- * @public
2532
2531
  * <p>The SyncJob summary.</p>
2532
+ * @public
2533
2533
  */
2534
2534
  export interface SyncJobSummary {
2535
2535
  /**
2536
- * @public
2537
2536
  * <p>The SyncJob summary ARN.</p>
2537
+ * @public
2538
2538
  */
2539
2539
  arn?: string;
2540
2540
  /**
2541
- * @public
2542
2541
  * <p>The ID of the workspace that contains the sync job.</p>
2542
+ * @public
2543
2543
  */
2544
2544
  workspaceId?: string;
2545
2545
  /**
2546
- * @public
2547
2546
  * <p>The sync source.</p>
2547
+ * @public
2548
2548
  */
2549
2549
  syncSource?: string;
2550
2550
  /**
2551
- * @public
2552
2551
  * <p>The SyncJob summaries status.</p>
2552
+ * @public
2553
2553
  */
2554
2554
  status?: SyncJobStatus;
2555
2555
  /**
2556
- * @public
2557
2556
  * <p>The creation date and time.</p>
2557
+ * @public
2558
2558
  */
2559
2559
  creationDateTime?: Date;
2560
2560
  /**
2561
- * @public
2562
2561
  * <p>The update date and time.</p>
2562
+ * @public
2563
2563
  */
2564
2564
  updateDateTime?: Date;
2565
2565
  }
@@ -2568,13 +2568,13 @@ export interface SyncJobSummary {
2568
2568
  */
2569
2569
  export interface ListSyncJobsResponse {
2570
2570
  /**
2571
- * @public
2572
2571
  * <p>The listed SyncJob summaries.</p>
2572
+ * @public
2573
2573
  */
2574
2574
  syncJobSummaries?: SyncJobSummary[];
2575
2575
  /**
2576
- * @public
2577
2576
  * <p>The string that specifies the next page of results.</p>
2577
+ * @public
2578
2578
  */
2579
2579
  nextToken?: string;
2580
2580
  }
@@ -2606,8 +2606,8 @@ export declare const SyncResourceState: {
2606
2606
  */
2607
2607
  export type SyncResourceState = (typeof SyncResourceState)[keyof typeof SyncResourceState];
2608
2608
  /**
2609
- * @public
2610
2609
  * <p>The sync resource filter.</p>
2610
+ * @public
2611
2611
  */
2612
2612
  export type SyncResourceFilter = SyncResourceFilter.ExternalIdMember | SyncResourceFilter.ResourceIdMember | SyncResourceFilter.ResourceTypeMember | SyncResourceFilter.StateMember | SyncResourceFilter.$UnknownMember;
2613
2613
  /**
@@ -2615,8 +2615,8 @@ export type SyncResourceFilter = SyncResourceFilter.ExternalIdMember | SyncResou
2615
2615
  */
2616
2616
  export declare namespace SyncResourceFilter {
2617
2617
  /**
2618
- * @public
2619
2618
  * <p>The sync resource filter's state.</p>
2619
+ * @public
2620
2620
  */
2621
2621
  interface StateMember {
2622
2622
  state: SyncResourceState;
@@ -2626,8 +2626,8 @@ export declare namespace SyncResourceFilter {
2626
2626
  $unknown?: never;
2627
2627
  }
2628
2628
  /**
2629
- * @public
2630
2629
  * <p>The sync resource filter resource type</p>
2630
+ * @public
2631
2631
  */
2632
2632
  interface ResourceTypeMember {
2633
2633
  state?: never;
@@ -2637,8 +2637,8 @@ export declare namespace SyncResourceFilter {
2637
2637
  $unknown?: never;
2638
2638
  }
2639
2639
  /**
2640
- * @public
2641
2640
  * <p>The sync resource filter resource ID.</p>
2641
+ * @public
2642
2642
  */
2643
2643
  interface ResourceIdMember {
2644
2644
  state?: never;
@@ -2648,8 +2648,8 @@ export declare namespace SyncResourceFilter {
2648
2648
  $unknown?: never;
2649
2649
  }
2650
2650
  /**
2651
- * @public
2652
2651
  * <p>The external ID.</p>
2652
+ * @public
2653
2653
  */
2654
2654
  interface ExternalIdMember {
2655
2655
  state?: never;
@@ -2682,20 +2682,19 @@ export declare namespace SyncResourceFilter {
2682
2682
  */
2683
2683
  export interface ListSyncResourcesRequest {
2684
2684
  /**
2685
- * @public
2686
2685
  * <p>The ID of the workspace that contains the sync job.</p>
2686
+ * @public
2687
2687
  */
2688
2688
  workspaceId: string | undefined;
2689
2689
  /**
2690
- * @public
2691
2690
  * <p>The sync source.</p>
2692
2691
  * <note>
2693
2692
  * <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p>
2694
2693
  * </note>
2694
+ * @public
2695
2695
  */
2696
2696
  syncSource: string | undefined;
2697
2697
  /**
2698
- * @public
2699
2698
  * <p>A list of objects that filter the request.</p>
2700
2699
  * <p>The following filter combinations are supported:</p>
2701
2700
  * <ul>
@@ -2709,64 +2708,65 @@ export interface ListSyncResourcesRequest {
2709
2708
  * <p>Filter with ResourceType and ExternalId</p>
2710
2709
  * </li>
2711
2710
  * </ul>
2711
+ * @public
2712
2712
  */
2713
2713
  filters?: SyncResourceFilter[];
2714
2714
  /**
2715
- * @public
2716
2715
  * <p>The maximum number of results to return at one time. The default is 50.</p>
2717
2716
  * <p>Valid Range: Minimum value of 0. Maximum value of 200.</p>
2717
+ * @public
2718
2718
  */
2719
2719
  maxResults?: number;
2720
2720
  /**
2721
- * @public
2722
2721
  * <p>The string that specifies the next page of results.</p>
2722
+ * @public
2723
2723
  */
2724
2724
  nextToken?: string;
2725
2725
  }
2726
2726
  /**
2727
- * @public
2728
2727
  * <p>The sync resource status.</p>
2728
+ * @public
2729
2729
  */
2730
2730
  export interface SyncResourceStatus {
2731
2731
  /**
2732
- * @public
2733
2732
  * <p>The sync resource status state.</p>
2733
+ * @public
2734
2734
  */
2735
2735
  state?: SyncResourceState;
2736
2736
  /**
2737
- * @public
2738
2737
  * <p>The status error.</p>
2738
+ * @public
2739
2739
  */
2740
2740
  error?: ErrorDetails;
2741
2741
  }
2742
2742
  /**
2743
- * @public
2744
2743
  * <p>The sync resource summary.</p>
2744
+ * @public
2745
2745
  */
2746
2746
  export interface SyncResourceSummary {
2747
2747
  /**
2748
- * @public
2749
2748
  * <p>The resource type.</p>
2749
+ * @public
2750
2750
  */
2751
2751
  resourceType?: SyncResourceType;
2752
2752
  /**
2753
- * @public
2754
2753
  * <p>The external ID.</p>
2754
+ * @public
2755
2755
  */
2756
2756
  externalId?: string;
2757
2757
  /**
2758
- * @public
2759
2758
  * <p>The resource ID.</p>
2759
+ * @public
2760
2760
  */
2761
2761
  resourceId?: string;
2762
2762
  /**
2763
- * @public
2764
2763
  * <p>The sync resource summary status.</p>
2764
+ * @public
2765
2765
  */
2766
2766
  status?: SyncResourceStatus;
2767
2767
  /**
2768
- * @public
2769
2768
  * <p>The update date and time.</p>
2769
+ * @public
2770
2770
  */
2771
2771
  updateDateTime?: Date;
2772
2772
  }
@@ -2775,13 +2775,13 @@ export interface SyncResourceSummary {
2775
2775
  */
2776
2776
  export interface ListSyncResourcesResponse {
2777
2777
  /**
2778
- * @public
2779
2778
  * <p>The sync resources.</p>
2779
+ * @public
2780
2780
  */
2781
2781
  syncResources?: SyncResourceSummary[];
2782
2782
  /**
2783
- * @public
2784
2783
  * <p>The string that specifies the next page of results.</p>
2784
+ * @public
2785
2785
  */
2786
2786
  nextToken?: string;
2787
2787
  }
@@ -2790,19 +2790,19 @@ export interface ListSyncResourcesResponse {
2790
2790
  */
2791
2791
  export interface ListTagsForResourceRequest {
2792
2792
  /**
2793
- * @public
2794
2793
  * <p>The ARN of the resource.</p>
2794
+ * @public
2795
2795
  */
2796
2796
  resourceARN: string | undefined;
2797
2797
  /**
2798
- * @public
2799
2798
  * <p>The maximum number of results to return at one time. The default is 25.</p>
2800
2799
  * <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
2800
+ * @public
2801
2801
  */
2802
2802
  maxResults?: number;
2803
2803
  /**
2804
- * @public
2805
2804
  * <p>The string that specifies the next page of results.</p>
2805
+ * @public
2806
2806
  */
2807
2807
  nextToken?: string;
2808
2808
  }
@@ -2811,13 +2811,13 @@ export interface ListTagsForResourceRequest {
2811
2811
  */
2812
2812
  export interface ListTagsForResourceResponse {
2813
2813
  /**
2814
- * @public
2815
2814
  * <p>Metadata that you can use to manage a resource.</p>
2815
+ * @public
2816
2816
  */
2817
2817
  tags?: Record<string, string>;
2818
2818
  /**
2819
- * @public
2820
2819
  * <p>The string that specifies the next page of results.</p>
2820
+ * @public
2821
2821
  */
2822
2822
  nextToken?: string;
2823
2823
  }
@@ -2826,50 +2826,50 @@ export interface ListTagsForResourceResponse {
2826
2826
  */
2827
2827
  export interface ListWorkspacesRequest {
2828
2828
  /**
2829
- * @public
2830
2829
  * <p>The maximum number of results to return at one time. The default is 25.</p>
2831
2830
  * <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
2831
+ * @public
2832
2832
  */
2833
2833
  maxResults?: number;
2834
2834
  /**
2835
- * @public
2836
2835
  * <p>The string that specifies the next page of results.</p>
2836
+ * @public
2837
2837
  */
2838
2838
  nextToken?: string;
2839
2839
  }
2840
2840
  /**
2841
- * @public
2842
2841
  * <p>An object that contains information about a workspace.</p>
2842
+ * @public
2843
2843
  */
2844
2844
  export interface WorkspaceSummary {
2845
2845
  /**
2846
- * @public
2847
2846
  * <p>The ID of the workspace.</p>
2847
+ * @public
2848
2848
  */
2849
2849
  workspaceId: string | undefined;
2850
2850
  /**
2851
- * @public
2852
2851
  * <p>The ARN of the workspace.</p>
2852
+ * @public
2853
2853
  */
2854
2854
  arn: string | undefined;
2855
2855
  /**
2856
- * @public
2857
2856
  * <p>The description of the workspace.</p>
2857
+ * @public
2858
2858
  */
2859
2859
  description?: string;
2860
2860
  /**
2861
- * @public
2862
2861
  * <p>A list of services that are linked to the workspace.</p>
2862
+ * @public
2863
2863
  */
2864
2864
  linkedServices?: string[];
2865
2865
  /**
2866
- * @public
2867
2866
  * <p>The date and time when the workspace was created.</p>
2867
+ * @public
2868
2868
  */
2869
2869
  creationDateTime: Date | undefined;
2870
2870
  /**
2871
- * @public
2872
2871
  * <p>The date and time when the workspace was last updated.</p>
2872
+ * @public
2873
2873
  */
2874
2874
  updateDateTime: Date | undefined;
2875
2875
  }
@@ -2878,13 +2878,13 @@ export interface WorkspaceSummary {
2878
2878
  */
2879
2879
  export interface ListWorkspacesResponse {
2880
2880
  /**
2881
- * @public
2882
2881
  * <p>A list of objects that contain information about the workspaces.</p>
2882
+ * @public
2883
2883
  */
2884
2884
  workspaceSummaries?: WorkspaceSummary[];
2885
2885
  /**
2886
- * @public
2887
2886
  * <p>The string that specifies the next page of results.</p>
2887
+ * @public
2888
2888
  */
2889
2889
  nextToken?: string;
2890
2890
  }
@@ -2893,13 +2893,13 @@ export interface ListWorkspacesResponse {
2893
2893
  */
2894
2894
  export interface TagResourceRequest {
2895
2895
  /**
2896
- * @public
2897
2896
  * <p>The ARN of the resource.</p>
2897
+ * @public
2898
2898
  */
2899
2899
  resourceARN: string | undefined;
2900
2900
  /**
2901
- * @public
2902
2901
  * <p>Metadata to add to this resource.</p>
2902
+ * @public
2903
2903
  */
2904
2904
  tags: Record<string, string> | undefined;
2905
2905
  }
@@ -2909,8 +2909,8 @@ export interface TagResourceRequest {
2909
2909
  export interface TagResourceResponse {
2910
2910
  }
2911
2911
  /**
2912
- * @public
2913
2912
  * <p>The number of tags exceeds the limit.</p>
2913
+ * @public
2914
2914
  */
2915
2915
  export declare class TooManyTagsException extends __BaseException {
2916
2916
  readonly name: "TooManyTagsException";
@@ -2925,14 +2925,14 @@ export declare class TooManyTagsException extends __BaseException {
2925
2925
  */
2926
2926
  export interface UntagResourceRequest {
2927
2927
  /**
2928
- * @public
2929
2928
  * <p>The ARN of the resource.</p>
2929
+ * @public
2930
2930
  */
2931
2931
  resourceARN: string | undefined;
2932
2932
  /**
2933
- * @public
2934
2933
  * <p>A list of tag key names to remove from the resource. You don't specify the value. Both
2935
2934
  * the key and its associated value are removed.</p>
2935
+ * @public
2936
2936
  */
2937
2937
  tagKeys: string[] | undefined;
2938
2938
  }
@@ -2946,23 +2946,23 @@ export interface UntagResourceResponse {
2946
2946
  */
2947
2947
  export interface UpdateComponentTypeResponse {
2948
2948
  /**
2949
- * @public
2950
2949
  * <p>The ID of the workspace that contains the component type.</p>
2950
+ * @public
2951
2951
  */
2952
2952
  workspaceId: string | undefined;
2953
2953
  /**
2954
- * @public
2955
2954
  * <p>The ARN of the component type.</p>
2955
+ * @public
2956
2956
  */
2957
2957
  arn: string | undefined;
2958
2958
  /**
2959
- * @public
2960
2959
  * <p>The ID of the component type.</p>
2960
+ * @public
2961
2961
  */
2962
2962
  componentTypeId: string | undefined;
2963
2963
  /**
2964
- * @public
2965
2964
  * <p>The current state of the component type.</p>
2965
+ * @public
2966
2966
  */
2967
2967
  state: State | undefined;
2968
2968
  }
@@ -2992,18 +2992,18 @@ export declare const ParentEntityUpdateType: {
2992
2992
  */
2993
2993
  export type ParentEntityUpdateType = (typeof ParentEntityUpdateType)[keyof typeof ParentEntityUpdateType];
2994
2994
  /**
2995
- * @public
2996
2995
  * <p>The parent entity update request.</p>
2996
+ * @public
2997
2997
  */
2998
2998
  export interface ParentEntityUpdateRequest {
2999
2999
  /**
3000
- * @public
3001
3000
  * <p>The type of the update.</p>
3001
+ * @public
3002
3002
  */
3003
3003
  updateType: ParentEntityUpdateType | undefined;
3004
3004
  /**
3005
- * @public
3006
3005
  * <p>The ID of the parent entity.</p>
3006
+ * @public
3007
3007
  */
3008
3008
  parentEntityId?: string;
3009
3009
  }
@@ -3012,13 +3012,13 @@ export interface ParentEntityUpdateRequest {
3012
3012
  */
3013
3013
  export interface UpdateEntityResponse {
3014
3014
  /**
3015
- * @public
3016
3015
  * <p>The date and time when the entity was last updated.</p>
3016
+ * @public
3017
3017
  */
3018
3018
  updateDateTime: Date | undefined;
3019
3019
  /**
3020
- * @public
3021
3020
  * <p>The current state of the entity update.</p>
3021
+ * @public
3022
3022
  */
3023
3023
  state: State | undefined;
3024
3024
  }
@@ -3027,13 +3027,13 @@ export interface UpdateEntityResponse {
3027
3027
  */
3028
3028
  export interface UpdatePricingPlanRequest {
3029
3029
  /**
3030
- * @public
3031
3030
  * <p>The pricing mode.</p>
3031
+ * @public
3032
3032
  */
3033
3033
  pricingMode: PricingMode | undefined;
3034
3034
  /**
3035
- * @public
3036
3035
  * <p>The bundle names.</p>
3036
+ * @public
3037
3037
  */
3038
3038
  bundleNames?: string[];
3039
3039
  }
@@ -3042,13 +3042,13 @@ export interface UpdatePricingPlanRequest {
3042
3042
  */
3043
3043
  export interface UpdatePricingPlanResponse {
3044
3044
  /**
3045
- * @public
3046
3045
  * <p>Update the current pricing plan.</p>
3046
+ * @public
3047
3047
  */
3048
3048
  currentPricingPlan: PricingPlan | undefined;
3049
3049
  /**
3050
- * @public
3051
3050
  * <p>Update the pending pricing plan.</p>
3051
+ * @public
3052
3052
  */
3053
3053
  pendingPricingPlan?: PricingPlan;
3054
3054
  }
@@ -3057,33 +3057,33 @@ export interface UpdatePricingPlanResponse {
3057
3057
  */
3058
3058
  export interface UpdateSceneRequest {
3059
3059
  /**
3060
- * @public
3061
3060
  * <p>The ID of the workspace that contains the scene.</p>
3061
+ * @public
3062
3062
  */
3063
3063
  workspaceId: string | undefined;
3064
3064
  /**
3065
- * @public
3066
3065
  * <p>The ID of the scene.</p>
3066
+ * @public
3067
3067
  */
3068
3068
  sceneId: string | undefined;
3069
3069
  /**
3070
- * @public
3071
3070
  * <p>The relative path that specifies the location of the content definition file.</p>
3071
+ * @public
3072
3072
  */
3073
3073
  contentLocation?: string;
3074
3074
  /**
3075
- * @public
3076
3075
  * <p>The description of this scene.</p>
3076
+ * @public
3077
3077
  */
3078
3078
  description?: string;
3079
3079
  /**
3080
- * @public
3081
3080
  * <p>A list of capabilities that the scene uses to render.</p>
3081
+ * @public
3082
3082
  */
3083
3083
  capabilities?: string[];
3084
3084
  /**
3085
- * @public
3086
3085
  * <p>The scene metadata.</p>
3086
+ * @public
3087
3087
  */
3088
3088
  sceneMetadata?: Record<string, string>;
3089
3089
  }
@@ -3092,8 +3092,8 @@ export interface UpdateSceneRequest {
3092
3092
  */
3093
3093
  export interface UpdateSceneResponse {
3094
3094
  /**
3095
- * @public
3096
3095
  * <p>The date and time when the scene was last updated.</p>
3096
+ * @public
3097
3097
  */
3098
3098
  updateDateTime: Date | undefined;
3099
3099
  }
@@ -3102,24 +3102,24 @@ export interface UpdateSceneResponse {
3102
3102
  */
3103
3103
  export interface UpdateWorkspaceRequest {
3104
3104
  /**
3105
- * @public
3106
3105
  * <p>The ID of the workspace.</p>
3106
+ * @public
3107
3107
  */
3108
3108
  workspaceId: string | undefined;
3109
3109
  /**
3110
- * @public
3111
3110
  * <p>The description of the workspace.</p>
3111
+ * @public
3112
3112
  */
3113
3113
  description?: string;
3114
3114
  /**
3115
- * @public
3116
3115
  * <p>The ARN of the execution role associated with the workspace.</p>
3116
+ * @public
3117
3117
  */
3118
3118
  role?: string;
3119
3119
  /**
3120
- * @public
3121
3120
  * <p>The ARN of the S3 bucket where resources associated with the workspace are
3122
3121
  * stored.</p>
3122
+ * @public
3123
3123
  */
3124
3124
  s3Location?: string;
3125
3125
  }
@@ -3128,118 +3128,117 @@ export interface UpdateWorkspaceRequest {
3128
3128
  */
3129
3129
  export interface UpdateWorkspaceResponse {
3130
3130
  /**
3131
- * @public
3132
3131
  * <p>The date and time of the current update.</p>
3132
+ * @public
3133
3133
  */
3134
3134
  updateDateTime: Date | undefined;
3135
3135
  }
3136
3136
  /**
3137
- * @public
3138
3137
  * <p>An object that specifies a value for a property.</p>
3138
+ * @public
3139
3139
  */
3140
3140
  export interface DataValue {
3141
3141
  /**
3142
- * @public
3143
3142
  * <p>A Boolean value.</p>
3143
+ * @public
3144
3144
  */
3145
3145
  booleanValue?: boolean;
3146
3146
  /**
3147
- * @public
3148
3147
  * <p>A double value.</p>
3148
+ * @public
3149
3149
  */
3150
3150
  doubleValue?: number;
3151
3151
  /**
3152
- * @public
3153
3152
  * <p>An integer value.</p>
3153
+ * @public
3154
3154
  */
3155
3155
  integerValue?: number;
3156
3156
  /**
3157
- * @public
3158
3157
  * <p>A long value.</p>
3158
+ * @public
3159
3159
  */
3160
3160
  longValue?: number;
3161
3161
  /**
3162
- * @public
3163
3162
  * <p>A string value.</p>
3163
+ * @public
3164
3164
  */
3165
3165
  stringValue?: string;
3166
3166
  /**
3167
- * @public
3168
3167
  * <p>A list of multiple values.</p>
3168
+ * @public
3169
3169
  */
3170
3170
  listValue?: DataValue[];
3171
3171
  /**
3172
- * @public
3173
3172
  * <p>An object that maps strings to multiple <code>DataValue</code> objects.</p>
3173
+ * @public
3174
3174
  */
3175
3175
  mapValue?: Record<string, DataValue>;
3176
3176
  /**
3177
- * @public
3178
3177
  * <p>A value that relates a component to another component.</p>
3178
+ * @public
3179
3179
  */
3180
3180
  relationshipValue?: RelationshipValue;
3181
3181
  /**
3182
- * @public
3183
3182
  * <p>An expression that produces the value.</p>
3183
+ * @public
3184
3184
  */
3185
3185
  expression?: string;
3186
3186
  }
3187
3187
  /**
3188
- * @public
3189
3188
  * <p>An object that filters items returned by a property request.</p>
3189
+ * @public
3190
3190
  */
3191
3191
  export interface PropertyFilter {
3192
3192
  /**
3193
- * @public
3194
3193
  * <p>The property name associated with this property filter.</p>
3194
+ * @public
3195
3195
  */
3196
3196
  propertyName?: string;
3197
3197
  /**
3198
- * @public
3199
3198
  * <p>The operator associated with this property filter.</p>
3199
+ * @public
3200
3200
  */
3201
3201
  operator?: string;
3202
3202
  /**
3203
- * @public
3204
3203
  * <p>The value associated with this property filter.</p>
3204
+ * @public
3205
3205
  */
3206
3206
  value?: DataValue;
3207
3207
  }
3208
3208
  /**
3209
- * @public
3210
3209
  * <p>The latest value of the property.</p>
3210
+ * @public
3211
3211
  */
3212
3212
  export interface PropertyLatestValue {
3213
3213
  /**
3214
- * @public
3215
3214
  * <p>An object that specifies information about a property.</p>
3215
+ * @public
3216
3216
  */
3217
3217
  propertyReference: EntityPropertyReference | undefined;
3218
3218
  /**
3219
- * @public
3220
3219
  * <p>The value of the property.</p>
3220
+ * @public
3221
3221
  */
3222
3222
  propertyValue?: DataValue;
3223
3223
  }
3224
3224
  /**
3225
- * @public
3226
3225
  * <p>An object that contains information about a value for a time series property.</p>
3226
+ * @public
3227
3227
  */
3228
3228
  export interface PropertyValue {
3229
3229
  /**
3230
- * @public
3231
3230
  * @deprecated
3232
3231
  *
3233
3232
  * <p>The timestamp of a value for a time series property.</p>
3233
+ * @public
3234
3234
  */
3235
3235
  timestamp?: Date;
3236
3236
  /**
3237
- * @public
3238
3237
  * <p>An object that specifies a value for a time series property.</p>
3238
+ * @public
3239
3239
  */
3240
3240
  value: DataValue | undefined;
3241
3241
  /**
3242
- * @public
3243
3242
  * <p>ISO8601 DateTime of a value for a time series property.</p>
3244
3243
  * <p>The time for when the property value was recorded in ISO 8601 format:
3245
3244
  * <i>YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm]</i>.</p>
@@ -3284,37 +3283,38 @@ export interface PropertyValue {
3284
3283
  * </ul>
3285
3284
  * <p>
3286
3285
  * <i>Required sub-fields</i>: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]</p>
3286
+ * @public
3287
3287
  */
3288
3288
  time?: string;
3289
3289
  }
3290
3290
  /**
3291
- * @public
3292
3291
  * <p>An object that specifies the data type of a property.</p>
3292
+ * @public
3293
3293
  */
3294
3294
  export interface DataType {
3295
3295
  /**
3296
- * @public
3297
3296
  * <p>The underlying type of the data type.</p>
3297
+ * @public
3298
3298
  */
3299
3299
  type: Type | undefined;
3300
3300
  /**
3301
- * @public
3302
3301
  * <p>The nested type in the data type.</p>
3302
+ * @public
3303
3303
  */
3304
3304
  nestedType?: DataType;
3305
3305
  /**
3306
- * @public
3307
3306
  * <p>The allowed values for this data type.</p>
3307
+ * @public
3308
3308
  */
3309
3309
  allowedValues?: DataValue[];
3310
3310
  /**
3311
- * @public
3312
3311
  * <p>The unit of measure used in this data type.</p>
3312
+ * @public
3313
3313
  */
3314
3314
  unitOfMeasure?: string;
3315
3315
  /**
3316
- * @public
3317
3316
  * <p>A relationship that associates a component with another component.</p>
3317
+ * @public
3318
3318
  */
3319
3319
  relationship?: Relationship;
3320
3320
  }
@@ -3323,163 +3323,163 @@ export interface DataType {
3323
3323
  */
3324
3324
  export interface GetPropertyValueHistoryRequest {
3325
3325
  /**
3326
- * @public
3327
3326
  * <p>The ID of the workspace.</p>
3327
+ * @public
3328
3328
  */
3329
3329
  workspaceId: string | undefined;
3330
3330
  /**
3331
- * @public
3332
3331
  * <p>The ID of the entity.</p>
3332
+ * @public
3333
3333
  */
3334
3334
  entityId?: string;
3335
3335
  /**
3336
- * @public
3337
3336
  * <p>The name of the component.</p>
3337
+ * @public
3338
3338
  */
3339
3339
  componentName?: string;
3340
3340
  /**
3341
- * @public
3342
3341
  * <p>This string specifies the path to the composite component, starting from the top-level component.</p>
3342
+ * @public
3343
3343
  */
3344
3344
  componentPath?: string;
3345
3345
  /**
3346
- * @public
3347
3346
  * <p>The ID of the component type.</p>
3347
+ * @public
3348
3348
  */
3349
3349
  componentTypeId?: string;
3350
3350
  /**
3351
- * @public
3352
3351
  * <p>A list of properties whose value histories the request retrieves.</p>
3352
+ * @public
3353
3353
  */
3354
3354
  selectedProperties: string[] | undefined;
3355
3355
  /**
3356
- * @public
3357
3356
  * <p>A list of objects that filter the property value history request.</p>
3357
+ * @public
3358
3358
  */
3359
3359
  propertyFilters?: PropertyFilter[];
3360
3360
  /**
3361
- * @public
3362
3361
  * @deprecated
3363
3362
  *
3364
3363
  * <p>The date and time of the earliest property value to return.</p>
3364
+ * @public
3365
3365
  */
3366
3366
  startDateTime?: Date;
3367
3367
  /**
3368
- * @public
3369
3368
  * @deprecated
3370
3369
  *
3371
3370
  * <p>The date and time of the latest property value to return.</p>
3371
+ * @public
3372
3372
  */
3373
3373
  endDateTime?: Date;
3374
3374
  /**
3375
- * @public
3376
3375
  * <p>An object that specifies the interpolation type and the interval over which to
3377
3376
  * interpolate data.</p>
3377
+ * @public
3378
3378
  */
3379
3379
  interpolation?: InterpolationParameters;
3380
3380
  /**
3381
- * @public
3382
3381
  * <p>The string that specifies the next page of results.</p>
3382
+ * @public
3383
3383
  */
3384
3384
  nextToken?: string;
3385
3385
  /**
3386
- * @public
3387
3386
  * <p>The maximum number of results to return at one time. The default is 25.</p>
3388
3387
  * <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
3388
+ * @public
3389
3389
  */
3390
3390
  maxResults?: number;
3391
3391
  /**
3392
- * @public
3393
3392
  * <p>The time direction to use in the result order.</p>
3393
+ * @public
3394
3394
  */
3395
3395
  orderByTime?: OrderByTime;
3396
3396
  /**
3397
- * @public
3398
3397
  * <p>The ISO8601 DateTime of the earliest property value to return.</p>
3399
3398
  * <p>For more information about the ISO8601 DateTime format, see the data type <a href="https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html">PropertyValue</a>.</p>
3399
+ * @public
3400
3400
  */
3401
3401
  startTime?: string;
3402
3402
  /**
3403
- * @public
3404
3403
  * <p>The ISO8601 DateTime of the latest property value to return.</p>
3405
3404
  * <p>For more information about the ISO8601 DateTime format, see the data type <a href="https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html">PropertyValue</a>.</p>
3405
+ * @public
3406
3406
  */
3407
3407
  endTime?: string;
3408
3408
  }
3409
3409
  /**
3410
- * @public
3411
3410
  * <p>An object that specifies information about time series property values. This object is
3412
3411
  * used and consumed by the <a href="https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_BatchPutPropertyValues.html">BatchPutPropertyValues</a> action.</p>
3412
+ * @public
3413
3413
  */
3414
3414
  export interface PropertyValueEntry {
3415
3415
  /**
3416
- * @public
3417
3416
  * <p>An object that contains information about the entity that has the property.</p>
3417
+ * @public
3418
3418
  */
3419
3419
  entityPropertyReference: EntityPropertyReference | undefined;
3420
3420
  /**
3421
- * @public
3422
3421
  * <p>A list of objects that specify time series property values.</p>
3422
+ * @public
3423
3423
  */
3424
3424
  propertyValues?: PropertyValue[];
3425
3425
  }
3426
3426
  /**
3427
- * @public
3428
3427
  * <p>The history of values for a time series property.</p>
3428
+ * @public
3429
3429
  */
3430
3430
  export interface PropertyValueHistory {
3431
3431
  /**
3432
- * @public
3433
3432
  * <p>An object that uniquely identifies an entity property.</p>
3433
+ * @public
3434
3434
  */
3435
3435
  entityPropertyReference: EntityPropertyReference | undefined;
3436
3436
  /**
3437
- * @public
3438
3437
  * <p>A list of objects that contain information about the values in the history of a time
3439
3438
  * series property.</p>
3439
+ * @public
3440
3440
  */
3441
3441
  values?: PropertyValue[];
3442
3442
  }
3443
3443
  /**
3444
- * @public
3445
3444
  * <p>The tabular conditions.</p>
3445
+ * @public
3446
3446
  */
3447
3447
  export interface TabularConditions {
3448
3448
  /**
3449
- * @public
3450
3449
  * <p>Filter criteria that orders the output. It can be sorted in ascending or descending
3451
3450
  * order.</p>
3451
+ * @public
3452
3452
  */
3453
3453
  orderBy?: OrderBy[];
3454
3454
  /**
3455
- * @public
3456
3455
  * <p>You can filter the request using various logical operators and a key-value format. For
3457
3456
  * example:</p>
3458
3457
  * <p>
3459
3458
  * <code>\{"key": "serverType", "value": "webServer"\}</code>
3460
3459
  * </p>
3460
+ * @public
3461
3461
  */
3462
3462
  propertyFilters?: PropertyFilter[];
3463
3463
  }
3464
3464
  /**
3465
- * @public
3466
3465
  * <p>An error returned by the <code>BatchPutProperty</code> action.</p>
3466
+ * @public
3467
3467
  */
3468
3468
  export interface BatchPutPropertyError {
3469
3469
  /**
3470
- * @public
3471
3470
  * <p>The error code.</p>
3471
+ * @public
3472
3472
  */
3473
3473
  errorCode: string | undefined;
3474
3474
  /**
3475
- * @public
3476
3475
  * <p>The error message.</p>
3476
+ * @public
3477
3477
  */
3478
3478
  errorMessage: string | undefined;
3479
3479
  /**
3480
- * @public
3481
3480
  * <p>An object that contains information about errors returned by the
3482
3481
  * <code>BatchPutProperty</code> action.</p>
3482
+ * @public
3483
3483
  */
3484
3484
  entry: PropertyValueEntry | undefined;
3485
3485
  }
@@ -3488,54 +3488,54 @@ export interface BatchPutPropertyError {
3488
3488
  */
3489
3489
  export interface GetPropertyValueRequest {
3490
3490
  /**
3491
- * @public
3492
3491
  * <p>The name of the component whose property values the operation returns.</p>
3492
+ * @public
3493
3493
  */
3494
3494
  componentName?: string;
3495
3495
  /**
3496
- * @public
3497
3496
  * <p>This string specifies the path to the composite component, starting from the top-level component.</p>
3497
+ * @public
3498
3498
  */
3499
3499
  componentPath?: string;
3500
3500
  /**
3501
- * @public
3502
3501
  * <p>The ID of the component type whose property values the operation returns.</p>
3502
+ * @public
3503
3503
  */
3504
3504
  componentTypeId?: string;
3505
3505
  /**
3506
- * @public
3507
3506
  * <p>The ID of the entity whose property values the operation returns.</p>
3507
+ * @public
3508
3508
  */
3509
3509
  entityId?: string;
3510
3510
  /**
3511
- * @public
3512
3511
  * <p>The properties whose values the operation returns.</p>
3512
+ * @public
3513
3513
  */
3514
3514
  selectedProperties: string[] | undefined;
3515
3515
  /**
3516
- * @public
3517
3516
  * <p>The ID of the workspace whose values the operation returns.</p>
3517
+ * @public
3518
3518
  */
3519
3519
  workspaceId: string | undefined;
3520
3520
  /**
3521
- * @public
3522
3521
  * <p>The maximum number of results to return at one time. The default is 25.</p>
3523
3522
  * <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
3523
+ * @public
3524
3524
  */
3525
3525
  maxResults?: number;
3526
3526
  /**
3527
- * @public
3528
3527
  * <p>The string that specifies the next page of results.</p>
3528
+ * @public
3529
3529
  */
3530
3530
  nextToken?: string;
3531
3531
  /**
3532
- * @public
3533
3532
  * <p>The property group name.</p>
3533
+ * @public
3534
3534
  */
3535
3535
  propertyGroupName?: string;
3536
3536
  /**
3537
- * @public
3538
3537
  * <p>The tabular conditions.</p>
3538
+ * @public
3539
3539
  */
3540
3540
  tabularConditions?: TabularConditions;
3541
3541
  }
@@ -3544,14 +3544,14 @@ export interface GetPropertyValueRequest {
3544
3544
  */
3545
3545
  export interface BatchPutPropertyValuesRequest {
3546
3546
  /**
3547
- * @public
3548
3547
  * <p>The ID of the workspace that contains the properties to set.</p>
3548
+ * @public
3549
3549
  */
3550
3550
  workspaceId: string | undefined;
3551
3551
  /**
3552
- * @public
3553
3552
  * <p>An object that maps strings to the property value entries to set. Each string in the
3554
3553
  * mapping must be unique to this object.</p>
3554
+ * @public
3555
3555
  */
3556
3556
  entries: PropertyValueEntry[] | undefined;
3557
3557
  }
@@ -3560,139 +3560,139 @@ export interface BatchPutPropertyValuesRequest {
3560
3560
  */
3561
3561
  export interface GetPropertyValueHistoryResponse {
3562
3562
  /**
3563
- * @public
3564
3563
  * <p>An object that maps strings to the property definitions in the component type. Each
3565
3564
  * string in the mapping must be unique to this object.</p>
3565
+ * @public
3566
3566
  */
3567
3567
  propertyValues: PropertyValueHistory[] | undefined;
3568
3568
  /**
3569
- * @public
3570
3569
  * <p>The string that specifies the next page of results.</p>
3570
+ * @public
3571
3571
  */
3572
3572
  nextToken?: string;
3573
3573
  }
3574
3574
  /**
3575
- * @public
3576
3575
  * <p>An object that contains information about errors returned by the
3577
3576
  * <code>BatchPutProperty</code> action.</p>
3577
+ * @public
3578
3578
  */
3579
3579
  export interface BatchPutPropertyErrorEntry {
3580
3580
  /**
3581
- * @public
3582
3581
  * <p>A list of objects that contain information about errors returned by the
3583
3582
  * <code>BatchPutProperty</code> action.</p>
3583
+ * @public
3584
3584
  */
3585
3585
  errors: BatchPutPropertyError[] | undefined;
3586
3586
  }
3587
3587
  /**
3588
- * @public
3589
3588
  * <p>An object that sets information about a property.</p>
3589
+ * @public
3590
3590
  */
3591
3591
  export interface PropertyDefinitionRequest {
3592
3592
  /**
3593
- * @public
3594
3593
  * <p>An object that contains information about the data type.</p>
3594
+ * @public
3595
3595
  */
3596
3596
  dataType?: DataType;
3597
3597
  /**
3598
- * @public
3599
3598
  * <p>A Boolean value that specifies whether the property is required.</p>
3599
+ * @public
3600
3600
  */
3601
3601
  isRequiredInEntity?: boolean;
3602
3602
  /**
3603
- * @public
3604
3603
  * <p>A Boolean value that specifies whether the property ID comes from an external data
3605
3604
  * store.</p>
3605
+ * @public
3606
3606
  */
3607
3607
  isExternalId?: boolean;
3608
3608
  /**
3609
- * @public
3610
3609
  * <p>A Boolean value that specifies whether the property is stored externally.</p>
3610
+ * @public
3611
3611
  */
3612
3612
  isStoredExternally?: boolean;
3613
3613
  /**
3614
- * @public
3615
3614
  * <p>A Boolean value that specifies whether the property consists of time series data.</p>
3615
+ * @public
3616
3616
  */
3617
3617
  isTimeSeries?: boolean;
3618
3618
  /**
3619
- * @public
3620
3619
  * <p>An object that contains the default value.</p>
3620
+ * @public
3621
3621
  */
3622
3622
  defaultValue?: DataValue;
3623
3623
  /**
3624
- * @public
3625
3624
  * <p>A mapping that specifies configuration information about the property. Use this field to
3626
3625
  * specify information that you read from and write to an external source.</p>
3626
+ * @public
3627
3627
  */
3628
3628
  configuration?: Record<string, string>;
3629
3629
  /**
3630
- * @public
3631
3630
  * <p>A friendly name for the property.</p>
3631
+ * @public
3632
3632
  */
3633
3633
  displayName?: string;
3634
3634
  }
3635
3635
  /**
3636
- * @public
3637
3636
  * <p>An object that contains response data from a property definition request.</p>
3637
+ * @public
3638
3638
  */
3639
3639
  export interface PropertyDefinitionResponse {
3640
3640
  /**
3641
- * @public
3642
3641
  * <p>An object that contains information about the data type.</p>
3642
+ * @public
3643
3643
  */
3644
3644
  dataType: DataType | undefined;
3645
3645
  /**
3646
- * @public
3647
3646
  * <p>A Boolean value that specifies whether the property consists of time series data.</p>
3647
+ * @public
3648
3648
  */
3649
3649
  isTimeSeries: boolean | undefined;
3650
3650
  /**
3651
- * @public
3652
3651
  * <p>A Boolean value that specifies whether the property is required in an entity.</p>
3652
+ * @public
3653
3653
  */
3654
3654
  isRequiredInEntity: boolean | undefined;
3655
3655
  /**
3656
- * @public
3657
3656
  * <p>A Boolean value that specifies whether the property ID comes from an external data
3658
3657
  * store.</p>
3658
+ * @public
3659
3659
  */
3660
3660
  isExternalId: boolean | undefined;
3661
3661
  /**
3662
- * @public
3663
3662
  * <p>A Boolean value that specifies whether the property is stored externally.</p>
3663
+ * @public
3664
3664
  */
3665
3665
  isStoredExternally: boolean | undefined;
3666
3666
  /**
3667
- * @public
3668
3667
  * <p>A Boolean value that specifies whether the property definition is imported from an
3669
3668
  * external data store.</p>
3669
+ * @public
3670
3670
  */
3671
3671
  isImported: boolean | undefined;
3672
3672
  /**
3673
- * @public
3674
3673
  * <p>A Boolean value that specifies whether the property definition can be updated.</p>
3674
+ * @public
3675
3675
  */
3676
3676
  isFinal: boolean | undefined;
3677
3677
  /**
3678
- * @public
3679
3678
  * <p>A Boolean value that specifies whether the property definition is inherited from a
3680
3679
  * parent entity.</p>
3680
+ * @public
3681
3681
  */
3682
3682
  isInherited: boolean | undefined;
3683
3683
  /**
3684
- * @public
3685
3684
  * <p>An object that contains the default value.</p>
3685
+ * @public
3686
3686
  */
3687
3687
  defaultValue?: DataValue;
3688
3688
  /**
3689
- * @public
3690
3689
  * <p>A mapping that specifies configuration information about the property.</p>
3690
+ * @public
3691
3691
  */
3692
3692
  configuration?: Record<string, string>;
3693
3693
  /**
3694
- * @public
3695
3694
  * <p>A friendly name for the property.</p>
3695
+ * @public
3696
3696
  */
3697
3697
  displayName?: string;
3698
3698
  }
@@ -3701,8 +3701,8 @@ export interface PropertyDefinitionResponse {
3701
3701
  */
3702
3702
  export interface BatchPutPropertyValuesResponse {
3703
3703
  /**
3704
- * @public
3705
3704
  * <p>Entries that caused errors in the batch put operation.</p>
3705
+ * @public
3706
3706
  */
3707
3707
  errorEntries: BatchPutPropertyErrorEntry[] | undefined;
3708
3708
  }
@@ -3711,19 +3711,19 @@ export interface BatchPutPropertyValuesResponse {
3711
3711
  */
3712
3712
  export interface GetPropertyValueResponse {
3713
3713
  /**
3714
- * @public
3715
3714
  * <p>An object that maps strings to the properties and latest property values in the
3716
3715
  * response. Each string in the mapping must be unique to this object.</p>
3716
+ * @public
3717
3717
  */
3718
3718
  propertyValues?: Record<string, PropertyLatestValue>;
3719
3719
  /**
3720
- * @public
3721
3720
  * <p>The string that specifies the next page of results.</p>
3721
+ * @public
3722
3722
  */
3723
3723
  nextToken?: string;
3724
3724
  /**
3725
- * @public
3726
3725
  * <p>A table of property values.</p>
3726
+ * @public
3727
3727
  */
3728
3728
  tabularPropertyValues?: Record<string, DataValue>[][];
3729
3729
  }
@@ -3732,62 +3732,62 @@ export interface GetPropertyValueResponse {
3732
3732
  */
3733
3733
  export interface CreateComponentTypeRequest {
3734
3734
  /**
3735
- * @public
3736
3735
  * <p>The ID of the workspace that contains the component type.</p>
3736
+ * @public
3737
3737
  */
3738
3738
  workspaceId: string | undefined;
3739
3739
  /**
3740
- * @public
3741
3740
  * <p>A Boolean value that specifies whether an entity can have more than one component of
3742
3741
  * this type.</p>
3742
+ * @public
3743
3743
  */
3744
3744
  isSingleton?: boolean;
3745
3745
  /**
3746
- * @public
3747
3746
  * <p>The ID of the component type.</p>
3747
+ * @public
3748
3748
  */
3749
3749
  componentTypeId: string | undefined;
3750
3750
  /**
3751
- * @public
3752
3751
  * <p>The description of the component type.</p>
3752
+ * @public
3753
3753
  */
3754
3754
  description?: string;
3755
3755
  /**
3756
- * @public
3757
3756
  * <p>An object that maps strings to the property definitions in the component type. Each
3758
3757
  * string in the mapping must be unique to this object.</p>
3758
+ * @public
3759
3759
  */
3760
3760
  propertyDefinitions?: Record<string, PropertyDefinitionRequest>;
3761
3761
  /**
3762
- * @public
3763
3762
  * <p>Specifies the parent component type to extend.</p>
3763
+ * @public
3764
3764
  */
3765
3765
  extendsFrom?: string[];
3766
3766
  /**
3767
- * @public
3768
3767
  * <p>An object that maps strings to the functions in the component type. Each string in the
3769
3768
  * mapping must be unique to this object.</p>
3769
+ * @public
3770
3770
  */
3771
3771
  functions?: Record<string, FunctionRequest>;
3772
3772
  /**
3773
- * @public
3774
3773
  * <p>Metadata that you can use to manage the component type.</p>
3774
+ * @public
3775
3775
  */
3776
3776
  tags?: Record<string, string>;
3777
3777
  /**
3778
- * @public
3779
3778
  * <p/>
3779
+ * @public
3780
3780
  */
3781
3781
  propertyGroups?: Record<string, PropertyGroupRequest>;
3782
3782
  /**
3783
- * @public
3784
3783
  * <p>A friendly name for the component type.</p>
3784
+ * @public
3785
3785
  */
3786
3786
  componentTypeName?: string;
3787
3787
  /**
3788
- * @public
3789
3788
  * <p>This is an object that maps strings to <code>compositeComponentTypes</code> of the <code>componentType</code>.
3790
3789
  * <code>CompositeComponentType</code> is referenced by <code>componentTypeId</code>.</p>
3790
+ * @public
3791
3791
  */
3792
3792
  compositeComponentTypes?: Record<string, CompositeComponentTypeRequest>;
3793
3793
  }
@@ -3796,93 +3796,93 @@ export interface CreateComponentTypeRequest {
3796
3796
  */
3797
3797
  export interface GetComponentTypeResponse {
3798
3798
  /**
3799
- * @public
3800
3799
  * <p>The ID of the workspace that contains the component type.</p>
3800
+ * @public
3801
3801
  */
3802
3802
  workspaceId: string | undefined;
3803
3803
  /**
3804
- * @public
3805
3804
  * <p>A Boolean value that specifies whether an entity can have more than one component of
3806
3805
  * this type.</p>
3806
+ * @public
3807
3807
  */
3808
3808
  isSingleton?: boolean;
3809
3809
  /**
3810
- * @public
3811
3810
  * <p>The ID of the component type.</p>
3811
+ * @public
3812
3812
  */
3813
3813
  componentTypeId: string | undefined;
3814
3814
  /**
3815
- * @public
3816
3815
  * <p>The description of the component type.</p>
3816
+ * @public
3817
3817
  */
3818
3818
  description?: string;
3819
3819
  /**
3820
- * @public
3821
3820
  * <p>An object that maps strings to the property definitions in the component type. Each
3822
3821
  * string in the mapping must be unique to this object.</p>
3822
+ * @public
3823
3823
  */
3824
3824
  propertyDefinitions?: Record<string, PropertyDefinitionResponse>;
3825
3825
  /**
3826
- * @public
3827
3826
  * <p>The name of the parent component type that this component type extends.</p>
3827
+ * @public
3828
3828
  */
3829
3829
  extendsFrom?: string[];
3830
3830
  /**
3831
- * @public
3832
3831
  * <p>An object that maps strings to the functions in the component type. Each string in the
3833
3832
  * mapping must be unique to this object.</p>
3833
+ * @public
3834
3834
  */
3835
3835
  functions?: Record<string, FunctionResponse>;
3836
3836
  /**
3837
- * @public
3838
3837
  * <p>The date and time when the component type was created.</p>
3838
+ * @public
3839
3839
  */
3840
3840
  creationDateTime: Date | undefined;
3841
3841
  /**
3842
- * @public
3843
3842
  * <p>The date and time when the component was last updated.</p>
3843
+ * @public
3844
3844
  */
3845
3845
  updateDateTime: Date | undefined;
3846
3846
  /**
3847
- * @public
3848
3847
  * <p>The ARN of the component type.</p>
3848
+ * @public
3849
3849
  */
3850
3850
  arn: string | undefined;
3851
3851
  /**
3852
- * @public
3853
3852
  * <p>A Boolean value that specifies whether the component type is abstract.</p>
3853
+ * @public
3854
3854
  */
3855
3855
  isAbstract?: boolean;
3856
3856
  /**
3857
- * @public
3858
3857
  * <p>A Boolean value that specifies whether the component type has a schema initializer and
3859
3858
  * that the schema initializer has run.</p>
3859
+ * @public
3860
3860
  */
3861
3861
  isSchemaInitialized?: boolean;
3862
3862
  /**
3863
- * @public
3864
3863
  * <p>The current status of the component type.</p>
3864
+ * @public
3865
3865
  */
3866
3866
  status?: Status;
3867
3867
  /**
3868
- * @public
3869
3868
  * <p>The maximum number of results to return at one time. The default is 25.</p>
3870
3869
  * <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
3870
+ * @public
3871
3871
  */
3872
3872
  propertyGroups?: Record<string, PropertyGroupResponse>;
3873
3873
  /**
3874
- * @public
3875
3874
  * <p>The syncSource of the SyncJob, if this entity was created by a SyncJob.</p>
3875
+ * @public
3876
3876
  */
3877
3877
  syncSource?: string;
3878
3878
  /**
3879
- * @public
3880
3879
  * <p>The component type name.</p>
3880
+ * @public
3881
3881
  */
3882
3882
  componentTypeName?: string;
3883
3883
  /**
3884
- * @public
3885
3884
  * <p>This is an object that maps strings to <code>compositeComponentTypes</code> of the <code>componentType</code>. <code>CompositeComponentType</code> is referenced by <code>componentTypeId</code>.</p>
3885
+ * @public
3886
3886
  */
3887
3887
  compositeComponentTypes?: Record<string, CompositeComponentTypeResponse>;
3888
3888
  }
@@ -3891,298 +3891,298 @@ export interface GetComponentTypeResponse {
3891
3891
  */
3892
3892
  export interface UpdateComponentTypeRequest {
3893
3893
  /**
3894
- * @public
3895
3894
  * <p>The ID of the workspace.</p>
3895
+ * @public
3896
3896
  */
3897
3897
  workspaceId: string | undefined;
3898
3898
  /**
3899
- * @public
3900
3899
  * <p>A Boolean value that specifies whether an entity can have more than one component of
3901
3900
  * this type.</p>
3901
+ * @public
3902
3902
  */
3903
3903
  isSingleton?: boolean;
3904
3904
  /**
3905
- * @public
3906
3905
  * <p>The ID of the component type.</p>
3906
+ * @public
3907
3907
  */
3908
3908
  componentTypeId: string | undefined;
3909
3909
  /**
3910
- * @public
3911
3910
  * <p>The description of the component type.</p>
3911
+ * @public
3912
3912
  */
3913
3913
  description?: string;
3914
3914
  /**
3915
- * @public
3916
3915
  * <p>An object that maps strings to the property definitions in the component type. Each
3917
3916
  * string in the mapping must be unique to this object.</p>
3917
+ * @public
3918
3918
  */
3919
3919
  propertyDefinitions?: Record<string, PropertyDefinitionRequest>;
3920
3920
  /**
3921
- * @public
3922
3921
  * <p>Specifies the component type that this component type extends.</p>
3922
+ * @public
3923
3923
  */
3924
3924
  extendsFrom?: string[];
3925
3925
  /**
3926
- * @public
3927
3926
  * <p>An object that maps strings to the functions in the component type. Each string in the
3928
3927
  * mapping must be unique to this object.</p>
3928
+ * @public
3929
3929
  */
3930
3930
  functions?: Record<string, FunctionRequest>;
3931
3931
  /**
3932
- * @public
3933
3932
  * <p>The property groups.</p>
3933
+ * @public
3934
3934
  */
3935
3935
  propertyGroups?: Record<string, PropertyGroupRequest>;
3936
3936
  /**
3937
- * @public
3938
3937
  * <p>The component type name.</p>
3938
+ * @public
3939
3939
  */
3940
3940
  componentTypeName?: string;
3941
3941
  /**
3942
- * @public
3943
3942
  * <p>This is an object that maps strings to <code>compositeComponentTypes</code> of the <code>componentType</code>.
3944
3943
  * <code>CompositeComponentType</code> is referenced by <code>componentTypeId</code>.</p>
3944
+ * @public
3945
3945
  */
3946
3946
  compositeComponentTypes?: Record<string, CompositeComponentTypeRequest>;
3947
3947
  }
3948
3948
  /**
3949
- * @public
3950
3949
  * <p>An object that sets information about a property.</p>
3950
+ * @public
3951
3951
  */
3952
3952
  export interface PropertyRequest {
3953
3953
  /**
3954
- * @public
3955
3954
  * <p>An object that specifies information about a property.</p>
3955
+ * @public
3956
3956
  */
3957
3957
  definition?: PropertyDefinitionRequest;
3958
3958
  /**
3959
- * @public
3960
3959
  * <p>The value of the property.</p>
3960
+ * @public
3961
3961
  */
3962
3962
  value?: DataValue;
3963
3963
  /**
3964
- * @public
3965
3964
  * <p>The update type of the update property request.</p>
3965
+ * @public
3966
3966
  */
3967
3967
  updateType?: PropertyUpdateType;
3968
3968
  }
3969
3969
  /**
3970
- * @public
3971
3970
  * <p>An object that contains information about a property response.</p>
3971
+ * @public
3972
3972
  */
3973
3973
  export interface PropertyResponse {
3974
3974
  /**
3975
- * @public
3976
3975
  * <p>An object that specifies information about a property.</p>
3976
+ * @public
3977
3977
  */
3978
3978
  definition?: PropertyDefinitionResponse;
3979
3979
  /**
3980
- * @public
3981
3980
  * <p>The value of the property.</p>
3981
+ * @public
3982
3982
  */
3983
3983
  value?: DataValue;
3984
3984
  /**
3985
- * @public
3986
3985
  * <p>This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.</p>
3986
+ * @public
3987
3987
  */
3988
3988
  areAllPropertyValuesReturned?: boolean;
3989
3989
  }
3990
3990
  /**
3991
- * @public
3992
3991
  * <p>This is an object that contains the information of a property.</p>
3992
+ * @public
3993
3993
  */
3994
3994
  export interface PropertySummary {
3995
3995
  /**
3996
- * @public
3997
3996
  * <p>This is the schema for the property.</p>
3997
+ * @public
3998
3998
  */
3999
3999
  definition?: PropertyDefinitionResponse;
4000
4000
  /**
4001
- * @public
4002
4001
  * <p>This is the name of the property.</p>
4002
+ * @public
4003
4003
  */
4004
4004
  propertyName: string | undefined;
4005
4005
  /**
4006
- * @public
4007
4006
  * <p>This is the value for the property.</p>
4007
+ * @public
4008
4008
  */
4009
4009
  value?: DataValue;
4010
4010
  /**
4011
- * @public
4012
4011
  * <p>This flag notes whether all values of a list or map type property are returned in the API
4013
4012
  * response. The maximum number of values per property returned is 50.</p>
4013
+ * @public
4014
4014
  */
4015
4015
  areAllPropertyValuesReturned?: boolean;
4016
4016
  }
4017
4017
  /**
4018
- * @public
4019
4018
  * <p>An object that sets information about a component type create or update request.</p>
4019
+ * @public
4020
4020
  */
4021
4021
  export interface ComponentRequest {
4022
4022
  /**
4023
- * @public
4024
4023
  * <p>The description of the component request.</p>
4024
+ * @public
4025
4025
  */
4026
4026
  description?: string;
4027
4027
  /**
4028
- * @public
4029
4028
  * <p>The ID of the component type.</p>
4029
+ * @public
4030
4030
  */
4031
4031
  componentTypeId?: string;
4032
4032
  /**
4033
- * @public
4034
4033
  * <p>An object that maps strings to the properties to set in the component type. Each string
4035
4034
  * in the mapping must be unique to this object.</p>
4035
+ * @public
4036
4036
  */
4037
4037
  properties?: Record<string, PropertyRequest>;
4038
4038
  /**
4039
- * @public
4040
4039
  * <p>The property groups.</p>
4040
+ * @public
4041
4041
  */
4042
4042
  propertyGroups?: Record<string, ComponentPropertyGroupRequest>;
4043
4043
  }
4044
4044
  /**
4045
- * @public
4046
4045
  * <p>An object that returns information about a component type create or update
4047
4046
  * request.</p>
4047
+ * @public
4048
4048
  */
4049
4049
  export interface ComponentResponse {
4050
4050
  /**
4051
- * @public
4052
4051
  * <p>The name of the component.</p>
4052
+ * @public
4053
4053
  */
4054
4054
  componentName?: string;
4055
4055
  /**
4056
- * @public
4057
4056
  * <p>The description of the component type.</p>
4057
+ * @public
4058
4058
  */
4059
4059
  description?: string;
4060
4060
  /**
4061
- * @public
4062
4061
  * <p>The ID of the component type.</p>
4062
+ * @public
4063
4063
  */
4064
4064
  componentTypeId?: string;
4065
4065
  /**
4066
- * @public
4067
4066
  * <p>The status of the component type.</p>
4067
+ * @public
4068
4068
  */
4069
4069
  status?: Status;
4070
4070
  /**
4071
- * @public
4072
4071
  * <p>The name of the property definition set in the request.</p>
4072
+ * @public
4073
4073
  */
4074
4074
  definedIn?: string;
4075
4075
  /**
4076
- * @public
4077
4076
  * <p>An object that maps strings to the properties to set in the component type. Each string
4078
4077
  * in the mapping must be unique to this object.</p>
4078
+ * @public
4079
4079
  */
4080
4080
  properties?: Record<string, PropertyResponse>;
4081
4081
  /**
4082
- * @public
4083
4082
  * <p>The property groups.</p>
4083
+ * @public
4084
4084
  */
4085
4085
  propertyGroups?: Record<string, ComponentPropertyGroupResponse>;
4086
4086
  /**
4087
- * @public
4088
4087
  * <p>The syncSource of the sync job, if this entity was created by a sync job.</p>
4088
+ * @public
4089
4089
  */
4090
4090
  syncSource?: string;
4091
4091
  /**
4092
- * @public
4093
4092
  * <p>This flag notes whether all properties of the component are returned in the API response.
4094
4093
  * The maximum number of properties returned is 800.</p>
4094
+ * @public
4095
4095
  */
4096
4096
  areAllPropertiesReturned?: boolean;
4097
4097
  /**
4098
- * @public
4099
4098
  * <p>This lists objects that contain information about the <code>compositeComponents</code>.</p>
4099
+ * @public
4100
4100
  */
4101
4101
  compositeComponents?: Record<string, ComponentSummary>;
4102
4102
  /**
4103
- * @public
4104
4103
  * <p>This flag notes whether all <code>compositeComponents</code> are returned in the API
4105
4104
  * response.</p>
4105
+ * @public
4106
4106
  */
4107
4107
  areAllCompositeComponentsReturned?: boolean;
4108
4108
  }
4109
4109
  /**
4110
- * @public
4111
4110
  * <p>The component update request.</p>
4111
+ * @public
4112
4112
  */
4113
4113
  export interface ComponentUpdateRequest {
4114
4114
  /**
4115
- * @public
4116
4115
  * <p>The update type of the component update request.</p>
4116
+ * @public
4117
4117
  */
4118
4118
  updateType?: ComponentUpdateType;
4119
4119
  /**
4120
- * @public
4121
4120
  * <p>The description of the component type.</p>
4121
+ * @public
4122
4122
  */
4123
4123
  description?: string;
4124
4124
  /**
4125
- * @public
4126
4125
  * <p>The ID of the component type.</p>
4126
+ * @public
4127
4127
  */
4128
4128
  componentTypeId?: string;
4129
4129
  /**
4130
- * @public
4131
4130
  * <p>An object that maps strings to the properties to set in the component type update. Each
4132
4131
  * string in the mapping must be unique to this object.</p>
4132
+ * @public
4133
4133
  */
4134
4134
  propertyUpdates?: Record<string, PropertyRequest>;
4135
4135
  /**
4136
- * @public
4137
4136
  * <p>The property group updates.</p>
4137
+ * @public
4138
4138
  */
4139
4139
  propertyGroupUpdates?: Record<string, ComponentPropertyGroupRequest>;
4140
4140
  }
4141
4141
  /**
4142
- * @public
4143
4142
  * <p>An object that sets information about the composite component update request.</p>
4143
+ * @public
4144
4144
  */
4145
4145
  export interface CompositeComponentRequest {
4146
4146
  /**
4147
- * @public
4148
4147
  * <p>The description of the component type.</p>
4148
+ * @public
4149
4149
  */
4150
4150
  description?: string;
4151
4151
  /**
4152
- * @public
4153
4152
  * <p>This is an object that maps strings to the properties to set in the component type. Each string in
4154
4153
  * the mapping must be unique to this object.</p>
4154
+ * @public
4155
4155
  */
4156
4156
  properties?: Record<string, PropertyRequest>;
4157
4157
  /**
4158
- * @public
4159
4158
  * <p>The property groups.</p>
4159
+ * @public
4160
4160
  */
4161
4161
  propertyGroups?: Record<string, ComponentPropertyGroupRequest>;
4162
4162
  }
4163
4163
  /**
4164
- * @public
4165
4164
  * <p>An object that sets information about the composite component update request.</p>
4165
+ * @public
4166
4166
  */
4167
4167
  export interface CompositeComponentUpdateRequest {
4168
4168
  /**
4169
- * @public
4170
4169
  * <p>The update type of the component update request.</p>
4170
+ * @public
4171
4171
  */
4172
4172
  updateType?: ComponentUpdateType;
4173
4173
  /**
4174
- * @public
4175
4174
  * <p>The description of the component type.</p>
4175
+ * @public
4176
4176
  */
4177
4177
  description?: string;
4178
4178
  /**
4179
- * @public
4180
4179
  * <p>An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.</p>
4180
+ * @public
4181
4181
  */
4182
4182
  propertyUpdates?: Record<string, PropertyRequest>;
4183
4183
  /**
4184
- * @public
4185
4184
  * <p>The property group updates.</p>
4185
+ * @public
4186
4186
  */
4187
4187
  propertyGroupUpdates?: Record<string, ComponentPropertyGroupRequest>;
4188
4188
  }
@@ -4191,13 +4191,13 @@ export interface CompositeComponentUpdateRequest {
4191
4191
  */
4192
4192
  export interface ListPropertiesResponse {
4193
4193
  /**
4194
- * @public
4195
4194
  * <p>A list of objects that contain information about the properties.</p>
4195
+ * @public
4196
4196
  */
4197
4197
  propertySummaries: PropertySummary[] | undefined;
4198
4198
  /**
4199
- * @public
4200
4199
  * <p>The string that specifies the next page of property results.</p>
4200
+ * @public
4201
4201
  */
4202
4202
  nextToken?: string;
4203
4203
  }
@@ -4206,69 +4206,69 @@ export interface ListPropertiesResponse {
4206
4206
  */
4207
4207
  export interface GetEntityResponse {
4208
4208
  /**
4209
- * @public
4210
4209
  * <p>The ID of the entity.</p>
4210
+ * @public
4211
4211
  */
4212
4212
  entityId: string | undefined;
4213
4213
  /**
4214
- * @public
4215
4214
  * <p>The name of the entity.</p>
4215
+ * @public
4216
4216
  */
4217
4217
  entityName: string | undefined;
4218
4218
  /**
4219
- * @public
4220
4219
  * <p>The ARN of the entity.</p>
4220
+ * @public
4221
4221
  */
4222
4222
  arn: string | undefined;
4223
4223
  /**
4224
- * @public
4225
4224
  * <p>The current status of the entity.</p>
4225
+ * @public
4226
4226
  */
4227
4227
  status: Status | undefined;
4228
4228
  /**
4229
- * @public
4230
4229
  * <p>The ID of the workspace.</p>
4230
+ * @public
4231
4231
  */
4232
4232
  workspaceId: string | undefined;
4233
4233
  /**
4234
- * @public
4235
4234
  * <p>The description of the entity.</p>
4235
+ * @public
4236
4236
  */
4237
4237
  description?: string;
4238
4238
  /**
4239
- * @public
4240
4239
  * <p>An object that maps strings to the components in the entity. Each string in the mapping
4241
4240
  * must be unique to this object.</p>
4241
+ * @public
4242
4242
  */
4243
4243
  components?: Record<string, ComponentResponse>;
4244
4244
  /**
4245
- * @public
4246
4245
  * <p>The ID of the parent entity for this entity.</p>
4246
+ * @public
4247
4247
  */
4248
4248
  parentEntityId: string | undefined;
4249
4249
  /**
4250
- * @public
4251
4250
  * <p>A Boolean value that specifies whether the entity has associated child entities.</p>
4251
+ * @public
4252
4252
  */
4253
4253
  hasChildEntities: boolean | undefined;
4254
4254
  /**
4255
- * @public
4256
4255
  * <p>The date and time when the entity was created.</p>
4256
+ * @public
4257
4257
  */
4258
4258
  creationDateTime: Date | undefined;
4259
4259
  /**
4260
- * @public
4261
4260
  * <p>The date and time when the entity was last updated.</p>
4261
+ * @public
4262
4262
  */
4263
4263
  updateDateTime: Date | undefined;
4264
4264
  /**
4265
- * @public
4266
4265
  * <p>The syncSource of the sync job, if this entity was created by a sync job.</p>
4266
+ * @public
4267
4267
  */
4268
4268
  syncSource?: string;
4269
4269
  /**
4270
- * @public
4271
4270
  * <p>This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.</p>
4271
+ * @public
4272
4272
  */
4273
4273
  areAllComponentsReturned?: boolean;
4274
4274
  }
@@ -4277,45 +4277,45 @@ export interface GetEntityResponse {
4277
4277
  */
4278
4278
  export interface CreateEntityRequest {
4279
4279
  /**
4280
- * @public
4281
4280
  * <p>The ID of the workspace that contains the entity.</p>
4281
+ * @public
4282
4282
  */
4283
4283
  workspaceId: string | undefined;
4284
4284
  /**
4285
- * @public
4286
4285
  * <p>The ID of the entity.</p>
4286
+ * @public
4287
4287
  */
4288
4288
  entityId?: string;
4289
4289
  /**
4290
- * @public
4291
4290
  * <p>The name of the entity.</p>
4291
+ * @public
4292
4292
  */
4293
4293
  entityName: string | undefined;
4294
4294
  /**
4295
- * @public
4296
4295
  * <p>The description of the entity.</p>
4296
+ * @public
4297
4297
  */
4298
4298
  description?: string;
4299
4299
  /**
4300
- * @public
4301
4300
  * <p>An object that maps strings to the components in the entity. Each string in the mapping
4302
4301
  * must be unique to this object.</p>
4302
+ * @public
4303
4303
  */
4304
4304
  components?: Record<string, ComponentRequest>;
4305
4305
  /**
4306
- * @public
4307
4306
  * <p>This is an object that maps strings to <code>compositeComponent</code> updates in the request.
4308
4307
  * Each key of the map represents the <code>componentPath</code> of the <code>compositeComponent</code>.</p>
4308
+ * @public
4309
4309
  */
4310
4310
  compositeComponents?: Record<string, CompositeComponentRequest>;
4311
4311
  /**
4312
- * @public
4313
4312
  * <p>The ID of the entity's parent entity.</p>
4313
+ * @public
4314
4314
  */
4315
4315
  parentEntityId?: string;
4316
4316
  /**
4317
- * @public
4318
4317
  * <p>Metadata that you can use to manage the entity.</p>
4318
+ * @public
4319
4319
  */
4320
4320
  tags?: Record<string, string>;
4321
4321
  }
@@ -4324,40 +4324,40 @@ export interface CreateEntityRequest {
4324
4324
  */
4325
4325
  export interface UpdateEntityRequest {
4326
4326
  /**
4327
- * @public
4328
4327
  * <p>The ID of the workspace that contains the entity.</p>
4328
+ * @public
4329
4329
  */
4330
4330
  workspaceId: string | undefined;
4331
4331
  /**
4332
- * @public
4333
4332
  * <p>The ID of the entity.</p>
4333
+ * @public
4334
4334
  */
4335
4335
  entityId: string | undefined;
4336
4336
  /**
4337
- * @public
4338
4337
  * <p>The name of the entity.</p>
4338
+ * @public
4339
4339
  */
4340
4340
  entityName?: string;
4341
4341
  /**
4342
- * @public
4343
4342
  * <p>The description of the entity.</p>
4343
+ * @public
4344
4344
  */
4345
4345
  description?: string;
4346
4346
  /**
4347
- * @public
4348
4347
  * <p>An object that maps strings to the component updates in the request. Each string in the
4349
4348
  * mapping must be unique to this object.</p>
4349
+ * @public
4350
4350
  */
4351
4351
  componentUpdates?: Record<string, ComponentUpdateRequest>;
4352
4352
  /**
4353
- * @public
4354
4353
  * <p>This is an object that maps strings to <code>compositeComponent</code> updates in the request. Each key
4355
4354
  * of the map represents the <code>componentPath</code> of the <code>compositeComponent</code>.</p>
4355
+ * @public
4356
4356
  */
4357
4357
  compositeComponentUpdates?: Record<string, CompositeComponentUpdateRequest>;
4358
4358
  /**
4359
- * @public
4360
4359
  * <p>An object that describes the update request for a parent entity.</p>
4360
+ * @public
4361
4361
  */
4362
4362
  parentEntityUpdate?: ParentEntityUpdateRequest;
4363
4363
  }