@aws-sdk/client-iottwinmaker 3.454.0 → 3.458.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 +83 -36
- package/dist-cjs/IoTTwinMaker.js +12 -0
- package/dist-cjs/commands/CancelMetadataTransferJobCommand.js +51 -0
- package/dist-cjs/commands/CreateMetadataTransferJobCommand.js +51 -0
- package/dist-cjs/commands/GetMetadataTransferJobCommand.js +51 -0
- package/dist-cjs/commands/ListComponentsCommand.js +51 -0
- package/dist-cjs/commands/ListMetadataTransferJobsCommand.js +51 -0
- package/dist-cjs/commands/ListPropertiesCommand.js +51 -0
- package/dist-cjs/commands/index.js +6 -0
- package/dist-cjs/models/models_0.js +60 -8
- package/dist-cjs/pagination/ListComponentsPaginator.js +29 -0
- package/dist-cjs/pagination/ListMetadataTransferJobsPaginator.js +29 -0
- package/dist-cjs/pagination/ListPropertiesPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +3 -0
- package/dist-cjs/protocols/Aws_restJson1.js +570 -3
- package/dist-es/IoTTwinMaker.js +12 -0
- package/dist-es/commands/CancelMetadataTransferJobCommand.js +47 -0
- package/dist-es/commands/CreateMetadataTransferJobCommand.js +47 -0
- package/dist-es/commands/GetMetadataTransferJobCommand.js +47 -0
- package/dist-es/commands/ListComponentsCommand.js +47 -0
- package/dist-es/commands/ListMetadataTransferJobsCommand.js +47 -0
- package/dist-es/commands/ListPropertiesCommand.js +47 -0
- package/dist-es/commands/index.js +6 -0
- package/dist-es/models/models_0.js +59 -7
- package/dist-es/pagination/ListComponentsPaginator.js +25 -0
- package/dist-es/pagination/ListMetadataTransferJobsPaginator.js +25 -0
- package/dist-es/pagination/ListPropertiesPaginator.js +25 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +556 -1
- package/dist-types/IoTTwinMaker.d.ts +43 -2
- package/dist-types/IoTTwinMakerClient.d.ts +9 -4
- package/dist-types/commands/BatchPutPropertyValuesCommand.d.ts +2 -0
- package/dist-types/commands/CancelMetadataTransferJobCommand.d.ts +107 -0
- package/dist-types/commands/CreateComponentTypeCommand.d.ts +5 -0
- package/dist-types/commands/CreateEntityCommand.d.ts +32 -0
- package/dist-types/commands/CreateMetadataTransferJobCommand.d.ts +153 -0
- package/dist-types/commands/CreateWorkspaceCommand.d.ts +2 -2
- package/dist-types/commands/DeleteWorkspaceCommand.d.ts +3 -1
- package/dist-types/commands/ExecuteQueryCommand.d.ts +4 -0
- package/dist-types/commands/GetComponentTypeCommand.d.ts +6 -0
- package/dist-types/commands/GetEntityCommand.d.ts +24 -0
- package/dist-types/commands/GetMetadataTransferJobCommand.d.ts +156 -0
- package/dist-types/commands/GetPropertyValueCommand.d.ts +2 -0
- package/dist-types/commands/GetPropertyValueHistoryCommand.d.ts +2 -0
- package/dist-types/commands/GetWorkspaceCommand.d.ts +5 -2
- package/dist-types/commands/ListComponentsCommand.d.ts +118 -0
- package/dist-types/commands/ListMetadataTransferJobsCommand.d.ts +116 -0
- package/dist-types/commands/ListPropertiesCommand.d.ts +167 -0
- package/dist-types/commands/ListWorkspacesCommand.d.ts +3 -0
- package/dist-types/commands/UpdateComponentTypeCommand.d.ts +5 -0
- package/dist-types/commands/UpdateEntityCommand.d.ts +33 -0
- package/dist-types/commands/UpdateWorkspaceCommand.d.ts +1 -0
- package/dist-types/commands/index.d.ts +6 -0
- package/dist-types/index.d.ts +1 -2
- package/dist-types/models/models_0.d.ts +1118 -143
- package/dist-types/pagination/ListComponentsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListMetadataTransferJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListPropertiesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +54 -0
- package/dist-types/ts3.4/IoTTwinMaker.d.ts +102 -0
- package/dist-types/ts3.4/IoTTwinMakerClient.d.ts +36 -0
- package/dist-types/ts3.4/commands/CancelMetadataTransferJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateMetadataTransferJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetMetadataTransferJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListComponentsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListMetadataTransferJobsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListPropertiesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +329 -24
- package/dist-types/ts3.4/pagination/ListComponentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListMetadataTransferJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListPropertiesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +72 -0
- package/package.json +3 -3
|
@@ -23,6 +23,11 @@ export interface EntityPropertyReference {
|
|
|
23
23
|
* <p>The name of the component.</p>
|
|
24
24
|
*/
|
|
25
25
|
componentName?: string;
|
|
26
|
+
/**
|
|
27
|
+
* @public
|
|
28
|
+
* <p>This string specifies the path to the composite component, starting from the top-level component.</p>
|
|
29
|
+
*/
|
|
30
|
+
componentPath?: string;
|
|
26
31
|
/**
|
|
27
32
|
* @public
|
|
28
33
|
* <p>A mapping of external IDs to property names. External IDs uniquely identify properties
|
|
@@ -104,6 +109,144 @@ export declare class ValidationException extends __BaseException {
|
|
|
104
109
|
*/
|
|
105
110
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
106
111
|
}
|
|
112
|
+
/**
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
export interface CancelMetadataTransferJobRequest {
|
|
116
|
+
/**
|
|
117
|
+
* @public
|
|
118
|
+
* <p>The metadata transfer job Id.</p>
|
|
119
|
+
*/
|
|
120
|
+
metadataTransferJobId: string | undefined;
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* @public
|
|
124
|
+
* <p>The metadata transfer job's progress.</p>
|
|
125
|
+
*/
|
|
126
|
+
export interface MetadataTransferJobProgress {
|
|
127
|
+
/**
|
|
128
|
+
* @public
|
|
129
|
+
* <p>The total count. [of what]</p>
|
|
130
|
+
*/
|
|
131
|
+
totalCount?: number;
|
|
132
|
+
/**
|
|
133
|
+
* @public
|
|
134
|
+
* <p>The succeeded count.</p>
|
|
135
|
+
*/
|
|
136
|
+
succeededCount?: number;
|
|
137
|
+
/**
|
|
138
|
+
* @public
|
|
139
|
+
* <p>The skipped count.</p>
|
|
140
|
+
*/
|
|
141
|
+
skippedCount?: number;
|
|
142
|
+
/**
|
|
143
|
+
* @public
|
|
144
|
+
* <p>The failed count.</p>
|
|
145
|
+
*/
|
|
146
|
+
failedCount?: number;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* @public
|
|
150
|
+
* @enum
|
|
151
|
+
*/
|
|
152
|
+
export declare const ErrorCode: {
|
|
153
|
+
readonly COMPOSITE_COMPONENT_FAILURE: "COMPOSITE_COMPONENT_FAILURE";
|
|
154
|
+
readonly INTERNAL_FAILURE: "INTERNAL_FAILURE";
|
|
155
|
+
readonly PROCESSING_ERROR: "PROCESSING_ERROR";
|
|
156
|
+
readonly SYNC_CREATING_ERROR: "SYNC_CREATING_ERROR";
|
|
157
|
+
readonly SYNC_DELETING_ERROR: "SYNC_DELETING_ERROR";
|
|
158
|
+
readonly SYNC_INITIALIZING_ERROR: "SYNC_INITIALIZING_ERROR";
|
|
159
|
+
readonly SYNC_PROCESSING_ERROR: "SYNC_PROCESSING_ERROR";
|
|
160
|
+
readonly VALIDATION_ERROR: "VALIDATION_ERROR";
|
|
161
|
+
};
|
|
162
|
+
/**
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
|
|
166
|
+
/**
|
|
167
|
+
* @public
|
|
168
|
+
* <p>The error details.</p>
|
|
169
|
+
*/
|
|
170
|
+
export interface ErrorDetails {
|
|
171
|
+
/**
|
|
172
|
+
* @public
|
|
173
|
+
* <p>The error code.</p>
|
|
174
|
+
*/
|
|
175
|
+
code?: ErrorCode;
|
|
176
|
+
/**
|
|
177
|
+
* @public
|
|
178
|
+
* <p>The error message.</p>
|
|
179
|
+
*/
|
|
180
|
+
message?: string;
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* @public
|
|
184
|
+
* @enum
|
|
185
|
+
*/
|
|
186
|
+
export declare const MetadataTransferJobState: {
|
|
187
|
+
readonly CANCELLED: "CANCELLED";
|
|
188
|
+
readonly CANCELLING: "CANCELLING";
|
|
189
|
+
readonly COMPLETED: "COMPLETED";
|
|
190
|
+
readonly ERROR: "ERROR";
|
|
191
|
+
readonly PENDING: "PENDING";
|
|
192
|
+
readonly RUNNING: "RUNNING";
|
|
193
|
+
readonly VALIDATING: "VALIDATING";
|
|
194
|
+
};
|
|
195
|
+
/**
|
|
196
|
+
* @public
|
|
197
|
+
*/
|
|
198
|
+
export type MetadataTransferJobState = (typeof MetadataTransferJobState)[keyof typeof MetadataTransferJobState];
|
|
199
|
+
/**
|
|
200
|
+
* @public
|
|
201
|
+
* <p>The metadata transfer job status.</p>
|
|
202
|
+
*/
|
|
203
|
+
export interface MetadataTransferJobStatus {
|
|
204
|
+
/**
|
|
205
|
+
* @public
|
|
206
|
+
* <p>The metadata transfer job state.</p>
|
|
207
|
+
*/
|
|
208
|
+
state?: MetadataTransferJobState;
|
|
209
|
+
/**
|
|
210
|
+
* @public
|
|
211
|
+
* <p>The metadata transfer job error.</p>
|
|
212
|
+
*/
|
|
213
|
+
error?: ErrorDetails;
|
|
214
|
+
/**
|
|
215
|
+
* @public
|
|
216
|
+
* <p>The queued position.</p>
|
|
217
|
+
*/
|
|
218
|
+
queuedPosition?: number;
|
|
219
|
+
}
|
|
220
|
+
/**
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
export interface CancelMetadataTransferJobResponse {
|
|
224
|
+
/**
|
|
225
|
+
* @public
|
|
226
|
+
* <p>The metadata transfer job Id.</p>
|
|
227
|
+
*/
|
|
228
|
+
metadataTransferJobId: string | undefined;
|
|
229
|
+
/**
|
|
230
|
+
* @public
|
|
231
|
+
* <p>The metadata transfer job ARN.</p>
|
|
232
|
+
*/
|
|
233
|
+
arn: string | undefined;
|
|
234
|
+
/**
|
|
235
|
+
* @public
|
|
236
|
+
* <p>Used to update the DateTime property.</p>
|
|
237
|
+
*/
|
|
238
|
+
updateDateTime: Date | undefined;
|
|
239
|
+
/**
|
|
240
|
+
* @public
|
|
241
|
+
* <p>The metadata transfer job's status.</p>
|
|
242
|
+
*/
|
|
243
|
+
status: MetadataTransferJobStatus | undefined;
|
|
244
|
+
/**
|
|
245
|
+
* @public
|
|
246
|
+
* <p>The metadata transfer job's progress.</p>
|
|
247
|
+
*/
|
|
248
|
+
progress?: MetadataTransferJobProgress;
|
|
249
|
+
}
|
|
107
250
|
/**
|
|
108
251
|
* @public
|
|
109
252
|
* <p>A conflict occurred.</p>
|
|
@@ -116,6 +259,17 @@ export declare class ConflictException extends __BaseException {
|
|
|
116
259
|
*/
|
|
117
260
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
118
261
|
}
|
|
262
|
+
/**
|
|
263
|
+
* @public
|
|
264
|
+
* <p>An object that sets information about the composite component types of a component type.</p>
|
|
265
|
+
*/
|
|
266
|
+
export interface CompositeComponentTypeRequest {
|
|
267
|
+
/**
|
|
268
|
+
* @public
|
|
269
|
+
* <p>This is the <code>componentTypeId</code> that the <code>compositeComponentType</code> refers to.</p>
|
|
270
|
+
*/
|
|
271
|
+
componentTypeId?: string;
|
|
272
|
+
}
|
|
119
273
|
/**
|
|
120
274
|
* @public
|
|
121
275
|
* <p>The Lambda function.</p>
|
|
@@ -357,6 +511,347 @@ export interface CreateEntityResponse {
|
|
|
357
511
|
*/
|
|
358
512
|
state: State | undefined;
|
|
359
513
|
}
|
|
514
|
+
/**
|
|
515
|
+
* @public
|
|
516
|
+
* <p>The metadata transfer job AWS IoT TwinMaker destination configuration.</p>
|
|
517
|
+
*/
|
|
518
|
+
export interface IotTwinMakerDestinationConfiguration {
|
|
519
|
+
/**
|
|
520
|
+
* @public
|
|
521
|
+
* <p>The IoT TwinMaker workspace.</p>
|
|
522
|
+
*/
|
|
523
|
+
workspace: string | undefined;
|
|
524
|
+
}
|
|
525
|
+
/**
|
|
526
|
+
* @public
|
|
527
|
+
* <p>The S3 destination configuration.</p>
|
|
528
|
+
*/
|
|
529
|
+
export interface S3DestinationConfiguration {
|
|
530
|
+
/**
|
|
531
|
+
* @public
|
|
532
|
+
* <p>The S3 destination configuration location.</p>
|
|
533
|
+
*/
|
|
534
|
+
location: string | undefined;
|
|
535
|
+
}
|
|
536
|
+
/**
|
|
537
|
+
* @public
|
|
538
|
+
* @enum
|
|
539
|
+
*/
|
|
540
|
+
export declare const DestinationType: {
|
|
541
|
+
readonly IOTSITEWISE: "iotsitewise";
|
|
542
|
+
readonly IOTTWINMAKER: "iottwinmaker";
|
|
543
|
+
readonly S3: "s3";
|
|
544
|
+
};
|
|
545
|
+
/**
|
|
546
|
+
* @public
|
|
547
|
+
*/
|
|
548
|
+
export type DestinationType = (typeof DestinationType)[keyof typeof DestinationType];
|
|
549
|
+
/**
|
|
550
|
+
* @public
|
|
551
|
+
* <p>The [link to action] metadata transfer job destination configuration.</p>
|
|
552
|
+
*/
|
|
553
|
+
export interface DestinationConfiguration {
|
|
554
|
+
/**
|
|
555
|
+
* @public
|
|
556
|
+
* <p>The destination type.</p>
|
|
557
|
+
*/
|
|
558
|
+
type: DestinationType | undefined;
|
|
559
|
+
/**
|
|
560
|
+
* @public
|
|
561
|
+
* <p>The metadata transfer job S3 configuration. [need to add S3 entity]</p>
|
|
562
|
+
*/
|
|
563
|
+
s3Configuration?: S3DestinationConfiguration;
|
|
564
|
+
/**
|
|
565
|
+
* @public
|
|
566
|
+
* <p>The metadata transfer job Amazon Web Services IoT TwinMaker configuration.</p>
|
|
567
|
+
*/
|
|
568
|
+
iotTwinMakerConfiguration?: IotTwinMakerDestinationConfiguration;
|
|
569
|
+
}
|
|
570
|
+
/**
|
|
571
|
+
* @public
|
|
572
|
+
* <p>Filter by asset. [TwinMaker asset]</p>
|
|
573
|
+
*/
|
|
574
|
+
export interface FilterByAsset {
|
|
575
|
+
/**
|
|
576
|
+
* @public
|
|
577
|
+
* <p>Filter by asset Id.</p>
|
|
578
|
+
*/
|
|
579
|
+
assetId?: string;
|
|
580
|
+
/**
|
|
581
|
+
* @public
|
|
582
|
+
* <p>The external-Id property of an asset. </p>
|
|
583
|
+
*/
|
|
584
|
+
assetExternalId?: string;
|
|
585
|
+
/**
|
|
586
|
+
* @public
|
|
587
|
+
* <p>Includes sub-assets.[need description hekp for this]</p>
|
|
588
|
+
*/
|
|
589
|
+
includeOffspring?: boolean;
|
|
590
|
+
/**
|
|
591
|
+
* @public
|
|
592
|
+
* <p>Boolean to include the asset model.</p>
|
|
593
|
+
*/
|
|
594
|
+
includeAssetModel?: boolean;
|
|
595
|
+
}
|
|
596
|
+
/**
|
|
597
|
+
* @public
|
|
598
|
+
* <p>Filter by asset model.</p>
|
|
599
|
+
*/
|
|
600
|
+
export interface FilterByAssetModel {
|
|
601
|
+
/**
|
|
602
|
+
* @public
|
|
603
|
+
* <p>The asset model Id.</p>
|
|
604
|
+
*/
|
|
605
|
+
assetModelId?: string;
|
|
606
|
+
/**
|
|
607
|
+
* @public
|
|
608
|
+
* <p>The external-Id property of an asset model.</p>
|
|
609
|
+
*/
|
|
610
|
+
assetModelExternalId?: string;
|
|
611
|
+
/**
|
|
612
|
+
* @public
|
|
613
|
+
* <p>Include asset offspring. [need desc.]</p>
|
|
614
|
+
*/
|
|
615
|
+
includeOffspring?: boolean;
|
|
616
|
+
/**
|
|
617
|
+
* @public
|
|
618
|
+
* <p>Bolean to include assets.</p>
|
|
619
|
+
*/
|
|
620
|
+
includeAssets?: boolean;
|
|
621
|
+
}
|
|
622
|
+
/**
|
|
623
|
+
* @public
|
|
624
|
+
* <p>The AWS IoT SiteWise soucre configuration filter.[need held with desc here]</p>
|
|
625
|
+
*/
|
|
626
|
+
export type IotSiteWiseSourceConfigurationFilter = IotSiteWiseSourceConfigurationFilter.FilterByAssetMember | IotSiteWiseSourceConfigurationFilter.FilterByAssetModelMember | IotSiteWiseSourceConfigurationFilter.$UnknownMember;
|
|
627
|
+
/**
|
|
628
|
+
* @public
|
|
629
|
+
*/
|
|
630
|
+
export declare namespace IotSiteWiseSourceConfigurationFilter {
|
|
631
|
+
/**
|
|
632
|
+
* @public
|
|
633
|
+
* <p>Filter by asset model.</p>
|
|
634
|
+
*/
|
|
635
|
+
interface FilterByAssetModelMember {
|
|
636
|
+
filterByAssetModel: FilterByAssetModel;
|
|
637
|
+
filterByAsset?: never;
|
|
638
|
+
$unknown?: never;
|
|
639
|
+
}
|
|
640
|
+
/**
|
|
641
|
+
* @public
|
|
642
|
+
* <p>Filter by asset.</p>
|
|
643
|
+
*/
|
|
644
|
+
interface FilterByAssetMember {
|
|
645
|
+
filterByAssetModel?: never;
|
|
646
|
+
filterByAsset: FilterByAsset;
|
|
647
|
+
$unknown?: never;
|
|
648
|
+
}
|
|
649
|
+
/**
|
|
650
|
+
* @public
|
|
651
|
+
*/
|
|
652
|
+
interface $UnknownMember {
|
|
653
|
+
filterByAssetModel?: never;
|
|
654
|
+
filterByAsset?: never;
|
|
655
|
+
$unknown: [string, any];
|
|
656
|
+
}
|
|
657
|
+
interface Visitor<T> {
|
|
658
|
+
filterByAssetModel: (value: FilterByAssetModel) => T;
|
|
659
|
+
filterByAsset: (value: FilterByAsset) => T;
|
|
660
|
+
_: (name: string, value: any) => T;
|
|
661
|
+
}
|
|
662
|
+
const visit: <T>(value: IotSiteWiseSourceConfigurationFilter, visitor: Visitor<T>) => T;
|
|
663
|
+
}
|
|
664
|
+
/**
|
|
665
|
+
* @public
|
|
666
|
+
* <p>The metadata transfer job AWS IoT SiteWise source configuration.</p>
|
|
667
|
+
*/
|
|
668
|
+
export interface IotSiteWiseSourceConfiguration {
|
|
669
|
+
/**
|
|
670
|
+
* @public
|
|
671
|
+
* <p>The AWS IoT SiteWise soucre configuration filters.</p>
|
|
672
|
+
*/
|
|
673
|
+
filters?: IotSiteWiseSourceConfigurationFilter[];
|
|
674
|
+
}
|
|
675
|
+
/**
|
|
676
|
+
* @public
|
|
677
|
+
* <p>Filter by component type.</p>
|
|
678
|
+
*/
|
|
679
|
+
export interface FilterByComponentType {
|
|
680
|
+
/**
|
|
681
|
+
* @public
|
|
682
|
+
* <p>The component type Id.</p>
|
|
683
|
+
*/
|
|
684
|
+
componentTypeId: string | undefined;
|
|
685
|
+
}
|
|
686
|
+
/**
|
|
687
|
+
* @public
|
|
688
|
+
* <p>Vilter by entity.</p>
|
|
689
|
+
*/
|
|
690
|
+
export interface FilterByEntity {
|
|
691
|
+
/**
|
|
692
|
+
* @public
|
|
693
|
+
* <p>The entity Id.</p>
|
|
694
|
+
*/
|
|
695
|
+
entityId: string | undefined;
|
|
696
|
+
}
|
|
697
|
+
/**
|
|
698
|
+
* @public
|
|
699
|
+
* <p>The metadata transfer job AWS IoT TwinMaker source configuration filter.</p>
|
|
700
|
+
*/
|
|
701
|
+
export type IotTwinMakerSourceConfigurationFilter = IotTwinMakerSourceConfigurationFilter.FilterByComponentTypeMember | IotTwinMakerSourceConfigurationFilter.FilterByEntityMember | IotTwinMakerSourceConfigurationFilter.$UnknownMember;
|
|
702
|
+
/**
|
|
703
|
+
* @public
|
|
704
|
+
*/
|
|
705
|
+
export declare namespace IotTwinMakerSourceConfigurationFilter {
|
|
706
|
+
/**
|
|
707
|
+
* @public
|
|
708
|
+
* <p>Filter by component type.</p>
|
|
709
|
+
*/
|
|
710
|
+
interface FilterByComponentTypeMember {
|
|
711
|
+
filterByComponentType: FilterByComponentType;
|
|
712
|
+
filterByEntity?: never;
|
|
713
|
+
$unknown?: never;
|
|
714
|
+
}
|
|
715
|
+
/**
|
|
716
|
+
* @public
|
|
717
|
+
* <p>Filter by entity.</p>
|
|
718
|
+
*/
|
|
719
|
+
interface FilterByEntityMember {
|
|
720
|
+
filterByComponentType?: never;
|
|
721
|
+
filterByEntity: FilterByEntity;
|
|
722
|
+
$unknown?: never;
|
|
723
|
+
}
|
|
724
|
+
/**
|
|
725
|
+
* @public
|
|
726
|
+
*/
|
|
727
|
+
interface $UnknownMember {
|
|
728
|
+
filterByComponentType?: never;
|
|
729
|
+
filterByEntity?: never;
|
|
730
|
+
$unknown: [string, any];
|
|
731
|
+
}
|
|
732
|
+
interface Visitor<T> {
|
|
733
|
+
filterByComponentType: (value: FilterByComponentType) => T;
|
|
734
|
+
filterByEntity: (value: FilterByEntity) => T;
|
|
735
|
+
_: (name: string, value: any) => T;
|
|
736
|
+
}
|
|
737
|
+
const visit: <T>(value: IotTwinMakerSourceConfigurationFilter, visitor: Visitor<T>) => T;
|
|
738
|
+
}
|
|
739
|
+
/**
|
|
740
|
+
* @public
|
|
741
|
+
* <p>The metadata transfer job AWS IoT TwinMaker source configuration.</p>
|
|
742
|
+
*/
|
|
743
|
+
export interface IotTwinMakerSourceConfiguration {
|
|
744
|
+
/**
|
|
745
|
+
* @public
|
|
746
|
+
* <p>The IoT TwinMaker workspace.</p>
|
|
747
|
+
*/
|
|
748
|
+
workspace: string | undefined;
|
|
749
|
+
/**
|
|
750
|
+
* @public
|
|
751
|
+
* <p>The metadata transfer job AWS IoT TwinMaker source configuration filters.</p>
|
|
752
|
+
*/
|
|
753
|
+
filters?: IotTwinMakerSourceConfigurationFilter[];
|
|
754
|
+
}
|
|
755
|
+
/**
|
|
756
|
+
* @public
|
|
757
|
+
* <p>The S3 destination source configuration.</p>
|
|
758
|
+
*/
|
|
759
|
+
export interface S3SourceConfiguration {
|
|
760
|
+
/**
|
|
761
|
+
* @public
|
|
762
|
+
* <p>The S3 destination source configuration location.</p>
|
|
763
|
+
*/
|
|
764
|
+
location: string | undefined;
|
|
765
|
+
}
|
|
766
|
+
/**
|
|
767
|
+
* @public
|
|
768
|
+
* @enum
|
|
769
|
+
*/
|
|
770
|
+
export declare const SourceType: {
|
|
771
|
+
readonly IOTSITEWISE: "iotsitewise";
|
|
772
|
+
readonly IOTTWINMAKER: "iottwinmaker";
|
|
773
|
+
readonly S3: "s3";
|
|
774
|
+
};
|
|
775
|
+
/**
|
|
776
|
+
* @public
|
|
777
|
+
*/
|
|
778
|
+
export type SourceType = (typeof SourceType)[keyof typeof SourceType];
|
|
779
|
+
/**
|
|
780
|
+
* @public
|
|
781
|
+
* <p>The source configuration.</p>
|
|
782
|
+
*/
|
|
783
|
+
export interface SourceConfiguration {
|
|
784
|
+
/**
|
|
785
|
+
* @public
|
|
786
|
+
* <p>The source configuration type.</p>
|
|
787
|
+
*/
|
|
788
|
+
type: SourceType | undefined;
|
|
789
|
+
/**
|
|
790
|
+
* @public
|
|
791
|
+
* <p>The source configuration S3 configuration.</p>
|
|
792
|
+
*/
|
|
793
|
+
s3Configuration?: S3SourceConfiguration;
|
|
794
|
+
/**
|
|
795
|
+
* @public
|
|
796
|
+
* <p>The source configuration IoT SiteWise configuration.</p>
|
|
797
|
+
*/
|
|
798
|
+
iotSiteWiseConfiguration?: IotSiteWiseSourceConfiguration;
|
|
799
|
+
/**
|
|
800
|
+
* @public
|
|
801
|
+
* <p>The source configuration IoT TwinMaker configuration.</p>
|
|
802
|
+
*/
|
|
803
|
+
iotTwinMakerConfiguration?: IotTwinMakerSourceConfiguration;
|
|
804
|
+
}
|
|
805
|
+
/**
|
|
806
|
+
* @public
|
|
807
|
+
*/
|
|
808
|
+
export interface CreateMetadataTransferJobRequest {
|
|
809
|
+
/**
|
|
810
|
+
* @public
|
|
811
|
+
* <p>The metadata transfer job Id.</p>
|
|
812
|
+
*/
|
|
813
|
+
metadataTransferJobId?: string;
|
|
814
|
+
/**
|
|
815
|
+
* @public
|
|
816
|
+
* <p>The metadata transfer job description.</p>
|
|
817
|
+
*/
|
|
818
|
+
description?: string;
|
|
819
|
+
/**
|
|
820
|
+
* @public
|
|
821
|
+
* <p>The metadata transfer job sources.</p>
|
|
822
|
+
*/
|
|
823
|
+
sources: SourceConfiguration[] | undefined;
|
|
824
|
+
/**
|
|
825
|
+
* @public
|
|
826
|
+
* <p>The metadata transfer job destination.</p>
|
|
827
|
+
*/
|
|
828
|
+
destination: DestinationConfiguration | undefined;
|
|
829
|
+
}
|
|
830
|
+
/**
|
|
831
|
+
* @public
|
|
832
|
+
*/
|
|
833
|
+
export interface CreateMetadataTransferJobResponse {
|
|
834
|
+
/**
|
|
835
|
+
* @public
|
|
836
|
+
* <p>The metadata transfer job Id.</p>
|
|
837
|
+
*/
|
|
838
|
+
metadataTransferJobId: string | undefined;
|
|
839
|
+
/**
|
|
840
|
+
* @public
|
|
841
|
+
* <p>The metadata transfer job ARN.</p>
|
|
842
|
+
*/
|
|
843
|
+
arn: string | undefined;
|
|
844
|
+
/**
|
|
845
|
+
* @public
|
|
846
|
+
* <p>The The metadata transfer job creation DateTime property.</p>
|
|
847
|
+
*/
|
|
848
|
+
creationDateTime: Date | undefined;
|
|
849
|
+
/**
|
|
850
|
+
* @public
|
|
851
|
+
* <p>The metadata transfer job response status.</p>
|
|
852
|
+
*/
|
|
853
|
+
status: MetadataTransferJobStatus | undefined;
|
|
854
|
+
}
|
|
360
855
|
/**
|
|
361
856
|
* @public
|
|
362
857
|
*/
|
|
@@ -495,12 +990,12 @@ export interface CreateWorkspaceRequest {
|
|
|
495
990
|
* <p>The ARN of the S3 bucket where resources associated with the workspace are
|
|
496
991
|
* stored.</p>
|
|
497
992
|
*/
|
|
498
|
-
s3Location
|
|
993
|
+
s3Location?: string;
|
|
499
994
|
/**
|
|
500
995
|
* @public
|
|
501
996
|
* <p>The ARN of the execution role associated with the workspace.</p>
|
|
502
997
|
*/
|
|
503
|
-
role
|
|
998
|
+
role?: string;
|
|
504
999
|
/**
|
|
505
1000
|
* @public
|
|
506
1001
|
* <p>Metadata that you can use to manage the workspace</p>
|
|
@@ -639,6 +1134,11 @@ export interface DeleteWorkspaceRequest {
|
|
|
639
1134
|
* @public
|
|
640
1135
|
*/
|
|
641
1136
|
export interface DeleteWorkspaceResponse {
|
|
1137
|
+
/**
|
|
1138
|
+
* @public
|
|
1139
|
+
* <p>The string that specifies the delete result for the workspace.</p>
|
|
1140
|
+
*/
|
|
1141
|
+
message?: string;
|
|
642
1142
|
}
|
|
643
1143
|
/**
|
|
644
1144
|
* @public
|
|
@@ -656,8 +1156,7 @@ export interface ExecuteQueryRequest {
|
|
|
656
1156
|
queryStatement: string | undefined;
|
|
657
1157
|
/**
|
|
658
1158
|
* @public
|
|
659
|
-
* <p>The maximum number of results to return at one time. The default is
|
|
660
|
-
* <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
|
|
1159
|
+
* <p>The maximum number of results to return at one time. The default is 50.</p>
|
|
661
1160
|
*/
|
|
662
1161
|
maxResults?: number;
|
|
663
1162
|
/**
|
|
@@ -754,6 +1253,22 @@ export interface GetComponentTypeRequest {
|
|
|
754
1253
|
*/
|
|
755
1254
|
componentTypeId: string | undefined;
|
|
756
1255
|
}
|
|
1256
|
+
/**
|
|
1257
|
+
* @public
|
|
1258
|
+
* <p>An object that returns information about the composite component types of a component type.</p>
|
|
1259
|
+
*/
|
|
1260
|
+
export interface CompositeComponentTypeResponse {
|
|
1261
|
+
/**
|
|
1262
|
+
* @public
|
|
1263
|
+
* <p>This is the <code>componentTypeId</code> that this <code>compositeComponentType</code> refers to.</p>
|
|
1264
|
+
*/
|
|
1265
|
+
componentTypeId?: string;
|
|
1266
|
+
/**
|
|
1267
|
+
* @public
|
|
1268
|
+
* <p>This boolean indicates whether this <code>compositeComponentType</code> is inherited from its parent.</p>
|
|
1269
|
+
*/
|
|
1270
|
+
isInherited?: boolean;
|
|
1271
|
+
}
|
|
757
1272
|
/**
|
|
758
1273
|
* @public
|
|
759
1274
|
* <p>The function response.</p>
|
|
@@ -804,88 +1319,173 @@ export interface PropertyGroupResponse {
|
|
|
804
1319
|
}
|
|
805
1320
|
/**
|
|
806
1321
|
* @public
|
|
807
|
-
*
|
|
1322
|
+
* <p>An object that represents the status of an entity, component, component type, or
|
|
1323
|
+
* workspace.</p>
|
|
808
1324
|
*/
|
|
809
|
-
export
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
1325
|
+
export interface Status {
|
|
1326
|
+
/**
|
|
1327
|
+
* @public
|
|
1328
|
+
* <p>The current state of the entity, component, component type, or workspace.</p>
|
|
1329
|
+
*/
|
|
1330
|
+
state?: State;
|
|
1331
|
+
/**
|
|
1332
|
+
* @public
|
|
1333
|
+
* <p>The error message.</p>
|
|
1334
|
+
*/
|
|
1335
|
+
error?: ErrorDetails;
|
|
1336
|
+
}
|
|
1337
|
+
/**
|
|
1338
|
+
* @public
|
|
1339
|
+
*/
|
|
1340
|
+
export interface GetEntityRequest {
|
|
1341
|
+
/**
|
|
1342
|
+
* @public
|
|
1343
|
+
* <p>The ID of the workspace.</p>
|
|
1344
|
+
*/
|
|
1345
|
+
workspaceId: string | undefined;
|
|
1346
|
+
/**
|
|
1347
|
+
* @public
|
|
1348
|
+
* <p>The ID of the entity.</p>
|
|
1349
|
+
*/
|
|
1350
|
+
entityId: string | undefined;
|
|
1351
|
+
}
|
|
1352
|
+
/**
|
|
1353
|
+
* @public
|
|
1354
|
+
* <p>The component property group response.</p>
|
|
1355
|
+
*/
|
|
1356
|
+
export interface ComponentPropertyGroupResponse {
|
|
1357
|
+
/**
|
|
1358
|
+
* @public
|
|
1359
|
+
* <p>The group type.</p>
|
|
1360
|
+
*/
|
|
1361
|
+
groupType: GroupType | undefined;
|
|
1362
|
+
/**
|
|
1363
|
+
* @public
|
|
1364
|
+
* <p>The names of properties</p>
|
|
1365
|
+
*/
|
|
1366
|
+
propertyNames: string[] | undefined;
|
|
1367
|
+
/**
|
|
1368
|
+
* @public
|
|
1369
|
+
* <p>A Boolean value that specifies whether the property group is inherited from a parent
|
|
1370
|
+
* entity</p>
|
|
1371
|
+
*/
|
|
1372
|
+
isInherited: boolean | undefined;
|
|
1373
|
+
}
|
|
1374
|
+
/**
|
|
1375
|
+
* @public
|
|
1376
|
+
* <p>An object that returns information about a component summary.</p>
|
|
1377
|
+
*/
|
|
1378
|
+
export interface ComponentSummary {
|
|
1379
|
+
/**
|
|
1380
|
+
* @public
|
|
1381
|
+
* <p>The name of the component.</p>
|
|
1382
|
+
*/
|
|
1383
|
+
componentName: string | undefined;
|
|
1384
|
+
/**
|
|
1385
|
+
* @public
|
|
1386
|
+
* <p>The ID of the component type.</p>
|
|
1387
|
+
*/
|
|
1388
|
+
componentTypeId: string | undefined;
|
|
1389
|
+
/**
|
|
1390
|
+
* @public
|
|
1391
|
+
* <p>The name of the property definition set in the request.</p>
|
|
1392
|
+
*/
|
|
1393
|
+
definedIn?: string;
|
|
1394
|
+
/**
|
|
1395
|
+
* @public
|
|
1396
|
+
* <p>The description of the component request.</p>
|
|
1397
|
+
*/
|
|
1398
|
+
description?: string;
|
|
1399
|
+
/**
|
|
1400
|
+
* @public
|
|
1401
|
+
* <p>The property groups.</p>
|
|
1402
|
+
*/
|
|
1403
|
+
propertyGroups?: Record<string, ComponentPropertyGroupResponse>;
|
|
1404
|
+
/**
|
|
1405
|
+
* @public
|
|
1406
|
+
* <p>The status of the component type.</p>
|
|
1407
|
+
*/
|
|
1408
|
+
status: Status | undefined;
|
|
1409
|
+
/**
|
|
1410
|
+
* @public
|
|
1411
|
+
* <p>The <code>syncSource</code> of the sync job, if this entity was created by a sync job.</p>
|
|
1412
|
+
*/
|
|
1413
|
+
syncSource?: string;
|
|
1414
|
+
/**
|
|
1415
|
+
* @public
|
|
1416
|
+
* <p>This string specifies the path to the composite component, starting from the top-level component.</p>
|
|
1417
|
+
*/
|
|
1418
|
+
componentPath?: string;
|
|
1419
|
+
}
|
|
816
1420
|
/**
|
|
817
1421
|
* @public
|
|
818
1422
|
*/
|
|
819
|
-
export
|
|
1423
|
+
export interface GetMetadataTransferJobRequest {
|
|
1424
|
+
/**
|
|
1425
|
+
* @public
|
|
1426
|
+
* <p>The metadata transfer job Id.</p>
|
|
1427
|
+
*/
|
|
1428
|
+
metadataTransferJobId: string | undefined;
|
|
1429
|
+
}
|
|
820
1430
|
/**
|
|
821
1431
|
* @public
|
|
822
|
-
* <p>The error details.</p>
|
|
823
1432
|
*/
|
|
824
|
-
export interface
|
|
1433
|
+
export interface GetMetadataTransferJobResponse {
|
|
825
1434
|
/**
|
|
826
1435
|
* @public
|
|
827
|
-
* <p>The
|
|
1436
|
+
* <p>The metadata transfer job Id.</p>
|
|
828
1437
|
*/
|
|
829
|
-
|
|
1438
|
+
metadataTransferJobId: string | undefined;
|
|
830
1439
|
/**
|
|
831
1440
|
* @public
|
|
832
|
-
* <p>The
|
|
1441
|
+
* <p>The metadata transfer job ARN.</p>
|
|
833
1442
|
*/
|
|
834
|
-
|
|
835
|
-
}
|
|
836
|
-
/**
|
|
837
|
-
* @public
|
|
838
|
-
* <p>An object that represents the status of an entity, component, component type, or
|
|
839
|
-
* workspace.</p>
|
|
840
|
-
*/
|
|
841
|
-
export interface Status {
|
|
1443
|
+
arn: string | undefined;
|
|
842
1444
|
/**
|
|
843
1445
|
* @public
|
|
844
|
-
* <p>The
|
|
1446
|
+
* <p>The metadata transfer job description.</p>
|
|
845
1447
|
*/
|
|
846
|
-
|
|
1448
|
+
description?: string;
|
|
847
1449
|
/**
|
|
848
1450
|
* @public
|
|
849
|
-
* <p>The
|
|
1451
|
+
* <p>The metadata transfer job's sources.</p>
|
|
850
1452
|
*/
|
|
851
|
-
|
|
852
|
-
}
|
|
853
|
-
/**
|
|
854
|
-
* @public
|
|
855
|
-
*/
|
|
856
|
-
export interface GetEntityRequest {
|
|
1453
|
+
sources: SourceConfiguration[] | undefined;
|
|
857
1454
|
/**
|
|
858
1455
|
* @public
|
|
859
|
-
* <p>The
|
|
1456
|
+
* <p>The metadata transfer job's destination.</p>
|
|
860
1457
|
*/
|
|
861
|
-
|
|
1458
|
+
destination: DestinationConfiguration | undefined;
|
|
862
1459
|
/**
|
|
863
1460
|
* @public
|
|
864
|
-
* <p>The
|
|
1461
|
+
* <p>The metadata transfer job's role.</p>
|
|
865
1462
|
*/
|
|
866
|
-
|
|
867
|
-
}
|
|
868
|
-
/**
|
|
869
|
-
* @public
|
|
870
|
-
* <p>The component property group response.</p>
|
|
871
|
-
*/
|
|
872
|
-
export interface ComponentPropertyGroupResponse {
|
|
1463
|
+
metadataTransferJobRole: string | undefined;
|
|
873
1464
|
/**
|
|
874
1465
|
* @public
|
|
875
|
-
* <p>The
|
|
1466
|
+
* <p>The metadata transfer job's report URL.</p>
|
|
876
1467
|
*/
|
|
877
|
-
|
|
1468
|
+
reportUrl?: string;
|
|
878
1469
|
/**
|
|
879
1470
|
* @public
|
|
880
|
-
* <p>The
|
|
1471
|
+
* <p>The metadata transfer job's creation DateTime property.</p>
|
|
881
1472
|
*/
|
|
882
|
-
|
|
1473
|
+
creationDateTime: Date | undefined;
|
|
883
1474
|
/**
|
|
884
1475
|
* @public
|
|
885
|
-
* <p>
|
|
886
|
-
* entity</p>
|
|
1476
|
+
* <p>The metadata transfer job's update DateTime property.</p>
|
|
887
1477
|
*/
|
|
888
|
-
|
|
1478
|
+
updateDateTime: Date | undefined;
|
|
1479
|
+
/**
|
|
1480
|
+
* @public
|
|
1481
|
+
* <p>The metadata transfer job's status.</p>
|
|
1482
|
+
*/
|
|
1483
|
+
status: MetadataTransferJobStatus | undefined;
|
|
1484
|
+
/**
|
|
1485
|
+
* @public
|
|
1486
|
+
* <p>The metadata transfer job's progress.</p>
|
|
1487
|
+
*/
|
|
1488
|
+
progress?: MetadataTransferJobProgress;
|
|
889
1489
|
}
|
|
890
1490
|
/**
|
|
891
1491
|
* @public
|
|
@@ -1301,17 +1901,22 @@ export interface GetWorkspaceResponse {
|
|
|
1301
1901
|
* <p>The description of the workspace.</p>
|
|
1302
1902
|
*/
|
|
1303
1903
|
description?: string;
|
|
1904
|
+
/**
|
|
1905
|
+
* @public
|
|
1906
|
+
* <p>A list of services that are linked to the workspace.</p>
|
|
1907
|
+
*/
|
|
1908
|
+
linkedServices?: string[];
|
|
1304
1909
|
/**
|
|
1305
1910
|
* @public
|
|
1306
1911
|
* <p>The ARN of the S3 bucket where resources associated with the workspace are
|
|
1307
1912
|
* stored.</p>
|
|
1308
1913
|
*/
|
|
1309
|
-
s3Location
|
|
1914
|
+
s3Location?: string;
|
|
1310
1915
|
/**
|
|
1311
1916
|
* @public
|
|
1312
1917
|
* <p>The ARN of the execution role associated with the workspace.</p>
|
|
1313
1918
|
*/
|
|
1314
|
-
role
|
|
1919
|
+
role?: string;
|
|
1315
1920
|
/**
|
|
1316
1921
|
* @public
|
|
1317
1922
|
* <p>The date and time when the workspace was created.</p>
|
|
@@ -1323,6 +1928,51 @@ export interface GetWorkspaceResponse {
|
|
|
1323
1928
|
*/
|
|
1324
1929
|
updateDateTime: Date | undefined;
|
|
1325
1930
|
}
|
|
1931
|
+
/**
|
|
1932
|
+
* @public
|
|
1933
|
+
*/
|
|
1934
|
+
export interface ListComponentsRequest {
|
|
1935
|
+
/**
|
|
1936
|
+
* @public
|
|
1937
|
+
* <p>The workspace ID.</p>
|
|
1938
|
+
*/
|
|
1939
|
+
workspaceId: string | undefined;
|
|
1940
|
+
/**
|
|
1941
|
+
* @public
|
|
1942
|
+
* <p>The ID for the entity whose metadata (component/properties) is returned by the operation.</p>
|
|
1943
|
+
*/
|
|
1944
|
+
entityId: string | undefined;
|
|
1945
|
+
/**
|
|
1946
|
+
* @public
|
|
1947
|
+
* <p>This string specifies the path to the composite component, starting from the top-level component.</p>
|
|
1948
|
+
*/
|
|
1949
|
+
componentPath?: string;
|
|
1950
|
+
/**
|
|
1951
|
+
* @public
|
|
1952
|
+
* <p>The maximum number of results returned at one time. The default is 25.</p>
|
|
1953
|
+
*/
|
|
1954
|
+
maxResults?: number;
|
|
1955
|
+
/**
|
|
1956
|
+
* @public
|
|
1957
|
+
* <p>The string that specifies the next page of results.</p>
|
|
1958
|
+
*/
|
|
1959
|
+
nextToken?: string;
|
|
1960
|
+
}
|
|
1961
|
+
/**
|
|
1962
|
+
* @public
|
|
1963
|
+
*/
|
|
1964
|
+
export interface ListComponentsResponse {
|
|
1965
|
+
/**
|
|
1966
|
+
* @public
|
|
1967
|
+
* <p>A list of objects that contain information about the components.</p>
|
|
1968
|
+
*/
|
|
1969
|
+
componentSummaries: ComponentSummary[] | undefined;
|
|
1970
|
+
/**
|
|
1971
|
+
* @public
|
|
1972
|
+
* <p>The string that specifies the next page of component results.</p>
|
|
1973
|
+
*/
|
|
1974
|
+
nextToken?: string;
|
|
1975
|
+
}
|
|
1326
1976
|
/**
|
|
1327
1977
|
* @public
|
|
1328
1978
|
* <p>An object that filters items in a list of component types.</p>
|
|
@@ -1461,166 +2111,324 @@ export interface ListComponentTypesResponse {
|
|
|
1461
2111
|
workspaceId: string | undefined;
|
|
1462
2112
|
/**
|
|
1463
2113
|
* @public
|
|
1464
|
-
* <p>A list of objects that contain information about the component types.</p>
|
|
2114
|
+
* <p>A list of objects that contain information about the component types.</p>
|
|
2115
|
+
*/
|
|
2116
|
+
componentTypeSummaries: ComponentTypeSummary[] | undefined;
|
|
2117
|
+
/**
|
|
2118
|
+
* @public
|
|
2119
|
+
* <p>The string that specifies the next page of results.</p>
|
|
2120
|
+
*/
|
|
2121
|
+
nextToken?: string;
|
|
2122
|
+
/**
|
|
2123
|
+
* @public
|
|
2124
|
+
* <p>Specifies the maximum number of results to display.</p>
|
|
2125
|
+
*/
|
|
2126
|
+
maxResults?: number;
|
|
2127
|
+
}
|
|
2128
|
+
/**
|
|
2129
|
+
* @public
|
|
2130
|
+
* <p>An object that filters items in a list of entities.</p>
|
|
2131
|
+
*/
|
|
2132
|
+
export type ListEntitiesFilter = ListEntitiesFilter.ComponentTypeIdMember | ListEntitiesFilter.ExternalIdMember | ListEntitiesFilter.ParentEntityIdMember | ListEntitiesFilter.$UnknownMember;
|
|
2133
|
+
/**
|
|
2134
|
+
* @public
|
|
2135
|
+
*/
|
|
2136
|
+
export declare namespace ListEntitiesFilter {
|
|
2137
|
+
/**
|
|
2138
|
+
* @public
|
|
2139
|
+
* <p>The parent of the entities in the list.</p>
|
|
2140
|
+
*/
|
|
2141
|
+
interface ParentEntityIdMember {
|
|
2142
|
+
parentEntityId: string;
|
|
2143
|
+
componentTypeId?: never;
|
|
2144
|
+
externalId?: never;
|
|
2145
|
+
$unknown?: never;
|
|
2146
|
+
}
|
|
2147
|
+
/**
|
|
2148
|
+
* @public
|
|
2149
|
+
* <p>The ID of the component type in the entities in the list.</p>
|
|
2150
|
+
*/
|
|
2151
|
+
interface ComponentTypeIdMember {
|
|
2152
|
+
parentEntityId?: never;
|
|
2153
|
+
componentTypeId: string;
|
|
2154
|
+
externalId?: never;
|
|
2155
|
+
$unknown?: never;
|
|
2156
|
+
}
|
|
2157
|
+
/**
|
|
2158
|
+
* @public
|
|
2159
|
+
* <p>The external-Id property of a component. The external-Id property is the primary key of
|
|
2160
|
+
* an external storage system.</p>
|
|
2161
|
+
*/
|
|
2162
|
+
interface ExternalIdMember {
|
|
2163
|
+
parentEntityId?: never;
|
|
2164
|
+
componentTypeId?: never;
|
|
2165
|
+
externalId: string;
|
|
2166
|
+
$unknown?: never;
|
|
2167
|
+
}
|
|
2168
|
+
/**
|
|
2169
|
+
* @public
|
|
2170
|
+
*/
|
|
2171
|
+
interface $UnknownMember {
|
|
2172
|
+
parentEntityId?: never;
|
|
2173
|
+
componentTypeId?: never;
|
|
2174
|
+
externalId?: never;
|
|
2175
|
+
$unknown: [string, any];
|
|
2176
|
+
}
|
|
2177
|
+
interface Visitor<T> {
|
|
2178
|
+
parentEntityId: (value: string) => T;
|
|
2179
|
+
componentTypeId: (value: string) => T;
|
|
2180
|
+
externalId: (value: string) => T;
|
|
2181
|
+
_: (name: string, value: any) => T;
|
|
2182
|
+
}
|
|
2183
|
+
const visit: <T>(value: ListEntitiesFilter, visitor: Visitor<T>) => T;
|
|
2184
|
+
}
|
|
2185
|
+
/**
|
|
2186
|
+
* @public
|
|
2187
|
+
*/
|
|
2188
|
+
export interface ListEntitiesRequest {
|
|
2189
|
+
/**
|
|
2190
|
+
* @public
|
|
2191
|
+
* <p>The ID of the workspace.</p>
|
|
2192
|
+
*/
|
|
2193
|
+
workspaceId: string | undefined;
|
|
2194
|
+
/**
|
|
2195
|
+
* @public
|
|
2196
|
+
* <p>A list of objects that filter the request.</p>
|
|
2197
|
+
* <note>
|
|
2198
|
+
* <p>Only one object is accepted as a valid input.</p>
|
|
2199
|
+
* </note>
|
|
2200
|
+
*/
|
|
2201
|
+
filters?: ListEntitiesFilter[];
|
|
2202
|
+
/**
|
|
2203
|
+
* @public
|
|
2204
|
+
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
2205
|
+
* <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
|
|
2206
|
+
*/
|
|
2207
|
+
maxResults?: number;
|
|
2208
|
+
/**
|
|
2209
|
+
* @public
|
|
2210
|
+
* <p>The string that specifies the next page of results.</p>
|
|
2211
|
+
*/
|
|
2212
|
+
nextToken?: string;
|
|
2213
|
+
}
|
|
2214
|
+
/**
|
|
2215
|
+
* @public
|
|
2216
|
+
* <p>An object that contains information about an entity.</p>
|
|
2217
|
+
*/
|
|
2218
|
+
export interface EntitySummary {
|
|
2219
|
+
/**
|
|
2220
|
+
* @public
|
|
2221
|
+
* <p>The ID of the entity.</p>
|
|
2222
|
+
*/
|
|
2223
|
+
entityId: string | undefined;
|
|
2224
|
+
/**
|
|
2225
|
+
* @public
|
|
2226
|
+
* <p>The name of the entity.</p>
|
|
2227
|
+
*/
|
|
2228
|
+
entityName: string | undefined;
|
|
2229
|
+
/**
|
|
2230
|
+
* @public
|
|
2231
|
+
* <p>The ARN of the entity.</p>
|
|
2232
|
+
*/
|
|
2233
|
+
arn: string | undefined;
|
|
2234
|
+
/**
|
|
2235
|
+
* @public
|
|
2236
|
+
* <p>The ID of the parent entity.</p>
|
|
2237
|
+
*/
|
|
2238
|
+
parentEntityId?: string;
|
|
2239
|
+
/**
|
|
2240
|
+
* @public
|
|
2241
|
+
* <p>The current status of the entity.</p>
|
|
2242
|
+
*/
|
|
2243
|
+
status: Status | undefined;
|
|
2244
|
+
/**
|
|
2245
|
+
* @public
|
|
2246
|
+
* <p>The description of the entity.</p>
|
|
2247
|
+
*/
|
|
2248
|
+
description?: string;
|
|
2249
|
+
/**
|
|
2250
|
+
* @public
|
|
2251
|
+
* <p>An <b>eventual</b> Boolean value that specifies whether the entity has child entities or not.</p>
|
|
2252
|
+
*/
|
|
2253
|
+
hasChildEntities?: boolean;
|
|
2254
|
+
/**
|
|
2255
|
+
* @public
|
|
2256
|
+
* <p>The date and time when the entity was created.</p>
|
|
2257
|
+
*/
|
|
2258
|
+
creationDateTime: Date | undefined;
|
|
2259
|
+
/**
|
|
2260
|
+
* @public
|
|
2261
|
+
* <p>The last date and time when the entity was updated.</p>
|
|
2262
|
+
*/
|
|
2263
|
+
updateDateTime: Date | undefined;
|
|
2264
|
+
}
|
|
2265
|
+
/**
|
|
2266
|
+
* @public
|
|
2267
|
+
*/
|
|
2268
|
+
export interface ListEntitiesResponse {
|
|
2269
|
+
/**
|
|
2270
|
+
* @public
|
|
2271
|
+
* <p>A list of objects that contain information about the entities.</p>
|
|
1465
2272
|
*/
|
|
1466
|
-
|
|
2273
|
+
entitySummaries?: EntitySummary[];
|
|
1467
2274
|
/**
|
|
1468
2275
|
* @public
|
|
1469
2276
|
* <p>The string that specifies the next page of results.</p>
|
|
1470
2277
|
*/
|
|
1471
2278
|
nextToken?: string;
|
|
1472
|
-
/**
|
|
1473
|
-
* @public
|
|
1474
|
-
* <p>Specifies the maximum number of results to display.</p>
|
|
1475
|
-
*/
|
|
1476
|
-
maxResults?: number;
|
|
1477
2279
|
}
|
|
1478
2280
|
/**
|
|
1479
2281
|
* @public
|
|
1480
|
-
* <p>
|
|
2282
|
+
* <p>The ListMetadataTransferJobs filter.</p>
|
|
1481
2283
|
*/
|
|
1482
|
-
export type
|
|
2284
|
+
export type ListMetadataTransferJobsFilter = ListMetadataTransferJobsFilter.StateMember | ListMetadataTransferJobsFilter.WorkspaceIdMember | ListMetadataTransferJobsFilter.$UnknownMember;
|
|
1483
2285
|
/**
|
|
1484
2286
|
* @public
|
|
1485
2287
|
*/
|
|
1486
|
-
export declare namespace
|
|
2288
|
+
export declare namespace ListMetadataTransferJobsFilter {
|
|
1487
2289
|
/**
|
|
1488
2290
|
* @public
|
|
1489
|
-
* <p>The
|
|
1490
|
-
*/
|
|
1491
|
-
interface ParentEntityIdMember {
|
|
1492
|
-
parentEntityId: string;
|
|
1493
|
-
componentTypeId?: never;
|
|
1494
|
-
externalId?: never;
|
|
1495
|
-
$unknown?: never;
|
|
1496
|
-
}
|
|
1497
|
-
/**
|
|
1498
|
-
* @public
|
|
1499
|
-
* <p>The ID of the component type in the entities in the list.</p>
|
|
2291
|
+
* <p>The workspace Id.</p>
|
|
1500
2292
|
*/
|
|
1501
|
-
interface
|
|
1502
|
-
|
|
1503
|
-
|
|
1504
|
-
externalId?: never;
|
|
2293
|
+
interface WorkspaceIdMember {
|
|
2294
|
+
workspaceId: string;
|
|
2295
|
+
state?: never;
|
|
1505
2296
|
$unknown?: never;
|
|
1506
2297
|
}
|
|
1507
2298
|
/**
|
|
1508
2299
|
* @public
|
|
1509
|
-
* <p>The
|
|
1510
|
-
* an external storage system.</p>
|
|
2300
|
+
* <p>The filter state.</p>
|
|
1511
2301
|
*/
|
|
1512
|
-
interface
|
|
1513
|
-
|
|
1514
|
-
|
|
1515
|
-
externalId: string;
|
|
2302
|
+
interface StateMember {
|
|
2303
|
+
workspaceId?: never;
|
|
2304
|
+
state: MetadataTransferJobState;
|
|
1516
2305
|
$unknown?: never;
|
|
1517
2306
|
}
|
|
1518
2307
|
/**
|
|
1519
2308
|
* @public
|
|
1520
2309
|
*/
|
|
1521
2310
|
interface $UnknownMember {
|
|
1522
|
-
|
|
1523
|
-
|
|
1524
|
-
externalId?: never;
|
|
2311
|
+
workspaceId?: never;
|
|
2312
|
+
state?: never;
|
|
1525
2313
|
$unknown: [string, any];
|
|
1526
2314
|
}
|
|
1527
2315
|
interface Visitor<T> {
|
|
1528
|
-
|
|
1529
|
-
|
|
1530
|
-
externalId: (value: string) => T;
|
|
2316
|
+
workspaceId: (value: string) => T;
|
|
2317
|
+
state: (value: MetadataTransferJobState) => T;
|
|
1531
2318
|
_: (name: string, value: any) => T;
|
|
1532
2319
|
}
|
|
1533
|
-
const visit: <T>(value:
|
|
2320
|
+
const visit: <T>(value: ListMetadataTransferJobsFilter, visitor: Visitor<T>) => T;
|
|
1534
2321
|
}
|
|
1535
2322
|
/**
|
|
1536
2323
|
* @public
|
|
1537
2324
|
*/
|
|
1538
|
-
export interface
|
|
2325
|
+
export interface ListMetadataTransferJobsRequest {
|
|
1539
2326
|
/**
|
|
1540
2327
|
* @public
|
|
1541
|
-
* <p>The
|
|
2328
|
+
* <p>The metadata transfer job's source type.</p>
|
|
1542
2329
|
*/
|
|
1543
|
-
|
|
2330
|
+
sourceType: SourceType | undefined;
|
|
1544
2331
|
/**
|
|
1545
2332
|
* @public
|
|
1546
|
-
* <p>
|
|
1547
|
-
* <note>
|
|
1548
|
-
* <p>Only one object is accepted as a valid input.</p>
|
|
1549
|
-
* </note>
|
|
2333
|
+
* <p>The metadata transfer job's destination type.</p>
|
|
1550
2334
|
*/
|
|
1551
|
-
|
|
2335
|
+
destinationType: DestinationType | undefined;
|
|
1552
2336
|
/**
|
|
1553
2337
|
* @public
|
|
1554
|
-
* <p>
|
|
1555
|
-
* <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
|
|
2338
|
+
* <p>An object that filters metadata transfer jobs.</p>
|
|
1556
2339
|
*/
|
|
1557
|
-
|
|
2340
|
+
filters?: ListMetadataTransferJobsFilter[];
|
|
1558
2341
|
/**
|
|
1559
2342
|
* @public
|
|
1560
2343
|
* <p>The string that specifies the next page of results.</p>
|
|
1561
2344
|
*/
|
|
1562
2345
|
nextToken?: string;
|
|
2346
|
+
/**
|
|
2347
|
+
* @public
|
|
2348
|
+
* <p>The maximum number of results to return at one time.</p>
|
|
2349
|
+
*/
|
|
2350
|
+
maxResults?: number;
|
|
1563
2351
|
}
|
|
1564
2352
|
/**
|
|
1565
2353
|
* @public
|
|
1566
|
-
* <p>
|
|
2354
|
+
* <p>The metadata transfer job summary.</p>
|
|
1567
2355
|
*/
|
|
1568
|
-
export interface
|
|
2356
|
+
export interface MetadataTransferJobSummary {
|
|
1569
2357
|
/**
|
|
1570
2358
|
* @public
|
|
1571
|
-
* <p>The
|
|
1572
|
-
*/
|
|
1573
|
-
entityId: string | undefined;
|
|
1574
|
-
/**
|
|
1575
|
-
* @public
|
|
1576
|
-
* <p>The name of the entity.</p>
|
|
2359
|
+
* <p>The metadata transfer job summary Id.</p>
|
|
1577
2360
|
*/
|
|
1578
|
-
|
|
2361
|
+
metadataTransferJobId: string | undefined;
|
|
1579
2362
|
/**
|
|
1580
2363
|
* @public
|
|
1581
|
-
* <p>The
|
|
2364
|
+
* <p>The metadata transfer job summary ARN.</p>
|
|
1582
2365
|
*/
|
|
1583
2366
|
arn: string | undefined;
|
|
1584
2367
|
/**
|
|
1585
2368
|
* @public
|
|
1586
|
-
* <p>The
|
|
2369
|
+
* <p>The metadata transfer job summary creation DateTime object.</p>
|
|
1587
2370
|
*/
|
|
1588
|
-
|
|
2371
|
+
creationDateTime: Date | undefined;
|
|
1589
2372
|
/**
|
|
1590
2373
|
* @public
|
|
1591
|
-
* <p>The
|
|
2374
|
+
* <p>The metadata transfer job summary update DateTime object</p>
|
|
1592
2375
|
*/
|
|
1593
|
-
|
|
2376
|
+
updateDateTime: Date | undefined;
|
|
1594
2377
|
/**
|
|
1595
2378
|
* @public
|
|
1596
|
-
* <p>The
|
|
2379
|
+
* <p>The metadata transfer job summary status.</p>
|
|
1597
2380
|
*/
|
|
1598
|
-
|
|
2381
|
+
status: MetadataTransferJobStatus | undefined;
|
|
1599
2382
|
/**
|
|
1600
2383
|
* @public
|
|
1601
|
-
* <p>
|
|
2384
|
+
* <p>The metadata transfer job summary progess.</p>
|
|
1602
2385
|
*/
|
|
1603
|
-
|
|
2386
|
+
progress?: MetadataTransferJobProgress;
|
|
2387
|
+
}
|
|
2388
|
+
/**
|
|
2389
|
+
* @public
|
|
2390
|
+
*/
|
|
2391
|
+
export interface ListMetadataTransferJobsResponse {
|
|
1604
2392
|
/**
|
|
1605
2393
|
* @public
|
|
1606
|
-
* <p>The
|
|
2394
|
+
* <p>The metadata transfer job summaries.</p>
|
|
1607
2395
|
*/
|
|
1608
|
-
|
|
2396
|
+
metadataTransferJobSummaries: MetadataTransferJobSummary[] | undefined;
|
|
1609
2397
|
/**
|
|
1610
2398
|
* @public
|
|
1611
|
-
* <p>The
|
|
2399
|
+
* <p>The string that specifies the next page of results.</p>
|
|
1612
2400
|
*/
|
|
1613
|
-
|
|
2401
|
+
nextToken?: string;
|
|
1614
2402
|
}
|
|
1615
2403
|
/**
|
|
1616
2404
|
* @public
|
|
1617
2405
|
*/
|
|
1618
|
-
export interface
|
|
2406
|
+
export interface ListPropertiesRequest {
|
|
1619
2407
|
/**
|
|
1620
2408
|
* @public
|
|
1621
|
-
* <p>
|
|
2409
|
+
* <p>The workspace ID.</p>
|
|
1622
2410
|
*/
|
|
1623
|
-
|
|
2411
|
+
workspaceId: string | undefined;
|
|
2412
|
+
/**
|
|
2413
|
+
* @public
|
|
2414
|
+
* <p>The name of the component whose properties are returned by the operation.</p>
|
|
2415
|
+
*/
|
|
2416
|
+
componentName?: string;
|
|
2417
|
+
/**
|
|
2418
|
+
* @public
|
|
2419
|
+
* <p>This string specifies the path to the composite component, starting from the top-level component.</p>
|
|
2420
|
+
*/
|
|
2421
|
+
componentPath?: string;
|
|
2422
|
+
/**
|
|
2423
|
+
* @public
|
|
2424
|
+
* <p>The ID for the entity whose metadata (component/properties) is returned by the operation.</p>
|
|
2425
|
+
*/
|
|
2426
|
+
entityId: string | undefined;
|
|
2427
|
+
/**
|
|
2428
|
+
* @public
|
|
2429
|
+
* <p>The maximum number of results returned at one time. The default is 25.</p>
|
|
2430
|
+
*/
|
|
2431
|
+
maxResults?: number;
|
|
1624
2432
|
/**
|
|
1625
2433
|
* @public
|
|
1626
2434
|
* <p>The string that specifies the next page of results.</p>
|
|
@@ -2049,6 +2857,11 @@ export interface WorkspaceSummary {
|
|
|
2049
2857
|
* <p>The description of the workspace.</p>
|
|
2050
2858
|
*/
|
|
2051
2859
|
description?: string;
|
|
2860
|
+
/**
|
|
2861
|
+
* @public
|
|
2862
|
+
* <p>A list of services that are linked to the workspace.</p>
|
|
2863
|
+
*/
|
|
2864
|
+
linkedServices?: string[];
|
|
2052
2865
|
/**
|
|
2053
2866
|
* @public
|
|
2054
2867
|
* <p>The date and time when the workspace was created.</p>
|
|
@@ -2303,6 +3116,12 @@ export interface UpdateWorkspaceRequest {
|
|
|
2303
3116
|
* <p>The ARN of the execution role associated with the workspace.</p>
|
|
2304
3117
|
*/
|
|
2305
3118
|
role?: string;
|
|
3119
|
+
/**
|
|
3120
|
+
* @public
|
|
3121
|
+
* <p>The ARN of the S3 bucket where resources associated with the workspace are
|
|
3122
|
+
* stored.</p>
|
|
3123
|
+
*/
|
|
3124
|
+
s3Location?: string;
|
|
2306
3125
|
}
|
|
2307
3126
|
/**
|
|
2308
3127
|
* @public
|
|
@@ -2518,6 +3337,11 @@ export interface GetPropertyValueHistoryRequest {
|
|
|
2518
3337
|
* <p>The name of the component.</p>
|
|
2519
3338
|
*/
|
|
2520
3339
|
componentName?: string;
|
|
3340
|
+
/**
|
|
3341
|
+
* @public
|
|
3342
|
+
* <p>This string specifies the path to the composite component, starting from the top-level component.</p>
|
|
3343
|
+
*/
|
|
3344
|
+
componentPath?: string;
|
|
2521
3345
|
/**
|
|
2522
3346
|
* @public
|
|
2523
3347
|
* <p>The ID of the component type.</p>
|
|
@@ -2668,6 +3492,11 @@ export interface GetPropertyValueRequest {
|
|
|
2668
3492
|
* <p>The name of the component whose property values the operation returns.</p>
|
|
2669
3493
|
*/
|
|
2670
3494
|
componentName?: string;
|
|
3495
|
+
/**
|
|
3496
|
+
* @public
|
|
3497
|
+
* <p>This string specifies the path to the composite component, starting from the top-level component.</p>
|
|
3498
|
+
*/
|
|
3499
|
+
componentPath?: string;
|
|
2671
3500
|
/**
|
|
2672
3501
|
* @public
|
|
2673
3502
|
* <p>The ID of the component type whose property values the operation returns.</p>
|
|
@@ -2955,6 +3784,12 @@ export interface CreateComponentTypeRequest {
|
|
|
2955
3784
|
* <p>A friendly name for the component type.</p>
|
|
2956
3785
|
*/
|
|
2957
3786
|
componentTypeName?: string;
|
|
3787
|
+
/**
|
|
3788
|
+
* @public
|
|
3789
|
+
* <p>This is an object that maps strings to <code>compositeComponentTypes</code> of the <code>componentType</code>.
|
|
3790
|
+
* <code>CompositeComponentType</code> is referenced by <code>componentTypeId</code>.</p>
|
|
3791
|
+
*/
|
|
3792
|
+
compositeComponentTypes?: Record<string, CompositeComponentTypeRequest>;
|
|
2958
3793
|
}
|
|
2959
3794
|
/**
|
|
2960
3795
|
* @public
|
|
@@ -3045,6 +3880,11 @@ export interface GetComponentTypeResponse {
|
|
|
3045
3880
|
* <p>The component type name.</p>
|
|
3046
3881
|
*/
|
|
3047
3882
|
componentTypeName?: string;
|
|
3883
|
+
/**
|
|
3884
|
+
* @public
|
|
3885
|
+
* <p>This is an object that maps strings to <code>compositeComponentTypes</code> of the <code>componentType</code>. <code>CompositeComponentType</code> is referenced by <code>componentTypeId</code>.</p>
|
|
3886
|
+
*/
|
|
3887
|
+
compositeComponentTypes?: Record<string, CompositeComponentTypeResponse>;
|
|
3048
3888
|
}
|
|
3049
3889
|
/**
|
|
3050
3890
|
* @public
|
|
@@ -3098,6 +3938,12 @@ export interface UpdateComponentTypeRequest {
|
|
|
3098
3938
|
* <p>The component type name.</p>
|
|
3099
3939
|
*/
|
|
3100
3940
|
componentTypeName?: string;
|
|
3941
|
+
/**
|
|
3942
|
+
* @public
|
|
3943
|
+
* <p>This is an object that maps strings to <code>compositeComponentTypes</code> of the <code>componentType</code>.
|
|
3944
|
+
* <code>CompositeComponentType</code> is referenced by <code>componentTypeId</code>.</p>
|
|
3945
|
+
*/
|
|
3946
|
+
compositeComponentTypes?: Record<string, CompositeComponentTypeRequest>;
|
|
3101
3947
|
}
|
|
3102
3948
|
/**
|
|
3103
3949
|
* @public
|
|
@@ -3135,6 +3981,38 @@ export interface PropertyResponse {
|
|
|
3135
3981
|
* <p>The value of the property.</p>
|
|
3136
3982
|
*/
|
|
3137
3983
|
value?: DataValue;
|
|
3984
|
+
/**
|
|
3985
|
+
* @public
|
|
3986
|
+
* <p>This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.</p>
|
|
3987
|
+
*/
|
|
3988
|
+
areAllPropertyValuesReturned?: boolean;
|
|
3989
|
+
}
|
|
3990
|
+
/**
|
|
3991
|
+
* @public
|
|
3992
|
+
* <p>This is an object that contains the information of a property.</p>
|
|
3993
|
+
*/
|
|
3994
|
+
export interface PropertySummary {
|
|
3995
|
+
/**
|
|
3996
|
+
* @public
|
|
3997
|
+
* <p>This is the schema for the property.</p>
|
|
3998
|
+
*/
|
|
3999
|
+
definition?: PropertyDefinitionResponse;
|
|
4000
|
+
/**
|
|
4001
|
+
* @public
|
|
4002
|
+
* <p>This is the name of the property.</p>
|
|
4003
|
+
*/
|
|
4004
|
+
propertyName: string | undefined;
|
|
4005
|
+
/**
|
|
4006
|
+
* @public
|
|
4007
|
+
* <p>This is the value for the property.</p>
|
|
4008
|
+
*/
|
|
4009
|
+
value?: DataValue;
|
|
4010
|
+
/**
|
|
4011
|
+
* @public
|
|
4012
|
+
* <p>This flag notes whether all values of a list or map type property are returned in the API
|
|
4013
|
+
* response. The maximum number of values per property returned is 50.</p>
|
|
4014
|
+
*/
|
|
4015
|
+
areAllPropertyValuesReturned?: boolean;
|
|
3138
4016
|
}
|
|
3139
4017
|
/**
|
|
3140
4018
|
* @public
|
|
@@ -3210,6 +4088,23 @@ export interface ComponentResponse {
|
|
|
3210
4088
|
* <p>The syncSource of the sync job, if this entity was created by a sync job.</p>
|
|
3211
4089
|
*/
|
|
3212
4090
|
syncSource?: string;
|
|
4091
|
+
/**
|
|
4092
|
+
* @public
|
|
4093
|
+
* <p>This flag notes whether all properties of the component are returned in the API response.
|
|
4094
|
+
* The maximum number of properties returned is 800.</p>
|
|
4095
|
+
*/
|
|
4096
|
+
areAllPropertiesReturned?: boolean;
|
|
4097
|
+
/**
|
|
4098
|
+
* @public
|
|
4099
|
+
* <p>This lists objects that contain information about the <code>compositeComponents</code>.</p>
|
|
4100
|
+
*/
|
|
4101
|
+
compositeComponents?: Record<string, ComponentSummary>;
|
|
4102
|
+
/**
|
|
4103
|
+
* @public
|
|
4104
|
+
* <p>This flag notes whether all <code>compositeComponents</code> are returned in the API
|
|
4105
|
+
* response.</p>
|
|
4106
|
+
*/
|
|
4107
|
+
areAllCompositeComponentsReturned?: boolean;
|
|
3213
4108
|
}
|
|
3214
4109
|
/**
|
|
3215
4110
|
* @public
|
|
@@ -3245,44 +4140,66 @@ export interface ComponentUpdateRequest {
|
|
|
3245
4140
|
}
|
|
3246
4141
|
/**
|
|
3247
4142
|
* @public
|
|
4143
|
+
* <p>An object that sets information about the composite component update request.</p>
|
|
3248
4144
|
*/
|
|
3249
|
-
export interface
|
|
4145
|
+
export interface CompositeComponentRequest {
|
|
3250
4146
|
/**
|
|
3251
4147
|
* @public
|
|
3252
|
-
* <p>The
|
|
4148
|
+
* <p>The description of the component type.</p>
|
|
3253
4149
|
*/
|
|
3254
|
-
|
|
4150
|
+
description?: string;
|
|
3255
4151
|
/**
|
|
3256
4152
|
* @public
|
|
3257
|
-
* <p>
|
|
4153
|
+
* <p>This is an object that maps strings to the properties to set in the component type. Each string in
|
|
4154
|
+
* the mapping must be unique to this object.</p>
|
|
3258
4155
|
*/
|
|
3259
|
-
|
|
4156
|
+
properties?: Record<string, PropertyRequest>;
|
|
3260
4157
|
/**
|
|
3261
4158
|
* @public
|
|
3262
|
-
* <p>The
|
|
4159
|
+
* <p>The property groups.</p>
|
|
3263
4160
|
*/
|
|
3264
|
-
|
|
4161
|
+
propertyGroups?: Record<string, ComponentPropertyGroupRequest>;
|
|
4162
|
+
}
|
|
4163
|
+
/**
|
|
4164
|
+
* @public
|
|
4165
|
+
* <p>An object that sets information about the composite component update request.</p>
|
|
4166
|
+
*/
|
|
4167
|
+
export interface CompositeComponentUpdateRequest {
|
|
3265
4168
|
/**
|
|
3266
4169
|
* @public
|
|
3267
|
-
* <p>The
|
|
4170
|
+
* <p>The update type of the component update request.</p>
|
|
4171
|
+
*/
|
|
4172
|
+
updateType?: ComponentUpdateType;
|
|
4173
|
+
/**
|
|
4174
|
+
* @public
|
|
4175
|
+
* <p>The description of the component type.</p>
|
|
3268
4176
|
*/
|
|
3269
4177
|
description?: string;
|
|
3270
4178
|
/**
|
|
3271
4179
|
* @public
|
|
3272
|
-
* <p>An object that maps strings to the
|
|
3273
|
-
* must be unique to this object.</p>
|
|
4180
|
+
* <p>An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.</p>
|
|
3274
4181
|
*/
|
|
3275
|
-
|
|
4182
|
+
propertyUpdates?: Record<string, PropertyRequest>;
|
|
3276
4183
|
/**
|
|
3277
4184
|
* @public
|
|
3278
|
-
* <p>The
|
|
4185
|
+
* <p>The property group updates.</p>
|
|
3279
4186
|
*/
|
|
3280
|
-
|
|
4187
|
+
propertyGroupUpdates?: Record<string, ComponentPropertyGroupRequest>;
|
|
4188
|
+
}
|
|
4189
|
+
/**
|
|
4190
|
+
* @public
|
|
4191
|
+
*/
|
|
4192
|
+
export interface ListPropertiesResponse {
|
|
3281
4193
|
/**
|
|
3282
4194
|
* @public
|
|
3283
|
-
* <p>
|
|
4195
|
+
* <p>A list of objects that contain information about the properties.</p>
|
|
3284
4196
|
*/
|
|
3285
|
-
|
|
4197
|
+
propertySummaries: PropertySummary[] | undefined;
|
|
4198
|
+
/**
|
|
4199
|
+
* @public
|
|
4200
|
+
* <p>The string that specifies the next page of property results.</p>
|
|
4201
|
+
*/
|
|
4202
|
+
nextToken?: string;
|
|
3286
4203
|
}
|
|
3287
4204
|
/**
|
|
3288
4205
|
* @public
|
|
@@ -3349,6 +4266,58 @@ export interface GetEntityResponse {
|
|
|
3349
4266
|
* <p>The syncSource of the sync job, if this entity was created by a sync job.</p>
|
|
3350
4267
|
*/
|
|
3351
4268
|
syncSource?: string;
|
|
4269
|
+
/**
|
|
4270
|
+
* @public
|
|
4271
|
+
* <p>This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.</p>
|
|
4272
|
+
*/
|
|
4273
|
+
areAllComponentsReturned?: boolean;
|
|
4274
|
+
}
|
|
4275
|
+
/**
|
|
4276
|
+
* @public
|
|
4277
|
+
*/
|
|
4278
|
+
export interface CreateEntityRequest {
|
|
4279
|
+
/**
|
|
4280
|
+
* @public
|
|
4281
|
+
* <p>The ID of the workspace that contains the entity.</p>
|
|
4282
|
+
*/
|
|
4283
|
+
workspaceId: string | undefined;
|
|
4284
|
+
/**
|
|
4285
|
+
* @public
|
|
4286
|
+
* <p>The ID of the entity.</p>
|
|
4287
|
+
*/
|
|
4288
|
+
entityId?: string;
|
|
4289
|
+
/**
|
|
4290
|
+
* @public
|
|
4291
|
+
* <p>The name of the entity.</p>
|
|
4292
|
+
*/
|
|
4293
|
+
entityName: string | undefined;
|
|
4294
|
+
/**
|
|
4295
|
+
* @public
|
|
4296
|
+
* <p>The description of the entity.</p>
|
|
4297
|
+
*/
|
|
4298
|
+
description?: string;
|
|
4299
|
+
/**
|
|
4300
|
+
* @public
|
|
4301
|
+
* <p>An object that maps strings to the components in the entity. Each string in the mapping
|
|
4302
|
+
* must be unique to this object.</p>
|
|
4303
|
+
*/
|
|
4304
|
+
components?: Record<string, ComponentRequest>;
|
|
4305
|
+
/**
|
|
4306
|
+
* @public
|
|
4307
|
+
* <p>This is an object that maps strings to <code>compositeComponent</code> updates in the request.
|
|
4308
|
+
* Each key of the map represents the <code>componentPath</code> of the <code>compositeComponent</code>.</p>
|
|
4309
|
+
*/
|
|
4310
|
+
compositeComponents?: Record<string, CompositeComponentRequest>;
|
|
4311
|
+
/**
|
|
4312
|
+
* @public
|
|
4313
|
+
* <p>The ID of the entity's parent entity.</p>
|
|
4314
|
+
*/
|
|
4315
|
+
parentEntityId?: string;
|
|
4316
|
+
/**
|
|
4317
|
+
* @public
|
|
4318
|
+
* <p>Metadata that you can use to manage the entity.</p>
|
|
4319
|
+
*/
|
|
4320
|
+
tags?: Record<string, string>;
|
|
3352
4321
|
}
|
|
3353
4322
|
/**
|
|
3354
4323
|
* @public
|
|
@@ -3380,6 +4349,12 @@ export interface UpdateEntityRequest {
|
|
|
3380
4349
|
* mapping must be unique to this object.</p>
|
|
3381
4350
|
*/
|
|
3382
4351
|
componentUpdates?: Record<string, ComponentUpdateRequest>;
|
|
4352
|
+
/**
|
|
4353
|
+
* @public
|
|
4354
|
+
* <p>This is an object that maps strings to <code>compositeComponent</code> updates in the request. Each key
|
|
4355
|
+
* of the map represents the <code>componentPath</code> of the <code>compositeComponent</code>.</p>
|
|
4356
|
+
*/
|
|
4357
|
+
compositeComponentUpdates?: Record<string, CompositeComponentUpdateRequest>;
|
|
3383
4358
|
/**
|
|
3384
4359
|
* @public
|
|
3385
4360
|
* <p>An object that describes the update request for a parent entity.</p>
|