@aws-sdk/client-iottwinmaker 3.44.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.
Files changed (184) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +201 -0
  3. package/README.md +212 -0
  4. package/dist-cjs/IoTTwinMaker.js +397 -0
  5. package/dist-cjs/IoTTwinMakerClient.js +35 -0
  6. package/dist-cjs/commands/BatchPutPropertyValuesCommand.js +36 -0
  7. package/dist-cjs/commands/CreateComponentTypeCommand.js +36 -0
  8. package/dist-cjs/commands/CreateEntityCommand.js +36 -0
  9. package/dist-cjs/commands/CreateSceneCommand.js +36 -0
  10. package/dist-cjs/commands/CreateWorkspaceCommand.js +36 -0
  11. package/dist-cjs/commands/DeleteComponentTypeCommand.js +36 -0
  12. package/dist-cjs/commands/DeleteEntityCommand.js +36 -0
  13. package/dist-cjs/commands/DeleteSceneCommand.js +36 -0
  14. package/dist-cjs/commands/DeleteWorkspaceCommand.js +36 -0
  15. package/dist-cjs/commands/GetComponentTypeCommand.js +36 -0
  16. package/dist-cjs/commands/GetEntityCommand.js +36 -0
  17. package/dist-cjs/commands/GetPropertyValueCommand.js +36 -0
  18. package/dist-cjs/commands/GetPropertyValueHistoryCommand.js +36 -0
  19. package/dist-cjs/commands/GetSceneCommand.js +36 -0
  20. package/dist-cjs/commands/GetWorkspaceCommand.js +36 -0
  21. package/dist-cjs/commands/ListComponentTypesCommand.js +36 -0
  22. package/dist-cjs/commands/ListEntitiesCommand.js +36 -0
  23. package/dist-cjs/commands/ListScenesCommand.js +36 -0
  24. package/dist-cjs/commands/ListTagsForResourceCommand.js +36 -0
  25. package/dist-cjs/commands/ListWorkspacesCommand.js +36 -0
  26. package/dist-cjs/commands/TagResourceCommand.js +36 -0
  27. package/dist-cjs/commands/UntagResourceCommand.js +36 -0
  28. package/dist-cjs/commands/UpdateComponentTypeCommand.js +36 -0
  29. package/dist-cjs/commands/UpdateEntityCommand.js +36 -0
  30. package/dist-cjs/commands/UpdateSceneCommand.js +36 -0
  31. package/dist-cjs/commands/UpdateWorkspaceCommand.js +36 -0
  32. package/dist-cjs/commands/index.js +29 -0
  33. package/dist-cjs/endpoints.js +130 -0
  34. package/dist-cjs/index.js +8 -0
  35. package/dist-cjs/models/index.js +4 -0
  36. package/dist-cjs/models/models_0.js +659 -0
  37. package/dist-cjs/pagination/GetPropertyValueHistoryPaginator.js +35 -0
  38. package/dist-cjs/pagination/Interfaces.js +2 -0
  39. package/dist-cjs/pagination/ListComponentTypesPaginator.js +35 -0
  40. package/dist-cjs/pagination/ListEntitiesPaginator.js +35 -0
  41. package/dist-cjs/pagination/ListScenesPaginator.js +35 -0
  42. package/dist-cjs/pagination/ListWorkspacesPaginator.js +35 -0
  43. package/dist-cjs/pagination/index.js +9 -0
  44. package/dist-cjs/protocols/Aws_restJson1.js +4460 -0
  45. package/dist-cjs/runtimeConfig.browser.js +40 -0
  46. package/dist-cjs/runtimeConfig.js +44 -0
  47. package/dist-cjs/runtimeConfig.native.js +16 -0
  48. package/dist-cjs/runtimeConfig.shared.js +17 -0
  49. package/dist-es/IoTTwinMaker.js +400 -0
  50. package/dist-es/IoTTwinMakerClient.js +37 -0
  51. package/dist-es/commands/BatchPutPropertyValuesCommand.js +39 -0
  52. package/dist-es/commands/CreateComponentTypeCommand.js +39 -0
  53. package/dist-es/commands/CreateEntityCommand.js +39 -0
  54. package/dist-es/commands/CreateSceneCommand.js +39 -0
  55. package/dist-es/commands/CreateWorkspaceCommand.js +39 -0
  56. package/dist-es/commands/DeleteComponentTypeCommand.js +39 -0
  57. package/dist-es/commands/DeleteEntityCommand.js +39 -0
  58. package/dist-es/commands/DeleteSceneCommand.js +39 -0
  59. package/dist-es/commands/DeleteWorkspaceCommand.js +39 -0
  60. package/dist-es/commands/GetComponentTypeCommand.js +39 -0
  61. package/dist-es/commands/GetEntityCommand.js +39 -0
  62. package/dist-es/commands/GetPropertyValueCommand.js +39 -0
  63. package/dist-es/commands/GetPropertyValueHistoryCommand.js +39 -0
  64. package/dist-es/commands/GetSceneCommand.js +39 -0
  65. package/dist-es/commands/GetWorkspaceCommand.js +39 -0
  66. package/dist-es/commands/ListComponentTypesCommand.js +39 -0
  67. package/dist-es/commands/ListEntitiesCommand.js +39 -0
  68. package/dist-es/commands/ListScenesCommand.js +39 -0
  69. package/dist-es/commands/ListTagsForResourceCommand.js +39 -0
  70. package/dist-es/commands/ListWorkspacesCommand.js +39 -0
  71. package/dist-es/commands/TagResourceCommand.js +39 -0
  72. package/dist-es/commands/UntagResourceCommand.js +39 -0
  73. package/dist-es/commands/UpdateComponentTypeCommand.js +39 -0
  74. package/dist-es/commands/UpdateEntityCommand.js +39 -0
  75. package/dist-es/commands/UpdateSceneCommand.js +39 -0
  76. package/dist-es/commands/UpdateWorkspaceCommand.js +39 -0
  77. package/dist-es/commands/index.js +26 -0
  78. package/dist-es/endpoints.js +126 -0
  79. package/dist-es/index.js +5 -0
  80. package/dist-es/models/index.js +1 -0
  81. package/dist-es/models/models_0.js +469 -0
  82. package/dist-es/pagination/GetPropertyValueHistoryPaginator.js +74 -0
  83. package/dist-es/pagination/Interfaces.js +1 -0
  84. package/dist-es/pagination/ListComponentTypesPaginator.js +74 -0
  85. package/dist-es/pagination/ListEntitiesPaginator.js +74 -0
  86. package/dist-es/pagination/ListScenesPaginator.js +74 -0
  87. package/dist-es/pagination/ListWorkspacesPaginator.js +74 -0
  88. package/dist-es/pagination/index.js +6 -0
  89. package/dist-es/protocols/Aws_restJson1.js +4853 -0
  90. package/dist-es/runtimeConfig.browser.js +17 -0
  91. package/dist-es/runtimeConfig.js +21 -0
  92. package/dist-es/runtimeConfig.native.js +8 -0
  93. package/dist-es/runtimeConfig.shared.js +13 -0
  94. package/dist-types/IoTTwinMaker.d.ts +206 -0
  95. package/dist-types/IoTTwinMakerClient.d.ts +175 -0
  96. package/dist-types/commands/BatchPutPropertyValuesCommand.d.ts +35 -0
  97. package/dist-types/commands/CreateComponentTypeCommand.d.ts +40 -0
  98. package/dist-types/commands/CreateEntityCommand.d.ts +35 -0
  99. package/dist-types/commands/CreateSceneCommand.d.ts +35 -0
  100. package/dist-types/commands/CreateWorkspaceCommand.d.ts +35 -0
  101. package/dist-types/commands/DeleteComponentTypeCommand.d.ts +35 -0
  102. package/dist-types/commands/DeleteEntityCommand.d.ts +35 -0
  103. package/dist-types/commands/DeleteSceneCommand.d.ts +35 -0
  104. package/dist-types/commands/DeleteWorkspaceCommand.d.ts +35 -0
  105. package/dist-types/commands/GetComponentTypeCommand.d.ts +35 -0
  106. package/dist-types/commands/GetEntityCommand.d.ts +35 -0
  107. package/dist-types/commands/GetPropertyValueCommand.d.ts +36 -0
  108. package/dist-types/commands/GetPropertyValueHistoryCommand.d.ts +37 -0
  109. package/dist-types/commands/GetSceneCommand.d.ts +35 -0
  110. package/dist-types/commands/GetWorkspaceCommand.d.ts +35 -0
  111. package/dist-types/commands/ListComponentTypesCommand.d.ts +35 -0
  112. package/dist-types/commands/ListEntitiesCommand.d.ts +35 -0
  113. package/dist-types/commands/ListScenesCommand.d.ts +35 -0
  114. package/dist-types/commands/ListTagsForResourceCommand.d.ts +35 -0
  115. package/dist-types/commands/ListWorkspacesCommand.d.ts +35 -0
  116. package/dist-types/commands/TagResourceCommand.d.ts +35 -0
  117. package/dist-types/commands/UntagResourceCommand.d.ts +35 -0
  118. package/dist-types/commands/UpdateComponentTypeCommand.d.ts +35 -0
  119. package/dist-types/commands/UpdateEntityCommand.d.ts +35 -0
  120. package/dist-types/commands/UpdateSceneCommand.d.ts +35 -0
  121. package/dist-types/commands/UpdateWorkspaceCommand.d.ts +35 -0
  122. package/dist-types/commands/index.d.ts +26 -0
  123. package/dist-types/endpoints.d.ts +2 -0
  124. package/dist-types/index.d.ts +5 -0
  125. package/dist-types/models/index.d.ts +1 -0
  126. package/dist-types/models/models_0.d.ts +2269 -0
  127. package/dist-types/pagination/GetPropertyValueHistoryPaginator.d.ts +4 -0
  128. package/dist-types/pagination/Interfaces.d.ts +6 -0
  129. package/dist-types/pagination/ListComponentTypesPaginator.d.ts +4 -0
  130. package/dist-types/pagination/ListEntitiesPaginator.d.ts +4 -0
  131. package/dist-types/pagination/ListScenesPaginator.d.ts +4 -0
  132. package/dist-types/pagination/ListWorkspacesPaginator.d.ts +4 -0
  133. package/dist-types/pagination/index.d.ts +6 -0
  134. package/dist-types/protocols/Aws_restJson1.d.ts +80 -0
  135. package/dist-types/runtimeConfig.browser.d.ts +39 -0
  136. package/dist-types/runtimeConfig.d.ts +39 -0
  137. package/dist-types/runtimeConfig.native.d.ts +38 -0
  138. package/dist-types/runtimeConfig.shared.d.ts +13 -0
  139. package/dist-types/ts3.4/IoTTwinMaker.d.ts +135 -0
  140. package/dist-types/ts3.4/IoTTwinMakerClient.d.ts +97 -0
  141. package/dist-types/ts3.4/commands/BatchPutPropertyValuesCommand.d.ts +17 -0
  142. package/dist-types/ts3.4/commands/CreateComponentTypeCommand.d.ts +17 -0
  143. package/dist-types/ts3.4/commands/CreateEntityCommand.d.ts +17 -0
  144. package/dist-types/ts3.4/commands/CreateSceneCommand.d.ts +17 -0
  145. package/dist-types/ts3.4/commands/CreateWorkspaceCommand.d.ts +17 -0
  146. package/dist-types/ts3.4/commands/DeleteComponentTypeCommand.d.ts +17 -0
  147. package/dist-types/ts3.4/commands/DeleteEntityCommand.d.ts +17 -0
  148. package/dist-types/ts3.4/commands/DeleteSceneCommand.d.ts +17 -0
  149. package/dist-types/ts3.4/commands/DeleteWorkspaceCommand.d.ts +17 -0
  150. package/dist-types/ts3.4/commands/GetComponentTypeCommand.d.ts +17 -0
  151. package/dist-types/ts3.4/commands/GetEntityCommand.d.ts +17 -0
  152. package/dist-types/ts3.4/commands/GetPropertyValueCommand.d.ts +17 -0
  153. package/dist-types/ts3.4/commands/GetPropertyValueHistoryCommand.d.ts +17 -0
  154. package/dist-types/ts3.4/commands/GetSceneCommand.d.ts +17 -0
  155. package/dist-types/ts3.4/commands/GetWorkspaceCommand.d.ts +17 -0
  156. package/dist-types/ts3.4/commands/ListComponentTypesCommand.d.ts +17 -0
  157. package/dist-types/ts3.4/commands/ListEntitiesCommand.d.ts +17 -0
  158. package/dist-types/ts3.4/commands/ListScenesCommand.d.ts +17 -0
  159. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +17 -0
  160. package/dist-types/ts3.4/commands/ListWorkspacesCommand.d.ts +17 -0
  161. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +17 -0
  162. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +17 -0
  163. package/dist-types/ts3.4/commands/UpdateComponentTypeCommand.d.ts +17 -0
  164. package/dist-types/ts3.4/commands/UpdateEntityCommand.d.ts +17 -0
  165. package/dist-types/ts3.4/commands/UpdateSceneCommand.d.ts +17 -0
  166. package/dist-types/ts3.4/commands/UpdateWorkspaceCommand.d.ts +17 -0
  167. package/dist-types/ts3.4/commands/index.d.ts +26 -0
  168. package/dist-types/ts3.4/endpoints.d.ts +2 -0
  169. package/dist-types/ts3.4/index.d.ts +5 -0
  170. package/dist-types/ts3.4/models/index.d.ts +1 -0
  171. package/dist-types/ts3.4/models/models_0.d.ts +1382 -0
  172. package/dist-types/ts3.4/pagination/GetPropertyValueHistoryPaginator.d.ts +4 -0
  173. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  174. package/dist-types/ts3.4/pagination/ListComponentTypesPaginator.d.ts +4 -0
  175. package/dist-types/ts3.4/pagination/ListEntitiesPaginator.d.ts +4 -0
  176. package/dist-types/ts3.4/pagination/ListScenesPaginator.d.ts +4 -0
  177. package/dist-types/ts3.4/pagination/ListWorkspacesPaginator.d.ts +4 -0
  178. package/dist-types/ts3.4/pagination/index.d.ts +6 -0
  179. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +80 -0
  180. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +37 -0
  181. package/dist-types/ts3.4/runtimeConfig.d.ts +37 -0
  182. package/dist-types/ts3.4/runtimeConfig.native.d.ts +36 -0
  183. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +11 -0
  184. package/package.json +94 -0
@@ -0,0 +1,2269 @@
1
+ import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
+ /**
3
+ * <p>Access is denied.</p>
4
+ */
5
+ export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
6
+ name: "AccessDeniedException";
7
+ $fault: "client";
8
+ message?: string;
9
+ }
10
+ export declare namespace AccessDeniedException {
11
+ /**
12
+ * @internal
13
+ */
14
+ const filterSensitiveLog: (obj: AccessDeniedException) => any;
15
+ }
16
+ /**
17
+ * <p>An object that uniquely identifies an entity property.</p>
18
+ */
19
+ export interface EntityPropertyReference {
20
+ /**
21
+ * <p>The name of the component.</p>
22
+ */
23
+ componentName?: string;
24
+ /**
25
+ * <p>A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.</p>
26
+ */
27
+ externalIdProperty?: {
28
+ [key: string]: string;
29
+ };
30
+ /**
31
+ * <p>The ID of the entity.</p>
32
+ */
33
+ entityId?: string;
34
+ /**
35
+ * <p>The name of the property.</p>
36
+ */
37
+ propertyName: string | undefined;
38
+ }
39
+ export declare namespace EntityPropertyReference {
40
+ /**
41
+ * @internal
42
+ */
43
+ const filterSensitiveLog: (obj: EntityPropertyReference) => any;
44
+ }
45
+ /**
46
+ * <p>A value that associates a component and an entity.</p>
47
+ */
48
+ export interface RelationshipValue {
49
+ /**
50
+ * <p>The ID of the target entity associated with this relationship value.</p>
51
+ */
52
+ targetEntityId?: string;
53
+ /**
54
+ * <p>The name of the target component associated with the relationship value.</p>
55
+ */
56
+ targetComponentName?: string;
57
+ }
58
+ export declare namespace RelationshipValue {
59
+ /**
60
+ * @internal
61
+ */
62
+ const filterSensitiveLog: (obj: RelationshipValue) => any;
63
+ }
64
+ /**
65
+ * <p>An unexpected error has occurred.</p>
66
+ */
67
+ export interface InternalServerException extends __SmithyException, $MetadataBearer {
68
+ name: "InternalServerException";
69
+ $fault: "server";
70
+ message?: string;
71
+ }
72
+ export declare namespace InternalServerException {
73
+ /**
74
+ * @internal
75
+ */
76
+ const filterSensitiveLog: (obj: InternalServerException) => any;
77
+ }
78
+ /**
79
+ * <p>The resource wasn't found.</p>
80
+ */
81
+ export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
82
+ name: "ResourceNotFoundException";
83
+ $fault: "client";
84
+ message?: string;
85
+ }
86
+ export declare namespace ResourceNotFoundException {
87
+ /**
88
+ * @internal
89
+ */
90
+ const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
91
+ }
92
+ /**
93
+ * <p>The rate exceeds the limit.</p>
94
+ */
95
+ export interface ThrottlingException extends __SmithyException, $MetadataBearer {
96
+ name: "ThrottlingException";
97
+ $fault: "client";
98
+ message?: string;
99
+ }
100
+ export declare namespace ThrottlingException {
101
+ /**
102
+ * @internal
103
+ */
104
+ const filterSensitiveLog: (obj: ThrottlingException) => any;
105
+ }
106
+ /**
107
+ * <p>Failed</p>
108
+ */
109
+ export interface ValidationException extends __SmithyException, $MetadataBearer {
110
+ name: "ValidationException";
111
+ $fault: "client";
112
+ message?: string;
113
+ }
114
+ export declare namespace ValidationException {
115
+ /**
116
+ * @internal
117
+ */
118
+ const filterSensitiveLog: (obj: ValidationException) => any;
119
+ }
120
+ /**
121
+ * <p>A conflict occurred.</p>
122
+ */
123
+ export interface ConflictException extends __SmithyException, $MetadataBearer {
124
+ name: "ConflictException";
125
+ $fault: "client";
126
+ message?: string;
127
+ }
128
+ export declare namespace ConflictException {
129
+ /**
130
+ * @internal
131
+ */
132
+ const filterSensitiveLog: (obj: ConflictException) => any;
133
+ }
134
+ /**
135
+ * <p>The Lambda function.</p>
136
+ */
137
+ export interface LambdaFunction {
138
+ /**
139
+ * <p>The ARN of the Lambda function.</p>
140
+ */
141
+ arn: string | undefined;
142
+ }
143
+ export declare namespace LambdaFunction {
144
+ /**
145
+ * @internal
146
+ */
147
+ const filterSensitiveLog: (obj: LambdaFunction) => any;
148
+ }
149
+ /**
150
+ * <p>The data connector.</p>
151
+ */
152
+ export interface DataConnector {
153
+ /**
154
+ * <p>The Lambda function associated with this data connector.</p>
155
+ */
156
+ lambda?: LambdaFunction;
157
+ /**
158
+ * <p>A Boolean value that specifies whether the data connector is native to TwinMaker.</p>
159
+ */
160
+ isNative?: boolean;
161
+ }
162
+ export declare namespace DataConnector {
163
+ /**
164
+ * @internal
165
+ */
166
+ const filterSensitiveLog: (obj: DataConnector) => any;
167
+ }
168
+ export declare enum Scope {
169
+ ENTITY = "ENTITY",
170
+ WORKSPACE = "WORKSPACE"
171
+ }
172
+ /**
173
+ * <p>The function request body.</p>
174
+ */
175
+ export interface FunctionRequest {
176
+ /**
177
+ * <p>The required properties of the function.</p>
178
+ */
179
+ requiredProperties?: string[];
180
+ /**
181
+ * <p>The scope of the function.</p>
182
+ */
183
+ scope?: Scope | string;
184
+ /**
185
+ * <p>The data connector.</p>
186
+ */
187
+ implementedBy?: DataConnector;
188
+ }
189
+ export declare namespace FunctionRequest {
190
+ /**
191
+ * @internal
192
+ */
193
+ const filterSensitiveLog: (obj: FunctionRequest) => any;
194
+ }
195
+ /**
196
+ * <p>An object that specifies a relationship with another component type.</p>
197
+ */
198
+ export interface Relationship {
199
+ /**
200
+ * <p>The ID of the target component type associated with this relationship.</p>
201
+ */
202
+ targetComponentTypeId?: string;
203
+ /**
204
+ * <p>The type of the relationship.</p>
205
+ */
206
+ relationshipType?: string;
207
+ }
208
+ export declare namespace Relationship {
209
+ /**
210
+ * @internal
211
+ */
212
+ const filterSensitiveLog: (obj: Relationship) => any;
213
+ }
214
+ export declare enum Type {
215
+ BOOLEAN = "BOOLEAN",
216
+ DOUBLE = "DOUBLE",
217
+ INTEGER = "INTEGER",
218
+ LIST = "LIST",
219
+ LONG = "LONG",
220
+ MAP = "MAP",
221
+ RELATIONSHIP = "RELATIONSHIP",
222
+ STRING = "STRING"
223
+ }
224
+ export declare enum State {
225
+ ACTIVE = "ACTIVE",
226
+ CREATING = "CREATING",
227
+ DELETING = "DELETING",
228
+ ERROR = "ERROR",
229
+ UPDATING = "UPDATING"
230
+ }
231
+ export interface CreateComponentTypeResponse {
232
+ /**
233
+ * <p>The ARN of the component type.</p>
234
+ */
235
+ arn: string | undefined;
236
+ /**
237
+ * <p>The date and time when the entity was created.</p>
238
+ */
239
+ creationDateTime: Date | undefined;
240
+ /**
241
+ * <p>The current state of the component type.</p>
242
+ */
243
+ state: State | string | undefined;
244
+ }
245
+ export declare namespace CreateComponentTypeResponse {
246
+ /**
247
+ * @internal
248
+ */
249
+ const filterSensitiveLog: (obj: CreateComponentTypeResponse) => any;
250
+ }
251
+ /**
252
+ * <p>The service quota was exceeded.</p>
253
+ */
254
+ export interface ServiceQuotaExceededException extends __SmithyException, $MetadataBearer {
255
+ name: "ServiceQuotaExceededException";
256
+ $fault: "client";
257
+ message?: string;
258
+ }
259
+ export declare namespace ServiceQuotaExceededException {
260
+ /**
261
+ * @internal
262
+ */
263
+ const filterSensitiveLog: (obj: ServiceQuotaExceededException) => any;
264
+ }
265
+ export declare enum PropertyUpdateType {
266
+ DELETE = "DELETE",
267
+ UPDATE = "UPDATE"
268
+ }
269
+ export interface CreateEntityResponse {
270
+ /**
271
+ * <p>The ID of the entity.</p>
272
+ */
273
+ entityId: string | undefined;
274
+ /**
275
+ * <p>The ARN of the entity.</p>
276
+ */
277
+ arn: string | undefined;
278
+ /**
279
+ * <p>The date and time when the entity was created.</p>
280
+ */
281
+ creationDateTime: Date | undefined;
282
+ /**
283
+ * <p>The current state of the entity.</p>
284
+ */
285
+ state: State | string | undefined;
286
+ }
287
+ export declare namespace CreateEntityResponse {
288
+ /**
289
+ * @internal
290
+ */
291
+ const filterSensitiveLog: (obj: CreateEntityResponse) => any;
292
+ }
293
+ export interface CreateSceneRequest {
294
+ /**
295
+ * <p>The ID of the workspace that contains the scene.</p>
296
+ */
297
+ workspaceId: string | undefined;
298
+ /**
299
+ * <p>The ID of the scene.</p>
300
+ */
301
+ sceneId: string | undefined;
302
+ /**
303
+ * <p>The relative path that specifies the location of the content definition file.</p>
304
+ */
305
+ contentLocation: string | undefined;
306
+ /**
307
+ * <p>The description for this scene.</p>
308
+ */
309
+ description?: string;
310
+ /**
311
+ * <p>A list of capabilities that the scene uses to render itself.</p>
312
+ */
313
+ capabilities?: string[];
314
+ /**
315
+ * <p>Metadata that you can use to manage the scene.</p>
316
+ */
317
+ tags?: {
318
+ [key: string]: string;
319
+ };
320
+ }
321
+ export declare namespace CreateSceneRequest {
322
+ /**
323
+ * @internal
324
+ */
325
+ const filterSensitiveLog: (obj: CreateSceneRequest) => any;
326
+ }
327
+ export interface CreateSceneResponse {
328
+ /**
329
+ * <p>The ARN of the scene.</p>
330
+ */
331
+ arn: string | undefined;
332
+ /**
333
+ * <p>The date and time when the scene was created.</p>
334
+ */
335
+ creationDateTime: Date | undefined;
336
+ }
337
+ export declare namespace CreateSceneResponse {
338
+ /**
339
+ * @internal
340
+ */
341
+ const filterSensitiveLog: (obj: CreateSceneResponse) => any;
342
+ }
343
+ export interface CreateWorkspaceRequest {
344
+ /**
345
+ * <p>The ID of the workspace.</p>
346
+ */
347
+ workspaceId: string | undefined;
348
+ /**
349
+ * <p>The description of the workspace.</p>
350
+ */
351
+ description?: string;
352
+ /**
353
+ * <p>The ARN of the S3 bucket where resources associated with the workspace are stored.</p>
354
+ */
355
+ s3Location: string | undefined;
356
+ /**
357
+ * <p>The ARN of the execution role associated with the workspace.</p>
358
+ */
359
+ role: string | undefined;
360
+ /**
361
+ * <p>Metadata that you can use to manage the workspace</p>
362
+ */
363
+ tags?: {
364
+ [key: string]: string;
365
+ };
366
+ }
367
+ export declare namespace CreateWorkspaceRequest {
368
+ /**
369
+ * @internal
370
+ */
371
+ const filterSensitiveLog: (obj: CreateWorkspaceRequest) => any;
372
+ }
373
+ export interface CreateWorkspaceResponse {
374
+ /**
375
+ * <p>The ARN of the workspace.</p>
376
+ */
377
+ arn: string | undefined;
378
+ /**
379
+ * <p>The date and time when the workspace was created.</p>
380
+ */
381
+ creationDateTime: Date | undefined;
382
+ }
383
+ export declare namespace CreateWorkspaceResponse {
384
+ /**
385
+ * @internal
386
+ */
387
+ const filterSensitiveLog: (obj: CreateWorkspaceResponse) => any;
388
+ }
389
+ export interface DeleteComponentTypeRequest {
390
+ /**
391
+ * <p>The ID of the workspace that contains the component type.</p>
392
+ */
393
+ workspaceId: string | undefined;
394
+ /**
395
+ * <p>The ID of the component type to delete.</p>
396
+ */
397
+ componentTypeId: string | undefined;
398
+ }
399
+ export declare namespace DeleteComponentTypeRequest {
400
+ /**
401
+ * @internal
402
+ */
403
+ const filterSensitiveLog: (obj: DeleteComponentTypeRequest) => any;
404
+ }
405
+ export interface DeleteComponentTypeResponse {
406
+ /**
407
+ * <p>The current state of the component type to be deleted.</p>
408
+ */
409
+ state: State | string | undefined;
410
+ }
411
+ export declare namespace DeleteComponentTypeResponse {
412
+ /**
413
+ * @internal
414
+ */
415
+ const filterSensitiveLog: (obj: DeleteComponentTypeResponse) => any;
416
+ }
417
+ export interface DeleteEntityRequest {
418
+ /**
419
+ * <p>The ID of the workspace that contains the entity to delete.</p>
420
+ */
421
+ workspaceId: string | undefined;
422
+ /**
423
+ * <p>The ID of the entity to delete.</p>
424
+ */
425
+ entityId: string | undefined;
426
+ /**
427
+ * <p>A Boolean value that specifies whether the operation deletes child entities.</p>
428
+ */
429
+ isRecursive?: boolean;
430
+ }
431
+ export declare namespace DeleteEntityRequest {
432
+ /**
433
+ * @internal
434
+ */
435
+ const filterSensitiveLog: (obj: DeleteEntityRequest) => any;
436
+ }
437
+ export interface DeleteEntityResponse {
438
+ /**
439
+ * <p>The current state of the deleted entity.</p>
440
+ */
441
+ state: State | string | undefined;
442
+ }
443
+ export declare namespace DeleteEntityResponse {
444
+ /**
445
+ * @internal
446
+ */
447
+ const filterSensitiveLog: (obj: DeleteEntityResponse) => any;
448
+ }
449
+ export interface DeleteSceneRequest {
450
+ /**
451
+ * <p>The ID of the workspace.</p>
452
+ */
453
+ workspaceId: string | undefined;
454
+ /**
455
+ * <p>The ID of the scene to delete.</p>
456
+ */
457
+ sceneId: string | undefined;
458
+ }
459
+ export declare namespace DeleteSceneRequest {
460
+ /**
461
+ * @internal
462
+ */
463
+ const filterSensitiveLog: (obj: DeleteSceneRequest) => any;
464
+ }
465
+ export interface DeleteSceneResponse {
466
+ }
467
+ export declare namespace DeleteSceneResponse {
468
+ /**
469
+ * @internal
470
+ */
471
+ const filterSensitiveLog: (obj: DeleteSceneResponse) => any;
472
+ }
473
+ export interface DeleteWorkspaceRequest {
474
+ /**
475
+ * <p>The ID of the workspace to delete.</p>
476
+ */
477
+ workspaceId: string | undefined;
478
+ }
479
+ export declare namespace DeleteWorkspaceRequest {
480
+ /**
481
+ * @internal
482
+ */
483
+ const filterSensitiveLog: (obj: DeleteWorkspaceRequest) => any;
484
+ }
485
+ export interface DeleteWorkspaceResponse {
486
+ }
487
+ export declare namespace DeleteWorkspaceResponse {
488
+ /**
489
+ * @internal
490
+ */
491
+ const filterSensitiveLog: (obj: DeleteWorkspaceResponse) => any;
492
+ }
493
+ export interface GetComponentTypeRequest {
494
+ /**
495
+ * <p>The ID of the workspace that contains the component type.</p>
496
+ */
497
+ workspaceId: string | undefined;
498
+ /**
499
+ * <p>The ID of the component type.</p>
500
+ */
501
+ componentTypeId: string | undefined;
502
+ }
503
+ export declare namespace GetComponentTypeRequest {
504
+ /**
505
+ * @internal
506
+ */
507
+ const filterSensitiveLog: (obj: GetComponentTypeRequest) => any;
508
+ }
509
+ /**
510
+ * <p>The function response.</p>
511
+ */
512
+ export interface FunctionResponse {
513
+ /**
514
+ * <p>The required properties of the function.</p>
515
+ */
516
+ requiredProperties?: string[];
517
+ /**
518
+ * <p>The scope of the function.</p>
519
+ */
520
+ scope?: Scope | string;
521
+ /**
522
+ * <p>The data connector.</p>
523
+ */
524
+ implementedBy?: DataConnector;
525
+ /**
526
+ * <p>Indicates whether this function is inherited.</p>
527
+ */
528
+ isInherited?: boolean;
529
+ }
530
+ export declare namespace FunctionResponse {
531
+ /**
532
+ * @internal
533
+ */
534
+ const filterSensitiveLog: (obj: FunctionResponse) => any;
535
+ }
536
+ export declare enum ErrorCode {
537
+ INTERNAL_FAILURE = "INTERNAL_FAILURE",
538
+ VALIDATION_ERROR = "VALIDATION_ERROR"
539
+ }
540
+ /**
541
+ * <p>The error details.</p>
542
+ */
543
+ export interface ErrorDetails {
544
+ /**
545
+ * <p>The error code.</p>
546
+ */
547
+ code?: ErrorCode | string;
548
+ /**
549
+ * <p>The error message.</p>
550
+ */
551
+ message?: string;
552
+ }
553
+ export declare namespace ErrorDetails {
554
+ /**
555
+ * @internal
556
+ */
557
+ const filterSensitiveLog: (obj: ErrorDetails) => any;
558
+ }
559
+ /**
560
+ * <p>An object that represents the status of an entity, component, component type, or workspace.</p>
561
+ */
562
+ export interface Status {
563
+ /**
564
+ * <p>The current state of the entity, component, component type, or workspace.</p>
565
+ */
566
+ state?: State | string;
567
+ /**
568
+ * <p>The error message.</p>
569
+ */
570
+ error?: ErrorDetails;
571
+ }
572
+ export declare namespace Status {
573
+ /**
574
+ * @internal
575
+ */
576
+ const filterSensitiveLog: (obj: Status) => any;
577
+ }
578
+ export interface GetEntityRequest {
579
+ /**
580
+ * <p>The ID of the workspace.</p>
581
+ */
582
+ workspaceId: string | undefined;
583
+ /**
584
+ * <p>The ID of the entity.</p>
585
+ */
586
+ entityId: string | undefined;
587
+ }
588
+ export declare namespace GetEntityRequest {
589
+ /**
590
+ * @internal
591
+ */
592
+ const filterSensitiveLog: (obj: GetEntityRequest) => any;
593
+ }
594
+ /**
595
+ * <p>The connector failed.</p>
596
+ */
597
+ export interface ConnectorFailureException extends __SmithyException, $MetadataBearer {
598
+ name: "ConnectorFailureException";
599
+ $fault: "client";
600
+ message?: string;
601
+ }
602
+ export declare namespace ConnectorFailureException {
603
+ /**
604
+ * @internal
605
+ */
606
+ const filterSensitiveLog: (obj: ConnectorFailureException) => any;
607
+ }
608
+ /**
609
+ * <p>The connector timed out.</p>
610
+ */
611
+ export interface ConnectorTimeoutException extends __SmithyException, $MetadataBearer {
612
+ name: "ConnectorTimeoutException";
613
+ $fault: "client";
614
+ message?: string;
615
+ }
616
+ export declare namespace ConnectorTimeoutException {
617
+ /**
618
+ * @internal
619
+ */
620
+ const filterSensitiveLog: (obj: ConnectorTimeoutException) => any;
621
+ }
622
+ export interface GetPropertyValueRequest {
623
+ /**
624
+ * <p>The name of the component whose property values the operation returns.</p>
625
+ */
626
+ componentName?: string;
627
+ /**
628
+ * <p>The ID of the component type whose property values the operation returns.</p>
629
+ */
630
+ componentTypeId?: string;
631
+ /**
632
+ * <p>The ID of the entity whose property values the operation returns.</p>
633
+ */
634
+ entityId?: string;
635
+ /**
636
+ * <p>The properties whose values the operation returns.</p>
637
+ */
638
+ selectedProperties: string[] | undefined;
639
+ /**
640
+ * <p>The ID of the workspace whose values the operation returns.</p>
641
+ */
642
+ workspaceId: string | undefined;
643
+ }
644
+ export declare namespace GetPropertyValueRequest {
645
+ /**
646
+ * @internal
647
+ */
648
+ const filterSensitiveLog: (obj: GetPropertyValueRequest) => any;
649
+ }
650
+ export declare enum InterpolationType {
651
+ LINEAR = "LINEAR"
652
+ }
653
+ /**
654
+ * <p>An object that specifies how to interpolate data in a list.</p>
655
+ */
656
+ export interface InterpolationParameters {
657
+ /**
658
+ * <p>The interpolation type.</p>
659
+ */
660
+ interpolationType?: InterpolationType | string;
661
+ /**
662
+ * <p>The interpolation time interval in seconds.</p>
663
+ */
664
+ intervalInSeconds?: number;
665
+ }
666
+ export declare namespace InterpolationParameters {
667
+ /**
668
+ * @internal
669
+ */
670
+ const filterSensitiveLog: (obj: InterpolationParameters) => any;
671
+ }
672
+ export declare enum OrderByTime {
673
+ ASCENDING = "ASCENDING",
674
+ DESCENDING = "DESCENDING"
675
+ }
676
+ export interface GetSceneRequest {
677
+ /**
678
+ * <p>The ID of the workspace that contains the scene.</p>
679
+ */
680
+ workspaceId: string | undefined;
681
+ /**
682
+ * <p>The ID of the scene.</p>
683
+ */
684
+ sceneId: string | undefined;
685
+ }
686
+ export declare namespace GetSceneRequest {
687
+ /**
688
+ * @internal
689
+ */
690
+ const filterSensitiveLog: (obj: GetSceneRequest) => any;
691
+ }
692
+ export interface GetSceneResponse {
693
+ /**
694
+ * <p>The ID of the workspace that contains the scene.</p>
695
+ */
696
+ workspaceId: string | undefined;
697
+ /**
698
+ * <p>The ID of the scene.</p>
699
+ */
700
+ sceneId: string | undefined;
701
+ /**
702
+ * <p>The relative path that specifies the location of the content definition file.</p>
703
+ */
704
+ contentLocation: string | undefined;
705
+ /**
706
+ * <p>The ARN of the scene.</p>
707
+ */
708
+ arn: string | undefined;
709
+ /**
710
+ * <p>The date and time when the scene was created.</p>
711
+ */
712
+ creationDateTime: Date | undefined;
713
+ /**
714
+ * <p>The date and time when the scene was last updated.</p>
715
+ */
716
+ updateDateTime: Date | undefined;
717
+ /**
718
+ * <p>The description of the scene.</p>
719
+ */
720
+ description?: string;
721
+ /**
722
+ * <p>A list of capabilities that the scene uses to render.</p>
723
+ */
724
+ capabilities?: string[];
725
+ }
726
+ export declare namespace GetSceneResponse {
727
+ /**
728
+ * @internal
729
+ */
730
+ const filterSensitiveLog: (obj: GetSceneResponse) => any;
731
+ }
732
+ export interface GetWorkspaceRequest {
733
+ /**
734
+ * <p>The ID of the workspace.</p>
735
+ */
736
+ workspaceId: string | undefined;
737
+ }
738
+ export declare namespace GetWorkspaceRequest {
739
+ /**
740
+ * @internal
741
+ */
742
+ const filterSensitiveLog: (obj: GetWorkspaceRequest) => any;
743
+ }
744
+ export interface GetWorkspaceResponse {
745
+ /**
746
+ * <p>The ID of the workspace.</p>
747
+ */
748
+ workspaceId: string | undefined;
749
+ /**
750
+ * <p>The ARN of the workspace.</p>
751
+ */
752
+ arn: string | undefined;
753
+ /**
754
+ * <p>The description of the workspace.</p>
755
+ */
756
+ description?: string;
757
+ /**
758
+ * <p>The ARN of the S3 bucket where resources associated with the workspace are stored.</p>
759
+ */
760
+ s3Location: string | undefined;
761
+ /**
762
+ * <p>The ARN of the execution role associated with the workspace.</p>
763
+ */
764
+ role: string | undefined;
765
+ /**
766
+ * <p>The date and time when the workspace was created.</p>
767
+ */
768
+ creationDateTime: Date | undefined;
769
+ /**
770
+ * <p>The date and time when the workspace was last updated.</p>
771
+ */
772
+ updateDateTime: Date | undefined;
773
+ }
774
+ export declare namespace GetWorkspaceResponse {
775
+ /**
776
+ * @internal
777
+ */
778
+ const filterSensitiveLog: (obj: GetWorkspaceResponse) => any;
779
+ }
780
+ /**
781
+ * <p>An object that filters items in a list of component types.</p>
782
+ */
783
+ export declare type ListComponentTypesFilter = ListComponentTypesFilter.ExtendsFromMember | ListComponentTypesFilter.IsAbstractMember | ListComponentTypesFilter.NamespaceMember | ListComponentTypesFilter.$UnknownMember;
784
+ export declare namespace ListComponentTypesFilter {
785
+ /**
786
+ * <p>The component type that the component types in the list extend.</p>
787
+ */
788
+ interface ExtendsFromMember {
789
+ extendsFrom: string;
790
+ namespace?: never;
791
+ isAbstract?: never;
792
+ $unknown?: never;
793
+ }
794
+ /**
795
+ * <p>The namespace to which the component types in the list belong.</p>
796
+ */
797
+ interface NamespaceMember {
798
+ extendsFrom?: never;
799
+ namespace: string;
800
+ isAbstract?: never;
801
+ $unknown?: never;
802
+ }
803
+ /**
804
+ * <p>A Boolean value that specifies whether the component types in the list are abstract.</p>
805
+ */
806
+ interface IsAbstractMember {
807
+ extendsFrom?: never;
808
+ namespace?: never;
809
+ isAbstract: boolean;
810
+ $unknown?: never;
811
+ }
812
+ interface $UnknownMember {
813
+ extendsFrom?: never;
814
+ namespace?: never;
815
+ isAbstract?: never;
816
+ $unknown: [string, any];
817
+ }
818
+ interface Visitor<T> {
819
+ extendsFrom: (value: string) => T;
820
+ namespace: (value: string) => T;
821
+ isAbstract: (value: boolean) => T;
822
+ _: (name: string, value: any) => T;
823
+ }
824
+ const visit: <T>(value: ListComponentTypesFilter, visitor: Visitor<T>) => T;
825
+ /**
826
+ * @internal
827
+ */
828
+ const filterSensitiveLog: (obj: ListComponentTypesFilter) => any;
829
+ }
830
+ export interface ListComponentTypesRequest {
831
+ /**
832
+ * <p>The ID of the workspace.</p>
833
+ */
834
+ workspaceId: string | undefined;
835
+ /**
836
+ * <p>A list of objects that filter the request.</p>
837
+ */
838
+ filters?: ListComponentTypesFilter[];
839
+ /**
840
+ * <p>The string that specifies the next page of results.</p>
841
+ */
842
+ nextToken?: string;
843
+ /**
844
+ * <p>The maximum number of results to display.</p>
845
+ */
846
+ maxResults?: number;
847
+ }
848
+ export declare namespace ListComponentTypesRequest {
849
+ /**
850
+ * @internal
851
+ */
852
+ const filterSensitiveLog: (obj: ListComponentTypesRequest) => any;
853
+ }
854
+ /**
855
+ * <p>An object that contains information about a component type.</p>
856
+ */
857
+ export interface ComponentTypeSummary {
858
+ /**
859
+ * <p>The ARN of the component type.</p>
860
+ */
861
+ arn: string | undefined;
862
+ /**
863
+ * <p>The ID of the component type.</p>
864
+ */
865
+ componentTypeId: string | undefined;
866
+ /**
867
+ * <p>The date and time when the component type was created.</p>
868
+ */
869
+ creationDateTime: Date | undefined;
870
+ /**
871
+ * <p>The date and time when the component type was last updated.</p>
872
+ */
873
+ updateDateTime: Date | undefined;
874
+ /**
875
+ * <p>The description of the component type.</p>
876
+ */
877
+ description?: string;
878
+ /**
879
+ * <p>The current status of the component type.</p>
880
+ */
881
+ status?: Status;
882
+ }
883
+ export declare namespace ComponentTypeSummary {
884
+ /**
885
+ * @internal
886
+ */
887
+ const filterSensitiveLog: (obj: ComponentTypeSummary) => any;
888
+ }
889
+ export interface ListComponentTypesResponse {
890
+ /**
891
+ * <p>The ID of the workspace.</p>
892
+ */
893
+ workspaceId: string | undefined;
894
+ /**
895
+ * <p>A list of objects that contain information about the component types.</p>
896
+ */
897
+ componentTypeSummaries: ComponentTypeSummary[] | undefined;
898
+ /**
899
+ * <p>The string that specifies the next page of results.</p>
900
+ */
901
+ nextToken?: string;
902
+ /**
903
+ * <p>Specifies the maximum number of results to display.</p>
904
+ */
905
+ maxResults?: number;
906
+ }
907
+ export declare namespace ListComponentTypesResponse {
908
+ /**
909
+ * @internal
910
+ */
911
+ const filterSensitiveLog: (obj: ListComponentTypesResponse) => any;
912
+ }
913
+ /**
914
+ * <p>An object that filters items in a list of entities.</p>
915
+ */
916
+ export declare type ListEntitiesFilter = ListEntitiesFilter.ComponentTypeIdMember | ListEntitiesFilter.ParentEntityIdMember | ListEntitiesFilter.$UnknownMember;
917
+ export declare namespace ListEntitiesFilter {
918
+ /**
919
+ * <p>The parent of the entities in the list.</p>
920
+ */
921
+ interface ParentEntityIdMember {
922
+ parentEntityId: string;
923
+ componentTypeId?: never;
924
+ $unknown?: never;
925
+ }
926
+ /**
927
+ * <p>The ID of the component type in the entities in the list.</p>
928
+ */
929
+ interface ComponentTypeIdMember {
930
+ parentEntityId?: never;
931
+ componentTypeId: string;
932
+ $unknown?: never;
933
+ }
934
+ interface $UnknownMember {
935
+ parentEntityId?: never;
936
+ componentTypeId?: never;
937
+ $unknown: [string, any];
938
+ }
939
+ interface Visitor<T> {
940
+ parentEntityId: (value: string) => T;
941
+ componentTypeId: (value: string) => T;
942
+ _: (name: string, value: any) => T;
943
+ }
944
+ const visit: <T>(value: ListEntitiesFilter, visitor: Visitor<T>) => T;
945
+ /**
946
+ * @internal
947
+ */
948
+ const filterSensitiveLog: (obj: ListEntitiesFilter) => any;
949
+ }
950
+ export interface ListEntitiesRequest {
951
+ /**
952
+ * <p>The ID of the workspace.</p>
953
+ */
954
+ workspaceId: string | undefined;
955
+ /**
956
+ * <p>A list of objects that filter the request.</p>
957
+ */
958
+ filters?: ListEntitiesFilter[];
959
+ /**
960
+ * <p>The maximum number of results to display.</p>
961
+ */
962
+ maxResults?: number;
963
+ /**
964
+ * <p>The string that specifies the next page of results.</p>
965
+ */
966
+ nextToken?: string;
967
+ }
968
+ export declare namespace ListEntitiesRequest {
969
+ /**
970
+ * @internal
971
+ */
972
+ const filterSensitiveLog: (obj: ListEntitiesRequest) => any;
973
+ }
974
+ /**
975
+ * <p>An object that contains information about an entity.</p>
976
+ */
977
+ export interface EntitySummary {
978
+ /**
979
+ * <p>The ID of the entity.</p>
980
+ */
981
+ entityId: string | undefined;
982
+ /**
983
+ * <p>The name of the entity.</p>
984
+ */
985
+ entityName: string | undefined;
986
+ /**
987
+ * <p>The ARN of the entity.</p>
988
+ */
989
+ arn: string | undefined;
990
+ /**
991
+ * <p>The ID of the parent entity.</p>
992
+ */
993
+ parentEntityId?: string;
994
+ /**
995
+ * <p>The current status of the entity.</p>
996
+ */
997
+ status: Status | undefined;
998
+ /**
999
+ * <p>The description of the entity.</p>
1000
+ */
1001
+ description?: string;
1002
+ /**
1003
+ * <p>A Boolean value that specifies whether the entity has child entities or not.</p>
1004
+ */
1005
+ hasChildEntities?: boolean;
1006
+ /**
1007
+ * <p>The date and time when the entity was created.</p>
1008
+ */
1009
+ creationDateTime: Date | undefined;
1010
+ /**
1011
+ * <p>The last date and time when the entity was updated.</p>
1012
+ */
1013
+ updateDateTime: Date | undefined;
1014
+ }
1015
+ export declare namespace EntitySummary {
1016
+ /**
1017
+ * @internal
1018
+ */
1019
+ const filterSensitiveLog: (obj: EntitySummary) => any;
1020
+ }
1021
+ export interface ListEntitiesResponse {
1022
+ /**
1023
+ * <p>A list of objects that contain information about the entities.</p>
1024
+ */
1025
+ entitySummaries?: EntitySummary[];
1026
+ /**
1027
+ * <p>The string that specifies the next page of results.</p>
1028
+ */
1029
+ nextToken?: string;
1030
+ }
1031
+ export declare namespace ListEntitiesResponse {
1032
+ /**
1033
+ * @internal
1034
+ */
1035
+ const filterSensitiveLog: (obj: ListEntitiesResponse) => any;
1036
+ }
1037
+ export interface ListScenesRequest {
1038
+ /**
1039
+ * <p>The ID of the workspace that contains the scenes.</p>
1040
+ */
1041
+ workspaceId: string | undefined;
1042
+ /**
1043
+ * <p>Specifies the maximum number of results to display.</p>
1044
+ */
1045
+ maxResults?: number;
1046
+ /**
1047
+ * <p>The string that specifies the next page of results.</p>
1048
+ */
1049
+ nextToken?: string;
1050
+ }
1051
+ export declare namespace ListScenesRequest {
1052
+ /**
1053
+ * @internal
1054
+ */
1055
+ const filterSensitiveLog: (obj: ListScenesRequest) => any;
1056
+ }
1057
+ /**
1058
+ * <p>An object that contains information about a scene.</p>
1059
+ */
1060
+ export interface SceneSummary {
1061
+ /**
1062
+ * <p>The ID of the scene.</p>
1063
+ */
1064
+ sceneId: string | undefined;
1065
+ /**
1066
+ * <p>The relative path that specifies the location of the content definition file.</p>
1067
+ */
1068
+ contentLocation: string | undefined;
1069
+ /**
1070
+ * <p>The ARN of the scene.</p>
1071
+ */
1072
+ arn: string | undefined;
1073
+ /**
1074
+ * <p>The date and time when the scene was created.</p>
1075
+ */
1076
+ creationDateTime: Date | undefined;
1077
+ /**
1078
+ * <p>The date and time when the scene was last updated.</p>
1079
+ */
1080
+ updateDateTime: Date | undefined;
1081
+ /**
1082
+ * <p>The scene description.</p>
1083
+ */
1084
+ description?: string;
1085
+ }
1086
+ export declare namespace SceneSummary {
1087
+ /**
1088
+ * @internal
1089
+ */
1090
+ const filterSensitiveLog: (obj: SceneSummary) => any;
1091
+ }
1092
+ export interface ListScenesResponse {
1093
+ /**
1094
+ * <p>A list of objects that contain information about the scenes.</p>
1095
+ */
1096
+ sceneSummaries?: SceneSummary[];
1097
+ /**
1098
+ * <p>The string that specifies the next page of results.</p>
1099
+ */
1100
+ nextToken?: string;
1101
+ }
1102
+ export declare namespace ListScenesResponse {
1103
+ /**
1104
+ * @internal
1105
+ */
1106
+ const filterSensitiveLog: (obj: ListScenesResponse) => any;
1107
+ }
1108
+ export interface ListTagsForResourceRequest {
1109
+ /**
1110
+ * <p>The ARN of the resource.</p>
1111
+ */
1112
+ resourceARN: string | undefined;
1113
+ /**
1114
+ * <p>The maximum number of results to display.</p>
1115
+ */
1116
+ maxResults?: number;
1117
+ /**
1118
+ * <p>The string that specifies the next page of results.</p>
1119
+ */
1120
+ nextToken?: string;
1121
+ }
1122
+ export declare namespace ListTagsForResourceRequest {
1123
+ /**
1124
+ * @internal
1125
+ */
1126
+ const filterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
1127
+ }
1128
+ export interface ListTagsForResourceResponse {
1129
+ /**
1130
+ * <p>Metadata that you can use to manage a resource.</p>
1131
+ */
1132
+ tags?: {
1133
+ [key: string]: string;
1134
+ };
1135
+ /**
1136
+ * <p>The string that specifies the next page of results.</p>
1137
+ */
1138
+ nextToken?: string;
1139
+ }
1140
+ export declare namespace ListTagsForResourceResponse {
1141
+ /**
1142
+ * @internal
1143
+ */
1144
+ const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
1145
+ }
1146
+ export interface ListWorkspacesRequest {
1147
+ /**
1148
+ * <p>The maximum number of results to display.</p>
1149
+ */
1150
+ maxResults?: number;
1151
+ /**
1152
+ * <p>The string that specifies the next page of results.</p>
1153
+ */
1154
+ nextToken?: string;
1155
+ }
1156
+ export declare namespace ListWorkspacesRequest {
1157
+ /**
1158
+ * @internal
1159
+ */
1160
+ const filterSensitiveLog: (obj: ListWorkspacesRequest) => any;
1161
+ }
1162
+ /**
1163
+ * <p>An object that contains information about a workspace.</p>
1164
+ */
1165
+ export interface WorkspaceSummary {
1166
+ /**
1167
+ * <p>The ID of the workspace.</p>
1168
+ */
1169
+ workspaceId: string | undefined;
1170
+ /**
1171
+ * <p>The ARN of the workspace.</p>
1172
+ */
1173
+ arn: string | undefined;
1174
+ /**
1175
+ * <p>The description of the workspace.</p>
1176
+ */
1177
+ description?: string;
1178
+ /**
1179
+ * <p>The date and time when the workspace was created.</p>
1180
+ */
1181
+ creationDateTime: Date | undefined;
1182
+ /**
1183
+ * <p>The date and time when the workspace was last updated.</p>
1184
+ */
1185
+ updateDateTime: Date | undefined;
1186
+ }
1187
+ export declare namespace WorkspaceSummary {
1188
+ /**
1189
+ * @internal
1190
+ */
1191
+ const filterSensitiveLog: (obj: WorkspaceSummary) => any;
1192
+ }
1193
+ export interface ListWorkspacesResponse {
1194
+ /**
1195
+ * <p>A list of objects that contain information about the workspaces.</p>
1196
+ */
1197
+ workspaceSummaries?: WorkspaceSummary[];
1198
+ /**
1199
+ * <p>The string that specifies the next page of results.</p>
1200
+ */
1201
+ nextToken?: string;
1202
+ }
1203
+ export declare namespace ListWorkspacesResponse {
1204
+ /**
1205
+ * @internal
1206
+ */
1207
+ const filterSensitiveLog: (obj: ListWorkspacesResponse) => any;
1208
+ }
1209
+ export interface TagResourceRequest {
1210
+ /**
1211
+ * <p>The ARN of the resource.</p>
1212
+ */
1213
+ resourceARN: string | undefined;
1214
+ /**
1215
+ * <p>Metadata to add to this resource.</p>
1216
+ */
1217
+ tags: {
1218
+ [key: string]: string;
1219
+ } | undefined;
1220
+ }
1221
+ export declare namespace TagResourceRequest {
1222
+ /**
1223
+ * @internal
1224
+ */
1225
+ const filterSensitiveLog: (obj: TagResourceRequest) => any;
1226
+ }
1227
+ export interface TagResourceResponse {
1228
+ }
1229
+ export declare namespace TagResourceResponse {
1230
+ /**
1231
+ * @internal
1232
+ */
1233
+ const filterSensitiveLog: (obj: TagResourceResponse) => any;
1234
+ }
1235
+ /**
1236
+ * <p>The number of tags exceeds the limit.</p>
1237
+ */
1238
+ export interface TooManyTagsException extends __SmithyException, $MetadataBearer {
1239
+ name: "TooManyTagsException";
1240
+ $fault: "client";
1241
+ message?: string;
1242
+ }
1243
+ export declare namespace TooManyTagsException {
1244
+ /**
1245
+ * @internal
1246
+ */
1247
+ const filterSensitiveLog: (obj: TooManyTagsException) => any;
1248
+ }
1249
+ export interface UntagResourceRequest {
1250
+ /**
1251
+ * <p>The ARN of the resource.</p>
1252
+ */
1253
+ resourceARN: string | undefined;
1254
+ /**
1255
+ * <p>A list of tag key names to remove from the resource. You don't specify the value. Both the key and its associated value are removed.</p>
1256
+ */
1257
+ tagKeys: string[] | undefined;
1258
+ }
1259
+ export declare namespace UntagResourceRequest {
1260
+ /**
1261
+ * @internal
1262
+ */
1263
+ const filterSensitiveLog: (obj: UntagResourceRequest) => any;
1264
+ }
1265
+ export interface UntagResourceResponse {
1266
+ }
1267
+ export declare namespace UntagResourceResponse {
1268
+ /**
1269
+ * @internal
1270
+ */
1271
+ const filterSensitiveLog: (obj: UntagResourceResponse) => any;
1272
+ }
1273
+ export interface UpdateComponentTypeResponse {
1274
+ /**
1275
+ * <p>The ID of the workspace that contains the component type.</p>
1276
+ */
1277
+ workspaceId: string | undefined;
1278
+ /**
1279
+ * <p>The ARN of the component type.</p>
1280
+ */
1281
+ arn: string | undefined;
1282
+ /**
1283
+ * <p>The ID of the component type.</p>
1284
+ */
1285
+ componentTypeId: string | undefined;
1286
+ /**
1287
+ * <p>The current state of the component type.</p>
1288
+ */
1289
+ state: State | string | undefined;
1290
+ }
1291
+ export declare namespace UpdateComponentTypeResponse {
1292
+ /**
1293
+ * @internal
1294
+ */
1295
+ const filterSensitiveLog: (obj: UpdateComponentTypeResponse) => any;
1296
+ }
1297
+ export declare enum ComponentUpdateType {
1298
+ CREATE = "CREATE",
1299
+ DELETE = "DELETE",
1300
+ UPDATE = "UPDATE"
1301
+ }
1302
+ export declare enum ParentEntityUpdateType {
1303
+ DELETE = "DELETE",
1304
+ UPDATE = "UPDATE"
1305
+ }
1306
+ /**
1307
+ * <p>The parent entity update request.</p>
1308
+ */
1309
+ export interface ParentEntityUpdateRequest {
1310
+ /**
1311
+ * <p>The type of the update.</p>
1312
+ */
1313
+ updateType: ParentEntityUpdateType | string | undefined;
1314
+ /**
1315
+ * <p>The ID of the parent entity.</p>
1316
+ */
1317
+ parentEntityId?: string;
1318
+ }
1319
+ export declare namespace ParentEntityUpdateRequest {
1320
+ /**
1321
+ * @internal
1322
+ */
1323
+ const filterSensitiveLog: (obj: ParentEntityUpdateRequest) => any;
1324
+ }
1325
+ export interface UpdateEntityResponse {
1326
+ /**
1327
+ * <p>The date and time when the entity was last updated.</p>
1328
+ */
1329
+ updateDateTime: Date | undefined;
1330
+ /**
1331
+ * <p>The current state of the entity update.</p>
1332
+ */
1333
+ state: State | string | undefined;
1334
+ }
1335
+ export declare namespace UpdateEntityResponse {
1336
+ /**
1337
+ * @internal
1338
+ */
1339
+ const filterSensitiveLog: (obj: UpdateEntityResponse) => any;
1340
+ }
1341
+ export interface UpdateSceneRequest {
1342
+ /**
1343
+ * <p>The ID of the workspace that contains the scene.</p>
1344
+ */
1345
+ workspaceId: string | undefined;
1346
+ /**
1347
+ * <p>The ID of the scene.</p>
1348
+ */
1349
+ sceneId: string | undefined;
1350
+ /**
1351
+ * <p>The relative path that specifies the location of the content definition file.</p>
1352
+ */
1353
+ contentLocation?: string;
1354
+ /**
1355
+ * <p>The description of this scene.</p>
1356
+ */
1357
+ description?: string;
1358
+ /**
1359
+ * <p>A list of capabilities that the scene uses to render.</p>
1360
+ */
1361
+ capabilities?: string[];
1362
+ }
1363
+ export declare namespace UpdateSceneRequest {
1364
+ /**
1365
+ * @internal
1366
+ */
1367
+ const filterSensitiveLog: (obj: UpdateSceneRequest) => any;
1368
+ }
1369
+ export interface UpdateSceneResponse {
1370
+ /**
1371
+ * <p>The date and time when the scene was last updated.</p>
1372
+ */
1373
+ updateDateTime: Date | undefined;
1374
+ }
1375
+ export declare namespace UpdateSceneResponse {
1376
+ /**
1377
+ * @internal
1378
+ */
1379
+ const filterSensitiveLog: (obj: UpdateSceneResponse) => any;
1380
+ }
1381
+ export interface UpdateWorkspaceRequest {
1382
+ /**
1383
+ * <p>The ID of the workspace.</p>
1384
+ */
1385
+ workspaceId: string | undefined;
1386
+ /**
1387
+ * <p>The description of the workspace.</p>
1388
+ */
1389
+ description?: string;
1390
+ /**
1391
+ * <p>The ARN of the execution role associated with the workspace.</p>
1392
+ */
1393
+ role?: string;
1394
+ }
1395
+ export declare namespace UpdateWorkspaceRequest {
1396
+ /**
1397
+ * @internal
1398
+ */
1399
+ const filterSensitiveLog: (obj: UpdateWorkspaceRequest) => any;
1400
+ }
1401
+ export interface UpdateWorkspaceResponse {
1402
+ /**
1403
+ * <p>The date and time of the current update.</p>
1404
+ */
1405
+ updateDateTime: Date | undefined;
1406
+ }
1407
+ export declare namespace UpdateWorkspaceResponse {
1408
+ /**
1409
+ * @internal
1410
+ */
1411
+ const filterSensitiveLog: (obj: UpdateWorkspaceResponse) => any;
1412
+ }
1413
+ /**
1414
+ * <p>An object that specifies a value for a property.</p>
1415
+ */
1416
+ export interface DataValue {
1417
+ /**
1418
+ * <p>A Boolean value.</p>
1419
+ */
1420
+ booleanValue?: boolean;
1421
+ /**
1422
+ * <p>A double value.</p>
1423
+ */
1424
+ doubleValue?: number;
1425
+ /**
1426
+ * <p>An integer value.</p>
1427
+ */
1428
+ integerValue?: number;
1429
+ /**
1430
+ * <p>A long value.</p>
1431
+ */
1432
+ longValue?: number;
1433
+ /**
1434
+ * <p>A string value.</p>
1435
+ */
1436
+ stringValue?: string;
1437
+ /**
1438
+ * <p>A list of multiple values.</p>
1439
+ */
1440
+ listValue?: DataValue[];
1441
+ /**
1442
+ * <p>An object that maps strings to multiple <code>DataValue</code> objects.</p>
1443
+ */
1444
+ mapValue?: {
1445
+ [key: string]: DataValue;
1446
+ };
1447
+ /**
1448
+ * <p>A value that relates a component to another component.</p>
1449
+ */
1450
+ relationshipValue?: RelationshipValue;
1451
+ /**
1452
+ * <p>An expression that produces the value.</p>
1453
+ */
1454
+ expression?: string;
1455
+ }
1456
+ export declare namespace DataValue {
1457
+ /**
1458
+ * @internal
1459
+ */
1460
+ const filterSensitiveLog: (obj: DataValue) => any;
1461
+ }
1462
+ /**
1463
+ * <p>An object that filters items returned by a property request.</p>
1464
+ */
1465
+ export interface PropertyFilter {
1466
+ /**
1467
+ * <p>The property name associated with this property filter.</p>
1468
+ */
1469
+ propertyName?: string;
1470
+ /**
1471
+ * <p>The operator associated with this property filter.</p>
1472
+ */
1473
+ operator?: string;
1474
+ /**
1475
+ * <p>The value associated with this property filter.</p>
1476
+ */
1477
+ value?: DataValue;
1478
+ }
1479
+ export declare namespace PropertyFilter {
1480
+ /**
1481
+ * @internal
1482
+ */
1483
+ const filterSensitiveLog: (obj: PropertyFilter) => any;
1484
+ }
1485
+ /**
1486
+ * <p>The latest value of the property.</p>
1487
+ */
1488
+ export interface PropertyLatestValue {
1489
+ /**
1490
+ * <p>An object that specifies information about a property.&gt;</p>
1491
+ */
1492
+ propertyReference: EntityPropertyReference | undefined;
1493
+ /**
1494
+ * <p>The value of the property.</p>
1495
+ */
1496
+ propertyValue?: DataValue;
1497
+ }
1498
+ export declare namespace PropertyLatestValue {
1499
+ /**
1500
+ * @internal
1501
+ */
1502
+ const filterSensitiveLog: (obj: PropertyLatestValue) => any;
1503
+ }
1504
+ /**
1505
+ * <p>An object that contains information about a value for a time series property.</p>
1506
+ */
1507
+ export interface PropertyValue {
1508
+ /**
1509
+ * <p>The timestamp of a value for a time series property.</p>
1510
+ */
1511
+ timestamp: Date | undefined;
1512
+ /**
1513
+ * <p>An object that specifies a value for a time series property.</p>
1514
+ */
1515
+ value: DataValue | undefined;
1516
+ }
1517
+ export declare namespace PropertyValue {
1518
+ /**
1519
+ * @internal
1520
+ */
1521
+ const filterSensitiveLog: (obj: PropertyValue) => any;
1522
+ }
1523
+ /**
1524
+ * <p>An object that specifies the data type of a property.</p>
1525
+ */
1526
+ export interface DataType {
1527
+ /**
1528
+ * <p>The underlying type of the data type.</p>
1529
+ */
1530
+ type: Type | string | undefined;
1531
+ /**
1532
+ * <p>The nested type in the data type.</p>
1533
+ */
1534
+ nestedType?: DataType;
1535
+ /**
1536
+ * <p>The allowed values for this data type.</p>
1537
+ */
1538
+ allowedValues?: DataValue[];
1539
+ /**
1540
+ * <p>The unit of measure used in this data type.</p>
1541
+ */
1542
+ unitOfMeasure?: string;
1543
+ /**
1544
+ * <p>A relationship that associates a component with another component.</p>
1545
+ */
1546
+ relationship?: Relationship;
1547
+ }
1548
+ export declare namespace DataType {
1549
+ /**
1550
+ * @internal
1551
+ */
1552
+ const filterSensitiveLog: (obj: DataType) => any;
1553
+ }
1554
+ export interface GetPropertyValueHistoryRequest {
1555
+ /**
1556
+ * <p>The ID of the workspace.</p>
1557
+ */
1558
+ workspaceId: string | undefined;
1559
+ /**
1560
+ * <p>The ID of the entity.</p>
1561
+ */
1562
+ entityId?: string;
1563
+ /**
1564
+ * <p>The name of the component.</p>
1565
+ */
1566
+ componentName?: string;
1567
+ /**
1568
+ * <p>The ID of the component type.</p>
1569
+ */
1570
+ componentTypeId?: string;
1571
+ /**
1572
+ * <p>A list of properties whose value histories the request retrieves.</p>
1573
+ */
1574
+ selectedProperties: string[] | undefined;
1575
+ /**
1576
+ * <p>A list of objects that filter the property value history request.</p>
1577
+ */
1578
+ propertyFilters?: PropertyFilter[];
1579
+ /**
1580
+ * <p>The date and time of the earliest property value to return.</p>
1581
+ */
1582
+ startDateTime: Date | undefined;
1583
+ /**
1584
+ * <p>The date and time of the latest property value to return.</p>
1585
+ */
1586
+ endDateTime: Date | undefined;
1587
+ /**
1588
+ * <p>An object that specifies the interpolation type and the interval over which to interpolate data.</p>
1589
+ */
1590
+ interpolation?: InterpolationParameters;
1591
+ /**
1592
+ * <p>The string that specifies the next page of results.</p>
1593
+ */
1594
+ nextToken?: string;
1595
+ /**
1596
+ * <p>The maximum number of results to return.</p>
1597
+ */
1598
+ maxResults?: number;
1599
+ /**
1600
+ * <p>The time direction to use in the result order.</p>
1601
+ */
1602
+ orderByTime?: OrderByTime | string;
1603
+ }
1604
+ export declare namespace GetPropertyValueHistoryRequest {
1605
+ /**
1606
+ * @internal
1607
+ */
1608
+ const filterSensitiveLog: (obj: GetPropertyValueHistoryRequest) => any;
1609
+ }
1610
+ export interface GetPropertyValueResponse {
1611
+ /**
1612
+ * <p>An object that maps strings to the properties and latest property values in the response. Each string
1613
+ * in the mapping must be unique to this object.</p>
1614
+ */
1615
+ propertyValues: {
1616
+ [key: string]: PropertyLatestValue;
1617
+ } | undefined;
1618
+ }
1619
+ export declare namespace GetPropertyValueResponse {
1620
+ /**
1621
+ * @internal
1622
+ */
1623
+ const filterSensitiveLog: (obj: GetPropertyValueResponse) => any;
1624
+ }
1625
+ /**
1626
+ * <p>An object that specifies information about time series property values.</p>
1627
+ */
1628
+ export interface PropertyValueEntry {
1629
+ /**
1630
+ * <p>An object that contains information about the entity that has the property.</p>
1631
+ */
1632
+ entityPropertyReference: EntityPropertyReference | undefined;
1633
+ /**
1634
+ * <p>A list of objects that specify time series property values.</p>
1635
+ */
1636
+ propertyValues?: PropertyValue[];
1637
+ }
1638
+ export declare namespace PropertyValueEntry {
1639
+ /**
1640
+ * @internal
1641
+ */
1642
+ const filterSensitiveLog: (obj: PropertyValueEntry) => any;
1643
+ }
1644
+ /**
1645
+ * <p>The history of values for a time series property.</p>
1646
+ */
1647
+ export interface PropertyValueHistory {
1648
+ /**
1649
+ * <p>An object that uniquely identifies an entity property.</p>
1650
+ */
1651
+ entityPropertyReference: EntityPropertyReference | undefined;
1652
+ /**
1653
+ * <p>A list of objects that contain information about the values in the history of a time series property.</p>
1654
+ */
1655
+ values?: PropertyValue[];
1656
+ }
1657
+ export declare namespace PropertyValueHistory {
1658
+ /**
1659
+ * @internal
1660
+ */
1661
+ const filterSensitiveLog: (obj: PropertyValueHistory) => any;
1662
+ }
1663
+ /**
1664
+ * <p>An error returned by the <code>BatchPutProperty</code> action.</p>
1665
+ */
1666
+ export interface BatchPutPropertyError {
1667
+ /**
1668
+ * <p>The error code.</p>
1669
+ */
1670
+ errorCode: string | undefined;
1671
+ /**
1672
+ * <p>The error message.</p>
1673
+ */
1674
+ errorMessage: string | undefined;
1675
+ /**
1676
+ * <p>An object that contains information about errors returned by the <code>BatchPutProperty</code> action.</p>
1677
+ */
1678
+ entry: PropertyValueEntry | undefined;
1679
+ }
1680
+ export declare namespace BatchPutPropertyError {
1681
+ /**
1682
+ * @internal
1683
+ */
1684
+ const filterSensitiveLog: (obj: BatchPutPropertyError) => any;
1685
+ }
1686
+ export interface BatchPutPropertyValuesRequest {
1687
+ /**
1688
+ * <p>The ID of the workspace that contains the properties to set.</p>
1689
+ */
1690
+ workspaceId: string | undefined;
1691
+ /**
1692
+ * <p>An object that maps strings to the property value entries to set. Each string
1693
+ * in the mapping must be unique to this object.</p>
1694
+ */
1695
+ entries: PropertyValueEntry[] | undefined;
1696
+ }
1697
+ export declare namespace BatchPutPropertyValuesRequest {
1698
+ /**
1699
+ * @internal
1700
+ */
1701
+ const filterSensitiveLog: (obj: BatchPutPropertyValuesRequest) => any;
1702
+ }
1703
+ export interface GetPropertyValueHistoryResponse {
1704
+ /**
1705
+ * <p>An object that maps strings to the property definitions in the component type. Each string
1706
+ * in the mapping must be unique to this object.</p>
1707
+ */
1708
+ propertyValues: PropertyValueHistory[] | undefined;
1709
+ /**
1710
+ * <p>The string that specifies the next page of results.</p>
1711
+ */
1712
+ nextToken?: string;
1713
+ }
1714
+ export declare namespace GetPropertyValueHistoryResponse {
1715
+ /**
1716
+ * @internal
1717
+ */
1718
+ const filterSensitiveLog: (obj: GetPropertyValueHistoryResponse) => any;
1719
+ }
1720
+ /**
1721
+ * <p>An object that contains information about errors returned by the <code>BatchPutProperty</code> action.</p>
1722
+ */
1723
+ export interface BatchPutPropertyErrorEntry {
1724
+ /**
1725
+ * <p>A list of objects that contain information about errors returned by the
1726
+ * <code>BatchPutProperty</code> action.</p>
1727
+ */
1728
+ errors: BatchPutPropertyError[] | undefined;
1729
+ }
1730
+ export declare namespace BatchPutPropertyErrorEntry {
1731
+ /**
1732
+ * @internal
1733
+ */
1734
+ const filterSensitiveLog: (obj: BatchPutPropertyErrorEntry) => any;
1735
+ }
1736
+ /**
1737
+ * <p>An object that sets information about a property.</p>
1738
+ */
1739
+ export interface PropertyDefinitionRequest {
1740
+ /**
1741
+ * <p>An object that contains information about the data type.</p>
1742
+ */
1743
+ dataType?: DataType;
1744
+ /**
1745
+ * <p>A Boolean value that specifies whether the property is required.</p>
1746
+ */
1747
+ isRequiredInEntity?: boolean;
1748
+ /**
1749
+ * <p>A Boolean value that specifies whether the property ID comes from an external data store.</p>
1750
+ */
1751
+ isExternalId?: boolean;
1752
+ /**
1753
+ * <p>A Boolean value that specifies whether the property is stored externally.</p>
1754
+ */
1755
+ isStoredExternally?: boolean;
1756
+ /**
1757
+ * <p>A Boolean value that specifies whether the property consists of time series data.</p>
1758
+ */
1759
+ isTimeSeries?: boolean;
1760
+ /**
1761
+ * <p>An object that contains the default value.</p>
1762
+ */
1763
+ defaultValue?: DataValue;
1764
+ /**
1765
+ * <p>A mapping that specifies configuration information about the property. Use this field to
1766
+ * specify information that you read from and write to an external source.</p>
1767
+ */
1768
+ configuration?: {
1769
+ [key: string]: string;
1770
+ };
1771
+ }
1772
+ export declare namespace PropertyDefinitionRequest {
1773
+ /**
1774
+ * @internal
1775
+ */
1776
+ const filterSensitiveLog: (obj: PropertyDefinitionRequest) => any;
1777
+ }
1778
+ /**
1779
+ * <p>An object that contains response data from a property definition request.</p>
1780
+ */
1781
+ export interface PropertyDefinitionResponse {
1782
+ /**
1783
+ * <p>An object that contains information about the data type.</p>
1784
+ */
1785
+ dataType: DataType | undefined;
1786
+ /**
1787
+ * <p>A Boolean value that specifies whether the property consists of time series data.</p>
1788
+ */
1789
+ isTimeSeries: boolean | undefined;
1790
+ /**
1791
+ * <p>A Boolean value that specifies whether the property is required in an entity.</p>
1792
+ */
1793
+ isRequiredInEntity: boolean | undefined;
1794
+ /**
1795
+ * <p>A Boolean value that specifies whether the property ID comes from an external data store.</p>
1796
+ */
1797
+ isExternalId: boolean | undefined;
1798
+ /**
1799
+ * <p>A Boolean value that specifies whether the property is stored externally.</p>
1800
+ */
1801
+ isStoredExternally: boolean | undefined;
1802
+ /**
1803
+ * <p>A Boolean value that specifies whether the property definition is imported from an external data store.</p>
1804
+ */
1805
+ isImported: boolean | undefined;
1806
+ /**
1807
+ * <p>A Boolean value that specifies whether the property definition can be updated.</p>
1808
+ */
1809
+ isFinal: boolean | undefined;
1810
+ /**
1811
+ * <p>A Boolean value that specifies whether the property definition is inherited from a parent entity.</p>
1812
+ */
1813
+ isInherited: boolean | undefined;
1814
+ /**
1815
+ * <p>An object that contains the default value.</p>
1816
+ */
1817
+ defaultValue?: DataValue;
1818
+ /**
1819
+ * <p>A mapping that specifies configuration information about the property.</p>
1820
+ */
1821
+ configuration?: {
1822
+ [key: string]: string;
1823
+ };
1824
+ }
1825
+ export declare namespace PropertyDefinitionResponse {
1826
+ /**
1827
+ * @internal
1828
+ */
1829
+ const filterSensitiveLog: (obj: PropertyDefinitionResponse) => any;
1830
+ }
1831
+ export interface BatchPutPropertyValuesResponse {
1832
+ /**
1833
+ * <p>Entries that caused errors in the batch put operation.</p>
1834
+ */
1835
+ errorEntries: BatchPutPropertyErrorEntry[] | undefined;
1836
+ }
1837
+ export declare namespace BatchPutPropertyValuesResponse {
1838
+ /**
1839
+ * @internal
1840
+ */
1841
+ const filterSensitiveLog: (obj: BatchPutPropertyValuesResponse) => any;
1842
+ }
1843
+ export interface CreateComponentTypeRequest {
1844
+ /**
1845
+ * <p>The ID of the workspace that contains the component type.</p>
1846
+ */
1847
+ workspaceId: string | undefined;
1848
+ /**
1849
+ * <p>A Boolean value that specifies whether an entity can have more than one component of
1850
+ * this type.</p>
1851
+ */
1852
+ isSingleton?: boolean;
1853
+ /**
1854
+ * <p>The ID of the component type.</p>
1855
+ */
1856
+ componentTypeId: string | undefined;
1857
+ /**
1858
+ * <p>The description of the component type.</p>
1859
+ */
1860
+ description?: string;
1861
+ /**
1862
+ * <p>An object that maps strings to the property definitions in the component type. Each string
1863
+ * in the mapping must be unique to this object.</p>
1864
+ */
1865
+ propertyDefinitions?: {
1866
+ [key: string]: PropertyDefinitionRequest;
1867
+ };
1868
+ /**
1869
+ * <p>Specifies the parent component type to extend.</p>
1870
+ */
1871
+ extendsFrom?: string[];
1872
+ /**
1873
+ * <p>An object that maps strings to the functions in the component type. Each string in the
1874
+ * mapping must be unique to this object.</p>
1875
+ */
1876
+ functions?: {
1877
+ [key: string]: FunctionRequest;
1878
+ };
1879
+ /**
1880
+ * <p>Metadata that you can use to manage the component type.</p>
1881
+ */
1882
+ tags?: {
1883
+ [key: string]: string;
1884
+ };
1885
+ }
1886
+ export declare namespace CreateComponentTypeRequest {
1887
+ /**
1888
+ * @internal
1889
+ */
1890
+ const filterSensitiveLog: (obj: CreateComponentTypeRequest) => any;
1891
+ }
1892
+ export interface GetComponentTypeResponse {
1893
+ /**
1894
+ * <p>The ID of the workspace that contains the component type.</p>
1895
+ */
1896
+ workspaceId: string | undefined;
1897
+ /**
1898
+ * <p>A Boolean value that specifies whether an entity can have more than one component of this
1899
+ * type.</p>
1900
+ */
1901
+ isSingleton?: boolean;
1902
+ /**
1903
+ * <p>The ID of the component type.</p>
1904
+ */
1905
+ componentTypeId: string | undefined;
1906
+ /**
1907
+ * <p>The description of the component type.</p>
1908
+ */
1909
+ description?: string;
1910
+ /**
1911
+ * <p>An object that maps strings to the property definitions in the component type. Each string
1912
+ * in the mapping must be unique to this object.</p>
1913
+ */
1914
+ propertyDefinitions?: {
1915
+ [key: string]: PropertyDefinitionResponse;
1916
+ };
1917
+ /**
1918
+ * <p>The name of the parent component type that this component type extends.</p>
1919
+ */
1920
+ extendsFrom?: string[];
1921
+ /**
1922
+ * <p>An object that maps strings to the functions in the component type. Each string
1923
+ * in the mapping must be unique to this object.</p>
1924
+ */
1925
+ functions?: {
1926
+ [key: string]: FunctionResponse;
1927
+ };
1928
+ /**
1929
+ * <p>The date and time when the component type was created.</p>
1930
+ */
1931
+ creationDateTime: Date | undefined;
1932
+ /**
1933
+ * <p>The date and time when the component was last updated.</p>
1934
+ */
1935
+ updateDateTime: Date | undefined;
1936
+ /**
1937
+ * <p>The ARN of the component type.</p>
1938
+ */
1939
+ arn: string | undefined;
1940
+ /**
1941
+ * <p>A Boolean value that specifies whether the component type is abstract.</p>
1942
+ */
1943
+ isAbstract?: boolean;
1944
+ /**
1945
+ * <p>A Boolean value that specifies whether the component type has a schema initializer and that the
1946
+ * schema initializer has run.</p>
1947
+ */
1948
+ isSchemaInitialized?: boolean;
1949
+ /**
1950
+ * <p>The current status of the component type.</p>
1951
+ */
1952
+ status?: Status;
1953
+ }
1954
+ export declare namespace GetComponentTypeResponse {
1955
+ /**
1956
+ * @internal
1957
+ */
1958
+ const filterSensitiveLog: (obj: GetComponentTypeResponse) => any;
1959
+ }
1960
+ export interface UpdateComponentTypeRequest {
1961
+ /**
1962
+ * <p>The ID of the workspace that contains the component type.</p>
1963
+ */
1964
+ workspaceId: string | undefined;
1965
+ /**
1966
+ * <p>A Boolean value that specifies whether an entity can have more than one component of this
1967
+ * type.</p>
1968
+ */
1969
+ isSingleton?: boolean;
1970
+ /**
1971
+ * <p>The ID of the component type.</p>
1972
+ */
1973
+ componentTypeId: string | undefined;
1974
+ /**
1975
+ * <p>The description of the component type.</p>
1976
+ */
1977
+ description?: string;
1978
+ /**
1979
+ * <p>An object that maps strings to the property definitions in the component type. Each string
1980
+ * in the mapping must be unique to this object.</p>
1981
+ */
1982
+ propertyDefinitions?: {
1983
+ [key: string]: PropertyDefinitionRequest;
1984
+ };
1985
+ /**
1986
+ * <p>Specifies the component type that this component type extends.</p>
1987
+ */
1988
+ extendsFrom?: string[];
1989
+ /**
1990
+ * <p>An object that maps strings to the functions in the component type. Each string
1991
+ * in the mapping must be unique to this object.</p>
1992
+ */
1993
+ functions?: {
1994
+ [key: string]: FunctionRequest;
1995
+ };
1996
+ }
1997
+ export declare namespace UpdateComponentTypeRequest {
1998
+ /**
1999
+ * @internal
2000
+ */
2001
+ const filterSensitiveLog: (obj: UpdateComponentTypeRequest) => any;
2002
+ }
2003
+ /**
2004
+ * <p>An object that sets information about a property.</p>
2005
+ */
2006
+ export interface PropertyRequest {
2007
+ /**
2008
+ * <p>An object that specifies information about a property.</p>
2009
+ */
2010
+ definition?: PropertyDefinitionRequest;
2011
+ /**
2012
+ * <p>The value of the property.</p>
2013
+ */
2014
+ value?: DataValue;
2015
+ /**
2016
+ * <p>The update type of the update property request.</p>
2017
+ */
2018
+ updateType?: PropertyUpdateType | string;
2019
+ }
2020
+ export declare namespace PropertyRequest {
2021
+ /**
2022
+ * @internal
2023
+ */
2024
+ const filterSensitiveLog: (obj: PropertyRequest) => any;
2025
+ }
2026
+ /**
2027
+ * <p>An object that contains information about a property response.</p>
2028
+ */
2029
+ export interface PropertyResponse {
2030
+ /**
2031
+ * <p>An object that specifies information about a property.</p>
2032
+ */
2033
+ definition?: PropertyDefinitionResponse;
2034
+ /**
2035
+ * <p>The value of the property.</p>
2036
+ */
2037
+ value?: DataValue;
2038
+ }
2039
+ export declare namespace PropertyResponse {
2040
+ /**
2041
+ * @internal
2042
+ */
2043
+ const filterSensitiveLog: (obj: PropertyResponse) => any;
2044
+ }
2045
+ /**
2046
+ * <p>An object that sets information about a component type create or update request.</p>
2047
+ */
2048
+ export interface ComponentRequest {
2049
+ /**
2050
+ * <p>The description of the component request.</p>
2051
+ */
2052
+ description?: string;
2053
+ /**
2054
+ * <p>The ID of the component type.</p>
2055
+ */
2056
+ componentTypeId?: string;
2057
+ /**
2058
+ * <p>An object that maps strings to the properties to set in the component type. Each string
2059
+ * in the mapping must be unique to this object.</p>
2060
+ */
2061
+ properties?: {
2062
+ [key: string]: PropertyRequest;
2063
+ };
2064
+ }
2065
+ export declare namespace ComponentRequest {
2066
+ /**
2067
+ * @internal
2068
+ */
2069
+ const filterSensitiveLog: (obj: ComponentRequest) => any;
2070
+ }
2071
+ /**
2072
+ * <p>An object that returns information about a component type create or update request.</p>
2073
+ */
2074
+ export interface ComponentResponse {
2075
+ /**
2076
+ * <p>The name of the component.</p>
2077
+ */
2078
+ componentName?: string;
2079
+ /**
2080
+ * <p>The description of the component type.</p>
2081
+ */
2082
+ description?: string;
2083
+ /**
2084
+ * <p>The ID of the component type.</p>
2085
+ */
2086
+ componentTypeId?: string;
2087
+ /**
2088
+ * <p>The status of the component type.</p>
2089
+ */
2090
+ status?: Status;
2091
+ /**
2092
+ * <p>The name of the property definition set in the request.</p>
2093
+ */
2094
+ definedIn?: string;
2095
+ /**
2096
+ * <p>An object that maps strings to the properties to set in the component type. Each string
2097
+ * in the mapping must be unique to this object.</p>
2098
+ */
2099
+ properties?: {
2100
+ [key: string]: PropertyResponse;
2101
+ };
2102
+ }
2103
+ export declare namespace ComponentResponse {
2104
+ /**
2105
+ * @internal
2106
+ */
2107
+ const filterSensitiveLog: (obj: ComponentResponse) => any;
2108
+ }
2109
+ /**
2110
+ * <p>The component update request.</p>
2111
+ */
2112
+ export interface ComponentUpdateRequest {
2113
+ /**
2114
+ * <p>The update type of the component update request.</p>
2115
+ */
2116
+ updateType?: ComponentUpdateType | string;
2117
+ /**
2118
+ * <p>The description of the component type.</p>
2119
+ */
2120
+ description?: string;
2121
+ /**
2122
+ * <p>The ID of the component type.</p>
2123
+ */
2124
+ componentTypeId?: string;
2125
+ /**
2126
+ * <p>An object that maps strings to the properties to set in the component type update. Each string
2127
+ * in the mapping must be unique to this object.</p>
2128
+ */
2129
+ propertyUpdates?: {
2130
+ [key: string]: PropertyRequest;
2131
+ };
2132
+ }
2133
+ export declare namespace ComponentUpdateRequest {
2134
+ /**
2135
+ * @internal
2136
+ */
2137
+ const filterSensitiveLog: (obj: ComponentUpdateRequest) => any;
2138
+ }
2139
+ export interface CreateEntityRequest {
2140
+ /**
2141
+ * <p>The ID of the workspace that contains the entity.</p>
2142
+ */
2143
+ workspaceId: string | undefined;
2144
+ /**
2145
+ * <p>The ID of the entity.</p>
2146
+ */
2147
+ entityId?: string;
2148
+ /**
2149
+ * <p>The name of the entity.</p>
2150
+ */
2151
+ entityName: string | undefined;
2152
+ /**
2153
+ * <p>The description of the entity.</p>
2154
+ */
2155
+ description?: string;
2156
+ /**
2157
+ * <p>An object that maps strings to the components in the entity. Each string
2158
+ * in the mapping must be unique to this object.</p>
2159
+ */
2160
+ components?: {
2161
+ [key: string]: ComponentRequest;
2162
+ };
2163
+ /**
2164
+ * <p>The ID of the entity's parent entity.</p>
2165
+ */
2166
+ parentEntityId?: string;
2167
+ /**
2168
+ * <p>Metadata that you can use to manage the entity.</p>
2169
+ */
2170
+ tags?: {
2171
+ [key: string]: string;
2172
+ };
2173
+ }
2174
+ export declare namespace CreateEntityRequest {
2175
+ /**
2176
+ * @internal
2177
+ */
2178
+ const filterSensitiveLog: (obj: CreateEntityRequest) => any;
2179
+ }
2180
+ export interface GetEntityResponse {
2181
+ /**
2182
+ * <p>The ID of the entity.</p>
2183
+ */
2184
+ entityId: string | undefined;
2185
+ /**
2186
+ * <p>The name of the entity.</p>
2187
+ */
2188
+ entityName: string | undefined;
2189
+ /**
2190
+ * <p>The ARN of the entity.</p>
2191
+ */
2192
+ arn: string | undefined;
2193
+ /**
2194
+ * <p>The current status of the entity.</p>
2195
+ */
2196
+ status: Status | undefined;
2197
+ /**
2198
+ * <p>The ID of the workspace.</p>
2199
+ */
2200
+ workspaceId: string | undefined;
2201
+ /**
2202
+ * <p>The description of the entity.</p>
2203
+ */
2204
+ description?: string;
2205
+ /**
2206
+ * <p>An object that maps strings to the components in the entity. Each string
2207
+ * in the mapping must be unique to this object.</p>
2208
+ */
2209
+ components?: {
2210
+ [key: string]: ComponentResponse;
2211
+ };
2212
+ /**
2213
+ * <p>The ID of the parent entity for this entity.</p>
2214
+ */
2215
+ parentEntityId: string | undefined;
2216
+ /**
2217
+ * <p>A Boolean value that specifies whether the entity has associated child entities.</p>
2218
+ */
2219
+ hasChildEntities: boolean | undefined;
2220
+ /**
2221
+ * <p>The date and time when the entity was created.</p>
2222
+ */
2223
+ creationDateTime: Date | undefined;
2224
+ /**
2225
+ * <p>The date and time when the entity was last updated.</p>
2226
+ */
2227
+ updateDateTime: Date | undefined;
2228
+ }
2229
+ export declare namespace GetEntityResponse {
2230
+ /**
2231
+ * @internal
2232
+ */
2233
+ const filterSensitiveLog: (obj: GetEntityResponse) => any;
2234
+ }
2235
+ export interface UpdateEntityRequest {
2236
+ /**
2237
+ * <p>The ID of the workspace that contains the entity.</p>
2238
+ */
2239
+ workspaceId: string | undefined;
2240
+ /**
2241
+ * <p>The ID of the entity.</p>
2242
+ */
2243
+ entityId: string | undefined;
2244
+ /**
2245
+ * <p>The name of the entity.</p>
2246
+ */
2247
+ entityName?: string;
2248
+ /**
2249
+ * <p>The description of the entity.</p>
2250
+ */
2251
+ description?: string;
2252
+ /**
2253
+ * <p>An object that maps strings to the component updates in the request. Each string
2254
+ * in the mapping must be unique to this object.</p>
2255
+ */
2256
+ componentUpdates?: {
2257
+ [key: string]: ComponentUpdateRequest;
2258
+ };
2259
+ /**
2260
+ * <p>An object that describes the update request for a parent entity.</p>
2261
+ */
2262
+ parentEntityUpdate?: ParentEntityUpdateRequest;
2263
+ }
2264
+ export declare namespace UpdateEntityRequest {
2265
+ /**
2266
+ * @internal
2267
+ */
2268
+ const filterSensitiveLog: (obj: UpdateEntityRequest) => any;
2269
+ }