@aws-sdk/client-iottwinmaker 3.686.0 → 3.691.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 +318 -318
- package/dist-types/ts3.4/models/models_0.d.ts +330 -318
- package/package.json +7 -7
|
@@ -9,15 +9,15 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
9
9
|
);
|
|
10
10
|
}
|
|
11
11
|
export interface EntityPropertyReference {
|
|
12
|
-
componentName?: string;
|
|
13
|
-
componentPath?: string;
|
|
14
|
-
externalIdProperty?: Record<string, string
|
|
15
|
-
entityId?: string;
|
|
12
|
+
componentName?: string | undefined;
|
|
13
|
+
componentPath?: string | undefined;
|
|
14
|
+
externalIdProperty?: Record<string, string> | undefined;
|
|
15
|
+
entityId?: string | undefined;
|
|
16
16
|
propertyName: string | undefined;
|
|
17
17
|
}
|
|
18
18
|
export interface RelationshipValue {
|
|
19
|
-
targetEntityId?: string;
|
|
20
|
-
targetComponentName?: string;
|
|
19
|
+
targetEntityId?: string | undefined;
|
|
20
|
+
targetComponentName?: string | undefined;
|
|
21
21
|
}
|
|
22
22
|
export declare class InternalServerException extends __BaseException {
|
|
23
23
|
readonly name: "InternalServerException";
|
|
@@ -51,10 +51,10 @@ export interface CancelMetadataTransferJobRequest {
|
|
|
51
51
|
metadataTransferJobId: string | undefined;
|
|
52
52
|
}
|
|
53
53
|
export interface MetadataTransferJobProgress {
|
|
54
|
-
totalCount?: number;
|
|
55
|
-
succeededCount?: number;
|
|
56
|
-
skippedCount?: number;
|
|
57
|
-
failedCount?: number;
|
|
54
|
+
totalCount?: number | undefined;
|
|
55
|
+
succeededCount?: number | undefined;
|
|
56
|
+
skippedCount?: number | undefined;
|
|
57
|
+
failedCount?: number | undefined;
|
|
58
58
|
}
|
|
59
59
|
export declare const ErrorCode: {
|
|
60
60
|
readonly COMPOSITE_COMPONENT_FAILURE: "COMPOSITE_COMPONENT_FAILURE";
|
|
@@ -68,8 +68,8 @@ export declare const ErrorCode: {
|
|
|
68
68
|
};
|
|
69
69
|
export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
|
|
70
70
|
export interface ErrorDetails {
|
|
71
|
-
code?: ErrorCode;
|
|
72
|
-
message?: string;
|
|
71
|
+
code?: ErrorCode | undefined;
|
|
72
|
+
message?: string | undefined;
|
|
73
73
|
}
|
|
74
74
|
export declare const MetadataTransferJobState: {
|
|
75
75
|
readonly CANCELLED: "CANCELLED";
|
|
@@ -83,16 +83,16 @@ export declare const MetadataTransferJobState: {
|
|
|
83
83
|
export type MetadataTransferJobState =
|
|
84
84
|
(typeof MetadataTransferJobState)[keyof typeof MetadataTransferJobState];
|
|
85
85
|
export interface MetadataTransferJobStatus {
|
|
86
|
-
state?: MetadataTransferJobState;
|
|
87
|
-
error?: ErrorDetails;
|
|
88
|
-
queuedPosition?: number;
|
|
86
|
+
state?: MetadataTransferJobState | undefined;
|
|
87
|
+
error?: ErrorDetails | undefined;
|
|
88
|
+
queuedPosition?: number | undefined;
|
|
89
89
|
}
|
|
90
90
|
export interface CancelMetadataTransferJobResponse {
|
|
91
91
|
metadataTransferJobId: string | undefined;
|
|
92
92
|
arn: string | undefined;
|
|
93
93
|
updateDateTime: Date | undefined;
|
|
94
94
|
status: MetadataTransferJobStatus | undefined;
|
|
95
|
-
progress?: MetadataTransferJobProgress;
|
|
95
|
+
progress?: MetadataTransferJobProgress | undefined;
|
|
96
96
|
}
|
|
97
97
|
export declare class ConflictException extends __BaseException {
|
|
98
98
|
readonly name: "ConflictException";
|
|
@@ -100,14 +100,14 @@ export declare class ConflictException extends __BaseException {
|
|
|
100
100
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
101
101
|
}
|
|
102
102
|
export interface CompositeComponentTypeRequest {
|
|
103
|
-
componentTypeId?: string;
|
|
103
|
+
componentTypeId?: string | undefined;
|
|
104
104
|
}
|
|
105
105
|
export interface LambdaFunction {
|
|
106
106
|
arn: string | undefined;
|
|
107
107
|
}
|
|
108
108
|
export interface DataConnector {
|
|
109
|
-
lambda?: LambdaFunction;
|
|
110
|
-
isNative?: boolean;
|
|
109
|
+
lambda?: LambdaFunction | undefined;
|
|
110
|
+
isNative?: boolean | undefined;
|
|
111
111
|
}
|
|
112
112
|
export declare const Scope: {
|
|
113
113
|
readonly ENTITY: "ENTITY";
|
|
@@ -115,13 +115,13 @@ export declare const Scope: {
|
|
|
115
115
|
};
|
|
116
116
|
export type Scope = (typeof Scope)[keyof typeof Scope];
|
|
117
117
|
export interface FunctionRequest {
|
|
118
|
-
requiredProperties?: string[];
|
|
119
|
-
scope?: Scope;
|
|
120
|
-
implementedBy?: DataConnector;
|
|
118
|
+
requiredProperties?: string[] | undefined;
|
|
119
|
+
scope?: Scope | undefined;
|
|
120
|
+
implementedBy?: DataConnector | undefined;
|
|
121
121
|
}
|
|
122
122
|
export interface Relationship {
|
|
123
|
-
targetComponentTypeId?: string;
|
|
124
|
-
relationshipType?: string;
|
|
123
|
+
targetComponentTypeId?: string | undefined;
|
|
124
|
+
relationshipType?: string | undefined;
|
|
125
125
|
}
|
|
126
126
|
export declare const Type: {
|
|
127
127
|
readonly BOOLEAN: "BOOLEAN";
|
|
@@ -139,8 +139,8 @@ export declare const GroupType: {
|
|
|
139
139
|
};
|
|
140
140
|
export type GroupType = (typeof GroupType)[keyof typeof GroupType];
|
|
141
141
|
export interface PropertyGroupRequest {
|
|
142
|
-
groupType?: GroupType;
|
|
143
|
-
propertyNames?: string[];
|
|
142
|
+
groupType?: GroupType | undefined;
|
|
143
|
+
propertyNames?: string[] | undefined;
|
|
144
144
|
}
|
|
145
145
|
export declare const State: {
|
|
146
146
|
readonly ACTIVE: "ACTIVE";
|
|
@@ -178,9 +178,9 @@ export declare const PropertyGroupUpdateType: {
|
|
|
178
178
|
export type PropertyGroupUpdateType =
|
|
179
179
|
(typeof PropertyGroupUpdateType)[keyof typeof PropertyGroupUpdateType];
|
|
180
180
|
export interface ComponentPropertyGroupRequest {
|
|
181
|
-
groupType?: GroupType;
|
|
182
|
-
propertyNames?: string[];
|
|
183
|
-
updateType?: PropertyGroupUpdateType;
|
|
181
|
+
groupType?: GroupType | undefined;
|
|
182
|
+
propertyNames?: string[] | undefined;
|
|
183
|
+
updateType?: PropertyGroupUpdateType | undefined;
|
|
184
184
|
}
|
|
185
185
|
export interface CreateEntityResponse {
|
|
186
186
|
entityId: string | undefined;
|
|
@@ -203,20 +203,20 @@ export type DestinationType =
|
|
|
203
203
|
(typeof DestinationType)[keyof typeof DestinationType];
|
|
204
204
|
export interface DestinationConfiguration {
|
|
205
205
|
type: DestinationType | undefined;
|
|
206
|
-
s3Configuration?: S3DestinationConfiguration;
|
|
207
|
-
iotTwinMakerConfiguration?: IotTwinMakerDestinationConfiguration;
|
|
206
|
+
s3Configuration?: S3DestinationConfiguration | undefined;
|
|
207
|
+
iotTwinMakerConfiguration?: IotTwinMakerDestinationConfiguration | undefined;
|
|
208
208
|
}
|
|
209
209
|
export interface FilterByAsset {
|
|
210
|
-
assetId?: string;
|
|
211
|
-
assetExternalId?: string;
|
|
212
|
-
includeOffspring?: boolean;
|
|
213
|
-
includeAssetModel?: boolean;
|
|
210
|
+
assetId?: string | undefined;
|
|
211
|
+
assetExternalId?: string | undefined;
|
|
212
|
+
includeOffspring?: boolean | undefined;
|
|
213
|
+
includeAssetModel?: boolean | undefined;
|
|
214
214
|
}
|
|
215
215
|
export interface FilterByAssetModel {
|
|
216
|
-
assetModelId?: string;
|
|
217
|
-
assetModelExternalId?: string;
|
|
218
|
-
includeOffspring?: boolean;
|
|
219
|
-
includeAssets?: boolean;
|
|
216
|
+
assetModelId?: string | undefined;
|
|
217
|
+
assetModelExternalId?: string | undefined;
|
|
218
|
+
includeOffspring?: boolean | undefined;
|
|
219
|
+
includeAssets?: boolean | undefined;
|
|
220
220
|
}
|
|
221
221
|
export type IotSiteWiseSourceConfigurationFilter =
|
|
222
222
|
| IotSiteWiseSourceConfigurationFilter.FilterByAssetMember
|
|
@@ -249,7 +249,7 @@ export declare namespace IotSiteWiseSourceConfigurationFilter {
|
|
|
249
249
|
) => T;
|
|
250
250
|
}
|
|
251
251
|
export interface IotSiteWiseSourceConfiguration {
|
|
252
|
-
filters?: IotSiteWiseSourceConfigurationFilter[];
|
|
252
|
+
filters?: IotSiteWiseSourceConfigurationFilter[] | undefined;
|
|
253
253
|
}
|
|
254
254
|
export interface FilterByComponentType {
|
|
255
255
|
componentTypeId: string | undefined;
|
|
@@ -289,7 +289,7 @@ export declare namespace IotTwinMakerSourceConfigurationFilter {
|
|
|
289
289
|
}
|
|
290
290
|
export interface IotTwinMakerSourceConfiguration {
|
|
291
291
|
workspace: string | undefined;
|
|
292
|
-
filters?: IotTwinMakerSourceConfigurationFilter[];
|
|
292
|
+
filters?: IotTwinMakerSourceConfigurationFilter[] | undefined;
|
|
293
293
|
}
|
|
294
294
|
export interface S3SourceConfiguration {
|
|
295
295
|
location: string | undefined;
|
|
@@ -302,13 +302,13 @@ export declare const SourceType: {
|
|
|
302
302
|
export type SourceType = (typeof SourceType)[keyof typeof SourceType];
|
|
303
303
|
export interface SourceConfiguration {
|
|
304
304
|
type: SourceType | undefined;
|
|
305
|
-
s3Configuration?: S3SourceConfiguration;
|
|
306
|
-
iotSiteWiseConfiguration?: IotSiteWiseSourceConfiguration;
|
|
307
|
-
iotTwinMakerConfiguration?: IotTwinMakerSourceConfiguration;
|
|
305
|
+
s3Configuration?: S3SourceConfiguration | undefined;
|
|
306
|
+
iotSiteWiseConfiguration?: IotSiteWiseSourceConfiguration | undefined;
|
|
307
|
+
iotTwinMakerConfiguration?: IotTwinMakerSourceConfiguration | undefined;
|
|
308
308
|
}
|
|
309
309
|
export interface CreateMetadataTransferJobRequest {
|
|
310
|
-
metadataTransferJobId?: string;
|
|
311
|
-
description?: string;
|
|
310
|
+
metadataTransferJobId?: string | undefined;
|
|
311
|
+
description?: string | undefined;
|
|
312
312
|
sources: SourceConfiguration[] | undefined;
|
|
313
313
|
destination: DestinationConfiguration | undefined;
|
|
314
314
|
}
|
|
@@ -322,10 +322,10 @@ export interface CreateSceneRequest {
|
|
|
322
322
|
workspaceId: string | undefined;
|
|
323
323
|
sceneId: string | undefined;
|
|
324
324
|
contentLocation: string | undefined;
|
|
325
|
-
description?: string;
|
|
326
|
-
capabilities?: string[];
|
|
327
|
-
tags?: Record<string, string
|
|
328
|
-
sceneMetadata?: Record<string, string
|
|
325
|
+
description?: string | undefined;
|
|
326
|
+
capabilities?: string[] | undefined;
|
|
327
|
+
tags?: Record<string, string> | undefined;
|
|
328
|
+
sceneMetadata?: Record<string, string> | undefined;
|
|
329
329
|
}
|
|
330
330
|
export interface CreateSceneResponse {
|
|
331
331
|
arn: string | undefined;
|
|
@@ -335,7 +335,7 @@ export interface CreateSyncJobRequest {
|
|
|
335
335
|
workspaceId: string | undefined;
|
|
336
336
|
syncSource: string | undefined;
|
|
337
337
|
syncRole: string | undefined;
|
|
338
|
-
tags?: Record<string, string
|
|
338
|
+
tags?: Record<string, string> | undefined;
|
|
339
339
|
}
|
|
340
340
|
export declare const SyncJobState: {
|
|
341
341
|
readonly ACTIVE: "ACTIVE";
|
|
@@ -352,10 +352,10 @@ export interface CreateSyncJobResponse {
|
|
|
352
352
|
}
|
|
353
353
|
export interface CreateWorkspaceRequest {
|
|
354
354
|
workspaceId: string | undefined;
|
|
355
|
-
description?: string;
|
|
356
|
-
s3Location?: string;
|
|
357
|
-
role?: string;
|
|
358
|
-
tags?: Record<string, string
|
|
355
|
+
description?: string | undefined;
|
|
356
|
+
s3Location?: string | undefined;
|
|
357
|
+
role?: string | undefined;
|
|
358
|
+
tags?: Record<string, string> | undefined;
|
|
359
359
|
}
|
|
360
360
|
export interface CreateWorkspaceResponse {
|
|
361
361
|
arn: string | undefined;
|
|
@@ -371,7 +371,7 @@ export interface DeleteComponentTypeResponse {
|
|
|
371
371
|
export interface DeleteEntityRequest {
|
|
372
372
|
workspaceId: string | undefined;
|
|
373
373
|
entityId: string | undefined;
|
|
374
|
-
isRecursive?: boolean;
|
|
374
|
+
isRecursive?: boolean | undefined;
|
|
375
375
|
}
|
|
376
376
|
export interface DeleteEntityResponse {
|
|
377
377
|
state: State | undefined;
|
|
@@ -392,13 +392,13 @@ export interface DeleteWorkspaceRequest {
|
|
|
392
392
|
workspaceId: string | undefined;
|
|
393
393
|
}
|
|
394
394
|
export interface DeleteWorkspaceResponse {
|
|
395
|
-
message?: string;
|
|
395
|
+
message?: string | undefined;
|
|
396
396
|
}
|
|
397
397
|
export interface ExecuteQueryRequest {
|
|
398
398
|
workspaceId: string | undefined;
|
|
399
399
|
queryStatement: string | undefined;
|
|
400
|
-
maxResults?: number;
|
|
401
|
-
nextToken?: string;
|
|
400
|
+
maxResults?: number | undefined;
|
|
401
|
+
nextToken?: string | undefined;
|
|
402
402
|
}
|
|
403
403
|
export declare const ColumnType: {
|
|
404
404
|
readonly EDGE: "EDGE";
|
|
@@ -407,16 +407,16 @@ export declare const ColumnType: {
|
|
|
407
407
|
};
|
|
408
408
|
export type ColumnType = (typeof ColumnType)[keyof typeof ColumnType];
|
|
409
409
|
export interface ColumnDescription {
|
|
410
|
-
name?: string;
|
|
411
|
-
type?: ColumnType;
|
|
410
|
+
name?: string | undefined;
|
|
411
|
+
type?: ColumnType | undefined;
|
|
412
412
|
}
|
|
413
413
|
export interface Row {
|
|
414
|
-
rowData?: __DocumentType[];
|
|
414
|
+
rowData?: __DocumentType[] | undefined;
|
|
415
415
|
}
|
|
416
416
|
export interface ExecuteQueryResponse {
|
|
417
|
-
columnDescriptions?: ColumnDescription[];
|
|
418
|
-
rows?: Row[];
|
|
419
|
-
nextToken?: string;
|
|
417
|
+
columnDescriptions?: ColumnDescription[] | undefined;
|
|
418
|
+
rows?: Row[] | undefined;
|
|
419
|
+
nextToken?: string | undefined;
|
|
420
420
|
}
|
|
421
421
|
export declare class QueryTimeoutException extends __BaseException {
|
|
422
422
|
readonly name: "QueryTimeoutException";
|
|
@@ -431,14 +431,14 @@ export interface GetComponentTypeRequest {
|
|
|
431
431
|
componentTypeId: string | undefined;
|
|
432
432
|
}
|
|
433
433
|
export interface CompositeComponentTypeResponse {
|
|
434
|
-
componentTypeId?: string;
|
|
435
|
-
isInherited?: boolean;
|
|
434
|
+
componentTypeId?: string | undefined;
|
|
435
|
+
isInherited?: boolean | undefined;
|
|
436
436
|
}
|
|
437
437
|
export interface FunctionResponse {
|
|
438
|
-
requiredProperties?: string[];
|
|
439
|
-
scope?: Scope;
|
|
440
|
-
implementedBy?: DataConnector;
|
|
441
|
-
isInherited?: boolean;
|
|
438
|
+
requiredProperties?: string[] | undefined;
|
|
439
|
+
scope?: Scope | undefined;
|
|
440
|
+
implementedBy?: DataConnector | undefined;
|
|
441
|
+
isInherited?: boolean | undefined;
|
|
442
442
|
}
|
|
443
443
|
export interface PropertyGroupResponse {
|
|
444
444
|
groupType: GroupType | undefined;
|
|
@@ -446,8 +446,8 @@ export interface PropertyGroupResponse {
|
|
|
446
446
|
isInherited: boolean | undefined;
|
|
447
447
|
}
|
|
448
448
|
export interface Status {
|
|
449
|
-
state?: State;
|
|
450
|
-
error?: ErrorDetails;
|
|
449
|
+
state?: State | undefined;
|
|
450
|
+
error?: ErrorDetails | undefined;
|
|
451
451
|
}
|
|
452
452
|
export interface GetEntityRequest {
|
|
453
453
|
workspaceId: string | undefined;
|
|
@@ -461,12 +461,12 @@ export interface ComponentPropertyGroupResponse {
|
|
|
461
461
|
export interface ComponentSummary {
|
|
462
462
|
componentName: string | undefined;
|
|
463
463
|
componentTypeId: string | undefined;
|
|
464
|
-
definedIn?: string;
|
|
465
|
-
description?: string;
|
|
466
|
-
propertyGroups?: Record<string, ComponentPropertyGroupResponse
|
|
464
|
+
definedIn?: string | undefined;
|
|
465
|
+
description?: string | undefined;
|
|
466
|
+
propertyGroups?: Record<string, ComponentPropertyGroupResponse> | undefined;
|
|
467
467
|
status: Status | undefined;
|
|
468
|
-
syncSource?: string;
|
|
469
|
-
componentPath?: string;
|
|
468
|
+
syncSource?: string | undefined;
|
|
469
|
+
componentPath?: string | undefined;
|
|
470
470
|
}
|
|
471
471
|
export interface GetMetadataTransferJobRequest {
|
|
472
472
|
metadataTransferJobId: string | undefined;
|
|
@@ -474,15 +474,15 @@ export interface GetMetadataTransferJobRequest {
|
|
|
474
474
|
export interface GetMetadataTransferJobResponse {
|
|
475
475
|
metadataTransferJobId: string | undefined;
|
|
476
476
|
arn: string | undefined;
|
|
477
|
-
description?: string;
|
|
477
|
+
description?: string | undefined;
|
|
478
478
|
sources: SourceConfiguration[] | undefined;
|
|
479
479
|
destination: DestinationConfiguration | undefined;
|
|
480
480
|
metadataTransferJobRole: string | undefined;
|
|
481
|
-
reportUrl?: string;
|
|
481
|
+
reportUrl?: string | undefined;
|
|
482
482
|
creationDateTime: Date | undefined;
|
|
483
483
|
updateDateTime: Date | undefined;
|
|
484
484
|
status: MetadataTransferJobStatus | undefined;
|
|
485
|
-
progress?: MetadataTransferJobProgress;
|
|
485
|
+
progress?: MetadataTransferJobProgress | undefined;
|
|
486
486
|
}
|
|
487
487
|
export interface GetPricingPlanRequest {}
|
|
488
488
|
export declare const PricingTier: {
|
|
@@ -494,7 +494,7 @@ export declare const PricingTier: {
|
|
|
494
494
|
export type PricingTier = (typeof PricingTier)[keyof typeof PricingTier];
|
|
495
495
|
export interface BundleInformation {
|
|
496
496
|
bundleNames: string[] | undefined;
|
|
497
|
-
pricingTier?: PricingTier;
|
|
497
|
+
pricingTier?: PricingTier | undefined;
|
|
498
498
|
}
|
|
499
499
|
export declare const PricingMode: {
|
|
500
500
|
readonly BASIC: "BASIC";
|
|
@@ -511,8 +511,8 @@ export declare const UpdateReason: {
|
|
|
511
511
|
};
|
|
512
512
|
export type UpdateReason = (typeof UpdateReason)[keyof typeof UpdateReason];
|
|
513
513
|
export interface PricingPlan {
|
|
514
|
-
billableEntityCount?: number;
|
|
515
|
-
bundleInformation?: BundleInformation;
|
|
514
|
+
billableEntityCount?: number | undefined;
|
|
515
|
+
bundleInformation?: BundleInformation | undefined;
|
|
516
516
|
effectiveDateTime: Date | undefined;
|
|
517
517
|
pricingMode: PricingMode | undefined;
|
|
518
518
|
updateDateTime: Date | undefined;
|
|
@@ -520,7 +520,7 @@ export interface PricingPlan {
|
|
|
520
520
|
}
|
|
521
521
|
export interface GetPricingPlanResponse {
|
|
522
522
|
currentPricingPlan: PricingPlan | undefined;
|
|
523
|
-
pendingPricingPlan?: PricingPlan;
|
|
523
|
+
pendingPricingPlan?: PricingPlan | undefined;
|
|
524
524
|
}
|
|
525
525
|
export declare class ConnectorFailureException extends __BaseException {
|
|
526
526
|
readonly name: "ConnectorFailureException";
|
|
@@ -542,7 +542,7 @@ export declare const Order: {
|
|
|
542
542
|
};
|
|
543
543
|
export type Order = (typeof Order)[keyof typeof Order];
|
|
544
544
|
export interface OrderBy {
|
|
545
|
-
order?: Order;
|
|
545
|
+
order?: Order | undefined;
|
|
546
546
|
propertyName: string | undefined;
|
|
547
547
|
}
|
|
548
548
|
export declare const InterpolationType: {
|
|
@@ -551,8 +551,8 @@ export declare const InterpolationType: {
|
|
|
551
551
|
export type InterpolationType =
|
|
552
552
|
(typeof InterpolationType)[keyof typeof InterpolationType];
|
|
553
553
|
export interface InterpolationParameters {
|
|
554
|
-
interpolationType?: InterpolationType;
|
|
555
|
-
intervalInSeconds?: number;
|
|
554
|
+
interpolationType?: InterpolationType | undefined;
|
|
555
|
+
intervalInSeconds?: number | undefined;
|
|
556
556
|
}
|
|
557
557
|
export declare const OrderByTime: {
|
|
558
558
|
readonly ASCENDING: "ASCENDING";
|
|
@@ -569,8 +569,8 @@ export declare const SceneErrorCode: {
|
|
|
569
569
|
export type SceneErrorCode =
|
|
570
570
|
(typeof SceneErrorCode)[keyof typeof SceneErrorCode];
|
|
571
571
|
export interface SceneError {
|
|
572
|
-
code?: SceneErrorCode;
|
|
573
|
-
message?: string;
|
|
572
|
+
code?: SceneErrorCode | undefined;
|
|
573
|
+
message?: string | undefined;
|
|
574
574
|
}
|
|
575
575
|
export interface GetSceneResponse {
|
|
576
576
|
workspaceId: string | undefined;
|
|
@@ -579,19 +579,19 @@ export interface GetSceneResponse {
|
|
|
579
579
|
arn: string | undefined;
|
|
580
580
|
creationDateTime: Date | undefined;
|
|
581
581
|
updateDateTime: Date | undefined;
|
|
582
|
-
description?: string;
|
|
583
|
-
capabilities?: string[];
|
|
584
|
-
sceneMetadata?: Record<string, string
|
|
585
|
-
generatedSceneMetadata?: Record<string, string
|
|
586
|
-
error?: SceneError;
|
|
582
|
+
description?: string | undefined;
|
|
583
|
+
capabilities?: string[] | undefined;
|
|
584
|
+
sceneMetadata?: Record<string, string> | undefined;
|
|
585
|
+
generatedSceneMetadata?: Record<string, string> | undefined;
|
|
586
|
+
error?: SceneError | undefined;
|
|
587
587
|
}
|
|
588
588
|
export interface GetSyncJobRequest {
|
|
589
589
|
syncSource: string | undefined;
|
|
590
|
-
workspaceId?: string;
|
|
590
|
+
workspaceId?: string | undefined;
|
|
591
591
|
}
|
|
592
592
|
export interface SyncJobStatus {
|
|
593
|
-
state?: SyncJobState;
|
|
594
|
-
error?: ErrorDetails;
|
|
593
|
+
state?: SyncJobState | undefined;
|
|
594
|
+
error?: ErrorDetails | undefined;
|
|
595
595
|
}
|
|
596
596
|
export interface GetSyncJobResponse {
|
|
597
597
|
arn: string | undefined;
|
|
@@ -608,23 +608,23 @@ export interface GetWorkspaceRequest {
|
|
|
608
608
|
export interface GetWorkspaceResponse {
|
|
609
609
|
workspaceId: string | undefined;
|
|
610
610
|
arn: string | undefined;
|
|
611
|
-
description?: string;
|
|
612
|
-
linkedServices?: string[];
|
|
613
|
-
s3Location?: string;
|
|
614
|
-
role?: string;
|
|
611
|
+
description?: string | undefined;
|
|
612
|
+
linkedServices?: string[] | undefined;
|
|
613
|
+
s3Location?: string | undefined;
|
|
614
|
+
role?: string | undefined;
|
|
615
615
|
creationDateTime: Date | undefined;
|
|
616
616
|
updateDateTime: Date | undefined;
|
|
617
617
|
}
|
|
618
618
|
export interface ListComponentsRequest {
|
|
619
619
|
workspaceId: string | undefined;
|
|
620
620
|
entityId: string | undefined;
|
|
621
|
-
componentPath?: string;
|
|
622
|
-
maxResults?: number;
|
|
623
|
-
nextToken?: string;
|
|
621
|
+
componentPath?: string | undefined;
|
|
622
|
+
maxResults?: number | undefined;
|
|
623
|
+
nextToken?: string | undefined;
|
|
624
624
|
}
|
|
625
625
|
export interface ListComponentsResponse {
|
|
626
626
|
componentSummaries: ComponentSummary[] | undefined;
|
|
627
|
-
nextToken?: string;
|
|
627
|
+
nextToken?: string | undefined;
|
|
628
628
|
}
|
|
629
629
|
export type ListComponentTypesFilter =
|
|
630
630
|
| ListComponentTypesFilter.ExtendsFromMember
|
|
@@ -666,24 +666,24 @@ export declare namespace ListComponentTypesFilter {
|
|
|
666
666
|
}
|
|
667
667
|
export interface ListComponentTypesRequest {
|
|
668
668
|
workspaceId: string | undefined;
|
|
669
|
-
filters?: ListComponentTypesFilter[];
|
|
670
|
-
nextToken?: string;
|
|
671
|
-
maxResults?: number;
|
|
669
|
+
filters?: ListComponentTypesFilter[] | undefined;
|
|
670
|
+
nextToken?: string | undefined;
|
|
671
|
+
maxResults?: number | undefined;
|
|
672
672
|
}
|
|
673
673
|
export interface ComponentTypeSummary {
|
|
674
674
|
arn: string | undefined;
|
|
675
675
|
componentTypeId: string | undefined;
|
|
676
676
|
creationDateTime: Date | undefined;
|
|
677
677
|
updateDateTime: Date | undefined;
|
|
678
|
-
description?: string;
|
|
679
|
-
status?: Status;
|
|
680
|
-
componentTypeName?: string;
|
|
678
|
+
description?: string | undefined;
|
|
679
|
+
status?: Status | undefined;
|
|
680
|
+
componentTypeName?: string | undefined;
|
|
681
681
|
}
|
|
682
682
|
export interface ListComponentTypesResponse {
|
|
683
683
|
workspaceId: string | undefined;
|
|
684
684
|
componentTypeSummaries: ComponentTypeSummary[] | undefined;
|
|
685
|
-
nextToken?: string;
|
|
686
|
-
maxResults?: number;
|
|
685
|
+
nextToken?: string | undefined;
|
|
686
|
+
maxResults?: number | undefined;
|
|
687
687
|
}
|
|
688
688
|
export type ListEntitiesFilter =
|
|
689
689
|
| ListEntitiesFilter.ComponentTypeIdMember
|
|
@@ -725,24 +725,24 @@ export declare namespace ListEntitiesFilter {
|
|
|
725
725
|
}
|
|
726
726
|
export interface ListEntitiesRequest {
|
|
727
727
|
workspaceId: string | undefined;
|
|
728
|
-
filters?: ListEntitiesFilter[];
|
|
729
|
-
maxResults?: number;
|
|
730
|
-
nextToken?: string;
|
|
728
|
+
filters?: ListEntitiesFilter[] | undefined;
|
|
729
|
+
maxResults?: number | undefined;
|
|
730
|
+
nextToken?: string | undefined;
|
|
731
731
|
}
|
|
732
732
|
export interface EntitySummary {
|
|
733
733
|
entityId: string | undefined;
|
|
734
734
|
entityName: string | undefined;
|
|
735
735
|
arn: string | undefined;
|
|
736
|
-
parentEntityId?: string;
|
|
736
|
+
parentEntityId?: string | undefined;
|
|
737
737
|
status: Status | undefined;
|
|
738
|
-
description?: string;
|
|
739
|
-
hasChildEntities?: boolean;
|
|
738
|
+
description?: string | undefined;
|
|
739
|
+
hasChildEntities?: boolean | undefined;
|
|
740
740
|
creationDateTime: Date | undefined;
|
|
741
741
|
updateDateTime: Date | undefined;
|
|
742
742
|
}
|
|
743
743
|
export interface ListEntitiesResponse {
|
|
744
|
-
entitySummaries?: EntitySummary[];
|
|
745
|
-
nextToken?: string;
|
|
744
|
+
entitySummaries?: EntitySummary[] | undefined;
|
|
745
|
+
nextToken?: string | undefined;
|
|
746
746
|
}
|
|
747
747
|
export type ListMetadataTransferJobsFilter =
|
|
748
748
|
| ListMetadataTransferJobsFilter.StateMember
|
|
@@ -777,9 +777,9 @@ export declare namespace ListMetadataTransferJobsFilter {
|
|
|
777
777
|
export interface ListMetadataTransferJobsRequest {
|
|
778
778
|
sourceType: SourceType | undefined;
|
|
779
779
|
destinationType: DestinationType | undefined;
|
|
780
|
-
filters?: ListMetadataTransferJobsFilter[];
|
|
781
|
-
nextToken?: string;
|
|
782
|
-
maxResults?: number;
|
|
780
|
+
filters?: ListMetadataTransferJobsFilter[] | undefined;
|
|
781
|
+
nextToken?: string | undefined;
|
|
782
|
+
maxResults?: number | undefined;
|
|
783
783
|
}
|
|
784
784
|
export interface MetadataTransferJobSummary {
|
|
785
785
|
metadataTransferJobId: string | undefined;
|
|
@@ -787,24 +787,24 @@ export interface MetadataTransferJobSummary {
|
|
|
787
787
|
creationDateTime: Date | undefined;
|
|
788
788
|
updateDateTime: Date | undefined;
|
|
789
789
|
status: MetadataTransferJobStatus | undefined;
|
|
790
|
-
progress?: MetadataTransferJobProgress;
|
|
790
|
+
progress?: MetadataTransferJobProgress | undefined;
|
|
791
791
|
}
|
|
792
792
|
export interface ListMetadataTransferJobsResponse {
|
|
793
793
|
metadataTransferJobSummaries: MetadataTransferJobSummary[] | undefined;
|
|
794
|
-
nextToken?: string;
|
|
794
|
+
nextToken?: string | undefined;
|
|
795
795
|
}
|
|
796
796
|
export interface ListPropertiesRequest {
|
|
797
797
|
workspaceId: string | undefined;
|
|
798
|
-
componentName?: string;
|
|
799
|
-
componentPath?: string;
|
|
798
|
+
componentName?: string | undefined;
|
|
799
|
+
componentPath?: string | undefined;
|
|
800
800
|
entityId: string | undefined;
|
|
801
|
-
maxResults?: number;
|
|
802
|
-
nextToken?: string;
|
|
801
|
+
maxResults?: number | undefined;
|
|
802
|
+
nextToken?: string | undefined;
|
|
803
803
|
}
|
|
804
804
|
export interface ListScenesRequest {
|
|
805
805
|
workspaceId: string | undefined;
|
|
806
|
-
maxResults?: number;
|
|
807
|
-
nextToken?: string;
|
|
806
|
+
maxResults?: number | undefined;
|
|
807
|
+
nextToken?: string | undefined;
|
|
808
808
|
}
|
|
809
809
|
export interface SceneSummary {
|
|
810
810
|
sceneId: string | undefined;
|
|
@@ -812,28 +812,28 @@ export interface SceneSummary {
|
|
|
812
812
|
arn: string | undefined;
|
|
813
813
|
creationDateTime: Date | undefined;
|
|
814
814
|
updateDateTime: Date | undefined;
|
|
815
|
-
description?: string;
|
|
815
|
+
description?: string | undefined;
|
|
816
816
|
}
|
|
817
817
|
export interface ListScenesResponse {
|
|
818
|
-
sceneSummaries?: SceneSummary[];
|
|
819
|
-
nextToken?: string;
|
|
818
|
+
sceneSummaries?: SceneSummary[] | undefined;
|
|
819
|
+
nextToken?: string | undefined;
|
|
820
820
|
}
|
|
821
821
|
export interface ListSyncJobsRequest {
|
|
822
822
|
workspaceId: string | undefined;
|
|
823
|
-
maxResults?: number;
|
|
824
|
-
nextToken?: string;
|
|
823
|
+
maxResults?: number | undefined;
|
|
824
|
+
nextToken?: string | undefined;
|
|
825
825
|
}
|
|
826
826
|
export interface SyncJobSummary {
|
|
827
|
-
arn?: string;
|
|
828
|
-
workspaceId?: string;
|
|
829
|
-
syncSource?: string;
|
|
830
|
-
status?: SyncJobStatus;
|
|
831
|
-
creationDateTime?: Date;
|
|
832
|
-
updateDateTime?: Date;
|
|
827
|
+
arn?: string | undefined;
|
|
828
|
+
workspaceId?: string | undefined;
|
|
829
|
+
syncSource?: string | undefined;
|
|
830
|
+
status?: SyncJobStatus | undefined;
|
|
831
|
+
creationDateTime?: Date | undefined;
|
|
832
|
+
updateDateTime?: Date | undefined;
|
|
833
833
|
}
|
|
834
834
|
export interface ListSyncJobsResponse {
|
|
835
|
-
syncJobSummaries?: SyncJobSummary[];
|
|
836
|
-
nextToken?: string;
|
|
835
|
+
syncJobSummaries?: SyncJobSummary[] | undefined;
|
|
836
|
+
nextToken?: string | undefined;
|
|
837
837
|
}
|
|
838
838
|
export declare const SyncResourceType: {
|
|
839
839
|
readonly COMPONENT_TYPE: "COMPONENT_TYPE";
|
|
@@ -904,49 +904,49 @@ export declare namespace SyncResourceFilter {
|
|
|
904
904
|
export interface ListSyncResourcesRequest {
|
|
905
905
|
workspaceId: string | undefined;
|
|
906
906
|
syncSource: string | undefined;
|
|
907
|
-
filters?: SyncResourceFilter[];
|
|
908
|
-
maxResults?: number;
|
|
909
|
-
nextToken?: string;
|
|
907
|
+
filters?: SyncResourceFilter[] | undefined;
|
|
908
|
+
maxResults?: number | undefined;
|
|
909
|
+
nextToken?: string | undefined;
|
|
910
910
|
}
|
|
911
911
|
export interface SyncResourceStatus {
|
|
912
|
-
state?: SyncResourceState;
|
|
913
|
-
error?: ErrorDetails;
|
|
912
|
+
state?: SyncResourceState | undefined;
|
|
913
|
+
error?: ErrorDetails | undefined;
|
|
914
914
|
}
|
|
915
915
|
export interface SyncResourceSummary {
|
|
916
|
-
resourceType?: SyncResourceType;
|
|
917
|
-
externalId?: string;
|
|
918
|
-
resourceId?: string;
|
|
919
|
-
status?: SyncResourceStatus;
|
|
920
|
-
updateDateTime?: Date;
|
|
916
|
+
resourceType?: SyncResourceType | undefined;
|
|
917
|
+
externalId?: string | undefined;
|
|
918
|
+
resourceId?: string | undefined;
|
|
919
|
+
status?: SyncResourceStatus | undefined;
|
|
920
|
+
updateDateTime?: Date | undefined;
|
|
921
921
|
}
|
|
922
922
|
export interface ListSyncResourcesResponse {
|
|
923
|
-
syncResources?: SyncResourceSummary[];
|
|
924
|
-
nextToken?: string;
|
|
923
|
+
syncResources?: SyncResourceSummary[] | undefined;
|
|
924
|
+
nextToken?: string | undefined;
|
|
925
925
|
}
|
|
926
926
|
export interface ListTagsForResourceRequest {
|
|
927
927
|
resourceARN: string | undefined;
|
|
928
|
-
maxResults?: number;
|
|
929
|
-
nextToken?: string;
|
|
928
|
+
maxResults?: number | undefined;
|
|
929
|
+
nextToken?: string | undefined;
|
|
930
930
|
}
|
|
931
931
|
export interface ListTagsForResourceResponse {
|
|
932
|
-
tags?: Record<string, string
|
|
933
|
-
nextToken?: string;
|
|
932
|
+
tags?: Record<string, string> | undefined;
|
|
933
|
+
nextToken?: string | undefined;
|
|
934
934
|
}
|
|
935
935
|
export interface ListWorkspacesRequest {
|
|
936
|
-
maxResults?: number;
|
|
937
|
-
nextToken?: string;
|
|
936
|
+
maxResults?: number | undefined;
|
|
937
|
+
nextToken?: string | undefined;
|
|
938
938
|
}
|
|
939
939
|
export interface WorkspaceSummary {
|
|
940
940
|
workspaceId: string | undefined;
|
|
941
941
|
arn: string | undefined;
|
|
942
|
-
description?: string;
|
|
943
|
-
linkedServices?: string[];
|
|
942
|
+
description?: string | undefined;
|
|
943
|
+
linkedServices?: string[] | undefined;
|
|
944
944
|
creationDateTime: Date | undefined;
|
|
945
945
|
updateDateTime: Date | undefined;
|
|
946
946
|
}
|
|
947
947
|
export interface ListWorkspacesResponse {
|
|
948
|
-
workspaceSummaries?: WorkspaceSummary[];
|
|
949
|
-
nextToken?: string;
|
|
948
|
+
workspaceSummaries?: WorkspaceSummary[] | undefined;
|
|
949
|
+
nextToken?: string | undefined;
|
|
950
950
|
}
|
|
951
951
|
export interface TagResourceRequest {
|
|
952
952
|
resourceARN: string | undefined;
|
|
@@ -986,7 +986,7 @@ export type ParentEntityUpdateType =
|
|
|
986
986
|
(typeof ParentEntityUpdateType)[keyof typeof ParentEntityUpdateType];
|
|
987
987
|
export interface ParentEntityUpdateRequest {
|
|
988
988
|
updateType: ParentEntityUpdateType | undefined;
|
|
989
|
-
parentEntityId?: string;
|
|
989
|
+
parentEntityId?: string | undefined;
|
|
990
990
|
}
|
|
991
991
|
export interface UpdateEntityResponse {
|
|
992
992
|
updateDateTime: Date | undefined;
|
|
@@ -994,92 +994,92 @@ export interface UpdateEntityResponse {
|
|
|
994
994
|
}
|
|
995
995
|
export interface UpdatePricingPlanRequest {
|
|
996
996
|
pricingMode: PricingMode | undefined;
|
|
997
|
-
bundleNames?: string[];
|
|
997
|
+
bundleNames?: string[] | undefined;
|
|
998
998
|
}
|
|
999
999
|
export interface UpdatePricingPlanResponse {
|
|
1000
1000
|
currentPricingPlan: PricingPlan | undefined;
|
|
1001
|
-
pendingPricingPlan?: PricingPlan;
|
|
1001
|
+
pendingPricingPlan?: PricingPlan | undefined;
|
|
1002
1002
|
}
|
|
1003
1003
|
export interface UpdateSceneRequest {
|
|
1004
1004
|
workspaceId: string | undefined;
|
|
1005
1005
|
sceneId: string | undefined;
|
|
1006
|
-
contentLocation?: string;
|
|
1007
|
-
description?: string;
|
|
1008
|
-
capabilities?: string[];
|
|
1009
|
-
sceneMetadata?: Record<string, string
|
|
1006
|
+
contentLocation?: string | undefined;
|
|
1007
|
+
description?: string | undefined;
|
|
1008
|
+
capabilities?: string[] | undefined;
|
|
1009
|
+
sceneMetadata?: Record<string, string> | undefined;
|
|
1010
1010
|
}
|
|
1011
1011
|
export interface UpdateSceneResponse {
|
|
1012
1012
|
updateDateTime: Date | undefined;
|
|
1013
1013
|
}
|
|
1014
1014
|
export interface UpdateWorkspaceRequest {
|
|
1015
1015
|
workspaceId: string | undefined;
|
|
1016
|
-
description?: string;
|
|
1017
|
-
role?: string;
|
|
1018
|
-
s3Location?: string;
|
|
1016
|
+
description?: string | undefined;
|
|
1017
|
+
role?: string | undefined;
|
|
1018
|
+
s3Location?: string | undefined;
|
|
1019
1019
|
}
|
|
1020
1020
|
export interface UpdateWorkspaceResponse {
|
|
1021
1021
|
updateDateTime: Date | undefined;
|
|
1022
1022
|
}
|
|
1023
1023
|
export interface DataValue {
|
|
1024
|
-
booleanValue?: boolean;
|
|
1025
|
-
doubleValue?: number;
|
|
1026
|
-
integerValue?: number;
|
|
1027
|
-
longValue?: number;
|
|
1028
|
-
stringValue?: string;
|
|
1029
|
-
listValue?: DataValue[];
|
|
1030
|
-
mapValue?: Record<string, DataValue
|
|
1031
|
-
relationshipValue?: RelationshipValue;
|
|
1032
|
-
expression?: string;
|
|
1024
|
+
booleanValue?: boolean | undefined;
|
|
1025
|
+
doubleValue?: number | undefined;
|
|
1026
|
+
integerValue?: number | undefined;
|
|
1027
|
+
longValue?: number | undefined;
|
|
1028
|
+
stringValue?: string | undefined;
|
|
1029
|
+
listValue?: DataValue[] | undefined;
|
|
1030
|
+
mapValue?: Record<string, DataValue> | undefined;
|
|
1031
|
+
relationshipValue?: RelationshipValue | undefined;
|
|
1032
|
+
expression?: string | undefined;
|
|
1033
1033
|
}
|
|
1034
1034
|
export interface PropertyFilter {
|
|
1035
|
-
propertyName?: string;
|
|
1036
|
-
operator?: string;
|
|
1037
|
-
value?: DataValue;
|
|
1035
|
+
propertyName?: string | undefined;
|
|
1036
|
+
operator?: string | undefined;
|
|
1037
|
+
value?: DataValue | undefined;
|
|
1038
1038
|
}
|
|
1039
1039
|
export interface PropertyLatestValue {
|
|
1040
1040
|
propertyReference: EntityPropertyReference | undefined;
|
|
1041
|
-
propertyValue?: DataValue;
|
|
1041
|
+
propertyValue?: DataValue | undefined;
|
|
1042
1042
|
}
|
|
1043
1043
|
export interface PropertyValue {
|
|
1044
|
-
timestamp?: Date;
|
|
1044
|
+
timestamp?: Date | undefined;
|
|
1045
1045
|
value: DataValue | undefined;
|
|
1046
|
-
time?: string;
|
|
1046
|
+
time?: string | undefined;
|
|
1047
1047
|
}
|
|
1048
1048
|
export interface DataType {
|
|
1049
1049
|
type: Type | undefined;
|
|
1050
|
-
nestedType?: DataType;
|
|
1051
|
-
allowedValues?: DataValue[];
|
|
1052
|
-
unitOfMeasure?: string;
|
|
1053
|
-
relationship?: Relationship;
|
|
1050
|
+
nestedType?: DataType | undefined;
|
|
1051
|
+
allowedValues?: DataValue[] | undefined;
|
|
1052
|
+
unitOfMeasure?: string | undefined;
|
|
1053
|
+
relationship?: Relationship | undefined;
|
|
1054
1054
|
}
|
|
1055
1055
|
export interface GetPropertyValueHistoryRequest {
|
|
1056
1056
|
workspaceId: string | undefined;
|
|
1057
|
-
entityId?: string;
|
|
1058
|
-
componentName?: string;
|
|
1059
|
-
componentPath?: string;
|
|
1060
|
-
componentTypeId?: string;
|
|
1057
|
+
entityId?: string | undefined;
|
|
1058
|
+
componentName?: string | undefined;
|
|
1059
|
+
componentPath?: string | undefined;
|
|
1060
|
+
componentTypeId?: string | undefined;
|
|
1061
1061
|
selectedProperties: string[] | undefined;
|
|
1062
|
-
propertyFilters?: PropertyFilter[];
|
|
1063
|
-
startDateTime?: Date;
|
|
1064
|
-
endDateTime?: Date;
|
|
1065
|
-
interpolation?: InterpolationParameters;
|
|
1066
|
-
nextToken?: string;
|
|
1067
|
-
maxResults?: number;
|
|
1068
|
-
orderByTime?: OrderByTime;
|
|
1069
|
-
startTime?: string;
|
|
1070
|
-
endTime?: string;
|
|
1062
|
+
propertyFilters?: PropertyFilter[] | undefined;
|
|
1063
|
+
startDateTime?: Date | undefined;
|
|
1064
|
+
endDateTime?: Date | undefined;
|
|
1065
|
+
interpolation?: InterpolationParameters | undefined;
|
|
1066
|
+
nextToken?: string | undefined;
|
|
1067
|
+
maxResults?: number | undefined;
|
|
1068
|
+
orderByTime?: OrderByTime | undefined;
|
|
1069
|
+
startTime?: string | undefined;
|
|
1070
|
+
endTime?: string | undefined;
|
|
1071
1071
|
}
|
|
1072
1072
|
export interface PropertyValueEntry {
|
|
1073
1073
|
entityPropertyReference: EntityPropertyReference | undefined;
|
|
1074
|
-
propertyValues?: PropertyValue[];
|
|
1074
|
+
propertyValues?: PropertyValue[] | undefined;
|
|
1075
1075
|
}
|
|
1076
1076
|
export interface PropertyValueHistory {
|
|
1077
1077
|
entityPropertyReference: EntityPropertyReference | undefined;
|
|
1078
|
-
values?: PropertyValue[];
|
|
1078
|
+
values?: PropertyValue[] | undefined;
|
|
1079
1079
|
}
|
|
1080
1080
|
export interface TabularConditions {
|
|
1081
|
-
orderBy?: OrderBy[];
|
|
1082
|
-
propertyFilters?: PropertyFilter[];
|
|
1081
|
+
orderBy?: OrderBy[] | undefined;
|
|
1082
|
+
propertyFilters?: PropertyFilter[] | undefined;
|
|
1083
1083
|
}
|
|
1084
1084
|
export interface BatchPutPropertyError {
|
|
1085
1085
|
errorCode: string | undefined;
|
|
@@ -1087,16 +1087,16 @@ export interface BatchPutPropertyError {
|
|
|
1087
1087
|
entry: PropertyValueEntry | undefined;
|
|
1088
1088
|
}
|
|
1089
1089
|
export interface GetPropertyValueRequest {
|
|
1090
|
-
componentName?: string;
|
|
1091
|
-
componentPath?: string;
|
|
1092
|
-
componentTypeId?: string;
|
|
1093
|
-
entityId?: string;
|
|
1090
|
+
componentName?: string | undefined;
|
|
1091
|
+
componentPath?: string | undefined;
|
|
1092
|
+
componentTypeId?: string | undefined;
|
|
1093
|
+
entityId?: string | undefined;
|
|
1094
1094
|
selectedProperties: string[] | undefined;
|
|
1095
1095
|
workspaceId: string | undefined;
|
|
1096
|
-
maxResults?: number;
|
|
1097
|
-
nextToken?: string;
|
|
1098
|
-
propertyGroupName?: string;
|
|
1099
|
-
tabularConditions?: TabularConditions;
|
|
1096
|
+
maxResults?: number | undefined;
|
|
1097
|
+
nextToken?: string | undefined;
|
|
1098
|
+
propertyGroupName?: string | undefined;
|
|
1099
|
+
tabularConditions?: TabularConditions | undefined;
|
|
1100
1100
|
}
|
|
1101
1101
|
export interface BatchPutPropertyValuesRequest {
|
|
1102
1102
|
workspaceId: string | undefined;
|
|
@@ -1104,20 +1104,20 @@ export interface BatchPutPropertyValuesRequest {
|
|
|
1104
1104
|
}
|
|
1105
1105
|
export interface GetPropertyValueHistoryResponse {
|
|
1106
1106
|
propertyValues: PropertyValueHistory[] | undefined;
|
|
1107
|
-
nextToken?: string;
|
|
1107
|
+
nextToken?: string | undefined;
|
|
1108
1108
|
}
|
|
1109
1109
|
export interface BatchPutPropertyErrorEntry {
|
|
1110
1110
|
errors: BatchPutPropertyError[] | undefined;
|
|
1111
1111
|
}
|
|
1112
1112
|
export interface PropertyDefinitionRequest {
|
|
1113
|
-
dataType?: DataType;
|
|
1114
|
-
isRequiredInEntity?: boolean;
|
|
1115
|
-
isExternalId?: boolean;
|
|
1116
|
-
isStoredExternally?: boolean;
|
|
1117
|
-
isTimeSeries?: boolean;
|
|
1118
|
-
defaultValue?: DataValue;
|
|
1119
|
-
configuration?: Record<string, string
|
|
1120
|
-
displayName?: string;
|
|
1113
|
+
dataType?: DataType | undefined;
|
|
1114
|
+
isRequiredInEntity?: boolean | undefined;
|
|
1115
|
+
isExternalId?: boolean | undefined;
|
|
1116
|
+
isStoredExternally?: boolean | undefined;
|
|
1117
|
+
isTimeSeries?: boolean | undefined;
|
|
1118
|
+
defaultValue?: DataValue | undefined;
|
|
1119
|
+
configuration?: Record<string, string> | undefined;
|
|
1120
|
+
displayName?: string | undefined;
|
|
1121
1121
|
}
|
|
1122
1122
|
export interface PropertyDefinitionResponse {
|
|
1123
1123
|
dataType: DataType | undefined;
|
|
@@ -1128,118 +1128,128 @@ export interface PropertyDefinitionResponse {
|
|
|
1128
1128
|
isImported: boolean | undefined;
|
|
1129
1129
|
isFinal: boolean | undefined;
|
|
1130
1130
|
isInherited: boolean | undefined;
|
|
1131
|
-
defaultValue?: DataValue;
|
|
1132
|
-
configuration?: Record<string, string
|
|
1133
|
-
displayName?: string;
|
|
1131
|
+
defaultValue?: DataValue | undefined;
|
|
1132
|
+
configuration?: Record<string, string> | undefined;
|
|
1133
|
+
displayName?: string | undefined;
|
|
1134
1134
|
}
|
|
1135
1135
|
export interface BatchPutPropertyValuesResponse {
|
|
1136
1136
|
errorEntries: BatchPutPropertyErrorEntry[] | undefined;
|
|
1137
1137
|
}
|
|
1138
1138
|
export interface GetPropertyValueResponse {
|
|
1139
|
-
propertyValues?: Record<string, PropertyLatestValue
|
|
1140
|
-
nextToken?: string;
|
|
1141
|
-
tabularPropertyValues?: Record<string, DataValue>[][];
|
|
1139
|
+
propertyValues?: Record<string, PropertyLatestValue> | undefined;
|
|
1140
|
+
nextToken?: string | undefined;
|
|
1141
|
+
tabularPropertyValues?: Record<string, DataValue>[][] | undefined;
|
|
1142
1142
|
}
|
|
1143
1143
|
export interface CreateComponentTypeRequest {
|
|
1144
1144
|
workspaceId: string | undefined;
|
|
1145
|
-
isSingleton?: boolean;
|
|
1145
|
+
isSingleton?: boolean | undefined;
|
|
1146
1146
|
componentTypeId: string | undefined;
|
|
1147
|
-
description?: string;
|
|
1148
|
-
propertyDefinitions?: Record<string, PropertyDefinitionRequest
|
|
1149
|
-
extendsFrom?: string[];
|
|
1150
|
-
functions?: Record<string, FunctionRequest
|
|
1151
|
-
tags?: Record<string, string
|
|
1152
|
-
propertyGroups?: Record<string, PropertyGroupRequest
|
|
1153
|
-
componentTypeName?: string;
|
|
1154
|
-
compositeComponentTypes?:
|
|
1147
|
+
description?: string | undefined;
|
|
1148
|
+
propertyDefinitions?: Record<string, PropertyDefinitionRequest> | undefined;
|
|
1149
|
+
extendsFrom?: string[] | undefined;
|
|
1150
|
+
functions?: Record<string, FunctionRequest> | undefined;
|
|
1151
|
+
tags?: Record<string, string> | undefined;
|
|
1152
|
+
propertyGroups?: Record<string, PropertyGroupRequest> | undefined;
|
|
1153
|
+
componentTypeName?: string | undefined;
|
|
1154
|
+
compositeComponentTypes?:
|
|
1155
|
+
| Record<string, CompositeComponentTypeRequest>
|
|
1156
|
+
| undefined;
|
|
1155
1157
|
}
|
|
1156
1158
|
export interface GetComponentTypeResponse {
|
|
1157
1159
|
workspaceId: string | undefined;
|
|
1158
|
-
isSingleton?: boolean;
|
|
1160
|
+
isSingleton?: boolean | undefined;
|
|
1159
1161
|
componentTypeId: string | undefined;
|
|
1160
|
-
description?: string;
|
|
1161
|
-
propertyDefinitions?: Record<string, PropertyDefinitionResponse
|
|
1162
|
-
extendsFrom?: string[];
|
|
1163
|
-
functions?: Record<string, FunctionResponse
|
|
1162
|
+
description?: string | undefined;
|
|
1163
|
+
propertyDefinitions?: Record<string, PropertyDefinitionResponse> | undefined;
|
|
1164
|
+
extendsFrom?: string[] | undefined;
|
|
1165
|
+
functions?: Record<string, FunctionResponse> | undefined;
|
|
1164
1166
|
creationDateTime: Date | undefined;
|
|
1165
1167
|
updateDateTime: Date | undefined;
|
|
1166
1168
|
arn: string | undefined;
|
|
1167
|
-
isAbstract?: boolean;
|
|
1168
|
-
isSchemaInitialized?: boolean;
|
|
1169
|
-
status?: Status;
|
|
1170
|
-
propertyGroups?: Record<string, PropertyGroupResponse
|
|
1171
|
-
syncSource?: string;
|
|
1172
|
-
componentTypeName?: string;
|
|
1173
|
-
compositeComponentTypes?:
|
|
1169
|
+
isAbstract?: boolean | undefined;
|
|
1170
|
+
isSchemaInitialized?: boolean | undefined;
|
|
1171
|
+
status?: Status | undefined;
|
|
1172
|
+
propertyGroups?: Record<string, PropertyGroupResponse> | undefined;
|
|
1173
|
+
syncSource?: string | undefined;
|
|
1174
|
+
componentTypeName?: string | undefined;
|
|
1175
|
+
compositeComponentTypes?:
|
|
1176
|
+
| Record<string, CompositeComponentTypeResponse>
|
|
1177
|
+
| undefined;
|
|
1174
1178
|
}
|
|
1175
1179
|
export interface UpdateComponentTypeRequest {
|
|
1176
1180
|
workspaceId: string | undefined;
|
|
1177
|
-
isSingleton?: boolean;
|
|
1181
|
+
isSingleton?: boolean | undefined;
|
|
1178
1182
|
componentTypeId: string | undefined;
|
|
1179
|
-
description?: string;
|
|
1180
|
-
propertyDefinitions?: Record<string, PropertyDefinitionRequest
|
|
1181
|
-
extendsFrom?: string[];
|
|
1182
|
-
functions?: Record<string, FunctionRequest
|
|
1183
|
-
propertyGroups?: Record<string, PropertyGroupRequest
|
|
1184
|
-
componentTypeName?: string;
|
|
1185
|
-
compositeComponentTypes?:
|
|
1183
|
+
description?: string | undefined;
|
|
1184
|
+
propertyDefinitions?: Record<string, PropertyDefinitionRequest> | undefined;
|
|
1185
|
+
extendsFrom?: string[] | undefined;
|
|
1186
|
+
functions?: Record<string, FunctionRequest> | undefined;
|
|
1187
|
+
propertyGroups?: Record<string, PropertyGroupRequest> | undefined;
|
|
1188
|
+
componentTypeName?: string | undefined;
|
|
1189
|
+
compositeComponentTypes?:
|
|
1190
|
+
| Record<string, CompositeComponentTypeRequest>
|
|
1191
|
+
| undefined;
|
|
1186
1192
|
}
|
|
1187
1193
|
export interface PropertyRequest {
|
|
1188
|
-
definition?: PropertyDefinitionRequest;
|
|
1189
|
-
value?: DataValue;
|
|
1190
|
-
updateType?: PropertyUpdateType;
|
|
1194
|
+
definition?: PropertyDefinitionRequest | undefined;
|
|
1195
|
+
value?: DataValue | undefined;
|
|
1196
|
+
updateType?: PropertyUpdateType | undefined;
|
|
1191
1197
|
}
|
|
1192
1198
|
export interface PropertyResponse {
|
|
1193
|
-
definition?: PropertyDefinitionResponse;
|
|
1194
|
-
value?: DataValue;
|
|
1195
|
-
areAllPropertyValuesReturned?: boolean;
|
|
1199
|
+
definition?: PropertyDefinitionResponse | undefined;
|
|
1200
|
+
value?: DataValue | undefined;
|
|
1201
|
+
areAllPropertyValuesReturned?: boolean | undefined;
|
|
1196
1202
|
}
|
|
1197
1203
|
export interface PropertySummary {
|
|
1198
|
-
definition?: PropertyDefinitionResponse;
|
|
1204
|
+
definition?: PropertyDefinitionResponse | undefined;
|
|
1199
1205
|
propertyName: string | undefined;
|
|
1200
|
-
value?: DataValue;
|
|
1201
|
-
areAllPropertyValuesReturned?: boolean;
|
|
1206
|
+
value?: DataValue | undefined;
|
|
1207
|
+
areAllPropertyValuesReturned?: boolean | undefined;
|
|
1202
1208
|
}
|
|
1203
1209
|
export interface ComponentRequest {
|
|
1204
|
-
description?: string;
|
|
1205
|
-
componentTypeId?: string;
|
|
1206
|
-
properties?: Record<string, PropertyRequest
|
|
1207
|
-
propertyGroups?: Record<string, ComponentPropertyGroupRequest
|
|
1210
|
+
description?: string | undefined;
|
|
1211
|
+
componentTypeId?: string | undefined;
|
|
1212
|
+
properties?: Record<string, PropertyRequest> | undefined;
|
|
1213
|
+
propertyGroups?: Record<string, ComponentPropertyGroupRequest> | undefined;
|
|
1208
1214
|
}
|
|
1209
1215
|
export interface ComponentResponse {
|
|
1210
|
-
componentName?: string;
|
|
1211
|
-
description?: string;
|
|
1212
|
-
componentTypeId?: string;
|
|
1213
|
-
status?: Status;
|
|
1214
|
-
definedIn?: string;
|
|
1215
|
-
properties?: Record<string, PropertyResponse
|
|
1216
|
-
propertyGroups?: Record<string, ComponentPropertyGroupResponse
|
|
1217
|
-
syncSource?: string;
|
|
1218
|
-
areAllPropertiesReturned?: boolean;
|
|
1219
|
-
compositeComponents?: Record<string, ComponentSummary
|
|
1220
|
-
areAllCompositeComponentsReturned?: boolean;
|
|
1216
|
+
componentName?: string | undefined;
|
|
1217
|
+
description?: string | undefined;
|
|
1218
|
+
componentTypeId?: string | undefined;
|
|
1219
|
+
status?: Status | undefined;
|
|
1220
|
+
definedIn?: string | undefined;
|
|
1221
|
+
properties?: Record<string, PropertyResponse> | undefined;
|
|
1222
|
+
propertyGroups?: Record<string, ComponentPropertyGroupResponse> | undefined;
|
|
1223
|
+
syncSource?: string | undefined;
|
|
1224
|
+
areAllPropertiesReturned?: boolean | undefined;
|
|
1225
|
+
compositeComponents?: Record<string, ComponentSummary> | undefined;
|
|
1226
|
+
areAllCompositeComponentsReturned?: boolean | undefined;
|
|
1221
1227
|
}
|
|
1222
1228
|
export interface ComponentUpdateRequest {
|
|
1223
|
-
updateType?: ComponentUpdateType;
|
|
1224
|
-
description?: string;
|
|
1225
|
-
componentTypeId?: string;
|
|
1226
|
-
propertyUpdates?: Record<string, PropertyRequest
|
|
1227
|
-
propertyGroupUpdates?:
|
|
1229
|
+
updateType?: ComponentUpdateType | undefined;
|
|
1230
|
+
description?: string | undefined;
|
|
1231
|
+
componentTypeId?: string | undefined;
|
|
1232
|
+
propertyUpdates?: Record<string, PropertyRequest> | undefined;
|
|
1233
|
+
propertyGroupUpdates?:
|
|
1234
|
+
| Record<string, ComponentPropertyGroupRequest>
|
|
1235
|
+
| undefined;
|
|
1228
1236
|
}
|
|
1229
1237
|
export interface CompositeComponentRequest {
|
|
1230
|
-
description?: string;
|
|
1231
|
-
properties?: Record<string, PropertyRequest
|
|
1232
|
-
propertyGroups?: Record<string, ComponentPropertyGroupRequest
|
|
1238
|
+
description?: string | undefined;
|
|
1239
|
+
properties?: Record<string, PropertyRequest> | undefined;
|
|
1240
|
+
propertyGroups?: Record<string, ComponentPropertyGroupRequest> | undefined;
|
|
1233
1241
|
}
|
|
1234
1242
|
export interface CompositeComponentUpdateRequest {
|
|
1235
|
-
updateType?: ComponentUpdateType;
|
|
1236
|
-
description?: string;
|
|
1237
|
-
propertyUpdates?: Record<string, PropertyRequest
|
|
1238
|
-
propertyGroupUpdates?:
|
|
1243
|
+
updateType?: ComponentUpdateType | undefined;
|
|
1244
|
+
description?: string | undefined;
|
|
1245
|
+
propertyUpdates?: Record<string, PropertyRequest> | undefined;
|
|
1246
|
+
propertyGroupUpdates?:
|
|
1247
|
+
| Record<string, ComponentPropertyGroupRequest>
|
|
1248
|
+
| undefined;
|
|
1239
1249
|
}
|
|
1240
1250
|
export interface ListPropertiesResponse {
|
|
1241
1251
|
propertySummaries: PropertySummary[] | undefined;
|
|
1242
|
-
nextToken?: string;
|
|
1252
|
+
nextToken?: string | undefined;
|
|
1243
1253
|
}
|
|
1244
1254
|
export interface GetEntityResponse {
|
|
1245
1255
|
entityId: string | undefined;
|
|
@@ -1247,31 +1257,33 @@ export interface GetEntityResponse {
|
|
|
1247
1257
|
arn: string | undefined;
|
|
1248
1258
|
status: Status | undefined;
|
|
1249
1259
|
workspaceId: string | undefined;
|
|
1250
|
-
description?: string;
|
|
1251
|
-
components?: Record<string, ComponentResponse
|
|
1260
|
+
description?: string | undefined;
|
|
1261
|
+
components?: Record<string, ComponentResponse> | undefined;
|
|
1252
1262
|
parentEntityId: string | undefined;
|
|
1253
1263
|
hasChildEntities: boolean | undefined;
|
|
1254
1264
|
creationDateTime: Date | undefined;
|
|
1255
1265
|
updateDateTime: Date | undefined;
|
|
1256
|
-
syncSource?: string;
|
|
1257
|
-
areAllComponentsReturned?: boolean;
|
|
1266
|
+
syncSource?: string | undefined;
|
|
1267
|
+
areAllComponentsReturned?: boolean | undefined;
|
|
1258
1268
|
}
|
|
1259
1269
|
export interface CreateEntityRequest {
|
|
1260
1270
|
workspaceId: string | undefined;
|
|
1261
|
-
entityId?: string;
|
|
1271
|
+
entityId?: string | undefined;
|
|
1262
1272
|
entityName: string | undefined;
|
|
1263
|
-
description?: string;
|
|
1264
|
-
components?: Record<string, ComponentRequest
|
|
1265
|
-
compositeComponents?: Record<string, CompositeComponentRequest
|
|
1266
|
-
parentEntityId?: string;
|
|
1267
|
-
tags?: Record<string, string
|
|
1273
|
+
description?: string | undefined;
|
|
1274
|
+
components?: Record<string, ComponentRequest> | undefined;
|
|
1275
|
+
compositeComponents?: Record<string, CompositeComponentRequest> | undefined;
|
|
1276
|
+
parentEntityId?: string | undefined;
|
|
1277
|
+
tags?: Record<string, string> | undefined;
|
|
1268
1278
|
}
|
|
1269
1279
|
export interface UpdateEntityRequest {
|
|
1270
1280
|
workspaceId: string | undefined;
|
|
1271
1281
|
entityId: string | undefined;
|
|
1272
|
-
entityName?: string;
|
|
1273
|
-
description?: string;
|
|
1274
|
-
componentUpdates?: Record<string, ComponentUpdateRequest
|
|
1275
|
-
compositeComponentUpdates?:
|
|
1276
|
-
|
|
1282
|
+
entityName?: string | undefined;
|
|
1283
|
+
description?: string | undefined;
|
|
1284
|
+
componentUpdates?: Record<string, ComponentUpdateRequest> | undefined;
|
|
1285
|
+
compositeComponentUpdates?:
|
|
1286
|
+
| Record<string, CompositeComponentUpdateRequest>
|
|
1287
|
+
| undefined;
|
|
1288
|
+
parentEntityUpdate?: ParentEntityUpdateRequest | undefined;
|
|
1277
1289
|
}
|