@aws-sdk/client-iottwinmaker 3.451.0 → 3.456.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 +49 -2
- 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 +2 -2
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import {
|
|
4
|
+
Handler,
|
|
5
|
+
HttpHandlerOptions as __HttpHandlerOptions,
|
|
6
|
+
MetadataBearer as __MetadataBearer,
|
|
7
|
+
MiddlewareStack,
|
|
8
|
+
} from "@smithy/types";
|
|
9
|
+
import {
|
|
10
|
+
IoTTwinMakerClientResolvedConfig,
|
|
11
|
+
ServiceInputTypes,
|
|
12
|
+
ServiceOutputTypes,
|
|
13
|
+
} from "../IoTTwinMakerClient";
|
|
14
|
+
import {
|
|
15
|
+
ListPropertiesRequest,
|
|
16
|
+
ListPropertiesResponse,
|
|
17
|
+
} from "../models/models_0";
|
|
18
|
+
export { __MetadataBearer, $Command };
|
|
19
|
+
export interface ListPropertiesCommandInput extends ListPropertiesRequest {}
|
|
20
|
+
export interface ListPropertiesCommandOutput
|
|
21
|
+
extends ListPropertiesResponse,
|
|
22
|
+
__MetadataBearer {}
|
|
23
|
+
export declare class ListPropertiesCommand extends $Command<
|
|
24
|
+
ListPropertiesCommandInput,
|
|
25
|
+
ListPropertiesCommandOutput,
|
|
26
|
+
IoTTwinMakerClientResolvedConfig
|
|
27
|
+
> {
|
|
28
|
+
readonly input: ListPropertiesCommandInput;
|
|
29
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
30
|
+
constructor(input: ListPropertiesCommandInput);
|
|
31
|
+
resolveMiddleware(
|
|
32
|
+
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
|
|
33
|
+
configuration: IoTTwinMakerClientResolvedConfig,
|
|
34
|
+
options?: __HttpHandlerOptions
|
|
35
|
+
): Handler<ListPropertiesCommandInput, ListPropertiesCommandOutput>;
|
|
36
|
+
private serialize;
|
|
37
|
+
private deserialize;
|
|
38
|
+
}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
export * from "./BatchPutPropertyValuesCommand";
|
|
2
|
+
export * from "./CancelMetadataTransferJobCommand";
|
|
2
3
|
export * from "./CreateComponentTypeCommand";
|
|
3
4
|
export * from "./CreateEntityCommand";
|
|
5
|
+
export * from "./CreateMetadataTransferJobCommand";
|
|
4
6
|
export * from "./CreateSceneCommand";
|
|
5
7
|
export * from "./CreateSyncJobCommand";
|
|
6
8
|
export * from "./CreateWorkspaceCommand";
|
|
@@ -12,6 +14,7 @@ export * from "./DeleteWorkspaceCommand";
|
|
|
12
14
|
export * from "./ExecuteQueryCommand";
|
|
13
15
|
export * from "./GetComponentTypeCommand";
|
|
14
16
|
export * from "./GetEntityCommand";
|
|
17
|
+
export * from "./GetMetadataTransferJobCommand";
|
|
15
18
|
export * from "./GetPricingPlanCommand";
|
|
16
19
|
export * from "./GetPropertyValueCommand";
|
|
17
20
|
export * from "./GetPropertyValueHistoryCommand";
|
|
@@ -19,7 +22,10 @@ export * from "./GetSceneCommand";
|
|
|
19
22
|
export * from "./GetSyncJobCommand";
|
|
20
23
|
export * from "./GetWorkspaceCommand";
|
|
21
24
|
export * from "./ListComponentTypesCommand";
|
|
25
|
+
export * from "./ListComponentsCommand";
|
|
22
26
|
export * from "./ListEntitiesCommand";
|
|
27
|
+
export * from "./ListMetadataTransferJobsCommand";
|
|
28
|
+
export * from "./ListPropertiesCommand";
|
|
23
29
|
export * from "./ListScenesCommand";
|
|
24
30
|
export * from "./ListSyncJobsCommand";
|
|
25
31
|
export * from "./ListSyncResourcesCommand";
|
|
@@ -10,6 +10,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
10
10
|
}
|
|
11
11
|
export interface EntityPropertyReference {
|
|
12
12
|
componentName?: string;
|
|
13
|
+
componentPath?: string;
|
|
13
14
|
externalIdProperty?: Record<string, string>;
|
|
14
15
|
entityId?: string;
|
|
15
16
|
propertyName: string | undefined;
|
|
@@ -46,11 +47,61 @@ export declare class ValidationException extends __BaseException {
|
|
|
46
47
|
opts: __ExceptionOptionType<ValidationException, __BaseException>
|
|
47
48
|
);
|
|
48
49
|
}
|
|
50
|
+
export interface CancelMetadataTransferJobRequest {
|
|
51
|
+
metadataTransferJobId: string | undefined;
|
|
52
|
+
}
|
|
53
|
+
export interface MetadataTransferJobProgress {
|
|
54
|
+
totalCount?: number;
|
|
55
|
+
succeededCount?: number;
|
|
56
|
+
skippedCount?: number;
|
|
57
|
+
failedCount?: number;
|
|
58
|
+
}
|
|
59
|
+
export declare const ErrorCode: {
|
|
60
|
+
readonly COMPOSITE_COMPONENT_FAILURE: "COMPOSITE_COMPONENT_FAILURE";
|
|
61
|
+
readonly INTERNAL_FAILURE: "INTERNAL_FAILURE";
|
|
62
|
+
readonly PROCESSING_ERROR: "PROCESSING_ERROR";
|
|
63
|
+
readonly SYNC_CREATING_ERROR: "SYNC_CREATING_ERROR";
|
|
64
|
+
readonly SYNC_DELETING_ERROR: "SYNC_DELETING_ERROR";
|
|
65
|
+
readonly SYNC_INITIALIZING_ERROR: "SYNC_INITIALIZING_ERROR";
|
|
66
|
+
readonly SYNC_PROCESSING_ERROR: "SYNC_PROCESSING_ERROR";
|
|
67
|
+
readonly VALIDATION_ERROR: "VALIDATION_ERROR";
|
|
68
|
+
};
|
|
69
|
+
export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
|
|
70
|
+
export interface ErrorDetails {
|
|
71
|
+
code?: ErrorCode;
|
|
72
|
+
message?: string;
|
|
73
|
+
}
|
|
74
|
+
export declare const MetadataTransferJobState: {
|
|
75
|
+
readonly CANCELLED: "CANCELLED";
|
|
76
|
+
readonly CANCELLING: "CANCELLING";
|
|
77
|
+
readonly COMPLETED: "COMPLETED";
|
|
78
|
+
readonly ERROR: "ERROR";
|
|
79
|
+
readonly PENDING: "PENDING";
|
|
80
|
+
readonly RUNNING: "RUNNING";
|
|
81
|
+
readonly VALIDATING: "VALIDATING";
|
|
82
|
+
};
|
|
83
|
+
export type MetadataTransferJobState =
|
|
84
|
+
(typeof MetadataTransferJobState)[keyof typeof MetadataTransferJobState];
|
|
85
|
+
export interface MetadataTransferJobStatus {
|
|
86
|
+
state?: MetadataTransferJobState;
|
|
87
|
+
error?: ErrorDetails;
|
|
88
|
+
queuedPosition?: number;
|
|
89
|
+
}
|
|
90
|
+
export interface CancelMetadataTransferJobResponse {
|
|
91
|
+
metadataTransferJobId: string | undefined;
|
|
92
|
+
arn: string | undefined;
|
|
93
|
+
updateDateTime: Date | undefined;
|
|
94
|
+
status: MetadataTransferJobStatus | undefined;
|
|
95
|
+
progress?: MetadataTransferJobProgress;
|
|
96
|
+
}
|
|
49
97
|
export declare class ConflictException extends __BaseException {
|
|
50
98
|
readonly name: "ConflictException";
|
|
51
99
|
readonly $fault: "client";
|
|
52
100
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
53
101
|
}
|
|
102
|
+
export interface CompositeComponentTypeRequest {
|
|
103
|
+
componentTypeId?: string;
|
|
104
|
+
}
|
|
54
105
|
export interface LambdaFunction {
|
|
55
106
|
arn: string | undefined;
|
|
56
107
|
}
|
|
@@ -136,6 +187,136 @@ export interface CreateEntityResponse {
|
|
|
136
187
|
creationDateTime: Date | undefined;
|
|
137
188
|
state: State | undefined;
|
|
138
189
|
}
|
|
190
|
+
export interface IotTwinMakerDestinationConfiguration {
|
|
191
|
+
workspace: string | undefined;
|
|
192
|
+
}
|
|
193
|
+
export interface S3DestinationConfiguration {
|
|
194
|
+
location: string | undefined;
|
|
195
|
+
}
|
|
196
|
+
export declare const DestinationType: {
|
|
197
|
+
readonly IOTSITEWISE: "iotsitewise";
|
|
198
|
+
readonly IOTTWINMAKER: "iottwinmaker";
|
|
199
|
+
readonly S3: "s3";
|
|
200
|
+
};
|
|
201
|
+
export type DestinationType =
|
|
202
|
+
(typeof DestinationType)[keyof typeof DestinationType];
|
|
203
|
+
export interface DestinationConfiguration {
|
|
204
|
+
type: DestinationType | undefined;
|
|
205
|
+
s3Configuration?: S3DestinationConfiguration;
|
|
206
|
+
iotTwinMakerConfiguration?: IotTwinMakerDestinationConfiguration;
|
|
207
|
+
}
|
|
208
|
+
export interface FilterByAsset {
|
|
209
|
+
assetId?: string;
|
|
210
|
+
assetExternalId?: string;
|
|
211
|
+
includeOffspring?: boolean;
|
|
212
|
+
includeAssetModel?: boolean;
|
|
213
|
+
}
|
|
214
|
+
export interface FilterByAssetModel {
|
|
215
|
+
assetModelId?: string;
|
|
216
|
+
assetModelExternalId?: string;
|
|
217
|
+
includeOffspring?: boolean;
|
|
218
|
+
includeAssets?: boolean;
|
|
219
|
+
}
|
|
220
|
+
export type IotSiteWiseSourceConfigurationFilter =
|
|
221
|
+
| IotSiteWiseSourceConfigurationFilter.FilterByAssetMember
|
|
222
|
+
| IotSiteWiseSourceConfigurationFilter.FilterByAssetModelMember
|
|
223
|
+
| IotSiteWiseSourceConfigurationFilter.$UnknownMember;
|
|
224
|
+
export declare namespace IotSiteWiseSourceConfigurationFilter {
|
|
225
|
+
interface FilterByAssetModelMember {
|
|
226
|
+
filterByAssetModel: FilterByAssetModel;
|
|
227
|
+
filterByAsset?: never;
|
|
228
|
+
$unknown?: never;
|
|
229
|
+
}
|
|
230
|
+
interface FilterByAssetMember {
|
|
231
|
+
filterByAssetModel?: never;
|
|
232
|
+
filterByAsset: FilterByAsset;
|
|
233
|
+
$unknown?: never;
|
|
234
|
+
}
|
|
235
|
+
interface $UnknownMember {
|
|
236
|
+
filterByAssetModel?: never;
|
|
237
|
+
filterByAsset?: never;
|
|
238
|
+
$unknown: [string, any];
|
|
239
|
+
}
|
|
240
|
+
interface Visitor<T> {
|
|
241
|
+
filterByAssetModel: (value: FilterByAssetModel) => T;
|
|
242
|
+
filterByAsset: (value: FilterByAsset) => T;
|
|
243
|
+
_: (name: string, value: any) => T;
|
|
244
|
+
}
|
|
245
|
+
const visit: <T>(
|
|
246
|
+
value: IotSiteWiseSourceConfigurationFilter,
|
|
247
|
+
visitor: Visitor<T>
|
|
248
|
+
) => T;
|
|
249
|
+
}
|
|
250
|
+
export interface IotSiteWiseSourceConfiguration {
|
|
251
|
+
filters?: IotSiteWiseSourceConfigurationFilter[];
|
|
252
|
+
}
|
|
253
|
+
export interface FilterByComponentType {
|
|
254
|
+
componentTypeId: string | undefined;
|
|
255
|
+
}
|
|
256
|
+
export interface FilterByEntity {
|
|
257
|
+
entityId: string | undefined;
|
|
258
|
+
}
|
|
259
|
+
export type IotTwinMakerSourceConfigurationFilter =
|
|
260
|
+
| IotTwinMakerSourceConfigurationFilter.FilterByComponentTypeMember
|
|
261
|
+
| IotTwinMakerSourceConfigurationFilter.FilterByEntityMember
|
|
262
|
+
| IotTwinMakerSourceConfigurationFilter.$UnknownMember;
|
|
263
|
+
export declare namespace IotTwinMakerSourceConfigurationFilter {
|
|
264
|
+
interface FilterByComponentTypeMember {
|
|
265
|
+
filterByComponentType: FilterByComponentType;
|
|
266
|
+
filterByEntity?: never;
|
|
267
|
+
$unknown?: never;
|
|
268
|
+
}
|
|
269
|
+
interface FilterByEntityMember {
|
|
270
|
+
filterByComponentType?: never;
|
|
271
|
+
filterByEntity: FilterByEntity;
|
|
272
|
+
$unknown?: never;
|
|
273
|
+
}
|
|
274
|
+
interface $UnknownMember {
|
|
275
|
+
filterByComponentType?: never;
|
|
276
|
+
filterByEntity?: never;
|
|
277
|
+
$unknown: [string, any];
|
|
278
|
+
}
|
|
279
|
+
interface Visitor<T> {
|
|
280
|
+
filterByComponentType: (value: FilterByComponentType) => T;
|
|
281
|
+
filterByEntity: (value: FilterByEntity) => T;
|
|
282
|
+
_: (name: string, value: any) => T;
|
|
283
|
+
}
|
|
284
|
+
const visit: <T>(
|
|
285
|
+
value: IotTwinMakerSourceConfigurationFilter,
|
|
286
|
+
visitor: Visitor<T>
|
|
287
|
+
) => T;
|
|
288
|
+
}
|
|
289
|
+
export interface IotTwinMakerSourceConfiguration {
|
|
290
|
+
workspace: string | undefined;
|
|
291
|
+
filters?: IotTwinMakerSourceConfigurationFilter[];
|
|
292
|
+
}
|
|
293
|
+
export interface S3SourceConfiguration {
|
|
294
|
+
location: string | undefined;
|
|
295
|
+
}
|
|
296
|
+
export declare const SourceType: {
|
|
297
|
+
readonly IOTSITEWISE: "iotsitewise";
|
|
298
|
+
readonly IOTTWINMAKER: "iottwinmaker";
|
|
299
|
+
readonly S3: "s3";
|
|
300
|
+
};
|
|
301
|
+
export type SourceType = (typeof SourceType)[keyof typeof SourceType];
|
|
302
|
+
export interface SourceConfiguration {
|
|
303
|
+
type: SourceType | undefined;
|
|
304
|
+
s3Configuration?: S3SourceConfiguration;
|
|
305
|
+
iotSiteWiseConfiguration?: IotSiteWiseSourceConfiguration;
|
|
306
|
+
iotTwinMakerConfiguration?: IotTwinMakerSourceConfiguration;
|
|
307
|
+
}
|
|
308
|
+
export interface CreateMetadataTransferJobRequest {
|
|
309
|
+
metadataTransferJobId?: string;
|
|
310
|
+
description?: string;
|
|
311
|
+
sources: SourceConfiguration[] | undefined;
|
|
312
|
+
destination: DestinationConfiguration | undefined;
|
|
313
|
+
}
|
|
314
|
+
export interface CreateMetadataTransferJobResponse {
|
|
315
|
+
metadataTransferJobId: string | undefined;
|
|
316
|
+
arn: string | undefined;
|
|
317
|
+
creationDateTime: Date | undefined;
|
|
318
|
+
status: MetadataTransferJobStatus | undefined;
|
|
319
|
+
}
|
|
139
320
|
export interface CreateSceneRequest {
|
|
140
321
|
workspaceId: string | undefined;
|
|
141
322
|
sceneId: string | undefined;
|
|
@@ -171,8 +352,8 @@ export interface CreateSyncJobResponse {
|
|
|
171
352
|
export interface CreateWorkspaceRequest {
|
|
172
353
|
workspaceId: string | undefined;
|
|
173
354
|
description?: string;
|
|
174
|
-
s3Location
|
|
175
|
-
role
|
|
355
|
+
s3Location?: string;
|
|
356
|
+
role?: string;
|
|
176
357
|
tags?: Record<string, string>;
|
|
177
358
|
}
|
|
178
359
|
export interface CreateWorkspaceResponse {
|
|
@@ -209,7 +390,9 @@ export interface DeleteSyncJobResponse {
|
|
|
209
390
|
export interface DeleteWorkspaceRequest {
|
|
210
391
|
workspaceId: string | undefined;
|
|
211
392
|
}
|
|
212
|
-
export interface DeleteWorkspaceResponse {
|
|
393
|
+
export interface DeleteWorkspaceResponse {
|
|
394
|
+
message?: string;
|
|
395
|
+
}
|
|
213
396
|
export interface ExecuteQueryRequest {
|
|
214
397
|
workspaceId: string | undefined;
|
|
215
398
|
queryStatement: string | undefined;
|
|
@@ -246,6 +429,10 @@ export interface GetComponentTypeRequest {
|
|
|
246
429
|
workspaceId: string | undefined;
|
|
247
430
|
componentTypeId: string | undefined;
|
|
248
431
|
}
|
|
432
|
+
export interface CompositeComponentTypeResponse {
|
|
433
|
+
componentTypeId?: string;
|
|
434
|
+
isInherited?: boolean;
|
|
435
|
+
}
|
|
249
436
|
export interface FunctionResponse {
|
|
250
437
|
requiredProperties?: string[];
|
|
251
438
|
scope?: Scope;
|
|
@@ -257,18 +444,6 @@ export interface PropertyGroupResponse {
|
|
|
257
444
|
propertyNames: string[] | undefined;
|
|
258
445
|
isInherited: boolean | undefined;
|
|
259
446
|
}
|
|
260
|
-
export declare const ErrorCode: {
|
|
261
|
-
readonly INTERNAL_FAILURE: "INTERNAL_FAILURE";
|
|
262
|
-
readonly SYNC_CREATING_ERROR: "SYNC_CREATING_ERROR";
|
|
263
|
-
readonly SYNC_INITIALIZING_ERROR: "SYNC_INITIALIZING_ERROR";
|
|
264
|
-
readonly SYNC_PROCESSING_ERROR: "SYNC_PROCESSING_ERROR";
|
|
265
|
-
readonly VALIDATION_ERROR: "VALIDATION_ERROR";
|
|
266
|
-
};
|
|
267
|
-
export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
|
|
268
|
-
export interface ErrorDetails {
|
|
269
|
-
code?: ErrorCode;
|
|
270
|
-
message?: string;
|
|
271
|
-
}
|
|
272
447
|
export interface Status {
|
|
273
448
|
state?: State;
|
|
274
449
|
error?: ErrorDetails;
|
|
@@ -282,6 +457,32 @@ export interface ComponentPropertyGroupResponse {
|
|
|
282
457
|
propertyNames: string[] | undefined;
|
|
283
458
|
isInherited: boolean | undefined;
|
|
284
459
|
}
|
|
460
|
+
export interface ComponentSummary {
|
|
461
|
+
componentName: string | undefined;
|
|
462
|
+
componentTypeId: string | undefined;
|
|
463
|
+
definedIn?: string;
|
|
464
|
+
description?: string;
|
|
465
|
+
propertyGroups?: Record<string, ComponentPropertyGroupResponse>;
|
|
466
|
+
status: Status | undefined;
|
|
467
|
+
syncSource?: string;
|
|
468
|
+
componentPath?: string;
|
|
469
|
+
}
|
|
470
|
+
export interface GetMetadataTransferJobRequest {
|
|
471
|
+
metadataTransferJobId: string | undefined;
|
|
472
|
+
}
|
|
473
|
+
export interface GetMetadataTransferJobResponse {
|
|
474
|
+
metadataTransferJobId: string | undefined;
|
|
475
|
+
arn: string | undefined;
|
|
476
|
+
description?: string;
|
|
477
|
+
sources: SourceConfiguration[] | undefined;
|
|
478
|
+
destination: DestinationConfiguration | undefined;
|
|
479
|
+
metadataTransferJobRole: string | undefined;
|
|
480
|
+
reportUrl?: string;
|
|
481
|
+
creationDateTime: Date | undefined;
|
|
482
|
+
updateDateTime: Date | undefined;
|
|
483
|
+
status: MetadataTransferJobStatus | undefined;
|
|
484
|
+
progress?: MetadataTransferJobProgress;
|
|
485
|
+
}
|
|
285
486
|
export interface GetPricingPlanRequest {}
|
|
286
487
|
export declare const PricingTier: {
|
|
287
488
|
readonly TIER_1: "TIER_1";
|
|
@@ -407,11 +608,23 @@ export interface GetWorkspaceResponse {
|
|
|
407
608
|
workspaceId: string | undefined;
|
|
408
609
|
arn: string | undefined;
|
|
409
610
|
description?: string;
|
|
410
|
-
|
|
411
|
-
|
|
611
|
+
linkedServices?: string[];
|
|
612
|
+
s3Location?: string;
|
|
613
|
+
role?: string;
|
|
412
614
|
creationDateTime: Date | undefined;
|
|
413
615
|
updateDateTime: Date | undefined;
|
|
414
616
|
}
|
|
617
|
+
export interface ListComponentsRequest {
|
|
618
|
+
workspaceId: string | undefined;
|
|
619
|
+
entityId: string | undefined;
|
|
620
|
+
componentPath?: string;
|
|
621
|
+
maxResults?: number;
|
|
622
|
+
nextToken?: string;
|
|
623
|
+
}
|
|
624
|
+
export interface ListComponentsResponse {
|
|
625
|
+
componentSummaries: ComponentSummary[] | undefined;
|
|
626
|
+
nextToken?: string;
|
|
627
|
+
}
|
|
415
628
|
export type ListComponentTypesFilter =
|
|
416
629
|
| ListComponentTypesFilter.ExtendsFromMember
|
|
417
630
|
| ListComponentTypesFilter.IsAbstractMember
|
|
@@ -530,6 +743,63 @@ export interface ListEntitiesResponse {
|
|
|
530
743
|
entitySummaries?: EntitySummary[];
|
|
531
744
|
nextToken?: string;
|
|
532
745
|
}
|
|
746
|
+
export type ListMetadataTransferJobsFilter =
|
|
747
|
+
| ListMetadataTransferJobsFilter.StateMember
|
|
748
|
+
| ListMetadataTransferJobsFilter.WorkspaceIdMember
|
|
749
|
+
| ListMetadataTransferJobsFilter.$UnknownMember;
|
|
750
|
+
export declare namespace ListMetadataTransferJobsFilter {
|
|
751
|
+
interface WorkspaceIdMember {
|
|
752
|
+
workspaceId: string;
|
|
753
|
+
state?: never;
|
|
754
|
+
$unknown?: never;
|
|
755
|
+
}
|
|
756
|
+
interface StateMember {
|
|
757
|
+
workspaceId?: never;
|
|
758
|
+
state: MetadataTransferJobState;
|
|
759
|
+
$unknown?: never;
|
|
760
|
+
}
|
|
761
|
+
interface $UnknownMember {
|
|
762
|
+
workspaceId?: never;
|
|
763
|
+
state?: never;
|
|
764
|
+
$unknown: [string, any];
|
|
765
|
+
}
|
|
766
|
+
interface Visitor<T> {
|
|
767
|
+
workspaceId: (value: string) => T;
|
|
768
|
+
state: (value: MetadataTransferJobState) => T;
|
|
769
|
+
_: (name: string, value: any) => T;
|
|
770
|
+
}
|
|
771
|
+
const visit: <T>(
|
|
772
|
+
value: ListMetadataTransferJobsFilter,
|
|
773
|
+
visitor: Visitor<T>
|
|
774
|
+
) => T;
|
|
775
|
+
}
|
|
776
|
+
export interface ListMetadataTransferJobsRequest {
|
|
777
|
+
sourceType: SourceType | undefined;
|
|
778
|
+
destinationType: DestinationType | undefined;
|
|
779
|
+
filters?: ListMetadataTransferJobsFilter[];
|
|
780
|
+
nextToken?: string;
|
|
781
|
+
maxResults?: number;
|
|
782
|
+
}
|
|
783
|
+
export interface MetadataTransferJobSummary {
|
|
784
|
+
metadataTransferJobId: string | undefined;
|
|
785
|
+
arn: string | undefined;
|
|
786
|
+
creationDateTime: Date | undefined;
|
|
787
|
+
updateDateTime: Date | undefined;
|
|
788
|
+
status: MetadataTransferJobStatus | undefined;
|
|
789
|
+
progress?: MetadataTransferJobProgress;
|
|
790
|
+
}
|
|
791
|
+
export interface ListMetadataTransferJobsResponse {
|
|
792
|
+
metadataTransferJobSummaries: MetadataTransferJobSummary[] | undefined;
|
|
793
|
+
nextToken?: string;
|
|
794
|
+
}
|
|
795
|
+
export interface ListPropertiesRequest {
|
|
796
|
+
workspaceId: string | undefined;
|
|
797
|
+
componentName?: string;
|
|
798
|
+
componentPath?: string;
|
|
799
|
+
entityId: string | undefined;
|
|
800
|
+
maxResults?: number;
|
|
801
|
+
nextToken?: string;
|
|
802
|
+
}
|
|
533
803
|
export interface ListScenesRequest {
|
|
534
804
|
workspaceId: string | undefined;
|
|
535
805
|
maxResults?: number;
|
|
@@ -669,6 +939,7 @@ export interface WorkspaceSummary {
|
|
|
669
939
|
workspaceId: string | undefined;
|
|
670
940
|
arn: string | undefined;
|
|
671
941
|
description?: string;
|
|
942
|
+
linkedServices?: string[];
|
|
672
943
|
creationDateTime: Date | undefined;
|
|
673
944
|
updateDateTime: Date | undefined;
|
|
674
945
|
}
|
|
@@ -743,6 +1014,7 @@ export interface UpdateWorkspaceRequest {
|
|
|
743
1014
|
workspaceId: string | undefined;
|
|
744
1015
|
description?: string;
|
|
745
1016
|
role?: string;
|
|
1017
|
+
s3Location?: string;
|
|
746
1018
|
}
|
|
747
1019
|
export interface UpdateWorkspaceResponse {
|
|
748
1020
|
updateDateTime: Date | undefined;
|
|
@@ -783,6 +1055,7 @@ export interface GetPropertyValueHistoryRequest {
|
|
|
783
1055
|
workspaceId: string | undefined;
|
|
784
1056
|
entityId?: string;
|
|
785
1057
|
componentName?: string;
|
|
1058
|
+
componentPath?: string;
|
|
786
1059
|
componentTypeId?: string;
|
|
787
1060
|
selectedProperties: string[] | undefined;
|
|
788
1061
|
propertyFilters?: PropertyFilter[];
|
|
@@ -814,6 +1087,7 @@ export interface BatchPutPropertyError {
|
|
|
814
1087
|
}
|
|
815
1088
|
export interface GetPropertyValueRequest {
|
|
816
1089
|
componentName?: string;
|
|
1090
|
+
componentPath?: string;
|
|
817
1091
|
componentTypeId?: string;
|
|
818
1092
|
entityId?: string;
|
|
819
1093
|
selectedProperties: string[] | undefined;
|
|
@@ -876,6 +1150,7 @@ export interface CreateComponentTypeRequest {
|
|
|
876
1150
|
tags?: Record<string, string>;
|
|
877
1151
|
propertyGroups?: Record<string, PropertyGroupRequest>;
|
|
878
1152
|
componentTypeName?: string;
|
|
1153
|
+
compositeComponentTypes?: Record<string, CompositeComponentTypeRequest>;
|
|
879
1154
|
}
|
|
880
1155
|
export interface GetComponentTypeResponse {
|
|
881
1156
|
workspaceId: string | undefined;
|
|
@@ -894,6 +1169,7 @@ export interface GetComponentTypeResponse {
|
|
|
894
1169
|
propertyGroups?: Record<string, PropertyGroupResponse>;
|
|
895
1170
|
syncSource?: string;
|
|
896
1171
|
componentTypeName?: string;
|
|
1172
|
+
compositeComponentTypes?: Record<string, CompositeComponentTypeResponse>;
|
|
897
1173
|
}
|
|
898
1174
|
export interface UpdateComponentTypeRequest {
|
|
899
1175
|
workspaceId: string | undefined;
|
|
@@ -905,6 +1181,7 @@ export interface UpdateComponentTypeRequest {
|
|
|
905
1181
|
functions?: Record<string, FunctionRequest>;
|
|
906
1182
|
propertyGroups?: Record<string, PropertyGroupRequest>;
|
|
907
1183
|
componentTypeName?: string;
|
|
1184
|
+
compositeComponentTypes?: Record<string, CompositeComponentTypeRequest>;
|
|
908
1185
|
}
|
|
909
1186
|
export interface PropertyRequest {
|
|
910
1187
|
definition?: PropertyDefinitionRequest;
|
|
@@ -914,6 +1191,13 @@ export interface PropertyRequest {
|
|
|
914
1191
|
export interface PropertyResponse {
|
|
915
1192
|
definition?: PropertyDefinitionResponse;
|
|
916
1193
|
value?: DataValue;
|
|
1194
|
+
areAllPropertyValuesReturned?: boolean;
|
|
1195
|
+
}
|
|
1196
|
+
export interface PropertySummary {
|
|
1197
|
+
definition?: PropertyDefinitionResponse;
|
|
1198
|
+
propertyName: string | undefined;
|
|
1199
|
+
value?: DataValue;
|
|
1200
|
+
areAllPropertyValuesReturned?: boolean;
|
|
917
1201
|
}
|
|
918
1202
|
export interface ComponentRequest {
|
|
919
1203
|
description?: string;
|
|
@@ -930,6 +1214,9 @@ export interface ComponentResponse {
|
|
|
930
1214
|
properties?: Record<string, PropertyResponse>;
|
|
931
1215
|
propertyGroups?: Record<string, ComponentPropertyGroupResponse>;
|
|
932
1216
|
syncSource?: string;
|
|
1217
|
+
areAllPropertiesReturned?: boolean;
|
|
1218
|
+
compositeComponents?: Record<string, ComponentSummary>;
|
|
1219
|
+
areAllCompositeComponentsReturned?: boolean;
|
|
933
1220
|
}
|
|
934
1221
|
export interface ComponentUpdateRequest {
|
|
935
1222
|
updateType?: ComponentUpdateType;
|
|
@@ -938,14 +1225,20 @@ export interface ComponentUpdateRequest {
|
|
|
938
1225
|
propertyUpdates?: Record<string, PropertyRequest>;
|
|
939
1226
|
propertyGroupUpdates?: Record<string, ComponentPropertyGroupRequest>;
|
|
940
1227
|
}
|
|
941
|
-
export interface
|
|
942
|
-
workspaceId: string | undefined;
|
|
943
|
-
entityId?: string;
|
|
944
|
-
entityName: string | undefined;
|
|
1228
|
+
export interface CompositeComponentRequest {
|
|
945
1229
|
description?: string;
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
1230
|
+
properties?: Record<string, PropertyRequest>;
|
|
1231
|
+
propertyGroups?: Record<string, ComponentPropertyGroupRequest>;
|
|
1232
|
+
}
|
|
1233
|
+
export interface CompositeComponentUpdateRequest {
|
|
1234
|
+
updateType?: ComponentUpdateType;
|
|
1235
|
+
description?: string;
|
|
1236
|
+
propertyUpdates?: Record<string, PropertyRequest>;
|
|
1237
|
+
propertyGroupUpdates?: Record<string, ComponentPropertyGroupRequest>;
|
|
1238
|
+
}
|
|
1239
|
+
export interface ListPropertiesResponse {
|
|
1240
|
+
propertySummaries: PropertySummary[] | undefined;
|
|
1241
|
+
nextToken?: string;
|
|
949
1242
|
}
|
|
950
1243
|
export interface GetEntityResponse {
|
|
951
1244
|
entityId: string | undefined;
|
|
@@ -960,6 +1253,17 @@ export interface GetEntityResponse {
|
|
|
960
1253
|
creationDateTime: Date | undefined;
|
|
961
1254
|
updateDateTime: Date | undefined;
|
|
962
1255
|
syncSource?: string;
|
|
1256
|
+
areAllComponentsReturned?: boolean;
|
|
1257
|
+
}
|
|
1258
|
+
export interface CreateEntityRequest {
|
|
1259
|
+
workspaceId: string | undefined;
|
|
1260
|
+
entityId?: string;
|
|
1261
|
+
entityName: string | undefined;
|
|
1262
|
+
description?: string;
|
|
1263
|
+
components?: Record<string, ComponentRequest>;
|
|
1264
|
+
compositeComponents?: Record<string, CompositeComponentRequest>;
|
|
1265
|
+
parentEntityId?: string;
|
|
1266
|
+
tags?: Record<string, string>;
|
|
963
1267
|
}
|
|
964
1268
|
export interface UpdateEntityRequest {
|
|
965
1269
|
workspaceId: string | undefined;
|
|
@@ -967,5 +1271,6 @@ export interface UpdateEntityRequest {
|
|
|
967
1271
|
entityName?: string;
|
|
968
1272
|
description?: string;
|
|
969
1273
|
componentUpdates?: Record<string, ComponentUpdateRequest>;
|
|
1274
|
+
compositeComponentUpdates?: Record<string, CompositeComponentUpdateRequest>;
|
|
970
1275
|
parentEntityUpdate?: ParentEntityUpdateRequest;
|
|
971
1276
|
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { Paginator } from "@smithy/types";
|
|
2
|
+
import {
|
|
3
|
+
ListComponentsCommandInput,
|
|
4
|
+
ListComponentsCommandOutput,
|
|
5
|
+
} from "../commands/ListComponentsCommand";
|
|
6
|
+
import { IoTTwinMakerPaginationConfiguration } from "./Interfaces";
|
|
7
|
+
export declare function paginateListComponents(
|
|
8
|
+
config: IoTTwinMakerPaginationConfiguration,
|
|
9
|
+
input: ListComponentsCommandInput,
|
|
10
|
+
...additionalArguments: any
|
|
11
|
+
): Paginator<ListComponentsCommandOutput>;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { Paginator } from "@smithy/types";
|
|
2
|
+
import {
|
|
3
|
+
ListMetadataTransferJobsCommandInput,
|
|
4
|
+
ListMetadataTransferJobsCommandOutput,
|
|
5
|
+
} from "../commands/ListMetadataTransferJobsCommand";
|
|
6
|
+
import { IoTTwinMakerPaginationConfiguration } from "./Interfaces";
|
|
7
|
+
export declare function paginateListMetadataTransferJobs(
|
|
8
|
+
config: IoTTwinMakerPaginationConfiguration,
|
|
9
|
+
input: ListMetadataTransferJobsCommandInput,
|
|
10
|
+
...additionalArguments: any
|
|
11
|
+
): Paginator<ListMetadataTransferJobsCommandOutput>;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { Paginator } from "@smithy/types";
|
|
2
|
+
import {
|
|
3
|
+
ListPropertiesCommandInput,
|
|
4
|
+
ListPropertiesCommandOutput,
|
|
5
|
+
} from "../commands/ListPropertiesCommand";
|
|
6
|
+
import { IoTTwinMakerPaginationConfiguration } from "./Interfaces";
|
|
7
|
+
export declare function paginateListProperties(
|
|
8
|
+
config: IoTTwinMakerPaginationConfiguration,
|
|
9
|
+
input: ListPropertiesCommandInput,
|
|
10
|
+
...additionalArguments: any
|
|
11
|
+
): Paginator<ListPropertiesCommandOutput>;
|
|
@@ -3,7 +3,10 @@ export * from "./GetPropertyValueHistoryPaginator";
|
|
|
3
3
|
export * from "./GetPropertyValuePaginator";
|
|
4
4
|
export * from "./Interfaces";
|
|
5
5
|
export * from "./ListComponentTypesPaginator";
|
|
6
|
+
export * from "./ListComponentsPaginator";
|
|
6
7
|
export * from "./ListEntitiesPaginator";
|
|
8
|
+
export * from "./ListMetadataTransferJobsPaginator";
|
|
9
|
+
export * from "./ListPropertiesPaginator";
|
|
7
10
|
export * from "./ListScenesPaginator";
|
|
8
11
|
export * from "./ListSyncJobsPaginator";
|
|
9
12
|
export * from "./ListSyncResourcesPaginator";
|