@aws-sdk/client-iottwinmaker 3.379.1 → 3.382.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.
- package/dist-types/models/models_0.d.ts +428 -0
- package/package.json +5 -5
|
@@ -19,19 +19,23 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
19
19
|
*/
|
|
20
20
|
export interface EntityPropertyReference {
|
|
21
21
|
/**
|
|
22
|
+
* @public
|
|
22
23
|
* <p>The name of the component.</p>
|
|
23
24
|
*/
|
|
24
25
|
componentName?: string;
|
|
25
26
|
/**
|
|
27
|
+
* @public
|
|
26
28
|
* <p>A mapping of external IDs to property names. External IDs uniquely identify properties
|
|
27
29
|
* from external data stores.</p>
|
|
28
30
|
*/
|
|
29
31
|
externalIdProperty?: Record<string, string>;
|
|
30
32
|
/**
|
|
33
|
+
* @public
|
|
31
34
|
* <p>The ID of the entity.</p>
|
|
32
35
|
*/
|
|
33
36
|
entityId?: string;
|
|
34
37
|
/**
|
|
38
|
+
* @public
|
|
35
39
|
* <p>The name of the property.</p>
|
|
36
40
|
*/
|
|
37
41
|
propertyName: string | undefined;
|
|
@@ -42,10 +46,12 @@ export interface EntityPropertyReference {
|
|
|
42
46
|
*/
|
|
43
47
|
export interface RelationshipValue {
|
|
44
48
|
/**
|
|
49
|
+
* @public
|
|
45
50
|
* <p>The ID of the target entity associated with this relationship value.</p>
|
|
46
51
|
*/
|
|
47
52
|
targetEntityId?: string;
|
|
48
53
|
/**
|
|
54
|
+
* @public
|
|
49
55
|
* <p>The name of the target component associated with the relationship value.</p>
|
|
50
56
|
*/
|
|
51
57
|
targetComponentName?: string;
|
|
@@ -116,6 +122,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
116
122
|
*/
|
|
117
123
|
export interface LambdaFunction {
|
|
118
124
|
/**
|
|
125
|
+
* @public
|
|
119
126
|
* <p>The ARN of the Lambda function.</p>
|
|
120
127
|
*/
|
|
121
128
|
arn: string | undefined;
|
|
@@ -126,10 +133,12 @@ export interface LambdaFunction {
|
|
|
126
133
|
*/
|
|
127
134
|
export interface DataConnector {
|
|
128
135
|
/**
|
|
136
|
+
* @public
|
|
129
137
|
* <p>The Lambda function associated with this data connector.</p>
|
|
130
138
|
*/
|
|
131
139
|
lambda?: LambdaFunction;
|
|
132
140
|
/**
|
|
141
|
+
* @public
|
|
133
142
|
* <p>A Boolean value that specifies whether the data connector is native to IoT
|
|
134
143
|
* TwinMaker.</p>
|
|
135
144
|
*/
|
|
@@ -153,14 +162,17 @@ export type Scope = (typeof Scope)[keyof typeof Scope];
|
|
|
153
162
|
*/
|
|
154
163
|
export interface FunctionRequest {
|
|
155
164
|
/**
|
|
165
|
+
* @public
|
|
156
166
|
* <p>The required properties of the function.</p>
|
|
157
167
|
*/
|
|
158
168
|
requiredProperties?: string[];
|
|
159
169
|
/**
|
|
170
|
+
* @public
|
|
160
171
|
* <p>The scope of the function.</p>
|
|
161
172
|
*/
|
|
162
173
|
scope?: Scope | string;
|
|
163
174
|
/**
|
|
175
|
+
* @public
|
|
164
176
|
* <p>The data connector.</p>
|
|
165
177
|
*/
|
|
166
178
|
implementedBy?: DataConnector;
|
|
@@ -171,10 +183,12 @@ export interface FunctionRequest {
|
|
|
171
183
|
*/
|
|
172
184
|
export interface Relationship {
|
|
173
185
|
/**
|
|
186
|
+
* @public
|
|
174
187
|
* <p>The ID of the target component type associated with this relationship.</p>
|
|
175
188
|
*/
|
|
176
189
|
targetComponentTypeId?: string;
|
|
177
190
|
/**
|
|
191
|
+
* @public
|
|
178
192
|
* <p>The type of the relationship.</p>
|
|
179
193
|
*/
|
|
180
194
|
relationshipType?: string;
|
|
@@ -214,10 +228,12 @@ export type GroupType = (typeof GroupType)[keyof typeof GroupType];
|
|
|
214
228
|
*/
|
|
215
229
|
export interface PropertyGroupRequest {
|
|
216
230
|
/**
|
|
231
|
+
* @public
|
|
217
232
|
* <p>The group type.</p>
|
|
218
233
|
*/
|
|
219
234
|
groupType?: GroupType | string;
|
|
220
235
|
/**
|
|
236
|
+
* @public
|
|
221
237
|
* <p>The names of properties.</p>
|
|
222
238
|
*/
|
|
223
239
|
propertyNames?: string[];
|
|
@@ -242,14 +258,17 @@ export type State = (typeof State)[keyof typeof State];
|
|
|
242
258
|
*/
|
|
243
259
|
export interface CreateComponentTypeResponse {
|
|
244
260
|
/**
|
|
261
|
+
* @public
|
|
245
262
|
* <p>The ARN of the component type.</p>
|
|
246
263
|
*/
|
|
247
264
|
arn: string | undefined;
|
|
248
265
|
/**
|
|
266
|
+
* @public
|
|
249
267
|
* <p>The date and time when the entity was created.</p>
|
|
250
268
|
*/
|
|
251
269
|
creationDateTime: Date | undefined;
|
|
252
270
|
/**
|
|
271
|
+
* @public
|
|
253
272
|
* <p>The current state of the component type.</p>
|
|
254
273
|
*/
|
|
255
274
|
state: State | string | undefined;
|
|
@@ -298,14 +317,17 @@ export type PropertyGroupUpdateType = (typeof PropertyGroupUpdateType)[keyof typ
|
|
|
298
317
|
*/
|
|
299
318
|
export interface ComponentPropertyGroupRequest {
|
|
300
319
|
/**
|
|
320
|
+
* @public
|
|
301
321
|
* <p>The group type.</p>
|
|
302
322
|
*/
|
|
303
323
|
groupType?: GroupType | string;
|
|
304
324
|
/**
|
|
325
|
+
* @public
|
|
305
326
|
* <p>The property names.</p>
|
|
306
327
|
*/
|
|
307
328
|
propertyNames?: string[];
|
|
308
329
|
/**
|
|
330
|
+
* @public
|
|
309
331
|
* <p>The update type.</p>
|
|
310
332
|
*/
|
|
311
333
|
updateType?: PropertyGroupUpdateType | string;
|
|
@@ -315,18 +337,22 @@ export interface ComponentPropertyGroupRequest {
|
|
|
315
337
|
*/
|
|
316
338
|
export interface CreateEntityResponse {
|
|
317
339
|
/**
|
|
340
|
+
* @public
|
|
318
341
|
* <p>The ID of the entity.</p>
|
|
319
342
|
*/
|
|
320
343
|
entityId: string | undefined;
|
|
321
344
|
/**
|
|
345
|
+
* @public
|
|
322
346
|
* <p>The ARN of the entity.</p>
|
|
323
347
|
*/
|
|
324
348
|
arn: string | undefined;
|
|
325
349
|
/**
|
|
350
|
+
* @public
|
|
326
351
|
* <p>The date and time when the entity was created.</p>
|
|
327
352
|
*/
|
|
328
353
|
creationDateTime: Date | undefined;
|
|
329
354
|
/**
|
|
355
|
+
* @public
|
|
330
356
|
* <p>The current state of the entity.</p>
|
|
331
357
|
*/
|
|
332
358
|
state: State | string | undefined;
|
|
@@ -336,30 +362,37 @@ export interface CreateEntityResponse {
|
|
|
336
362
|
*/
|
|
337
363
|
export interface CreateSceneRequest {
|
|
338
364
|
/**
|
|
365
|
+
* @public
|
|
339
366
|
* <p>The ID of the workspace that contains the scene.</p>
|
|
340
367
|
*/
|
|
341
368
|
workspaceId: string | undefined;
|
|
342
369
|
/**
|
|
370
|
+
* @public
|
|
343
371
|
* <p>The ID of the scene.</p>
|
|
344
372
|
*/
|
|
345
373
|
sceneId: string | undefined;
|
|
346
374
|
/**
|
|
375
|
+
* @public
|
|
347
376
|
* <p>The relative path that specifies the location of the content definition file.</p>
|
|
348
377
|
*/
|
|
349
378
|
contentLocation: string | undefined;
|
|
350
379
|
/**
|
|
380
|
+
* @public
|
|
351
381
|
* <p>The description for this scene.</p>
|
|
352
382
|
*/
|
|
353
383
|
description?: string;
|
|
354
384
|
/**
|
|
385
|
+
* @public
|
|
355
386
|
* <p>A list of capabilities that the scene uses to render itself.</p>
|
|
356
387
|
*/
|
|
357
388
|
capabilities?: string[];
|
|
358
389
|
/**
|
|
390
|
+
* @public
|
|
359
391
|
* <p>Metadata that you can use to manage the scene.</p>
|
|
360
392
|
*/
|
|
361
393
|
tags?: Record<string, string>;
|
|
362
394
|
/**
|
|
395
|
+
* @public
|
|
363
396
|
* <p>The request metadata.</p>
|
|
364
397
|
*/
|
|
365
398
|
sceneMetadata?: Record<string, string>;
|
|
@@ -369,10 +402,12 @@ export interface CreateSceneRequest {
|
|
|
369
402
|
*/
|
|
370
403
|
export interface CreateSceneResponse {
|
|
371
404
|
/**
|
|
405
|
+
* @public
|
|
372
406
|
* <p>The ARN of the scene.</p>
|
|
373
407
|
*/
|
|
374
408
|
arn: string | undefined;
|
|
375
409
|
/**
|
|
410
|
+
* @public
|
|
376
411
|
* <p>The date and time when the scene was created.</p>
|
|
377
412
|
*/
|
|
378
413
|
creationDateTime: Date | undefined;
|
|
@@ -382,10 +417,12 @@ export interface CreateSceneResponse {
|
|
|
382
417
|
*/
|
|
383
418
|
export interface CreateSyncJobRequest {
|
|
384
419
|
/**
|
|
420
|
+
* @public
|
|
385
421
|
* <p>The workspace ID.</p>
|
|
386
422
|
*/
|
|
387
423
|
workspaceId: string | undefined;
|
|
388
424
|
/**
|
|
425
|
+
* @public
|
|
389
426
|
* <p>The sync source.</p>
|
|
390
427
|
* <note>
|
|
391
428
|
* <p>Currently the only supported syncSoource is <code>SITEWISE </code>.</p>
|
|
@@ -393,11 +430,13 @@ export interface CreateSyncJobRequest {
|
|
|
393
430
|
*/
|
|
394
431
|
syncSource: string | undefined;
|
|
395
432
|
/**
|
|
433
|
+
* @public
|
|
396
434
|
* <p>The SyncJob IAM role. This IAM role is used by the SyncJob to read from the syncSource,
|
|
397
435
|
* and create, update, or delete the corresponding resources.</p>
|
|
398
436
|
*/
|
|
399
437
|
syncRole: string | undefined;
|
|
400
438
|
/**
|
|
439
|
+
* @public
|
|
401
440
|
* <p>The SyncJob tags.</p>
|
|
402
441
|
*/
|
|
403
442
|
tags?: Record<string, string>;
|
|
@@ -422,14 +461,17 @@ export type SyncJobState = (typeof SyncJobState)[keyof typeof SyncJobState];
|
|
|
422
461
|
*/
|
|
423
462
|
export interface CreateSyncJobResponse {
|
|
424
463
|
/**
|
|
464
|
+
* @public
|
|
425
465
|
* <p>The SyncJob ARN.</p>
|
|
426
466
|
*/
|
|
427
467
|
arn: string | undefined;
|
|
428
468
|
/**
|
|
469
|
+
* @public
|
|
429
470
|
* <p>The date and time for the SyncJob creation.</p>
|
|
430
471
|
*/
|
|
431
472
|
creationDateTime: Date | undefined;
|
|
432
473
|
/**
|
|
474
|
+
* @public
|
|
433
475
|
* <p>The SyncJob response state.</p>
|
|
434
476
|
*/
|
|
435
477
|
state: SyncJobState | string | undefined;
|
|
@@ -439,23 +481,28 @@ export interface CreateSyncJobResponse {
|
|
|
439
481
|
*/
|
|
440
482
|
export interface CreateWorkspaceRequest {
|
|
441
483
|
/**
|
|
484
|
+
* @public
|
|
442
485
|
* <p>The ID of the workspace.</p>
|
|
443
486
|
*/
|
|
444
487
|
workspaceId: string | undefined;
|
|
445
488
|
/**
|
|
489
|
+
* @public
|
|
446
490
|
* <p>The description of the workspace.</p>
|
|
447
491
|
*/
|
|
448
492
|
description?: string;
|
|
449
493
|
/**
|
|
494
|
+
* @public
|
|
450
495
|
* <p>The ARN of the S3 bucket where resources associated with the workspace are
|
|
451
496
|
* stored.</p>
|
|
452
497
|
*/
|
|
453
498
|
s3Location: string | undefined;
|
|
454
499
|
/**
|
|
500
|
+
* @public
|
|
455
501
|
* <p>The ARN of the execution role associated with the workspace.</p>
|
|
456
502
|
*/
|
|
457
503
|
role: string | undefined;
|
|
458
504
|
/**
|
|
505
|
+
* @public
|
|
459
506
|
* <p>Metadata that you can use to manage the workspace</p>
|
|
460
507
|
*/
|
|
461
508
|
tags?: Record<string, string>;
|
|
@@ -465,10 +512,12 @@ export interface CreateWorkspaceRequest {
|
|
|
465
512
|
*/
|
|
466
513
|
export interface CreateWorkspaceResponse {
|
|
467
514
|
/**
|
|
515
|
+
* @public
|
|
468
516
|
* <p>The ARN of the workspace.</p>
|
|
469
517
|
*/
|
|
470
518
|
arn: string | undefined;
|
|
471
519
|
/**
|
|
520
|
+
* @public
|
|
472
521
|
* <p>The date and time when the workspace was created.</p>
|
|
473
522
|
*/
|
|
474
523
|
creationDateTime: Date | undefined;
|
|
@@ -478,10 +527,12 @@ export interface CreateWorkspaceResponse {
|
|
|
478
527
|
*/
|
|
479
528
|
export interface DeleteComponentTypeRequest {
|
|
480
529
|
/**
|
|
530
|
+
* @public
|
|
481
531
|
* <p>The ID of the workspace that contains the component type.</p>
|
|
482
532
|
*/
|
|
483
533
|
workspaceId: string | undefined;
|
|
484
534
|
/**
|
|
535
|
+
* @public
|
|
485
536
|
* <p>The ID of the component type to delete.</p>
|
|
486
537
|
*/
|
|
487
538
|
componentTypeId: string | undefined;
|
|
@@ -491,6 +542,7 @@ export interface DeleteComponentTypeRequest {
|
|
|
491
542
|
*/
|
|
492
543
|
export interface DeleteComponentTypeResponse {
|
|
493
544
|
/**
|
|
545
|
+
* @public
|
|
494
546
|
* <p>The current state of the component type to be deleted.</p>
|
|
495
547
|
*/
|
|
496
548
|
state: State | string | undefined;
|
|
@@ -500,14 +552,17 @@ export interface DeleteComponentTypeResponse {
|
|
|
500
552
|
*/
|
|
501
553
|
export interface DeleteEntityRequest {
|
|
502
554
|
/**
|
|
555
|
+
* @public
|
|
503
556
|
* <p>The ID of the workspace that contains the entity to delete.</p>
|
|
504
557
|
*/
|
|
505
558
|
workspaceId: string | undefined;
|
|
506
559
|
/**
|
|
560
|
+
* @public
|
|
507
561
|
* <p>The ID of the entity to delete.</p>
|
|
508
562
|
*/
|
|
509
563
|
entityId: string | undefined;
|
|
510
564
|
/**
|
|
565
|
+
* @public
|
|
511
566
|
* <p>A Boolean value that specifies whether the operation deletes child entities.</p>
|
|
512
567
|
*/
|
|
513
568
|
isRecursive?: boolean;
|
|
@@ -517,6 +572,7 @@ export interface DeleteEntityRequest {
|
|
|
517
572
|
*/
|
|
518
573
|
export interface DeleteEntityResponse {
|
|
519
574
|
/**
|
|
575
|
+
* @public
|
|
520
576
|
* <p>The current state of the deleted entity.</p>
|
|
521
577
|
*/
|
|
522
578
|
state: State | string | undefined;
|
|
@@ -526,10 +582,12 @@ export interface DeleteEntityResponse {
|
|
|
526
582
|
*/
|
|
527
583
|
export interface DeleteSceneRequest {
|
|
528
584
|
/**
|
|
585
|
+
* @public
|
|
529
586
|
* <p>The ID of the workspace.</p>
|
|
530
587
|
*/
|
|
531
588
|
workspaceId: string | undefined;
|
|
532
589
|
/**
|
|
590
|
+
* @public
|
|
533
591
|
* <p>The ID of the scene to delete.</p>
|
|
534
592
|
*/
|
|
535
593
|
sceneId: string | undefined;
|
|
@@ -544,10 +602,12 @@ export interface DeleteSceneResponse {
|
|
|
544
602
|
*/
|
|
545
603
|
export interface DeleteSyncJobRequest {
|
|
546
604
|
/**
|
|
605
|
+
* @public
|
|
547
606
|
* <p>The workspace ID.</p>
|
|
548
607
|
*/
|
|
549
608
|
workspaceId: string | undefined;
|
|
550
609
|
/**
|
|
610
|
+
* @public
|
|
551
611
|
* <p>The sync source.</p>
|
|
552
612
|
* <note>
|
|
553
613
|
* <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p>
|
|
@@ -560,6 +620,7 @@ export interface DeleteSyncJobRequest {
|
|
|
560
620
|
*/
|
|
561
621
|
export interface DeleteSyncJobResponse {
|
|
562
622
|
/**
|
|
623
|
+
* @public
|
|
563
624
|
* <p>The SyncJob response state.</p>
|
|
564
625
|
*/
|
|
565
626
|
state: SyncJobState | string | undefined;
|
|
@@ -569,6 +630,7 @@ export interface DeleteSyncJobResponse {
|
|
|
569
630
|
*/
|
|
570
631
|
export interface DeleteWorkspaceRequest {
|
|
571
632
|
/**
|
|
633
|
+
* @public
|
|
572
634
|
* <p>The ID of the workspace to delete.</p>
|
|
573
635
|
*/
|
|
574
636
|
workspaceId: string | undefined;
|
|
@@ -583,19 +645,23 @@ export interface DeleteWorkspaceResponse {
|
|
|
583
645
|
*/
|
|
584
646
|
export interface ExecuteQueryRequest {
|
|
585
647
|
/**
|
|
648
|
+
* @public
|
|
586
649
|
* <p>The ID of the workspace.</p>
|
|
587
650
|
*/
|
|
588
651
|
workspaceId: string | undefined;
|
|
589
652
|
/**
|
|
653
|
+
* @public
|
|
590
654
|
* <p>The query statement.</p>
|
|
591
655
|
*/
|
|
592
656
|
queryStatement: string | undefined;
|
|
593
657
|
/**
|
|
658
|
+
* @public
|
|
594
659
|
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
595
660
|
* <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
|
|
596
661
|
*/
|
|
597
662
|
maxResults?: number;
|
|
598
663
|
/**
|
|
664
|
+
* @public
|
|
599
665
|
* <p>The string that specifies the next page of results.</p>
|
|
600
666
|
*/
|
|
601
667
|
nextToken?: string;
|
|
@@ -619,10 +685,12 @@ export type ColumnType = (typeof ColumnType)[keyof typeof ColumnType];
|
|
|
619
685
|
*/
|
|
620
686
|
export interface ColumnDescription {
|
|
621
687
|
/**
|
|
688
|
+
* @public
|
|
622
689
|
* <p>The name of the column description.</p>
|
|
623
690
|
*/
|
|
624
691
|
name?: string;
|
|
625
692
|
/**
|
|
693
|
+
* @public
|
|
626
694
|
* <p>The type of the column description.</p>
|
|
627
695
|
*/
|
|
628
696
|
type?: ColumnType | string;
|
|
@@ -633,6 +701,7 @@ export interface ColumnDescription {
|
|
|
633
701
|
*/
|
|
634
702
|
export interface Row {
|
|
635
703
|
/**
|
|
704
|
+
* @public
|
|
636
705
|
* <p>The data in a row of query results.</p>
|
|
637
706
|
*/
|
|
638
707
|
rowData?: __DocumentType[];
|
|
@@ -642,14 +711,17 @@ export interface Row {
|
|
|
642
711
|
*/
|
|
643
712
|
export interface ExecuteQueryResponse {
|
|
644
713
|
/**
|
|
714
|
+
* @public
|
|
645
715
|
* <p>A list of ColumnDescription objects.</p>
|
|
646
716
|
*/
|
|
647
717
|
columnDescriptions?: ColumnDescription[];
|
|
648
718
|
/**
|
|
719
|
+
* @public
|
|
649
720
|
* <p>Represents a single row in the query results.</p>
|
|
650
721
|
*/
|
|
651
722
|
rows?: Row[];
|
|
652
723
|
/**
|
|
724
|
+
* @public
|
|
653
725
|
* <p>The string that specifies the next page of results.</p>
|
|
654
726
|
*/
|
|
655
727
|
nextToken?: string;
|
|
@@ -672,10 +744,12 @@ export declare class QueryTimeoutException extends __BaseException {
|
|
|
672
744
|
*/
|
|
673
745
|
export interface GetComponentTypeRequest {
|
|
674
746
|
/**
|
|
747
|
+
* @public
|
|
675
748
|
* <p>The ID of the workspace that contains the component type.</p>
|
|
676
749
|
*/
|
|
677
750
|
workspaceId: string | undefined;
|
|
678
751
|
/**
|
|
752
|
+
* @public
|
|
679
753
|
* <p>The ID of the component type.</p>
|
|
680
754
|
*/
|
|
681
755
|
componentTypeId: string | undefined;
|
|
@@ -686,18 +760,22 @@ export interface GetComponentTypeRequest {
|
|
|
686
760
|
*/
|
|
687
761
|
export interface FunctionResponse {
|
|
688
762
|
/**
|
|
763
|
+
* @public
|
|
689
764
|
* <p>The required properties of the function.</p>
|
|
690
765
|
*/
|
|
691
766
|
requiredProperties?: string[];
|
|
692
767
|
/**
|
|
768
|
+
* @public
|
|
693
769
|
* <p>The scope of the function.</p>
|
|
694
770
|
*/
|
|
695
771
|
scope?: Scope | string;
|
|
696
772
|
/**
|
|
773
|
+
* @public
|
|
697
774
|
* <p>The data connector.</p>
|
|
698
775
|
*/
|
|
699
776
|
implementedBy?: DataConnector;
|
|
700
777
|
/**
|
|
778
|
+
* @public
|
|
701
779
|
* <p>Indicates whether this function is inherited.</p>
|
|
702
780
|
*/
|
|
703
781
|
isInherited?: boolean;
|
|
@@ -708,14 +786,17 @@ export interface FunctionResponse {
|
|
|
708
786
|
*/
|
|
709
787
|
export interface PropertyGroupResponse {
|
|
710
788
|
/**
|
|
789
|
+
* @public
|
|
711
790
|
* <p>The group types.</p>
|
|
712
791
|
*/
|
|
713
792
|
groupType: GroupType | string | undefined;
|
|
714
793
|
/**
|
|
794
|
+
* @public
|
|
715
795
|
* <p>The names of properties.</p>
|
|
716
796
|
*/
|
|
717
797
|
propertyNames: string[] | undefined;
|
|
718
798
|
/**
|
|
799
|
+
* @public
|
|
719
800
|
* <p>A Boolean value that specifies whether the property group is inherited from a parent
|
|
720
801
|
* entity</p>
|
|
721
802
|
*/
|
|
@@ -742,10 +823,12 @@ export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
|
|
|
742
823
|
*/
|
|
743
824
|
export interface ErrorDetails {
|
|
744
825
|
/**
|
|
826
|
+
* @public
|
|
745
827
|
* <p>The error code.</p>
|
|
746
828
|
*/
|
|
747
829
|
code?: ErrorCode | string;
|
|
748
830
|
/**
|
|
831
|
+
* @public
|
|
749
832
|
* <p>The error message.</p>
|
|
750
833
|
*/
|
|
751
834
|
message?: string;
|
|
@@ -757,10 +840,12 @@ export interface ErrorDetails {
|
|
|
757
840
|
*/
|
|
758
841
|
export interface Status {
|
|
759
842
|
/**
|
|
843
|
+
* @public
|
|
760
844
|
* <p>The current state of the entity, component, component type, or workspace.</p>
|
|
761
845
|
*/
|
|
762
846
|
state?: State | string;
|
|
763
847
|
/**
|
|
848
|
+
* @public
|
|
764
849
|
* <p>The error message.</p>
|
|
765
850
|
*/
|
|
766
851
|
error?: ErrorDetails;
|
|
@@ -770,10 +855,12 @@ export interface Status {
|
|
|
770
855
|
*/
|
|
771
856
|
export interface GetEntityRequest {
|
|
772
857
|
/**
|
|
858
|
+
* @public
|
|
773
859
|
* <p>The ID of the workspace.</p>
|
|
774
860
|
*/
|
|
775
861
|
workspaceId: string | undefined;
|
|
776
862
|
/**
|
|
863
|
+
* @public
|
|
777
864
|
* <p>The ID of the entity.</p>
|
|
778
865
|
*/
|
|
779
866
|
entityId: string | undefined;
|
|
@@ -784,14 +871,17 @@ export interface GetEntityRequest {
|
|
|
784
871
|
*/
|
|
785
872
|
export interface ComponentPropertyGroupResponse {
|
|
786
873
|
/**
|
|
874
|
+
* @public
|
|
787
875
|
* <p>The group type.</p>
|
|
788
876
|
*/
|
|
789
877
|
groupType: GroupType | string | undefined;
|
|
790
878
|
/**
|
|
879
|
+
* @public
|
|
791
880
|
* <p>The names of properties</p>
|
|
792
881
|
*/
|
|
793
882
|
propertyNames: string[] | undefined;
|
|
794
883
|
/**
|
|
884
|
+
* @public
|
|
795
885
|
* <p>A Boolean value that specifies whether the property group is inherited from a parent
|
|
796
886
|
* entity</p>
|
|
797
887
|
*/
|
|
@@ -822,10 +912,12 @@ export type PricingTier = (typeof PricingTier)[keyof typeof PricingTier];
|
|
|
822
912
|
*/
|
|
823
913
|
export interface BundleInformation {
|
|
824
914
|
/**
|
|
915
|
+
* @public
|
|
825
916
|
* <p>The bundle names.</p>
|
|
826
917
|
*/
|
|
827
918
|
bundleNames: string[] | undefined;
|
|
828
919
|
/**
|
|
920
|
+
* @public
|
|
829
921
|
* <p>The pricing tier.</p>
|
|
830
922
|
*/
|
|
831
923
|
pricingTier?: PricingTier | string;
|
|
@@ -864,26 +956,32 @@ export type UpdateReason = (typeof UpdateReason)[keyof typeof UpdateReason];
|
|
|
864
956
|
*/
|
|
865
957
|
export interface PricingPlan {
|
|
866
958
|
/**
|
|
959
|
+
* @public
|
|
867
960
|
* <p>The billable entity count.</p>
|
|
868
961
|
*/
|
|
869
962
|
billableEntityCount?: number;
|
|
870
963
|
/**
|
|
964
|
+
* @public
|
|
871
965
|
* <p>The pricing plan's bundle information.</p>
|
|
872
966
|
*/
|
|
873
967
|
bundleInformation?: BundleInformation;
|
|
874
968
|
/**
|
|
969
|
+
* @public
|
|
875
970
|
* <p>The effective date and time of the pricing plan.</p>
|
|
876
971
|
*/
|
|
877
972
|
effectiveDateTime: Date | undefined;
|
|
878
973
|
/**
|
|
974
|
+
* @public
|
|
879
975
|
* <p>The pricing mode.</p>
|
|
880
976
|
*/
|
|
881
977
|
pricingMode: PricingMode | string | undefined;
|
|
882
978
|
/**
|
|
979
|
+
* @public
|
|
883
980
|
* <p>The set date and time for updating a pricing plan.</p>
|
|
884
981
|
*/
|
|
885
982
|
updateDateTime: Date | undefined;
|
|
886
983
|
/**
|
|
984
|
+
* @public
|
|
887
985
|
* <p>The update reason for changing a pricing plan.</p>
|
|
888
986
|
*/
|
|
889
987
|
updateReason: UpdateReason | string | undefined;
|
|
@@ -893,10 +991,12 @@ export interface PricingPlan {
|
|
|
893
991
|
*/
|
|
894
992
|
export interface GetPricingPlanResponse {
|
|
895
993
|
/**
|
|
994
|
+
* @public
|
|
896
995
|
* <p>The chosen pricing plan for the current billing cycle.</p>
|
|
897
996
|
*/
|
|
898
997
|
currentPricingPlan: PricingPlan | undefined;
|
|
899
998
|
/**
|
|
999
|
+
* @public
|
|
900
1000
|
* <p>The pending pricing plan.</p>
|
|
901
1001
|
*/
|
|
902
1002
|
pendingPricingPlan?: PricingPlan;
|
|
@@ -944,10 +1044,12 @@ export type Order = (typeof Order)[keyof typeof Order];
|
|
|
944
1044
|
*/
|
|
945
1045
|
export interface OrderBy {
|
|
946
1046
|
/**
|
|
1047
|
+
* @public
|
|
947
1048
|
* <p>The set order that filters results.</p>
|
|
948
1049
|
*/
|
|
949
1050
|
order?: Order | string;
|
|
950
1051
|
/**
|
|
1052
|
+
* @public
|
|
951
1053
|
* <p>The property name.</p>
|
|
952
1054
|
*/
|
|
953
1055
|
propertyName: string | undefined;
|
|
@@ -969,10 +1071,12 @@ export type InterpolationType = (typeof InterpolationType)[keyof typeof Interpol
|
|
|
969
1071
|
*/
|
|
970
1072
|
export interface InterpolationParameters {
|
|
971
1073
|
/**
|
|
1074
|
+
* @public
|
|
972
1075
|
* <p>The interpolation type.</p>
|
|
973
1076
|
*/
|
|
974
1077
|
interpolationType?: InterpolationType | string;
|
|
975
1078
|
/**
|
|
1079
|
+
* @public
|
|
976
1080
|
* <p>The interpolation time interval in seconds.</p>
|
|
977
1081
|
*/
|
|
978
1082
|
intervalInSeconds?: number;
|
|
@@ -994,10 +1098,12 @@ export type OrderByTime = (typeof OrderByTime)[keyof typeof OrderByTime];
|
|
|
994
1098
|
*/
|
|
995
1099
|
export interface GetSceneRequest {
|
|
996
1100
|
/**
|
|
1101
|
+
* @public
|
|
997
1102
|
* <p>The ID of the workspace that contains the scene.</p>
|
|
998
1103
|
*/
|
|
999
1104
|
workspaceId: string | undefined;
|
|
1000
1105
|
/**
|
|
1106
|
+
* @public
|
|
1001
1107
|
* <p>The ID of the scene.</p>
|
|
1002
1108
|
*/
|
|
1003
1109
|
sceneId: string | undefined;
|
|
@@ -1019,10 +1125,12 @@ export type SceneErrorCode = (typeof SceneErrorCode)[keyof typeof SceneErrorCode
|
|
|
1019
1125
|
*/
|
|
1020
1126
|
export interface SceneError {
|
|
1021
1127
|
/**
|
|
1128
|
+
* @public
|
|
1022
1129
|
* <p>The SceneError code.</p>
|
|
1023
1130
|
*/
|
|
1024
1131
|
code?: SceneErrorCode | string;
|
|
1025
1132
|
/**
|
|
1133
|
+
* @public
|
|
1026
1134
|
* <p>The SceneError message.</p>
|
|
1027
1135
|
*/
|
|
1028
1136
|
message?: string;
|
|
@@ -1032,46 +1140,57 @@ export interface SceneError {
|
|
|
1032
1140
|
*/
|
|
1033
1141
|
export interface GetSceneResponse {
|
|
1034
1142
|
/**
|
|
1143
|
+
* @public
|
|
1035
1144
|
* <p>The ID of the workspace that contains the scene.</p>
|
|
1036
1145
|
*/
|
|
1037
1146
|
workspaceId: string | undefined;
|
|
1038
1147
|
/**
|
|
1148
|
+
* @public
|
|
1039
1149
|
* <p>The ID of the scene.</p>
|
|
1040
1150
|
*/
|
|
1041
1151
|
sceneId: string | undefined;
|
|
1042
1152
|
/**
|
|
1153
|
+
* @public
|
|
1043
1154
|
* <p>The relative path that specifies the location of the content definition file.</p>
|
|
1044
1155
|
*/
|
|
1045
1156
|
contentLocation: string | undefined;
|
|
1046
1157
|
/**
|
|
1158
|
+
* @public
|
|
1047
1159
|
* <p>The ARN of the scene.</p>
|
|
1048
1160
|
*/
|
|
1049
1161
|
arn: string | undefined;
|
|
1050
1162
|
/**
|
|
1163
|
+
* @public
|
|
1051
1164
|
* <p>The date and time when the scene was created.</p>
|
|
1052
1165
|
*/
|
|
1053
1166
|
creationDateTime: Date | undefined;
|
|
1054
1167
|
/**
|
|
1168
|
+
* @public
|
|
1055
1169
|
* <p>The date and time when the scene was last updated.</p>
|
|
1056
1170
|
*/
|
|
1057
1171
|
updateDateTime: Date | undefined;
|
|
1058
1172
|
/**
|
|
1173
|
+
* @public
|
|
1059
1174
|
* <p>The description of the scene.</p>
|
|
1060
1175
|
*/
|
|
1061
1176
|
description?: string;
|
|
1062
1177
|
/**
|
|
1178
|
+
* @public
|
|
1063
1179
|
* <p>A list of capabilities that the scene uses to render.</p>
|
|
1064
1180
|
*/
|
|
1065
1181
|
capabilities?: string[];
|
|
1066
1182
|
/**
|
|
1183
|
+
* @public
|
|
1067
1184
|
* <p>The response metadata.</p>
|
|
1068
1185
|
*/
|
|
1069
1186
|
sceneMetadata?: Record<string, string>;
|
|
1070
1187
|
/**
|
|
1188
|
+
* @public
|
|
1071
1189
|
* <p>The generated scene metadata.</p>
|
|
1072
1190
|
*/
|
|
1073
1191
|
generatedSceneMetadata?: Record<string, string>;
|
|
1074
1192
|
/**
|
|
1193
|
+
* @public
|
|
1075
1194
|
* <p>The SceneResponse error.</p>
|
|
1076
1195
|
*/
|
|
1077
1196
|
error?: SceneError;
|
|
@@ -1081,6 +1200,7 @@ export interface GetSceneResponse {
|
|
|
1081
1200
|
*/
|
|
1082
1201
|
export interface GetSyncJobRequest {
|
|
1083
1202
|
/**
|
|
1203
|
+
* @public
|
|
1084
1204
|
* <p>The sync source.</p>
|
|
1085
1205
|
* <note>
|
|
1086
1206
|
* <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p>
|
|
@@ -1088,6 +1208,7 @@ export interface GetSyncJobRequest {
|
|
|
1088
1208
|
*/
|
|
1089
1209
|
syncSource: string | undefined;
|
|
1090
1210
|
/**
|
|
1211
|
+
* @public
|
|
1091
1212
|
* <p>The workspace ID.</p>
|
|
1092
1213
|
*/
|
|
1093
1214
|
workspaceId?: string;
|
|
@@ -1098,10 +1219,12 @@ export interface GetSyncJobRequest {
|
|
|
1098
1219
|
*/
|
|
1099
1220
|
export interface SyncJobStatus {
|
|
1100
1221
|
/**
|
|
1222
|
+
* @public
|
|
1101
1223
|
* <p>The SyncJob status state.</p>
|
|
1102
1224
|
*/
|
|
1103
1225
|
state?: SyncJobState | string;
|
|
1104
1226
|
/**
|
|
1227
|
+
* @public
|
|
1105
1228
|
* <p>The SyncJob error.</p>
|
|
1106
1229
|
*/
|
|
1107
1230
|
error?: ErrorDetails;
|
|
@@ -1111,14 +1234,17 @@ export interface SyncJobStatus {
|
|
|
1111
1234
|
*/
|
|
1112
1235
|
export interface GetSyncJobResponse {
|
|
1113
1236
|
/**
|
|
1237
|
+
* @public
|
|
1114
1238
|
* <p>The sync job ARN.</p>
|
|
1115
1239
|
*/
|
|
1116
1240
|
arn: string | undefined;
|
|
1117
1241
|
/**
|
|
1242
|
+
* @public
|
|
1118
1243
|
* <p>The ID of the workspace that contains the sync job.</p>
|
|
1119
1244
|
*/
|
|
1120
1245
|
workspaceId: string | undefined;
|
|
1121
1246
|
/**
|
|
1247
|
+
* @public
|
|
1122
1248
|
* <p>The sync soucre.</p>
|
|
1123
1249
|
* <note>
|
|
1124
1250
|
* <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p>
|
|
@@ -1126,18 +1252,22 @@ export interface GetSyncJobResponse {
|
|
|
1126
1252
|
*/
|
|
1127
1253
|
syncSource: string | undefined;
|
|
1128
1254
|
/**
|
|
1255
|
+
* @public
|
|
1129
1256
|
* <p>The sync IAM role.</p>
|
|
1130
1257
|
*/
|
|
1131
1258
|
syncRole: string | undefined;
|
|
1132
1259
|
/**
|
|
1260
|
+
* @public
|
|
1133
1261
|
* <p>The SyncJob response status.</p>
|
|
1134
1262
|
*/
|
|
1135
1263
|
status: SyncJobStatus | undefined;
|
|
1136
1264
|
/**
|
|
1265
|
+
* @public
|
|
1137
1266
|
* <p>The creation date and time.</p>
|
|
1138
1267
|
*/
|
|
1139
1268
|
creationDateTime: Date | undefined;
|
|
1140
1269
|
/**
|
|
1270
|
+
* @public
|
|
1141
1271
|
* <p>The update date and time.</p>
|
|
1142
1272
|
*/
|
|
1143
1273
|
updateDateTime: Date | undefined;
|
|
@@ -1147,6 +1277,7 @@ export interface GetSyncJobResponse {
|
|
|
1147
1277
|
*/
|
|
1148
1278
|
export interface GetWorkspaceRequest {
|
|
1149
1279
|
/**
|
|
1280
|
+
* @public
|
|
1150
1281
|
* <p>The ID of the workspace.</p>
|
|
1151
1282
|
*/
|
|
1152
1283
|
workspaceId: string | undefined;
|
|
@@ -1156,31 +1287,38 @@ export interface GetWorkspaceRequest {
|
|
|
1156
1287
|
*/
|
|
1157
1288
|
export interface GetWorkspaceResponse {
|
|
1158
1289
|
/**
|
|
1290
|
+
* @public
|
|
1159
1291
|
* <p>The ID of the workspace.</p>
|
|
1160
1292
|
*/
|
|
1161
1293
|
workspaceId: string | undefined;
|
|
1162
1294
|
/**
|
|
1295
|
+
* @public
|
|
1163
1296
|
* <p>The ARN of the workspace.</p>
|
|
1164
1297
|
*/
|
|
1165
1298
|
arn: string | undefined;
|
|
1166
1299
|
/**
|
|
1300
|
+
* @public
|
|
1167
1301
|
* <p>The description of the workspace.</p>
|
|
1168
1302
|
*/
|
|
1169
1303
|
description?: string;
|
|
1170
1304
|
/**
|
|
1305
|
+
* @public
|
|
1171
1306
|
* <p>The ARN of the S3 bucket where resources associated with the workspace are
|
|
1172
1307
|
* stored.</p>
|
|
1173
1308
|
*/
|
|
1174
1309
|
s3Location: string | undefined;
|
|
1175
1310
|
/**
|
|
1311
|
+
* @public
|
|
1176
1312
|
* <p>The ARN of the execution role associated with the workspace.</p>
|
|
1177
1313
|
*/
|
|
1178
1314
|
role: string | undefined;
|
|
1179
1315
|
/**
|
|
1316
|
+
* @public
|
|
1180
1317
|
* <p>The date and time when the workspace was created.</p>
|
|
1181
1318
|
*/
|
|
1182
1319
|
creationDateTime: Date | undefined;
|
|
1183
1320
|
/**
|
|
1321
|
+
* @public
|
|
1184
1322
|
* <p>The date and time when the workspace was last updated.</p>
|
|
1185
1323
|
*/
|
|
1186
1324
|
updateDateTime: Date | undefined;
|
|
@@ -1198,6 +1336,7 @@ export type ListComponentTypesFilter = ListComponentTypesFilter.ExtendsFromMembe
|
|
|
1198
1336
|
*/
|
|
1199
1337
|
export declare namespace ListComponentTypesFilter {
|
|
1200
1338
|
/**
|
|
1339
|
+
* @public
|
|
1201
1340
|
* <p>The component type that the component types in the list extend.</p>
|
|
1202
1341
|
*/
|
|
1203
1342
|
interface ExtendsFromMember {
|
|
@@ -1207,6 +1346,7 @@ export declare namespace ListComponentTypesFilter {
|
|
|
1207
1346
|
$unknown?: never;
|
|
1208
1347
|
}
|
|
1209
1348
|
/**
|
|
1349
|
+
* @public
|
|
1210
1350
|
* <p>The namespace to which the component types in the list belong.</p>
|
|
1211
1351
|
*/
|
|
1212
1352
|
interface NamespaceMember {
|
|
@@ -1216,6 +1356,7 @@ export declare namespace ListComponentTypesFilter {
|
|
|
1216
1356
|
$unknown?: never;
|
|
1217
1357
|
}
|
|
1218
1358
|
/**
|
|
1359
|
+
* @public
|
|
1219
1360
|
* <p>A Boolean value that specifies whether the component types in the list are
|
|
1220
1361
|
* abstract.</p>
|
|
1221
1362
|
*/
|
|
@@ -1225,6 +1366,9 @@ export declare namespace ListComponentTypesFilter {
|
|
|
1225
1366
|
isAbstract: boolean;
|
|
1226
1367
|
$unknown?: never;
|
|
1227
1368
|
}
|
|
1369
|
+
/**
|
|
1370
|
+
* @public
|
|
1371
|
+
*/
|
|
1228
1372
|
interface $UnknownMember {
|
|
1229
1373
|
extendsFrom?: never;
|
|
1230
1374
|
namespace?: never;
|
|
@@ -1244,18 +1388,22 @@ export declare namespace ListComponentTypesFilter {
|
|
|
1244
1388
|
*/
|
|
1245
1389
|
export interface ListComponentTypesRequest {
|
|
1246
1390
|
/**
|
|
1391
|
+
* @public
|
|
1247
1392
|
* <p>The ID of the workspace.</p>
|
|
1248
1393
|
*/
|
|
1249
1394
|
workspaceId: string | undefined;
|
|
1250
1395
|
/**
|
|
1396
|
+
* @public
|
|
1251
1397
|
* <p>A list of objects that filter the request.</p>
|
|
1252
1398
|
*/
|
|
1253
1399
|
filters?: ListComponentTypesFilter[];
|
|
1254
1400
|
/**
|
|
1401
|
+
* @public
|
|
1255
1402
|
* <p>The string that specifies the next page of results.</p>
|
|
1256
1403
|
*/
|
|
1257
1404
|
nextToken?: string;
|
|
1258
1405
|
/**
|
|
1406
|
+
* @public
|
|
1259
1407
|
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
1260
1408
|
* <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
|
|
1261
1409
|
*/
|
|
@@ -1267,30 +1415,37 @@ export interface ListComponentTypesRequest {
|
|
|
1267
1415
|
*/
|
|
1268
1416
|
export interface ComponentTypeSummary {
|
|
1269
1417
|
/**
|
|
1418
|
+
* @public
|
|
1270
1419
|
* <p>The ARN of the component type.</p>
|
|
1271
1420
|
*/
|
|
1272
1421
|
arn: string | undefined;
|
|
1273
1422
|
/**
|
|
1423
|
+
* @public
|
|
1274
1424
|
* <p>The ID of the component type.</p>
|
|
1275
1425
|
*/
|
|
1276
1426
|
componentTypeId: string | undefined;
|
|
1277
1427
|
/**
|
|
1428
|
+
* @public
|
|
1278
1429
|
* <p>The date and time when the component type was created.</p>
|
|
1279
1430
|
*/
|
|
1280
1431
|
creationDateTime: Date | undefined;
|
|
1281
1432
|
/**
|
|
1433
|
+
* @public
|
|
1282
1434
|
* <p>The date and time when the component type was last updated.</p>
|
|
1283
1435
|
*/
|
|
1284
1436
|
updateDateTime: Date | undefined;
|
|
1285
1437
|
/**
|
|
1438
|
+
* @public
|
|
1286
1439
|
* <p>The description of the component type.</p>
|
|
1287
1440
|
*/
|
|
1288
1441
|
description?: string;
|
|
1289
1442
|
/**
|
|
1443
|
+
* @public
|
|
1290
1444
|
* <p>The current status of the component type.</p>
|
|
1291
1445
|
*/
|
|
1292
1446
|
status?: Status;
|
|
1293
1447
|
/**
|
|
1448
|
+
* @public
|
|
1294
1449
|
* <p>The component type name.</p>
|
|
1295
1450
|
*/
|
|
1296
1451
|
componentTypeName?: string;
|
|
@@ -1300,18 +1455,22 @@ export interface ComponentTypeSummary {
|
|
|
1300
1455
|
*/
|
|
1301
1456
|
export interface ListComponentTypesResponse {
|
|
1302
1457
|
/**
|
|
1458
|
+
* @public
|
|
1303
1459
|
* <p>The ID of the workspace.</p>
|
|
1304
1460
|
*/
|
|
1305
1461
|
workspaceId: string | undefined;
|
|
1306
1462
|
/**
|
|
1463
|
+
* @public
|
|
1307
1464
|
* <p>A list of objects that contain information about the component types.</p>
|
|
1308
1465
|
*/
|
|
1309
1466
|
componentTypeSummaries: ComponentTypeSummary[] | undefined;
|
|
1310
1467
|
/**
|
|
1468
|
+
* @public
|
|
1311
1469
|
* <p>The string that specifies the next page of results.</p>
|
|
1312
1470
|
*/
|
|
1313
1471
|
nextToken?: string;
|
|
1314
1472
|
/**
|
|
1473
|
+
* @public
|
|
1315
1474
|
* <p>Specifies the maximum number of results to display.</p>
|
|
1316
1475
|
*/
|
|
1317
1476
|
maxResults?: number;
|
|
@@ -1326,6 +1485,7 @@ export type ListEntitiesFilter = ListEntitiesFilter.ComponentTypeIdMember | List
|
|
|
1326
1485
|
*/
|
|
1327
1486
|
export declare namespace ListEntitiesFilter {
|
|
1328
1487
|
/**
|
|
1488
|
+
* @public
|
|
1329
1489
|
* <p>The parent of the entities in the list.</p>
|
|
1330
1490
|
*/
|
|
1331
1491
|
interface ParentEntityIdMember {
|
|
@@ -1335,6 +1495,7 @@ export declare namespace ListEntitiesFilter {
|
|
|
1335
1495
|
$unknown?: never;
|
|
1336
1496
|
}
|
|
1337
1497
|
/**
|
|
1498
|
+
* @public
|
|
1338
1499
|
* <p>The ID of the component type in the entities in the list.</p>
|
|
1339
1500
|
*/
|
|
1340
1501
|
interface ComponentTypeIdMember {
|
|
@@ -1344,6 +1505,7 @@ export declare namespace ListEntitiesFilter {
|
|
|
1344
1505
|
$unknown?: never;
|
|
1345
1506
|
}
|
|
1346
1507
|
/**
|
|
1508
|
+
* @public
|
|
1347
1509
|
* <p>The external-Id property of a component. The external-Id property is the primary key of
|
|
1348
1510
|
* an external storage system.</p>
|
|
1349
1511
|
*/
|
|
@@ -1353,6 +1515,9 @@ export declare namespace ListEntitiesFilter {
|
|
|
1353
1515
|
externalId: string;
|
|
1354
1516
|
$unknown?: never;
|
|
1355
1517
|
}
|
|
1518
|
+
/**
|
|
1519
|
+
* @public
|
|
1520
|
+
*/
|
|
1356
1521
|
interface $UnknownMember {
|
|
1357
1522
|
parentEntityId?: never;
|
|
1358
1523
|
componentTypeId?: never;
|
|
@@ -1372,10 +1537,12 @@ export declare namespace ListEntitiesFilter {
|
|
|
1372
1537
|
*/
|
|
1373
1538
|
export interface ListEntitiesRequest {
|
|
1374
1539
|
/**
|
|
1540
|
+
* @public
|
|
1375
1541
|
* <p>The ID of the workspace.</p>
|
|
1376
1542
|
*/
|
|
1377
1543
|
workspaceId: string | undefined;
|
|
1378
1544
|
/**
|
|
1545
|
+
* @public
|
|
1379
1546
|
* <p>A list of objects that filter the request.</p>
|
|
1380
1547
|
* <note>
|
|
1381
1548
|
* <p>Only one object is accepted as a valid input.</p>
|
|
@@ -1383,11 +1550,13 @@ export interface ListEntitiesRequest {
|
|
|
1383
1550
|
*/
|
|
1384
1551
|
filters?: ListEntitiesFilter[];
|
|
1385
1552
|
/**
|
|
1553
|
+
* @public
|
|
1386
1554
|
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
1387
1555
|
* <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
|
|
1388
1556
|
*/
|
|
1389
1557
|
maxResults?: number;
|
|
1390
1558
|
/**
|
|
1559
|
+
* @public
|
|
1391
1560
|
* <p>The string that specifies the next page of results.</p>
|
|
1392
1561
|
*/
|
|
1393
1562
|
nextToken?: string;
|
|
@@ -1398,38 +1567,47 @@ export interface ListEntitiesRequest {
|
|
|
1398
1567
|
*/
|
|
1399
1568
|
export interface EntitySummary {
|
|
1400
1569
|
/**
|
|
1570
|
+
* @public
|
|
1401
1571
|
* <p>The ID of the entity.</p>
|
|
1402
1572
|
*/
|
|
1403
1573
|
entityId: string | undefined;
|
|
1404
1574
|
/**
|
|
1575
|
+
* @public
|
|
1405
1576
|
* <p>The name of the entity.</p>
|
|
1406
1577
|
*/
|
|
1407
1578
|
entityName: string | undefined;
|
|
1408
1579
|
/**
|
|
1580
|
+
* @public
|
|
1409
1581
|
* <p>The ARN of the entity.</p>
|
|
1410
1582
|
*/
|
|
1411
1583
|
arn: string | undefined;
|
|
1412
1584
|
/**
|
|
1585
|
+
* @public
|
|
1413
1586
|
* <p>The ID of the parent entity.</p>
|
|
1414
1587
|
*/
|
|
1415
1588
|
parentEntityId?: string;
|
|
1416
1589
|
/**
|
|
1590
|
+
* @public
|
|
1417
1591
|
* <p>The current status of the entity.</p>
|
|
1418
1592
|
*/
|
|
1419
1593
|
status: Status | undefined;
|
|
1420
1594
|
/**
|
|
1595
|
+
* @public
|
|
1421
1596
|
* <p>The description of the entity.</p>
|
|
1422
1597
|
*/
|
|
1423
1598
|
description?: string;
|
|
1424
1599
|
/**
|
|
1600
|
+
* @public
|
|
1425
1601
|
* <p>A Boolean value that specifies whether the entity has child entities or not.</p>
|
|
1426
1602
|
*/
|
|
1427
1603
|
hasChildEntities?: boolean;
|
|
1428
1604
|
/**
|
|
1605
|
+
* @public
|
|
1429
1606
|
* <p>The date and time when the entity was created.</p>
|
|
1430
1607
|
*/
|
|
1431
1608
|
creationDateTime: Date | undefined;
|
|
1432
1609
|
/**
|
|
1610
|
+
* @public
|
|
1433
1611
|
* <p>The last date and time when the entity was updated.</p>
|
|
1434
1612
|
*/
|
|
1435
1613
|
updateDateTime: Date | undefined;
|
|
@@ -1439,10 +1617,12 @@ export interface EntitySummary {
|
|
|
1439
1617
|
*/
|
|
1440
1618
|
export interface ListEntitiesResponse {
|
|
1441
1619
|
/**
|
|
1620
|
+
* @public
|
|
1442
1621
|
* <p>A list of objects that contain information about the entities.</p>
|
|
1443
1622
|
*/
|
|
1444
1623
|
entitySummaries?: EntitySummary[];
|
|
1445
1624
|
/**
|
|
1625
|
+
* @public
|
|
1446
1626
|
* <p>The string that specifies the next page of results.</p>
|
|
1447
1627
|
*/
|
|
1448
1628
|
nextToken?: string;
|
|
@@ -1452,14 +1632,17 @@ export interface ListEntitiesResponse {
|
|
|
1452
1632
|
*/
|
|
1453
1633
|
export interface ListScenesRequest {
|
|
1454
1634
|
/**
|
|
1635
|
+
* @public
|
|
1455
1636
|
* <p>The ID of the workspace that contains the scenes.</p>
|
|
1456
1637
|
*/
|
|
1457
1638
|
workspaceId: string | undefined;
|
|
1458
1639
|
/**
|
|
1640
|
+
* @public
|
|
1459
1641
|
* <p>Specifies the maximum number of results to display.</p>
|
|
1460
1642
|
*/
|
|
1461
1643
|
maxResults?: number;
|
|
1462
1644
|
/**
|
|
1645
|
+
* @public
|
|
1463
1646
|
* <p>The string that specifies the next page of results.</p>
|
|
1464
1647
|
*/
|
|
1465
1648
|
nextToken?: string;
|
|
@@ -1470,26 +1653,32 @@ export interface ListScenesRequest {
|
|
|
1470
1653
|
*/
|
|
1471
1654
|
export interface SceneSummary {
|
|
1472
1655
|
/**
|
|
1656
|
+
* @public
|
|
1473
1657
|
* <p>The ID of the scene.</p>
|
|
1474
1658
|
*/
|
|
1475
1659
|
sceneId: string | undefined;
|
|
1476
1660
|
/**
|
|
1661
|
+
* @public
|
|
1477
1662
|
* <p>The relative path that specifies the location of the content definition file.</p>
|
|
1478
1663
|
*/
|
|
1479
1664
|
contentLocation: string | undefined;
|
|
1480
1665
|
/**
|
|
1666
|
+
* @public
|
|
1481
1667
|
* <p>The ARN of the scene.</p>
|
|
1482
1668
|
*/
|
|
1483
1669
|
arn: string | undefined;
|
|
1484
1670
|
/**
|
|
1671
|
+
* @public
|
|
1485
1672
|
* <p>The date and time when the scene was created.</p>
|
|
1486
1673
|
*/
|
|
1487
1674
|
creationDateTime: Date | undefined;
|
|
1488
1675
|
/**
|
|
1676
|
+
* @public
|
|
1489
1677
|
* <p>The date and time when the scene was last updated.</p>
|
|
1490
1678
|
*/
|
|
1491
1679
|
updateDateTime: Date | undefined;
|
|
1492
1680
|
/**
|
|
1681
|
+
* @public
|
|
1493
1682
|
* <p>The scene description.</p>
|
|
1494
1683
|
*/
|
|
1495
1684
|
description?: string;
|
|
@@ -1499,10 +1688,12 @@ export interface SceneSummary {
|
|
|
1499
1688
|
*/
|
|
1500
1689
|
export interface ListScenesResponse {
|
|
1501
1690
|
/**
|
|
1691
|
+
* @public
|
|
1502
1692
|
* <p>A list of objects that contain information about the scenes.</p>
|
|
1503
1693
|
*/
|
|
1504
1694
|
sceneSummaries?: SceneSummary[];
|
|
1505
1695
|
/**
|
|
1696
|
+
* @public
|
|
1506
1697
|
* <p>The string that specifies the next page of results.</p>
|
|
1507
1698
|
*/
|
|
1508
1699
|
nextToken?: string;
|
|
@@ -1512,15 +1703,18 @@ export interface ListScenesResponse {
|
|
|
1512
1703
|
*/
|
|
1513
1704
|
export interface ListSyncJobsRequest {
|
|
1514
1705
|
/**
|
|
1706
|
+
* @public
|
|
1515
1707
|
* <p>The ID of the workspace that contains the sync job.</p>
|
|
1516
1708
|
*/
|
|
1517
1709
|
workspaceId: string | undefined;
|
|
1518
1710
|
/**
|
|
1711
|
+
* @public
|
|
1519
1712
|
* <p>The maximum number of results to return at one time. The default is 50.</p>
|
|
1520
1713
|
* <p>Valid Range: Minimum value of 0. Maximum value of 200.</p>
|
|
1521
1714
|
*/
|
|
1522
1715
|
maxResults?: number;
|
|
1523
1716
|
/**
|
|
1717
|
+
* @public
|
|
1524
1718
|
* <p>The string that specifies the next page of results.</p>
|
|
1525
1719
|
*/
|
|
1526
1720
|
nextToken?: string;
|
|
@@ -1531,26 +1725,32 @@ export interface ListSyncJobsRequest {
|
|
|
1531
1725
|
*/
|
|
1532
1726
|
export interface SyncJobSummary {
|
|
1533
1727
|
/**
|
|
1728
|
+
* @public
|
|
1534
1729
|
* <p>The SyncJob summary ARN.</p>
|
|
1535
1730
|
*/
|
|
1536
1731
|
arn?: string;
|
|
1537
1732
|
/**
|
|
1733
|
+
* @public
|
|
1538
1734
|
* <p>The ID of the workspace that contains the sync job.</p>
|
|
1539
1735
|
*/
|
|
1540
1736
|
workspaceId?: string;
|
|
1541
1737
|
/**
|
|
1738
|
+
* @public
|
|
1542
1739
|
* <p>The sync source.</p>
|
|
1543
1740
|
*/
|
|
1544
1741
|
syncSource?: string;
|
|
1545
1742
|
/**
|
|
1743
|
+
* @public
|
|
1546
1744
|
* <p>The SyncJob summaries status.</p>
|
|
1547
1745
|
*/
|
|
1548
1746
|
status?: SyncJobStatus;
|
|
1549
1747
|
/**
|
|
1748
|
+
* @public
|
|
1550
1749
|
* <p>The creation date and time.</p>
|
|
1551
1750
|
*/
|
|
1552
1751
|
creationDateTime?: Date;
|
|
1553
1752
|
/**
|
|
1753
|
+
* @public
|
|
1554
1754
|
* <p>The update date and time.</p>
|
|
1555
1755
|
*/
|
|
1556
1756
|
updateDateTime?: Date;
|
|
@@ -1560,10 +1760,12 @@ export interface SyncJobSummary {
|
|
|
1560
1760
|
*/
|
|
1561
1761
|
export interface ListSyncJobsResponse {
|
|
1562
1762
|
/**
|
|
1763
|
+
* @public
|
|
1563
1764
|
* <p>The listed SyncJob summaries.</p>
|
|
1564
1765
|
*/
|
|
1565
1766
|
syncJobSummaries?: SyncJobSummary[];
|
|
1566
1767
|
/**
|
|
1768
|
+
* @public
|
|
1567
1769
|
* <p>The string that specifies the next page of results.</p>
|
|
1568
1770
|
*/
|
|
1569
1771
|
nextToken?: string;
|
|
@@ -1605,6 +1807,7 @@ export type SyncResourceFilter = SyncResourceFilter.ExternalIdMember | SyncResou
|
|
|
1605
1807
|
*/
|
|
1606
1808
|
export declare namespace SyncResourceFilter {
|
|
1607
1809
|
/**
|
|
1810
|
+
* @public
|
|
1608
1811
|
* <p>The sync resource filter's state.</p>
|
|
1609
1812
|
*/
|
|
1610
1813
|
interface StateMember {
|
|
@@ -1615,6 +1818,7 @@ export declare namespace SyncResourceFilter {
|
|
|
1615
1818
|
$unknown?: never;
|
|
1616
1819
|
}
|
|
1617
1820
|
/**
|
|
1821
|
+
* @public
|
|
1618
1822
|
* <p>The sync resource filter resource type</p>
|
|
1619
1823
|
*/
|
|
1620
1824
|
interface ResourceTypeMember {
|
|
@@ -1625,6 +1829,7 @@ export declare namespace SyncResourceFilter {
|
|
|
1625
1829
|
$unknown?: never;
|
|
1626
1830
|
}
|
|
1627
1831
|
/**
|
|
1832
|
+
* @public
|
|
1628
1833
|
* <p>The sync resource filter resource ID.</p>
|
|
1629
1834
|
*/
|
|
1630
1835
|
interface ResourceIdMember {
|
|
@@ -1635,6 +1840,7 @@ export declare namespace SyncResourceFilter {
|
|
|
1635
1840
|
$unknown?: never;
|
|
1636
1841
|
}
|
|
1637
1842
|
/**
|
|
1843
|
+
* @public
|
|
1638
1844
|
* <p>The external ID.</p>
|
|
1639
1845
|
*/
|
|
1640
1846
|
interface ExternalIdMember {
|
|
@@ -1644,6 +1850,9 @@ export declare namespace SyncResourceFilter {
|
|
|
1644
1850
|
externalId: string;
|
|
1645
1851
|
$unknown?: never;
|
|
1646
1852
|
}
|
|
1853
|
+
/**
|
|
1854
|
+
* @public
|
|
1855
|
+
*/
|
|
1647
1856
|
interface $UnknownMember {
|
|
1648
1857
|
state?: never;
|
|
1649
1858
|
resourceType?: never;
|
|
@@ -1665,10 +1874,12 @@ export declare namespace SyncResourceFilter {
|
|
|
1665
1874
|
*/
|
|
1666
1875
|
export interface ListSyncResourcesRequest {
|
|
1667
1876
|
/**
|
|
1877
|
+
* @public
|
|
1668
1878
|
* <p>The ID of the workspace that contains the sync job.</p>
|
|
1669
1879
|
*/
|
|
1670
1880
|
workspaceId: string | undefined;
|
|
1671
1881
|
/**
|
|
1882
|
+
* @public
|
|
1672
1883
|
* <p>The sync source.</p>
|
|
1673
1884
|
* <note>
|
|
1674
1885
|
* <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p>
|
|
@@ -1676,6 +1887,7 @@ export interface ListSyncResourcesRequest {
|
|
|
1676
1887
|
*/
|
|
1677
1888
|
syncSource: string | undefined;
|
|
1678
1889
|
/**
|
|
1890
|
+
* @public
|
|
1679
1891
|
* <p>A list of objects that filter the request.</p>
|
|
1680
1892
|
* <p>The following filter combinations are supported:</p>
|
|
1681
1893
|
* <ul>
|
|
@@ -1692,11 +1904,13 @@ export interface ListSyncResourcesRequest {
|
|
|
1692
1904
|
*/
|
|
1693
1905
|
filters?: SyncResourceFilter[];
|
|
1694
1906
|
/**
|
|
1907
|
+
* @public
|
|
1695
1908
|
* <p>The maximum number of results to return at one time. The default is 50.</p>
|
|
1696
1909
|
* <p>Valid Range: Minimum value of 0. Maximum value of 200.</p>
|
|
1697
1910
|
*/
|
|
1698
1911
|
maxResults?: number;
|
|
1699
1912
|
/**
|
|
1913
|
+
* @public
|
|
1700
1914
|
* <p>The string that specifies the next page of results.</p>
|
|
1701
1915
|
*/
|
|
1702
1916
|
nextToken?: string;
|
|
@@ -1707,10 +1921,12 @@ export interface ListSyncResourcesRequest {
|
|
|
1707
1921
|
*/
|
|
1708
1922
|
export interface SyncResourceStatus {
|
|
1709
1923
|
/**
|
|
1924
|
+
* @public
|
|
1710
1925
|
* <p>The sync resource status state.</p>
|
|
1711
1926
|
*/
|
|
1712
1927
|
state?: SyncResourceState | string;
|
|
1713
1928
|
/**
|
|
1929
|
+
* @public
|
|
1714
1930
|
* <p>The status error.</p>
|
|
1715
1931
|
*/
|
|
1716
1932
|
error?: ErrorDetails;
|
|
@@ -1721,22 +1937,27 @@ export interface SyncResourceStatus {
|
|
|
1721
1937
|
*/
|
|
1722
1938
|
export interface SyncResourceSummary {
|
|
1723
1939
|
/**
|
|
1940
|
+
* @public
|
|
1724
1941
|
* <p>The resource type.</p>
|
|
1725
1942
|
*/
|
|
1726
1943
|
resourceType?: SyncResourceType | string;
|
|
1727
1944
|
/**
|
|
1945
|
+
* @public
|
|
1728
1946
|
* <p>The external ID.</p>
|
|
1729
1947
|
*/
|
|
1730
1948
|
externalId?: string;
|
|
1731
1949
|
/**
|
|
1950
|
+
* @public
|
|
1732
1951
|
* <p>The resource ID.</p>
|
|
1733
1952
|
*/
|
|
1734
1953
|
resourceId?: string;
|
|
1735
1954
|
/**
|
|
1955
|
+
* @public
|
|
1736
1956
|
* <p>The sync resource summary status.</p>
|
|
1737
1957
|
*/
|
|
1738
1958
|
status?: SyncResourceStatus;
|
|
1739
1959
|
/**
|
|
1960
|
+
* @public
|
|
1740
1961
|
* <p>The update date and time.</p>
|
|
1741
1962
|
*/
|
|
1742
1963
|
updateDateTime?: Date;
|
|
@@ -1746,10 +1967,12 @@ export interface SyncResourceSummary {
|
|
|
1746
1967
|
*/
|
|
1747
1968
|
export interface ListSyncResourcesResponse {
|
|
1748
1969
|
/**
|
|
1970
|
+
* @public
|
|
1749
1971
|
* <p>The sync resources.</p>
|
|
1750
1972
|
*/
|
|
1751
1973
|
syncResources?: SyncResourceSummary[];
|
|
1752
1974
|
/**
|
|
1975
|
+
* @public
|
|
1753
1976
|
* <p>The string that specifies the next page of results.</p>
|
|
1754
1977
|
*/
|
|
1755
1978
|
nextToken?: string;
|
|
@@ -1759,15 +1982,18 @@ export interface ListSyncResourcesResponse {
|
|
|
1759
1982
|
*/
|
|
1760
1983
|
export interface ListTagsForResourceRequest {
|
|
1761
1984
|
/**
|
|
1985
|
+
* @public
|
|
1762
1986
|
* <p>The ARN of the resource.</p>
|
|
1763
1987
|
*/
|
|
1764
1988
|
resourceARN: string | undefined;
|
|
1765
1989
|
/**
|
|
1990
|
+
* @public
|
|
1766
1991
|
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
1767
1992
|
* <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
|
|
1768
1993
|
*/
|
|
1769
1994
|
maxResults?: number;
|
|
1770
1995
|
/**
|
|
1996
|
+
* @public
|
|
1771
1997
|
* <p>The string that specifies the next page of results.</p>
|
|
1772
1998
|
*/
|
|
1773
1999
|
nextToken?: string;
|
|
@@ -1777,10 +2003,12 @@ export interface ListTagsForResourceRequest {
|
|
|
1777
2003
|
*/
|
|
1778
2004
|
export interface ListTagsForResourceResponse {
|
|
1779
2005
|
/**
|
|
2006
|
+
* @public
|
|
1780
2007
|
* <p>Metadata that you can use to manage a resource.</p>
|
|
1781
2008
|
*/
|
|
1782
2009
|
tags?: Record<string, string>;
|
|
1783
2010
|
/**
|
|
2011
|
+
* @public
|
|
1784
2012
|
* <p>The string that specifies the next page of results.</p>
|
|
1785
2013
|
*/
|
|
1786
2014
|
nextToken?: string;
|
|
@@ -1790,11 +2018,13 @@ export interface ListTagsForResourceResponse {
|
|
|
1790
2018
|
*/
|
|
1791
2019
|
export interface ListWorkspacesRequest {
|
|
1792
2020
|
/**
|
|
2021
|
+
* @public
|
|
1793
2022
|
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
1794
2023
|
* <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
|
|
1795
2024
|
*/
|
|
1796
2025
|
maxResults?: number;
|
|
1797
2026
|
/**
|
|
2027
|
+
* @public
|
|
1798
2028
|
* <p>The string that specifies the next page of results.</p>
|
|
1799
2029
|
*/
|
|
1800
2030
|
nextToken?: string;
|
|
@@ -1805,22 +2035,27 @@ export interface ListWorkspacesRequest {
|
|
|
1805
2035
|
*/
|
|
1806
2036
|
export interface WorkspaceSummary {
|
|
1807
2037
|
/**
|
|
2038
|
+
* @public
|
|
1808
2039
|
* <p>The ID of the workspace.</p>
|
|
1809
2040
|
*/
|
|
1810
2041
|
workspaceId: string | undefined;
|
|
1811
2042
|
/**
|
|
2043
|
+
* @public
|
|
1812
2044
|
* <p>The ARN of the workspace.</p>
|
|
1813
2045
|
*/
|
|
1814
2046
|
arn: string | undefined;
|
|
1815
2047
|
/**
|
|
2048
|
+
* @public
|
|
1816
2049
|
* <p>The description of the workspace.</p>
|
|
1817
2050
|
*/
|
|
1818
2051
|
description?: string;
|
|
1819
2052
|
/**
|
|
2053
|
+
* @public
|
|
1820
2054
|
* <p>The date and time when the workspace was created.</p>
|
|
1821
2055
|
*/
|
|
1822
2056
|
creationDateTime: Date | undefined;
|
|
1823
2057
|
/**
|
|
2058
|
+
* @public
|
|
1824
2059
|
* <p>The date and time when the workspace was last updated.</p>
|
|
1825
2060
|
*/
|
|
1826
2061
|
updateDateTime: Date | undefined;
|
|
@@ -1830,10 +2065,12 @@ export interface WorkspaceSummary {
|
|
|
1830
2065
|
*/
|
|
1831
2066
|
export interface ListWorkspacesResponse {
|
|
1832
2067
|
/**
|
|
2068
|
+
* @public
|
|
1833
2069
|
* <p>A list of objects that contain information about the workspaces.</p>
|
|
1834
2070
|
*/
|
|
1835
2071
|
workspaceSummaries?: WorkspaceSummary[];
|
|
1836
2072
|
/**
|
|
2073
|
+
* @public
|
|
1837
2074
|
* <p>The string that specifies the next page of results.</p>
|
|
1838
2075
|
*/
|
|
1839
2076
|
nextToken?: string;
|
|
@@ -1843,10 +2080,12 @@ export interface ListWorkspacesResponse {
|
|
|
1843
2080
|
*/
|
|
1844
2081
|
export interface TagResourceRequest {
|
|
1845
2082
|
/**
|
|
2083
|
+
* @public
|
|
1846
2084
|
* <p>The ARN of the resource.</p>
|
|
1847
2085
|
*/
|
|
1848
2086
|
resourceARN: string | undefined;
|
|
1849
2087
|
/**
|
|
2088
|
+
* @public
|
|
1850
2089
|
* <p>Metadata to add to this resource.</p>
|
|
1851
2090
|
*/
|
|
1852
2091
|
tags: Record<string, string> | undefined;
|
|
@@ -1873,10 +2112,12 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
1873
2112
|
*/
|
|
1874
2113
|
export interface UntagResourceRequest {
|
|
1875
2114
|
/**
|
|
2115
|
+
* @public
|
|
1876
2116
|
* <p>The ARN of the resource.</p>
|
|
1877
2117
|
*/
|
|
1878
2118
|
resourceARN: string | undefined;
|
|
1879
2119
|
/**
|
|
2120
|
+
* @public
|
|
1880
2121
|
* <p>A list of tag key names to remove from the resource. You don't specify the value. Both
|
|
1881
2122
|
* the key and its associated value are removed.</p>
|
|
1882
2123
|
*/
|
|
@@ -1892,18 +2133,22 @@ export interface UntagResourceResponse {
|
|
|
1892
2133
|
*/
|
|
1893
2134
|
export interface UpdateComponentTypeResponse {
|
|
1894
2135
|
/**
|
|
2136
|
+
* @public
|
|
1895
2137
|
* <p>The ID of the workspace that contains the component type.</p>
|
|
1896
2138
|
*/
|
|
1897
2139
|
workspaceId: string | undefined;
|
|
1898
2140
|
/**
|
|
2141
|
+
* @public
|
|
1899
2142
|
* <p>The ARN of the component type.</p>
|
|
1900
2143
|
*/
|
|
1901
2144
|
arn: string | undefined;
|
|
1902
2145
|
/**
|
|
2146
|
+
* @public
|
|
1903
2147
|
* <p>The ID of the component type.</p>
|
|
1904
2148
|
*/
|
|
1905
2149
|
componentTypeId: string | undefined;
|
|
1906
2150
|
/**
|
|
2151
|
+
* @public
|
|
1907
2152
|
* <p>The current state of the component type.</p>
|
|
1908
2153
|
*/
|
|
1909
2154
|
state: State | string | undefined;
|
|
@@ -1939,10 +2184,12 @@ export type ParentEntityUpdateType = (typeof ParentEntityUpdateType)[keyof typeo
|
|
|
1939
2184
|
*/
|
|
1940
2185
|
export interface ParentEntityUpdateRequest {
|
|
1941
2186
|
/**
|
|
2187
|
+
* @public
|
|
1942
2188
|
* <p>The type of the update.</p>
|
|
1943
2189
|
*/
|
|
1944
2190
|
updateType: ParentEntityUpdateType | string | undefined;
|
|
1945
2191
|
/**
|
|
2192
|
+
* @public
|
|
1946
2193
|
* <p>The ID of the parent entity.</p>
|
|
1947
2194
|
*/
|
|
1948
2195
|
parentEntityId?: string;
|
|
@@ -1952,10 +2199,12 @@ export interface ParentEntityUpdateRequest {
|
|
|
1952
2199
|
*/
|
|
1953
2200
|
export interface UpdateEntityResponse {
|
|
1954
2201
|
/**
|
|
2202
|
+
* @public
|
|
1955
2203
|
* <p>The date and time when the entity was last updated.</p>
|
|
1956
2204
|
*/
|
|
1957
2205
|
updateDateTime: Date | undefined;
|
|
1958
2206
|
/**
|
|
2207
|
+
* @public
|
|
1959
2208
|
* <p>The current state of the entity update.</p>
|
|
1960
2209
|
*/
|
|
1961
2210
|
state: State | string | undefined;
|
|
@@ -1965,10 +2214,12 @@ export interface UpdateEntityResponse {
|
|
|
1965
2214
|
*/
|
|
1966
2215
|
export interface UpdatePricingPlanRequest {
|
|
1967
2216
|
/**
|
|
2217
|
+
* @public
|
|
1968
2218
|
* <p>The pricing mode.</p>
|
|
1969
2219
|
*/
|
|
1970
2220
|
pricingMode: PricingMode | string | undefined;
|
|
1971
2221
|
/**
|
|
2222
|
+
* @public
|
|
1972
2223
|
* <p>The bundle names.</p>
|
|
1973
2224
|
*/
|
|
1974
2225
|
bundleNames?: string[];
|
|
@@ -1978,10 +2229,12 @@ export interface UpdatePricingPlanRequest {
|
|
|
1978
2229
|
*/
|
|
1979
2230
|
export interface UpdatePricingPlanResponse {
|
|
1980
2231
|
/**
|
|
2232
|
+
* @public
|
|
1981
2233
|
* <p>Update the current pricing plan.</p>
|
|
1982
2234
|
*/
|
|
1983
2235
|
currentPricingPlan: PricingPlan | undefined;
|
|
1984
2236
|
/**
|
|
2237
|
+
* @public
|
|
1985
2238
|
* <p>Update the pending pricing plan.</p>
|
|
1986
2239
|
*/
|
|
1987
2240
|
pendingPricingPlan?: PricingPlan;
|
|
@@ -1991,26 +2244,32 @@ export interface UpdatePricingPlanResponse {
|
|
|
1991
2244
|
*/
|
|
1992
2245
|
export interface UpdateSceneRequest {
|
|
1993
2246
|
/**
|
|
2247
|
+
* @public
|
|
1994
2248
|
* <p>The ID of the workspace that contains the scene.</p>
|
|
1995
2249
|
*/
|
|
1996
2250
|
workspaceId: string | undefined;
|
|
1997
2251
|
/**
|
|
2252
|
+
* @public
|
|
1998
2253
|
* <p>The ID of the scene.</p>
|
|
1999
2254
|
*/
|
|
2000
2255
|
sceneId: string | undefined;
|
|
2001
2256
|
/**
|
|
2257
|
+
* @public
|
|
2002
2258
|
* <p>The relative path that specifies the location of the content definition file.</p>
|
|
2003
2259
|
*/
|
|
2004
2260
|
contentLocation?: string;
|
|
2005
2261
|
/**
|
|
2262
|
+
* @public
|
|
2006
2263
|
* <p>The description of this scene.</p>
|
|
2007
2264
|
*/
|
|
2008
2265
|
description?: string;
|
|
2009
2266
|
/**
|
|
2267
|
+
* @public
|
|
2010
2268
|
* <p>A list of capabilities that the scene uses to render.</p>
|
|
2011
2269
|
*/
|
|
2012
2270
|
capabilities?: string[];
|
|
2013
2271
|
/**
|
|
2272
|
+
* @public
|
|
2014
2273
|
* <p>The scene metadata.</p>
|
|
2015
2274
|
*/
|
|
2016
2275
|
sceneMetadata?: Record<string, string>;
|
|
@@ -2020,6 +2279,7 @@ export interface UpdateSceneRequest {
|
|
|
2020
2279
|
*/
|
|
2021
2280
|
export interface UpdateSceneResponse {
|
|
2022
2281
|
/**
|
|
2282
|
+
* @public
|
|
2023
2283
|
* <p>The date and time when the scene was last updated.</p>
|
|
2024
2284
|
*/
|
|
2025
2285
|
updateDateTime: Date | undefined;
|
|
@@ -2029,14 +2289,17 @@ export interface UpdateSceneResponse {
|
|
|
2029
2289
|
*/
|
|
2030
2290
|
export interface UpdateWorkspaceRequest {
|
|
2031
2291
|
/**
|
|
2292
|
+
* @public
|
|
2032
2293
|
* <p>The ID of the workspace.</p>
|
|
2033
2294
|
*/
|
|
2034
2295
|
workspaceId: string | undefined;
|
|
2035
2296
|
/**
|
|
2297
|
+
* @public
|
|
2036
2298
|
* <p>The description of the workspace.</p>
|
|
2037
2299
|
*/
|
|
2038
2300
|
description?: string;
|
|
2039
2301
|
/**
|
|
2302
|
+
* @public
|
|
2040
2303
|
* <p>The ARN of the execution role associated with the workspace.</p>
|
|
2041
2304
|
*/
|
|
2042
2305
|
role?: string;
|
|
@@ -2046,6 +2309,7 @@ export interface UpdateWorkspaceRequest {
|
|
|
2046
2309
|
*/
|
|
2047
2310
|
export interface UpdateWorkspaceResponse {
|
|
2048
2311
|
/**
|
|
2312
|
+
* @public
|
|
2049
2313
|
* <p>The date and time of the current update.</p>
|
|
2050
2314
|
*/
|
|
2051
2315
|
updateDateTime: Date | undefined;
|
|
@@ -2056,38 +2320,47 @@ export interface UpdateWorkspaceResponse {
|
|
|
2056
2320
|
*/
|
|
2057
2321
|
export interface DataValue {
|
|
2058
2322
|
/**
|
|
2323
|
+
* @public
|
|
2059
2324
|
* <p>A Boolean value.</p>
|
|
2060
2325
|
*/
|
|
2061
2326
|
booleanValue?: boolean;
|
|
2062
2327
|
/**
|
|
2328
|
+
* @public
|
|
2063
2329
|
* <p>A double value.</p>
|
|
2064
2330
|
*/
|
|
2065
2331
|
doubleValue?: number;
|
|
2066
2332
|
/**
|
|
2333
|
+
* @public
|
|
2067
2334
|
* <p>An integer value.</p>
|
|
2068
2335
|
*/
|
|
2069
2336
|
integerValue?: number;
|
|
2070
2337
|
/**
|
|
2338
|
+
* @public
|
|
2071
2339
|
* <p>A long value.</p>
|
|
2072
2340
|
*/
|
|
2073
2341
|
longValue?: number;
|
|
2074
2342
|
/**
|
|
2343
|
+
* @public
|
|
2075
2344
|
* <p>A string value.</p>
|
|
2076
2345
|
*/
|
|
2077
2346
|
stringValue?: string;
|
|
2078
2347
|
/**
|
|
2348
|
+
* @public
|
|
2079
2349
|
* <p>A list of multiple values.</p>
|
|
2080
2350
|
*/
|
|
2081
2351
|
listValue?: DataValue[];
|
|
2082
2352
|
/**
|
|
2353
|
+
* @public
|
|
2083
2354
|
* <p>An object that maps strings to multiple <code>DataValue</code> objects.</p>
|
|
2084
2355
|
*/
|
|
2085
2356
|
mapValue?: Record<string, DataValue>;
|
|
2086
2357
|
/**
|
|
2358
|
+
* @public
|
|
2087
2359
|
* <p>A value that relates a component to another component.</p>
|
|
2088
2360
|
*/
|
|
2089
2361
|
relationshipValue?: RelationshipValue;
|
|
2090
2362
|
/**
|
|
2363
|
+
* @public
|
|
2091
2364
|
* <p>An expression that produces the value.</p>
|
|
2092
2365
|
*/
|
|
2093
2366
|
expression?: string;
|
|
@@ -2098,14 +2371,17 @@ export interface DataValue {
|
|
|
2098
2371
|
*/
|
|
2099
2372
|
export interface PropertyFilter {
|
|
2100
2373
|
/**
|
|
2374
|
+
* @public
|
|
2101
2375
|
* <p>The property name associated with this property filter.</p>
|
|
2102
2376
|
*/
|
|
2103
2377
|
propertyName?: string;
|
|
2104
2378
|
/**
|
|
2379
|
+
* @public
|
|
2105
2380
|
* <p>The operator associated with this property filter.</p>
|
|
2106
2381
|
*/
|
|
2107
2382
|
operator?: string;
|
|
2108
2383
|
/**
|
|
2384
|
+
* @public
|
|
2109
2385
|
* <p>The value associated with this property filter.</p>
|
|
2110
2386
|
*/
|
|
2111
2387
|
value?: DataValue;
|
|
@@ -2116,10 +2392,12 @@ export interface PropertyFilter {
|
|
|
2116
2392
|
*/
|
|
2117
2393
|
export interface PropertyLatestValue {
|
|
2118
2394
|
/**
|
|
2395
|
+
* @public
|
|
2119
2396
|
* <p>An object that specifies information about a property.</p>
|
|
2120
2397
|
*/
|
|
2121
2398
|
propertyReference: EntityPropertyReference | undefined;
|
|
2122
2399
|
/**
|
|
2400
|
+
* @public
|
|
2123
2401
|
* <p>The value of the property.</p>
|
|
2124
2402
|
*/
|
|
2125
2403
|
propertyValue?: DataValue;
|
|
@@ -2130,16 +2408,19 @@ export interface PropertyLatestValue {
|
|
|
2130
2408
|
*/
|
|
2131
2409
|
export interface PropertyValue {
|
|
2132
2410
|
/**
|
|
2411
|
+
* @public
|
|
2133
2412
|
* @deprecated
|
|
2134
2413
|
*
|
|
2135
2414
|
* <p>The timestamp of a value for a time series property.</p>
|
|
2136
2415
|
*/
|
|
2137
2416
|
timestamp?: Date;
|
|
2138
2417
|
/**
|
|
2418
|
+
* @public
|
|
2139
2419
|
* <p>An object that specifies a value for a time series property.</p>
|
|
2140
2420
|
*/
|
|
2141
2421
|
value: DataValue | undefined;
|
|
2142
2422
|
/**
|
|
2423
|
+
* @public
|
|
2143
2424
|
* <p>ISO8601 DateTime of a value for a time series property.</p>
|
|
2144
2425
|
* <p>The time for when the property value was recorded in ISO 8601 format:
|
|
2145
2426
|
* <i>YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm]</i>.</p>
|
|
@@ -2193,22 +2474,27 @@ export interface PropertyValue {
|
|
|
2193
2474
|
*/
|
|
2194
2475
|
export interface DataType {
|
|
2195
2476
|
/**
|
|
2477
|
+
* @public
|
|
2196
2478
|
* <p>The underlying type of the data type.</p>
|
|
2197
2479
|
*/
|
|
2198
2480
|
type: Type | string | undefined;
|
|
2199
2481
|
/**
|
|
2482
|
+
* @public
|
|
2200
2483
|
* <p>The nested type in the data type.</p>
|
|
2201
2484
|
*/
|
|
2202
2485
|
nestedType?: DataType;
|
|
2203
2486
|
/**
|
|
2487
|
+
* @public
|
|
2204
2488
|
* <p>The allowed values for this data type.</p>
|
|
2205
2489
|
*/
|
|
2206
2490
|
allowedValues?: DataValue[];
|
|
2207
2491
|
/**
|
|
2492
|
+
* @public
|
|
2208
2493
|
* <p>The unit of measure used in this data type.</p>
|
|
2209
2494
|
*/
|
|
2210
2495
|
unitOfMeasure?: string;
|
|
2211
2496
|
/**
|
|
2497
|
+
* @public
|
|
2212
2498
|
* <p>A relationship that associates a component with another component.</p>
|
|
2213
2499
|
*/
|
|
2214
2500
|
relationship?: Relationship;
|
|
@@ -2218,65 +2504,79 @@ export interface DataType {
|
|
|
2218
2504
|
*/
|
|
2219
2505
|
export interface GetPropertyValueHistoryRequest {
|
|
2220
2506
|
/**
|
|
2507
|
+
* @public
|
|
2221
2508
|
* <p>The ID of the workspace.</p>
|
|
2222
2509
|
*/
|
|
2223
2510
|
workspaceId: string | undefined;
|
|
2224
2511
|
/**
|
|
2512
|
+
* @public
|
|
2225
2513
|
* <p>The ID of the entity.</p>
|
|
2226
2514
|
*/
|
|
2227
2515
|
entityId?: string;
|
|
2228
2516
|
/**
|
|
2517
|
+
* @public
|
|
2229
2518
|
* <p>The name of the component.</p>
|
|
2230
2519
|
*/
|
|
2231
2520
|
componentName?: string;
|
|
2232
2521
|
/**
|
|
2522
|
+
* @public
|
|
2233
2523
|
* <p>The ID of the component type.</p>
|
|
2234
2524
|
*/
|
|
2235
2525
|
componentTypeId?: string;
|
|
2236
2526
|
/**
|
|
2527
|
+
* @public
|
|
2237
2528
|
* <p>A list of properties whose value histories the request retrieves.</p>
|
|
2238
2529
|
*/
|
|
2239
2530
|
selectedProperties: string[] | undefined;
|
|
2240
2531
|
/**
|
|
2532
|
+
* @public
|
|
2241
2533
|
* <p>A list of objects that filter the property value history request.</p>
|
|
2242
2534
|
*/
|
|
2243
2535
|
propertyFilters?: PropertyFilter[];
|
|
2244
2536
|
/**
|
|
2537
|
+
* @public
|
|
2245
2538
|
* @deprecated
|
|
2246
2539
|
*
|
|
2247
2540
|
* <p>The date and time of the earliest property value to return.</p>
|
|
2248
2541
|
*/
|
|
2249
2542
|
startDateTime?: Date;
|
|
2250
2543
|
/**
|
|
2544
|
+
* @public
|
|
2251
2545
|
* @deprecated
|
|
2252
2546
|
*
|
|
2253
2547
|
* <p>The date and time of the latest property value to return.</p>
|
|
2254
2548
|
*/
|
|
2255
2549
|
endDateTime?: Date;
|
|
2256
2550
|
/**
|
|
2551
|
+
* @public
|
|
2257
2552
|
* <p>An object that specifies the interpolation type and the interval over which to
|
|
2258
2553
|
* interpolate data.</p>
|
|
2259
2554
|
*/
|
|
2260
2555
|
interpolation?: InterpolationParameters;
|
|
2261
2556
|
/**
|
|
2557
|
+
* @public
|
|
2262
2558
|
* <p>The string that specifies the next page of results.</p>
|
|
2263
2559
|
*/
|
|
2264
2560
|
nextToken?: string;
|
|
2265
2561
|
/**
|
|
2562
|
+
* @public
|
|
2266
2563
|
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
2267
2564
|
* <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
|
|
2268
2565
|
*/
|
|
2269
2566
|
maxResults?: number;
|
|
2270
2567
|
/**
|
|
2568
|
+
* @public
|
|
2271
2569
|
* <p>The time direction to use in the result order.</p>
|
|
2272
2570
|
*/
|
|
2273
2571
|
orderByTime?: OrderByTime | string;
|
|
2274
2572
|
/**
|
|
2573
|
+
* @public
|
|
2275
2574
|
* <p>The ISO8601 DateTime of the earliest property value to return.</p>
|
|
2276
2575
|
* <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>
|
|
2277
2576
|
*/
|
|
2278
2577
|
startTime?: string;
|
|
2279
2578
|
/**
|
|
2579
|
+
* @public
|
|
2280
2580
|
* <p>The ISO8601 DateTime of the latest property value to return.</p>
|
|
2281
2581
|
* <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>
|
|
2282
2582
|
*/
|
|
@@ -2289,10 +2589,12 @@ export interface GetPropertyValueHistoryRequest {
|
|
|
2289
2589
|
*/
|
|
2290
2590
|
export interface PropertyValueEntry {
|
|
2291
2591
|
/**
|
|
2592
|
+
* @public
|
|
2292
2593
|
* <p>An object that contains information about the entity that has the property.</p>
|
|
2293
2594
|
*/
|
|
2294
2595
|
entityPropertyReference: EntityPropertyReference | undefined;
|
|
2295
2596
|
/**
|
|
2597
|
+
* @public
|
|
2296
2598
|
* <p>A list of objects that specify time series property values.</p>
|
|
2297
2599
|
*/
|
|
2298
2600
|
propertyValues?: PropertyValue[];
|
|
@@ -2303,10 +2605,12 @@ export interface PropertyValueEntry {
|
|
|
2303
2605
|
*/
|
|
2304
2606
|
export interface PropertyValueHistory {
|
|
2305
2607
|
/**
|
|
2608
|
+
* @public
|
|
2306
2609
|
* <p>An object that uniquely identifies an entity property.</p>
|
|
2307
2610
|
*/
|
|
2308
2611
|
entityPropertyReference: EntityPropertyReference | undefined;
|
|
2309
2612
|
/**
|
|
2613
|
+
* @public
|
|
2310
2614
|
* <p>A list of objects that contain information about the values in the history of a time
|
|
2311
2615
|
* series property.</p>
|
|
2312
2616
|
*/
|
|
@@ -2318,11 +2622,13 @@ export interface PropertyValueHistory {
|
|
|
2318
2622
|
*/
|
|
2319
2623
|
export interface TabularConditions {
|
|
2320
2624
|
/**
|
|
2625
|
+
* @public
|
|
2321
2626
|
* <p>Filter criteria that orders the output. It can be sorted in ascending or descending
|
|
2322
2627
|
* order.</p>
|
|
2323
2628
|
*/
|
|
2324
2629
|
orderBy?: OrderBy[];
|
|
2325
2630
|
/**
|
|
2631
|
+
* @public
|
|
2326
2632
|
* <p>You can filter the request using various logical operators and a key-value format. For
|
|
2327
2633
|
* example:</p>
|
|
2328
2634
|
* <p>
|
|
@@ -2337,14 +2643,17 @@ export interface TabularConditions {
|
|
|
2337
2643
|
*/
|
|
2338
2644
|
export interface BatchPutPropertyError {
|
|
2339
2645
|
/**
|
|
2646
|
+
* @public
|
|
2340
2647
|
* <p>The error code.</p>
|
|
2341
2648
|
*/
|
|
2342
2649
|
errorCode: string | undefined;
|
|
2343
2650
|
/**
|
|
2651
|
+
* @public
|
|
2344
2652
|
* <p>The error message.</p>
|
|
2345
2653
|
*/
|
|
2346
2654
|
errorMessage: string | undefined;
|
|
2347
2655
|
/**
|
|
2656
|
+
* @public
|
|
2348
2657
|
* <p>An object that contains information about errors returned by the
|
|
2349
2658
|
* <code>BatchPutProperty</code> action.</p>
|
|
2350
2659
|
*/
|
|
@@ -2355,39 +2664,48 @@ export interface BatchPutPropertyError {
|
|
|
2355
2664
|
*/
|
|
2356
2665
|
export interface GetPropertyValueRequest {
|
|
2357
2666
|
/**
|
|
2667
|
+
* @public
|
|
2358
2668
|
* <p>The name of the component whose property values the operation returns.</p>
|
|
2359
2669
|
*/
|
|
2360
2670
|
componentName?: string;
|
|
2361
2671
|
/**
|
|
2672
|
+
* @public
|
|
2362
2673
|
* <p>The ID of the component type whose property values the operation returns.</p>
|
|
2363
2674
|
*/
|
|
2364
2675
|
componentTypeId?: string;
|
|
2365
2676
|
/**
|
|
2677
|
+
* @public
|
|
2366
2678
|
* <p>The ID of the entity whose property values the operation returns.</p>
|
|
2367
2679
|
*/
|
|
2368
2680
|
entityId?: string;
|
|
2369
2681
|
/**
|
|
2682
|
+
* @public
|
|
2370
2683
|
* <p>The properties whose values the operation returns.</p>
|
|
2371
2684
|
*/
|
|
2372
2685
|
selectedProperties: string[] | undefined;
|
|
2373
2686
|
/**
|
|
2687
|
+
* @public
|
|
2374
2688
|
* <p>The ID of the workspace whose values the operation returns.</p>
|
|
2375
2689
|
*/
|
|
2376
2690
|
workspaceId: string | undefined;
|
|
2377
2691
|
/**
|
|
2692
|
+
* @public
|
|
2378
2693
|
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
2379
2694
|
* <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
|
|
2380
2695
|
*/
|
|
2381
2696
|
maxResults?: number;
|
|
2382
2697
|
/**
|
|
2698
|
+
* @public
|
|
2383
2699
|
* <p>The string that specifies the next page of results.</p>
|
|
2384
2700
|
*/
|
|
2385
2701
|
nextToken?: string;
|
|
2386
2702
|
/**
|
|
2703
|
+
* @public
|
|
2387
2704
|
* <p>The property group name.</p>
|
|
2388
2705
|
*/
|
|
2389
2706
|
propertyGroupName?: string;
|
|
2390
2707
|
/**
|
|
2708
|
+
* @public
|
|
2391
2709
|
* <p>The tabular conditions.</p>
|
|
2392
2710
|
*/
|
|
2393
2711
|
tabularConditions?: TabularConditions;
|
|
@@ -2397,10 +2715,12 @@ export interface GetPropertyValueRequest {
|
|
|
2397
2715
|
*/
|
|
2398
2716
|
export interface BatchPutPropertyValuesRequest {
|
|
2399
2717
|
/**
|
|
2718
|
+
* @public
|
|
2400
2719
|
* <p>The ID of the workspace that contains the properties to set.</p>
|
|
2401
2720
|
*/
|
|
2402
2721
|
workspaceId: string | undefined;
|
|
2403
2722
|
/**
|
|
2723
|
+
* @public
|
|
2404
2724
|
* <p>An object that maps strings to the property value entries to set. Each string in the
|
|
2405
2725
|
* mapping must be unique to this object.</p>
|
|
2406
2726
|
*/
|
|
@@ -2411,11 +2731,13 @@ export interface BatchPutPropertyValuesRequest {
|
|
|
2411
2731
|
*/
|
|
2412
2732
|
export interface GetPropertyValueHistoryResponse {
|
|
2413
2733
|
/**
|
|
2734
|
+
* @public
|
|
2414
2735
|
* <p>An object that maps strings to the property definitions in the component type. Each
|
|
2415
2736
|
* string in the mapping must be unique to this object.</p>
|
|
2416
2737
|
*/
|
|
2417
2738
|
propertyValues: PropertyValueHistory[] | undefined;
|
|
2418
2739
|
/**
|
|
2740
|
+
* @public
|
|
2419
2741
|
* <p>The string that specifies the next page of results.</p>
|
|
2420
2742
|
*/
|
|
2421
2743
|
nextToken?: string;
|
|
@@ -2427,6 +2749,7 @@ export interface GetPropertyValueHistoryResponse {
|
|
|
2427
2749
|
*/
|
|
2428
2750
|
export interface BatchPutPropertyErrorEntry {
|
|
2429
2751
|
/**
|
|
2752
|
+
* @public
|
|
2430
2753
|
* <p>A list of objects that contain information about errors returned by the
|
|
2431
2754
|
* <code>BatchPutProperty</code> action.</p>
|
|
2432
2755
|
*/
|
|
@@ -2438,36 +2761,44 @@ export interface BatchPutPropertyErrorEntry {
|
|
|
2438
2761
|
*/
|
|
2439
2762
|
export interface PropertyDefinitionRequest {
|
|
2440
2763
|
/**
|
|
2764
|
+
* @public
|
|
2441
2765
|
* <p>An object that contains information about the data type.</p>
|
|
2442
2766
|
*/
|
|
2443
2767
|
dataType?: DataType;
|
|
2444
2768
|
/**
|
|
2769
|
+
* @public
|
|
2445
2770
|
* <p>A Boolean value that specifies whether the property is required.</p>
|
|
2446
2771
|
*/
|
|
2447
2772
|
isRequiredInEntity?: boolean;
|
|
2448
2773
|
/**
|
|
2774
|
+
* @public
|
|
2449
2775
|
* <p>A Boolean value that specifies whether the property ID comes from an external data
|
|
2450
2776
|
* store.</p>
|
|
2451
2777
|
*/
|
|
2452
2778
|
isExternalId?: boolean;
|
|
2453
2779
|
/**
|
|
2780
|
+
* @public
|
|
2454
2781
|
* <p>A Boolean value that specifies whether the property is stored externally.</p>
|
|
2455
2782
|
*/
|
|
2456
2783
|
isStoredExternally?: boolean;
|
|
2457
2784
|
/**
|
|
2785
|
+
* @public
|
|
2458
2786
|
* <p>A Boolean value that specifies whether the property consists of time series data.</p>
|
|
2459
2787
|
*/
|
|
2460
2788
|
isTimeSeries?: boolean;
|
|
2461
2789
|
/**
|
|
2790
|
+
* @public
|
|
2462
2791
|
* <p>An object that contains the default value.</p>
|
|
2463
2792
|
*/
|
|
2464
2793
|
defaultValue?: DataValue;
|
|
2465
2794
|
/**
|
|
2795
|
+
* @public
|
|
2466
2796
|
* <p>A mapping that specifies configuration information about the property. Use this field to
|
|
2467
2797
|
* specify information that you read from and write to an external source.</p>
|
|
2468
2798
|
*/
|
|
2469
2799
|
configuration?: Record<string, string>;
|
|
2470
2800
|
/**
|
|
2801
|
+
* @public
|
|
2471
2802
|
* <p>A friendly name for the property.</p>
|
|
2472
2803
|
*/
|
|
2473
2804
|
displayName?: string;
|
|
@@ -2478,49 +2809,60 @@ export interface PropertyDefinitionRequest {
|
|
|
2478
2809
|
*/
|
|
2479
2810
|
export interface PropertyDefinitionResponse {
|
|
2480
2811
|
/**
|
|
2812
|
+
* @public
|
|
2481
2813
|
* <p>An object that contains information about the data type.</p>
|
|
2482
2814
|
*/
|
|
2483
2815
|
dataType: DataType | undefined;
|
|
2484
2816
|
/**
|
|
2817
|
+
* @public
|
|
2485
2818
|
* <p>A Boolean value that specifies whether the property consists of time series data.</p>
|
|
2486
2819
|
*/
|
|
2487
2820
|
isTimeSeries: boolean | undefined;
|
|
2488
2821
|
/**
|
|
2822
|
+
* @public
|
|
2489
2823
|
* <p>A Boolean value that specifies whether the property is required in an entity.</p>
|
|
2490
2824
|
*/
|
|
2491
2825
|
isRequiredInEntity: boolean | undefined;
|
|
2492
2826
|
/**
|
|
2827
|
+
* @public
|
|
2493
2828
|
* <p>A Boolean value that specifies whether the property ID comes from an external data
|
|
2494
2829
|
* store.</p>
|
|
2495
2830
|
*/
|
|
2496
2831
|
isExternalId: boolean | undefined;
|
|
2497
2832
|
/**
|
|
2833
|
+
* @public
|
|
2498
2834
|
* <p>A Boolean value that specifies whether the property is stored externally.</p>
|
|
2499
2835
|
*/
|
|
2500
2836
|
isStoredExternally: boolean | undefined;
|
|
2501
2837
|
/**
|
|
2838
|
+
* @public
|
|
2502
2839
|
* <p>A Boolean value that specifies whether the property definition is imported from an
|
|
2503
2840
|
* external data store.</p>
|
|
2504
2841
|
*/
|
|
2505
2842
|
isImported: boolean | undefined;
|
|
2506
2843
|
/**
|
|
2844
|
+
* @public
|
|
2507
2845
|
* <p>A Boolean value that specifies whether the property definition can be updated.</p>
|
|
2508
2846
|
*/
|
|
2509
2847
|
isFinal: boolean | undefined;
|
|
2510
2848
|
/**
|
|
2849
|
+
* @public
|
|
2511
2850
|
* <p>A Boolean value that specifies whether the property definition is inherited from a
|
|
2512
2851
|
* parent entity.</p>
|
|
2513
2852
|
*/
|
|
2514
2853
|
isInherited: boolean | undefined;
|
|
2515
2854
|
/**
|
|
2855
|
+
* @public
|
|
2516
2856
|
* <p>An object that contains the default value.</p>
|
|
2517
2857
|
*/
|
|
2518
2858
|
defaultValue?: DataValue;
|
|
2519
2859
|
/**
|
|
2860
|
+
* @public
|
|
2520
2861
|
* <p>A mapping that specifies configuration information about the property.</p>
|
|
2521
2862
|
*/
|
|
2522
2863
|
configuration?: Record<string, string>;
|
|
2523
2864
|
/**
|
|
2865
|
+
* @public
|
|
2524
2866
|
* <p>A friendly name for the property.</p>
|
|
2525
2867
|
*/
|
|
2526
2868
|
displayName?: string;
|
|
@@ -2530,6 +2872,7 @@ export interface PropertyDefinitionResponse {
|
|
|
2530
2872
|
*/
|
|
2531
2873
|
export interface BatchPutPropertyValuesResponse {
|
|
2532
2874
|
/**
|
|
2875
|
+
* @public
|
|
2533
2876
|
* <p>Entries that caused errors in the batch put operation.</p>
|
|
2534
2877
|
*/
|
|
2535
2878
|
errorEntries: BatchPutPropertyErrorEntry[] | undefined;
|
|
@@ -2539,15 +2882,18 @@ export interface BatchPutPropertyValuesResponse {
|
|
|
2539
2882
|
*/
|
|
2540
2883
|
export interface GetPropertyValueResponse {
|
|
2541
2884
|
/**
|
|
2885
|
+
* @public
|
|
2542
2886
|
* <p>An object that maps strings to the properties and latest property values in the
|
|
2543
2887
|
* response. Each string in the mapping must be unique to this object.</p>
|
|
2544
2888
|
*/
|
|
2545
2889
|
propertyValues?: Record<string, PropertyLatestValue>;
|
|
2546
2890
|
/**
|
|
2891
|
+
* @public
|
|
2547
2892
|
* <p>The string that specifies the next page of results.</p>
|
|
2548
2893
|
*/
|
|
2549
2894
|
nextToken?: string;
|
|
2550
2895
|
/**
|
|
2896
|
+
* @public
|
|
2551
2897
|
* <p>A table of property values.</p>
|
|
2552
2898
|
*/
|
|
2553
2899
|
tabularPropertyValues?: Record<string, DataValue>[][];
|
|
@@ -2557,45 +2903,55 @@ export interface GetPropertyValueResponse {
|
|
|
2557
2903
|
*/
|
|
2558
2904
|
export interface CreateComponentTypeRequest {
|
|
2559
2905
|
/**
|
|
2906
|
+
* @public
|
|
2560
2907
|
* <p>The ID of the workspace that contains the component type.</p>
|
|
2561
2908
|
*/
|
|
2562
2909
|
workspaceId: string | undefined;
|
|
2563
2910
|
/**
|
|
2911
|
+
* @public
|
|
2564
2912
|
* <p>A Boolean value that specifies whether an entity can have more than one component of
|
|
2565
2913
|
* this type.</p>
|
|
2566
2914
|
*/
|
|
2567
2915
|
isSingleton?: boolean;
|
|
2568
2916
|
/**
|
|
2917
|
+
* @public
|
|
2569
2918
|
* <p>The ID of the component type.</p>
|
|
2570
2919
|
*/
|
|
2571
2920
|
componentTypeId: string | undefined;
|
|
2572
2921
|
/**
|
|
2922
|
+
* @public
|
|
2573
2923
|
* <p>The description of the component type.</p>
|
|
2574
2924
|
*/
|
|
2575
2925
|
description?: string;
|
|
2576
2926
|
/**
|
|
2927
|
+
* @public
|
|
2577
2928
|
* <p>An object that maps strings to the property definitions in the component type. Each
|
|
2578
2929
|
* string in the mapping must be unique to this object.</p>
|
|
2579
2930
|
*/
|
|
2580
2931
|
propertyDefinitions?: Record<string, PropertyDefinitionRequest>;
|
|
2581
2932
|
/**
|
|
2933
|
+
* @public
|
|
2582
2934
|
* <p>Specifies the parent component type to extend.</p>
|
|
2583
2935
|
*/
|
|
2584
2936
|
extendsFrom?: string[];
|
|
2585
2937
|
/**
|
|
2938
|
+
* @public
|
|
2586
2939
|
* <p>An object that maps strings to the functions in the component type. Each string in the
|
|
2587
2940
|
* mapping must be unique to this object.</p>
|
|
2588
2941
|
*/
|
|
2589
2942
|
functions?: Record<string, FunctionRequest>;
|
|
2590
2943
|
/**
|
|
2944
|
+
* @public
|
|
2591
2945
|
* <p>Metadata that you can use to manage the component type.</p>
|
|
2592
2946
|
*/
|
|
2593
2947
|
tags?: Record<string, string>;
|
|
2594
2948
|
/**
|
|
2949
|
+
* @public
|
|
2595
2950
|
* <p/>
|
|
2596
2951
|
*/
|
|
2597
2952
|
propertyGroups?: Record<string, PropertyGroupRequest>;
|
|
2598
2953
|
/**
|
|
2954
|
+
* @public
|
|
2599
2955
|
* <p>A friendly name for the component type.</p>
|
|
2600
2956
|
*/
|
|
2601
2957
|
componentTypeName?: string;
|
|
@@ -2605,71 +2961,87 @@ export interface CreateComponentTypeRequest {
|
|
|
2605
2961
|
*/
|
|
2606
2962
|
export interface GetComponentTypeResponse {
|
|
2607
2963
|
/**
|
|
2964
|
+
* @public
|
|
2608
2965
|
* <p>The ID of the workspace that contains the component type.</p>
|
|
2609
2966
|
*/
|
|
2610
2967
|
workspaceId: string | undefined;
|
|
2611
2968
|
/**
|
|
2969
|
+
* @public
|
|
2612
2970
|
* <p>A Boolean value that specifies whether an entity can have more than one component of
|
|
2613
2971
|
* this type.</p>
|
|
2614
2972
|
*/
|
|
2615
2973
|
isSingleton?: boolean;
|
|
2616
2974
|
/**
|
|
2975
|
+
* @public
|
|
2617
2976
|
* <p>The ID of the component type.</p>
|
|
2618
2977
|
*/
|
|
2619
2978
|
componentTypeId: string | undefined;
|
|
2620
2979
|
/**
|
|
2980
|
+
* @public
|
|
2621
2981
|
* <p>The description of the component type.</p>
|
|
2622
2982
|
*/
|
|
2623
2983
|
description?: string;
|
|
2624
2984
|
/**
|
|
2985
|
+
* @public
|
|
2625
2986
|
* <p>An object that maps strings to the property definitions in the component type. Each
|
|
2626
2987
|
* string in the mapping must be unique to this object.</p>
|
|
2627
2988
|
*/
|
|
2628
2989
|
propertyDefinitions?: Record<string, PropertyDefinitionResponse>;
|
|
2629
2990
|
/**
|
|
2991
|
+
* @public
|
|
2630
2992
|
* <p>The name of the parent component type that this component type extends.</p>
|
|
2631
2993
|
*/
|
|
2632
2994
|
extendsFrom?: string[];
|
|
2633
2995
|
/**
|
|
2996
|
+
* @public
|
|
2634
2997
|
* <p>An object that maps strings to the functions in the component type. Each string in the
|
|
2635
2998
|
* mapping must be unique to this object.</p>
|
|
2636
2999
|
*/
|
|
2637
3000
|
functions?: Record<string, FunctionResponse>;
|
|
2638
3001
|
/**
|
|
3002
|
+
* @public
|
|
2639
3003
|
* <p>The date and time when the component type was created.</p>
|
|
2640
3004
|
*/
|
|
2641
3005
|
creationDateTime: Date | undefined;
|
|
2642
3006
|
/**
|
|
3007
|
+
* @public
|
|
2643
3008
|
* <p>The date and time when the component was last updated.</p>
|
|
2644
3009
|
*/
|
|
2645
3010
|
updateDateTime: Date | undefined;
|
|
2646
3011
|
/**
|
|
3012
|
+
* @public
|
|
2647
3013
|
* <p>The ARN of the component type.</p>
|
|
2648
3014
|
*/
|
|
2649
3015
|
arn: string | undefined;
|
|
2650
3016
|
/**
|
|
3017
|
+
* @public
|
|
2651
3018
|
* <p>A Boolean value that specifies whether the component type is abstract.</p>
|
|
2652
3019
|
*/
|
|
2653
3020
|
isAbstract?: boolean;
|
|
2654
3021
|
/**
|
|
3022
|
+
* @public
|
|
2655
3023
|
* <p>A Boolean value that specifies whether the component type has a schema initializer and
|
|
2656
3024
|
* that the schema initializer has run.</p>
|
|
2657
3025
|
*/
|
|
2658
3026
|
isSchemaInitialized?: boolean;
|
|
2659
3027
|
/**
|
|
3028
|
+
* @public
|
|
2660
3029
|
* <p>The current status of the component type.</p>
|
|
2661
3030
|
*/
|
|
2662
3031
|
status?: Status;
|
|
2663
3032
|
/**
|
|
3033
|
+
* @public
|
|
2664
3034
|
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
2665
3035
|
* <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
|
|
2666
3036
|
*/
|
|
2667
3037
|
propertyGroups?: Record<string, PropertyGroupResponse>;
|
|
2668
3038
|
/**
|
|
3039
|
+
* @public
|
|
2669
3040
|
* <p>The syncSource of the SyncJob, if this entity was created by a SyncJob.</p>
|
|
2670
3041
|
*/
|
|
2671
3042
|
syncSource?: string;
|
|
2672
3043
|
/**
|
|
3044
|
+
* @public
|
|
2673
3045
|
* <p>The component type name.</p>
|
|
2674
3046
|
*/
|
|
2675
3047
|
componentTypeName?: string;
|
|
@@ -2679,41 +3051,50 @@ export interface GetComponentTypeResponse {
|
|
|
2679
3051
|
*/
|
|
2680
3052
|
export interface UpdateComponentTypeRequest {
|
|
2681
3053
|
/**
|
|
3054
|
+
* @public
|
|
2682
3055
|
* <p>The ID of the workspace.</p>
|
|
2683
3056
|
*/
|
|
2684
3057
|
workspaceId: string | undefined;
|
|
2685
3058
|
/**
|
|
3059
|
+
* @public
|
|
2686
3060
|
* <p>A Boolean value that specifies whether an entity can have more than one component of
|
|
2687
3061
|
* this type.</p>
|
|
2688
3062
|
*/
|
|
2689
3063
|
isSingleton?: boolean;
|
|
2690
3064
|
/**
|
|
3065
|
+
* @public
|
|
2691
3066
|
* <p>The ID of the component type.</p>
|
|
2692
3067
|
*/
|
|
2693
3068
|
componentTypeId: string | undefined;
|
|
2694
3069
|
/**
|
|
3070
|
+
* @public
|
|
2695
3071
|
* <p>The description of the component type.</p>
|
|
2696
3072
|
*/
|
|
2697
3073
|
description?: string;
|
|
2698
3074
|
/**
|
|
3075
|
+
* @public
|
|
2699
3076
|
* <p>An object that maps strings to the property definitions in the component type. Each
|
|
2700
3077
|
* string in the mapping must be unique to this object.</p>
|
|
2701
3078
|
*/
|
|
2702
3079
|
propertyDefinitions?: Record<string, PropertyDefinitionRequest>;
|
|
2703
3080
|
/**
|
|
3081
|
+
* @public
|
|
2704
3082
|
* <p>Specifies the component type that this component type extends.</p>
|
|
2705
3083
|
*/
|
|
2706
3084
|
extendsFrom?: string[];
|
|
2707
3085
|
/**
|
|
3086
|
+
* @public
|
|
2708
3087
|
* <p>An object that maps strings to the functions in the component type. Each string in the
|
|
2709
3088
|
* mapping must be unique to this object.</p>
|
|
2710
3089
|
*/
|
|
2711
3090
|
functions?: Record<string, FunctionRequest>;
|
|
2712
3091
|
/**
|
|
3092
|
+
* @public
|
|
2713
3093
|
* <p>The property groups.</p>
|
|
2714
3094
|
*/
|
|
2715
3095
|
propertyGroups?: Record<string, PropertyGroupRequest>;
|
|
2716
3096
|
/**
|
|
3097
|
+
* @public
|
|
2717
3098
|
* <p>The component type name.</p>
|
|
2718
3099
|
*/
|
|
2719
3100
|
componentTypeName?: string;
|
|
@@ -2724,14 +3105,17 @@ export interface UpdateComponentTypeRequest {
|
|
|
2724
3105
|
*/
|
|
2725
3106
|
export interface PropertyRequest {
|
|
2726
3107
|
/**
|
|
3108
|
+
* @public
|
|
2727
3109
|
* <p>An object that specifies information about a property.</p>
|
|
2728
3110
|
*/
|
|
2729
3111
|
definition?: PropertyDefinitionRequest;
|
|
2730
3112
|
/**
|
|
3113
|
+
* @public
|
|
2731
3114
|
* <p>The value of the property.</p>
|
|
2732
3115
|
*/
|
|
2733
3116
|
value?: DataValue;
|
|
2734
3117
|
/**
|
|
3118
|
+
* @public
|
|
2735
3119
|
* <p>The update type of the update property request.</p>
|
|
2736
3120
|
*/
|
|
2737
3121
|
updateType?: PropertyUpdateType | string;
|
|
@@ -2742,10 +3126,12 @@ export interface PropertyRequest {
|
|
|
2742
3126
|
*/
|
|
2743
3127
|
export interface PropertyResponse {
|
|
2744
3128
|
/**
|
|
3129
|
+
* @public
|
|
2745
3130
|
* <p>An object that specifies information about a property.</p>
|
|
2746
3131
|
*/
|
|
2747
3132
|
definition?: PropertyDefinitionResponse;
|
|
2748
3133
|
/**
|
|
3134
|
+
* @public
|
|
2749
3135
|
* <p>The value of the property.</p>
|
|
2750
3136
|
*/
|
|
2751
3137
|
value?: DataValue;
|
|
@@ -2756,19 +3142,23 @@ export interface PropertyResponse {
|
|
|
2756
3142
|
*/
|
|
2757
3143
|
export interface ComponentRequest {
|
|
2758
3144
|
/**
|
|
3145
|
+
* @public
|
|
2759
3146
|
* <p>The description of the component request.</p>
|
|
2760
3147
|
*/
|
|
2761
3148
|
description?: string;
|
|
2762
3149
|
/**
|
|
3150
|
+
* @public
|
|
2763
3151
|
* <p>The ID of the component type.</p>
|
|
2764
3152
|
*/
|
|
2765
3153
|
componentTypeId?: string;
|
|
2766
3154
|
/**
|
|
3155
|
+
* @public
|
|
2767
3156
|
* <p>An object that maps strings to the properties to set in the component type. Each string
|
|
2768
3157
|
* in the mapping must be unique to this object.</p>
|
|
2769
3158
|
*/
|
|
2770
3159
|
properties?: Record<string, PropertyRequest>;
|
|
2771
3160
|
/**
|
|
3161
|
+
* @public
|
|
2772
3162
|
* <p>The property groups.</p>
|
|
2773
3163
|
*/
|
|
2774
3164
|
propertyGroups?: Record<string, ComponentPropertyGroupRequest>;
|
|
@@ -2780,35 +3170,43 @@ export interface ComponentRequest {
|
|
|
2780
3170
|
*/
|
|
2781
3171
|
export interface ComponentResponse {
|
|
2782
3172
|
/**
|
|
3173
|
+
* @public
|
|
2783
3174
|
* <p>The name of the component.</p>
|
|
2784
3175
|
*/
|
|
2785
3176
|
componentName?: string;
|
|
2786
3177
|
/**
|
|
3178
|
+
* @public
|
|
2787
3179
|
* <p>The description of the component type.</p>
|
|
2788
3180
|
*/
|
|
2789
3181
|
description?: string;
|
|
2790
3182
|
/**
|
|
3183
|
+
* @public
|
|
2791
3184
|
* <p>The ID of the component type.</p>
|
|
2792
3185
|
*/
|
|
2793
3186
|
componentTypeId?: string;
|
|
2794
3187
|
/**
|
|
3188
|
+
* @public
|
|
2795
3189
|
* <p>The status of the component type.</p>
|
|
2796
3190
|
*/
|
|
2797
3191
|
status?: Status;
|
|
2798
3192
|
/**
|
|
3193
|
+
* @public
|
|
2799
3194
|
* <p>The name of the property definition set in the request.</p>
|
|
2800
3195
|
*/
|
|
2801
3196
|
definedIn?: string;
|
|
2802
3197
|
/**
|
|
3198
|
+
* @public
|
|
2803
3199
|
* <p>An object that maps strings to the properties to set in the component type. Each string
|
|
2804
3200
|
* in the mapping must be unique to this object.</p>
|
|
2805
3201
|
*/
|
|
2806
3202
|
properties?: Record<string, PropertyResponse>;
|
|
2807
3203
|
/**
|
|
3204
|
+
* @public
|
|
2808
3205
|
* <p>The property groups.</p>
|
|
2809
3206
|
*/
|
|
2810
3207
|
propertyGroups?: Record<string, ComponentPropertyGroupResponse>;
|
|
2811
3208
|
/**
|
|
3209
|
+
* @public
|
|
2812
3210
|
* <p>The syncSource of the sync job, if this entity was created by a sync job.</p>
|
|
2813
3211
|
*/
|
|
2814
3212
|
syncSource?: string;
|
|
@@ -2819,23 +3217,28 @@ export interface ComponentResponse {
|
|
|
2819
3217
|
*/
|
|
2820
3218
|
export interface ComponentUpdateRequest {
|
|
2821
3219
|
/**
|
|
3220
|
+
* @public
|
|
2822
3221
|
* <p>The update type of the component update request.</p>
|
|
2823
3222
|
*/
|
|
2824
3223
|
updateType?: ComponentUpdateType | string;
|
|
2825
3224
|
/**
|
|
3225
|
+
* @public
|
|
2826
3226
|
* <p>The description of the component type.</p>
|
|
2827
3227
|
*/
|
|
2828
3228
|
description?: string;
|
|
2829
3229
|
/**
|
|
3230
|
+
* @public
|
|
2830
3231
|
* <p>The ID of the component type.</p>
|
|
2831
3232
|
*/
|
|
2832
3233
|
componentTypeId?: string;
|
|
2833
3234
|
/**
|
|
3235
|
+
* @public
|
|
2834
3236
|
* <p>An object that maps strings to the properties to set in the component type update. Each
|
|
2835
3237
|
* string in the mapping must be unique to this object.</p>
|
|
2836
3238
|
*/
|
|
2837
3239
|
propertyUpdates?: Record<string, PropertyRequest>;
|
|
2838
3240
|
/**
|
|
3241
|
+
* @public
|
|
2839
3242
|
* <p>The property group updates.</p>
|
|
2840
3243
|
*/
|
|
2841
3244
|
propertyGroupUpdates?: Record<string, ComponentPropertyGroupRequest>;
|
|
@@ -2845,31 +3248,38 @@ export interface ComponentUpdateRequest {
|
|
|
2845
3248
|
*/
|
|
2846
3249
|
export interface CreateEntityRequest {
|
|
2847
3250
|
/**
|
|
3251
|
+
* @public
|
|
2848
3252
|
* <p>The ID of the workspace that contains the entity.</p>
|
|
2849
3253
|
*/
|
|
2850
3254
|
workspaceId: string | undefined;
|
|
2851
3255
|
/**
|
|
3256
|
+
* @public
|
|
2852
3257
|
* <p>The ID of the entity.</p>
|
|
2853
3258
|
*/
|
|
2854
3259
|
entityId?: string;
|
|
2855
3260
|
/**
|
|
3261
|
+
* @public
|
|
2856
3262
|
* <p>The name of the entity.</p>
|
|
2857
3263
|
*/
|
|
2858
3264
|
entityName: string | undefined;
|
|
2859
3265
|
/**
|
|
3266
|
+
* @public
|
|
2860
3267
|
* <p>The description of the entity.</p>
|
|
2861
3268
|
*/
|
|
2862
3269
|
description?: string;
|
|
2863
3270
|
/**
|
|
3271
|
+
* @public
|
|
2864
3272
|
* <p>An object that maps strings to the components in the entity. Each string in the mapping
|
|
2865
3273
|
* must be unique to this object.</p>
|
|
2866
3274
|
*/
|
|
2867
3275
|
components?: Record<string, ComponentRequest>;
|
|
2868
3276
|
/**
|
|
3277
|
+
* @public
|
|
2869
3278
|
* <p>The ID of the entity's parent entity.</p>
|
|
2870
3279
|
*/
|
|
2871
3280
|
parentEntityId?: string;
|
|
2872
3281
|
/**
|
|
3282
|
+
* @public
|
|
2873
3283
|
* <p>Metadata that you can use to manage the entity.</p>
|
|
2874
3284
|
*/
|
|
2875
3285
|
tags?: Record<string, string>;
|
|
@@ -2879,51 +3289,63 @@ export interface CreateEntityRequest {
|
|
|
2879
3289
|
*/
|
|
2880
3290
|
export interface GetEntityResponse {
|
|
2881
3291
|
/**
|
|
3292
|
+
* @public
|
|
2882
3293
|
* <p>The ID of the entity.</p>
|
|
2883
3294
|
*/
|
|
2884
3295
|
entityId: string | undefined;
|
|
2885
3296
|
/**
|
|
3297
|
+
* @public
|
|
2886
3298
|
* <p>The name of the entity.</p>
|
|
2887
3299
|
*/
|
|
2888
3300
|
entityName: string | undefined;
|
|
2889
3301
|
/**
|
|
3302
|
+
* @public
|
|
2890
3303
|
* <p>The ARN of the entity.</p>
|
|
2891
3304
|
*/
|
|
2892
3305
|
arn: string | undefined;
|
|
2893
3306
|
/**
|
|
3307
|
+
* @public
|
|
2894
3308
|
* <p>The current status of the entity.</p>
|
|
2895
3309
|
*/
|
|
2896
3310
|
status: Status | undefined;
|
|
2897
3311
|
/**
|
|
3312
|
+
* @public
|
|
2898
3313
|
* <p>The ID of the workspace.</p>
|
|
2899
3314
|
*/
|
|
2900
3315
|
workspaceId: string | undefined;
|
|
2901
3316
|
/**
|
|
3317
|
+
* @public
|
|
2902
3318
|
* <p>The description of the entity.</p>
|
|
2903
3319
|
*/
|
|
2904
3320
|
description?: string;
|
|
2905
3321
|
/**
|
|
3322
|
+
* @public
|
|
2906
3323
|
* <p>An object that maps strings to the components in the entity. Each string in the mapping
|
|
2907
3324
|
* must be unique to this object.</p>
|
|
2908
3325
|
*/
|
|
2909
3326
|
components?: Record<string, ComponentResponse>;
|
|
2910
3327
|
/**
|
|
3328
|
+
* @public
|
|
2911
3329
|
* <p>The ID of the parent entity for this entity.</p>
|
|
2912
3330
|
*/
|
|
2913
3331
|
parentEntityId: string | undefined;
|
|
2914
3332
|
/**
|
|
3333
|
+
* @public
|
|
2915
3334
|
* <p>A Boolean value that specifies whether the entity has associated child entities.</p>
|
|
2916
3335
|
*/
|
|
2917
3336
|
hasChildEntities: boolean | undefined;
|
|
2918
3337
|
/**
|
|
3338
|
+
* @public
|
|
2919
3339
|
* <p>The date and time when the entity was created.</p>
|
|
2920
3340
|
*/
|
|
2921
3341
|
creationDateTime: Date | undefined;
|
|
2922
3342
|
/**
|
|
3343
|
+
* @public
|
|
2923
3344
|
* <p>The date and time when the entity was last updated.</p>
|
|
2924
3345
|
*/
|
|
2925
3346
|
updateDateTime: Date | undefined;
|
|
2926
3347
|
/**
|
|
3348
|
+
* @public
|
|
2927
3349
|
* <p>The syncSource of the sync job, if this entity was created by a sync job.</p>
|
|
2928
3350
|
*/
|
|
2929
3351
|
syncSource?: string;
|
|
@@ -2933,27 +3355,33 @@ export interface GetEntityResponse {
|
|
|
2933
3355
|
*/
|
|
2934
3356
|
export interface UpdateEntityRequest {
|
|
2935
3357
|
/**
|
|
3358
|
+
* @public
|
|
2936
3359
|
* <p>The ID of the workspace that contains the entity.</p>
|
|
2937
3360
|
*/
|
|
2938
3361
|
workspaceId: string | undefined;
|
|
2939
3362
|
/**
|
|
3363
|
+
* @public
|
|
2940
3364
|
* <p>The ID of the entity.</p>
|
|
2941
3365
|
*/
|
|
2942
3366
|
entityId: string | undefined;
|
|
2943
3367
|
/**
|
|
3368
|
+
* @public
|
|
2944
3369
|
* <p>The name of the entity.</p>
|
|
2945
3370
|
*/
|
|
2946
3371
|
entityName?: string;
|
|
2947
3372
|
/**
|
|
3373
|
+
* @public
|
|
2948
3374
|
* <p>The description of the entity.</p>
|
|
2949
3375
|
*/
|
|
2950
3376
|
description?: string;
|
|
2951
3377
|
/**
|
|
3378
|
+
* @public
|
|
2952
3379
|
* <p>An object that maps strings to the component updates in the request. Each string in the
|
|
2953
3380
|
* mapping must be unique to this object.</p>
|
|
2954
3381
|
*/
|
|
2955
3382
|
componentUpdates?: Record<string, ComponentUpdateRequest>;
|
|
2956
3383
|
/**
|
|
3384
|
+
* @public
|
|
2957
3385
|
* <p>An object that describes the update request for a parent entity.</p>
|
|
2958
3386
|
*/
|
|
2959
3387
|
parentEntityUpdate?: ParentEntityUpdateRequest;
|