@aws-sdk/client-iottwinmaker 3.296.0 → 3.297.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/README.md +7 -5
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/protocols/Aws_restJson1.js +39 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/protocols/Aws_restJson1.js +39 -0
- package/dist-types/IoTTwinMaker.d.ts +51 -10
- package/dist-types/IoTTwinMakerClient.d.ts +31 -9
- package/dist-types/commands/BatchPutPropertyValuesCommand.d.ts +16 -0
- package/dist-types/commands/CreateComponentTypeCommand.d.ts +16 -0
- package/dist-types/commands/CreateEntityCommand.d.ts +16 -0
- package/dist-types/commands/CreateSceneCommand.d.ts +16 -0
- package/dist-types/commands/CreateSyncJobCommand.d.ts +16 -0
- package/dist-types/commands/CreateWorkspaceCommand.d.ts +16 -0
- package/dist-types/commands/DeleteComponentTypeCommand.d.ts +16 -0
- package/dist-types/commands/DeleteEntityCommand.d.ts +16 -0
- package/dist-types/commands/DeleteSceneCommand.d.ts +16 -0
- package/dist-types/commands/DeleteSyncJobCommand.d.ts +16 -0
- package/dist-types/commands/DeleteWorkspaceCommand.d.ts +16 -0
- package/dist-types/commands/ExecuteQueryCommand.d.ts +18 -1
- package/dist-types/commands/GetComponentTypeCommand.d.ts +16 -0
- package/dist-types/commands/GetEntityCommand.d.ts +16 -0
- package/dist-types/commands/GetPricingPlanCommand.d.ts +16 -0
- package/dist-types/commands/GetPropertyValueCommand.d.ts +18 -1
- package/dist-types/commands/GetPropertyValueHistoryCommand.d.ts +21 -3
- package/dist-types/commands/GetSceneCommand.d.ts +16 -0
- package/dist-types/commands/GetSyncJobCommand.d.ts +16 -0
- package/dist-types/commands/GetWorkspaceCommand.d.ts +16 -0
- package/dist-types/commands/ListComponentTypesCommand.d.ts +16 -0
- package/dist-types/commands/ListEntitiesCommand.d.ts +16 -0
- package/dist-types/commands/ListScenesCommand.d.ts +16 -0
- package/dist-types/commands/ListSyncJobsCommand.d.ts +16 -0
- package/dist-types/commands/ListSyncResourcesCommand.d.ts +16 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
- package/dist-types/commands/ListWorkspacesCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateComponentTypeCommand.d.ts +16 -0
- package/dist-types/commands/UpdateEntityCommand.d.ts +16 -0
- package/dist-types/commands/UpdatePricingPlanCommand.d.ts +16 -0
- package/dist-types/commands/UpdateSceneCommand.d.ts +16 -0
- package/dist-types/commands/UpdateWorkspaceCommand.d.ts +16 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/IoTTwinMakerServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +463 -82
- package/dist-types/pagination/ExecuteQueryPaginator.d.ts +3 -0
- package/dist-types/pagination/GetPropertyValueHistoryPaginator.d.ts +3 -0
- package/dist-types/pagination/GetPropertyValuePaginator.d.ts +3 -0
- package/dist-types/pagination/Interfaces.d.ts +3 -0
- package/dist-types/pagination/ListComponentTypesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListEntitiesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListScenesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListSyncJobsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListSyncResourcesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListWorkspacesPaginator.d.ts +3 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +4 -0
- package/package.json +3 -3
|
@@ -2,6 +2,7 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-cl
|
|
|
2
2
|
import { DocumentType as __DocumentType } from "@aws-sdk/types";
|
|
3
3
|
import { IoTTwinMakerServiceException as __BaseException } from "./IoTTwinMakerServiceException";
|
|
4
4
|
/**
|
|
5
|
+
* @public
|
|
5
6
|
* <p>Access is denied.</p>
|
|
6
7
|
*/
|
|
7
8
|
export declare class AccessDeniedException extends __BaseException {
|
|
@@ -13,6 +14,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
13
14
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
15
|
}
|
|
15
16
|
/**
|
|
17
|
+
* @public
|
|
16
18
|
* <p>An object that uniquely identifies an entity property.</p>
|
|
17
19
|
*/
|
|
18
20
|
export interface EntityPropertyReference {
|
|
@@ -21,7 +23,8 @@ export interface EntityPropertyReference {
|
|
|
21
23
|
*/
|
|
22
24
|
componentName?: string;
|
|
23
25
|
/**
|
|
24
|
-
* <p>A mapping of external IDs to property names. External IDs uniquely identify properties
|
|
26
|
+
* <p>A mapping of external IDs to property names. External IDs uniquely identify properties
|
|
27
|
+
* from external data stores.</p>
|
|
25
28
|
*/
|
|
26
29
|
externalIdProperty?: Record<string, string>;
|
|
27
30
|
/**
|
|
@@ -34,6 +37,7 @@ export interface EntityPropertyReference {
|
|
|
34
37
|
propertyName: string | undefined;
|
|
35
38
|
}
|
|
36
39
|
/**
|
|
40
|
+
* @public
|
|
37
41
|
* <p>A value that associates a component and an entity.</p>
|
|
38
42
|
*/
|
|
39
43
|
export interface RelationshipValue {
|
|
@@ -47,6 +51,7 @@ export interface RelationshipValue {
|
|
|
47
51
|
targetComponentName?: string;
|
|
48
52
|
}
|
|
49
53
|
/**
|
|
54
|
+
* @public
|
|
50
55
|
* <p>An unexpected error has occurred.</p>
|
|
51
56
|
*/
|
|
52
57
|
export declare class InternalServerException extends __BaseException {
|
|
@@ -58,6 +63,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
58
63
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
59
64
|
}
|
|
60
65
|
/**
|
|
66
|
+
* @public
|
|
61
67
|
* <p>The resource wasn't found.</p>
|
|
62
68
|
*/
|
|
63
69
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
@@ -69,6 +75,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
69
75
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
70
76
|
}
|
|
71
77
|
/**
|
|
78
|
+
* @public
|
|
72
79
|
* <p>The rate exceeds the limit.</p>
|
|
73
80
|
*/
|
|
74
81
|
export declare class ThrottlingException extends __BaseException {
|
|
@@ -80,6 +87,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
80
87
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
81
88
|
}
|
|
82
89
|
/**
|
|
90
|
+
* @public
|
|
83
91
|
* <p>Failed</p>
|
|
84
92
|
*/
|
|
85
93
|
export declare class ValidationException extends __BaseException {
|
|
@@ -91,6 +99,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
91
99
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
92
100
|
}
|
|
93
101
|
/**
|
|
102
|
+
* @public
|
|
94
103
|
* <p>A conflict occurred.</p>
|
|
95
104
|
*/
|
|
96
105
|
export declare class ConflictException extends __BaseException {
|
|
@@ -102,6 +111,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
102
111
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
103
112
|
}
|
|
104
113
|
/**
|
|
114
|
+
* @public
|
|
105
115
|
* <p>The Lambda function.</p>
|
|
106
116
|
*/
|
|
107
117
|
export interface LambdaFunction {
|
|
@@ -111,6 +121,7 @@ export interface LambdaFunction {
|
|
|
111
121
|
arn: string | undefined;
|
|
112
122
|
}
|
|
113
123
|
/**
|
|
124
|
+
* @public
|
|
114
125
|
* <p>The data connector.</p>
|
|
115
126
|
*/
|
|
116
127
|
export interface DataConnector {
|
|
@@ -119,15 +130,20 @@ export interface DataConnector {
|
|
|
119
130
|
*/
|
|
120
131
|
lambda?: LambdaFunction;
|
|
121
132
|
/**
|
|
122
|
-
* <p>A Boolean value that specifies whether the data connector is native to IoT
|
|
133
|
+
* <p>A Boolean value that specifies whether the data connector is native to IoT
|
|
134
|
+
* TwinMaker.</p>
|
|
123
135
|
*/
|
|
124
136
|
isNative?: boolean;
|
|
125
137
|
}
|
|
138
|
+
/**
|
|
139
|
+
* @public
|
|
140
|
+
*/
|
|
126
141
|
export declare enum Scope {
|
|
127
142
|
ENTITY = "ENTITY",
|
|
128
143
|
WORKSPACE = "WORKSPACE"
|
|
129
144
|
}
|
|
130
145
|
/**
|
|
146
|
+
* @public
|
|
131
147
|
* <p>The function request body.</p>
|
|
132
148
|
*/
|
|
133
149
|
export interface FunctionRequest {
|
|
@@ -145,6 +161,7 @@ export interface FunctionRequest {
|
|
|
145
161
|
implementedBy?: DataConnector;
|
|
146
162
|
}
|
|
147
163
|
/**
|
|
164
|
+
* @public
|
|
148
165
|
* <p>An object that specifies a relationship with another component type.</p>
|
|
149
166
|
*/
|
|
150
167
|
export interface Relationship {
|
|
@@ -157,6 +174,9 @@ export interface Relationship {
|
|
|
157
174
|
*/
|
|
158
175
|
relationshipType?: string;
|
|
159
176
|
}
|
|
177
|
+
/**
|
|
178
|
+
* @public
|
|
179
|
+
*/
|
|
160
180
|
export declare enum Type {
|
|
161
181
|
BOOLEAN = "BOOLEAN",
|
|
162
182
|
DOUBLE = "DOUBLE",
|
|
@@ -167,10 +187,14 @@ export declare enum Type {
|
|
|
167
187
|
RELATIONSHIP = "RELATIONSHIP",
|
|
168
188
|
STRING = "STRING"
|
|
169
189
|
}
|
|
190
|
+
/**
|
|
191
|
+
* @public
|
|
192
|
+
*/
|
|
170
193
|
export declare enum GroupType {
|
|
171
194
|
TABULAR = "TABULAR"
|
|
172
195
|
}
|
|
173
196
|
/**
|
|
197
|
+
* @public
|
|
174
198
|
* <p/>
|
|
175
199
|
*/
|
|
176
200
|
export interface PropertyGroupRequest {
|
|
@@ -183,6 +207,9 @@ export interface PropertyGroupRequest {
|
|
|
183
207
|
*/
|
|
184
208
|
propertyNames?: string[];
|
|
185
209
|
}
|
|
210
|
+
/**
|
|
211
|
+
* @public
|
|
212
|
+
*/
|
|
186
213
|
export declare enum State {
|
|
187
214
|
ACTIVE = "ACTIVE",
|
|
188
215
|
CREATING = "CREATING",
|
|
@@ -190,6 +217,9 @@ export declare enum State {
|
|
|
190
217
|
ERROR = "ERROR",
|
|
191
218
|
UPDATING = "UPDATING"
|
|
192
219
|
}
|
|
220
|
+
/**
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
193
223
|
export interface CreateComponentTypeResponse {
|
|
194
224
|
/**
|
|
195
225
|
* <p>The ARN of the component type.</p>
|
|
@@ -205,6 +235,7 @@ export interface CreateComponentTypeResponse {
|
|
|
205
235
|
state: State | string | undefined;
|
|
206
236
|
}
|
|
207
237
|
/**
|
|
238
|
+
* @public
|
|
208
239
|
* <p>The service quota was exceeded.</p>
|
|
209
240
|
*/
|
|
210
241
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
@@ -215,18 +246,25 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
215
246
|
*/
|
|
216
247
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
217
248
|
}
|
|
249
|
+
/**
|
|
250
|
+
* @public
|
|
251
|
+
*/
|
|
218
252
|
export declare enum PropertyUpdateType {
|
|
219
253
|
CREATE = "CREATE",
|
|
220
254
|
DELETE = "DELETE",
|
|
221
255
|
UPDATE = "UPDATE"
|
|
222
256
|
}
|
|
257
|
+
/**
|
|
258
|
+
* @public
|
|
259
|
+
*/
|
|
223
260
|
export declare enum PropertyGroupUpdateType {
|
|
224
261
|
CREATE = "CREATE",
|
|
225
262
|
DELETE = "DELETE",
|
|
226
263
|
UPDATE = "UPDATE"
|
|
227
264
|
}
|
|
228
265
|
/**
|
|
229
|
-
*
|
|
266
|
+
* @public
|
|
267
|
+
* <p>The component property group request.</p>
|
|
230
268
|
*/
|
|
231
269
|
export interface ComponentPropertyGroupRequest {
|
|
232
270
|
/**
|
|
@@ -242,6 +280,9 @@ export interface ComponentPropertyGroupRequest {
|
|
|
242
280
|
*/
|
|
243
281
|
updateType?: PropertyGroupUpdateType | string;
|
|
244
282
|
}
|
|
283
|
+
/**
|
|
284
|
+
* @public
|
|
285
|
+
*/
|
|
245
286
|
export interface CreateEntityResponse {
|
|
246
287
|
/**
|
|
247
288
|
* <p>The ID of the entity.</p>
|
|
@@ -260,6 +301,9 @@ export interface CreateEntityResponse {
|
|
|
260
301
|
*/
|
|
261
302
|
state: State | string | undefined;
|
|
262
303
|
}
|
|
304
|
+
/**
|
|
305
|
+
* @public
|
|
306
|
+
*/
|
|
263
307
|
export interface CreateSceneRequest {
|
|
264
308
|
/**
|
|
265
309
|
* <p>The ID of the workspace that contains the scene.</p>
|
|
@@ -285,7 +329,14 @@ export interface CreateSceneRequest {
|
|
|
285
329
|
* <p>Metadata that you can use to manage the scene.</p>
|
|
286
330
|
*/
|
|
287
331
|
tags?: Record<string, string>;
|
|
332
|
+
/**
|
|
333
|
+
* <p>The request metadata.</p>
|
|
334
|
+
*/
|
|
335
|
+
sceneMetadata?: Record<string, string>;
|
|
288
336
|
}
|
|
337
|
+
/**
|
|
338
|
+
* @public
|
|
339
|
+
*/
|
|
289
340
|
export interface CreateSceneResponse {
|
|
290
341
|
/**
|
|
291
342
|
* <p>The ARN of the scene.</p>
|
|
@@ -296,21 +347,24 @@ export interface CreateSceneResponse {
|
|
|
296
347
|
*/
|
|
297
348
|
creationDateTime: Date | undefined;
|
|
298
349
|
}
|
|
350
|
+
/**
|
|
351
|
+
* @public
|
|
352
|
+
*/
|
|
299
353
|
export interface CreateSyncJobRequest {
|
|
300
354
|
/**
|
|
301
|
-
* <p>The workspace
|
|
355
|
+
* <p>The workspace ID.</p>
|
|
302
356
|
*/
|
|
303
357
|
workspaceId: string | undefined;
|
|
304
358
|
/**
|
|
305
359
|
* <p>The sync source.</p>
|
|
306
360
|
* <note>
|
|
307
|
-
* <p>Currently the only supported
|
|
361
|
+
* <p>Currently the only supported syncSoource is <code>SITEWISE </code>.</p>
|
|
308
362
|
* </note>
|
|
309
363
|
*/
|
|
310
364
|
syncSource: string | undefined;
|
|
311
365
|
/**
|
|
312
|
-
* <p>The SyncJob IAM role. This IAM role is used by the
|
|
313
|
-
* update or delete the corresponding resources.</p>
|
|
366
|
+
* <p>The SyncJob IAM role. This IAM role is used by the SyncJob to read from the syncSource,
|
|
367
|
+
* and create, update, or delete the corresponding resources.</p>
|
|
314
368
|
*/
|
|
315
369
|
syncRole: string | undefined;
|
|
316
370
|
/**
|
|
@@ -318,6 +372,9 @@ export interface CreateSyncJobRequest {
|
|
|
318
372
|
*/
|
|
319
373
|
tags?: Record<string, string>;
|
|
320
374
|
}
|
|
375
|
+
/**
|
|
376
|
+
* @public
|
|
377
|
+
*/
|
|
321
378
|
export declare enum SyncJobState {
|
|
322
379
|
ACTIVE = "ACTIVE",
|
|
323
380
|
CREATING = "CREATING",
|
|
@@ -325,6 +382,9 @@ export declare enum SyncJobState {
|
|
|
325
382
|
ERROR = "ERROR",
|
|
326
383
|
INITIALIZING = "INITIALIZING"
|
|
327
384
|
}
|
|
385
|
+
/**
|
|
386
|
+
* @public
|
|
387
|
+
*/
|
|
328
388
|
export interface CreateSyncJobResponse {
|
|
329
389
|
/**
|
|
330
390
|
* <p>The SyncJob ARN.</p>
|
|
@@ -339,6 +399,9 @@ export interface CreateSyncJobResponse {
|
|
|
339
399
|
*/
|
|
340
400
|
state: SyncJobState | string | undefined;
|
|
341
401
|
}
|
|
402
|
+
/**
|
|
403
|
+
* @public
|
|
404
|
+
*/
|
|
342
405
|
export interface CreateWorkspaceRequest {
|
|
343
406
|
/**
|
|
344
407
|
* <p>The ID of the workspace.</p>
|
|
@@ -349,7 +412,8 @@ export interface CreateWorkspaceRequest {
|
|
|
349
412
|
*/
|
|
350
413
|
description?: string;
|
|
351
414
|
/**
|
|
352
|
-
* <p>The ARN of the S3 bucket where resources associated with the workspace are
|
|
415
|
+
* <p>The ARN of the S3 bucket where resources associated with the workspace are
|
|
416
|
+
* stored.</p>
|
|
353
417
|
*/
|
|
354
418
|
s3Location: string | undefined;
|
|
355
419
|
/**
|
|
@@ -361,6 +425,9 @@ export interface CreateWorkspaceRequest {
|
|
|
361
425
|
*/
|
|
362
426
|
tags?: Record<string, string>;
|
|
363
427
|
}
|
|
428
|
+
/**
|
|
429
|
+
* @public
|
|
430
|
+
*/
|
|
364
431
|
export interface CreateWorkspaceResponse {
|
|
365
432
|
/**
|
|
366
433
|
* <p>The ARN of the workspace.</p>
|
|
@@ -371,6 +438,9 @@ export interface CreateWorkspaceResponse {
|
|
|
371
438
|
*/
|
|
372
439
|
creationDateTime: Date | undefined;
|
|
373
440
|
}
|
|
441
|
+
/**
|
|
442
|
+
* @public
|
|
443
|
+
*/
|
|
374
444
|
export interface DeleteComponentTypeRequest {
|
|
375
445
|
/**
|
|
376
446
|
* <p>The ID of the workspace that contains the component type.</p>
|
|
@@ -381,12 +451,18 @@ export interface DeleteComponentTypeRequest {
|
|
|
381
451
|
*/
|
|
382
452
|
componentTypeId: string | undefined;
|
|
383
453
|
}
|
|
454
|
+
/**
|
|
455
|
+
* @public
|
|
456
|
+
*/
|
|
384
457
|
export interface DeleteComponentTypeResponse {
|
|
385
458
|
/**
|
|
386
459
|
* <p>The current state of the component type to be deleted.</p>
|
|
387
460
|
*/
|
|
388
461
|
state: State | string | undefined;
|
|
389
462
|
}
|
|
463
|
+
/**
|
|
464
|
+
* @public
|
|
465
|
+
*/
|
|
390
466
|
export interface DeleteEntityRequest {
|
|
391
467
|
/**
|
|
392
468
|
* <p>The ID of the workspace that contains the entity to delete.</p>
|
|
@@ -401,12 +477,18 @@ export interface DeleteEntityRequest {
|
|
|
401
477
|
*/
|
|
402
478
|
isRecursive?: boolean;
|
|
403
479
|
}
|
|
480
|
+
/**
|
|
481
|
+
* @public
|
|
482
|
+
*/
|
|
404
483
|
export interface DeleteEntityResponse {
|
|
405
484
|
/**
|
|
406
485
|
* <p>The current state of the deleted entity.</p>
|
|
407
486
|
*/
|
|
408
487
|
state: State | string | undefined;
|
|
409
488
|
}
|
|
489
|
+
/**
|
|
490
|
+
* @public
|
|
491
|
+
*/
|
|
410
492
|
export interface DeleteSceneRequest {
|
|
411
493
|
/**
|
|
412
494
|
* <p>The ID of the workspace.</p>
|
|
@@ -417,35 +499,53 @@ export interface DeleteSceneRequest {
|
|
|
417
499
|
*/
|
|
418
500
|
sceneId: string | undefined;
|
|
419
501
|
}
|
|
502
|
+
/**
|
|
503
|
+
* @public
|
|
504
|
+
*/
|
|
420
505
|
export interface DeleteSceneResponse {
|
|
421
506
|
}
|
|
507
|
+
/**
|
|
508
|
+
* @public
|
|
509
|
+
*/
|
|
422
510
|
export interface DeleteSyncJobRequest {
|
|
423
511
|
/**
|
|
424
|
-
* <p>The workspace
|
|
512
|
+
* <p>The workspace ID.</p>
|
|
425
513
|
*/
|
|
426
514
|
workspaceId: string | undefined;
|
|
427
515
|
/**
|
|
428
516
|
* <p>The sync source.</p>
|
|
429
517
|
* <note>
|
|
430
|
-
* <p>Currently the only supported
|
|
518
|
+
* <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p>
|
|
431
519
|
* </note>
|
|
432
520
|
*/
|
|
433
521
|
syncSource: string | undefined;
|
|
434
522
|
}
|
|
523
|
+
/**
|
|
524
|
+
* @public
|
|
525
|
+
*/
|
|
435
526
|
export interface DeleteSyncJobResponse {
|
|
436
527
|
/**
|
|
437
528
|
* <p>The SyncJob response state.</p>
|
|
438
529
|
*/
|
|
439
530
|
state: SyncJobState | string | undefined;
|
|
440
531
|
}
|
|
532
|
+
/**
|
|
533
|
+
* @public
|
|
534
|
+
*/
|
|
441
535
|
export interface DeleteWorkspaceRequest {
|
|
442
536
|
/**
|
|
443
537
|
* <p>The ID of the workspace to delete.</p>
|
|
444
538
|
*/
|
|
445
539
|
workspaceId: string | undefined;
|
|
446
540
|
}
|
|
541
|
+
/**
|
|
542
|
+
* @public
|
|
543
|
+
*/
|
|
447
544
|
export interface DeleteWorkspaceResponse {
|
|
448
545
|
}
|
|
546
|
+
/**
|
|
547
|
+
* @public
|
|
548
|
+
*/
|
|
449
549
|
export interface ExecuteQueryRequest {
|
|
450
550
|
/**
|
|
451
551
|
* <p>The ID of the workspace.</p>
|
|
@@ -465,12 +565,16 @@ export interface ExecuteQueryRequest {
|
|
|
465
565
|
*/
|
|
466
566
|
nextToken?: string;
|
|
467
567
|
}
|
|
568
|
+
/**
|
|
569
|
+
* @public
|
|
570
|
+
*/
|
|
468
571
|
export declare enum ColumnType {
|
|
469
572
|
EDGE = "EDGE",
|
|
470
573
|
NODE = "NODE",
|
|
471
574
|
VALUE = "VALUE"
|
|
472
575
|
}
|
|
473
576
|
/**
|
|
577
|
+
* @public
|
|
474
578
|
* <p>A description of the column in the query results.</p>
|
|
475
579
|
*/
|
|
476
580
|
export interface ColumnDescription {
|
|
@@ -484,6 +588,7 @@ export interface ColumnDescription {
|
|
|
484
588
|
type?: ColumnType | string;
|
|
485
589
|
}
|
|
486
590
|
/**
|
|
591
|
+
* @public
|
|
487
592
|
* <p>Represents a single row in the query results.</p>
|
|
488
593
|
*/
|
|
489
594
|
export interface Row {
|
|
@@ -492,6 +597,9 @@ export interface Row {
|
|
|
492
597
|
*/
|
|
493
598
|
rowData?: __DocumentType[];
|
|
494
599
|
}
|
|
600
|
+
/**
|
|
601
|
+
* @public
|
|
602
|
+
*/
|
|
495
603
|
export interface ExecuteQueryResponse {
|
|
496
604
|
/**
|
|
497
605
|
* <p>A list of ColumnDescription objects.</p>
|
|
@@ -507,6 +615,7 @@ export interface ExecuteQueryResponse {
|
|
|
507
615
|
nextToken?: string;
|
|
508
616
|
}
|
|
509
617
|
/**
|
|
618
|
+
* @public
|
|
510
619
|
* <p>The query timeout exception.</p>
|
|
511
620
|
*/
|
|
512
621
|
export declare class QueryTimeoutException extends __BaseException {
|
|
@@ -518,6 +627,9 @@ export declare class QueryTimeoutException extends __BaseException {
|
|
|
518
627
|
*/
|
|
519
628
|
constructor(opts: __ExceptionOptionType<QueryTimeoutException, __BaseException>);
|
|
520
629
|
}
|
|
630
|
+
/**
|
|
631
|
+
* @public
|
|
632
|
+
*/
|
|
521
633
|
export interface GetComponentTypeRequest {
|
|
522
634
|
/**
|
|
523
635
|
* <p>The ID of the workspace that contains the component type.</p>
|
|
@@ -529,6 +641,7 @@ export interface GetComponentTypeRequest {
|
|
|
529
641
|
componentTypeId: string | undefined;
|
|
530
642
|
}
|
|
531
643
|
/**
|
|
644
|
+
* @public
|
|
532
645
|
* <p>The function response.</p>
|
|
533
646
|
*/
|
|
534
647
|
export interface FunctionResponse {
|
|
@@ -550,6 +663,7 @@ export interface FunctionResponse {
|
|
|
550
663
|
isInherited?: boolean;
|
|
551
664
|
}
|
|
552
665
|
/**
|
|
666
|
+
* @public
|
|
553
667
|
* <p>The property group response</p>
|
|
554
668
|
*/
|
|
555
669
|
export interface PropertyGroupResponse {
|
|
@@ -562,10 +676,14 @@ export interface PropertyGroupResponse {
|
|
|
562
676
|
*/
|
|
563
677
|
propertyNames: string[] | undefined;
|
|
564
678
|
/**
|
|
565
|
-
* <p>A Boolean value that specifies whether the property group is inherited from a parent
|
|
679
|
+
* <p>A Boolean value that specifies whether the property group is inherited from a parent
|
|
680
|
+
* entity</p>
|
|
566
681
|
*/
|
|
567
682
|
isInherited: boolean | undefined;
|
|
568
683
|
}
|
|
684
|
+
/**
|
|
685
|
+
* @public
|
|
686
|
+
*/
|
|
569
687
|
export declare enum ErrorCode {
|
|
570
688
|
INTERNAL_FAILURE = "INTERNAL_FAILURE",
|
|
571
689
|
SYNC_CREATING_ERROR = "SYNC_CREATING_ERROR",
|
|
@@ -574,6 +692,7 @@ export declare enum ErrorCode {
|
|
|
574
692
|
VALIDATION_ERROR = "VALIDATION_ERROR"
|
|
575
693
|
}
|
|
576
694
|
/**
|
|
695
|
+
* @public
|
|
577
696
|
* <p>The error details.</p>
|
|
578
697
|
*/
|
|
579
698
|
export interface ErrorDetails {
|
|
@@ -587,7 +706,9 @@ export interface ErrorDetails {
|
|
|
587
706
|
message?: string;
|
|
588
707
|
}
|
|
589
708
|
/**
|
|
590
|
-
*
|
|
709
|
+
* @public
|
|
710
|
+
* <p>An object that represents the status of an entity, component, component type, or
|
|
711
|
+
* workspace.</p>
|
|
591
712
|
*/
|
|
592
713
|
export interface Status {
|
|
593
714
|
/**
|
|
@@ -599,6 +720,9 @@ export interface Status {
|
|
|
599
720
|
*/
|
|
600
721
|
error?: ErrorDetails;
|
|
601
722
|
}
|
|
723
|
+
/**
|
|
724
|
+
* @public
|
|
725
|
+
*/
|
|
602
726
|
export interface GetEntityRequest {
|
|
603
727
|
/**
|
|
604
728
|
* <p>The ID of the workspace.</p>
|
|
@@ -610,6 +734,7 @@ export interface GetEntityRequest {
|
|
|
610
734
|
entityId: string | undefined;
|
|
611
735
|
}
|
|
612
736
|
/**
|
|
737
|
+
* @public
|
|
613
738
|
* <p>The component property group response.</p>
|
|
614
739
|
*/
|
|
615
740
|
export interface ComponentPropertyGroupResponse {
|
|
@@ -622,12 +747,19 @@ export interface ComponentPropertyGroupResponse {
|
|
|
622
747
|
*/
|
|
623
748
|
propertyNames: string[] | undefined;
|
|
624
749
|
/**
|
|
625
|
-
* <p>A Boolean value that specifies whether the property group is inherited from a parent
|
|
750
|
+
* <p>A Boolean value that specifies whether the property group is inherited from a parent
|
|
751
|
+
* entity</p>
|
|
626
752
|
*/
|
|
627
753
|
isInherited: boolean | undefined;
|
|
628
754
|
}
|
|
755
|
+
/**
|
|
756
|
+
* @public
|
|
757
|
+
*/
|
|
629
758
|
export interface GetPricingPlanRequest {
|
|
630
759
|
}
|
|
760
|
+
/**
|
|
761
|
+
* @public
|
|
762
|
+
*/
|
|
631
763
|
export declare enum PricingTier {
|
|
632
764
|
TIER_1 = "TIER_1",
|
|
633
765
|
TIER_2 = "TIER_2",
|
|
@@ -635,7 +767,8 @@ export declare enum PricingTier {
|
|
|
635
767
|
TIER_4 = "TIER_4"
|
|
636
768
|
}
|
|
637
769
|
/**
|
|
638
|
-
*
|
|
770
|
+
* @public
|
|
771
|
+
* <p>Information about the pricing bundle.</p>
|
|
639
772
|
*/
|
|
640
773
|
export interface BundleInformation {
|
|
641
774
|
/**
|
|
@@ -647,11 +780,17 @@ export interface BundleInformation {
|
|
|
647
780
|
*/
|
|
648
781
|
pricingTier?: PricingTier | string;
|
|
649
782
|
}
|
|
783
|
+
/**
|
|
784
|
+
* @public
|
|
785
|
+
*/
|
|
650
786
|
export declare enum PricingMode {
|
|
651
787
|
BASIC = "BASIC",
|
|
652
788
|
STANDARD = "STANDARD",
|
|
653
789
|
TIERED_BUNDLE = "TIERED_BUNDLE"
|
|
654
790
|
}
|
|
791
|
+
/**
|
|
792
|
+
* @public
|
|
793
|
+
*/
|
|
655
794
|
export declare enum UpdateReason {
|
|
656
795
|
DEFAULT = "DEFAULT",
|
|
657
796
|
ENTITY_COUNT_UPDATE = "ENTITY_COUNT_UPDATE",
|
|
@@ -660,6 +799,7 @@ export declare enum UpdateReason {
|
|
|
660
799
|
PRICING_TIER_UPDATE = "PRICING_TIER_UPDATE"
|
|
661
800
|
}
|
|
662
801
|
/**
|
|
802
|
+
* @public
|
|
663
803
|
* <p>The pricing plan.</p>
|
|
664
804
|
*/
|
|
665
805
|
export interface PricingPlan {
|
|
@@ -684,10 +824,13 @@ export interface PricingPlan {
|
|
|
684
824
|
*/
|
|
685
825
|
updateDateTime: Date | undefined;
|
|
686
826
|
/**
|
|
687
|
-
* <p>The update reason
|
|
827
|
+
* <p>The update reason for changing a pricing plan.</p>
|
|
688
828
|
*/
|
|
689
829
|
updateReason: UpdateReason | string | undefined;
|
|
690
830
|
}
|
|
831
|
+
/**
|
|
832
|
+
* @public
|
|
833
|
+
*/
|
|
691
834
|
export interface GetPricingPlanResponse {
|
|
692
835
|
/**
|
|
693
836
|
* <p>The chosen pricing plan for the current billing cycle.</p>
|
|
@@ -699,6 +842,7 @@ export interface GetPricingPlanResponse {
|
|
|
699
842
|
pendingPricingPlan?: PricingPlan;
|
|
700
843
|
}
|
|
701
844
|
/**
|
|
845
|
+
* @public
|
|
702
846
|
* <p>The connector failed.</p>
|
|
703
847
|
*/
|
|
704
848
|
export declare class ConnectorFailureException extends __BaseException {
|
|
@@ -710,6 +854,7 @@ export declare class ConnectorFailureException extends __BaseException {
|
|
|
710
854
|
constructor(opts: __ExceptionOptionType<ConnectorFailureException, __BaseException>);
|
|
711
855
|
}
|
|
712
856
|
/**
|
|
857
|
+
* @public
|
|
713
858
|
* <p>The connector timed out.</p>
|
|
714
859
|
*/
|
|
715
860
|
export declare class ConnectorTimeoutException extends __BaseException {
|
|
@@ -720,12 +865,17 @@ export declare class ConnectorTimeoutException extends __BaseException {
|
|
|
720
865
|
*/
|
|
721
866
|
constructor(opts: __ExceptionOptionType<ConnectorTimeoutException, __BaseException>);
|
|
722
867
|
}
|
|
868
|
+
/**
|
|
869
|
+
* @public
|
|
870
|
+
*/
|
|
723
871
|
export declare enum Order {
|
|
724
872
|
ASCENDING = "ASCENDING",
|
|
725
873
|
DESCENDING = "DESCENDING"
|
|
726
874
|
}
|
|
727
875
|
/**
|
|
728
|
-
*
|
|
876
|
+
* @public
|
|
877
|
+
* <p>Filter criteria that orders the return output. It can be sorted in ascending or
|
|
878
|
+
* descending order.</p>
|
|
729
879
|
*/
|
|
730
880
|
export interface OrderBy {
|
|
731
881
|
/**
|
|
@@ -737,10 +887,14 @@ export interface OrderBy {
|
|
|
737
887
|
*/
|
|
738
888
|
propertyName: string | undefined;
|
|
739
889
|
}
|
|
890
|
+
/**
|
|
891
|
+
* @public
|
|
892
|
+
*/
|
|
740
893
|
export declare enum InterpolationType {
|
|
741
894
|
LINEAR = "LINEAR"
|
|
742
895
|
}
|
|
743
896
|
/**
|
|
897
|
+
* @public
|
|
744
898
|
* <p>An object that specifies how to interpolate data in a list.</p>
|
|
745
899
|
*/
|
|
746
900
|
export interface InterpolationParameters {
|
|
@@ -753,10 +907,16 @@ export interface InterpolationParameters {
|
|
|
753
907
|
*/
|
|
754
908
|
intervalInSeconds?: number;
|
|
755
909
|
}
|
|
910
|
+
/**
|
|
911
|
+
* @public
|
|
912
|
+
*/
|
|
756
913
|
export declare enum OrderByTime {
|
|
757
914
|
ASCENDING = "ASCENDING",
|
|
758
915
|
DESCENDING = "DESCENDING"
|
|
759
916
|
}
|
|
917
|
+
/**
|
|
918
|
+
* @public
|
|
919
|
+
*/
|
|
760
920
|
export interface GetSceneRequest {
|
|
761
921
|
/**
|
|
762
922
|
* <p>The ID of the workspace that contains the scene.</p>
|
|
@@ -767,6 +927,9 @@ export interface GetSceneRequest {
|
|
|
767
927
|
*/
|
|
768
928
|
sceneId: string | undefined;
|
|
769
929
|
}
|
|
930
|
+
/**
|
|
931
|
+
* @public
|
|
932
|
+
*/
|
|
770
933
|
export interface GetSceneResponse {
|
|
771
934
|
/**
|
|
772
935
|
* <p>The ID of the workspace that contains the scene.</p>
|
|
@@ -800,21 +963,33 @@ export interface GetSceneResponse {
|
|
|
800
963
|
* <p>A list of capabilities that the scene uses to render.</p>
|
|
801
964
|
*/
|
|
802
965
|
capabilities?: string[];
|
|
966
|
+
/**
|
|
967
|
+
* <p>The response metadata.</p>
|
|
968
|
+
*/
|
|
969
|
+
sceneMetadata?: Record<string, string>;
|
|
970
|
+
/**
|
|
971
|
+
* <p>The generated scene metadata.</p>
|
|
972
|
+
*/
|
|
973
|
+
generatedSceneMetadata?: Record<string, string>;
|
|
803
974
|
}
|
|
975
|
+
/**
|
|
976
|
+
* @public
|
|
977
|
+
*/
|
|
804
978
|
export interface GetSyncJobRequest {
|
|
805
979
|
/**
|
|
806
|
-
* <p>The sync
|
|
980
|
+
* <p>The sync source.</p>
|
|
807
981
|
* <note>
|
|
808
|
-
* <p>Currently the only supported
|
|
982
|
+
* <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p>
|
|
809
983
|
* </note>
|
|
810
984
|
*/
|
|
811
985
|
syncSource: string | undefined;
|
|
812
986
|
/**
|
|
813
|
-
* <p>The workspace
|
|
987
|
+
* <p>The workspace ID.</p>
|
|
814
988
|
*/
|
|
815
989
|
workspaceId?: string;
|
|
816
990
|
}
|
|
817
991
|
/**
|
|
992
|
+
* @public
|
|
818
993
|
* <p>The SyncJob status.</p>
|
|
819
994
|
*/
|
|
820
995
|
export interface SyncJobStatus {
|
|
@@ -827,6 +1002,9 @@ export interface SyncJobStatus {
|
|
|
827
1002
|
*/
|
|
828
1003
|
error?: ErrorDetails;
|
|
829
1004
|
}
|
|
1005
|
+
/**
|
|
1006
|
+
* @public
|
|
1007
|
+
*/
|
|
830
1008
|
export interface GetSyncJobResponse {
|
|
831
1009
|
/**
|
|
832
1010
|
* <p>The sync job ARN.</p>
|
|
@@ -839,7 +1017,7 @@ export interface GetSyncJobResponse {
|
|
|
839
1017
|
/**
|
|
840
1018
|
* <p>The sync soucre.</p>
|
|
841
1019
|
* <note>
|
|
842
|
-
* <p>Currently the only supported
|
|
1020
|
+
* <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p>
|
|
843
1021
|
* </note>
|
|
844
1022
|
*/
|
|
845
1023
|
syncSource: string | undefined;
|
|
@@ -860,12 +1038,18 @@ export interface GetSyncJobResponse {
|
|
|
860
1038
|
*/
|
|
861
1039
|
updateDateTime: Date | undefined;
|
|
862
1040
|
}
|
|
1041
|
+
/**
|
|
1042
|
+
* @public
|
|
1043
|
+
*/
|
|
863
1044
|
export interface GetWorkspaceRequest {
|
|
864
1045
|
/**
|
|
865
1046
|
* <p>The ID of the workspace.</p>
|
|
866
1047
|
*/
|
|
867
1048
|
workspaceId: string | undefined;
|
|
868
1049
|
}
|
|
1050
|
+
/**
|
|
1051
|
+
* @public
|
|
1052
|
+
*/
|
|
869
1053
|
export interface GetWorkspaceResponse {
|
|
870
1054
|
/**
|
|
871
1055
|
* <p>The ID of the workspace.</p>
|
|
@@ -880,7 +1064,8 @@ export interface GetWorkspaceResponse {
|
|
|
880
1064
|
*/
|
|
881
1065
|
description?: string;
|
|
882
1066
|
/**
|
|
883
|
-
* <p>The ARN of the S3 bucket where resources associated with the workspace are
|
|
1067
|
+
* <p>The ARN of the S3 bucket where resources associated with the workspace are
|
|
1068
|
+
* stored.</p>
|
|
884
1069
|
*/
|
|
885
1070
|
s3Location: string | undefined;
|
|
886
1071
|
/**
|
|
@@ -897,12 +1082,16 @@ export interface GetWorkspaceResponse {
|
|
|
897
1082
|
updateDateTime: Date | undefined;
|
|
898
1083
|
}
|
|
899
1084
|
/**
|
|
1085
|
+
* @public
|
|
900
1086
|
* <p>An object that filters items in a list of component types.</p>
|
|
901
1087
|
* <note>
|
|
902
1088
|
* <p>Only one object is accepted as a valid input.</p>
|
|
903
1089
|
* </note>
|
|
904
1090
|
*/
|
|
905
1091
|
export type ListComponentTypesFilter = ListComponentTypesFilter.ExtendsFromMember | ListComponentTypesFilter.IsAbstractMember | ListComponentTypesFilter.NamespaceMember | ListComponentTypesFilter.$UnknownMember;
|
|
1092
|
+
/**
|
|
1093
|
+
* @public
|
|
1094
|
+
*/
|
|
906
1095
|
export declare namespace ListComponentTypesFilter {
|
|
907
1096
|
/**
|
|
908
1097
|
* <p>The component type that the component types in the list extend.</p>
|
|
@@ -923,7 +1112,8 @@ export declare namespace ListComponentTypesFilter {
|
|
|
923
1112
|
$unknown?: never;
|
|
924
1113
|
}
|
|
925
1114
|
/**
|
|
926
|
-
* <p>A Boolean value that specifies whether the component types in the list are
|
|
1115
|
+
* <p>A Boolean value that specifies whether the component types in the list are
|
|
1116
|
+
* abstract.</p>
|
|
927
1117
|
*/
|
|
928
1118
|
interface IsAbstractMember {
|
|
929
1119
|
extendsFrom?: never;
|
|
@@ -945,6 +1135,9 @@ export declare namespace ListComponentTypesFilter {
|
|
|
945
1135
|
}
|
|
946
1136
|
const visit: <T>(value: ListComponentTypesFilter, visitor: Visitor<T>) => T;
|
|
947
1137
|
}
|
|
1138
|
+
/**
|
|
1139
|
+
* @public
|
|
1140
|
+
*/
|
|
948
1141
|
export interface ListComponentTypesRequest {
|
|
949
1142
|
/**
|
|
950
1143
|
* <p>The ID of the workspace.</p>
|
|
@@ -965,6 +1158,7 @@ export interface ListComponentTypesRequest {
|
|
|
965
1158
|
maxResults?: number;
|
|
966
1159
|
}
|
|
967
1160
|
/**
|
|
1161
|
+
* @public
|
|
968
1162
|
* <p>An object that contains information about a component type.</p>
|
|
969
1163
|
*/
|
|
970
1164
|
export interface ComponentTypeSummary {
|
|
@@ -997,6 +1191,9 @@ export interface ComponentTypeSummary {
|
|
|
997
1191
|
*/
|
|
998
1192
|
componentTypeName?: string;
|
|
999
1193
|
}
|
|
1194
|
+
/**
|
|
1195
|
+
* @public
|
|
1196
|
+
*/
|
|
1000
1197
|
export interface ListComponentTypesResponse {
|
|
1001
1198
|
/**
|
|
1002
1199
|
* <p>The ID of the workspace.</p>
|
|
@@ -1016,9 +1213,13 @@ export interface ListComponentTypesResponse {
|
|
|
1016
1213
|
maxResults?: number;
|
|
1017
1214
|
}
|
|
1018
1215
|
/**
|
|
1216
|
+
* @public
|
|
1019
1217
|
* <p>An object that filters items in a list of entities.</p>
|
|
1020
1218
|
*/
|
|
1021
1219
|
export type ListEntitiesFilter = ListEntitiesFilter.ComponentTypeIdMember | ListEntitiesFilter.ExternalIdMember | ListEntitiesFilter.ParentEntityIdMember | ListEntitiesFilter.$UnknownMember;
|
|
1220
|
+
/**
|
|
1221
|
+
* @public
|
|
1222
|
+
*/
|
|
1022
1223
|
export declare namespace ListEntitiesFilter {
|
|
1023
1224
|
/**
|
|
1024
1225
|
* <p>The parent of the entities in the list.</p>
|
|
@@ -1039,7 +1240,8 @@ export declare namespace ListEntitiesFilter {
|
|
|
1039
1240
|
$unknown?: never;
|
|
1040
1241
|
}
|
|
1041
1242
|
/**
|
|
1042
|
-
* <p>The external-Id property of a component. The external-Id property is the primary key of
|
|
1243
|
+
* <p>The external-Id property of a component. The external-Id property is the primary key of
|
|
1244
|
+
* an external storage system.</p>
|
|
1043
1245
|
*/
|
|
1044
1246
|
interface ExternalIdMember {
|
|
1045
1247
|
parentEntityId?: never;
|
|
@@ -1061,6 +1263,9 @@ export declare namespace ListEntitiesFilter {
|
|
|
1061
1263
|
}
|
|
1062
1264
|
const visit: <T>(value: ListEntitiesFilter, visitor: Visitor<T>) => T;
|
|
1063
1265
|
}
|
|
1266
|
+
/**
|
|
1267
|
+
* @public
|
|
1268
|
+
*/
|
|
1064
1269
|
export interface ListEntitiesRequest {
|
|
1065
1270
|
/**
|
|
1066
1271
|
* <p>The ID of the workspace.</p>
|
|
@@ -1084,6 +1289,7 @@ export interface ListEntitiesRequest {
|
|
|
1084
1289
|
nextToken?: string;
|
|
1085
1290
|
}
|
|
1086
1291
|
/**
|
|
1292
|
+
* @public
|
|
1087
1293
|
* <p>An object that contains information about an entity.</p>
|
|
1088
1294
|
*/
|
|
1089
1295
|
export interface EntitySummary {
|
|
@@ -1124,6 +1330,9 @@ export interface EntitySummary {
|
|
|
1124
1330
|
*/
|
|
1125
1331
|
updateDateTime: Date | undefined;
|
|
1126
1332
|
}
|
|
1333
|
+
/**
|
|
1334
|
+
* @public
|
|
1335
|
+
*/
|
|
1127
1336
|
export interface ListEntitiesResponse {
|
|
1128
1337
|
/**
|
|
1129
1338
|
* <p>A list of objects that contain information about the entities.</p>
|
|
@@ -1134,6 +1343,9 @@ export interface ListEntitiesResponse {
|
|
|
1134
1343
|
*/
|
|
1135
1344
|
nextToken?: string;
|
|
1136
1345
|
}
|
|
1346
|
+
/**
|
|
1347
|
+
* @public
|
|
1348
|
+
*/
|
|
1137
1349
|
export interface ListScenesRequest {
|
|
1138
1350
|
/**
|
|
1139
1351
|
* <p>The ID of the workspace that contains the scenes.</p>
|
|
@@ -1149,6 +1361,7 @@ export interface ListScenesRequest {
|
|
|
1149
1361
|
nextToken?: string;
|
|
1150
1362
|
}
|
|
1151
1363
|
/**
|
|
1364
|
+
* @public
|
|
1152
1365
|
* <p>An object that contains information about a scene.</p>
|
|
1153
1366
|
*/
|
|
1154
1367
|
export interface SceneSummary {
|
|
@@ -1177,6 +1390,9 @@ export interface SceneSummary {
|
|
|
1177
1390
|
*/
|
|
1178
1391
|
description?: string;
|
|
1179
1392
|
}
|
|
1393
|
+
/**
|
|
1394
|
+
* @public
|
|
1395
|
+
*/
|
|
1180
1396
|
export interface ListScenesResponse {
|
|
1181
1397
|
/**
|
|
1182
1398
|
* <p>A list of objects that contain information about the scenes.</p>
|
|
@@ -1187,6 +1403,9 @@ export interface ListScenesResponse {
|
|
|
1187
1403
|
*/
|
|
1188
1404
|
nextToken?: string;
|
|
1189
1405
|
}
|
|
1406
|
+
/**
|
|
1407
|
+
* @public
|
|
1408
|
+
*/
|
|
1190
1409
|
export interface ListSyncJobsRequest {
|
|
1191
1410
|
/**
|
|
1192
1411
|
* <p>The ID of the workspace that contains the sync job.</p>
|
|
@@ -1203,6 +1422,7 @@ export interface ListSyncJobsRequest {
|
|
|
1203
1422
|
nextToken?: string;
|
|
1204
1423
|
}
|
|
1205
1424
|
/**
|
|
1425
|
+
* @public
|
|
1206
1426
|
* <p>The SyncJob summary.</p>
|
|
1207
1427
|
*/
|
|
1208
1428
|
export interface SyncJobSummary {
|
|
@@ -1231,6 +1451,9 @@ export interface SyncJobSummary {
|
|
|
1231
1451
|
*/
|
|
1232
1452
|
updateDateTime?: Date;
|
|
1233
1453
|
}
|
|
1454
|
+
/**
|
|
1455
|
+
* @public
|
|
1456
|
+
*/
|
|
1234
1457
|
export interface ListSyncJobsResponse {
|
|
1235
1458
|
/**
|
|
1236
1459
|
* <p>The listed SyncJob summaries.</p>
|
|
@@ -1241,10 +1464,16 @@ export interface ListSyncJobsResponse {
|
|
|
1241
1464
|
*/
|
|
1242
1465
|
nextToken?: string;
|
|
1243
1466
|
}
|
|
1467
|
+
/**
|
|
1468
|
+
* @public
|
|
1469
|
+
*/
|
|
1244
1470
|
export declare enum SyncResourceType {
|
|
1245
1471
|
COMPONENT_TYPE = "COMPONENT_TYPE",
|
|
1246
1472
|
ENTITY = "ENTITY"
|
|
1247
1473
|
}
|
|
1474
|
+
/**
|
|
1475
|
+
* @public
|
|
1476
|
+
*/
|
|
1248
1477
|
export declare enum SyncResourceState {
|
|
1249
1478
|
DELETED = "DELETED",
|
|
1250
1479
|
ERROR = "ERROR",
|
|
@@ -1253,9 +1482,13 @@ export declare enum SyncResourceState {
|
|
|
1253
1482
|
PROCESSING = "PROCESSING"
|
|
1254
1483
|
}
|
|
1255
1484
|
/**
|
|
1485
|
+
* @public
|
|
1256
1486
|
* <p>The sync resource filter.</p>
|
|
1257
1487
|
*/
|
|
1258
1488
|
export type SyncResourceFilter = SyncResourceFilter.ExternalIdMember | SyncResourceFilter.ResourceIdMember | SyncResourceFilter.ResourceTypeMember | SyncResourceFilter.StateMember | SyncResourceFilter.$UnknownMember;
|
|
1489
|
+
/**
|
|
1490
|
+
* @public
|
|
1491
|
+
*/
|
|
1259
1492
|
export declare namespace SyncResourceFilter {
|
|
1260
1493
|
/**
|
|
1261
1494
|
* <p>The sync resource filter's state.</p>
|
|
@@ -1268,7 +1501,7 @@ export declare namespace SyncResourceFilter {
|
|
|
1268
1501
|
$unknown?: never;
|
|
1269
1502
|
}
|
|
1270
1503
|
/**
|
|
1271
|
-
* <p>The sync resource filter
|
|
1504
|
+
* <p>The sync resource filter resource type</p>
|
|
1272
1505
|
*/
|
|
1273
1506
|
interface ResourceTypeMember {
|
|
1274
1507
|
state?: never;
|
|
@@ -1278,7 +1511,7 @@ export declare namespace SyncResourceFilter {
|
|
|
1278
1511
|
$unknown?: never;
|
|
1279
1512
|
}
|
|
1280
1513
|
/**
|
|
1281
|
-
* <p>The sync resource filter resource
|
|
1514
|
+
* <p>The sync resource filter resource ID.</p>
|
|
1282
1515
|
*/
|
|
1283
1516
|
interface ResourceIdMember {
|
|
1284
1517
|
state?: never;
|
|
@@ -1288,7 +1521,7 @@ export declare namespace SyncResourceFilter {
|
|
|
1288
1521
|
$unknown?: never;
|
|
1289
1522
|
}
|
|
1290
1523
|
/**
|
|
1291
|
-
* <p>The external
|
|
1524
|
+
* <p>The external ID.</p>
|
|
1292
1525
|
*/
|
|
1293
1526
|
interface ExternalIdMember {
|
|
1294
1527
|
state?: never;
|
|
@@ -1313,20 +1546,35 @@ export declare namespace SyncResourceFilter {
|
|
|
1313
1546
|
}
|
|
1314
1547
|
const visit: <T>(value: SyncResourceFilter, visitor: Visitor<T>) => T;
|
|
1315
1548
|
}
|
|
1549
|
+
/**
|
|
1550
|
+
* @public
|
|
1551
|
+
*/
|
|
1316
1552
|
export interface ListSyncResourcesRequest {
|
|
1317
1553
|
/**
|
|
1318
1554
|
* <p>The ID of the workspace that contains the sync job.</p>
|
|
1319
1555
|
*/
|
|
1320
1556
|
workspaceId: string | undefined;
|
|
1321
1557
|
/**
|
|
1322
|
-
* <p>The sync
|
|
1558
|
+
* <p>The sync source.</p>
|
|
1323
1559
|
* <note>
|
|
1324
|
-
* <p>Currently the only supported
|
|
1560
|
+
* <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p>
|
|
1325
1561
|
* </note>
|
|
1326
1562
|
*/
|
|
1327
1563
|
syncSource: string | undefined;
|
|
1328
1564
|
/**
|
|
1329
1565
|
* <p>A list of objects that filter the request.</p>
|
|
1566
|
+
* <p>The following filter combinations are supported:</p>
|
|
1567
|
+
* <ul>
|
|
1568
|
+
* <li>
|
|
1569
|
+
* <p>Filter with state</p>
|
|
1570
|
+
* </li>
|
|
1571
|
+
* <li>
|
|
1572
|
+
* <p>Filter with ResourceType and ResourceId</p>
|
|
1573
|
+
* </li>
|
|
1574
|
+
* <li>
|
|
1575
|
+
* <p>Filter with ResourceType and ExternalId</p>
|
|
1576
|
+
* </li>
|
|
1577
|
+
* </ul>
|
|
1330
1578
|
*/
|
|
1331
1579
|
filters?: SyncResourceFilter[];
|
|
1332
1580
|
/**
|
|
@@ -1340,6 +1588,7 @@ export interface ListSyncResourcesRequest {
|
|
|
1340
1588
|
nextToken?: string;
|
|
1341
1589
|
}
|
|
1342
1590
|
/**
|
|
1591
|
+
* @public
|
|
1343
1592
|
* <p>The sync resource status.</p>
|
|
1344
1593
|
*/
|
|
1345
1594
|
export interface SyncResourceStatus {
|
|
@@ -1353,6 +1602,7 @@ export interface SyncResourceStatus {
|
|
|
1353
1602
|
error?: ErrorDetails;
|
|
1354
1603
|
}
|
|
1355
1604
|
/**
|
|
1605
|
+
* @public
|
|
1356
1606
|
* <p>The sync resource summary.</p>
|
|
1357
1607
|
*/
|
|
1358
1608
|
export interface SyncResourceSummary {
|
|
@@ -1361,11 +1611,11 @@ export interface SyncResourceSummary {
|
|
|
1361
1611
|
*/
|
|
1362
1612
|
resourceType?: SyncResourceType | string;
|
|
1363
1613
|
/**
|
|
1364
|
-
* <p>The external
|
|
1614
|
+
* <p>The external ID.</p>
|
|
1365
1615
|
*/
|
|
1366
1616
|
externalId?: string;
|
|
1367
1617
|
/**
|
|
1368
|
-
* <p>The resource
|
|
1618
|
+
* <p>The resource ID.</p>
|
|
1369
1619
|
*/
|
|
1370
1620
|
resourceId?: string;
|
|
1371
1621
|
/**
|
|
@@ -1377,6 +1627,9 @@ export interface SyncResourceSummary {
|
|
|
1377
1627
|
*/
|
|
1378
1628
|
updateDateTime?: Date;
|
|
1379
1629
|
}
|
|
1630
|
+
/**
|
|
1631
|
+
* @public
|
|
1632
|
+
*/
|
|
1380
1633
|
export interface ListSyncResourcesResponse {
|
|
1381
1634
|
/**
|
|
1382
1635
|
* <p>The sync resources.</p>
|
|
@@ -1387,6 +1640,9 @@ export interface ListSyncResourcesResponse {
|
|
|
1387
1640
|
*/
|
|
1388
1641
|
nextToken?: string;
|
|
1389
1642
|
}
|
|
1643
|
+
/**
|
|
1644
|
+
* @public
|
|
1645
|
+
*/
|
|
1390
1646
|
export interface ListTagsForResourceRequest {
|
|
1391
1647
|
/**
|
|
1392
1648
|
* <p>The ARN of the resource.</p>
|
|
@@ -1402,6 +1658,9 @@ export interface ListTagsForResourceRequest {
|
|
|
1402
1658
|
*/
|
|
1403
1659
|
nextToken?: string;
|
|
1404
1660
|
}
|
|
1661
|
+
/**
|
|
1662
|
+
* @public
|
|
1663
|
+
*/
|
|
1405
1664
|
export interface ListTagsForResourceResponse {
|
|
1406
1665
|
/**
|
|
1407
1666
|
* <p>Metadata that you can use to manage a resource.</p>
|
|
@@ -1412,6 +1671,9 @@ export interface ListTagsForResourceResponse {
|
|
|
1412
1671
|
*/
|
|
1413
1672
|
nextToken?: string;
|
|
1414
1673
|
}
|
|
1674
|
+
/**
|
|
1675
|
+
* @public
|
|
1676
|
+
*/
|
|
1415
1677
|
export interface ListWorkspacesRequest {
|
|
1416
1678
|
/**
|
|
1417
1679
|
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
@@ -1424,6 +1686,7 @@ export interface ListWorkspacesRequest {
|
|
|
1424
1686
|
nextToken?: string;
|
|
1425
1687
|
}
|
|
1426
1688
|
/**
|
|
1689
|
+
* @public
|
|
1427
1690
|
* <p>An object that contains information about a workspace.</p>
|
|
1428
1691
|
*/
|
|
1429
1692
|
export interface WorkspaceSummary {
|
|
@@ -1448,6 +1711,9 @@ export interface WorkspaceSummary {
|
|
|
1448
1711
|
*/
|
|
1449
1712
|
updateDateTime: Date | undefined;
|
|
1450
1713
|
}
|
|
1714
|
+
/**
|
|
1715
|
+
* @public
|
|
1716
|
+
*/
|
|
1451
1717
|
export interface ListWorkspacesResponse {
|
|
1452
1718
|
/**
|
|
1453
1719
|
* <p>A list of objects that contain information about the workspaces.</p>
|
|
@@ -1458,6 +1724,9 @@ export interface ListWorkspacesResponse {
|
|
|
1458
1724
|
*/
|
|
1459
1725
|
nextToken?: string;
|
|
1460
1726
|
}
|
|
1727
|
+
/**
|
|
1728
|
+
* @public
|
|
1729
|
+
*/
|
|
1461
1730
|
export interface TagResourceRequest {
|
|
1462
1731
|
/**
|
|
1463
1732
|
* <p>The ARN of the resource.</p>
|
|
@@ -1468,9 +1737,13 @@ export interface TagResourceRequest {
|
|
|
1468
1737
|
*/
|
|
1469
1738
|
tags: Record<string, string> | undefined;
|
|
1470
1739
|
}
|
|
1740
|
+
/**
|
|
1741
|
+
* @public
|
|
1742
|
+
*/
|
|
1471
1743
|
export interface TagResourceResponse {
|
|
1472
1744
|
}
|
|
1473
1745
|
/**
|
|
1746
|
+
* @public
|
|
1474
1747
|
* <p>The number of tags exceeds the limit.</p>
|
|
1475
1748
|
*/
|
|
1476
1749
|
export declare class TooManyTagsException extends __BaseException {
|
|
@@ -1481,18 +1754,28 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
1481
1754
|
*/
|
|
1482
1755
|
constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
|
|
1483
1756
|
}
|
|
1757
|
+
/**
|
|
1758
|
+
* @public
|
|
1759
|
+
*/
|
|
1484
1760
|
export interface UntagResourceRequest {
|
|
1485
1761
|
/**
|
|
1486
1762
|
* <p>The ARN of the resource.</p>
|
|
1487
1763
|
*/
|
|
1488
1764
|
resourceARN: string | undefined;
|
|
1489
1765
|
/**
|
|
1490
|
-
* <p>A list of tag key names to remove from the resource. You don't specify the value. Both
|
|
1766
|
+
* <p>A list of tag key names to remove from the resource. You don't specify the value. Both
|
|
1767
|
+
* the key and its associated value are removed.</p>
|
|
1491
1768
|
*/
|
|
1492
1769
|
tagKeys: string[] | undefined;
|
|
1493
1770
|
}
|
|
1771
|
+
/**
|
|
1772
|
+
* @public
|
|
1773
|
+
*/
|
|
1494
1774
|
export interface UntagResourceResponse {
|
|
1495
1775
|
}
|
|
1776
|
+
/**
|
|
1777
|
+
* @public
|
|
1778
|
+
*/
|
|
1496
1779
|
export interface UpdateComponentTypeResponse {
|
|
1497
1780
|
/**
|
|
1498
1781
|
* <p>The ID of the workspace that contains the component type.</p>
|
|
@@ -1511,16 +1794,23 @@ export interface UpdateComponentTypeResponse {
|
|
|
1511
1794
|
*/
|
|
1512
1795
|
state: State | string | undefined;
|
|
1513
1796
|
}
|
|
1797
|
+
/**
|
|
1798
|
+
* @public
|
|
1799
|
+
*/
|
|
1514
1800
|
export declare enum ComponentUpdateType {
|
|
1515
1801
|
CREATE = "CREATE",
|
|
1516
1802
|
DELETE = "DELETE",
|
|
1517
1803
|
UPDATE = "UPDATE"
|
|
1518
1804
|
}
|
|
1805
|
+
/**
|
|
1806
|
+
* @public
|
|
1807
|
+
*/
|
|
1519
1808
|
export declare enum ParentEntityUpdateType {
|
|
1520
1809
|
DELETE = "DELETE",
|
|
1521
1810
|
UPDATE = "UPDATE"
|
|
1522
1811
|
}
|
|
1523
1812
|
/**
|
|
1813
|
+
* @public
|
|
1524
1814
|
* <p>The parent entity update request.</p>
|
|
1525
1815
|
*/
|
|
1526
1816
|
export interface ParentEntityUpdateRequest {
|
|
@@ -1533,6 +1823,9 @@ export interface ParentEntityUpdateRequest {
|
|
|
1533
1823
|
*/
|
|
1534
1824
|
parentEntityId?: string;
|
|
1535
1825
|
}
|
|
1826
|
+
/**
|
|
1827
|
+
* @public
|
|
1828
|
+
*/
|
|
1536
1829
|
export interface UpdateEntityResponse {
|
|
1537
1830
|
/**
|
|
1538
1831
|
* <p>The date and time when the entity was last updated.</p>
|
|
@@ -1543,6 +1836,9 @@ export interface UpdateEntityResponse {
|
|
|
1543
1836
|
*/
|
|
1544
1837
|
state: State | string | undefined;
|
|
1545
1838
|
}
|
|
1839
|
+
/**
|
|
1840
|
+
* @public
|
|
1841
|
+
*/
|
|
1546
1842
|
export interface UpdatePricingPlanRequest {
|
|
1547
1843
|
/**
|
|
1548
1844
|
* <p>The pricing mode.</p>
|
|
@@ -1553,6 +1849,9 @@ export interface UpdatePricingPlanRequest {
|
|
|
1553
1849
|
*/
|
|
1554
1850
|
bundleNames?: string[];
|
|
1555
1851
|
}
|
|
1852
|
+
/**
|
|
1853
|
+
* @public
|
|
1854
|
+
*/
|
|
1556
1855
|
export interface UpdatePricingPlanResponse {
|
|
1557
1856
|
/**
|
|
1558
1857
|
* <p>Update the current pricing plan.</p>
|
|
@@ -1563,6 +1862,9 @@ export interface UpdatePricingPlanResponse {
|
|
|
1563
1862
|
*/
|
|
1564
1863
|
pendingPricingPlan?: PricingPlan;
|
|
1565
1864
|
}
|
|
1865
|
+
/**
|
|
1866
|
+
* @public
|
|
1867
|
+
*/
|
|
1566
1868
|
export interface UpdateSceneRequest {
|
|
1567
1869
|
/**
|
|
1568
1870
|
* <p>The ID of the workspace that contains the scene.</p>
|
|
@@ -1584,13 +1886,23 @@ export interface UpdateSceneRequest {
|
|
|
1584
1886
|
* <p>A list of capabilities that the scene uses to render.</p>
|
|
1585
1887
|
*/
|
|
1586
1888
|
capabilities?: string[];
|
|
1889
|
+
/**
|
|
1890
|
+
* <p>The scene metadata.</p>
|
|
1891
|
+
*/
|
|
1892
|
+
sceneMetadata?: Record<string, string>;
|
|
1587
1893
|
}
|
|
1894
|
+
/**
|
|
1895
|
+
* @public
|
|
1896
|
+
*/
|
|
1588
1897
|
export interface UpdateSceneResponse {
|
|
1589
1898
|
/**
|
|
1590
1899
|
* <p>The date and time when the scene was last updated.</p>
|
|
1591
1900
|
*/
|
|
1592
1901
|
updateDateTime: Date | undefined;
|
|
1593
1902
|
}
|
|
1903
|
+
/**
|
|
1904
|
+
* @public
|
|
1905
|
+
*/
|
|
1594
1906
|
export interface UpdateWorkspaceRequest {
|
|
1595
1907
|
/**
|
|
1596
1908
|
* <p>The ID of the workspace.</p>
|
|
@@ -1605,6 +1917,9 @@ export interface UpdateWorkspaceRequest {
|
|
|
1605
1917
|
*/
|
|
1606
1918
|
role?: string;
|
|
1607
1919
|
}
|
|
1920
|
+
/**
|
|
1921
|
+
* @public
|
|
1922
|
+
*/
|
|
1608
1923
|
export interface UpdateWorkspaceResponse {
|
|
1609
1924
|
/**
|
|
1610
1925
|
* <p>The date and time of the current update.</p>
|
|
@@ -1612,6 +1927,7 @@ export interface UpdateWorkspaceResponse {
|
|
|
1612
1927
|
updateDateTime: Date | undefined;
|
|
1613
1928
|
}
|
|
1614
1929
|
/**
|
|
1930
|
+
* @public
|
|
1615
1931
|
* <p>An object that specifies a value for a property.</p>
|
|
1616
1932
|
*/
|
|
1617
1933
|
export interface DataValue {
|
|
@@ -1653,6 +1969,7 @@ export interface DataValue {
|
|
|
1653
1969
|
expression?: string;
|
|
1654
1970
|
}
|
|
1655
1971
|
/**
|
|
1972
|
+
* @public
|
|
1656
1973
|
* <p>An object that filters items returned by a property request.</p>
|
|
1657
1974
|
*/
|
|
1658
1975
|
export interface PropertyFilter {
|
|
@@ -1670,11 +1987,12 @@ export interface PropertyFilter {
|
|
|
1670
1987
|
value?: DataValue;
|
|
1671
1988
|
}
|
|
1672
1989
|
/**
|
|
1990
|
+
* @public
|
|
1673
1991
|
* <p>The latest value of the property.</p>
|
|
1674
1992
|
*/
|
|
1675
1993
|
export interface PropertyLatestValue {
|
|
1676
1994
|
/**
|
|
1677
|
-
* <p>An object that specifies information about a property
|
|
1995
|
+
* <p>An object that specifies information about a property.</p>
|
|
1678
1996
|
*/
|
|
1679
1997
|
propertyReference: EntityPropertyReference | undefined;
|
|
1680
1998
|
/**
|
|
@@ -1683,6 +2001,7 @@ export interface PropertyLatestValue {
|
|
|
1683
2001
|
propertyValue?: DataValue;
|
|
1684
2002
|
}
|
|
1685
2003
|
/**
|
|
2004
|
+
* @public
|
|
1686
2005
|
* <p>An object that contains information about a value for a time series property.</p>
|
|
1687
2006
|
*/
|
|
1688
2007
|
export interface PropertyValue {
|
|
@@ -1698,7 +2017,8 @@ export interface PropertyValue {
|
|
|
1698
2017
|
value: DataValue | undefined;
|
|
1699
2018
|
/**
|
|
1700
2019
|
* <p>ISO8601 DateTime of a value for a time series property.</p>
|
|
1701
|
-
* <p>The time for when the property value was recorded in ISO 8601 format:
|
|
2020
|
+
* <p>The time for when the property value was recorded in ISO 8601 format:
|
|
2021
|
+
* <i>YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm]</i>.</p>
|
|
1702
2022
|
* <ul>
|
|
1703
2023
|
* <li>
|
|
1704
2024
|
* <p>
|
|
@@ -1726,8 +2046,8 @@ export interface PropertyValue {
|
|
|
1726
2046
|
* </li>
|
|
1727
2047
|
* <li>
|
|
1728
2048
|
* <p>
|
|
1729
|
-
* <i>[.SSSSSSSSS]</i>: additional precision, where precedence is
|
|
1730
|
-
* example: [.573123] is equal to 573123000 nanoseconds.</p>
|
|
2049
|
+
* <i>[.SSSSSSSSS]</i>: additional precision, where precedence is
|
|
2050
|
+
* maintained. For example: [.573123] is equal to 573123000 nanoseconds.</p>
|
|
1731
2051
|
* </li>
|
|
1732
2052
|
* <li>
|
|
1733
2053
|
* <p>
|
|
@@ -1744,6 +2064,7 @@ export interface PropertyValue {
|
|
|
1744
2064
|
time?: string;
|
|
1745
2065
|
}
|
|
1746
2066
|
/**
|
|
2067
|
+
* @public
|
|
1747
2068
|
* <p>An object that specifies the data type of a property.</p>
|
|
1748
2069
|
*/
|
|
1749
2070
|
export interface DataType {
|
|
@@ -1768,6 +2089,9 @@ export interface DataType {
|
|
|
1768
2089
|
*/
|
|
1769
2090
|
relationship?: Relationship;
|
|
1770
2091
|
}
|
|
2092
|
+
/**
|
|
2093
|
+
* @public
|
|
2094
|
+
*/
|
|
1771
2095
|
export interface GetPropertyValueHistoryRequest {
|
|
1772
2096
|
/**
|
|
1773
2097
|
* <p>The ID of the workspace.</p>
|
|
@@ -1806,7 +2130,8 @@ export interface GetPropertyValueHistoryRequest {
|
|
|
1806
2130
|
*/
|
|
1807
2131
|
endDateTime?: Date;
|
|
1808
2132
|
/**
|
|
1809
|
-
* <p>An object that specifies the interpolation type and the interval over which to
|
|
2133
|
+
* <p>An object that specifies the interpolation type and the interval over which to
|
|
2134
|
+
* interpolate data.</p>
|
|
1810
2135
|
*/
|
|
1811
2136
|
interpolation?: InterpolationParameters;
|
|
1812
2137
|
/**
|
|
@@ -1834,7 +2159,9 @@ export interface GetPropertyValueHistoryRequest {
|
|
|
1834
2159
|
endTime?: string;
|
|
1835
2160
|
}
|
|
1836
2161
|
/**
|
|
1837
|
-
*
|
|
2162
|
+
* @public
|
|
2163
|
+
* <p>An object that specifies information about time series property values. This object is
|
|
2164
|
+
* used and consumed by the <a href="https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_BatchPutPropertyValues.html">BatchPutPropertyValues</a> action.</p>
|
|
1838
2165
|
*/
|
|
1839
2166
|
export interface PropertyValueEntry {
|
|
1840
2167
|
/**
|
|
@@ -1847,6 +2174,7 @@ export interface PropertyValueEntry {
|
|
|
1847
2174
|
propertyValues?: PropertyValue[];
|
|
1848
2175
|
}
|
|
1849
2176
|
/**
|
|
2177
|
+
* @public
|
|
1850
2178
|
* <p>The history of values for a time series property.</p>
|
|
1851
2179
|
*/
|
|
1852
2180
|
export interface PropertyValueHistory {
|
|
@@ -1855,27 +2183,32 @@ export interface PropertyValueHistory {
|
|
|
1855
2183
|
*/
|
|
1856
2184
|
entityPropertyReference: EntityPropertyReference | undefined;
|
|
1857
2185
|
/**
|
|
1858
|
-
* <p>A list of objects that contain information about the values in the history of a time
|
|
2186
|
+
* <p>A list of objects that contain information about the values in the history of a time
|
|
2187
|
+
* series property.</p>
|
|
1859
2188
|
*/
|
|
1860
2189
|
values?: PropertyValue[];
|
|
1861
2190
|
}
|
|
1862
2191
|
/**
|
|
2192
|
+
* @public
|
|
1863
2193
|
* <p>The tabular conditions.</p>
|
|
1864
2194
|
*/
|
|
1865
2195
|
export interface TabularConditions {
|
|
1866
2196
|
/**
|
|
1867
|
-
* <p>Filter criteria that orders the output. It can be sorted in ascending or descending
|
|
2197
|
+
* <p>Filter criteria that orders the output. It can be sorted in ascending or descending
|
|
2198
|
+
* order.</p>
|
|
1868
2199
|
*/
|
|
1869
2200
|
orderBy?: OrderBy[];
|
|
1870
2201
|
/**
|
|
1871
|
-
* <p>You can filter the request using various logical operators and a key-value format. For
|
|
2202
|
+
* <p>You can filter the request using various logical operators and a key-value format. For
|
|
2203
|
+
* example:</p>
|
|
1872
2204
|
* <p>
|
|
1873
|
-
* <code
|
|
2205
|
+
* <code>\{"key": "serverType", "value": "webServer"\}</code>
|
|
1874
2206
|
* </p>
|
|
1875
2207
|
*/
|
|
1876
2208
|
propertyFilters?: PropertyFilter[];
|
|
1877
2209
|
}
|
|
1878
2210
|
/**
|
|
2211
|
+
* @public
|
|
1879
2212
|
* <p>An error returned by the <code>BatchPutProperty</code> action.</p>
|
|
1880
2213
|
*/
|
|
1881
2214
|
export interface BatchPutPropertyError {
|
|
@@ -1888,10 +2221,14 @@ export interface BatchPutPropertyError {
|
|
|
1888
2221
|
*/
|
|
1889
2222
|
errorMessage: string | undefined;
|
|
1890
2223
|
/**
|
|
1891
|
-
* <p>An object that contains information about errors returned by the
|
|
2224
|
+
* <p>An object that contains information about errors returned by the
|
|
2225
|
+
* <code>BatchPutProperty</code> action.</p>
|
|
1892
2226
|
*/
|
|
1893
2227
|
entry: PropertyValueEntry | undefined;
|
|
1894
2228
|
}
|
|
2229
|
+
/**
|
|
2230
|
+
* @public
|
|
2231
|
+
*/
|
|
1895
2232
|
export interface GetPropertyValueRequest {
|
|
1896
2233
|
/**
|
|
1897
2234
|
* <p>The name of the component whose property values the operation returns.</p>
|
|
@@ -1931,21 +2268,27 @@ export interface GetPropertyValueRequest {
|
|
|
1931
2268
|
*/
|
|
1932
2269
|
tabularConditions?: TabularConditions;
|
|
1933
2270
|
}
|
|
2271
|
+
/**
|
|
2272
|
+
* @public
|
|
2273
|
+
*/
|
|
1934
2274
|
export interface BatchPutPropertyValuesRequest {
|
|
1935
2275
|
/**
|
|
1936
2276
|
* <p>The ID of the workspace that contains the properties to set.</p>
|
|
1937
2277
|
*/
|
|
1938
2278
|
workspaceId: string | undefined;
|
|
1939
2279
|
/**
|
|
1940
|
-
* <p>An object that maps strings to the property value entries to set. Each string
|
|
1941
|
-
*
|
|
2280
|
+
* <p>An object that maps strings to the property value entries to set. Each string in the
|
|
2281
|
+
* mapping must be unique to this object.</p>
|
|
1942
2282
|
*/
|
|
1943
2283
|
entries: PropertyValueEntry[] | undefined;
|
|
1944
2284
|
}
|
|
2285
|
+
/**
|
|
2286
|
+
* @public
|
|
2287
|
+
*/
|
|
1945
2288
|
export interface GetPropertyValueHistoryResponse {
|
|
1946
2289
|
/**
|
|
1947
|
-
* <p>An object that maps strings to the property definitions in the component type. Each
|
|
1948
|
-
*
|
|
2290
|
+
* <p>An object that maps strings to the property definitions in the component type. Each
|
|
2291
|
+
* string in the mapping must be unique to this object.</p>
|
|
1949
2292
|
*/
|
|
1950
2293
|
propertyValues: PropertyValueHistory[] | undefined;
|
|
1951
2294
|
/**
|
|
@@ -1954,7 +2297,9 @@ export interface GetPropertyValueHistoryResponse {
|
|
|
1954
2297
|
nextToken?: string;
|
|
1955
2298
|
}
|
|
1956
2299
|
/**
|
|
1957
|
-
*
|
|
2300
|
+
* @public
|
|
2301
|
+
* <p>An object that contains information about errors returned by the
|
|
2302
|
+
* <code>BatchPutProperty</code> action.</p>
|
|
1958
2303
|
*/
|
|
1959
2304
|
export interface BatchPutPropertyErrorEntry {
|
|
1960
2305
|
/**
|
|
@@ -1964,6 +2309,7 @@ export interface BatchPutPropertyErrorEntry {
|
|
|
1964
2309
|
errors: BatchPutPropertyError[] | undefined;
|
|
1965
2310
|
}
|
|
1966
2311
|
/**
|
|
2312
|
+
* @public
|
|
1967
2313
|
* <p>An object that sets information about a property.</p>
|
|
1968
2314
|
*/
|
|
1969
2315
|
export interface PropertyDefinitionRequest {
|
|
@@ -1976,7 +2322,8 @@ export interface PropertyDefinitionRequest {
|
|
|
1976
2322
|
*/
|
|
1977
2323
|
isRequiredInEntity?: boolean;
|
|
1978
2324
|
/**
|
|
1979
|
-
* <p>A Boolean value that specifies whether the property ID comes from an external data
|
|
2325
|
+
* <p>A Boolean value that specifies whether the property ID comes from an external data
|
|
2326
|
+
* store.</p>
|
|
1980
2327
|
*/
|
|
1981
2328
|
isExternalId?: boolean;
|
|
1982
2329
|
/**
|
|
@@ -2002,6 +2349,7 @@ export interface PropertyDefinitionRequest {
|
|
|
2002
2349
|
displayName?: string;
|
|
2003
2350
|
}
|
|
2004
2351
|
/**
|
|
2352
|
+
* @public
|
|
2005
2353
|
* <p>An object that contains response data from a property definition request.</p>
|
|
2006
2354
|
*/
|
|
2007
2355
|
export interface PropertyDefinitionResponse {
|
|
@@ -2018,7 +2366,8 @@ export interface PropertyDefinitionResponse {
|
|
|
2018
2366
|
*/
|
|
2019
2367
|
isRequiredInEntity: boolean | undefined;
|
|
2020
2368
|
/**
|
|
2021
|
-
* <p>A Boolean value that specifies whether the property ID comes from an external data
|
|
2369
|
+
* <p>A Boolean value that specifies whether the property ID comes from an external data
|
|
2370
|
+
* store.</p>
|
|
2022
2371
|
*/
|
|
2023
2372
|
isExternalId: boolean | undefined;
|
|
2024
2373
|
/**
|
|
@@ -2026,7 +2375,8 @@ export interface PropertyDefinitionResponse {
|
|
|
2026
2375
|
*/
|
|
2027
2376
|
isStoredExternally: boolean | undefined;
|
|
2028
2377
|
/**
|
|
2029
|
-
* <p>A Boolean value that specifies whether the property definition is imported from an
|
|
2378
|
+
* <p>A Boolean value that specifies whether the property definition is imported from an
|
|
2379
|
+
* external data store.</p>
|
|
2030
2380
|
*/
|
|
2031
2381
|
isImported: boolean | undefined;
|
|
2032
2382
|
/**
|
|
@@ -2034,7 +2384,8 @@ export interface PropertyDefinitionResponse {
|
|
|
2034
2384
|
*/
|
|
2035
2385
|
isFinal: boolean | undefined;
|
|
2036
2386
|
/**
|
|
2037
|
-
* <p>A Boolean value that specifies whether the property definition is inherited from a
|
|
2387
|
+
* <p>A Boolean value that specifies whether the property definition is inherited from a
|
|
2388
|
+
* parent entity.</p>
|
|
2038
2389
|
*/
|
|
2039
2390
|
isInherited: boolean | undefined;
|
|
2040
2391
|
/**
|
|
@@ -2050,16 +2401,22 @@ export interface PropertyDefinitionResponse {
|
|
|
2050
2401
|
*/
|
|
2051
2402
|
displayName?: string;
|
|
2052
2403
|
}
|
|
2404
|
+
/**
|
|
2405
|
+
* @public
|
|
2406
|
+
*/
|
|
2053
2407
|
export interface BatchPutPropertyValuesResponse {
|
|
2054
2408
|
/**
|
|
2055
2409
|
* <p>Entries that caused errors in the batch put operation.</p>
|
|
2056
2410
|
*/
|
|
2057
2411
|
errorEntries: BatchPutPropertyErrorEntry[] | undefined;
|
|
2058
2412
|
}
|
|
2413
|
+
/**
|
|
2414
|
+
* @public
|
|
2415
|
+
*/
|
|
2059
2416
|
export interface GetPropertyValueResponse {
|
|
2060
2417
|
/**
|
|
2061
|
-
* <p>An object that maps strings to the properties and latest property values in the
|
|
2062
|
-
*
|
|
2418
|
+
* <p>An object that maps strings to the properties and latest property values in the
|
|
2419
|
+
* response. Each string in the mapping must be unique to this object.</p>
|
|
2063
2420
|
*/
|
|
2064
2421
|
propertyValues?: Record<string, PropertyLatestValue>;
|
|
2065
2422
|
/**
|
|
@@ -2071,6 +2428,9 @@ export interface GetPropertyValueResponse {
|
|
|
2071
2428
|
*/
|
|
2072
2429
|
tabularPropertyValues?: Record<string, DataValue>[][];
|
|
2073
2430
|
}
|
|
2431
|
+
/**
|
|
2432
|
+
* @public
|
|
2433
|
+
*/
|
|
2074
2434
|
export interface CreateComponentTypeRequest {
|
|
2075
2435
|
/**
|
|
2076
2436
|
* <p>The ID of the workspace that contains the component type.</p>
|
|
@@ -2090,8 +2450,8 @@ export interface CreateComponentTypeRequest {
|
|
|
2090
2450
|
*/
|
|
2091
2451
|
description?: string;
|
|
2092
2452
|
/**
|
|
2093
|
-
* <p>An object that maps strings to the property definitions in the component type. Each
|
|
2094
|
-
*
|
|
2453
|
+
* <p>An object that maps strings to the property definitions in the component type. Each
|
|
2454
|
+
* string in the mapping must be unique to this object.</p>
|
|
2095
2455
|
*/
|
|
2096
2456
|
propertyDefinitions?: Record<string, PropertyDefinitionRequest>;
|
|
2097
2457
|
/**
|
|
@@ -2116,14 +2476,17 @@ export interface CreateComponentTypeRequest {
|
|
|
2116
2476
|
*/
|
|
2117
2477
|
componentTypeName?: string;
|
|
2118
2478
|
}
|
|
2479
|
+
/**
|
|
2480
|
+
* @public
|
|
2481
|
+
*/
|
|
2119
2482
|
export interface GetComponentTypeResponse {
|
|
2120
2483
|
/**
|
|
2121
2484
|
* <p>The ID of the workspace that contains the component type.</p>
|
|
2122
2485
|
*/
|
|
2123
2486
|
workspaceId: string | undefined;
|
|
2124
2487
|
/**
|
|
2125
|
-
* <p>A Boolean value that specifies whether an entity can have more than one component of
|
|
2126
|
-
* type.</p>
|
|
2488
|
+
* <p>A Boolean value that specifies whether an entity can have more than one component of
|
|
2489
|
+
* this type.</p>
|
|
2127
2490
|
*/
|
|
2128
2491
|
isSingleton?: boolean;
|
|
2129
2492
|
/**
|
|
@@ -2135,8 +2498,8 @@ export interface GetComponentTypeResponse {
|
|
|
2135
2498
|
*/
|
|
2136
2499
|
description?: string;
|
|
2137
2500
|
/**
|
|
2138
|
-
* <p>An object that maps strings to the property definitions in the component type. Each
|
|
2139
|
-
*
|
|
2501
|
+
* <p>An object that maps strings to the property definitions in the component type. Each
|
|
2502
|
+
* string in the mapping must be unique to this object.</p>
|
|
2140
2503
|
*/
|
|
2141
2504
|
propertyDefinitions?: Record<string, PropertyDefinitionResponse>;
|
|
2142
2505
|
/**
|
|
@@ -2144,8 +2507,8 @@ export interface GetComponentTypeResponse {
|
|
|
2144
2507
|
*/
|
|
2145
2508
|
extendsFrom?: string[];
|
|
2146
2509
|
/**
|
|
2147
|
-
* <p>An object that maps strings to the functions in the component type. Each string
|
|
2148
|
-
*
|
|
2510
|
+
* <p>An object that maps strings to the functions in the component type. Each string in the
|
|
2511
|
+
* mapping must be unique to this object.</p>
|
|
2149
2512
|
*/
|
|
2150
2513
|
functions?: Record<string, FunctionResponse>;
|
|
2151
2514
|
/**
|
|
@@ -2165,8 +2528,8 @@ export interface GetComponentTypeResponse {
|
|
|
2165
2528
|
*/
|
|
2166
2529
|
isAbstract?: boolean;
|
|
2167
2530
|
/**
|
|
2168
|
-
* <p>A Boolean value that specifies whether the component type has a schema initializer and
|
|
2169
|
-
*
|
|
2531
|
+
* <p>A Boolean value that specifies whether the component type has a schema initializer and
|
|
2532
|
+
* that the schema initializer has run.</p>
|
|
2170
2533
|
*/
|
|
2171
2534
|
isSchemaInitialized?: boolean;
|
|
2172
2535
|
/**
|
|
@@ -2179,7 +2542,7 @@ export interface GetComponentTypeResponse {
|
|
|
2179
2542
|
*/
|
|
2180
2543
|
propertyGroups?: Record<string, PropertyGroupResponse>;
|
|
2181
2544
|
/**
|
|
2182
|
-
* <p>The syncSource of the
|
|
2545
|
+
* <p>The syncSource of the SyncJob, if this entity was created by a SyncJob.</p>
|
|
2183
2546
|
*/
|
|
2184
2547
|
syncSource?: string;
|
|
2185
2548
|
/**
|
|
@@ -2187,14 +2550,17 @@ export interface GetComponentTypeResponse {
|
|
|
2187
2550
|
*/
|
|
2188
2551
|
componentTypeName?: string;
|
|
2189
2552
|
}
|
|
2553
|
+
/**
|
|
2554
|
+
* @public
|
|
2555
|
+
*/
|
|
2190
2556
|
export interface UpdateComponentTypeRequest {
|
|
2191
2557
|
/**
|
|
2192
2558
|
* <p>The ID of the workspace.</p>
|
|
2193
2559
|
*/
|
|
2194
2560
|
workspaceId: string | undefined;
|
|
2195
2561
|
/**
|
|
2196
|
-
* <p>A Boolean value that specifies whether an entity can have more than one component of
|
|
2197
|
-
* type.</p>
|
|
2562
|
+
* <p>A Boolean value that specifies whether an entity can have more than one component of
|
|
2563
|
+
* this type.</p>
|
|
2198
2564
|
*/
|
|
2199
2565
|
isSingleton?: boolean;
|
|
2200
2566
|
/**
|
|
@@ -2206,8 +2572,8 @@ export interface UpdateComponentTypeRequest {
|
|
|
2206
2572
|
*/
|
|
2207
2573
|
description?: string;
|
|
2208
2574
|
/**
|
|
2209
|
-
* <p>An object that maps strings to the property definitions in the component type. Each
|
|
2210
|
-
*
|
|
2575
|
+
* <p>An object that maps strings to the property definitions in the component type. Each
|
|
2576
|
+
* string in the mapping must be unique to this object.</p>
|
|
2211
2577
|
*/
|
|
2212
2578
|
propertyDefinitions?: Record<string, PropertyDefinitionRequest>;
|
|
2213
2579
|
/**
|
|
@@ -2215,12 +2581,12 @@ export interface UpdateComponentTypeRequest {
|
|
|
2215
2581
|
*/
|
|
2216
2582
|
extendsFrom?: string[];
|
|
2217
2583
|
/**
|
|
2218
|
-
* <p>An object that maps strings to the functions in the component type. Each string
|
|
2219
|
-
*
|
|
2584
|
+
* <p>An object that maps strings to the functions in the component type. Each string in the
|
|
2585
|
+
* mapping must be unique to this object.</p>
|
|
2220
2586
|
*/
|
|
2221
2587
|
functions?: Record<string, FunctionRequest>;
|
|
2222
2588
|
/**
|
|
2223
|
-
* <p>The property groups
|
|
2589
|
+
* <p>The property groups.</p>
|
|
2224
2590
|
*/
|
|
2225
2591
|
propertyGroups?: Record<string, PropertyGroupRequest>;
|
|
2226
2592
|
/**
|
|
@@ -2229,6 +2595,7 @@ export interface UpdateComponentTypeRequest {
|
|
|
2229
2595
|
componentTypeName?: string;
|
|
2230
2596
|
}
|
|
2231
2597
|
/**
|
|
2598
|
+
* @public
|
|
2232
2599
|
* <p>An object that sets information about a property.</p>
|
|
2233
2600
|
*/
|
|
2234
2601
|
export interface PropertyRequest {
|
|
@@ -2246,6 +2613,7 @@ export interface PropertyRequest {
|
|
|
2246
2613
|
updateType?: PropertyUpdateType | string;
|
|
2247
2614
|
}
|
|
2248
2615
|
/**
|
|
2616
|
+
* @public
|
|
2249
2617
|
* <p>An object that contains information about a property response.</p>
|
|
2250
2618
|
*/
|
|
2251
2619
|
export interface PropertyResponse {
|
|
@@ -2259,6 +2627,7 @@ export interface PropertyResponse {
|
|
|
2259
2627
|
value?: DataValue;
|
|
2260
2628
|
}
|
|
2261
2629
|
/**
|
|
2630
|
+
* @public
|
|
2262
2631
|
* <p>An object that sets information about a component type create or update request.</p>
|
|
2263
2632
|
*/
|
|
2264
2633
|
export interface ComponentRequest {
|
|
@@ -2272,7 +2641,7 @@ export interface ComponentRequest {
|
|
|
2272
2641
|
componentTypeId?: string;
|
|
2273
2642
|
/**
|
|
2274
2643
|
* <p>An object that maps strings to the properties to set in the component type. Each string
|
|
2275
|
-
*
|
|
2644
|
+
* in the mapping must be unique to this object.</p>
|
|
2276
2645
|
*/
|
|
2277
2646
|
properties?: Record<string, PropertyRequest>;
|
|
2278
2647
|
/**
|
|
@@ -2281,7 +2650,9 @@ export interface ComponentRequest {
|
|
|
2281
2650
|
propertyGroups?: Record<string, ComponentPropertyGroupRequest>;
|
|
2282
2651
|
}
|
|
2283
2652
|
/**
|
|
2284
|
-
*
|
|
2653
|
+
* @public
|
|
2654
|
+
* <p>An object that returns information about a component type create or update
|
|
2655
|
+
* request.</p>
|
|
2285
2656
|
*/
|
|
2286
2657
|
export interface ComponentResponse {
|
|
2287
2658
|
/**
|
|
@@ -2306,7 +2677,7 @@ export interface ComponentResponse {
|
|
|
2306
2677
|
definedIn?: string;
|
|
2307
2678
|
/**
|
|
2308
2679
|
* <p>An object that maps strings to the properties to set in the component type. Each string
|
|
2309
|
-
*
|
|
2680
|
+
* in the mapping must be unique to this object.</p>
|
|
2310
2681
|
*/
|
|
2311
2682
|
properties?: Record<string, PropertyResponse>;
|
|
2312
2683
|
/**
|
|
@@ -2319,6 +2690,7 @@ export interface ComponentResponse {
|
|
|
2319
2690
|
syncSource?: string;
|
|
2320
2691
|
}
|
|
2321
2692
|
/**
|
|
2693
|
+
* @public
|
|
2322
2694
|
* <p>The component update request.</p>
|
|
2323
2695
|
*/
|
|
2324
2696
|
export interface ComponentUpdateRequest {
|
|
@@ -2335,8 +2707,8 @@ export interface ComponentUpdateRequest {
|
|
|
2335
2707
|
*/
|
|
2336
2708
|
componentTypeId?: string;
|
|
2337
2709
|
/**
|
|
2338
|
-
* <p>An object that maps strings to the properties to set in the component type update. Each
|
|
2339
|
-
*
|
|
2710
|
+
* <p>An object that maps strings to the properties to set in the component type update. Each
|
|
2711
|
+
* string in the mapping must be unique to this object.</p>
|
|
2340
2712
|
*/
|
|
2341
2713
|
propertyUpdates?: Record<string, PropertyRequest>;
|
|
2342
2714
|
/**
|
|
@@ -2344,6 +2716,9 @@ export interface ComponentUpdateRequest {
|
|
|
2344
2716
|
*/
|
|
2345
2717
|
propertyGroupUpdates?: Record<string, ComponentPropertyGroupRequest>;
|
|
2346
2718
|
}
|
|
2719
|
+
/**
|
|
2720
|
+
* @public
|
|
2721
|
+
*/
|
|
2347
2722
|
export interface CreateEntityRequest {
|
|
2348
2723
|
/**
|
|
2349
2724
|
* <p>The ID of the workspace that contains the entity.</p>
|
|
@@ -2362,8 +2737,8 @@ export interface CreateEntityRequest {
|
|
|
2362
2737
|
*/
|
|
2363
2738
|
description?: string;
|
|
2364
2739
|
/**
|
|
2365
|
-
* <p>An object that maps strings to the components in the entity. Each string
|
|
2366
|
-
*
|
|
2740
|
+
* <p>An object that maps strings to the components in the entity. Each string in the mapping
|
|
2741
|
+
* must be unique to this object.</p>
|
|
2367
2742
|
*/
|
|
2368
2743
|
components?: Record<string, ComponentRequest>;
|
|
2369
2744
|
/**
|
|
@@ -2375,6 +2750,9 @@ export interface CreateEntityRequest {
|
|
|
2375
2750
|
*/
|
|
2376
2751
|
tags?: Record<string, string>;
|
|
2377
2752
|
}
|
|
2753
|
+
/**
|
|
2754
|
+
* @public
|
|
2755
|
+
*/
|
|
2378
2756
|
export interface GetEntityResponse {
|
|
2379
2757
|
/**
|
|
2380
2758
|
* <p>The ID of the entity.</p>
|
|
@@ -2401,8 +2779,8 @@ export interface GetEntityResponse {
|
|
|
2401
2779
|
*/
|
|
2402
2780
|
description?: string;
|
|
2403
2781
|
/**
|
|
2404
|
-
* <p>An object that maps strings to the components in the entity. Each string
|
|
2405
|
-
*
|
|
2782
|
+
* <p>An object that maps strings to the components in the entity. Each string in the mapping
|
|
2783
|
+
* must be unique to this object.</p>
|
|
2406
2784
|
*/
|
|
2407
2785
|
components?: Record<string, ComponentResponse>;
|
|
2408
2786
|
/**
|
|
@@ -2426,6 +2804,9 @@ export interface GetEntityResponse {
|
|
|
2426
2804
|
*/
|
|
2427
2805
|
syncSource?: string;
|
|
2428
2806
|
}
|
|
2807
|
+
/**
|
|
2808
|
+
* @public
|
|
2809
|
+
*/
|
|
2429
2810
|
export interface UpdateEntityRequest {
|
|
2430
2811
|
/**
|
|
2431
2812
|
* <p>The ID of the workspace that contains the entity.</p>
|
|
@@ -2444,8 +2825,8 @@ export interface UpdateEntityRequest {
|
|
|
2444
2825
|
*/
|
|
2445
2826
|
description?: string;
|
|
2446
2827
|
/**
|
|
2447
|
-
* <p>An object that maps strings to the component updates in the request. Each string
|
|
2448
|
-
*
|
|
2828
|
+
* <p>An object that maps strings to the component updates in the request. Each string in the
|
|
2829
|
+
* mapping must be unique to this object.</p>
|
|
2449
2830
|
*/
|
|
2450
2831
|
componentUpdates?: Record<string, ComponentUpdateRequest>;
|
|
2451
2832
|
/**
|