aws-sdk-iottwinmaker 1.20.0 → 1.21.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iottwinmaker/client.rb +1 -1
- data/lib/aws-sdk-iottwinmaker/plugins/endpoints.rb +1 -0
- data/lib/aws-sdk-iottwinmaker.rb +1 -1
- data/sig/client.rbs +1283 -0
- data/sig/errors.rbs +49 -0
- data/sig/resource.rbs +79 -0
- data/sig/types.rbs +1274 -0
- data/sig/waiters.rbs +13 -0
- metadata +13 -8
data/sig/client.rbs
ADDED
@@ -0,0 +1,1283 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module IoTTwinMaker
|
10
|
+
class Client < ::Seahorse::Client::Base
|
11
|
+
include ::Aws::ClientStubs
|
12
|
+
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#initialize-instance_method
|
14
|
+
def self.new: (
|
15
|
+
?credentials: untyped,
|
16
|
+
?region: String,
|
17
|
+
?access_key_id: String,
|
18
|
+
?active_endpoint_cache: bool,
|
19
|
+
?adaptive_retry_wait_to_fill: bool,
|
20
|
+
?client_side_monitoring: bool,
|
21
|
+
?client_side_monitoring_client_id: String,
|
22
|
+
?client_side_monitoring_host: String,
|
23
|
+
?client_side_monitoring_port: Integer,
|
24
|
+
?client_side_monitoring_publisher: untyped,
|
25
|
+
?convert_params: bool,
|
26
|
+
?correct_clock_skew: bool,
|
27
|
+
?defaults_mode: String,
|
28
|
+
?disable_host_prefix_injection: bool,
|
29
|
+
?disable_request_compression: bool,
|
30
|
+
?endpoint: String,
|
31
|
+
?endpoint_cache_max_entries: Integer,
|
32
|
+
?endpoint_cache_max_threads: Integer,
|
33
|
+
?endpoint_cache_poll_interval: Integer,
|
34
|
+
?endpoint_discovery: bool,
|
35
|
+
?ignore_configured_endpoint_urls: bool,
|
36
|
+
?log_formatter: untyped,
|
37
|
+
?log_level: Symbol,
|
38
|
+
?logger: untyped,
|
39
|
+
?max_attempts: Integer,
|
40
|
+
?profile: String,
|
41
|
+
?request_min_compression_size_bytes: Integer,
|
42
|
+
?retry_backoff: Proc,
|
43
|
+
?retry_base_delay: Float,
|
44
|
+
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
45
|
+
?retry_limit: Integer,
|
46
|
+
?retry_max_delay: Integer,
|
47
|
+
?retry_mode: ("legacy" | "standard" | "adaptive"),
|
48
|
+
?sdk_ua_app_id: String,
|
49
|
+
?secret_access_key: String,
|
50
|
+
?session_token: String,
|
51
|
+
?stub_responses: untyped,
|
52
|
+
?token_provider: untyped,
|
53
|
+
?use_dualstack_endpoint: bool,
|
54
|
+
?use_fips_endpoint: bool,
|
55
|
+
?validate_params: bool,
|
56
|
+
?endpoint_provider: untyped,
|
57
|
+
?http_proxy: String,
|
58
|
+
?http_open_timeout: (Float | Integer),
|
59
|
+
?http_read_timeout: (Float | Integer),
|
60
|
+
?http_idle_timeout: (Float | Integer),
|
61
|
+
?http_continue_timeout: (Float | Integer),
|
62
|
+
?ssl_timeout: (Float | Integer | nil),
|
63
|
+
?http_wire_trace: bool,
|
64
|
+
?ssl_verify_peer: bool,
|
65
|
+
?ssl_ca_bundle: String,
|
66
|
+
?ssl_ca_directory: String,
|
67
|
+
?ssl_ca_store: String,
|
68
|
+
?on_chunk_received: Proc,
|
69
|
+
?on_chunk_sent: Proc,
|
70
|
+
?raise_response_errors: bool
|
71
|
+
) -> instance
|
72
|
+
| (?Hash[Symbol, untyped]) -> instance
|
73
|
+
|
74
|
+
|
75
|
+
interface _BatchPutPropertyValuesResponseSuccess
|
76
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::BatchPutPropertyValuesResponse]
|
77
|
+
def error_entries: () -> ::Array[Types::BatchPutPropertyErrorEntry]
|
78
|
+
end
|
79
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#batch_put_property_values-instance_method
|
80
|
+
def batch_put_property_values: (
|
81
|
+
workspace_id: ::String,
|
82
|
+
entries: Array[
|
83
|
+
{
|
84
|
+
entity_property_reference: {
|
85
|
+
component_name: ::String?,
|
86
|
+
component_path: ::String?,
|
87
|
+
external_id_property: Hash[::String, ::String]?,
|
88
|
+
entity_id: ::String?,
|
89
|
+
property_name: ::String
|
90
|
+
},
|
91
|
+
property_values: Array[
|
92
|
+
{
|
93
|
+
timestamp: ::Time?,
|
94
|
+
value: {
|
95
|
+
boolean_value: bool?,
|
96
|
+
double_value: ::Float?,
|
97
|
+
integer_value: ::Integer?,
|
98
|
+
long_value: ::Integer?,
|
99
|
+
string_value: ::String?,
|
100
|
+
list_value: Array[
|
101
|
+
untyped,
|
102
|
+
]?,
|
103
|
+
map_value: Hash[::String, untyped]?,
|
104
|
+
relationship_value: {
|
105
|
+
target_entity_id: ::String?,
|
106
|
+
target_component_name: ::String?
|
107
|
+
}?,
|
108
|
+
expression: ::String?
|
109
|
+
},
|
110
|
+
time: ::String?
|
111
|
+
},
|
112
|
+
]?
|
113
|
+
},
|
114
|
+
]
|
115
|
+
) -> _BatchPutPropertyValuesResponseSuccess
|
116
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _BatchPutPropertyValuesResponseSuccess
|
117
|
+
|
118
|
+
interface _CancelMetadataTransferJobResponseSuccess
|
119
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CancelMetadataTransferJobResponse]
|
120
|
+
def metadata_transfer_job_id: () -> ::String
|
121
|
+
def arn: () -> ::String
|
122
|
+
def update_date_time: () -> ::Time
|
123
|
+
def status: () -> Types::MetadataTransferJobStatus
|
124
|
+
def progress: () -> Types::MetadataTransferJobProgress
|
125
|
+
end
|
126
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#cancel_metadata_transfer_job-instance_method
|
127
|
+
def cancel_metadata_transfer_job: (
|
128
|
+
metadata_transfer_job_id: ::String
|
129
|
+
) -> _CancelMetadataTransferJobResponseSuccess
|
130
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CancelMetadataTransferJobResponseSuccess
|
131
|
+
|
132
|
+
interface _CreateComponentTypeResponseSuccess
|
133
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateComponentTypeResponse]
|
134
|
+
def arn: () -> ::String
|
135
|
+
def creation_date_time: () -> ::Time
|
136
|
+
def state: () -> ("CREATING" | "UPDATING" | "DELETING" | "ACTIVE" | "ERROR")
|
137
|
+
end
|
138
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#create_component_type-instance_method
|
139
|
+
def create_component_type: (
|
140
|
+
workspace_id: ::String,
|
141
|
+
?is_singleton: bool,
|
142
|
+
component_type_id: ::String,
|
143
|
+
?description: ::String,
|
144
|
+
?property_definitions: Hash[::String, {
|
145
|
+
data_type: {
|
146
|
+
type: ("RELATIONSHIP" | "STRING" | "LONG" | "BOOLEAN" | "INTEGER" | "DOUBLE" | "LIST" | "MAP"),
|
147
|
+
nested_type: untyped?,
|
148
|
+
allowed_values: Array[
|
149
|
+
{
|
150
|
+
boolean_value: bool?,
|
151
|
+
double_value: ::Float?,
|
152
|
+
integer_value: ::Integer?,
|
153
|
+
long_value: ::Integer?,
|
154
|
+
string_value: ::String?,
|
155
|
+
list_value: untyped?,
|
156
|
+
map_value: Hash[::String, untyped]?,
|
157
|
+
relationship_value: {
|
158
|
+
target_entity_id: ::String?,
|
159
|
+
target_component_name: ::String?
|
160
|
+
}?,
|
161
|
+
expression: ::String?
|
162
|
+
},
|
163
|
+
]?,
|
164
|
+
unit_of_measure: ::String?,
|
165
|
+
relationship: {
|
166
|
+
target_component_type_id: ::String?,
|
167
|
+
relationship_type: ::String?
|
168
|
+
}?
|
169
|
+
}?,
|
170
|
+
is_required_in_entity: bool?,
|
171
|
+
is_external_id: bool?,
|
172
|
+
is_stored_externally: bool?,
|
173
|
+
is_time_series: bool?,
|
174
|
+
default_value: {
|
175
|
+
boolean_value: bool?,
|
176
|
+
double_value: ::Float?,
|
177
|
+
integer_value: ::Integer?,
|
178
|
+
long_value: ::Integer?,
|
179
|
+
string_value: ::String?,
|
180
|
+
list_value: Array[
|
181
|
+
untyped,
|
182
|
+
]?,
|
183
|
+
map_value: Hash[::String, untyped]?,
|
184
|
+
relationship_value: {
|
185
|
+
target_entity_id: ::String?,
|
186
|
+
target_component_name: ::String?
|
187
|
+
}?,
|
188
|
+
expression: ::String?
|
189
|
+
}?,
|
190
|
+
configuration: Hash[::String, ::String]?,
|
191
|
+
display_name: ::String?
|
192
|
+
}],
|
193
|
+
?extends_from: Array[::String],
|
194
|
+
?functions: Hash[::String, {
|
195
|
+
required_properties: Array[::String]?,
|
196
|
+
scope: ("ENTITY" | "WORKSPACE")?,
|
197
|
+
implemented_by: {
|
198
|
+
lambda: {
|
199
|
+
arn: ::String
|
200
|
+
}?,
|
201
|
+
is_native: bool?
|
202
|
+
}?
|
203
|
+
}],
|
204
|
+
?tags: Hash[::String, ::String],
|
205
|
+
?property_groups: Hash[::String, {
|
206
|
+
group_type: ("TABULAR")?,
|
207
|
+
property_names: Array[::String]?
|
208
|
+
}],
|
209
|
+
?component_type_name: ::String,
|
210
|
+
?composite_component_types: Hash[::String, {
|
211
|
+
component_type_id: ::String?
|
212
|
+
}]
|
213
|
+
) -> _CreateComponentTypeResponseSuccess
|
214
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateComponentTypeResponseSuccess
|
215
|
+
|
216
|
+
interface _CreateEntityResponseSuccess
|
217
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateEntityResponse]
|
218
|
+
def entity_id: () -> ::String
|
219
|
+
def arn: () -> ::String
|
220
|
+
def creation_date_time: () -> ::Time
|
221
|
+
def state: () -> ("CREATING" | "UPDATING" | "DELETING" | "ACTIVE" | "ERROR")
|
222
|
+
end
|
223
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#create_entity-instance_method
|
224
|
+
def create_entity: (
|
225
|
+
workspace_id: ::String,
|
226
|
+
?entity_id: ::String,
|
227
|
+
entity_name: ::String,
|
228
|
+
?description: ::String,
|
229
|
+
?components: Hash[::String, {
|
230
|
+
description: ::String?,
|
231
|
+
component_type_id: ::String?,
|
232
|
+
properties: Hash[::String, {
|
233
|
+
definition: {
|
234
|
+
data_type: {
|
235
|
+
type: ("RELATIONSHIP" | "STRING" | "LONG" | "BOOLEAN" | "INTEGER" | "DOUBLE" | "LIST" | "MAP"),
|
236
|
+
nested_type: untyped?,
|
237
|
+
allowed_values: Array[
|
238
|
+
{
|
239
|
+
boolean_value: bool?,
|
240
|
+
double_value: ::Float?,
|
241
|
+
integer_value: ::Integer?,
|
242
|
+
long_value: ::Integer?,
|
243
|
+
string_value: ::String?,
|
244
|
+
list_value: untyped?,
|
245
|
+
map_value: Hash[::String, untyped]?,
|
246
|
+
relationship_value: {
|
247
|
+
target_entity_id: ::String?,
|
248
|
+
target_component_name: ::String?
|
249
|
+
}?,
|
250
|
+
expression: ::String?
|
251
|
+
},
|
252
|
+
]?,
|
253
|
+
unit_of_measure: ::String?,
|
254
|
+
relationship: {
|
255
|
+
target_component_type_id: ::String?,
|
256
|
+
relationship_type: ::String?
|
257
|
+
}?
|
258
|
+
}?,
|
259
|
+
is_required_in_entity: bool?,
|
260
|
+
is_external_id: bool?,
|
261
|
+
is_stored_externally: bool?,
|
262
|
+
is_time_series: bool?,
|
263
|
+
default_value: {
|
264
|
+
boolean_value: bool?,
|
265
|
+
double_value: ::Float?,
|
266
|
+
integer_value: ::Integer?,
|
267
|
+
long_value: ::Integer?,
|
268
|
+
string_value: ::String?,
|
269
|
+
list_value: Array[
|
270
|
+
untyped,
|
271
|
+
]?,
|
272
|
+
map_value: Hash[::String, untyped]?,
|
273
|
+
relationship_value: {
|
274
|
+
target_entity_id: ::String?,
|
275
|
+
target_component_name: ::String?
|
276
|
+
}?,
|
277
|
+
expression: ::String?
|
278
|
+
}?,
|
279
|
+
configuration: Hash[::String, ::String]?,
|
280
|
+
display_name: ::String?
|
281
|
+
}?,
|
282
|
+
value: {
|
283
|
+
boolean_value: bool?,
|
284
|
+
double_value: ::Float?,
|
285
|
+
integer_value: ::Integer?,
|
286
|
+
long_value: ::Integer?,
|
287
|
+
string_value: ::String?,
|
288
|
+
list_value: Array[
|
289
|
+
untyped,
|
290
|
+
]?,
|
291
|
+
map_value: Hash[::String, untyped]?,
|
292
|
+
relationship_value: {
|
293
|
+
target_entity_id: ::String?,
|
294
|
+
target_component_name: ::String?
|
295
|
+
}?,
|
296
|
+
expression: ::String?
|
297
|
+
}?,
|
298
|
+
update_type: ("UPDATE" | "DELETE" | "CREATE")?
|
299
|
+
}]?,
|
300
|
+
property_groups: Hash[::String, {
|
301
|
+
group_type: ("TABULAR")?,
|
302
|
+
property_names: Array[::String]?,
|
303
|
+
update_type: ("UPDATE" | "DELETE" | "CREATE")?
|
304
|
+
}]?
|
305
|
+
}],
|
306
|
+
?composite_components: Hash[::String, {
|
307
|
+
description: ::String?,
|
308
|
+
properties: Hash[::String, {
|
309
|
+
definition: {
|
310
|
+
data_type: {
|
311
|
+
type: ("RELATIONSHIP" | "STRING" | "LONG" | "BOOLEAN" | "INTEGER" | "DOUBLE" | "LIST" | "MAP"),
|
312
|
+
nested_type: untyped?,
|
313
|
+
allowed_values: Array[
|
314
|
+
{
|
315
|
+
boolean_value: bool?,
|
316
|
+
double_value: ::Float?,
|
317
|
+
integer_value: ::Integer?,
|
318
|
+
long_value: ::Integer?,
|
319
|
+
string_value: ::String?,
|
320
|
+
list_value: untyped?,
|
321
|
+
map_value: Hash[::String, untyped]?,
|
322
|
+
relationship_value: {
|
323
|
+
target_entity_id: ::String?,
|
324
|
+
target_component_name: ::String?
|
325
|
+
}?,
|
326
|
+
expression: ::String?
|
327
|
+
},
|
328
|
+
]?,
|
329
|
+
unit_of_measure: ::String?,
|
330
|
+
relationship: {
|
331
|
+
target_component_type_id: ::String?,
|
332
|
+
relationship_type: ::String?
|
333
|
+
}?
|
334
|
+
}?,
|
335
|
+
is_required_in_entity: bool?,
|
336
|
+
is_external_id: bool?,
|
337
|
+
is_stored_externally: bool?,
|
338
|
+
is_time_series: bool?,
|
339
|
+
default_value: {
|
340
|
+
boolean_value: bool?,
|
341
|
+
double_value: ::Float?,
|
342
|
+
integer_value: ::Integer?,
|
343
|
+
long_value: ::Integer?,
|
344
|
+
string_value: ::String?,
|
345
|
+
list_value: Array[
|
346
|
+
untyped,
|
347
|
+
]?,
|
348
|
+
map_value: Hash[::String, untyped]?,
|
349
|
+
relationship_value: {
|
350
|
+
target_entity_id: ::String?,
|
351
|
+
target_component_name: ::String?
|
352
|
+
}?,
|
353
|
+
expression: ::String?
|
354
|
+
}?,
|
355
|
+
configuration: Hash[::String, ::String]?,
|
356
|
+
display_name: ::String?
|
357
|
+
}?,
|
358
|
+
value: {
|
359
|
+
boolean_value: bool?,
|
360
|
+
double_value: ::Float?,
|
361
|
+
integer_value: ::Integer?,
|
362
|
+
long_value: ::Integer?,
|
363
|
+
string_value: ::String?,
|
364
|
+
list_value: Array[
|
365
|
+
untyped,
|
366
|
+
]?,
|
367
|
+
map_value: Hash[::String, untyped]?,
|
368
|
+
relationship_value: {
|
369
|
+
target_entity_id: ::String?,
|
370
|
+
target_component_name: ::String?
|
371
|
+
}?,
|
372
|
+
expression: ::String?
|
373
|
+
}?,
|
374
|
+
update_type: ("UPDATE" | "DELETE" | "CREATE")?
|
375
|
+
}]?,
|
376
|
+
property_groups: Hash[::String, {
|
377
|
+
group_type: ("TABULAR")?,
|
378
|
+
property_names: Array[::String]?,
|
379
|
+
update_type: ("UPDATE" | "DELETE" | "CREATE")?
|
380
|
+
}]?
|
381
|
+
}],
|
382
|
+
?parent_entity_id: ::String,
|
383
|
+
?tags: Hash[::String, ::String]
|
384
|
+
) -> _CreateEntityResponseSuccess
|
385
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateEntityResponseSuccess
|
386
|
+
|
387
|
+
interface _CreateMetadataTransferJobResponseSuccess
|
388
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateMetadataTransferJobResponse]
|
389
|
+
def metadata_transfer_job_id: () -> ::String
|
390
|
+
def arn: () -> ::String
|
391
|
+
def creation_date_time: () -> ::Time
|
392
|
+
def status: () -> Types::MetadataTransferJobStatus
|
393
|
+
end
|
394
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#create_metadata_transfer_job-instance_method
|
395
|
+
def create_metadata_transfer_job: (
|
396
|
+
?metadata_transfer_job_id: ::String,
|
397
|
+
?description: ::String,
|
398
|
+
sources: Array[
|
399
|
+
{
|
400
|
+
type: ("s3" | "iotsitewise" | "iottwinmaker"),
|
401
|
+
s3_configuration: {
|
402
|
+
location: ::String
|
403
|
+
}?,
|
404
|
+
iot_site_wise_configuration: {
|
405
|
+
filters: Array[
|
406
|
+
{
|
407
|
+
filter_by_asset_model: {
|
408
|
+
asset_model_id: ::String?,
|
409
|
+
asset_model_external_id: ::String?,
|
410
|
+
include_offspring: bool?,
|
411
|
+
include_assets: bool?
|
412
|
+
}?,
|
413
|
+
filter_by_asset: {
|
414
|
+
asset_id: ::String?,
|
415
|
+
asset_external_id: ::String?,
|
416
|
+
include_offspring: bool?,
|
417
|
+
include_asset_model: bool?
|
418
|
+
}?
|
419
|
+
},
|
420
|
+
]?
|
421
|
+
}?,
|
422
|
+
iot_twin_maker_configuration: {
|
423
|
+
workspace: ::String,
|
424
|
+
filters: Array[
|
425
|
+
{
|
426
|
+
filter_by_component_type: {
|
427
|
+
component_type_id: ::String
|
428
|
+
}?,
|
429
|
+
filter_by_entity: {
|
430
|
+
entity_id: ::String
|
431
|
+
}?
|
432
|
+
},
|
433
|
+
]?
|
434
|
+
}?
|
435
|
+
},
|
436
|
+
],
|
437
|
+
destination: {
|
438
|
+
type: ("s3" | "iotsitewise" | "iottwinmaker"),
|
439
|
+
s3_configuration: {
|
440
|
+
location: ::String
|
441
|
+
}?,
|
442
|
+
iot_twin_maker_configuration: {
|
443
|
+
workspace: ::String
|
444
|
+
}?
|
445
|
+
}
|
446
|
+
) -> _CreateMetadataTransferJobResponseSuccess
|
447
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateMetadataTransferJobResponseSuccess
|
448
|
+
|
449
|
+
interface _CreateSceneResponseSuccess
|
450
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateSceneResponse]
|
451
|
+
def arn: () -> ::String
|
452
|
+
def creation_date_time: () -> ::Time
|
453
|
+
end
|
454
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#create_scene-instance_method
|
455
|
+
def create_scene: (
|
456
|
+
workspace_id: ::String,
|
457
|
+
scene_id: ::String,
|
458
|
+
content_location: ::String,
|
459
|
+
?description: ::String,
|
460
|
+
?capabilities: Array[::String],
|
461
|
+
?tags: Hash[::String, ::String],
|
462
|
+
?scene_metadata: Hash[::String, ::String]
|
463
|
+
) -> _CreateSceneResponseSuccess
|
464
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateSceneResponseSuccess
|
465
|
+
|
466
|
+
interface _CreateSyncJobResponseSuccess
|
467
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateSyncJobResponse]
|
468
|
+
def arn: () -> ::String
|
469
|
+
def creation_date_time: () -> ::Time
|
470
|
+
def state: () -> ("CREATING" | "INITIALIZING" | "ACTIVE" | "DELETING" | "ERROR")
|
471
|
+
end
|
472
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#create_sync_job-instance_method
|
473
|
+
def create_sync_job: (
|
474
|
+
workspace_id: ::String,
|
475
|
+
sync_source: ::String,
|
476
|
+
sync_role: ::String,
|
477
|
+
?tags: Hash[::String, ::String]
|
478
|
+
) -> _CreateSyncJobResponseSuccess
|
479
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateSyncJobResponseSuccess
|
480
|
+
|
481
|
+
interface _CreateWorkspaceResponseSuccess
|
482
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateWorkspaceResponse]
|
483
|
+
def arn: () -> ::String
|
484
|
+
def creation_date_time: () -> ::Time
|
485
|
+
end
|
486
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#create_workspace-instance_method
|
487
|
+
def create_workspace: (
|
488
|
+
workspace_id: ::String,
|
489
|
+
?description: ::String,
|
490
|
+
?s3_location: ::String,
|
491
|
+
?role: ::String,
|
492
|
+
?tags: Hash[::String, ::String]
|
493
|
+
) -> _CreateWorkspaceResponseSuccess
|
494
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateWorkspaceResponseSuccess
|
495
|
+
|
496
|
+
interface _DeleteComponentTypeResponseSuccess
|
497
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteComponentTypeResponse]
|
498
|
+
def state: () -> ("CREATING" | "UPDATING" | "DELETING" | "ACTIVE" | "ERROR")
|
499
|
+
end
|
500
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#delete_component_type-instance_method
|
501
|
+
def delete_component_type: (
|
502
|
+
workspace_id: ::String,
|
503
|
+
component_type_id: ::String
|
504
|
+
) -> _DeleteComponentTypeResponseSuccess
|
505
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteComponentTypeResponseSuccess
|
506
|
+
|
507
|
+
interface _DeleteEntityResponseSuccess
|
508
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteEntityResponse]
|
509
|
+
def state: () -> ("CREATING" | "UPDATING" | "DELETING" | "ACTIVE" | "ERROR")
|
510
|
+
end
|
511
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#delete_entity-instance_method
|
512
|
+
def delete_entity: (
|
513
|
+
workspace_id: ::String,
|
514
|
+
entity_id: ::String,
|
515
|
+
?is_recursive: bool
|
516
|
+
) -> _DeleteEntityResponseSuccess
|
517
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteEntityResponseSuccess
|
518
|
+
|
519
|
+
interface _DeleteSceneResponseSuccess
|
520
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteSceneResponse]
|
521
|
+
end
|
522
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#delete_scene-instance_method
|
523
|
+
def delete_scene: (
|
524
|
+
workspace_id: ::String,
|
525
|
+
scene_id: ::String
|
526
|
+
) -> _DeleteSceneResponseSuccess
|
527
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteSceneResponseSuccess
|
528
|
+
|
529
|
+
interface _DeleteSyncJobResponseSuccess
|
530
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteSyncJobResponse]
|
531
|
+
def state: () -> ("CREATING" | "INITIALIZING" | "ACTIVE" | "DELETING" | "ERROR")
|
532
|
+
end
|
533
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#delete_sync_job-instance_method
|
534
|
+
def delete_sync_job: (
|
535
|
+
workspace_id: ::String,
|
536
|
+
sync_source: ::String
|
537
|
+
) -> _DeleteSyncJobResponseSuccess
|
538
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteSyncJobResponseSuccess
|
539
|
+
|
540
|
+
interface _DeleteWorkspaceResponseSuccess
|
541
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteWorkspaceResponse]
|
542
|
+
def message: () -> ::String
|
543
|
+
end
|
544
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#delete_workspace-instance_method
|
545
|
+
def delete_workspace: (
|
546
|
+
workspace_id: ::String
|
547
|
+
) -> _DeleteWorkspaceResponseSuccess
|
548
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteWorkspaceResponseSuccess
|
549
|
+
|
550
|
+
interface _ExecuteQueryResponseSuccess
|
551
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ExecuteQueryResponse]
|
552
|
+
def column_descriptions: () -> ::Array[Types::ColumnDescription]
|
553
|
+
def rows: () -> ::Array[Types::Row]
|
554
|
+
def next_token: () -> ::String
|
555
|
+
end
|
556
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#execute_query-instance_method
|
557
|
+
def execute_query: (
|
558
|
+
workspace_id: ::String,
|
559
|
+
query_statement: ::String,
|
560
|
+
?max_results: ::Integer,
|
561
|
+
?next_token: ::String
|
562
|
+
) -> _ExecuteQueryResponseSuccess
|
563
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ExecuteQueryResponseSuccess
|
564
|
+
|
565
|
+
interface _GetComponentTypeResponseSuccess
|
566
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetComponentTypeResponse]
|
567
|
+
def workspace_id: () -> ::String
|
568
|
+
def is_singleton: () -> bool
|
569
|
+
def component_type_id: () -> ::String
|
570
|
+
def description: () -> ::String
|
571
|
+
def property_definitions: () -> ::Hash[::String, Types::PropertyDefinitionResponse]
|
572
|
+
def extends_from: () -> ::Array[::String]
|
573
|
+
def functions: () -> ::Hash[::String, Types::FunctionResponse]
|
574
|
+
def creation_date_time: () -> ::Time
|
575
|
+
def update_date_time: () -> ::Time
|
576
|
+
def arn: () -> ::String
|
577
|
+
def is_abstract: () -> bool
|
578
|
+
def is_schema_initialized: () -> bool
|
579
|
+
def status: () -> Types::Status
|
580
|
+
def property_groups: () -> ::Hash[::String, Types::PropertyGroupResponse]
|
581
|
+
def sync_source: () -> ::String
|
582
|
+
def component_type_name: () -> ::String
|
583
|
+
def composite_component_types: () -> ::Hash[::String, Types::CompositeComponentTypeResponse]
|
584
|
+
end
|
585
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#get_component_type-instance_method
|
586
|
+
def get_component_type: (
|
587
|
+
workspace_id: ::String,
|
588
|
+
component_type_id: ::String
|
589
|
+
) -> _GetComponentTypeResponseSuccess
|
590
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetComponentTypeResponseSuccess
|
591
|
+
|
592
|
+
interface _GetEntityResponseSuccess
|
593
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetEntityResponse]
|
594
|
+
def entity_id: () -> ::String
|
595
|
+
def entity_name: () -> ::String
|
596
|
+
def arn: () -> ::String
|
597
|
+
def status: () -> Types::Status
|
598
|
+
def workspace_id: () -> ::String
|
599
|
+
def description: () -> ::String
|
600
|
+
def components: () -> ::Hash[::String, Types::ComponentResponse]
|
601
|
+
def parent_entity_id: () -> ::String
|
602
|
+
def has_child_entities: () -> bool
|
603
|
+
def creation_date_time: () -> ::Time
|
604
|
+
def update_date_time: () -> ::Time
|
605
|
+
def sync_source: () -> ::String
|
606
|
+
def are_all_components_returned: () -> bool
|
607
|
+
end
|
608
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#get_entity-instance_method
|
609
|
+
def get_entity: (
|
610
|
+
workspace_id: ::String,
|
611
|
+
entity_id: ::String
|
612
|
+
) -> _GetEntityResponseSuccess
|
613
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetEntityResponseSuccess
|
614
|
+
|
615
|
+
interface _GetMetadataTransferJobResponseSuccess
|
616
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetMetadataTransferJobResponse]
|
617
|
+
def metadata_transfer_job_id: () -> ::String
|
618
|
+
def arn: () -> ::String
|
619
|
+
def description: () -> ::String
|
620
|
+
def sources: () -> ::Array[Types::SourceConfiguration]
|
621
|
+
def destination: () -> Types::DestinationConfiguration
|
622
|
+
def metadata_transfer_job_role: () -> ::String
|
623
|
+
def report_url: () -> ::String
|
624
|
+
def creation_date_time: () -> ::Time
|
625
|
+
def update_date_time: () -> ::Time
|
626
|
+
def status: () -> Types::MetadataTransferJobStatus
|
627
|
+
def progress: () -> Types::MetadataTransferJobProgress
|
628
|
+
end
|
629
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#get_metadata_transfer_job-instance_method
|
630
|
+
def get_metadata_transfer_job: (
|
631
|
+
metadata_transfer_job_id: ::String
|
632
|
+
) -> _GetMetadataTransferJobResponseSuccess
|
633
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetMetadataTransferJobResponseSuccess
|
634
|
+
|
635
|
+
interface _GetPricingPlanResponseSuccess
|
636
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetPricingPlanResponse]
|
637
|
+
def current_pricing_plan: () -> Types::PricingPlan
|
638
|
+
def pending_pricing_plan: () -> Types::PricingPlan
|
639
|
+
end
|
640
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#get_pricing_plan-instance_method
|
641
|
+
def get_pricing_plan: (
|
642
|
+
) -> _GetPricingPlanResponseSuccess
|
643
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetPricingPlanResponseSuccess
|
644
|
+
|
645
|
+
interface _GetPropertyValueResponseSuccess
|
646
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetPropertyValueResponse]
|
647
|
+
def property_values: () -> ::Hash[::String, Types::PropertyLatestValue]
|
648
|
+
def next_token: () -> ::String
|
649
|
+
def tabular_property_values: () -> ::Array[::Array[::Hash[::String, Types::DataValue]]]
|
650
|
+
end
|
651
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#get_property_value-instance_method
|
652
|
+
def get_property_value: (
|
653
|
+
?component_name: ::String,
|
654
|
+
?component_path: ::String,
|
655
|
+
?component_type_id: ::String,
|
656
|
+
?entity_id: ::String,
|
657
|
+
selected_properties: Array[::String],
|
658
|
+
workspace_id: ::String,
|
659
|
+
?max_results: ::Integer,
|
660
|
+
?next_token: ::String,
|
661
|
+
?property_group_name: ::String,
|
662
|
+
?tabular_conditions: {
|
663
|
+
order_by: Array[
|
664
|
+
{
|
665
|
+
order: ("ASCENDING" | "DESCENDING")?,
|
666
|
+
property_name: ::String
|
667
|
+
},
|
668
|
+
]?,
|
669
|
+
property_filters: Array[
|
670
|
+
{
|
671
|
+
property_name: ::String?,
|
672
|
+
operator: ::String?,
|
673
|
+
value: {
|
674
|
+
boolean_value: bool?,
|
675
|
+
double_value: ::Float?,
|
676
|
+
integer_value: ::Integer?,
|
677
|
+
long_value: ::Integer?,
|
678
|
+
string_value: ::String?,
|
679
|
+
list_value: Array[
|
680
|
+
untyped,
|
681
|
+
]?,
|
682
|
+
map_value: Hash[::String, untyped]?,
|
683
|
+
relationship_value: {
|
684
|
+
target_entity_id: ::String?,
|
685
|
+
target_component_name: ::String?
|
686
|
+
}?,
|
687
|
+
expression: ::String?
|
688
|
+
}?
|
689
|
+
},
|
690
|
+
]?
|
691
|
+
}
|
692
|
+
) -> _GetPropertyValueResponseSuccess
|
693
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetPropertyValueResponseSuccess
|
694
|
+
|
695
|
+
interface _GetPropertyValueHistoryResponseSuccess
|
696
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetPropertyValueHistoryResponse]
|
697
|
+
def property_values: () -> ::Array[Types::PropertyValueHistory]
|
698
|
+
def next_token: () -> ::String
|
699
|
+
end
|
700
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#get_property_value_history-instance_method
|
701
|
+
def get_property_value_history: (
|
702
|
+
workspace_id: ::String,
|
703
|
+
?entity_id: ::String,
|
704
|
+
?component_name: ::String,
|
705
|
+
?component_path: ::String,
|
706
|
+
?component_type_id: ::String,
|
707
|
+
selected_properties: Array[::String],
|
708
|
+
?property_filters: Array[
|
709
|
+
{
|
710
|
+
property_name: ::String?,
|
711
|
+
operator: ::String?,
|
712
|
+
value: {
|
713
|
+
boolean_value: bool?,
|
714
|
+
double_value: ::Float?,
|
715
|
+
integer_value: ::Integer?,
|
716
|
+
long_value: ::Integer?,
|
717
|
+
string_value: ::String?,
|
718
|
+
list_value: Array[
|
719
|
+
untyped,
|
720
|
+
]?,
|
721
|
+
map_value: Hash[::String, untyped]?,
|
722
|
+
relationship_value: {
|
723
|
+
target_entity_id: ::String?,
|
724
|
+
target_component_name: ::String?
|
725
|
+
}?,
|
726
|
+
expression: ::String?
|
727
|
+
}?
|
728
|
+
},
|
729
|
+
],
|
730
|
+
?start_date_time: ::Time,
|
731
|
+
?end_date_time: ::Time,
|
732
|
+
?interpolation: {
|
733
|
+
interpolation_type: ("LINEAR")?,
|
734
|
+
interval_in_seconds: ::Integer?
|
735
|
+
},
|
736
|
+
?next_token: ::String,
|
737
|
+
?max_results: ::Integer,
|
738
|
+
?order_by_time: ("ASCENDING" | "DESCENDING"),
|
739
|
+
?start_time: ::String,
|
740
|
+
?end_time: ::String
|
741
|
+
) -> _GetPropertyValueHistoryResponseSuccess
|
742
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetPropertyValueHistoryResponseSuccess
|
743
|
+
|
744
|
+
interface _GetSceneResponseSuccess
|
745
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetSceneResponse]
|
746
|
+
def workspace_id: () -> ::String
|
747
|
+
def scene_id: () -> ::String
|
748
|
+
def content_location: () -> ::String
|
749
|
+
def arn: () -> ::String
|
750
|
+
def creation_date_time: () -> ::Time
|
751
|
+
def update_date_time: () -> ::Time
|
752
|
+
def description: () -> ::String
|
753
|
+
def capabilities: () -> ::Array[::String]
|
754
|
+
def scene_metadata: () -> ::Hash[::String, ::String]
|
755
|
+
def generated_scene_metadata: () -> ::Hash[::String, ::String]
|
756
|
+
end
|
757
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#get_scene-instance_method
|
758
|
+
def get_scene: (
|
759
|
+
workspace_id: ::String,
|
760
|
+
scene_id: ::String
|
761
|
+
) -> _GetSceneResponseSuccess
|
762
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetSceneResponseSuccess
|
763
|
+
|
764
|
+
interface _GetSyncJobResponseSuccess
|
765
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetSyncJobResponse]
|
766
|
+
def arn: () -> ::String
|
767
|
+
def workspace_id: () -> ::String
|
768
|
+
def sync_source: () -> ::String
|
769
|
+
def sync_role: () -> ::String
|
770
|
+
def status: () -> Types::SyncJobStatus
|
771
|
+
def creation_date_time: () -> ::Time
|
772
|
+
def update_date_time: () -> ::Time
|
773
|
+
end
|
774
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#get_sync_job-instance_method
|
775
|
+
def get_sync_job: (
|
776
|
+
sync_source: ::String,
|
777
|
+
?workspace_id: ::String
|
778
|
+
) -> _GetSyncJobResponseSuccess
|
779
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetSyncJobResponseSuccess
|
780
|
+
|
781
|
+
interface _GetWorkspaceResponseSuccess
|
782
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetWorkspaceResponse]
|
783
|
+
def workspace_id: () -> ::String
|
784
|
+
def arn: () -> ::String
|
785
|
+
def description: () -> ::String
|
786
|
+
def linked_services: () -> ::Array[::String]
|
787
|
+
def s3_location: () -> ::String
|
788
|
+
def role: () -> ::String
|
789
|
+
def creation_date_time: () -> ::Time
|
790
|
+
def update_date_time: () -> ::Time
|
791
|
+
end
|
792
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#get_workspace-instance_method
|
793
|
+
def get_workspace: (
|
794
|
+
workspace_id: ::String
|
795
|
+
) -> _GetWorkspaceResponseSuccess
|
796
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetWorkspaceResponseSuccess
|
797
|
+
|
798
|
+
interface _ListComponentTypesResponseSuccess
|
799
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListComponentTypesResponse]
|
800
|
+
def workspace_id: () -> ::String
|
801
|
+
def component_type_summaries: () -> ::Array[Types::ComponentTypeSummary]
|
802
|
+
def next_token: () -> ::String
|
803
|
+
def max_results: () -> ::Integer
|
804
|
+
end
|
805
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#list_component_types-instance_method
|
806
|
+
def list_component_types: (
|
807
|
+
workspace_id: ::String,
|
808
|
+
?filters: Array[
|
809
|
+
{
|
810
|
+
extends_from: ::String?,
|
811
|
+
namespace: ::String?,
|
812
|
+
is_abstract: bool?
|
813
|
+
},
|
814
|
+
],
|
815
|
+
?next_token: ::String,
|
816
|
+
?max_results: ::Integer
|
817
|
+
) -> _ListComponentTypesResponseSuccess
|
818
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListComponentTypesResponseSuccess
|
819
|
+
|
820
|
+
interface _ListComponentsResponseSuccess
|
821
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListComponentsResponse]
|
822
|
+
def component_summaries: () -> ::Array[Types::ComponentSummary]
|
823
|
+
def next_token: () -> ::String
|
824
|
+
end
|
825
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#list_components-instance_method
|
826
|
+
def list_components: (
|
827
|
+
workspace_id: ::String,
|
828
|
+
entity_id: ::String,
|
829
|
+
?component_path: ::String,
|
830
|
+
?max_results: ::Integer,
|
831
|
+
?next_token: ::String
|
832
|
+
) -> _ListComponentsResponseSuccess
|
833
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListComponentsResponseSuccess
|
834
|
+
|
835
|
+
interface _ListEntitiesResponseSuccess
|
836
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListEntitiesResponse]
|
837
|
+
def entity_summaries: () -> ::Array[Types::EntitySummary]
|
838
|
+
def next_token: () -> ::String
|
839
|
+
end
|
840
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#list_entities-instance_method
|
841
|
+
def list_entities: (
|
842
|
+
workspace_id: ::String,
|
843
|
+
?filters: Array[
|
844
|
+
{
|
845
|
+
parent_entity_id: ::String?,
|
846
|
+
component_type_id: ::String?,
|
847
|
+
external_id: ::String?
|
848
|
+
},
|
849
|
+
],
|
850
|
+
?max_results: ::Integer,
|
851
|
+
?next_token: ::String
|
852
|
+
) -> _ListEntitiesResponseSuccess
|
853
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListEntitiesResponseSuccess
|
854
|
+
|
855
|
+
interface _ListMetadataTransferJobsResponseSuccess
|
856
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListMetadataTransferJobsResponse]
|
857
|
+
def metadata_transfer_job_summaries: () -> ::Array[Types::MetadataTransferJobSummary]
|
858
|
+
def next_token: () -> ::String
|
859
|
+
end
|
860
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#list_metadata_transfer_jobs-instance_method
|
861
|
+
def list_metadata_transfer_jobs: (
|
862
|
+
source_type: ("s3" | "iotsitewise" | "iottwinmaker"),
|
863
|
+
destination_type: ("s3" | "iotsitewise" | "iottwinmaker"),
|
864
|
+
?filters: Array[
|
865
|
+
{
|
866
|
+
workspace_id: ::String?,
|
867
|
+
state: ("VALIDATING" | "PENDING" | "RUNNING" | "CANCELLING" | "ERROR" | "COMPLETED" | "CANCELLED")?
|
868
|
+
},
|
869
|
+
],
|
870
|
+
?next_token: ::String,
|
871
|
+
?max_results: ::Integer
|
872
|
+
) -> _ListMetadataTransferJobsResponseSuccess
|
873
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListMetadataTransferJobsResponseSuccess
|
874
|
+
|
875
|
+
interface _ListPropertiesResponseSuccess
|
876
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListPropertiesResponse]
|
877
|
+
def property_summaries: () -> ::Array[Types::PropertySummary]
|
878
|
+
def next_token: () -> ::String
|
879
|
+
end
|
880
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#list_properties-instance_method
|
881
|
+
def list_properties: (
|
882
|
+
workspace_id: ::String,
|
883
|
+
?component_name: ::String,
|
884
|
+
?component_path: ::String,
|
885
|
+
entity_id: ::String,
|
886
|
+
?max_results: ::Integer,
|
887
|
+
?next_token: ::String
|
888
|
+
) -> _ListPropertiesResponseSuccess
|
889
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPropertiesResponseSuccess
|
890
|
+
|
891
|
+
interface _ListScenesResponseSuccess
|
892
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListScenesResponse]
|
893
|
+
def scene_summaries: () -> ::Array[Types::SceneSummary]
|
894
|
+
def next_token: () -> ::String
|
895
|
+
end
|
896
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#list_scenes-instance_method
|
897
|
+
def list_scenes: (
|
898
|
+
workspace_id: ::String,
|
899
|
+
?max_results: ::Integer,
|
900
|
+
?next_token: ::String
|
901
|
+
) -> _ListScenesResponseSuccess
|
902
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListScenesResponseSuccess
|
903
|
+
|
904
|
+
interface _ListSyncJobsResponseSuccess
|
905
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListSyncJobsResponse]
|
906
|
+
def sync_job_summaries: () -> ::Array[Types::SyncJobSummary]
|
907
|
+
def next_token: () -> ::String
|
908
|
+
end
|
909
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#list_sync_jobs-instance_method
|
910
|
+
def list_sync_jobs: (
|
911
|
+
workspace_id: ::String,
|
912
|
+
?max_results: ::Integer,
|
913
|
+
?next_token: ::String
|
914
|
+
) -> _ListSyncJobsResponseSuccess
|
915
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListSyncJobsResponseSuccess
|
916
|
+
|
917
|
+
interface _ListSyncResourcesResponseSuccess
|
918
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListSyncResourcesResponse]
|
919
|
+
def sync_resources: () -> ::Array[Types::SyncResourceSummary]
|
920
|
+
def next_token: () -> ::String
|
921
|
+
end
|
922
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#list_sync_resources-instance_method
|
923
|
+
def list_sync_resources: (
|
924
|
+
workspace_id: ::String,
|
925
|
+
sync_source: ::String,
|
926
|
+
?filters: Array[
|
927
|
+
{
|
928
|
+
state: ("INITIALIZING" | "PROCESSING" | "DELETED" | "IN_SYNC" | "ERROR")?,
|
929
|
+
resource_type: ("ENTITY" | "COMPONENT_TYPE")?,
|
930
|
+
resource_id: ::String?,
|
931
|
+
external_id: ::String?
|
932
|
+
},
|
933
|
+
],
|
934
|
+
?max_results: ::Integer,
|
935
|
+
?next_token: ::String
|
936
|
+
) -> _ListSyncResourcesResponseSuccess
|
937
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListSyncResourcesResponseSuccess
|
938
|
+
|
939
|
+
interface _ListTagsForResourceResponseSuccess
|
940
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
|
941
|
+
def tags: () -> ::Hash[::String, ::String]
|
942
|
+
def next_token: () -> ::String
|
943
|
+
end
|
944
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#list_tags_for_resource-instance_method
|
945
|
+
def list_tags_for_resource: (
|
946
|
+
resource_arn: ::String,
|
947
|
+
?max_results: ::Integer,
|
948
|
+
?next_token: ::String
|
949
|
+
) -> _ListTagsForResourceResponseSuccess
|
950
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
|
951
|
+
|
952
|
+
interface _ListWorkspacesResponseSuccess
|
953
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListWorkspacesResponse]
|
954
|
+
def workspace_summaries: () -> ::Array[Types::WorkspaceSummary]
|
955
|
+
def next_token: () -> ::String
|
956
|
+
end
|
957
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#list_workspaces-instance_method
|
958
|
+
def list_workspaces: (
|
959
|
+
?max_results: ::Integer,
|
960
|
+
?next_token: ::String
|
961
|
+
) -> _ListWorkspacesResponseSuccess
|
962
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListWorkspacesResponseSuccess
|
963
|
+
|
964
|
+
interface _TagResourceResponseSuccess
|
965
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
|
966
|
+
end
|
967
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#tag_resource-instance_method
|
968
|
+
def tag_resource: (
|
969
|
+
resource_arn: ::String,
|
970
|
+
tags: Hash[::String, ::String]
|
971
|
+
) -> _TagResourceResponseSuccess
|
972
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
|
973
|
+
|
974
|
+
interface _UntagResourceResponseSuccess
|
975
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceResponse]
|
976
|
+
end
|
977
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#untag_resource-instance_method
|
978
|
+
def untag_resource: (
|
979
|
+
resource_arn: ::String,
|
980
|
+
tag_keys: Array[::String]
|
981
|
+
) -> _UntagResourceResponseSuccess
|
982
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
|
983
|
+
|
984
|
+
interface _UpdateComponentTypeResponseSuccess
|
985
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateComponentTypeResponse]
|
986
|
+
def workspace_id: () -> ::String
|
987
|
+
def arn: () -> ::String
|
988
|
+
def component_type_id: () -> ::String
|
989
|
+
def state: () -> ("CREATING" | "UPDATING" | "DELETING" | "ACTIVE" | "ERROR")
|
990
|
+
end
|
991
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#update_component_type-instance_method
|
992
|
+
def update_component_type: (
|
993
|
+
workspace_id: ::String,
|
994
|
+
?is_singleton: bool,
|
995
|
+
component_type_id: ::String,
|
996
|
+
?description: ::String,
|
997
|
+
?property_definitions: Hash[::String, {
|
998
|
+
data_type: {
|
999
|
+
type: ("RELATIONSHIP" | "STRING" | "LONG" | "BOOLEAN" | "INTEGER" | "DOUBLE" | "LIST" | "MAP"),
|
1000
|
+
nested_type: untyped?,
|
1001
|
+
allowed_values: Array[
|
1002
|
+
{
|
1003
|
+
boolean_value: bool?,
|
1004
|
+
double_value: ::Float?,
|
1005
|
+
integer_value: ::Integer?,
|
1006
|
+
long_value: ::Integer?,
|
1007
|
+
string_value: ::String?,
|
1008
|
+
list_value: untyped?,
|
1009
|
+
map_value: Hash[::String, untyped]?,
|
1010
|
+
relationship_value: {
|
1011
|
+
target_entity_id: ::String?,
|
1012
|
+
target_component_name: ::String?
|
1013
|
+
}?,
|
1014
|
+
expression: ::String?
|
1015
|
+
},
|
1016
|
+
]?,
|
1017
|
+
unit_of_measure: ::String?,
|
1018
|
+
relationship: {
|
1019
|
+
target_component_type_id: ::String?,
|
1020
|
+
relationship_type: ::String?
|
1021
|
+
}?
|
1022
|
+
}?,
|
1023
|
+
is_required_in_entity: bool?,
|
1024
|
+
is_external_id: bool?,
|
1025
|
+
is_stored_externally: bool?,
|
1026
|
+
is_time_series: bool?,
|
1027
|
+
default_value: {
|
1028
|
+
boolean_value: bool?,
|
1029
|
+
double_value: ::Float?,
|
1030
|
+
integer_value: ::Integer?,
|
1031
|
+
long_value: ::Integer?,
|
1032
|
+
string_value: ::String?,
|
1033
|
+
list_value: Array[
|
1034
|
+
untyped,
|
1035
|
+
]?,
|
1036
|
+
map_value: Hash[::String, untyped]?,
|
1037
|
+
relationship_value: {
|
1038
|
+
target_entity_id: ::String?,
|
1039
|
+
target_component_name: ::String?
|
1040
|
+
}?,
|
1041
|
+
expression: ::String?
|
1042
|
+
}?,
|
1043
|
+
configuration: Hash[::String, ::String]?,
|
1044
|
+
display_name: ::String?
|
1045
|
+
}],
|
1046
|
+
?extends_from: Array[::String],
|
1047
|
+
?functions: Hash[::String, {
|
1048
|
+
required_properties: Array[::String]?,
|
1049
|
+
scope: ("ENTITY" | "WORKSPACE")?,
|
1050
|
+
implemented_by: {
|
1051
|
+
lambda: {
|
1052
|
+
arn: ::String
|
1053
|
+
}?,
|
1054
|
+
is_native: bool?
|
1055
|
+
}?
|
1056
|
+
}],
|
1057
|
+
?property_groups: Hash[::String, {
|
1058
|
+
group_type: ("TABULAR")?,
|
1059
|
+
property_names: Array[::String]?
|
1060
|
+
}],
|
1061
|
+
?component_type_name: ::String,
|
1062
|
+
?composite_component_types: Hash[::String, {
|
1063
|
+
component_type_id: ::String?
|
1064
|
+
}]
|
1065
|
+
) -> _UpdateComponentTypeResponseSuccess
|
1066
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateComponentTypeResponseSuccess
|
1067
|
+
|
1068
|
+
interface _UpdateEntityResponseSuccess
|
1069
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateEntityResponse]
|
1070
|
+
def update_date_time: () -> ::Time
|
1071
|
+
def state: () -> ("CREATING" | "UPDATING" | "DELETING" | "ACTIVE" | "ERROR")
|
1072
|
+
end
|
1073
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#update_entity-instance_method
|
1074
|
+
def update_entity: (
|
1075
|
+
workspace_id: ::String,
|
1076
|
+
entity_id: ::String,
|
1077
|
+
?entity_name: ::String,
|
1078
|
+
?description: ::String,
|
1079
|
+
?component_updates: Hash[::String, {
|
1080
|
+
update_type: ("CREATE" | "UPDATE" | "DELETE")?,
|
1081
|
+
description: ::String?,
|
1082
|
+
component_type_id: ::String?,
|
1083
|
+
property_updates: Hash[::String, {
|
1084
|
+
definition: {
|
1085
|
+
data_type: {
|
1086
|
+
type: ("RELATIONSHIP" | "STRING" | "LONG" | "BOOLEAN" | "INTEGER" | "DOUBLE" | "LIST" | "MAP"),
|
1087
|
+
nested_type: untyped?,
|
1088
|
+
allowed_values: Array[
|
1089
|
+
{
|
1090
|
+
boolean_value: bool?,
|
1091
|
+
double_value: ::Float?,
|
1092
|
+
integer_value: ::Integer?,
|
1093
|
+
long_value: ::Integer?,
|
1094
|
+
string_value: ::String?,
|
1095
|
+
list_value: untyped?,
|
1096
|
+
map_value: Hash[::String, untyped]?,
|
1097
|
+
relationship_value: {
|
1098
|
+
target_entity_id: ::String?,
|
1099
|
+
target_component_name: ::String?
|
1100
|
+
}?,
|
1101
|
+
expression: ::String?
|
1102
|
+
},
|
1103
|
+
]?,
|
1104
|
+
unit_of_measure: ::String?,
|
1105
|
+
relationship: {
|
1106
|
+
target_component_type_id: ::String?,
|
1107
|
+
relationship_type: ::String?
|
1108
|
+
}?
|
1109
|
+
}?,
|
1110
|
+
is_required_in_entity: bool?,
|
1111
|
+
is_external_id: bool?,
|
1112
|
+
is_stored_externally: bool?,
|
1113
|
+
is_time_series: bool?,
|
1114
|
+
default_value: {
|
1115
|
+
boolean_value: bool?,
|
1116
|
+
double_value: ::Float?,
|
1117
|
+
integer_value: ::Integer?,
|
1118
|
+
long_value: ::Integer?,
|
1119
|
+
string_value: ::String?,
|
1120
|
+
list_value: Array[
|
1121
|
+
untyped,
|
1122
|
+
]?,
|
1123
|
+
map_value: Hash[::String, untyped]?,
|
1124
|
+
relationship_value: {
|
1125
|
+
target_entity_id: ::String?,
|
1126
|
+
target_component_name: ::String?
|
1127
|
+
}?,
|
1128
|
+
expression: ::String?
|
1129
|
+
}?,
|
1130
|
+
configuration: Hash[::String, ::String]?,
|
1131
|
+
display_name: ::String?
|
1132
|
+
}?,
|
1133
|
+
value: {
|
1134
|
+
boolean_value: bool?,
|
1135
|
+
double_value: ::Float?,
|
1136
|
+
integer_value: ::Integer?,
|
1137
|
+
long_value: ::Integer?,
|
1138
|
+
string_value: ::String?,
|
1139
|
+
list_value: Array[
|
1140
|
+
untyped,
|
1141
|
+
]?,
|
1142
|
+
map_value: Hash[::String, untyped]?,
|
1143
|
+
relationship_value: {
|
1144
|
+
target_entity_id: ::String?,
|
1145
|
+
target_component_name: ::String?
|
1146
|
+
}?,
|
1147
|
+
expression: ::String?
|
1148
|
+
}?,
|
1149
|
+
update_type: ("UPDATE" | "DELETE" | "CREATE")?
|
1150
|
+
}]?,
|
1151
|
+
property_group_updates: Hash[::String, {
|
1152
|
+
group_type: ("TABULAR")?,
|
1153
|
+
property_names: Array[::String]?,
|
1154
|
+
update_type: ("UPDATE" | "DELETE" | "CREATE")?
|
1155
|
+
}]?
|
1156
|
+
}],
|
1157
|
+
?composite_component_updates: Hash[::String, {
|
1158
|
+
update_type: ("CREATE" | "UPDATE" | "DELETE")?,
|
1159
|
+
description: ::String?,
|
1160
|
+
property_updates: Hash[::String, {
|
1161
|
+
definition: {
|
1162
|
+
data_type: {
|
1163
|
+
type: ("RELATIONSHIP" | "STRING" | "LONG" | "BOOLEAN" | "INTEGER" | "DOUBLE" | "LIST" | "MAP"),
|
1164
|
+
nested_type: untyped?,
|
1165
|
+
allowed_values: Array[
|
1166
|
+
{
|
1167
|
+
boolean_value: bool?,
|
1168
|
+
double_value: ::Float?,
|
1169
|
+
integer_value: ::Integer?,
|
1170
|
+
long_value: ::Integer?,
|
1171
|
+
string_value: ::String?,
|
1172
|
+
list_value: untyped?,
|
1173
|
+
map_value: Hash[::String, untyped]?,
|
1174
|
+
relationship_value: {
|
1175
|
+
target_entity_id: ::String?,
|
1176
|
+
target_component_name: ::String?
|
1177
|
+
}?,
|
1178
|
+
expression: ::String?
|
1179
|
+
},
|
1180
|
+
]?,
|
1181
|
+
unit_of_measure: ::String?,
|
1182
|
+
relationship: {
|
1183
|
+
target_component_type_id: ::String?,
|
1184
|
+
relationship_type: ::String?
|
1185
|
+
}?
|
1186
|
+
}?,
|
1187
|
+
is_required_in_entity: bool?,
|
1188
|
+
is_external_id: bool?,
|
1189
|
+
is_stored_externally: bool?,
|
1190
|
+
is_time_series: bool?,
|
1191
|
+
default_value: {
|
1192
|
+
boolean_value: bool?,
|
1193
|
+
double_value: ::Float?,
|
1194
|
+
integer_value: ::Integer?,
|
1195
|
+
long_value: ::Integer?,
|
1196
|
+
string_value: ::String?,
|
1197
|
+
list_value: Array[
|
1198
|
+
untyped,
|
1199
|
+
]?,
|
1200
|
+
map_value: Hash[::String, untyped]?,
|
1201
|
+
relationship_value: {
|
1202
|
+
target_entity_id: ::String?,
|
1203
|
+
target_component_name: ::String?
|
1204
|
+
}?,
|
1205
|
+
expression: ::String?
|
1206
|
+
}?,
|
1207
|
+
configuration: Hash[::String, ::String]?,
|
1208
|
+
display_name: ::String?
|
1209
|
+
}?,
|
1210
|
+
value: {
|
1211
|
+
boolean_value: bool?,
|
1212
|
+
double_value: ::Float?,
|
1213
|
+
integer_value: ::Integer?,
|
1214
|
+
long_value: ::Integer?,
|
1215
|
+
string_value: ::String?,
|
1216
|
+
list_value: Array[
|
1217
|
+
untyped,
|
1218
|
+
]?,
|
1219
|
+
map_value: Hash[::String, untyped]?,
|
1220
|
+
relationship_value: {
|
1221
|
+
target_entity_id: ::String?,
|
1222
|
+
target_component_name: ::String?
|
1223
|
+
}?,
|
1224
|
+
expression: ::String?
|
1225
|
+
}?,
|
1226
|
+
update_type: ("UPDATE" | "DELETE" | "CREATE")?
|
1227
|
+
}]?,
|
1228
|
+
property_group_updates: Hash[::String, {
|
1229
|
+
group_type: ("TABULAR")?,
|
1230
|
+
property_names: Array[::String]?,
|
1231
|
+
update_type: ("UPDATE" | "DELETE" | "CREATE")?
|
1232
|
+
}]?
|
1233
|
+
}],
|
1234
|
+
?parent_entity_update: {
|
1235
|
+
update_type: ("UPDATE" | "DELETE"),
|
1236
|
+
parent_entity_id: ::String?
|
1237
|
+
}
|
1238
|
+
) -> _UpdateEntityResponseSuccess
|
1239
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateEntityResponseSuccess
|
1240
|
+
|
1241
|
+
interface _UpdatePricingPlanResponseSuccess
|
1242
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdatePricingPlanResponse]
|
1243
|
+
def current_pricing_plan: () -> Types::PricingPlan
|
1244
|
+
def pending_pricing_plan: () -> Types::PricingPlan
|
1245
|
+
end
|
1246
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#update_pricing_plan-instance_method
|
1247
|
+
def update_pricing_plan: (
|
1248
|
+
pricing_mode: ("BASIC" | "STANDARD" | "TIERED_BUNDLE"),
|
1249
|
+
?bundle_names: Array[::String]
|
1250
|
+
) -> _UpdatePricingPlanResponseSuccess
|
1251
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdatePricingPlanResponseSuccess
|
1252
|
+
|
1253
|
+
interface _UpdateSceneResponseSuccess
|
1254
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateSceneResponse]
|
1255
|
+
def update_date_time: () -> ::Time
|
1256
|
+
end
|
1257
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#update_scene-instance_method
|
1258
|
+
def update_scene: (
|
1259
|
+
workspace_id: ::String,
|
1260
|
+
scene_id: ::String,
|
1261
|
+
?content_location: ::String,
|
1262
|
+
?description: ::String,
|
1263
|
+
?capabilities: Array[::String],
|
1264
|
+
?scene_metadata: Hash[::String, ::String]
|
1265
|
+
) -> _UpdateSceneResponseSuccess
|
1266
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateSceneResponseSuccess
|
1267
|
+
|
1268
|
+
interface _UpdateWorkspaceResponseSuccess
|
1269
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateWorkspaceResponse]
|
1270
|
+
def update_date_time: () -> ::Time
|
1271
|
+
end
|
1272
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTTwinMaker/Client.html#update_workspace-instance_method
|
1273
|
+
def update_workspace: (
|
1274
|
+
workspace_id: ::String,
|
1275
|
+
?description: ::String,
|
1276
|
+
?role: ::String,
|
1277
|
+
?s3_location: ::String
|
1278
|
+
) -> _UpdateWorkspaceResponseSuccess
|
1279
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateWorkspaceResponseSuccess
|
1280
|
+
end
|
1281
|
+
end
|
1282
|
+
end
|
1283
|
+
|