@aws-sdk/client-iottwinmaker 3.454.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 +1 -1
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
|
|
5
|
+
import { GetMetadataTransferJobRequest, GetMetadataTransferJobResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetMetadataTransferJobCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetMetadataTransferJobCommandInput extends GetMetadataTransferJobRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetMetadataTransferJobCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetMetadataTransferJobCommandOutput extends GetMetadataTransferJobResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Gets a nmetadata transfer job.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { IoTTwinMakerClient, GetMetadataTransferJobCommand } from "@aws-sdk/client-iottwinmaker"; // ES Modules import
|
|
31
|
+
* // const { IoTTwinMakerClient, GetMetadataTransferJobCommand } = require("@aws-sdk/client-iottwinmaker"); // CommonJS import
|
|
32
|
+
* const client = new IoTTwinMakerClient(config);
|
|
33
|
+
* const input = { // GetMetadataTransferJobRequest
|
|
34
|
+
* metadataTransferJobId: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
36
|
+
* const command = new GetMetadataTransferJobCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* // { // GetMetadataTransferJobResponse
|
|
39
|
+
* // metadataTransferJobId: "STRING_VALUE", // required
|
|
40
|
+
* // arn: "STRING_VALUE", // required
|
|
41
|
+
* // description: "STRING_VALUE",
|
|
42
|
+
* // sources: [ // SourceConfigurations // required
|
|
43
|
+
* // { // SourceConfiguration
|
|
44
|
+
* // type: "STRING_VALUE", // required
|
|
45
|
+
* // s3Configuration: { // S3SourceConfiguration
|
|
46
|
+
* // location: "STRING_VALUE", // required
|
|
47
|
+
* // },
|
|
48
|
+
* // iotSiteWiseConfiguration: { // IotSiteWiseSourceConfiguration
|
|
49
|
+
* // filters: [ // IotSiteWiseSourceConfigurationFilters
|
|
50
|
+
* // { // IotSiteWiseSourceConfigurationFilter Union: only one key present
|
|
51
|
+
* // filterByAssetModel: { // FilterByAssetModel
|
|
52
|
+
* // assetModelId: "STRING_VALUE",
|
|
53
|
+
* // assetModelExternalId: "STRING_VALUE",
|
|
54
|
+
* // includeOffspring: true || false,
|
|
55
|
+
* // includeAssets: true || false,
|
|
56
|
+
* // },
|
|
57
|
+
* // filterByAsset: { // FilterByAsset
|
|
58
|
+
* // assetId: "STRING_VALUE",
|
|
59
|
+
* // assetExternalId: "STRING_VALUE",
|
|
60
|
+
* // includeOffspring: true || false,
|
|
61
|
+
* // includeAssetModel: true || false,
|
|
62
|
+
* // },
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // },
|
|
66
|
+
* // iotTwinMakerConfiguration: { // IotTwinMakerSourceConfiguration
|
|
67
|
+
* // workspace: "STRING_VALUE", // required
|
|
68
|
+
* // filters: [ // IotTwinMakerSourceConfigurationFilters
|
|
69
|
+
* // { // IotTwinMakerSourceConfigurationFilter Union: only one key present
|
|
70
|
+
* // filterByComponentType: { // FilterByComponentType
|
|
71
|
+
* // componentTypeId: "STRING_VALUE", // required
|
|
72
|
+
* // },
|
|
73
|
+
* // filterByEntity: { // FilterByEntity
|
|
74
|
+
* // entityId: "STRING_VALUE", // required
|
|
75
|
+
* // },
|
|
76
|
+
* // },
|
|
77
|
+
* // ],
|
|
78
|
+
* // },
|
|
79
|
+
* // },
|
|
80
|
+
* // ],
|
|
81
|
+
* // destination: { // DestinationConfiguration
|
|
82
|
+
* // type: "STRING_VALUE", // required
|
|
83
|
+
* // s3Configuration: { // S3DestinationConfiguration
|
|
84
|
+
* // location: "STRING_VALUE", // required
|
|
85
|
+
* // },
|
|
86
|
+
* // iotTwinMakerConfiguration: { // IotTwinMakerDestinationConfiguration
|
|
87
|
+
* // workspace: "STRING_VALUE", // required
|
|
88
|
+
* // },
|
|
89
|
+
* // },
|
|
90
|
+
* // metadataTransferJobRole: "STRING_VALUE", // required
|
|
91
|
+
* // reportUrl: "STRING_VALUE",
|
|
92
|
+
* // creationDateTime: new Date("TIMESTAMP"), // required
|
|
93
|
+
* // updateDateTime: new Date("TIMESTAMP"), // required
|
|
94
|
+
* // status: { // MetadataTransferJobStatus
|
|
95
|
+
* // state: "STRING_VALUE",
|
|
96
|
+
* // error: { // ErrorDetails
|
|
97
|
+
* // code: "STRING_VALUE",
|
|
98
|
+
* // message: "STRING_VALUE",
|
|
99
|
+
* // },
|
|
100
|
+
* // queuedPosition: Number("int"),
|
|
101
|
+
* // },
|
|
102
|
+
* // progress: { // MetadataTransferJobProgress
|
|
103
|
+
* // totalCount: Number("int"),
|
|
104
|
+
* // succeededCount: Number("int"),
|
|
105
|
+
* // skippedCount: Number("int"),
|
|
106
|
+
* // failedCount: Number("int"),
|
|
107
|
+
* // },
|
|
108
|
+
* // };
|
|
109
|
+
*
|
|
110
|
+
* ```
|
|
111
|
+
*
|
|
112
|
+
* @param GetMetadataTransferJobCommandInput - {@link GetMetadataTransferJobCommandInput}
|
|
113
|
+
* @returns {@link GetMetadataTransferJobCommandOutput}
|
|
114
|
+
* @see {@link GetMetadataTransferJobCommandInput} for command's `input` shape.
|
|
115
|
+
* @see {@link GetMetadataTransferJobCommandOutput} for command's `response` shape.
|
|
116
|
+
* @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
119
|
+
* <p>Access is denied.</p>
|
|
120
|
+
*
|
|
121
|
+
* @throws {@link InternalServerException} (server fault)
|
|
122
|
+
* <p>An unexpected error has occurred.</p>
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
125
|
+
* <p>The resource wasn't found.</p>
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
128
|
+
* <p>The rate exceeds the limit.</p>
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link ValidationException} (client fault)
|
|
131
|
+
* <p>Failed</p>
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link IoTTwinMakerServiceException}
|
|
134
|
+
* <p>Base exception class for all service exceptions from IoTTwinMaker service.</p>
|
|
135
|
+
*
|
|
136
|
+
*/
|
|
137
|
+
export declare class GetMetadataTransferJobCommand extends $Command<GetMetadataTransferJobCommandInput, GetMetadataTransferJobCommandOutput, IoTTwinMakerClientResolvedConfig> {
|
|
138
|
+
readonly input: GetMetadataTransferJobCommandInput;
|
|
139
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
140
|
+
/**
|
|
141
|
+
* @public
|
|
142
|
+
*/
|
|
143
|
+
constructor(input: GetMetadataTransferJobCommandInput);
|
|
144
|
+
/**
|
|
145
|
+
* @internal
|
|
146
|
+
*/
|
|
147
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetMetadataTransferJobCommandInput, GetMetadataTransferJobCommandOutput>;
|
|
148
|
+
/**
|
|
149
|
+
* @internal
|
|
150
|
+
*/
|
|
151
|
+
private serialize;
|
|
152
|
+
/**
|
|
153
|
+
* @internal
|
|
154
|
+
*/
|
|
155
|
+
private deserialize;
|
|
156
|
+
}
|
|
@@ -34,6 +34,7 @@ export interface GetPropertyValueCommandOutput extends GetPropertyValueResponse,
|
|
|
34
34
|
* const client = new IoTTwinMakerClient(config);
|
|
35
35
|
* const input = { // GetPropertyValueRequest
|
|
36
36
|
* componentName: "STRING_VALUE",
|
|
37
|
+
* componentPath: "STRING_VALUE",
|
|
37
38
|
* componentTypeId: "STRING_VALUE",
|
|
38
39
|
* entityId: "STRING_VALUE",
|
|
39
40
|
* selectedProperties: [ // SelectedPropertyList // required
|
|
@@ -100,6 +101,7 @@ export interface GetPropertyValueCommandOutput extends GetPropertyValueResponse,
|
|
|
100
101
|
* // "<keys>": { // PropertyLatestValue
|
|
101
102
|
* // propertyReference: { // EntityPropertyReference
|
|
102
103
|
* // componentName: "STRING_VALUE",
|
|
104
|
+
* // componentPath: "STRING_VALUE",
|
|
103
105
|
* // externalIdProperty: { // ExternalIdProperty
|
|
104
106
|
* // "<keys>": "STRING_VALUE",
|
|
105
107
|
* // },
|
|
@@ -38,6 +38,7 @@ export interface GetPropertyValueHistoryCommandOutput extends GetPropertyValueHi
|
|
|
38
38
|
* workspaceId: "STRING_VALUE", // required
|
|
39
39
|
* entityId: "STRING_VALUE",
|
|
40
40
|
* componentName: "STRING_VALUE",
|
|
41
|
+
* componentPath: "STRING_VALUE",
|
|
41
42
|
* componentTypeId: "STRING_VALUE",
|
|
42
43
|
* selectedProperties: [ // SelectedPropertyList // required
|
|
43
44
|
* "STRING_VALUE",
|
|
@@ -102,6 +103,7 @@ export interface GetPropertyValueHistoryCommandOutput extends GetPropertyValueHi
|
|
|
102
103
|
* // { // PropertyValueHistory
|
|
103
104
|
* // entityPropertyReference: { // EntityPropertyReference
|
|
104
105
|
* // componentName: "STRING_VALUE",
|
|
106
|
+
* // componentPath: "STRING_VALUE",
|
|
105
107
|
* // externalIdProperty: { // ExternalIdProperty
|
|
106
108
|
* // "<keys>": "STRING_VALUE",
|
|
107
109
|
* // },
|
|
@@ -39,8 +39,11 @@ export interface GetWorkspaceCommandOutput extends GetWorkspaceResponse, __Metad
|
|
|
39
39
|
* // workspaceId: "STRING_VALUE", // required
|
|
40
40
|
* // arn: "STRING_VALUE", // required
|
|
41
41
|
* // description: "STRING_VALUE",
|
|
42
|
-
* //
|
|
43
|
-
* //
|
|
42
|
+
* // linkedServices: [ // LinkedServices
|
|
43
|
+
* // "STRING_VALUE",
|
|
44
|
+
* // ],
|
|
45
|
+
* // s3Location: "STRING_VALUE",
|
|
46
|
+
* // role: "STRING_VALUE",
|
|
44
47
|
* // creationDateTime: new Date("TIMESTAMP"), // required
|
|
45
48
|
* // updateDateTime: new Date("TIMESTAMP"), // required
|
|
46
49
|
* // };
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
|
|
5
|
+
import { ListComponentsRequest, ListComponentsResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListComponentsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListComponentsCommandInput extends ListComponentsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListComponentsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListComponentsCommandOutput extends ListComponentsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>This API lists the components of an entity.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { IoTTwinMakerClient, ListComponentsCommand } from "@aws-sdk/client-iottwinmaker"; // ES Modules import
|
|
31
|
+
* // const { IoTTwinMakerClient, ListComponentsCommand } = require("@aws-sdk/client-iottwinmaker"); // CommonJS import
|
|
32
|
+
* const client = new IoTTwinMakerClient(config);
|
|
33
|
+
* const input = { // ListComponentsRequest
|
|
34
|
+
* workspaceId: "STRING_VALUE", // required
|
|
35
|
+
* entityId: "STRING_VALUE", // required
|
|
36
|
+
* componentPath: "STRING_VALUE",
|
|
37
|
+
* maxResults: Number("int"),
|
|
38
|
+
* nextToken: "STRING_VALUE",
|
|
39
|
+
* };
|
|
40
|
+
* const command = new ListComponentsCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // ListComponentsResponse
|
|
43
|
+
* // componentSummaries: [ // ComponentSummaries // required
|
|
44
|
+
* // { // ComponentSummary
|
|
45
|
+
* // componentName: "STRING_VALUE", // required
|
|
46
|
+
* // componentTypeId: "STRING_VALUE", // required
|
|
47
|
+
* // definedIn: "STRING_VALUE",
|
|
48
|
+
* // description: "STRING_VALUE",
|
|
49
|
+
* // propertyGroups: { // ComponentPropertyGroupResponses
|
|
50
|
+
* // "<keys>": { // ComponentPropertyGroupResponse
|
|
51
|
+
* // groupType: "STRING_VALUE", // required
|
|
52
|
+
* // propertyNames: [ // PropertyNames // required
|
|
53
|
+
* // "STRING_VALUE",
|
|
54
|
+
* // ],
|
|
55
|
+
* // isInherited: true || false, // required
|
|
56
|
+
* // },
|
|
57
|
+
* // },
|
|
58
|
+
* // status: { // Status
|
|
59
|
+
* // state: "STRING_VALUE",
|
|
60
|
+
* // error: { // ErrorDetails
|
|
61
|
+
* // code: "STRING_VALUE",
|
|
62
|
+
* // message: "STRING_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // },
|
|
65
|
+
* // syncSource: "STRING_VALUE",
|
|
66
|
+
* // componentPath: "STRING_VALUE",
|
|
67
|
+
* // },
|
|
68
|
+
* // ],
|
|
69
|
+
* // nextToken: "STRING_VALUE",
|
|
70
|
+
* // };
|
|
71
|
+
*
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
74
|
+
* @param ListComponentsCommandInput - {@link ListComponentsCommandInput}
|
|
75
|
+
* @returns {@link ListComponentsCommandOutput}
|
|
76
|
+
* @see {@link ListComponentsCommandInput} for command's `input` shape.
|
|
77
|
+
* @see {@link ListComponentsCommandOutput} for command's `response` shape.
|
|
78
|
+
* @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
81
|
+
* <p>Access is denied.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InternalServerException} (server fault)
|
|
84
|
+
* <p>An unexpected error has occurred.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
87
|
+
* <p>The resource wasn't found.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
90
|
+
* <p>The rate exceeds the limit.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ValidationException} (client fault)
|
|
93
|
+
* <p>Failed</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link IoTTwinMakerServiceException}
|
|
96
|
+
* <p>Base exception class for all service exceptions from IoTTwinMaker service.</p>
|
|
97
|
+
*
|
|
98
|
+
*/
|
|
99
|
+
export declare class ListComponentsCommand extends $Command<ListComponentsCommandInput, ListComponentsCommandOutput, IoTTwinMakerClientResolvedConfig> {
|
|
100
|
+
readonly input: ListComponentsCommandInput;
|
|
101
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
102
|
+
/**
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
constructor(input: ListComponentsCommandInput);
|
|
106
|
+
/**
|
|
107
|
+
* @internal
|
|
108
|
+
*/
|
|
109
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListComponentsCommandInput, ListComponentsCommandOutput>;
|
|
110
|
+
/**
|
|
111
|
+
* @internal
|
|
112
|
+
*/
|
|
113
|
+
private serialize;
|
|
114
|
+
/**
|
|
115
|
+
* @internal
|
|
116
|
+
*/
|
|
117
|
+
private deserialize;
|
|
118
|
+
}
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
|
|
5
|
+
import { ListMetadataTransferJobsRequest, ListMetadataTransferJobsResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListMetadataTransferJobsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListMetadataTransferJobsCommandInput extends ListMetadataTransferJobsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListMetadataTransferJobsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListMetadataTransferJobsCommandOutput extends ListMetadataTransferJobsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Lists the metadata transfer jobs.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { IoTTwinMakerClient, ListMetadataTransferJobsCommand } from "@aws-sdk/client-iottwinmaker"; // ES Modules import
|
|
31
|
+
* // const { IoTTwinMakerClient, ListMetadataTransferJobsCommand } = require("@aws-sdk/client-iottwinmaker"); // CommonJS import
|
|
32
|
+
* const client = new IoTTwinMakerClient(config);
|
|
33
|
+
* const input = { // ListMetadataTransferJobsRequest
|
|
34
|
+
* sourceType: "STRING_VALUE", // required
|
|
35
|
+
* destinationType: "STRING_VALUE", // required
|
|
36
|
+
* filters: [ // ListMetadataTransferJobsFilters
|
|
37
|
+
* { // ListMetadataTransferJobsFilter Union: only one key present
|
|
38
|
+
* workspaceId: "STRING_VALUE",
|
|
39
|
+
* state: "STRING_VALUE",
|
|
40
|
+
* },
|
|
41
|
+
* ],
|
|
42
|
+
* nextToken: "STRING_VALUE",
|
|
43
|
+
* maxResults: Number("int"),
|
|
44
|
+
* };
|
|
45
|
+
* const command = new ListMetadataTransferJobsCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // ListMetadataTransferJobsResponse
|
|
48
|
+
* // metadataTransferJobSummaries: [ // MetadataTransferJobSummaries // required
|
|
49
|
+
* // { // MetadataTransferJobSummary
|
|
50
|
+
* // metadataTransferJobId: "STRING_VALUE", // required
|
|
51
|
+
* // arn: "STRING_VALUE", // required
|
|
52
|
+
* // creationDateTime: new Date("TIMESTAMP"), // required
|
|
53
|
+
* // updateDateTime: new Date("TIMESTAMP"), // required
|
|
54
|
+
* // status: { // MetadataTransferJobStatus
|
|
55
|
+
* // state: "STRING_VALUE",
|
|
56
|
+
* // error: { // ErrorDetails
|
|
57
|
+
* // code: "STRING_VALUE",
|
|
58
|
+
* // message: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // queuedPosition: Number("int"),
|
|
61
|
+
* // },
|
|
62
|
+
* // progress: { // MetadataTransferJobProgress
|
|
63
|
+
* // totalCount: Number("int"),
|
|
64
|
+
* // succeededCount: Number("int"),
|
|
65
|
+
* // skippedCount: Number("int"),
|
|
66
|
+
* // failedCount: Number("int"),
|
|
67
|
+
* // },
|
|
68
|
+
* // },
|
|
69
|
+
* // ],
|
|
70
|
+
* // nextToken: "STRING_VALUE",
|
|
71
|
+
* // };
|
|
72
|
+
*
|
|
73
|
+
* ```
|
|
74
|
+
*
|
|
75
|
+
* @param ListMetadataTransferJobsCommandInput - {@link ListMetadataTransferJobsCommandInput}
|
|
76
|
+
* @returns {@link ListMetadataTransferJobsCommandOutput}
|
|
77
|
+
* @see {@link ListMetadataTransferJobsCommandInput} for command's `input` shape.
|
|
78
|
+
* @see {@link ListMetadataTransferJobsCommandOutput} for command's `response` shape.
|
|
79
|
+
* @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
82
|
+
* <p>Access is denied.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link InternalServerException} (server fault)
|
|
85
|
+
* <p>An unexpected error has occurred.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
88
|
+
* <p>The rate exceeds the limit.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ValidationException} (client fault)
|
|
91
|
+
* <p>Failed</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link IoTTwinMakerServiceException}
|
|
94
|
+
* <p>Base exception class for all service exceptions from IoTTwinMaker service.</p>
|
|
95
|
+
*
|
|
96
|
+
*/
|
|
97
|
+
export declare class ListMetadataTransferJobsCommand extends $Command<ListMetadataTransferJobsCommandInput, ListMetadataTransferJobsCommandOutput, IoTTwinMakerClientResolvedConfig> {
|
|
98
|
+
readonly input: ListMetadataTransferJobsCommandInput;
|
|
99
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
100
|
+
/**
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
constructor(input: ListMetadataTransferJobsCommandInput);
|
|
104
|
+
/**
|
|
105
|
+
* @internal
|
|
106
|
+
*/
|
|
107
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListMetadataTransferJobsCommandInput, ListMetadataTransferJobsCommandOutput>;
|
|
108
|
+
/**
|
|
109
|
+
* @internal
|
|
110
|
+
*/
|
|
111
|
+
private serialize;
|
|
112
|
+
/**
|
|
113
|
+
* @internal
|
|
114
|
+
*/
|
|
115
|
+
private deserialize;
|
|
116
|
+
}
|
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
|
|
5
|
+
import { ListPropertiesRequest, ListPropertiesResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListPropertiesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListPropertiesCommandInput extends ListPropertiesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListPropertiesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListPropertiesCommandOutput extends ListPropertiesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>This API lists the properties of a component.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { IoTTwinMakerClient, ListPropertiesCommand } from "@aws-sdk/client-iottwinmaker"; // ES Modules import
|
|
31
|
+
* // const { IoTTwinMakerClient, ListPropertiesCommand } = require("@aws-sdk/client-iottwinmaker"); // CommonJS import
|
|
32
|
+
* const client = new IoTTwinMakerClient(config);
|
|
33
|
+
* const input = { // ListPropertiesRequest
|
|
34
|
+
* workspaceId: "STRING_VALUE", // required
|
|
35
|
+
* componentName: "STRING_VALUE",
|
|
36
|
+
* componentPath: "STRING_VALUE",
|
|
37
|
+
* entityId: "STRING_VALUE", // required
|
|
38
|
+
* maxResults: Number("int"),
|
|
39
|
+
* nextToken: "STRING_VALUE",
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ListPropertiesCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // ListPropertiesResponse
|
|
44
|
+
* // propertySummaries: [ // PropertySummaries // required
|
|
45
|
+
* // { // PropertySummary
|
|
46
|
+
* // definition: { // PropertyDefinitionResponse
|
|
47
|
+
* // dataType: { // DataType
|
|
48
|
+
* // type: "STRING_VALUE", // required
|
|
49
|
+
* // nestedType: {
|
|
50
|
+
* // type: "STRING_VALUE", // required
|
|
51
|
+
* // nestedType: "<DataType>",
|
|
52
|
+
* // allowedValues: [ // DataValueList
|
|
53
|
+
* // { // DataValue
|
|
54
|
+
* // booleanValue: true || false,
|
|
55
|
+
* // doubleValue: Number("double"),
|
|
56
|
+
* // integerValue: Number("int"),
|
|
57
|
+
* // longValue: Number("long"),
|
|
58
|
+
* // stringValue: "STRING_VALUE",
|
|
59
|
+
* // listValue: [
|
|
60
|
+
* // {
|
|
61
|
+
* // booleanValue: true || false,
|
|
62
|
+
* // doubleValue: Number("double"),
|
|
63
|
+
* // integerValue: Number("int"),
|
|
64
|
+
* // longValue: Number("long"),
|
|
65
|
+
* // stringValue: "STRING_VALUE",
|
|
66
|
+
* // listValue: "<DataValueList>",
|
|
67
|
+
* // mapValue: { // DataValueMap
|
|
68
|
+
* // "<keys>": "<DataValue>",
|
|
69
|
+
* // },
|
|
70
|
+
* // relationshipValue: { // RelationshipValue
|
|
71
|
+
* // targetEntityId: "STRING_VALUE",
|
|
72
|
+
* // targetComponentName: "STRING_VALUE",
|
|
73
|
+
* // },
|
|
74
|
+
* // expression: "STRING_VALUE",
|
|
75
|
+
* // },
|
|
76
|
+
* // ],
|
|
77
|
+
* // mapValue: {
|
|
78
|
+
* // "<keys>": "<DataValue>",
|
|
79
|
+
* // },
|
|
80
|
+
* // relationshipValue: {
|
|
81
|
+
* // targetEntityId: "STRING_VALUE",
|
|
82
|
+
* // targetComponentName: "STRING_VALUE",
|
|
83
|
+
* // },
|
|
84
|
+
* // expression: "STRING_VALUE",
|
|
85
|
+
* // },
|
|
86
|
+
* // ],
|
|
87
|
+
* // unitOfMeasure: "STRING_VALUE",
|
|
88
|
+
* // relationship: { // Relationship
|
|
89
|
+
* // targetComponentTypeId: "STRING_VALUE",
|
|
90
|
+
* // relationshipType: "STRING_VALUE",
|
|
91
|
+
* // },
|
|
92
|
+
* // },
|
|
93
|
+
* // allowedValues: "<DataValueList>",
|
|
94
|
+
* // unitOfMeasure: "STRING_VALUE",
|
|
95
|
+
* // relationship: {
|
|
96
|
+
* // targetComponentTypeId: "STRING_VALUE",
|
|
97
|
+
* // relationshipType: "STRING_VALUE",
|
|
98
|
+
* // },
|
|
99
|
+
* // },
|
|
100
|
+
* // isTimeSeries: true || false, // required
|
|
101
|
+
* // isRequiredInEntity: true || false, // required
|
|
102
|
+
* // isExternalId: true || false, // required
|
|
103
|
+
* // isStoredExternally: true || false, // required
|
|
104
|
+
* // isImported: true || false, // required
|
|
105
|
+
* // isFinal: true || false, // required
|
|
106
|
+
* // isInherited: true || false, // required
|
|
107
|
+
* // defaultValue: "<DataValue>",
|
|
108
|
+
* // configuration: { // Configuration
|
|
109
|
+
* // "<keys>": "STRING_VALUE",
|
|
110
|
+
* // },
|
|
111
|
+
* // displayName: "STRING_VALUE",
|
|
112
|
+
* // },
|
|
113
|
+
* // propertyName: "STRING_VALUE", // required
|
|
114
|
+
* // value: "<DataValue>",
|
|
115
|
+
* // areAllPropertyValuesReturned: true || false,
|
|
116
|
+
* // },
|
|
117
|
+
* // ],
|
|
118
|
+
* // nextToken: "STRING_VALUE",
|
|
119
|
+
* // };
|
|
120
|
+
*
|
|
121
|
+
* ```
|
|
122
|
+
*
|
|
123
|
+
* @param ListPropertiesCommandInput - {@link ListPropertiesCommandInput}
|
|
124
|
+
* @returns {@link ListPropertiesCommandOutput}
|
|
125
|
+
* @see {@link ListPropertiesCommandInput} for command's `input` shape.
|
|
126
|
+
* @see {@link ListPropertiesCommandOutput} for command's `response` shape.
|
|
127
|
+
* @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
130
|
+
* <p>Access is denied.</p>
|
|
131
|
+
*
|
|
132
|
+
* @throws {@link InternalServerException} (server fault)
|
|
133
|
+
* <p>An unexpected error has occurred.</p>
|
|
134
|
+
*
|
|
135
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
136
|
+
* <p>The resource wasn't found.</p>
|
|
137
|
+
*
|
|
138
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
139
|
+
* <p>The rate exceeds the limit.</p>
|
|
140
|
+
*
|
|
141
|
+
* @throws {@link ValidationException} (client fault)
|
|
142
|
+
* <p>Failed</p>
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link IoTTwinMakerServiceException}
|
|
145
|
+
* <p>Base exception class for all service exceptions from IoTTwinMaker service.</p>
|
|
146
|
+
*
|
|
147
|
+
*/
|
|
148
|
+
export declare class ListPropertiesCommand extends $Command<ListPropertiesCommandInput, ListPropertiesCommandOutput, IoTTwinMakerClientResolvedConfig> {
|
|
149
|
+
readonly input: ListPropertiesCommandInput;
|
|
150
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
151
|
+
/**
|
|
152
|
+
* @public
|
|
153
|
+
*/
|
|
154
|
+
constructor(input: ListPropertiesCommandInput);
|
|
155
|
+
/**
|
|
156
|
+
* @internal
|
|
157
|
+
*/
|
|
158
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListPropertiesCommandInput, ListPropertiesCommandOutput>;
|
|
159
|
+
/**
|
|
160
|
+
* @internal
|
|
161
|
+
*/
|
|
162
|
+
private serialize;
|
|
163
|
+
/**
|
|
164
|
+
* @internal
|
|
165
|
+
*/
|
|
166
|
+
private deserialize;
|
|
167
|
+
}
|
|
@@ -42,6 +42,9 @@ export interface ListWorkspacesCommandOutput extends ListWorkspacesResponse, __M
|
|
|
42
42
|
* // workspaceId: "STRING_VALUE", // required
|
|
43
43
|
* // arn: "STRING_VALUE", // required
|
|
44
44
|
* // description: "STRING_VALUE",
|
|
45
|
+
* // linkedServices: [ // LinkedServices
|
|
46
|
+
* // "STRING_VALUE",
|
|
47
|
+
* // ],
|
|
45
48
|
* // creationDateTime: new Date("TIMESTAMP"), // required
|
|
46
49
|
* // updateDateTime: new Date("TIMESTAMP"), // required
|
|
47
50
|
* // },
|
|
@@ -127,6 +127,11 @@ export interface UpdateComponentTypeCommandOutput extends UpdateComponentTypeRes
|
|
|
127
127
|
* },
|
|
128
128
|
* },
|
|
129
129
|
* componentTypeName: "STRING_VALUE",
|
|
130
|
+
* compositeComponentTypes: { // CompositeComponentTypesRequest
|
|
131
|
+
* "<keys>": { // CompositeComponentTypeRequest
|
|
132
|
+
* componentTypeId: "STRING_VALUE",
|
|
133
|
+
* },
|
|
134
|
+
* },
|
|
130
135
|
* };
|
|
131
136
|
* const command = new UpdateComponentTypeCommand(input);
|
|
132
137
|
* const response = await client.send(command);
|
|
@@ -121,6 +121,39 @@ export interface UpdateEntityCommandOutput extends UpdateEntityResponse, __Metad
|
|
|
121
121
|
* },
|
|
122
122
|
* },
|
|
123
123
|
* },
|
|
124
|
+
* compositeComponentUpdates: { // CompositeComponentUpdatesMapRequest
|
|
125
|
+
* "<keys>": { // CompositeComponentUpdateRequest
|
|
126
|
+
* updateType: "STRING_VALUE",
|
|
127
|
+
* description: "STRING_VALUE",
|
|
128
|
+
* propertyUpdates: {
|
|
129
|
+
* "<keys>": {
|
|
130
|
+
* definition: {
|
|
131
|
+
* dataType: "<DataType>",
|
|
132
|
+
* isRequiredInEntity: true || false,
|
|
133
|
+
* isExternalId: true || false,
|
|
134
|
+
* isStoredExternally: true || false,
|
|
135
|
+
* isTimeSeries: true || false,
|
|
136
|
+
* defaultValue: "<DataValue>",
|
|
137
|
+
* configuration: {
|
|
138
|
+
* "<keys>": "STRING_VALUE",
|
|
139
|
+
* },
|
|
140
|
+
* displayName: "STRING_VALUE",
|
|
141
|
+
* },
|
|
142
|
+
* value: "<DataValue>",
|
|
143
|
+
* updateType: "STRING_VALUE",
|
|
144
|
+
* },
|
|
145
|
+
* },
|
|
146
|
+
* propertyGroupUpdates: {
|
|
147
|
+
* "<keys>": {
|
|
148
|
+
* groupType: "STRING_VALUE",
|
|
149
|
+
* propertyNames: [
|
|
150
|
+
* "STRING_VALUE",
|
|
151
|
+
* ],
|
|
152
|
+
* updateType: "STRING_VALUE",
|
|
153
|
+
* },
|
|
154
|
+
* },
|
|
155
|
+
* },
|
|
156
|
+
* },
|
|
124
157
|
* parentEntityUpdate: { // ParentEntityUpdateRequest
|
|
125
158
|
* updateType: "STRING_VALUE", // required
|
|
126
159
|
* parentEntityId: "STRING_VALUE",
|