aws-sdk-iottwinmaker 1.6.0 → 1.8.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.
@@ -23,11 +23,6 @@ module Aws::IoTTwinMaker
23
23
 
24
24
  # An error returned by the `BatchPutProperty` action.
25
25
  #
26
- # @!attribute [rw] entry
27
- # An object that contains information about errors returned by the
28
- # `BatchPutProperty` action.
29
- # @return [Types::PropertyValueEntry]
30
- #
31
26
  # @!attribute [rw] error_code
32
27
  # The error code.
33
28
  # @return [String]
@@ -36,10 +31,15 @@ module Aws::IoTTwinMaker
36
31
  # The error message.
37
32
  # @return [String]
38
33
  #
34
+ # @!attribute [rw] entry
35
+ # An object that contains information about errors returned by the
36
+ # `BatchPutProperty` action.
37
+ # @return [Types::PropertyValueEntry]
38
+ #
39
39
  class BatchPutPropertyError < Struct.new(
40
- :entry,
41
40
  :error_code,
42
- :error_message)
41
+ :error_message,
42
+ :entry)
43
43
  SENSITIVE = []
44
44
  include Aws::Structure
45
45
  end
@@ -58,65 +58,18 @@ module Aws::IoTTwinMaker
58
58
  include Aws::Structure
59
59
  end
60
60
 
61
- # @note When making an API call, you may pass BatchPutPropertyValuesRequest
62
- # data as a hash:
63
- #
64
- # {
65
- # entries: [ # required
66
- # {
67
- # entity_property_reference: { # required
68
- # component_name: "Name",
69
- # entity_id: "EntityId",
70
- # external_id_property: {
71
- # "String" => "String",
72
- # },
73
- # property_name: "Name", # required
74
- # },
75
- # property_values: [
76
- # {
77
- # time: "Time",
78
- # timestamp: Time.now,
79
- # value: { # required
80
- # boolean_value: false,
81
- # double_value: 1.0,
82
- # expression: "Expression",
83
- # integer_value: 1,
84
- # list_value: [
85
- # {
86
- # # recursive DataValue
87
- # },
88
- # ],
89
- # long_value: 1,
90
- # map_value: {
91
- # "String" => {
92
- # # recursive DataValue
93
- # },
94
- # },
95
- # relationship_value: {
96
- # target_component_name: "Name",
97
- # target_entity_id: "EntityId",
98
- # },
99
- # string_value: "String",
100
- # },
101
- # },
102
- # ],
103
- # },
104
- # ],
105
- # workspace_id: "Id", # required
106
- # }
61
+ # @!attribute [rw] workspace_id
62
+ # The ID of the workspace that contains the properties to set.
63
+ # @return [String]
107
64
  #
108
65
  # @!attribute [rw] entries
109
66
  # An object that maps strings to the property value entries to set.
110
67
  # Each string in the mapping must be unique to this object.
111
68
  # @return [Array<Types::PropertyValueEntry>]
112
69
  #
113
- # @!attribute [rw] workspace_id
114
- # The ID of the workspace that contains the properties to set.
115
- # @return [String]
116
- #
117
70
  class BatchPutPropertyValuesRequest < Struct.new(
118
- :entries,
119
- :workspace_id)
71
+ :workspace_id,
72
+ :entries)
120
73
  SENSITIVE = []
121
74
  include Aws::Structure
122
75
  end
@@ -131,126 +84,109 @@ module Aws::IoTTwinMaker
131
84
  include Aws::Structure
132
85
  end
133
86
 
134
- # An object that sets information about a component type create or
135
- # update request.
87
+ # Information about pricing bundle.
136
88
  #
137
- # @note When making an API call, you may pass ComponentRequest
138
- # data as a hash:
139
- #
140
- # {
141
- # component_type_id: "ComponentTypeId",
142
- # description: "Description",
143
- # properties: {
144
- # "Name" => {
145
- # definition: {
146
- # configuration: {
147
- # "Name" => "Value",
148
- # },
149
- # data_type: {
150
- # allowed_values: [
151
- # {
152
- # boolean_value: false,
153
- # double_value: 1.0,
154
- # expression: "Expression",
155
- # integer_value: 1,
156
- # list_value: {
157
- # # recursive DataValueList
158
- # },
159
- # long_value: 1,
160
- # map_value: {
161
- # "String" => {
162
- # # recursive DataValue
163
- # },
164
- # },
165
- # relationship_value: {
166
- # target_component_name: "Name",
167
- # target_entity_id: "EntityId",
168
- # },
169
- # string_value: "String",
170
- # },
171
- # ],
172
- # nested_type: {
173
- # # recursive DataType
174
- # },
175
- # relationship: {
176
- # relationship_type: "String",
177
- # target_component_type_id: "ComponentTypeId",
178
- # },
179
- # type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
180
- # unit_of_measure: "String",
181
- # },
182
- # default_value: {
183
- # boolean_value: false,
184
- # double_value: 1.0,
185
- # expression: "Expression",
186
- # integer_value: 1,
187
- # list_value: [
188
- # {
189
- # # recursive DataValue
190
- # },
191
- # ],
192
- # long_value: 1,
193
- # map_value: {
194
- # "String" => {
195
- # # recursive DataValue
196
- # },
197
- # },
198
- # relationship_value: {
199
- # target_component_name: "Name",
200
- # target_entity_id: "EntityId",
201
- # },
202
- # string_value: "String",
203
- # },
204
- # is_external_id: false,
205
- # is_required_in_entity: false,
206
- # is_stored_externally: false,
207
- # is_time_series: false,
208
- # },
209
- # update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
210
- # value: {
211
- # boolean_value: false,
212
- # double_value: 1.0,
213
- # expression: "Expression",
214
- # integer_value: 1,
215
- # list_value: [
216
- # {
217
- # # recursive DataValue
218
- # },
219
- # ],
220
- # long_value: 1,
221
- # map_value: {
222
- # "String" => {
223
- # # recursive DataValue
224
- # },
225
- # },
226
- # relationship_value: {
227
- # target_component_name: "Name",
228
- # target_entity_id: "EntityId",
229
- # },
230
- # string_value: "String",
231
- # },
232
- # },
233
- # },
234
- # }
89
+ # @!attribute [rw] bundle_names
90
+ # The bundle names.
91
+ # @return [Array<String>]
235
92
  #
236
- # @!attribute [rw] component_type_id
237
- # The ID of the component type.
93
+ # @!attribute [rw] pricing_tier
94
+ # The pricing tier.
95
+ # @return [String]
96
+ #
97
+ class BundleInformation < Struct.new(
98
+ :bundle_names,
99
+ :pricing_tier)
100
+ SENSITIVE = []
101
+ include Aws::Structure
102
+ end
103
+
104
+ # A description of the column in the query results.
105
+ #
106
+ # @!attribute [rw] name
107
+ # The name of the column description.
108
+ # @return [String]
109
+ #
110
+ # @!attribute [rw] type
111
+ # The type of the column description.
112
+ # @return [String]
113
+ #
114
+ class ColumnDescription < Struct.new(
115
+ :name,
116
+ :type)
117
+ SENSITIVE = []
118
+ include Aws::Structure
119
+ end
120
+
121
+ # @!attribute [rw] group_type
122
+ # The group type.
123
+ # @return [String]
124
+ #
125
+ # @!attribute [rw] property_names
126
+ # The property names.
127
+ # @return [Array<String>]
128
+ #
129
+ # @!attribute [rw] update_type
130
+ # The update type.
131
+ # @return [String]
132
+ #
133
+ class ComponentPropertyGroupRequest < Struct.new(
134
+ :group_type,
135
+ :property_names,
136
+ :update_type)
137
+ SENSITIVE = []
138
+ include Aws::Structure
139
+ end
140
+
141
+ # The component property group response.
142
+ #
143
+ # @!attribute [rw] group_type
144
+ # The group type.
238
145
  # @return [String]
239
146
  #
147
+ # @!attribute [rw] property_names
148
+ # The names of properties
149
+ # @return [Array<String>]
150
+ #
151
+ # @!attribute [rw] is_inherited
152
+ # A Boolean value that specifies whether the property group is
153
+ # inherited from a parent entity
154
+ # @return [Boolean]
155
+ #
156
+ class ComponentPropertyGroupResponse < Struct.new(
157
+ :group_type,
158
+ :property_names,
159
+ :is_inherited)
160
+ SENSITIVE = []
161
+ include Aws::Structure
162
+ end
163
+
164
+ # An object that sets information about a component type create or
165
+ # update request.
166
+ #
240
167
  # @!attribute [rw] description
241
168
  # The description of the component request.
242
169
  # @return [String]
243
170
  #
171
+ # @!attribute [rw] component_type_id
172
+ # The ID of the component type.
173
+ # @return [String]
174
+ #
244
175
  # @!attribute [rw] properties
245
176
  # An object that maps strings to the properties to set in the
246
177
  # component type. Each string in the mapping must be unique to this
247
178
  # object.
248
179
  # @return [Hash<String,Types::PropertyRequest>]
249
180
  #
181
+ # @!attribute [rw] property_groups
182
+ # The property groups.
183
+ # @return [Hash<String,Types::ComponentPropertyGroupRequest>]
184
+ #
250
185
  class ComponentRequest < Struct.new(
251
- :component_type_id,
252
186
  :description,
253
- :properties)
187
+ :component_type_id,
188
+ :properties,
189
+ :property_groups)
254
190
  SENSITIVE = []
255
191
  include Aws::Structure
256
192
  end
@@ -262,35 +198,46 @@ module Aws::IoTTwinMaker
262
198
  # The name of the component.
263
199
  # @return [String]
264
200
  #
201
+ # @!attribute [rw] description
202
+ # The description of the component type.
203
+ # @return [String]
204
+ #
265
205
  # @!attribute [rw] component_type_id
266
206
  # The ID of the component type.
267
207
  # @return [String]
268
208
  #
209
+ # @!attribute [rw] status
210
+ # The status of the component type.
211
+ # @return [Types::Status]
212
+ #
269
213
  # @!attribute [rw] defined_in
270
214
  # The name of the property definition set in the request.
271
215
  # @return [String]
272
216
  #
273
- # @!attribute [rw] description
274
- # The description of the component type.
275
- # @return [String]
276
- #
277
217
  # @!attribute [rw] properties
278
218
  # An object that maps strings to the properties to set in the
279
219
  # component type. Each string in the mapping must be unique to this
280
220
  # object.
281
221
  # @return [Hash<String,Types::PropertyResponse>]
282
222
  #
283
- # @!attribute [rw] status
284
- # The status of the component type.
285
- # @return [Types::Status]
223
+ # @!attribute [rw] property_groups
224
+ # The property groups.
225
+ # @return [Hash<String,Types::ComponentPropertyGroupResponse>]
226
+ #
227
+ # @!attribute [rw] sync_source
228
+ # The syncSource of the sync job, if this entity was created by a sync
229
+ # job.
230
+ # @return [String]
286
231
  #
287
232
  class ComponentResponse < Struct.new(
288
233
  :component_name,
234
+ :description,
289
235
  :component_type_id,
236
+ :status,
290
237
  :defined_in,
291
- :description,
292
238
  :properties,
293
- :status)
239
+ :property_groups,
240
+ :sync_source)
294
241
  SENSITIVE = []
295
242
  include Aws::Structure
296
243
  end
@@ -309,6 +256,10 @@ module Aws::IoTTwinMaker
309
256
  # The date and time when the component type was created.
310
257
  # @return [Time]
311
258
  #
259
+ # @!attribute [rw] update_date_time
260
+ # The date and time when the component type was last updated.
261
+ # @return [Time]
262
+ #
312
263
  # @!attribute [rw] description
313
264
  # The description of the component type.
314
265
  # @return [String]
@@ -317,146 +268,52 @@ module Aws::IoTTwinMaker
317
268
  # The current status of the component type.
318
269
  # @return [Types::Status]
319
270
  #
320
- # @!attribute [rw] update_date_time
321
- # The date and time when the component type was last updated.
322
- # @return [Time]
271
+ # @!attribute [rw] component_type_name
272
+ # The component type name.
273
+ # @return [String]
323
274
  #
324
275
  class ComponentTypeSummary < Struct.new(
325
276
  :arn,
326
277
  :component_type_id,
327
278
  :creation_date_time,
279
+ :update_date_time,
328
280
  :description,
329
281
  :status,
330
- :update_date_time)
282
+ :component_type_name)
331
283
  SENSITIVE = []
332
284
  include Aws::Structure
333
285
  end
334
286
 
335
287
  # The component update request.
336
288
  #
337
- # @note When making an API call, you may pass ComponentUpdateRequest
338
- # data as a hash:
339
- #
340
- # {
341
- # component_type_id: "ComponentTypeId",
342
- # description: "Description",
343
- # property_updates: {
344
- # "Name" => {
345
- # definition: {
346
- # configuration: {
347
- # "Name" => "Value",
348
- # },
349
- # data_type: {
350
- # allowed_values: [
351
- # {
352
- # boolean_value: false,
353
- # double_value: 1.0,
354
- # expression: "Expression",
355
- # integer_value: 1,
356
- # list_value: {
357
- # # recursive DataValueList
358
- # },
359
- # long_value: 1,
360
- # map_value: {
361
- # "String" => {
362
- # # recursive DataValue
363
- # },
364
- # },
365
- # relationship_value: {
366
- # target_component_name: "Name",
367
- # target_entity_id: "EntityId",
368
- # },
369
- # string_value: "String",
370
- # },
371
- # ],
372
- # nested_type: {
373
- # # recursive DataType
374
- # },
375
- # relationship: {
376
- # relationship_type: "String",
377
- # target_component_type_id: "ComponentTypeId",
378
- # },
379
- # type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
380
- # unit_of_measure: "String",
381
- # },
382
- # default_value: {
383
- # boolean_value: false,
384
- # double_value: 1.0,
385
- # expression: "Expression",
386
- # integer_value: 1,
387
- # list_value: [
388
- # {
389
- # # recursive DataValue
390
- # },
391
- # ],
392
- # long_value: 1,
393
- # map_value: {
394
- # "String" => {
395
- # # recursive DataValue
396
- # },
397
- # },
398
- # relationship_value: {
399
- # target_component_name: "Name",
400
- # target_entity_id: "EntityId",
401
- # },
402
- # string_value: "String",
403
- # },
404
- # is_external_id: false,
405
- # is_required_in_entity: false,
406
- # is_stored_externally: false,
407
- # is_time_series: false,
408
- # },
409
- # update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
410
- # value: {
411
- # boolean_value: false,
412
- # double_value: 1.0,
413
- # expression: "Expression",
414
- # integer_value: 1,
415
- # list_value: [
416
- # {
417
- # # recursive DataValue
418
- # },
419
- # ],
420
- # long_value: 1,
421
- # map_value: {
422
- # "String" => {
423
- # # recursive DataValue
424
- # },
425
- # },
426
- # relationship_value: {
427
- # target_component_name: "Name",
428
- # target_entity_id: "EntityId",
429
- # },
430
- # string_value: "String",
431
- # },
432
- # },
433
- # },
434
- # update_type: "CREATE", # accepts CREATE, UPDATE, DELETE
435
- # }
436
- #
437
- # @!attribute [rw] component_type_id
438
- # The ID of the component type.
289
+ # @!attribute [rw] update_type
290
+ # The update type of the component update request.
439
291
  # @return [String]
440
292
  #
441
293
  # @!attribute [rw] description
442
294
  # The description of the component type.
443
295
  # @return [String]
444
296
  #
297
+ # @!attribute [rw] component_type_id
298
+ # The ID of the component type.
299
+ # @return [String]
300
+ #
445
301
  # @!attribute [rw] property_updates
446
302
  # An object that maps strings to the properties to set in the
447
303
  # component type update. Each string in the mapping must be unique to
448
304
  # this object.
449
305
  # @return [Hash<String,Types::PropertyRequest>]
450
306
  #
451
- # @!attribute [rw] update_type
452
- # The update type of the component update request.
453
- # @return [String]
307
+ # @!attribute [rw] property_group_updates
308
+ # The property group updates.
309
+ # @return [Hash<String,Types::ComponentPropertyGroupRequest>]
454
310
  #
455
311
  class ComponentUpdateRequest < Struct.new(
456
- :component_type_id,
312
+ :update_type,
457
313
  :description,
314
+ :component_type_id,
458
315
  :property_updates,
459
- :update_type)
316
+ :property_group_updates)
460
317
  SENSITIVE = []
461
318
  include Aws::Structure
462
319
  end
@@ -494,97 +351,14 @@ module Aws::IoTTwinMaker
494
351
  include Aws::Structure
495
352
  end
496
353
 
497
- # @note When making an API call, you may pass CreateComponentTypeRequest
498
- # data as a hash:
499
- #
500
- # {
501
- # component_type_id: "ComponentTypeId", # required
502
- # description: "Description",
503
- # extends_from: ["ComponentTypeId"],
504
- # functions: {
505
- # "Name" => {
506
- # implemented_by: {
507
- # is_native: false,
508
- # lambda: {
509
- # arn: "LambdaArn", # required
510
- # },
511
- # },
512
- # required_properties: ["Name"],
513
- # scope: "ENTITY", # accepts ENTITY, WORKSPACE
514
- # },
515
- # },
516
- # is_singleton: false,
517
- # property_definitions: {
518
- # "Name" => {
519
- # configuration: {
520
- # "Name" => "Value",
521
- # },
522
- # data_type: {
523
- # allowed_values: [
524
- # {
525
- # boolean_value: false,
526
- # double_value: 1.0,
527
- # expression: "Expression",
528
- # integer_value: 1,
529
- # list_value: {
530
- # # recursive DataValueList
531
- # },
532
- # long_value: 1,
533
- # map_value: {
534
- # "String" => {
535
- # # recursive DataValue
536
- # },
537
- # },
538
- # relationship_value: {
539
- # target_component_name: "Name",
540
- # target_entity_id: "EntityId",
541
- # },
542
- # string_value: "String",
543
- # },
544
- # ],
545
- # nested_type: {
546
- # # recursive DataType
547
- # },
548
- # relationship: {
549
- # relationship_type: "String",
550
- # target_component_type_id: "ComponentTypeId",
551
- # },
552
- # type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
553
- # unit_of_measure: "String",
554
- # },
555
- # default_value: {
556
- # boolean_value: false,
557
- # double_value: 1.0,
558
- # expression: "Expression",
559
- # integer_value: 1,
560
- # list_value: [
561
- # {
562
- # # recursive DataValue
563
- # },
564
- # ],
565
- # long_value: 1,
566
- # map_value: {
567
- # "String" => {
568
- # # recursive DataValue
569
- # },
570
- # },
571
- # relationship_value: {
572
- # target_component_name: "Name",
573
- # target_entity_id: "EntityId",
574
- # },
575
- # string_value: "String",
576
- # },
577
- # is_external_id: false,
578
- # is_required_in_entity: false,
579
- # is_stored_externally: false,
580
- # is_time_series: false,
581
- # },
582
- # },
583
- # tags: {
584
- # "TagKey" => "TagValue",
585
- # },
586
- # workspace_id: "Id", # required
587
- # }
354
+ # @!attribute [rw] workspace_id
355
+ # The ID of the workspace that contains the component type.
356
+ # @return [String]
357
+ #
358
+ # @!attribute [rw] is_singleton
359
+ # A Boolean value that specifies whether an entity can have more than
360
+ # one component of this type.
361
+ # @return [Boolean]
588
362
  #
589
363
  # @!attribute [rw] component_type_id
590
364
  # The ID of the component type.
@@ -594,6 +368,12 @@ module Aws::IoTTwinMaker
594
368
  # The description of the component type.
595
369
  # @return [String]
596
370
  #
371
+ # @!attribute [rw] property_definitions
372
+ # An object that maps strings to the property definitions in the
373
+ # component type. Each string in the mapping must be unique to this
374
+ # object.
375
+ # @return [Hash<String,Types::PropertyDefinitionRequest>]
376
+ #
597
377
  # @!attribute [rw] extends_from
598
378
  # Specifies the parent component type to extend.
599
379
  # @return [Array<String>]
@@ -603,34 +383,28 @@ module Aws::IoTTwinMaker
603
383
  # Each string in the mapping must be unique to this object.
604
384
  # @return [Hash<String,Types::FunctionRequest>]
605
385
  #
606
- # @!attribute [rw] is_singleton
607
- # A Boolean value that specifies whether an entity can have more than
608
- # one component of this type.
609
- # @return [Boolean]
610
- #
611
- # @!attribute [rw] property_definitions
612
- # An object that maps strings to the property definitions in the
613
- # component type. Each string in the mapping must be unique to this
614
- # object.
615
- # @return [Hash<String,Types::PropertyDefinitionRequest>]
616
- #
617
386
  # @!attribute [rw] tags
618
387
  # Metadata that you can use to manage the component type.
619
388
  # @return [Hash<String,String>]
620
389
  #
621
- # @!attribute [rw] workspace_id
622
- # The ID of the workspace that contains the component type.
390
+ # @!attribute [rw] property_groups
391
+ # @return [Hash<String,Types::PropertyGroupRequest>]
392
+ #
393
+ # @!attribute [rw] component_type_name
394
+ # A friendly name for the component type.
623
395
  # @return [String]
624
396
  #
625
397
  class CreateComponentTypeRequest < Struct.new(
398
+ :workspace_id,
399
+ :is_singleton,
626
400
  :component_type_id,
627
401
  :description,
402
+ :property_definitions,
628
403
  :extends_from,
629
404
  :functions,
630
- :is_singleton,
631
- :property_definitions,
632
405
  :tags,
633
- :workspace_id)
406
+ :property_groups,
407
+ :component_type_name)
634
408
  SENSITIVE = []
635
409
  include Aws::Structure
636
410
  end
@@ -655,124 +429,8 @@ module Aws::IoTTwinMaker
655
429
  include Aws::Structure
656
430
  end
657
431
 
658
- # @note When making an API call, you may pass CreateEntityRequest
659
- # data as a hash:
660
- #
661
- # {
662
- # components: {
663
- # "Name" => {
664
- # component_type_id: "ComponentTypeId",
665
- # description: "Description",
666
- # properties: {
667
- # "Name" => {
668
- # definition: {
669
- # configuration: {
670
- # "Name" => "Value",
671
- # },
672
- # data_type: {
673
- # allowed_values: [
674
- # {
675
- # boolean_value: false,
676
- # double_value: 1.0,
677
- # expression: "Expression",
678
- # integer_value: 1,
679
- # list_value: {
680
- # # recursive DataValueList
681
- # },
682
- # long_value: 1,
683
- # map_value: {
684
- # "String" => {
685
- # # recursive DataValue
686
- # },
687
- # },
688
- # relationship_value: {
689
- # target_component_name: "Name",
690
- # target_entity_id: "EntityId",
691
- # },
692
- # string_value: "String",
693
- # },
694
- # ],
695
- # nested_type: {
696
- # # recursive DataType
697
- # },
698
- # relationship: {
699
- # relationship_type: "String",
700
- # target_component_type_id: "ComponentTypeId",
701
- # },
702
- # type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
703
- # unit_of_measure: "String",
704
- # },
705
- # default_value: {
706
- # boolean_value: false,
707
- # double_value: 1.0,
708
- # expression: "Expression",
709
- # integer_value: 1,
710
- # list_value: [
711
- # {
712
- # # recursive DataValue
713
- # },
714
- # ],
715
- # long_value: 1,
716
- # map_value: {
717
- # "String" => {
718
- # # recursive DataValue
719
- # },
720
- # },
721
- # relationship_value: {
722
- # target_component_name: "Name",
723
- # target_entity_id: "EntityId",
724
- # },
725
- # string_value: "String",
726
- # },
727
- # is_external_id: false,
728
- # is_required_in_entity: false,
729
- # is_stored_externally: false,
730
- # is_time_series: false,
731
- # },
732
- # update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
733
- # value: {
734
- # boolean_value: false,
735
- # double_value: 1.0,
736
- # expression: "Expression",
737
- # integer_value: 1,
738
- # list_value: [
739
- # {
740
- # # recursive DataValue
741
- # },
742
- # ],
743
- # long_value: 1,
744
- # map_value: {
745
- # "String" => {
746
- # # recursive DataValue
747
- # },
748
- # },
749
- # relationship_value: {
750
- # target_component_name: "Name",
751
- # target_entity_id: "EntityId",
752
- # },
753
- # string_value: "String",
754
- # },
755
- # },
756
- # },
757
- # },
758
- # },
759
- # description: "Description",
760
- # entity_id: "EntityId",
761
- # entity_name: "EntityName", # required
762
- # parent_entity_id: "ParentEntityId",
763
- # tags: {
764
- # "TagKey" => "TagValue",
765
- # },
766
- # workspace_id: "Id", # required
767
- # }
768
- #
769
- # @!attribute [rw] components
770
- # An object that maps strings to the components in the entity. Each
771
- # string in the mapping must be unique to this object.
772
- # @return [Hash<String,Types::ComponentRequest>]
773
- #
774
- # @!attribute [rw] description
775
- # The description of the entity.
432
+ # @!attribute [rw] workspace_id
433
+ # The ID of the workspace that contains the entity.
776
434
  # @return [String]
777
435
  #
778
436
  # @!attribute [rw] entity_id
@@ -783,6 +441,15 @@ module Aws::IoTTwinMaker
783
441
  # The name of the entity.
784
442
  # @return [String]
785
443
  #
444
+ # @!attribute [rw] description
445
+ # The description of the entity.
446
+ # @return [String]
447
+ #
448
+ # @!attribute [rw] components
449
+ # An object that maps strings to the components in the entity. Each
450
+ # string in the mapping must be unique to this object.
451
+ # @return [Hash<String,Types::ComponentRequest>]
452
+ #
786
453
  # @!attribute [rw] parent_entity_id
787
454
  # The ID of the entity's parent entity.
788
455
  # @return [String]
@@ -791,22 +458,22 @@ module Aws::IoTTwinMaker
791
458
  # Metadata that you can use to manage the entity.
792
459
  # @return [Hash<String,String>]
793
460
  #
794
- # @!attribute [rw] workspace_id
795
- # The ID of the workspace that contains the entity.
796
- # @return [String]
797
- #
798
461
  class CreateEntityRequest < Struct.new(
799
- :components,
800
- :description,
462
+ :workspace_id,
801
463
  :entity_id,
802
464
  :entity_name,
465
+ :description,
466
+ :components,
803
467
  :parent_entity_id,
804
- :tags,
805
- :workspace_id)
468
+ :tags)
806
469
  SENSITIVE = []
807
470
  include Aws::Structure
808
471
  end
809
472
 
473
+ # @!attribute [rw] entity_id
474
+ # The ID of the entity.
475
+ # @return [String]
476
+ #
810
477
  # @!attribute [rw] arn
811
478
  # The ARN of the entity.
812
479
  # @return [String]
@@ -815,40 +482,26 @@ module Aws::IoTTwinMaker
815
482
  # The date and time when the entity was created.
816
483
  # @return [Time]
817
484
  #
818
- # @!attribute [rw] entity_id
819
- # The ID of the entity.
820
- # @return [String]
821
- #
822
485
  # @!attribute [rw] state
823
486
  # The current state of the entity.
824
487
  # @return [String]
825
488
  #
826
489
  class CreateEntityResponse < Struct.new(
490
+ :entity_id,
827
491
  :arn,
828
492
  :creation_date_time,
829
- :entity_id,
830
493
  :state)
831
494
  SENSITIVE = []
832
495
  include Aws::Structure
833
496
  end
834
497
 
835
- # @note When making an API call, you may pass CreateSceneRequest
836
- # data as a hash:
837
- #
838
- # {
839
- # capabilities: ["SceneCapability"],
840
- # content_location: "S3Url", # required
841
- # description: "Description",
842
- # scene_id: "Id", # required
843
- # tags: {
844
- # "TagKey" => "TagValue",
845
- # },
846
- # workspace_id: "Id", # required
847
- # }
498
+ # @!attribute [rw] workspace_id
499
+ # The ID of the workspace that contains the scene.
500
+ # @return [String]
848
501
  #
849
- # @!attribute [rw] capabilities
850
- # A list of capabilities that the scene uses to render itself.
851
- # @return [Array<String>]
502
+ # @!attribute [rw] scene_id
503
+ # The ID of the scene.
504
+ # @return [String]
852
505
  #
853
506
  # @!attribute [rw] content_location
854
507
  # The relative path that specifies the location of the content
@@ -859,25 +512,21 @@ module Aws::IoTTwinMaker
859
512
  # The description for this scene.
860
513
  # @return [String]
861
514
  #
862
- # @!attribute [rw] scene_id
863
- # The ID of the scene.
864
- # @return [String]
515
+ # @!attribute [rw] capabilities
516
+ # A list of capabilities that the scene uses to render itself.
517
+ # @return [Array<String>]
865
518
  #
866
519
  # @!attribute [rw] tags
867
520
  # Metadata that you can use to manage the scene.
868
521
  # @return [Hash<String,String>]
869
522
  #
870
- # @!attribute [rw] workspace_id
871
- # The ID of the workspace that contains the scene.
872
- # @return [String]
873
- #
874
523
  class CreateSceneRequest < Struct.new(
875
- :capabilities,
524
+ :workspace_id,
525
+ :scene_id,
876
526
  :content_location,
877
527
  :description,
878
- :scene_id,
879
- :tags,
880
- :workspace_id)
528
+ :capabilities,
529
+ :tags)
881
530
  SENSITIVE = []
882
531
  include Aws::Structure
883
532
  end
@@ -897,254 +546,155 @@ module Aws::IoTTwinMaker
897
546
  include Aws::Structure
898
547
  end
899
548
 
900
- # @note When making an API call, you may pass CreateWorkspaceRequest
901
- # data as a hash:
549
+ # @!attribute [rw] workspace_id
550
+ # The workspace Id.
551
+ # @return [String]
902
552
  #
903
- # {
904
- # description: "Description",
905
- # role: "RoleArn", # required
906
- # s3_location: "S3Location", # required
907
- # tags: {
908
- # "TagKey" => "TagValue",
909
- # },
910
- # workspace_id: "Id", # required
911
- # }
553
+ # @!attribute [rw] sync_source
554
+ # The sync source.
912
555
  #
913
- # @!attribute [rw] description
914
- # The description of the workspace.
915
- # @return [String]
556
+ # <note markdown="1"> Currently the only supported syncSoucre is `SITEWISE `.
916
557
  #
917
- # @!attribute [rw] role
918
- # The ARN of the execution role associated with the workspace.
558
+ # </note>
919
559
  # @return [String]
920
560
  #
921
- # @!attribute [rw] s3_location
922
- # The ARN of the S3 bucket where resources associated with the
923
- # workspace are stored.
561
+ # @!attribute [rw] sync_role
562
+ # The SyncJob IAM role. This IAM role is used by the sync job to read
563
+ # from the syncSource, and create, update or delete the corresponding
564
+ # resources.
924
565
  # @return [String]
925
566
  #
926
567
  # @!attribute [rw] tags
927
- # Metadata that you can use to manage the workspace
568
+ # The SyncJob tags.
928
569
  # @return [Hash<String,String>]
929
570
  #
930
- # @!attribute [rw] workspace_id
931
- # The ID of the workspace.
932
- # @return [String]
933
- #
934
- class CreateWorkspaceRequest < Struct.new(
935
- :description,
936
- :role,
937
- :s3_location,
938
- :tags,
939
- :workspace_id)
571
+ class CreateSyncJobRequest < Struct.new(
572
+ :workspace_id,
573
+ :sync_source,
574
+ :sync_role,
575
+ :tags)
940
576
  SENSITIVE = []
941
577
  include Aws::Structure
942
578
  end
943
579
 
944
580
  # @!attribute [rw] arn
945
- # The ARN of the workspace.
581
+ # The SyncJob ARN.
946
582
  # @return [String]
947
583
  #
948
584
  # @!attribute [rw] creation_date_time
949
- # The date and time when the workspace was created.
585
+ # The date and time for the SyncJob creation.
950
586
  # @return [Time]
951
587
  #
952
- class CreateWorkspaceResponse < Struct.new(
588
+ # @!attribute [rw] state
589
+ # The SyncJob response state.
590
+ # @return [String]
591
+ #
592
+ class CreateSyncJobResponse < Struct.new(
953
593
  :arn,
954
- :creation_date_time)
594
+ :creation_date_time,
595
+ :state)
955
596
  SENSITIVE = []
956
597
  include Aws::Structure
957
598
  end
958
599
 
959
- # The data connector.
960
- #
961
- # @note When making an API call, you may pass DataConnector
962
- # data as a hash:
963
- #
964
- # {
965
- # is_native: false,
966
- # lambda: {
967
- # arn: "LambdaArn", # required
968
- # },
969
- # }
600
+ # @!attribute [rw] workspace_id
601
+ # The ID of the workspace.
602
+ # @return [String]
970
603
  #
971
- # @!attribute [rw] is_native
972
- # A Boolean value that specifies whether the data connector is native
973
- # to IoT TwinMaker.
974
- # @return [Boolean]
604
+ # @!attribute [rw] description
605
+ # The description of the workspace.
606
+ # @return [String]
607
+ #
608
+ # @!attribute [rw] s3_location
609
+ # The ARN of the S3 bucket where resources associated with the
610
+ # workspace are stored.
611
+ # @return [String]
612
+ #
613
+ # @!attribute [rw] role
614
+ # The ARN of the execution role associated with the workspace.
615
+ # @return [String]
616
+ #
617
+ # @!attribute [rw] tags
618
+ # Metadata that you can use to manage the workspace
619
+ # @return [Hash<String,String>]
620
+ #
621
+ class CreateWorkspaceRequest < Struct.new(
622
+ :workspace_id,
623
+ :description,
624
+ :s3_location,
625
+ :role,
626
+ :tags)
627
+ SENSITIVE = []
628
+ include Aws::Structure
629
+ end
630
+
631
+ # @!attribute [rw] arn
632
+ # The ARN of the workspace.
633
+ # @return [String]
634
+ #
635
+ # @!attribute [rw] creation_date_time
636
+ # The date and time when the workspace was created.
637
+ # @return [Time]
638
+ #
639
+ class CreateWorkspaceResponse < Struct.new(
640
+ :arn,
641
+ :creation_date_time)
642
+ SENSITIVE = []
643
+ include Aws::Structure
644
+ end
645
+
646
+ # The data connector.
975
647
  #
976
648
  # @!attribute [rw] lambda
977
649
  # The Lambda function associated with this data connector.
978
650
  # @return [Types::LambdaFunction]
979
651
  #
652
+ # @!attribute [rw] is_native
653
+ # A Boolean value that specifies whether the data connector is native
654
+ # to IoT TwinMaker.
655
+ # @return [Boolean]
656
+ #
980
657
  class DataConnector < Struct.new(
981
- :is_native,
982
- :lambda)
658
+ :lambda,
659
+ :is_native)
983
660
  SENSITIVE = []
984
661
  include Aws::Structure
985
662
  end
986
663
 
987
664
  # An object that specifies the data type of a property.
988
665
  #
989
- # @note When making an API call, you may pass DataType
990
- # data as a hash:
991
- #
992
- # {
993
- # allowed_values: [
994
- # {
995
- # boolean_value: false,
996
- # double_value: 1.0,
997
- # expression: "Expression",
998
- # integer_value: 1,
999
- # list_value: {
1000
- # # recursive DataValueList
1001
- # },
1002
- # long_value: 1,
1003
- # map_value: {
1004
- # "String" => {
1005
- # # recursive DataValue
1006
- # },
1007
- # },
1008
- # relationship_value: {
1009
- # target_component_name: "Name",
1010
- # target_entity_id: "EntityId",
1011
- # },
1012
- # string_value: "String",
1013
- # },
1014
- # ],
1015
- # nested_type: {
1016
- # allowed_values: [
1017
- # {
1018
- # boolean_value: false,
1019
- # double_value: 1.0,
1020
- # expression: "Expression",
1021
- # integer_value: 1,
1022
- # list_value: {
1023
- # # recursive DataValueList
1024
- # },
1025
- # long_value: 1,
1026
- # map_value: {
1027
- # "String" => {
1028
- # # recursive DataValue
1029
- # },
1030
- # },
1031
- # relationship_value: {
1032
- # target_component_name: "Name",
1033
- # target_entity_id: "EntityId",
1034
- # },
1035
- # string_value: "String",
1036
- # },
1037
- # ],
1038
- # nested_type: {
1039
- # # recursive DataType
1040
- # },
1041
- # relationship: {
1042
- # relationship_type: "String",
1043
- # target_component_type_id: "ComponentTypeId",
1044
- # },
1045
- # type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
1046
- # unit_of_measure: "String",
1047
- # },
1048
- # relationship: {
1049
- # relationship_type: "String",
1050
- # target_component_type_id: "ComponentTypeId",
1051
- # },
1052
- # type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
1053
- # unit_of_measure: "String",
1054
- # }
1055
- #
1056
- # @!attribute [rw] allowed_values
1057
- # The allowed values for this data type.
1058
- # @return [Array<Types::DataValue>]
666
+ # @!attribute [rw] type
667
+ # The underlying type of the data type.
668
+ # @return [String]
1059
669
  #
1060
670
  # @!attribute [rw] nested_type
1061
671
  # The nested type in the data type.
1062
672
  # @return [Types::DataType]
1063
673
  #
1064
- # @!attribute [rw] relationship
1065
- # A relationship that associates a component with another component.
1066
- # @return [Types::Relationship]
1067
- #
1068
- # @!attribute [rw] type
1069
- # The underlying type of the data type.
1070
- # @return [String]
674
+ # @!attribute [rw] allowed_values
675
+ # The allowed values for this data type.
676
+ # @return [Array<Types::DataValue>]
1071
677
  #
1072
678
  # @!attribute [rw] unit_of_measure
1073
679
  # The unit of measure used in this data type.
1074
680
  # @return [String]
1075
681
  #
682
+ # @!attribute [rw] relationship
683
+ # A relationship that associates a component with another component.
684
+ # @return [Types::Relationship]
685
+ #
1076
686
  class DataType < Struct.new(
1077
- :allowed_values,
1078
- :nested_type,
1079
- :relationship,
1080
687
  :type,
1081
- :unit_of_measure)
688
+ :nested_type,
689
+ :allowed_values,
690
+ :unit_of_measure,
691
+ :relationship)
1082
692
  SENSITIVE = []
1083
693
  include Aws::Structure
1084
694
  end
1085
695
 
1086
696
  # An object that specifies a value for a property.
1087
697
  #
1088
- # @note When making an API call, you may pass DataValue
1089
- # data as a hash:
1090
- #
1091
- # {
1092
- # boolean_value: false,
1093
- # double_value: 1.0,
1094
- # expression: "Expression",
1095
- # integer_value: 1,
1096
- # list_value: [
1097
- # {
1098
- # boolean_value: false,
1099
- # double_value: 1.0,
1100
- # expression: "Expression",
1101
- # integer_value: 1,
1102
- # list_value: {
1103
- # # recursive DataValueList
1104
- # },
1105
- # long_value: 1,
1106
- # map_value: {
1107
- # "String" => {
1108
- # # recursive DataValue
1109
- # },
1110
- # },
1111
- # relationship_value: {
1112
- # target_component_name: "Name",
1113
- # target_entity_id: "EntityId",
1114
- # },
1115
- # string_value: "String",
1116
- # },
1117
- # ],
1118
- # long_value: 1,
1119
- # map_value: {
1120
- # "String" => {
1121
- # boolean_value: false,
1122
- # double_value: 1.0,
1123
- # expression: "Expression",
1124
- # integer_value: 1,
1125
- # list_value: [
1126
- # {
1127
- # # recursive DataValue
1128
- # },
1129
- # ],
1130
- # long_value: 1,
1131
- # map_value: {
1132
- # # recursive DataValueMap
1133
- # },
1134
- # relationship_value: {
1135
- # target_component_name: "Name",
1136
- # target_entity_id: "EntityId",
1137
- # },
1138
- # string_value: "String",
1139
- # },
1140
- # },
1141
- # relationship_value: {
1142
- # target_component_name: "Name",
1143
- # target_entity_id: "EntityId",
1144
- # },
1145
- # string_value: "String",
1146
- # }
1147
- #
1148
698
  # @!attribute [rw] boolean_value
1149
699
  # A Boolean value.
1150
700
  # @return [Boolean]
@@ -1153,22 +703,22 @@ module Aws::IoTTwinMaker
1153
703
  # A double value.
1154
704
  # @return [Float]
1155
705
  #
1156
- # @!attribute [rw] expression
1157
- # An expression that produces the value.
1158
- # @return [String]
1159
- #
1160
706
  # @!attribute [rw] integer_value
1161
707
  # An integer value.
1162
708
  # @return [Integer]
1163
709
  #
1164
- # @!attribute [rw] list_value
1165
- # A list of multiple values.
1166
- # @return [Array<Types::DataValue>]
1167
- #
1168
710
  # @!attribute [rw] long_value
1169
711
  # A long value.
1170
712
  # @return [Integer]
1171
713
  #
714
+ # @!attribute [rw] string_value
715
+ # A string value.
716
+ # @return [String]
717
+ #
718
+ # @!attribute [rw] list_value
719
+ # A list of multiple values.
720
+ # @return [Array<Types::DataValue>]
721
+ #
1172
722
  # @!attribute [rw] map_value
1173
723
  # An object that maps strings to multiple `DataValue` objects.
1174
724
  # @return [Hash<String,Types::DataValue>]
@@ -1177,43 +727,35 @@ module Aws::IoTTwinMaker
1177
727
  # A value that relates a component to another component.
1178
728
  # @return [Types::RelationshipValue]
1179
729
  #
1180
- # @!attribute [rw] string_value
1181
- # A string value.
730
+ # @!attribute [rw] expression
731
+ # An expression that produces the value.
1182
732
  # @return [String]
1183
733
  #
1184
734
  class DataValue < Struct.new(
1185
735
  :boolean_value,
1186
736
  :double_value,
1187
- :expression,
1188
737
  :integer_value,
1189
- :list_value,
1190
738
  :long_value,
739
+ :string_value,
740
+ :list_value,
1191
741
  :map_value,
1192
742
  :relationship_value,
1193
- :string_value)
743
+ :expression)
1194
744
  SENSITIVE = []
1195
745
  include Aws::Structure
1196
746
  end
1197
747
 
1198
- # @note When making an API call, you may pass DeleteComponentTypeRequest
1199
- # data as a hash:
1200
- #
1201
- # {
1202
- # component_type_id: "ComponentTypeId", # required
1203
- # workspace_id: "Id", # required
1204
- # }
748
+ # @!attribute [rw] workspace_id
749
+ # The ID of the workspace that contains the component type.
750
+ # @return [String]
1205
751
  #
1206
752
  # @!attribute [rw] component_type_id
1207
753
  # The ID of the component type to delete.
1208
754
  # @return [String]
1209
755
  #
1210
- # @!attribute [rw] workspace_id
1211
- # The ID of the workspace that contains the component type.
1212
- # @return [String]
1213
- #
1214
756
  class DeleteComponentTypeRequest < Struct.new(
1215
- :component_type_id,
1216
- :workspace_id)
757
+ :workspace_id,
758
+ :component_type_id)
1217
759
  SENSITIVE = []
1218
760
  include Aws::Structure
1219
761
  end
@@ -1228,14 +770,9 @@ module Aws::IoTTwinMaker
1228
770
  include Aws::Structure
1229
771
  end
1230
772
 
1231
- # @note When making an API call, you may pass DeleteEntityRequest
1232
- # data as a hash:
1233
- #
1234
- # {
1235
- # entity_id: "EntityId", # required
1236
- # is_recursive: false,
1237
- # workspace_id: "Id", # required
1238
- # }
773
+ # @!attribute [rw] workspace_id
774
+ # The ID of the workspace that contains the entity to delete.
775
+ # @return [String]
1239
776
  #
1240
777
  # @!attribute [rw] entity_id
1241
778
  # The ID of the entity to delete.
@@ -1246,14 +783,10 @@ module Aws::IoTTwinMaker
1246
783
  # entities.
1247
784
  # @return [Boolean]
1248
785
  #
1249
- # @!attribute [rw] workspace_id
1250
- # The ID of the workspace that contains the entity to delete.
1251
- # @return [String]
1252
- #
1253
786
  class DeleteEntityRequest < Struct.new(
787
+ :workspace_id,
1254
788
  :entity_id,
1255
- :is_recursive,
1256
- :workspace_id)
789
+ :is_recursive)
1257
790
  SENSITIVE = []
1258
791
  include Aws::Structure
1259
792
  end
@@ -1268,38 +801,52 @@ module Aws::IoTTwinMaker
1268
801
  include Aws::Structure
1269
802
  end
1270
803
 
1271
- # @note When making an API call, you may pass DeleteSceneRequest
1272
- # data as a hash:
1273
- #
1274
- # {
1275
- # scene_id: "Id", # required
1276
- # workspace_id: "Id", # required
1277
- # }
804
+ # @!attribute [rw] workspace_id
805
+ # The ID of the workspace.
806
+ # @return [String]
1278
807
  #
1279
808
  # @!attribute [rw] scene_id
1280
809
  # The ID of the scene to delete.
1281
810
  # @return [String]
1282
811
  #
1283
- # @!attribute [rw] workspace_id
1284
- # The ID of the workspace.
1285
- # @return [String]
1286
- #
1287
812
  class DeleteSceneRequest < Struct.new(
1288
- :scene_id,
1289
- :workspace_id)
813
+ :workspace_id,
814
+ :scene_id)
1290
815
  SENSITIVE = []
1291
816
  include Aws::Structure
1292
817
  end
1293
818
 
1294
819
  class DeleteSceneResponse < Aws::EmptyStructure; end
1295
820
 
1296
- # @note When making an API call, you may pass DeleteWorkspaceRequest
1297
- # data as a hash:
821
+ # @!attribute [rw] workspace_id
822
+ # The workspace Id.
823
+ # @return [String]
824
+ #
825
+ # @!attribute [rw] sync_source
826
+ # The sync source.
827
+ #
828
+ # <note markdown="1"> Currently the only supported syncSoucre is `SITEWISE `.
1298
829
  #
1299
- # {
1300
- # workspace_id: "Id", # required
1301
- # }
830
+ # </note>
831
+ # @return [String]
832
+ #
833
+ class DeleteSyncJobRequest < Struct.new(
834
+ :workspace_id,
835
+ :sync_source)
836
+ SENSITIVE = []
837
+ include Aws::Structure
838
+ end
839
+
840
+ # @!attribute [rw] state
841
+ # The SyncJob response state.
842
+ # @return [String]
1302
843
  #
844
+ class DeleteSyncJobResponse < Struct.new(
845
+ :state)
846
+ SENSITIVE = []
847
+ include Aws::Structure
848
+ end
849
+
1303
850
  # @!attribute [rw] workspace_id
1304
851
  # The ID of the workspace to delete.
1305
852
  # @return [String]
@@ -1314,39 +861,27 @@ module Aws::IoTTwinMaker
1314
861
 
1315
862
  # An object that uniquely identifies an entity property.
1316
863
  #
1317
- # @note When making an API call, you may pass EntityPropertyReference
1318
- # data as a hash:
1319
- #
1320
- # {
1321
- # component_name: "Name",
1322
- # entity_id: "EntityId",
1323
- # external_id_property: {
1324
- # "String" => "String",
1325
- # },
1326
- # property_name: "Name", # required
1327
- # }
1328
- #
1329
864
  # @!attribute [rw] component_name
1330
865
  # The name of the component.
1331
866
  # @return [String]
1332
867
  #
1333
- # @!attribute [rw] entity_id
1334
- # The ID of the entity.
1335
- # @return [String]
1336
- #
1337
868
  # @!attribute [rw] external_id_property
1338
869
  # A mapping of external IDs to property names. External IDs uniquely
1339
870
  # identify properties from external data stores.
1340
871
  # @return [Hash<String,String>]
1341
872
  #
873
+ # @!attribute [rw] entity_id
874
+ # The ID of the entity.
875
+ # @return [String]
876
+ #
1342
877
  # @!attribute [rw] property_name
1343
878
  # The name of the property.
1344
879
  # @return [String]
1345
880
  #
1346
881
  class EntityPropertyReference < Struct.new(
1347
882
  :component_name,
1348
- :entity_id,
1349
883
  :external_id_property,
884
+ :entity_id,
1350
885
  :property_name)
1351
886
  SENSITIVE = []
1352
887
  include Aws::Structure
@@ -1354,18 +889,6 @@ module Aws::IoTTwinMaker
1354
889
 
1355
890
  # An object that contains information about an entity.
1356
891
  #
1357
- # @!attribute [rw] arn
1358
- # The ARN of the entity.
1359
- # @return [String]
1360
- #
1361
- # @!attribute [rw] creation_date_time
1362
- # The date and time when the entity was created.
1363
- # @return [Time]
1364
- #
1365
- # @!attribute [rw] description
1366
- # The description of the entity.
1367
- # @return [String]
1368
- #
1369
892
  # @!attribute [rw] entity_id
1370
893
  # The ID of the entity.
1371
894
  # @return [String]
@@ -1374,10 +897,9 @@ module Aws::IoTTwinMaker
1374
897
  # The name of the entity.
1375
898
  # @return [String]
1376
899
  #
1377
- # @!attribute [rw] has_child_entities
1378
- # A Boolean value that specifies whether the entity has child entities
1379
- # or not.
1380
- # @return [Boolean]
900
+ # @!attribute [rw] arn
901
+ # The ARN of the entity.
902
+ # @return [String]
1381
903
  #
1382
904
  # @!attribute [rw] parent_entity_id
1383
905
  # The ID of the parent entity.
@@ -1387,19 +909,32 @@ module Aws::IoTTwinMaker
1387
909
  # The current status of the entity.
1388
910
  # @return [Types::Status]
1389
911
  #
912
+ # @!attribute [rw] description
913
+ # The description of the entity.
914
+ # @return [String]
915
+ #
916
+ # @!attribute [rw] has_child_entities
917
+ # A Boolean value that specifies whether the entity has child entities
918
+ # or not.
919
+ # @return [Boolean]
920
+ #
921
+ # @!attribute [rw] creation_date_time
922
+ # The date and time when the entity was created.
923
+ # @return [Time]
924
+ #
1390
925
  # @!attribute [rw] update_date_time
1391
926
  # The last date and time when the entity was updated.
1392
927
  # @return [Time]
1393
928
  #
1394
929
  class EntitySummary < Struct.new(
1395
- :arn,
1396
- :creation_date_time,
1397
- :description,
1398
930
  :entity_id,
1399
931
  :entity_name,
1400
- :has_child_entities,
932
+ :arn,
1401
933
  :parent_entity_id,
1402
934
  :status,
935
+ :description,
936
+ :has_child_entities,
937
+ :creation_date_time,
1403
938
  :update_date_time)
1404
939
  SENSITIVE = []
1405
940
  include Aws::Structure
@@ -1422,25 +957,55 @@ module Aws::IoTTwinMaker
1422
957
  include Aws::Structure
1423
958
  end
1424
959
 
1425
- # The function request body.
960
+ # @!attribute [rw] workspace_id
961
+ # The ID of the workspace.
962
+ # @return [String]
1426
963
  #
1427
- # @note When making an API call, you may pass FunctionRequest
1428
- # data as a hash:
964
+ # @!attribute [rw] query_statement
965
+ # The query statement.
966
+ # @return [String]
1429
967
  #
1430
- # {
1431
- # implemented_by: {
1432
- # is_native: false,
1433
- # lambda: {
1434
- # arn: "LambdaArn", # required
1435
- # },
1436
- # },
1437
- # required_properties: ["Name"],
1438
- # scope: "ENTITY", # accepts ENTITY, WORKSPACE
1439
- # }
968
+ # @!attribute [rw] max_results
969
+ # The maximum number of results to return at one time. The default is
970
+ # 25.
1440
971
  #
1441
- # @!attribute [rw] implemented_by
1442
- # The data connector.
1443
- # @return [Types::DataConnector]
972
+ # Valid Range: Minimum value of 1. Maximum value of 250.
973
+ # @return [Integer]
974
+ #
975
+ # @!attribute [rw] next_token
976
+ # The string that specifies the next page of results.
977
+ # @return [String]
978
+ #
979
+ class ExecuteQueryRequest < Struct.new(
980
+ :workspace_id,
981
+ :query_statement,
982
+ :max_results,
983
+ :next_token)
984
+ SENSITIVE = []
985
+ include Aws::Structure
986
+ end
987
+
988
+ # @!attribute [rw] column_descriptions
989
+ # A list of ColumnDescription objects.
990
+ # @return [Array<Types::ColumnDescription>]
991
+ #
992
+ # @!attribute [rw] rows
993
+ # Represents a single row in the query results.
994
+ # @return [Array<Types::Row>]
995
+ #
996
+ # @!attribute [rw] next_token
997
+ # The string that specifies the next page of results.
998
+ # @return [String]
999
+ #
1000
+ class ExecuteQueryResponse < Struct.new(
1001
+ :column_descriptions,
1002
+ :rows,
1003
+ :next_token)
1004
+ SENSITIVE = []
1005
+ include Aws::Structure
1006
+ end
1007
+
1008
+ # The function request body.
1444
1009
  #
1445
1010
  # @!attribute [rw] required_properties
1446
1011
  # The required properties of the function.
@@ -1450,24 +1015,20 @@ module Aws::IoTTwinMaker
1450
1015
  # The scope of the function.
1451
1016
  # @return [String]
1452
1017
  #
1018
+ # @!attribute [rw] implemented_by
1019
+ # The data connector.
1020
+ # @return [Types::DataConnector]
1021
+ #
1453
1022
  class FunctionRequest < Struct.new(
1454
- :implemented_by,
1455
1023
  :required_properties,
1456
- :scope)
1024
+ :scope,
1025
+ :implemented_by)
1457
1026
  SENSITIVE = []
1458
1027
  include Aws::Structure
1459
1028
  end
1460
1029
 
1461
1030
  # The function response.
1462
1031
  #
1463
- # @!attribute [rw] implemented_by
1464
- # The data connector.
1465
- # @return [Types::DataConnector]
1466
- #
1467
- # @!attribute [rw] is_inherited
1468
- # Indicates whether this function is inherited.
1469
- # @return [Boolean]
1470
- #
1471
1032
  # @!attribute [rw] required_properties
1472
1033
  # The required properties of the function.
1473
1034
  # @return [Array<String>]
@@ -1476,54 +1037,61 @@ module Aws::IoTTwinMaker
1476
1037
  # The scope of the function.
1477
1038
  # @return [String]
1478
1039
  #
1040
+ # @!attribute [rw] implemented_by
1041
+ # The data connector.
1042
+ # @return [Types::DataConnector]
1043
+ #
1044
+ # @!attribute [rw] is_inherited
1045
+ # Indicates whether this function is inherited.
1046
+ # @return [Boolean]
1047
+ #
1479
1048
  class FunctionResponse < Struct.new(
1480
- :implemented_by,
1481
- :is_inherited,
1482
1049
  :required_properties,
1483
- :scope)
1050
+ :scope,
1051
+ :implemented_by,
1052
+ :is_inherited)
1484
1053
  SENSITIVE = []
1485
1054
  include Aws::Structure
1486
1055
  end
1487
1056
 
1488
- # @note When making an API call, you may pass GetComponentTypeRequest
1489
- # data as a hash:
1490
- #
1491
- # {
1492
- # component_type_id: "ComponentTypeId", # required
1493
- # workspace_id: "Id", # required
1494
- # }
1057
+ # @!attribute [rw] workspace_id
1058
+ # The ID of the workspace that contains the component type.
1059
+ # @return [String]
1495
1060
  #
1496
1061
  # @!attribute [rw] component_type_id
1497
1062
  # The ID of the component type.
1498
1063
  # @return [String]
1499
1064
  #
1500
- # @!attribute [rw] workspace_id
1501
- # The ID of the workspace that contains the component type.
1502
- # @return [String]
1503
- #
1504
1065
  class GetComponentTypeRequest < Struct.new(
1505
- :component_type_id,
1506
- :workspace_id)
1066
+ :workspace_id,
1067
+ :component_type_id)
1507
1068
  SENSITIVE = []
1508
1069
  include Aws::Structure
1509
1070
  end
1510
1071
 
1511
- # @!attribute [rw] arn
1512
- # The ARN of the component type.
1072
+ # @!attribute [rw] workspace_id
1073
+ # The ID of the workspace that contains the component type.
1513
1074
  # @return [String]
1514
1075
  #
1076
+ # @!attribute [rw] is_singleton
1077
+ # A Boolean value that specifies whether an entity can have more than
1078
+ # one component of this type.
1079
+ # @return [Boolean]
1080
+ #
1515
1081
  # @!attribute [rw] component_type_id
1516
1082
  # The ID of the component type.
1517
1083
  # @return [String]
1518
1084
  #
1519
- # @!attribute [rw] creation_date_time
1520
- # The date and time when the component type was created.
1521
- # @return [Time]
1522
- #
1523
1085
  # @!attribute [rw] description
1524
1086
  # The description of the component type.
1525
1087
  # @return [String]
1526
1088
  #
1089
+ # @!attribute [rw] property_definitions
1090
+ # An object that maps strings to the property definitions in the
1091
+ # component type. Each string in the mapping must be unique to this
1092
+ # object.
1093
+ # @return [Hash<String,Types::PropertyDefinitionResponse>]
1094
+ #
1527
1095
  # @!attribute [rw] extends_from
1528
1096
  # The name of the parent component type that this component type
1529
1097
  # extends.
@@ -1534,6 +1102,18 @@ module Aws::IoTTwinMaker
1534
1102
  # Each string in the mapping must be unique to this object.
1535
1103
  # @return [Hash<String,Types::FunctionResponse>]
1536
1104
  #
1105
+ # @!attribute [rw] creation_date_time
1106
+ # The date and time when the component type was created.
1107
+ # @return [Time]
1108
+ #
1109
+ # @!attribute [rw] update_date_time
1110
+ # The date and time when the component was last updated.
1111
+ # @return [Time]
1112
+ #
1113
+ # @!attribute [rw] arn
1114
+ # The ARN of the component type.
1115
+ # @return [String]
1116
+ #
1537
1117
  # @!attribute [rw] is_abstract
1538
1118
  # A Boolean value that specifies whether the component type is
1539
1119
  # abstract.
@@ -1544,93 +1124,93 @@ module Aws::IoTTwinMaker
1544
1124
  # schema initializer and that the schema initializer has run.
1545
1125
  # @return [Boolean]
1546
1126
  #
1547
- # @!attribute [rw] is_singleton
1548
- # A Boolean value that specifies whether an entity can have more than
1549
- # one component of this type.
1550
- # @return [Boolean]
1551
- #
1552
- # @!attribute [rw] property_definitions
1553
- # An object that maps strings to the property definitions in the
1554
- # component type. Each string in the mapping must be unique to this
1555
- # object.
1556
- # @return [Hash<String,Types::PropertyDefinitionResponse>]
1557
- #
1558
1127
  # @!attribute [rw] status
1559
1128
  # The current status of the component type.
1560
1129
  # @return [Types::Status]
1561
1130
  #
1562
- # @!attribute [rw] update_date_time
1563
- # The date and time when the component was last updated.
1564
- # @return [Time]
1131
+ # @!attribute [rw] property_groups
1132
+ # The maximum number of results to return at one time. The default is
1133
+ # 25.
1565
1134
  #
1566
- # @!attribute [rw] workspace_id
1567
- # The ID of the workspace that contains the component type.
1135
+ # Valid Range: Minimum value of 1. Maximum value of 250.
1136
+ # @return [Hash<String,Types::PropertyGroupResponse>]
1137
+ #
1138
+ # @!attribute [rw] sync_source
1139
+ # The syncSource of the sync job, if this entity was created by a sync
1140
+ # job.
1141
+ # @return [String]
1142
+ #
1143
+ # @!attribute [rw] component_type_name
1144
+ # The component type name.
1568
1145
  # @return [String]
1569
1146
  #
1570
1147
  class GetComponentTypeResponse < Struct.new(
1571
- :arn,
1148
+ :workspace_id,
1149
+ :is_singleton,
1572
1150
  :component_type_id,
1573
- :creation_date_time,
1574
1151
  :description,
1152
+ :property_definitions,
1575
1153
  :extends_from,
1576
1154
  :functions,
1155
+ :creation_date_time,
1156
+ :update_date_time,
1157
+ :arn,
1577
1158
  :is_abstract,
1578
1159
  :is_schema_initialized,
1579
- :is_singleton,
1580
- :property_definitions,
1581
1160
  :status,
1582
- :update_date_time,
1583
- :workspace_id)
1161
+ :property_groups,
1162
+ :sync_source,
1163
+ :component_type_name)
1584
1164
  SENSITIVE = []
1585
1165
  include Aws::Structure
1586
1166
  end
1587
1167
 
1588
- # @note When making an API call, you may pass GetEntityRequest
1589
- # data as a hash:
1590
- #
1591
- # {
1592
- # entity_id: "EntityId", # required
1593
- # workspace_id: "Id", # required
1594
- # }
1168
+ # @!attribute [rw] workspace_id
1169
+ # The ID of the workspace.
1170
+ # @return [String]
1595
1171
  #
1596
1172
  # @!attribute [rw] entity_id
1597
1173
  # The ID of the entity.
1598
1174
  # @return [String]
1599
1175
  #
1600
- # @!attribute [rw] workspace_id
1601
- # The ID of the workspace.
1602
- # @return [String]
1603
- #
1604
1176
  class GetEntityRequest < Struct.new(
1605
- :entity_id,
1606
- :workspace_id)
1177
+ :workspace_id,
1178
+ :entity_id)
1607
1179
  SENSITIVE = []
1608
1180
  include Aws::Structure
1609
1181
  end
1610
1182
 
1183
+ # @!attribute [rw] entity_id
1184
+ # The ID of the entity.
1185
+ # @return [String]
1186
+ #
1187
+ # @!attribute [rw] entity_name
1188
+ # The name of the entity.
1189
+ # @return [String]
1190
+ #
1611
1191
  # @!attribute [rw] arn
1612
1192
  # The ARN of the entity.
1613
1193
  # @return [String]
1614
1194
  #
1615
- # @!attribute [rw] components
1616
- # An object that maps strings to the components in the entity. Each
1617
- # string in the mapping must be unique to this object.
1618
- # @return [Hash<String,Types::ComponentResponse>]
1195
+ # @!attribute [rw] status
1196
+ # The current status of the entity.
1197
+ # @return [Types::Status]
1619
1198
  #
1620
- # @!attribute [rw] creation_date_time
1621
- # The date and time when the entity was created.
1622
- # @return [Time]
1199
+ # @!attribute [rw] workspace_id
1200
+ # The ID of the workspace.
1201
+ # @return [String]
1623
1202
  #
1624
1203
  # @!attribute [rw] description
1625
1204
  # The description of the entity.
1626
1205
  # @return [String]
1627
1206
  #
1628
- # @!attribute [rw] entity_id
1629
- # The ID of the entity.
1630
- # @return [String]
1207
+ # @!attribute [rw] components
1208
+ # An object that maps strings to the components in the entity. Each
1209
+ # string in the mapping must be unique to this object.
1210
+ # @return [Hash<String,Types::ComponentResponse>]
1631
1211
  #
1632
- # @!attribute [rw] entity_name
1633
- # The name of the entity.
1212
+ # @!attribute [rw] parent_entity_id
1213
+ # The ID of the parent entity for this entity.
1634
1214
  # @return [String]
1635
1215
  #
1636
1216
  # @!attribute [rw] has_child_entities
@@ -1638,87 +1218,62 @@ module Aws::IoTTwinMaker
1638
1218
  # child entities.
1639
1219
  # @return [Boolean]
1640
1220
  #
1641
- # @!attribute [rw] parent_entity_id
1642
- # The ID of the parent entity for this entity.
1643
- # @return [String]
1644
- #
1645
- # @!attribute [rw] status
1646
- # The current status of the entity.
1647
- # @return [Types::Status]
1221
+ # @!attribute [rw] creation_date_time
1222
+ # The date and time when the entity was created.
1223
+ # @return [Time]
1648
1224
  #
1649
1225
  # @!attribute [rw] update_date_time
1650
1226
  # The date and time when the entity was last updated.
1651
1227
  # @return [Time]
1652
1228
  #
1653
- # @!attribute [rw] workspace_id
1654
- # The ID of the workspace.
1229
+ # @!attribute [rw] sync_source
1230
+ # The syncSource of the sync job, if this entity was created by a sync
1231
+ # job.
1655
1232
  # @return [String]
1656
1233
  #
1657
1234
  class GetEntityResponse < Struct.new(
1658
- :arn,
1659
- :components,
1660
- :creation_date_time,
1661
- :description,
1662
1235
  :entity_id,
1663
1236
  :entity_name,
1664
- :has_child_entities,
1665
- :parent_entity_id,
1237
+ :arn,
1666
1238
  :status,
1239
+ :workspace_id,
1240
+ :description,
1241
+ :components,
1242
+ :parent_entity_id,
1243
+ :has_child_entities,
1244
+ :creation_date_time,
1667
1245
  :update_date_time,
1668
- :workspace_id)
1246
+ :sync_source)
1247
+ SENSITIVE = []
1248
+ include Aws::Structure
1249
+ end
1250
+
1251
+ # @api private
1252
+ #
1253
+ class GetPricingPlanRequest < Aws::EmptyStructure; end
1254
+
1255
+ # @!attribute [rw] current_pricing_plan
1256
+ # The chosen pricing plan for the current billing cycle.
1257
+ # @return [Types::PricingPlan]
1258
+ #
1259
+ # @!attribute [rw] pending_pricing_plan
1260
+ # The pending pricing plan.
1261
+ # @return [Types::PricingPlan]
1262
+ #
1263
+ class GetPricingPlanResponse < Struct.new(
1264
+ :current_pricing_plan,
1265
+ :pending_pricing_plan)
1669
1266
  SENSITIVE = []
1670
1267
  include Aws::Structure
1671
1268
  end
1672
1269
 
1673
- # @note When making an API call, you may pass GetPropertyValueHistoryRequest
1674
- # data as a hash:
1675
- #
1676
- # {
1677
- # component_name: "Name",
1678
- # component_type_id: "ComponentTypeId",
1679
- # end_date_time: Time.now,
1680
- # end_time: "Time",
1681
- # entity_id: "EntityId",
1682
- # interpolation: {
1683
- # interpolation_type: "LINEAR", # accepts LINEAR
1684
- # interval_in_seconds: 1,
1685
- # },
1686
- # max_results: 1,
1687
- # next_token: "NextToken",
1688
- # order_by_time: "ASCENDING", # accepts ASCENDING, DESCENDING
1689
- # property_filters: [
1690
- # {
1691
- # operator: "String",
1692
- # property_name: "String",
1693
- # value: {
1694
- # boolean_value: false,
1695
- # double_value: 1.0,
1696
- # expression: "Expression",
1697
- # integer_value: 1,
1698
- # list_value: [
1699
- # {
1700
- # # recursive DataValue
1701
- # },
1702
- # ],
1703
- # long_value: 1,
1704
- # map_value: {
1705
- # "String" => {
1706
- # # recursive DataValue
1707
- # },
1708
- # },
1709
- # relationship_value: {
1710
- # target_component_name: "Name",
1711
- # target_entity_id: "EntityId",
1712
- # },
1713
- # string_value: "String",
1714
- # },
1715
- # },
1716
- # ],
1717
- # selected_properties: ["String"], # required
1718
- # start_date_time: Time.now,
1719
- # start_time: "Time",
1720
- # workspace_id: "Id", # required
1721
- # }
1270
+ # @!attribute [rw] workspace_id
1271
+ # The ID of the workspace.
1272
+ # @return [String]
1273
+ #
1274
+ # @!attribute [rw] entity_id
1275
+ # The ID of the entity.
1276
+ # @return [String]
1722
1277
  #
1723
1278
  # @!attribute [rw] component_name
1724
1279
  # The name of the component.
@@ -1728,54 +1283,42 @@ module Aws::IoTTwinMaker
1728
1283
  # The ID of the component type.
1729
1284
  # @return [String]
1730
1285
  #
1731
- # @!attribute [rw] end_date_time
1732
- # The date and time of the latest property value to return.
1733
- # @return [Time]
1734
- #
1735
- # @!attribute [rw] end_time
1736
- # The ISO8601 DateTime of the latest property value to return.
1737
- #
1738
- # For more information about the ISO8601 DateTime format, see the data
1739
- # type [PropertyValue][1].
1740
- #
1286
+ # @!attribute [rw] selected_properties
1287
+ # A list of properties whose value histories the request retrieves.
1288
+ # @return [Array<String>]
1741
1289
  #
1290
+ # @!attribute [rw] property_filters
1291
+ # A list of objects that filter the property value history request.
1292
+ # @return [Array<Types::PropertyFilter>]
1742
1293
  #
1743
- # [1]: https://docs.aws.amazon.com/roci/latest/roci-api/API_PropertyValue.html
1744
- # @return [String]
1294
+ # @!attribute [rw] start_date_time
1295
+ # The date and time of the earliest property value to return.
1296
+ # @return [Time]
1745
1297
  #
1746
- # @!attribute [rw] entity_id
1747
- # The ID of the entity.
1748
- # @return [String]
1298
+ # @!attribute [rw] end_date_time
1299
+ # The date and time of the latest property value to return.
1300
+ # @return [Time]
1749
1301
  #
1750
1302
  # @!attribute [rw] interpolation
1751
1303
  # An object that specifies the interpolation type and the interval
1752
1304
  # over which to interpolate data.
1753
1305
  # @return [Types::InterpolationParameters]
1754
1306
  #
1755
- # @!attribute [rw] max_results
1756
- # The maximum number of results to return.
1757
- # @return [Integer]
1758
- #
1759
1307
  # @!attribute [rw] next_token
1760
1308
  # The string that specifies the next page of results.
1761
1309
  # @return [String]
1762
1310
  #
1311
+ # @!attribute [rw] max_results
1312
+ # The maximum number of results to return at one time. The default is
1313
+ # 25.
1314
+ #
1315
+ # Valid Range: Minimum value of 1. Maximum value of 250.
1316
+ # @return [Integer]
1317
+ #
1763
1318
  # @!attribute [rw] order_by_time
1764
1319
  # The time direction to use in the result order.
1765
1320
  # @return [String]
1766
1321
  #
1767
- # @!attribute [rw] property_filters
1768
- # A list of objects that filter the property value history request.
1769
- # @return [Array<Types::PropertyFilter>]
1770
- #
1771
- # @!attribute [rw] selected_properties
1772
- # A list of properties whose value histories the request retrieves.
1773
- # @return [Array<String>]
1774
- #
1775
- # @!attribute [rw] start_date_time
1776
- # The date and time of the earliest property value to return.
1777
- # @return [Time]
1778
- #
1779
1322
  # @!attribute [rw] start_time
1780
1323
  # The ISO8601 DateTime of the earliest property value to return.
1781
1324
  #
@@ -1784,60 +1327,56 @@ module Aws::IoTTwinMaker
1784
1327
  #
1785
1328
  #
1786
1329
  #
1787
- # [1]: https://docs.aws.amazon.com/roci/latest/roci-api/API_PropertyValue.html
1330
+ # [1]: https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html
1788
1331
  # @return [String]
1789
1332
  #
1790
- # @!attribute [rw] workspace_id
1791
- # The ID of the workspace.
1333
+ # @!attribute [rw] end_time
1334
+ # The ISO8601 DateTime of the latest property value to return.
1335
+ #
1336
+ # For more information about the ISO8601 DateTime format, see the data
1337
+ # type [PropertyValue][1].
1338
+ #
1339
+ #
1340
+ #
1341
+ # [1]: https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html
1792
1342
  # @return [String]
1793
1343
  #
1794
1344
  class GetPropertyValueHistoryRequest < Struct.new(
1345
+ :workspace_id,
1346
+ :entity_id,
1795
1347
  :component_name,
1796
1348
  :component_type_id,
1349
+ :selected_properties,
1350
+ :property_filters,
1351
+ :start_date_time,
1797
1352
  :end_date_time,
1798
- :end_time,
1799
- :entity_id,
1800
1353
  :interpolation,
1801
- :max_results,
1802
1354
  :next_token,
1355
+ :max_results,
1803
1356
  :order_by_time,
1804
- :property_filters,
1805
- :selected_properties,
1806
- :start_date_time,
1807
1357
  :start_time,
1808
- :workspace_id)
1358
+ :end_time)
1809
1359
  SENSITIVE = []
1810
1360
  include Aws::Structure
1811
1361
  end
1812
1362
 
1813
- # @!attribute [rw] next_token
1814
- # The string that specifies the next page of results.
1815
- # @return [String]
1816
- #
1817
1363
  # @!attribute [rw] property_values
1818
1364
  # An object that maps strings to the property definitions in the
1819
1365
  # component type. Each string in the mapping must be unique to this
1820
1366
  # object.
1821
1367
  # @return [Array<Types::PropertyValueHistory>]
1822
1368
  #
1369
+ # @!attribute [rw] next_token
1370
+ # The string that specifies the next page of results.
1371
+ # @return [String]
1372
+ #
1823
1373
  class GetPropertyValueHistoryResponse < Struct.new(
1824
- :next_token,
1825
- :property_values)
1374
+ :property_values,
1375
+ :next_token)
1826
1376
  SENSITIVE = []
1827
1377
  include Aws::Structure
1828
1378
  end
1829
1379
 
1830
- # @note When making an API call, you may pass GetPropertyValueRequest
1831
- # data as a hash:
1832
- #
1833
- # {
1834
- # component_name: "Name",
1835
- # component_type_id: "ComponentTypeId",
1836
- # entity_id: "EntityId",
1837
- # selected_properties: ["String"], # required
1838
- # workspace_id: "Id", # required
1839
- # }
1840
- #
1841
1380
  # @!attribute [rw] component_name
1842
1381
  # The name of the component whose property values the operation
1843
1382
  # returns.
@@ -1860,12 +1399,35 @@ module Aws::IoTTwinMaker
1860
1399
  # The ID of the workspace whose values the operation returns.
1861
1400
  # @return [String]
1862
1401
  #
1402
+ # @!attribute [rw] max_results
1403
+ # The maximum number of results to return at one time. The default is
1404
+ # 25.
1405
+ #
1406
+ # Valid Range: Minimum value of 1. Maximum value of 250.
1407
+ # @return [Integer]
1408
+ #
1409
+ # @!attribute [rw] next_token
1410
+ # The string that specifies the next page of results.
1411
+ # @return [String]
1412
+ #
1413
+ # @!attribute [rw] property_group_name
1414
+ # The property group name.
1415
+ # @return [String]
1416
+ #
1417
+ # @!attribute [rw] tabular_conditions
1418
+ # The tabular conditions.
1419
+ # @return [Types::TabularConditions]
1420
+ #
1863
1421
  class GetPropertyValueRequest < Struct.new(
1864
1422
  :component_name,
1865
1423
  :component_type_id,
1866
1424
  :entity_id,
1867
1425
  :selected_properties,
1868
- :workspace_id)
1426
+ :workspace_id,
1427
+ :max_results,
1428
+ :next_token,
1429
+ :property_group_name,
1430
+ :tabular_conditions)
1869
1431
  SENSITIVE = []
1870
1432
  include Aws::Structure
1871
1433
  end
@@ -1876,88 +1438,146 @@ module Aws::IoTTwinMaker
1876
1438
  # this object.
1877
1439
  # @return [Hash<String,Types::PropertyLatestValue>]
1878
1440
  #
1441
+ # @!attribute [rw] next_token
1442
+ # The string that specifies the next page of results.
1443
+ # @return [String]
1444
+ #
1445
+ # @!attribute [rw] tabular_property_values
1446
+ # A table of property values.
1447
+ # @return [Array<Array<Hash<String,Types::DataValue>>>]
1448
+ #
1879
1449
  class GetPropertyValueResponse < Struct.new(
1880
- :property_values)
1450
+ :property_values,
1451
+ :next_token,
1452
+ :tabular_property_values)
1881
1453
  SENSITIVE = []
1882
1454
  include Aws::Structure
1883
1455
  end
1884
1456
 
1885
- # @note When making an API call, you may pass GetSceneRequest
1886
- # data as a hash:
1887
- #
1888
- # {
1889
- # scene_id: "Id", # required
1890
- # workspace_id: "Id", # required
1891
- # }
1457
+ # @!attribute [rw] workspace_id
1458
+ # The ID of the workspace that contains the scene.
1459
+ # @return [String]
1892
1460
  #
1893
1461
  # @!attribute [rw] scene_id
1894
1462
  # The ID of the scene.
1895
1463
  # @return [String]
1896
1464
  #
1897
- # @!attribute [rw] workspace_id
1898
- # The ID of the workspace that contains the scene.
1899
- # @return [String]
1900
- #
1901
1465
  class GetSceneRequest < Struct.new(
1902
- :scene_id,
1903
- :workspace_id)
1466
+ :workspace_id,
1467
+ :scene_id)
1904
1468
  SENSITIVE = []
1905
1469
  include Aws::Structure
1906
1470
  end
1907
1471
 
1908
- # @!attribute [rw] arn
1909
- # The ARN of the scene.
1472
+ # @!attribute [rw] workspace_id
1473
+ # The ID of the workspace that contains the scene.
1910
1474
  # @return [String]
1911
1475
  #
1912
- # @!attribute [rw] capabilities
1913
- # A list of capabilities that the scene uses to render.
1914
- # @return [Array<String>]
1476
+ # @!attribute [rw] scene_id
1477
+ # The ID of the scene.
1478
+ # @return [String]
1915
1479
  #
1916
1480
  # @!attribute [rw] content_location
1917
1481
  # The relative path that specifies the location of the content
1918
1482
  # definition file.
1919
1483
  # @return [String]
1920
1484
  #
1485
+ # @!attribute [rw] arn
1486
+ # The ARN of the scene.
1487
+ # @return [String]
1488
+ #
1921
1489
  # @!attribute [rw] creation_date_time
1922
1490
  # The date and time when the scene was created.
1923
1491
  # @return [Time]
1924
1492
  #
1925
- # @!attribute [rw] description
1926
- # The description of the scene.
1927
- # @return [String]
1928
- #
1929
- # @!attribute [rw] scene_id
1930
- # The ID of the scene.
1931
- # @return [String]
1932
- #
1933
1493
  # @!attribute [rw] update_date_time
1934
1494
  # The date and time when the scene was last updated.
1935
1495
  # @return [Time]
1936
1496
  #
1937
- # @!attribute [rw] workspace_id
1938
- # The ID of the workspace that contains the scene.
1497
+ # @!attribute [rw] description
1498
+ # The description of the scene.
1939
1499
  # @return [String]
1940
1500
  #
1501
+ # @!attribute [rw] capabilities
1502
+ # A list of capabilities that the scene uses to render.
1503
+ # @return [Array<String>]
1504
+ #
1941
1505
  class GetSceneResponse < Struct.new(
1942
- :arn,
1943
- :capabilities,
1506
+ :workspace_id,
1507
+ :scene_id,
1944
1508
  :content_location,
1509
+ :arn,
1945
1510
  :creation_date_time,
1946
- :description,
1947
- :scene_id,
1948
1511
  :update_date_time,
1512
+ :description,
1513
+ :capabilities)
1514
+ SENSITIVE = []
1515
+ include Aws::Structure
1516
+ end
1517
+
1518
+ # @!attribute [rw] sync_source
1519
+ # The sync soucre.
1520
+ #
1521
+ # <note markdown="1"> Currently the only supported syncSoucre is `SITEWISE `.
1522
+ #
1523
+ # </note>
1524
+ # @return [String]
1525
+ #
1526
+ # @!attribute [rw] workspace_id
1527
+ # The workspace Id.
1528
+ # @return [String]
1529
+ #
1530
+ class GetSyncJobRequest < Struct.new(
1531
+ :sync_source,
1949
1532
  :workspace_id)
1950
1533
  SENSITIVE = []
1951
1534
  include Aws::Structure
1952
1535
  end
1953
1536
 
1954
- # @note When making an API call, you may pass GetWorkspaceRequest
1955
- # data as a hash:
1537
+ # @!attribute [rw] arn
1538
+ # The sync job ARN.
1539
+ # @return [String]
1540
+ #
1541
+ # @!attribute [rw] workspace_id
1542
+ # The ID of the workspace that contains the sync job.
1543
+ # @return [String]
1544
+ #
1545
+ # @!attribute [rw] sync_source
1546
+ # The sync soucre.
1547
+ #
1548
+ # <note markdown="1"> Currently the only supported syncSoucre is `SITEWISE `.
1549
+ #
1550
+ # </note>
1551
+ # @return [String]
1552
+ #
1553
+ # @!attribute [rw] sync_role
1554
+ # The sync IAM role.
1555
+ # @return [String]
1556
+ #
1557
+ # @!attribute [rw] status
1558
+ # The SyncJob response status.
1559
+ # @return [Types::SyncJobStatus]
1560
+ #
1561
+ # @!attribute [rw] creation_date_time
1562
+ # The creation date and time.
1563
+ # @return [Time]
1956
1564
  #
1957
- # {
1958
- # workspace_id: "IdOrArn", # required
1959
- # }
1565
+ # @!attribute [rw] update_date_time
1566
+ # The update date and time.
1567
+ # @return [Time]
1960
1568
  #
1569
+ class GetSyncJobResponse < Struct.new(
1570
+ :arn,
1571
+ :workspace_id,
1572
+ :sync_source,
1573
+ :sync_role,
1574
+ :status,
1575
+ :creation_date_time,
1576
+ :update_date_time)
1577
+ SENSITIVE = []
1578
+ include Aws::Structure
1579
+ end
1580
+
1961
1581
  # @!attribute [rw] workspace_id
1962
1582
  # The ID of the workspace.
1963
1583
  # @return [String]
@@ -1968,43 +1588,43 @@ module Aws::IoTTwinMaker
1968
1588
  include Aws::Structure
1969
1589
  end
1970
1590
 
1591
+ # @!attribute [rw] workspace_id
1592
+ # The ID of the workspace.
1593
+ # @return [String]
1594
+ #
1971
1595
  # @!attribute [rw] arn
1972
1596
  # The ARN of the workspace.
1973
1597
  # @return [String]
1974
1598
  #
1975
- # @!attribute [rw] creation_date_time
1976
- # The date and time when the workspace was created.
1977
- # @return [Time]
1978
- #
1979
1599
  # @!attribute [rw] description
1980
1600
  # The description of the workspace.
1981
1601
  # @return [String]
1982
1602
  #
1983
- # @!attribute [rw] role
1984
- # The ARN of the execution role associated with the workspace.
1985
- # @return [String]
1986
- #
1987
1603
  # @!attribute [rw] s3_location
1988
1604
  # The ARN of the S3 bucket where resources associated with the
1989
1605
  # workspace are stored.
1990
1606
  # @return [String]
1991
1607
  #
1608
+ # @!attribute [rw] role
1609
+ # The ARN of the execution role associated with the workspace.
1610
+ # @return [String]
1611
+ #
1612
+ # @!attribute [rw] creation_date_time
1613
+ # The date and time when the workspace was created.
1614
+ # @return [Time]
1615
+ #
1992
1616
  # @!attribute [rw] update_date_time
1993
1617
  # The date and time when the workspace was last updated.
1994
1618
  # @return [Time]
1995
1619
  #
1996
- # @!attribute [rw] workspace_id
1997
- # The ID of the workspace.
1998
- # @return [String]
1999
- #
2000
1620
  class GetWorkspaceResponse < Struct.new(
1621
+ :workspace_id,
2001
1622
  :arn,
2002
- :creation_date_time,
2003
1623
  :description,
2004
- :role,
2005
1624
  :s3_location,
2006
- :update_date_time,
2007
- :workspace_id)
1625
+ :role,
1626
+ :creation_date_time,
1627
+ :update_date_time)
2008
1628
  SENSITIVE = []
2009
1629
  include Aws::Structure
2010
1630
  end
@@ -2022,14 +1642,6 @@ module Aws::IoTTwinMaker
2022
1642
 
2023
1643
  # An object that specifies how to interpolate data in a list.
2024
1644
  #
2025
- # @note When making an API call, you may pass InterpolationParameters
2026
- # data as a hash:
2027
- #
2028
- # {
2029
- # interpolation_type: "LINEAR", # accepts LINEAR
2030
- # interval_in_seconds: 1,
2031
- # }
2032
- #
2033
1645
  # @!attribute [rw] interpolation_type
2034
1646
  # The interpolation type.
2035
1647
  # @return [String]
@@ -2047,13 +1659,6 @@ module Aws::IoTTwinMaker
2047
1659
 
2048
1660
  # The Lambda function.
2049
1661
  #
2050
- # @note When making an API call, you may pass LambdaFunction
2051
- # data as a hash:
2052
- #
2053
- # {
2054
- # arn: "LambdaArn", # required
2055
- # }
2056
- #
2057
1662
  # @!attribute [rw] arn
2058
1663
  # The ARN of the Lambda function.
2059
1664
  # @return [String]
@@ -2076,93 +1681,80 @@ module Aws::IoTTwinMaker
2076
1681
  # The component type that the component types in the list extend.
2077
1682
  # @return [String]
2078
1683
  #
1684
+ # @!attribute [rw] namespace
1685
+ # The namespace to which the component types in the list belong.
1686
+ # @return [String]
1687
+ #
2079
1688
  # @!attribute [rw] is_abstract
2080
1689
  # A Boolean value that specifies whether the component types in the
2081
1690
  # list are abstract.
2082
1691
  # @return [Boolean]
2083
1692
  #
2084
- # @!attribute [rw] namespace
2085
- # The namespace to which the component types in the list belong.
2086
- # @return [String]
2087
- #
2088
1693
  class ListComponentTypesFilter < Struct.new(
2089
1694
  :extends_from,
2090
- :is_abstract,
2091
1695
  :namespace,
1696
+ :is_abstract,
2092
1697
  :unknown)
2093
1698
  SENSITIVE = []
2094
1699
  include Aws::Structure
2095
1700
  include Aws::Structure::Union
2096
1701
 
2097
1702
  class ExtendsFrom < ListComponentTypesFilter; end
2098
- class IsAbstract < ListComponentTypesFilter; end
2099
1703
  class Namespace < ListComponentTypesFilter; end
1704
+ class IsAbstract < ListComponentTypesFilter; end
2100
1705
  class Unknown < ListComponentTypesFilter; end
2101
1706
  end
2102
1707
 
2103
- # @note When making an API call, you may pass ListComponentTypesRequest
2104
- # data as a hash:
2105
- #
2106
- # {
2107
- # filters: [
2108
- # {
2109
- # extends_from: "ComponentTypeId",
2110
- # is_abstract: false,
2111
- # namespace: "String",
2112
- # },
2113
- # ],
2114
- # max_results: 1,
2115
- # next_token: "NextToken",
2116
- # workspace_id: "Id", # required
2117
- # }
1708
+ # @!attribute [rw] workspace_id
1709
+ # The ID of the workspace.
1710
+ # @return [String]
2118
1711
  #
2119
1712
  # @!attribute [rw] filters
2120
1713
  # A list of objects that filter the request.
2121
1714
  # @return [Array<Types::ListComponentTypesFilter>]
2122
1715
  #
2123
- # @!attribute [rw] max_results
2124
- # The maximum number of results to display.
2125
- # @return [Integer]
2126
- #
2127
1716
  # @!attribute [rw] next_token
2128
1717
  # The string that specifies the next page of results.
2129
1718
  # @return [String]
2130
1719
  #
2131
- # @!attribute [rw] workspace_id
2132
- # The ID of the workspace.
2133
- # @return [String]
1720
+ # @!attribute [rw] max_results
1721
+ # The maximum number of results to return at one time. The default is
1722
+ # 25.
1723
+ #
1724
+ # Valid Range: Minimum value of 1. Maximum value of 250.
1725
+ # @return [Integer]
2134
1726
  #
2135
1727
  class ListComponentTypesRequest < Struct.new(
1728
+ :workspace_id,
2136
1729
  :filters,
2137
- :max_results,
2138
1730
  :next_token,
2139
- :workspace_id)
1731
+ :max_results)
2140
1732
  SENSITIVE = []
2141
1733
  include Aws::Structure
2142
1734
  end
2143
1735
 
1736
+ # @!attribute [rw] workspace_id
1737
+ # The ID of the workspace.
1738
+ # @return [String]
1739
+ #
2144
1740
  # @!attribute [rw] component_type_summaries
2145
1741
  # A list of objects that contain information about the component
2146
1742
  # types.
2147
1743
  # @return [Array<Types::ComponentTypeSummary>]
2148
1744
  #
2149
- # @!attribute [rw] max_results
2150
- # Specifies the maximum number of results to display.
2151
- # @return [Integer]
2152
- #
2153
1745
  # @!attribute [rw] next_token
2154
1746
  # The string that specifies the next page of results.
2155
1747
  # @return [String]
2156
1748
  #
2157
- # @!attribute [rw] workspace_id
2158
- # The ID of the workspace.
2159
- # @return [String]
1749
+ # @!attribute [rw] max_results
1750
+ # Specifies the maximum number of results to display.
1751
+ # @return [Integer]
2160
1752
  #
2161
1753
  class ListComponentTypesResponse < Struct.new(
1754
+ :workspace_id,
2162
1755
  :component_type_summaries,
2163
- :max_results,
2164
1756
  :next_token,
2165
- :workspace_id)
1757
+ :max_results)
2166
1758
  SENSITIVE = []
2167
1759
  include Aws::Structure
2168
1760
  end
@@ -2171,6 +1763,10 @@ module Aws::IoTTwinMaker
2171
1763
  #
2172
1764
  # @note ListEntitiesFilter is a union - when making an API calls you must set exactly one of the members.
2173
1765
  #
1766
+ # @!attribute [rw] parent_entity_id
1767
+ # The parent of the entities in the list.
1768
+ # @return [String]
1769
+ #
2174
1770
  # @!attribute [rw] component_type_id
2175
1771
  # The ID of the component type in the entities in the list.
2176
1772
  # @return [String]
@@ -2180,40 +1776,24 @@ module Aws::IoTTwinMaker
2180
1776
  # the primary key of an external storage system.
2181
1777
  # @return [String]
2182
1778
  #
2183
- # @!attribute [rw] parent_entity_id
2184
- # The parent of the entities in the list.
2185
- # @return [String]
2186
- #
2187
1779
  class ListEntitiesFilter < Struct.new(
1780
+ :parent_entity_id,
2188
1781
  :component_type_id,
2189
1782
  :external_id,
2190
- :parent_entity_id,
2191
1783
  :unknown)
2192
1784
  SENSITIVE = []
2193
1785
  include Aws::Structure
2194
1786
  include Aws::Structure::Union
2195
1787
 
1788
+ class ParentEntityId < ListEntitiesFilter; end
2196
1789
  class ComponentTypeId < ListEntitiesFilter; end
2197
1790
  class ExternalId < ListEntitiesFilter; end
2198
- class ParentEntityId < ListEntitiesFilter; end
2199
1791
  class Unknown < ListEntitiesFilter; end
2200
1792
  end
2201
1793
 
2202
- # @note When making an API call, you may pass ListEntitiesRequest
2203
- # data as a hash:
2204
- #
2205
- # {
2206
- # filters: [
2207
- # {
2208
- # component_type_id: "ComponentTypeId",
2209
- # external_id: "String",
2210
- # parent_entity_id: "ParentEntityId",
2211
- # },
2212
- # ],
2213
- # max_results: 1,
2214
- # next_token: "NextToken",
2215
- # workspace_id: "Id", # required
2216
- # }
1794
+ # @!attribute [rw] workspace_id
1795
+ # The ID of the workspace.
1796
+ # @return [String]
2217
1797
  #
2218
1798
  # @!attribute [rw] filters
2219
1799
  # A list of objects that filter the request.
@@ -2224,22 +1804,21 @@ module Aws::IoTTwinMaker
2224
1804
  # @return [Array<Types::ListEntitiesFilter>]
2225
1805
  #
2226
1806
  # @!attribute [rw] max_results
2227
- # The maximum number of results to display.
1807
+ # The maximum number of results to return at one time. The default is
1808
+ # 25.
1809
+ #
1810
+ # Valid Range: Minimum value of 1. Maximum value of 250.
2228
1811
  # @return [Integer]
2229
1812
  #
2230
1813
  # @!attribute [rw] next_token
2231
1814
  # The string that specifies the next page of results.
2232
1815
  # @return [String]
2233
1816
  #
2234
- # @!attribute [rw] workspace_id
2235
- # The ID of the workspace.
2236
- # @return [String]
2237
- #
2238
1817
  class ListEntitiesRequest < Struct.new(
1818
+ :workspace_id,
2239
1819
  :filters,
2240
1820
  :max_results,
2241
- :next_token,
2242
- :workspace_id)
1821
+ :next_token)
2243
1822
  SENSITIVE = []
2244
1823
  include Aws::Structure
2245
1824
  end
@@ -2259,14 +1838,9 @@ module Aws::IoTTwinMaker
2259
1838
  include Aws::Structure
2260
1839
  end
2261
1840
 
2262
- # @note When making an API call, you may pass ListScenesRequest
2263
- # data as a hash:
2264
- #
2265
- # {
2266
- # max_results: 1,
2267
- # next_token: "NextToken",
2268
- # workspace_id: "Id", # required
2269
- # }
1841
+ # @!attribute [rw] workspace_id
1842
+ # The ID of the workspace that contains the scenes.
1843
+ # @return [String]
2270
1844
  #
2271
1845
  # @!attribute [rw] max_results
2272
1846
  # Specifies the maximum number of results to display.
@@ -2276,233 +1850,277 @@ module Aws::IoTTwinMaker
2276
1850
  # The string that specifies the next page of results.
2277
1851
  # @return [String]
2278
1852
  #
2279
- # @!attribute [rw] workspace_id
2280
- # The ID of the workspace that contains the scenes.
2281
- # @return [String]
2282
- #
2283
1853
  class ListScenesRequest < Struct.new(
1854
+ :workspace_id,
2284
1855
  :max_results,
2285
- :next_token,
2286
- :workspace_id)
1856
+ :next_token)
2287
1857
  SENSITIVE = []
2288
1858
  include Aws::Structure
2289
1859
  end
2290
1860
 
2291
- # @!attribute [rw] next_token
2292
- # The string that specifies the next page of results.
2293
- # @return [String]
2294
- #
2295
1861
  # @!attribute [rw] scene_summaries
2296
1862
  # A list of objects that contain information about the scenes.
2297
1863
  # @return [Array<Types::SceneSummary>]
2298
1864
  #
1865
+ # @!attribute [rw] next_token
1866
+ # The string that specifies the next page of results.
1867
+ # @return [String]
1868
+ #
2299
1869
  class ListScenesResponse < Struct.new(
2300
- :next_token,
2301
- :scene_summaries)
1870
+ :scene_summaries,
1871
+ :next_token)
2302
1872
  SENSITIVE = []
2303
1873
  include Aws::Structure
2304
1874
  end
2305
1875
 
2306
- # @note When making an API call, you may pass ListTagsForResourceRequest
2307
- # data as a hash:
2308
- #
2309
- # {
2310
- # max_results: 1,
2311
- # next_token: "NextToken",
2312
- # resource_arn: "TwinMakerArn", # required
2313
- # }
1876
+ # @!attribute [rw] workspace_id
1877
+ # The ID of the workspace that contains the sync job.
1878
+ # @return [String]
2314
1879
  #
2315
1880
  # @!attribute [rw] max_results
2316
- # The maximum number of results to display.
1881
+ # The maximum number of results to return at one time. The default is
1882
+ # 50.
1883
+ #
1884
+ # Valid Range: Minimum value of 0. Maximum value of 200.
2317
1885
  # @return [Integer]
2318
1886
  #
2319
1887
  # @!attribute [rw] next_token
2320
1888
  # The string that specifies the next page of results.
2321
1889
  # @return [String]
2322
1890
  #
2323
- # @!attribute [rw] resource_arn
2324
- # The ARN of the resource.
2325
- # @return [String]
2326
- #
2327
- class ListTagsForResourceRequest < Struct.new(
1891
+ class ListSyncJobsRequest < Struct.new(
1892
+ :workspace_id,
2328
1893
  :max_results,
2329
- :next_token,
2330
- :resource_arn)
1894
+ :next_token)
2331
1895
  SENSITIVE = []
2332
1896
  include Aws::Structure
2333
1897
  end
2334
1898
 
1899
+ # @!attribute [rw] sync_job_summaries
1900
+ # The listed SyncJob summaries.
1901
+ # @return [Array<Types::SyncJobSummary>]
1902
+ #
2335
1903
  # @!attribute [rw] next_token
2336
1904
  # The string that specifies the next page of results.
2337
1905
  # @return [String]
2338
1906
  #
2339
- # @!attribute [rw] tags
2340
- # Metadata that you can use to manage a resource.
2341
- # @return [Hash<String,String>]
2342
- #
2343
- class ListTagsForResourceResponse < Struct.new(
2344
- :next_token,
2345
- :tags)
1907
+ class ListSyncJobsResponse < Struct.new(
1908
+ :sync_job_summaries,
1909
+ :next_token)
2346
1910
  SENSITIVE = []
2347
1911
  include Aws::Structure
2348
1912
  end
2349
1913
 
2350
- # @note When making an API call, you may pass ListWorkspacesRequest
2351
- # data as a hash:
1914
+ # @!attribute [rw] workspace_id
1915
+ # The ID of the workspace that contains the sync job.
1916
+ # @return [String]
1917
+ #
1918
+ # @!attribute [rw] sync_source
1919
+ # The sync soucre.
1920
+ #
1921
+ # <note markdown="1"> Currently the only supported syncSoucre is `SITEWISE `.
1922
+ #
1923
+ # </note>
1924
+ # @return [String]
2352
1925
  #
2353
- # {
2354
- # max_results: 1,
2355
- # next_token: "NextToken",
2356
- # }
1926
+ # @!attribute [rw] filters
1927
+ # A list of objects that filter the request.
1928
+ # @return [Array<Types::SyncResourceFilter>]
2357
1929
  #
2358
1930
  # @!attribute [rw] max_results
2359
- # The maximum number of results to display.
1931
+ # The maximum number of results to return at one time. The default is
1932
+ # 50.
1933
+ #
1934
+ # Valid Range: Minimum value of 0. Maximum value of 200.
2360
1935
  # @return [Integer]
2361
1936
  #
2362
1937
  # @!attribute [rw] next_token
2363
1938
  # The string that specifies the next page of results.
2364
1939
  # @return [String]
2365
1940
  #
2366
- class ListWorkspacesRequest < Struct.new(
1941
+ class ListSyncResourcesRequest < Struct.new(
1942
+ :workspace_id,
1943
+ :sync_source,
1944
+ :filters,
2367
1945
  :max_results,
2368
1946
  :next_token)
2369
1947
  SENSITIVE = []
2370
1948
  include Aws::Structure
2371
1949
  end
2372
1950
 
1951
+ # @!attribute [rw] sync_resources
1952
+ # The sync resources.
1953
+ # @return [Array<Types::SyncResourceSummary>]
1954
+ #
2373
1955
  # @!attribute [rw] next_token
2374
1956
  # The string that specifies the next page of results.
2375
1957
  # @return [String]
2376
1958
  #
2377
- # @!attribute [rw] workspace_summaries
2378
- # A list of objects that contain information about the workspaces.
2379
- # @return [Array<Types::WorkspaceSummary>]
2380
- #
2381
- class ListWorkspacesResponse < Struct.new(
2382
- :next_token,
2383
- :workspace_summaries)
1959
+ class ListSyncResourcesResponse < Struct.new(
1960
+ :sync_resources,
1961
+ :next_token)
2384
1962
  SENSITIVE = []
2385
1963
  include Aws::Structure
2386
1964
  end
2387
1965
 
2388
- # The parent entity update request.
1966
+ # @!attribute [rw] resource_arn
1967
+ # The ARN of the resource.
1968
+ # @return [String]
2389
1969
  #
2390
- # @note When making an API call, you may pass ParentEntityUpdateRequest
2391
- # data as a hash:
1970
+ # @!attribute [rw] max_results
1971
+ # The maximum number of results to return at one time. The default is
1972
+ # 25.
2392
1973
  #
2393
- # {
2394
- # parent_entity_id: "ParentEntityId",
2395
- # update_type: "UPDATE", # required, accepts UPDATE, DELETE
2396
- # }
1974
+ # Valid Range: Minimum value of 1. Maximum value of 250.
1975
+ # @return [Integer]
2397
1976
  #
2398
- # @!attribute [rw] parent_entity_id
2399
- # The ID of the parent entity.
1977
+ # @!attribute [rw] next_token
1978
+ # The string that specifies the next page of results.
2400
1979
  # @return [String]
2401
1980
  #
2402
- # @!attribute [rw] update_type
1981
+ class ListTagsForResourceRequest < Struct.new(
1982
+ :resource_arn,
1983
+ :max_results,
1984
+ :next_token)
1985
+ SENSITIVE = []
1986
+ include Aws::Structure
1987
+ end
1988
+
1989
+ # @!attribute [rw] tags
1990
+ # Metadata that you can use to manage a resource.
1991
+ # @return [Hash<String,String>]
1992
+ #
1993
+ # @!attribute [rw] next_token
1994
+ # The string that specifies the next page of results.
1995
+ # @return [String]
1996
+ #
1997
+ class ListTagsForResourceResponse < Struct.new(
1998
+ :tags,
1999
+ :next_token)
2000
+ SENSITIVE = []
2001
+ include Aws::Structure
2002
+ end
2003
+
2004
+ # @!attribute [rw] max_results
2005
+ # The maximum number of results to return at one time. The default is
2006
+ # 25.
2007
+ #
2008
+ # Valid Range: Minimum value of 1. Maximum value of 250.
2009
+ # @return [Integer]
2010
+ #
2011
+ # @!attribute [rw] next_token
2012
+ # The string that specifies the next page of results.
2013
+ # @return [String]
2014
+ #
2015
+ class ListWorkspacesRequest < Struct.new(
2016
+ :max_results,
2017
+ :next_token)
2018
+ SENSITIVE = []
2019
+ include Aws::Structure
2020
+ end
2021
+
2022
+ # @!attribute [rw] workspace_summaries
2023
+ # A list of objects that contain information about the workspaces.
2024
+ # @return [Array<Types::WorkspaceSummary>]
2025
+ #
2026
+ # @!attribute [rw] next_token
2027
+ # The string that specifies the next page of results.
2028
+ # @return [String]
2029
+ #
2030
+ class ListWorkspacesResponse < Struct.new(
2031
+ :workspace_summaries,
2032
+ :next_token)
2033
+ SENSITIVE = []
2034
+ include Aws::Structure
2035
+ end
2036
+
2037
+ # Filter criteria that orders the return output. It can be sorted in
2038
+ # ascending or descending order.
2039
+ #
2040
+ # @!attribute [rw] order
2041
+ # The set order that filters results.
2042
+ # @return [String]
2043
+ #
2044
+ # @!attribute [rw] property_name
2045
+ # The property name.
2046
+ # @return [String]
2047
+ #
2048
+ class OrderBy < Struct.new(
2049
+ :order,
2050
+ :property_name)
2051
+ SENSITIVE = []
2052
+ include Aws::Structure
2053
+ end
2054
+
2055
+ # The parent entity update request.
2056
+ #
2057
+ # @!attribute [rw] update_type
2403
2058
  # The type of the update.
2404
2059
  # @return [String]
2405
2060
  #
2061
+ # @!attribute [rw] parent_entity_id
2062
+ # The ID of the parent entity.
2063
+ # @return [String]
2064
+ #
2406
2065
  class ParentEntityUpdateRequest < Struct.new(
2407
- :parent_entity_id,
2408
- :update_type)
2066
+ :update_type,
2067
+ :parent_entity_id)
2409
2068
  SENSITIVE = []
2410
2069
  include Aws::Structure
2411
2070
  end
2412
2071
 
2413
- # An object that sets information about a property.
2072
+ # The pricing plan.
2414
2073
  #
2415
- # @note When making an API call, you may pass PropertyDefinitionRequest
2416
- # data as a hash:
2417
- #
2418
- # {
2419
- # configuration: {
2420
- # "Name" => "Value",
2421
- # },
2422
- # data_type: {
2423
- # allowed_values: [
2424
- # {
2425
- # boolean_value: false,
2426
- # double_value: 1.0,
2427
- # expression: "Expression",
2428
- # integer_value: 1,
2429
- # list_value: {
2430
- # # recursive DataValueList
2431
- # },
2432
- # long_value: 1,
2433
- # map_value: {
2434
- # "String" => {
2435
- # # recursive DataValue
2436
- # },
2437
- # },
2438
- # relationship_value: {
2439
- # target_component_name: "Name",
2440
- # target_entity_id: "EntityId",
2441
- # },
2442
- # string_value: "String",
2443
- # },
2444
- # ],
2445
- # nested_type: {
2446
- # # recursive DataType
2447
- # },
2448
- # relationship: {
2449
- # relationship_type: "String",
2450
- # target_component_type_id: "ComponentTypeId",
2451
- # },
2452
- # type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
2453
- # unit_of_measure: "String",
2454
- # },
2455
- # default_value: {
2456
- # boolean_value: false,
2457
- # double_value: 1.0,
2458
- # expression: "Expression",
2459
- # integer_value: 1,
2460
- # list_value: [
2461
- # {
2462
- # # recursive DataValue
2463
- # },
2464
- # ],
2465
- # long_value: 1,
2466
- # map_value: {
2467
- # "String" => {
2468
- # # recursive DataValue
2469
- # },
2470
- # },
2471
- # relationship_value: {
2472
- # target_component_name: "Name",
2473
- # target_entity_id: "EntityId",
2474
- # },
2475
- # string_value: "String",
2476
- # },
2477
- # is_external_id: false,
2478
- # is_required_in_entity: false,
2479
- # is_stored_externally: false,
2480
- # is_time_series: false,
2481
- # }
2074
+ # @!attribute [rw] billable_entity_count
2075
+ # The billable entity count.
2076
+ # @return [Integer]
2482
2077
  #
2483
- # @!attribute [rw] configuration
2484
- # A mapping that specifies configuration information about the
2485
- # property. Use this field to specify information that you read from
2486
- # and write to an external source.
2487
- # @return [Hash<String,String>]
2078
+ # @!attribute [rw] bundle_information
2079
+ # The pricing plan's bundle information.
2080
+ # @return [Types::BundleInformation]
2081
+ #
2082
+ # @!attribute [rw] effective_date_time
2083
+ # The effective date and time of the pricing plan.
2084
+ # @return [Time]
2085
+ #
2086
+ # @!attribute [rw] pricing_mode
2087
+ # The pricing mode.
2088
+ # @return [String]
2089
+ #
2090
+ # @!attribute [rw] update_date_time
2091
+ # The set date and time for updating a pricing plan.
2092
+ # @return [Time]
2093
+ #
2094
+ # @!attribute [rw] update_reason
2095
+ # The update reason, for changing a pricing plan.
2096
+ # @return [String]
2097
+ #
2098
+ class PricingPlan < Struct.new(
2099
+ :billable_entity_count,
2100
+ :bundle_information,
2101
+ :effective_date_time,
2102
+ :pricing_mode,
2103
+ :update_date_time,
2104
+ :update_reason)
2105
+ SENSITIVE = []
2106
+ include Aws::Structure
2107
+ end
2108
+
2109
+ # An object that sets information about a property.
2488
2110
  #
2489
2111
  # @!attribute [rw] data_type
2490
2112
  # An object that contains information about the data type.
2491
2113
  # @return [Types::DataType]
2492
2114
  #
2493
- # @!attribute [rw] default_value
2494
- # An object that contains the default value.
2495
- # @return [Types::DataValue]
2115
+ # @!attribute [rw] is_required_in_entity
2116
+ # A Boolean value that specifies whether the property is required.
2117
+ # @return [Boolean]
2496
2118
  #
2497
2119
  # @!attribute [rw] is_external_id
2498
2120
  # A Boolean value that specifies whether the property ID comes from an
2499
2121
  # external data store.
2500
2122
  # @return [Boolean]
2501
2123
  #
2502
- # @!attribute [rw] is_required_in_entity
2503
- # A Boolean value that specifies whether the property is required.
2504
- # @return [Boolean]
2505
- #
2506
2124
  # @!attribute [rw] is_stored_externally
2507
2125
  # A Boolean value that specifies whether the property is stored
2508
2126
  # externally.
@@ -2513,14 +2131,29 @@ module Aws::IoTTwinMaker
2513
2131
  # series data.
2514
2132
  # @return [Boolean]
2515
2133
  #
2134
+ # @!attribute [rw] default_value
2135
+ # An object that contains the default value.
2136
+ # @return [Types::DataValue]
2137
+ #
2138
+ # @!attribute [rw] configuration
2139
+ # A mapping that specifies configuration information about the
2140
+ # property. Use this field to specify information that you read from
2141
+ # and write to an external source.
2142
+ # @return [Hash<String,String>]
2143
+ #
2144
+ # @!attribute [rw] display_name
2145
+ # A friendly name for the property.
2146
+ # @return [String]
2147
+ #
2516
2148
  class PropertyDefinitionRequest < Struct.new(
2517
- :configuration,
2518
2149
  :data_type,
2519
- :default_value,
2520
- :is_external_id,
2521
2150
  :is_required_in_entity,
2151
+ :is_external_id,
2522
2152
  :is_stored_externally,
2523
- :is_time_series)
2153
+ :is_time_series,
2154
+ :default_value,
2155
+ :configuration,
2156
+ :display_name)
2524
2157
  SENSITIVE = []
2525
2158
  include Aws::Structure
2526
2159
  end
@@ -2528,27 +2161,28 @@ module Aws::IoTTwinMaker
2528
2161
  # An object that contains response data from a property definition
2529
2162
  # request.
2530
2163
  #
2531
- # @!attribute [rw] configuration
2532
- # A mapping that specifies configuration information about the
2533
- # property.
2534
- # @return [Hash<String,String>]
2535
- #
2536
2164
  # @!attribute [rw] data_type
2537
2165
  # An object that contains information about the data type.
2538
2166
  # @return [Types::DataType]
2539
2167
  #
2540
- # @!attribute [rw] default_value
2541
- # An object that contains the default value.
2542
- # @return [Types::DataValue]
2168
+ # @!attribute [rw] is_time_series
2169
+ # A Boolean value that specifies whether the property consists of time
2170
+ # series data.
2171
+ # @return [Boolean]
2172
+ #
2173
+ # @!attribute [rw] is_required_in_entity
2174
+ # A Boolean value that specifies whether the property is required in
2175
+ # an entity.
2176
+ # @return [Boolean]
2543
2177
  #
2544
2178
  # @!attribute [rw] is_external_id
2545
2179
  # A Boolean value that specifies whether the property ID comes from an
2546
2180
  # external data store.
2547
2181
  # @return [Boolean]
2548
2182
  #
2549
- # @!attribute [rw] is_final
2550
- # A Boolean value that specifies whether the property definition can
2551
- # be updated.
2183
+ # @!attribute [rw] is_stored_externally
2184
+ # A Boolean value that specifies whether the property is stored
2185
+ # externally.
2552
2186
  # @return [Boolean]
2553
2187
  #
2554
2188
  # @!attribute [rw] is_imported
@@ -2556,93 +2190,105 @@ module Aws::IoTTwinMaker
2556
2190
  # imported from an external data store.
2557
2191
  # @return [Boolean]
2558
2192
  #
2193
+ # @!attribute [rw] is_final
2194
+ # A Boolean value that specifies whether the property definition can
2195
+ # be updated.
2196
+ # @return [Boolean]
2197
+ #
2559
2198
  # @!attribute [rw] is_inherited
2560
2199
  # A Boolean value that specifies whether the property definition is
2561
2200
  # inherited from a parent entity.
2562
2201
  # @return [Boolean]
2563
2202
  #
2564
- # @!attribute [rw] is_required_in_entity
2565
- # A Boolean value that specifies whether the property is required in
2566
- # an entity.
2567
- # @return [Boolean]
2203
+ # @!attribute [rw] default_value
2204
+ # An object that contains the default value.
2205
+ # @return [Types::DataValue]
2568
2206
  #
2569
- # @!attribute [rw] is_stored_externally
2570
- # A Boolean value that specifies whether the property is stored
2571
- # externally.
2572
- # @return [Boolean]
2207
+ # @!attribute [rw] configuration
2208
+ # A mapping that specifies configuration information about the
2209
+ # property.
2210
+ # @return [Hash<String,String>]
2573
2211
  #
2574
- # @!attribute [rw] is_time_series
2575
- # A Boolean value that specifies whether the property consists of time
2576
- # series data.
2577
- # @return [Boolean]
2212
+ # @!attribute [rw] display_name
2213
+ # A friendly name for the property.
2214
+ # @return [String]
2578
2215
  #
2579
2216
  class PropertyDefinitionResponse < Struct.new(
2580
- :configuration,
2581
2217
  :data_type,
2582
- :default_value,
2218
+ :is_time_series,
2219
+ :is_required_in_entity,
2583
2220
  :is_external_id,
2584
- :is_final,
2221
+ :is_stored_externally,
2585
2222
  :is_imported,
2223
+ :is_final,
2586
2224
  :is_inherited,
2587
- :is_required_in_entity,
2588
- :is_stored_externally,
2589
- :is_time_series)
2225
+ :default_value,
2226
+ :configuration,
2227
+ :display_name)
2590
2228
  SENSITIVE = []
2591
2229
  include Aws::Structure
2592
2230
  end
2593
2231
 
2594
2232
  # An object that filters items returned by a property request.
2595
2233
  #
2596
- # @note When making an API call, you may pass PropertyFilter
2597
- # data as a hash:
2598
- #
2599
- # {
2600
- # operator: "String",
2601
- # property_name: "String",
2602
- # value: {
2603
- # boolean_value: false,
2604
- # double_value: 1.0,
2605
- # expression: "Expression",
2606
- # integer_value: 1,
2607
- # list_value: [
2608
- # {
2609
- # # recursive DataValue
2610
- # },
2611
- # ],
2612
- # long_value: 1,
2613
- # map_value: {
2614
- # "String" => {
2615
- # # recursive DataValue
2616
- # },
2617
- # },
2618
- # relationship_value: {
2619
- # target_component_name: "Name",
2620
- # target_entity_id: "EntityId",
2621
- # },
2622
- # string_value: "String",
2623
- # },
2624
- # }
2234
+ # @!attribute [rw] property_name
2235
+ # The property name associated with this property filter.
2236
+ # @return [String]
2625
2237
  #
2626
2238
  # @!attribute [rw] operator
2627
2239
  # The operator associated with this property filter.
2628
2240
  # @return [String]
2629
2241
  #
2630
- # @!attribute [rw] property_name
2631
- # The property name associated with this property filter.
2632
- # @return [String]
2633
- #
2634
2242
  # @!attribute [rw] value
2635
2243
  # The value associated with this property filter.
2636
2244
  # @return [Types::DataValue]
2637
2245
  #
2638
2246
  class PropertyFilter < Struct.new(
2639
- :operator,
2640
2247
  :property_name,
2248
+ :operator,
2641
2249
  :value)
2642
2250
  SENSITIVE = []
2643
2251
  include Aws::Structure
2644
2252
  end
2645
2253
 
2254
+ # @!attribute [rw] group_type
2255
+ # The group type.
2256
+ # @return [String]
2257
+ #
2258
+ # @!attribute [rw] property_names
2259
+ # The names of properties.
2260
+ # @return [Array<String>]
2261
+ #
2262
+ class PropertyGroupRequest < Struct.new(
2263
+ :group_type,
2264
+ :property_names)
2265
+ SENSITIVE = []
2266
+ include Aws::Structure
2267
+ end
2268
+
2269
+ # The property group response
2270
+ #
2271
+ # @!attribute [rw] group_type
2272
+ # The group types.
2273
+ # @return [String]
2274
+ #
2275
+ # @!attribute [rw] property_names
2276
+ # The names of properties.
2277
+ # @return [Array<String>]
2278
+ #
2279
+ # @!attribute [rw] is_inherited
2280
+ # A Boolean value that specifies whether the property group is
2281
+ # inherited from a parent entity
2282
+ # @return [Boolean]
2283
+ #
2284
+ class PropertyGroupResponse < Struct.new(
2285
+ :group_type,
2286
+ :property_names,
2287
+ :is_inherited)
2288
+ SENSITIVE = []
2289
+ include Aws::Structure
2290
+ end
2291
+
2646
2292
  # The latest value of the property.
2647
2293
  #
2648
2294
  # @!attribute [rw] property_reference
@@ -2662,115 +2308,22 @@ module Aws::IoTTwinMaker
2662
2308
 
2663
2309
  # An object that sets information about a property.
2664
2310
  #
2665
- # @note When making an API call, you may pass PropertyRequest
2666
- # data as a hash:
2667
- #
2668
- # {
2669
- # definition: {
2670
- # configuration: {
2671
- # "Name" => "Value",
2672
- # },
2673
- # data_type: {
2674
- # allowed_values: [
2675
- # {
2676
- # boolean_value: false,
2677
- # double_value: 1.0,
2678
- # expression: "Expression",
2679
- # integer_value: 1,
2680
- # list_value: {
2681
- # # recursive DataValueList
2682
- # },
2683
- # long_value: 1,
2684
- # map_value: {
2685
- # "String" => {
2686
- # # recursive DataValue
2687
- # },
2688
- # },
2689
- # relationship_value: {
2690
- # target_component_name: "Name",
2691
- # target_entity_id: "EntityId",
2692
- # },
2693
- # string_value: "String",
2694
- # },
2695
- # ],
2696
- # nested_type: {
2697
- # # recursive DataType
2698
- # },
2699
- # relationship: {
2700
- # relationship_type: "String",
2701
- # target_component_type_id: "ComponentTypeId",
2702
- # },
2703
- # type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
2704
- # unit_of_measure: "String",
2705
- # },
2706
- # default_value: {
2707
- # boolean_value: false,
2708
- # double_value: 1.0,
2709
- # expression: "Expression",
2710
- # integer_value: 1,
2711
- # list_value: [
2712
- # {
2713
- # # recursive DataValue
2714
- # },
2715
- # ],
2716
- # long_value: 1,
2717
- # map_value: {
2718
- # "String" => {
2719
- # # recursive DataValue
2720
- # },
2721
- # },
2722
- # relationship_value: {
2723
- # target_component_name: "Name",
2724
- # target_entity_id: "EntityId",
2725
- # },
2726
- # string_value: "String",
2727
- # },
2728
- # is_external_id: false,
2729
- # is_required_in_entity: false,
2730
- # is_stored_externally: false,
2731
- # is_time_series: false,
2732
- # },
2733
- # update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
2734
- # value: {
2735
- # boolean_value: false,
2736
- # double_value: 1.0,
2737
- # expression: "Expression",
2738
- # integer_value: 1,
2739
- # list_value: [
2740
- # {
2741
- # # recursive DataValue
2742
- # },
2743
- # ],
2744
- # long_value: 1,
2745
- # map_value: {
2746
- # "String" => {
2747
- # # recursive DataValue
2748
- # },
2749
- # },
2750
- # relationship_value: {
2751
- # target_component_name: "Name",
2752
- # target_entity_id: "EntityId",
2753
- # },
2754
- # string_value: "String",
2755
- # },
2756
- # }
2757
- #
2758
2311
  # @!attribute [rw] definition
2759
2312
  # An object that specifies information about a property.
2760
2313
  # @return [Types::PropertyDefinitionRequest]
2761
2314
  #
2762
- # @!attribute [rw] update_type
2763
- # The update type of the update property request.
2764
- # @return [String]
2765
- #
2766
2315
  # @!attribute [rw] value
2767
2316
  # The value of the property.
2768
2317
  # @return [Types::DataValue]
2769
2318
  #
2319
+ # @!attribute [rw] update_type
2320
+ # The update type of the update property request.
2321
+ # @return [String]
2322
+ #
2770
2323
  class PropertyRequest < Struct.new(
2771
2324
  :definition,
2772
- :update_type,
2773
- :value)
2325
+ :value,
2326
+ :update_type)
2774
2327
  SENSITIVE = []
2775
2328
  include Aws::Structure
2776
2329
  end
@@ -2795,35 +2348,13 @@ module Aws::IoTTwinMaker
2795
2348
  # An object that contains information about a value for a time series
2796
2349
  # property.
2797
2350
  #
2798
- # @note When making an API call, you may pass PropertyValue
2799
- # data as a hash:
2800
- #
2801
- # {
2802
- # time: "Time",
2803
- # timestamp: Time.now,
2804
- # value: { # required
2805
- # boolean_value: false,
2806
- # double_value: 1.0,
2807
- # expression: "Expression",
2808
- # integer_value: 1,
2809
- # list_value: [
2810
- # {
2811
- # # recursive DataValue
2812
- # },
2813
- # ],
2814
- # long_value: 1,
2815
- # map_value: {
2816
- # "String" => {
2817
- # # recursive DataValue
2818
- # },
2819
- # },
2820
- # relationship_value: {
2821
- # target_component_name: "Name",
2822
- # target_entity_id: "EntityId",
2823
- # },
2824
- # string_value: "String",
2825
- # },
2826
- # }
2351
+ # @!attribute [rw] timestamp
2352
+ # The timestamp of a value for a time series property.
2353
+ # @return [Time]
2354
+ #
2355
+ # @!attribute [rw] value
2356
+ # An object that specifies a value for a time series property.
2357
+ # @return [Types::DataValue]
2827
2358
  #
2828
2359
  # @!attribute [rw] time
2829
2360
  # ISO8601 DateTime of a value for a time series property.
@@ -2854,18 +2385,10 @@ module Aws::IoTTwinMaker
2854
2385
  # *Required sub-fields*\: YYYY-MM-DDThh:mm:ss and \[Z/±HH:mm\]
2855
2386
  # @return [String]
2856
2387
  #
2857
- # @!attribute [rw] timestamp
2858
- # The timestamp of a value for a time series property.
2859
- # @return [Time]
2860
- #
2861
- # @!attribute [rw] value
2862
- # An object that specifies a value for a time series property.
2863
- # @return [Types::DataValue]
2864
- #
2865
2388
  class PropertyValue < Struct.new(
2866
- :time,
2867
2389
  :timestamp,
2868
- :value)
2390
+ :value,
2391
+ :time)
2869
2392
  SENSITIVE = []
2870
2393
  include Aws::Structure
2871
2394
  end
@@ -2878,48 +2401,6 @@ module Aws::IoTTwinMaker
2878
2401
  #
2879
2402
  # [1]: https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_BatchPutPropertyValues.html
2880
2403
  #
2881
- # @note When making an API call, you may pass PropertyValueEntry
2882
- # data as a hash:
2883
- #
2884
- # {
2885
- # entity_property_reference: { # required
2886
- # component_name: "Name",
2887
- # entity_id: "EntityId",
2888
- # external_id_property: {
2889
- # "String" => "String",
2890
- # },
2891
- # property_name: "Name", # required
2892
- # },
2893
- # property_values: [
2894
- # {
2895
- # time: "Time",
2896
- # timestamp: Time.now,
2897
- # value: { # required
2898
- # boolean_value: false,
2899
- # double_value: 1.0,
2900
- # expression: "Expression",
2901
- # integer_value: 1,
2902
- # list_value: [
2903
- # {
2904
- # # recursive DataValue
2905
- # },
2906
- # ],
2907
- # long_value: 1,
2908
- # map_value: {
2909
- # "String" => {
2910
- # # recursive DataValue
2911
- # },
2912
- # },
2913
- # relationship_value: {
2914
- # target_component_name: "Name",
2915
- # target_entity_id: "EntityId",
2916
- # },
2917
- # string_value: "String",
2918
- # },
2919
- # },
2920
- # ],
2921
- # }
2922
- #
2923
2404
  # @!attribute [rw] entity_property_reference
2924
2405
  # An object that contains information about the entity that has the
2925
2406
  # property.
@@ -2947,154 +2428,312 @@ module Aws::IoTTwinMaker
2947
2428
  # history of a time series property.
2948
2429
  # @return [Array<Types::PropertyValue>]
2949
2430
  #
2950
- class PropertyValueHistory < Struct.new(
2951
- :entity_property_reference,
2952
- :values)
2431
+ class PropertyValueHistory < Struct.new(
2432
+ :entity_property_reference,
2433
+ :values)
2434
+ SENSITIVE = []
2435
+ include Aws::Structure
2436
+ end
2437
+
2438
+ # The query timeout exception.
2439
+ #
2440
+ # @!attribute [rw] message
2441
+ # @return [String]
2442
+ #
2443
+ class QueryTimeoutException < Struct.new(
2444
+ :message)
2445
+ SENSITIVE = []
2446
+ include Aws::Structure
2447
+ end
2448
+
2449
+ # An object that specifies a relationship with another component type.
2450
+ #
2451
+ # @!attribute [rw] target_component_type_id
2452
+ # The ID of the target component type associated with this
2453
+ # relationship.
2454
+ # @return [String]
2455
+ #
2456
+ # @!attribute [rw] relationship_type
2457
+ # The type of the relationship.
2458
+ # @return [String]
2459
+ #
2460
+ class Relationship < Struct.new(
2461
+ :target_component_type_id,
2462
+ :relationship_type)
2463
+ SENSITIVE = []
2464
+ include Aws::Structure
2465
+ end
2466
+
2467
+ # A value that associates a component and an entity.
2468
+ #
2469
+ # @!attribute [rw] target_entity_id
2470
+ # The ID of the target entity associated with this relationship value.
2471
+ # @return [String]
2472
+ #
2473
+ # @!attribute [rw] target_component_name
2474
+ # The name of the target component associated with the relationship
2475
+ # value.
2476
+ # @return [String]
2477
+ #
2478
+ class RelationshipValue < Struct.new(
2479
+ :target_entity_id,
2480
+ :target_component_name)
2481
+ SENSITIVE = []
2482
+ include Aws::Structure
2483
+ end
2484
+
2485
+ # The resource wasn't found.
2486
+ #
2487
+ # @!attribute [rw] message
2488
+ # @return [String]
2489
+ #
2490
+ class ResourceNotFoundException < Struct.new(
2491
+ :message)
2492
+ SENSITIVE = []
2493
+ include Aws::Structure
2494
+ end
2495
+
2496
+ # Represents a single row in the query results.
2497
+ #
2498
+ # @!attribute [rw] row_data
2499
+ # The data in a row of query results.
2500
+ # @return [Array<Hash,Array,String,Numeric,Boolean>]
2501
+ #
2502
+ class Row < Struct.new(
2503
+ :row_data)
2504
+ SENSITIVE = []
2505
+ include Aws::Structure
2506
+ end
2507
+
2508
+ # An object that contains information about a scene.
2509
+ #
2510
+ # @!attribute [rw] scene_id
2511
+ # The ID of the scene.
2512
+ # @return [String]
2513
+ #
2514
+ # @!attribute [rw] content_location
2515
+ # The relative path that specifies the location of the content
2516
+ # definition file.
2517
+ # @return [String]
2518
+ #
2519
+ # @!attribute [rw] arn
2520
+ # The ARN of the scene.
2521
+ # @return [String]
2522
+ #
2523
+ # @!attribute [rw] creation_date_time
2524
+ # The date and time when the scene was created.
2525
+ # @return [Time]
2526
+ #
2527
+ # @!attribute [rw] update_date_time
2528
+ # The date and time when the scene was last updated.
2529
+ # @return [Time]
2530
+ #
2531
+ # @!attribute [rw] description
2532
+ # The scene description.
2533
+ # @return [String]
2534
+ #
2535
+ class SceneSummary < Struct.new(
2536
+ :scene_id,
2537
+ :content_location,
2538
+ :arn,
2539
+ :creation_date_time,
2540
+ :update_date_time,
2541
+ :description)
2542
+ SENSITIVE = []
2543
+ include Aws::Structure
2544
+ end
2545
+
2546
+ # The service quota was exceeded.
2547
+ #
2548
+ # @!attribute [rw] message
2549
+ # @return [String]
2550
+ #
2551
+ class ServiceQuotaExceededException < Struct.new(
2552
+ :message)
2553
+ SENSITIVE = []
2554
+ include Aws::Structure
2555
+ end
2556
+
2557
+ # An object that represents the status of an entity, component,
2558
+ # component type, or workspace.
2559
+ #
2560
+ # @!attribute [rw] state
2561
+ # The current state of the entity, component, component type, or
2562
+ # workspace.
2563
+ # @return [String]
2564
+ #
2565
+ # @!attribute [rw] error
2566
+ # The error message.
2567
+ # @return [Types::ErrorDetails]
2568
+ #
2569
+ class Status < Struct.new(
2570
+ :state,
2571
+ :error)
2572
+ SENSITIVE = []
2573
+ include Aws::Structure
2574
+ end
2575
+
2576
+ # The SyncJob status.
2577
+ #
2578
+ # @!attribute [rw] state
2579
+ # The SyncJob status state.
2580
+ # @return [String]
2581
+ #
2582
+ # @!attribute [rw] error
2583
+ # The SyncJob error.
2584
+ # @return [Types::ErrorDetails]
2585
+ #
2586
+ class SyncJobStatus < Struct.new(
2587
+ :state,
2588
+ :error)
2953
2589
  SENSITIVE = []
2954
2590
  include Aws::Structure
2955
2591
  end
2956
2592
 
2957
- # An object that specifies a relationship with another component type.
2593
+ # The SyncJob summary.
2958
2594
  #
2959
- # @note When making an API call, you may pass Relationship
2960
- # data as a hash:
2961
- #
2962
- # {
2963
- # relationship_type: "String",
2964
- # target_component_type_id: "ComponentTypeId",
2965
- # }
2595
+ # @!attribute [rw] arn
2596
+ # The SyncJob summary ARN.
2597
+ # @return [String]
2966
2598
  #
2967
- # @!attribute [rw] relationship_type
2968
- # The type of the relationship.
2599
+ # @!attribute [rw] workspace_id
2600
+ # The ID of the workspace that contains the sync job.
2969
2601
  # @return [String]
2970
2602
  #
2971
- # @!attribute [rw] target_component_type_id
2972
- # The ID of the target component type associated with this
2973
- # relationship.
2603
+ # @!attribute [rw] sync_source
2604
+ # The sync source.
2974
2605
  # @return [String]
2975
2606
  #
2976
- class Relationship < Struct.new(
2977
- :relationship_type,
2978
- :target_component_type_id)
2607
+ # @!attribute [rw] status
2608
+ # The SyncJob summaries status.
2609
+ # @return [Types::SyncJobStatus]
2610
+ #
2611
+ # @!attribute [rw] creation_date_time
2612
+ # The creation date and time.
2613
+ # @return [Time]
2614
+ #
2615
+ # @!attribute [rw] update_date_time
2616
+ # The update date and time.
2617
+ # @return [Time]
2618
+ #
2619
+ class SyncJobSummary < Struct.new(
2620
+ :arn,
2621
+ :workspace_id,
2622
+ :sync_source,
2623
+ :status,
2624
+ :creation_date_time,
2625
+ :update_date_time)
2979
2626
  SENSITIVE = []
2980
2627
  include Aws::Structure
2981
2628
  end
2982
2629
 
2983
- # A value that associates a component and an entity.
2630
+ # The sync resource filter.
2984
2631
  #
2985
- # @note When making an API call, you may pass RelationshipValue
2986
- # data as a hash:
2632
+ # @note SyncResourceFilter is a union - when making an API calls you must set exactly one of the members.
2987
2633
  #
2988
- # {
2989
- # target_component_name: "Name",
2990
- # target_entity_id: "EntityId",
2991
- # }
2634
+ # @!attribute [rw] state
2635
+ # The sync resource filter's state.
2636
+ # @return [String]
2992
2637
  #
2993
- # @!attribute [rw] target_component_name
2994
- # The name of the target component associated with the relationship
2995
- # value.
2638
+ # @!attribute [rw] resource_type
2639
+ # The sync resource filter resoucre type
2996
2640
  # @return [String]
2997
2641
  #
2998
- # @!attribute [rw] target_entity_id
2999
- # The ID of the target entity associated with this relationship value.
2642
+ # @!attribute [rw] resource_id
2643
+ # The sync resource filter resource Id.
3000
2644
  # @return [String]
3001
2645
  #
3002
- class RelationshipValue < Struct.new(
3003
- :target_component_name,
3004
- :target_entity_id)
2646
+ # @!attribute [rw] external_id
2647
+ # The external Id.
2648
+ # @return [String]
2649
+ #
2650
+ class SyncResourceFilter < Struct.new(
2651
+ :state,
2652
+ :resource_type,
2653
+ :resource_id,
2654
+ :external_id,
2655
+ :unknown)
3005
2656
  SENSITIVE = []
3006
2657
  include Aws::Structure
2658
+ include Aws::Structure::Union
2659
+
2660
+ class State < SyncResourceFilter; end
2661
+ class ResourceType < SyncResourceFilter; end
2662
+ class ResourceId < SyncResourceFilter; end
2663
+ class ExternalId < SyncResourceFilter; end
2664
+ class Unknown < SyncResourceFilter; end
3007
2665
  end
3008
2666
 
3009
- # The resource wasn't found.
2667
+ # The sync resource status.
3010
2668
  #
3011
- # @!attribute [rw] message
2669
+ # @!attribute [rw] state
2670
+ # The sync resource status state.
3012
2671
  # @return [String]
3013
2672
  #
3014
- class ResourceNotFoundException < Struct.new(
3015
- :message)
2673
+ # @!attribute [rw] error
2674
+ # The status error.
2675
+ # @return [Types::ErrorDetails]
2676
+ #
2677
+ class SyncResourceStatus < Struct.new(
2678
+ :state,
2679
+ :error)
3016
2680
  SENSITIVE = []
3017
2681
  include Aws::Structure
3018
2682
  end
3019
2683
 
3020
- # An object that contains information about a scene.
2684
+ # The sync resource summary.
3021
2685
  #
3022
- # @!attribute [rw] arn
3023
- # The ARN of the scene.
2686
+ # @!attribute [rw] resource_type
2687
+ # The resource type.
3024
2688
  # @return [String]
3025
2689
  #
3026
- # @!attribute [rw] content_location
3027
- # The relative path that specifies the location of the content
3028
- # definition file.
2690
+ # @!attribute [rw] external_id
2691
+ # The external Id.
3029
2692
  # @return [String]
3030
2693
  #
3031
- # @!attribute [rw] creation_date_time
3032
- # The date and time when the scene was created.
3033
- # @return [Time]
3034
- #
3035
- # @!attribute [rw] description
3036
- # The scene description.
2694
+ # @!attribute [rw] resource_id
2695
+ # The resource Id.
3037
2696
  # @return [String]
3038
2697
  #
3039
- # @!attribute [rw] scene_id
3040
- # The ID of the scene.
3041
- # @return [String]
2698
+ # @!attribute [rw] status
2699
+ # The sync resource summary status.
2700
+ # @return [Types::SyncResourceStatus]
3042
2701
  #
3043
2702
  # @!attribute [rw] update_date_time
3044
- # The date and time when the scene was last updated.
2703
+ # The update date and time.
3045
2704
  # @return [Time]
3046
2705
  #
3047
- class SceneSummary < Struct.new(
3048
- :arn,
3049
- :content_location,
3050
- :creation_date_time,
3051
- :description,
3052
- :scene_id,
2706
+ class SyncResourceSummary < Struct.new(
2707
+ :resource_type,
2708
+ :external_id,
2709
+ :resource_id,
2710
+ :status,
3053
2711
  :update_date_time)
3054
2712
  SENSITIVE = []
3055
2713
  include Aws::Structure
3056
2714
  end
3057
2715
 
3058
- # The service quota was exceeded.
3059
- #
3060
- # @!attribute [rw] message
3061
- # @return [String]
2716
+ # The tabular conditions.
3062
2717
  #
3063
- class ServiceQuotaExceededException < Struct.new(
3064
- :message)
3065
- SENSITIVE = []
3066
- include Aws::Structure
3067
- end
3068
-
3069
- # An object that represents the status of an entity, component,
3070
- # component type, or workspace.
2718
+ # @!attribute [rw] order_by
2719
+ # Filter criteria that orders the output. It can be sorted in
2720
+ # ascending or descending order.
2721
+ # @return [Array<Types::OrderBy>]
3071
2722
  #
3072
- # @!attribute [rw] error
3073
- # The error message.
3074
- # @return [Types::ErrorDetails]
2723
+ # @!attribute [rw] property_filters
2724
+ # You can filter the request using various logical operators and a
2725
+ # key-value format. For example:
3075
2726
  #
3076
- # @!attribute [rw] state
3077
- # The current state of the entity, component, component type, or
3078
- # workspace.
3079
- # @return [String]
2727
+ # `\{"key": "serverType", "value": "webServer"\}`
2728
+ # @return [Array<Types::PropertyFilter>]
3080
2729
  #
3081
- class Status < Struct.new(
3082
- :error,
3083
- :state)
2730
+ class TabularConditions < Struct.new(
2731
+ :order_by,
2732
+ :property_filters)
3084
2733
  SENSITIVE = []
3085
2734
  include Aws::Structure
3086
2735
  end
3087
2736
 
3088
- # @note When making an API call, you may pass TagResourceRequest
3089
- # data as a hash:
3090
- #
3091
- # {
3092
- # resource_arn: "TwinMakerArn", # required
3093
- # tags: { # required
3094
- # "TagKey" => "TagValue",
3095
- # },
3096
- # }
3097
- #
3098
2737
  # @!attribute [rw] resource_arn
3099
2738
  # The ARN of the resource.
3100
2739
  # @return [String]
@@ -3134,14 +2773,6 @@ module Aws::IoTTwinMaker
3134
2773
  include Aws::Structure
3135
2774
  end
3136
2775
 
3137
- # @note When making an API call, you may pass UntagResourceRequest
3138
- # data as a hash:
3139
- #
3140
- # {
3141
- # resource_arn: "TwinMakerArn", # required
3142
- # tag_keys: ["TagKey"], # required
3143
- # }
3144
- #
3145
2776
  # @!attribute [rw] resource_arn
3146
2777
  # The ARN of the resource.
3147
2778
  # @return [String]
@@ -3161,94 +2792,14 @@ module Aws::IoTTwinMaker
3161
2792
 
3162
2793
  class UntagResourceResponse < Aws::EmptyStructure; end
3163
2794
 
3164
- # @note When making an API call, you may pass UpdateComponentTypeRequest
3165
- # data as a hash:
3166
- #
3167
- # {
3168
- # component_type_id: "ComponentTypeId", # required
3169
- # description: "Description",
3170
- # extends_from: ["ComponentTypeId"],
3171
- # functions: {
3172
- # "Name" => {
3173
- # implemented_by: {
3174
- # is_native: false,
3175
- # lambda: {
3176
- # arn: "LambdaArn", # required
3177
- # },
3178
- # },
3179
- # required_properties: ["Name"],
3180
- # scope: "ENTITY", # accepts ENTITY, WORKSPACE
3181
- # },
3182
- # },
3183
- # is_singleton: false,
3184
- # property_definitions: {
3185
- # "Name" => {
3186
- # configuration: {
3187
- # "Name" => "Value",
3188
- # },
3189
- # data_type: {
3190
- # allowed_values: [
3191
- # {
3192
- # boolean_value: false,
3193
- # double_value: 1.0,
3194
- # expression: "Expression",
3195
- # integer_value: 1,
3196
- # list_value: {
3197
- # # recursive DataValueList
3198
- # },
3199
- # long_value: 1,
3200
- # map_value: {
3201
- # "String" => {
3202
- # # recursive DataValue
3203
- # },
3204
- # },
3205
- # relationship_value: {
3206
- # target_component_name: "Name",
3207
- # target_entity_id: "EntityId",
3208
- # },
3209
- # string_value: "String",
3210
- # },
3211
- # ],
3212
- # nested_type: {
3213
- # # recursive DataType
3214
- # },
3215
- # relationship: {
3216
- # relationship_type: "String",
3217
- # target_component_type_id: "ComponentTypeId",
3218
- # },
3219
- # type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
3220
- # unit_of_measure: "String",
3221
- # },
3222
- # default_value: {
3223
- # boolean_value: false,
3224
- # double_value: 1.0,
3225
- # expression: "Expression",
3226
- # integer_value: 1,
3227
- # list_value: [
3228
- # {
3229
- # # recursive DataValue
3230
- # },
3231
- # ],
3232
- # long_value: 1,
3233
- # map_value: {
3234
- # "String" => {
3235
- # # recursive DataValue
3236
- # },
3237
- # },
3238
- # relationship_value: {
3239
- # target_component_name: "Name",
3240
- # target_entity_id: "EntityId",
3241
- # },
3242
- # string_value: "String",
3243
- # },
3244
- # is_external_id: false,
3245
- # is_required_in_entity: false,
3246
- # is_stored_externally: false,
3247
- # is_time_series: false,
3248
- # },
3249
- # },
3250
- # workspace_id: "Id", # required
3251
- # }
2795
+ # @!attribute [rw] workspace_id
2796
+ # The ID of the workspace.
2797
+ # @return [String]
2798
+ #
2799
+ # @!attribute [rw] is_singleton
2800
+ # A Boolean value that specifies whether an entity can have more than
2801
+ # one component of this type.
2802
+ # @return [Boolean]
3252
2803
  #
3253
2804
  # @!attribute [rw] component_type_id
3254
2805
  # The ID of the component type.
@@ -3258,6 +2809,12 @@ module Aws::IoTTwinMaker
3258
2809
  # The description of the component type.
3259
2810
  # @return [String]
3260
2811
  #
2812
+ # @!attribute [rw] property_definitions
2813
+ # An object that maps strings to the property definitions in the
2814
+ # component type. Each string in the mapping must be unique to this
2815
+ # object.
2816
+ # @return [Hash<String,Types::PropertyDefinitionRequest>]
2817
+ #
3261
2818
  # @!attribute [rw] extends_from
3262
2819
  # Specifies the component type that this component type extends.
3263
2820
  # @return [Array<String>]
@@ -3267,33 +2824,32 @@ module Aws::IoTTwinMaker
3267
2824
  # Each string in the mapping must be unique to this object.
3268
2825
  # @return [Hash<String,Types::FunctionRequest>]
3269
2826
  #
3270
- # @!attribute [rw] is_singleton
3271
- # A Boolean value that specifies whether an entity can have more than
3272
- # one component of this type.
3273
- # @return [Boolean]
3274
- #
3275
- # @!attribute [rw] property_definitions
3276
- # An object that maps strings to the property definitions in the
3277
- # component type. Each string in the mapping must be unique to this
3278
- # object.
3279
- # @return [Hash<String,Types::PropertyDefinitionRequest>]
2827
+ # @!attribute [rw] property_groups
2828
+ # The property groups
2829
+ # @return [Hash<String,Types::PropertyGroupRequest>]
3280
2830
  #
3281
- # @!attribute [rw] workspace_id
3282
- # The ID of the workspace that contains the component type.
2831
+ # @!attribute [rw] component_type_name
2832
+ # The component type name.
3283
2833
  # @return [String]
3284
2834
  #
3285
2835
  class UpdateComponentTypeRequest < Struct.new(
2836
+ :workspace_id,
2837
+ :is_singleton,
3286
2838
  :component_type_id,
3287
2839
  :description,
2840
+ :property_definitions,
3288
2841
  :extends_from,
3289
2842
  :functions,
3290
- :is_singleton,
3291
- :property_definitions,
3292
- :workspace_id)
2843
+ :property_groups,
2844
+ :component_type_name)
3293
2845
  SENSITIVE = []
3294
2846
  include Aws::Structure
3295
2847
  end
3296
2848
 
2849
+ # @!attribute [rw] workspace_id
2850
+ # The ID of the workspace that contains the component type.
2851
+ # @return [String]
2852
+ #
3297
2853
  # @!attribute [rw] arn
3298
2854
  # The ARN of the component type.
3299
2855
  # @return [String]
@@ -3306,138 +2862,17 @@ module Aws::IoTTwinMaker
3306
2862
  # The current state of the component type.
3307
2863
  # @return [String]
3308
2864
  #
3309
- # @!attribute [rw] workspace_id
3310
- # The ID of the workspace that contains the component type.
3311
- # @return [String]
3312
- #
3313
2865
  class UpdateComponentTypeResponse < Struct.new(
2866
+ :workspace_id,
3314
2867
  :arn,
3315
2868
  :component_type_id,
3316
- :state,
3317
- :workspace_id)
2869
+ :state)
3318
2870
  SENSITIVE = []
3319
2871
  include Aws::Structure
3320
2872
  end
3321
2873
 
3322
- # @note When making an API call, you may pass UpdateEntityRequest
3323
- # data as a hash:
3324
- #
3325
- # {
3326
- # component_updates: {
3327
- # "Name" => {
3328
- # component_type_id: "ComponentTypeId",
3329
- # description: "Description",
3330
- # property_updates: {
3331
- # "Name" => {
3332
- # definition: {
3333
- # configuration: {
3334
- # "Name" => "Value",
3335
- # },
3336
- # data_type: {
3337
- # allowed_values: [
3338
- # {
3339
- # boolean_value: false,
3340
- # double_value: 1.0,
3341
- # expression: "Expression",
3342
- # integer_value: 1,
3343
- # list_value: {
3344
- # # recursive DataValueList
3345
- # },
3346
- # long_value: 1,
3347
- # map_value: {
3348
- # "String" => {
3349
- # # recursive DataValue
3350
- # },
3351
- # },
3352
- # relationship_value: {
3353
- # target_component_name: "Name",
3354
- # target_entity_id: "EntityId",
3355
- # },
3356
- # string_value: "String",
3357
- # },
3358
- # ],
3359
- # nested_type: {
3360
- # # recursive DataType
3361
- # },
3362
- # relationship: {
3363
- # relationship_type: "String",
3364
- # target_component_type_id: "ComponentTypeId",
3365
- # },
3366
- # type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
3367
- # unit_of_measure: "String",
3368
- # },
3369
- # default_value: {
3370
- # boolean_value: false,
3371
- # double_value: 1.0,
3372
- # expression: "Expression",
3373
- # integer_value: 1,
3374
- # list_value: [
3375
- # {
3376
- # # recursive DataValue
3377
- # },
3378
- # ],
3379
- # long_value: 1,
3380
- # map_value: {
3381
- # "String" => {
3382
- # # recursive DataValue
3383
- # },
3384
- # },
3385
- # relationship_value: {
3386
- # target_component_name: "Name",
3387
- # target_entity_id: "EntityId",
3388
- # },
3389
- # string_value: "String",
3390
- # },
3391
- # is_external_id: false,
3392
- # is_required_in_entity: false,
3393
- # is_stored_externally: false,
3394
- # is_time_series: false,
3395
- # },
3396
- # update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
3397
- # value: {
3398
- # boolean_value: false,
3399
- # double_value: 1.0,
3400
- # expression: "Expression",
3401
- # integer_value: 1,
3402
- # list_value: [
3403
- # {
3404
- # # recursive DataValue
3405
- # },
3406
- # ],
3407
- # long_value: 1,
3408
- # map_value: {
3409
- # "String" => {
3410
- # # recursive DataValue
3411
- # },
3412
- # },
3413
- # relationship_value: {
3414
- # target_component_name: "Name",
3415
- # target_entity_id: "EntityId",
3416
- # },
3417
- # string_value: "String",
3418
- # },
3419
- # },
3420
- # },
3421
- # update_type: "CREATE", # accepts CREATE, UPDATE, DELETE
3422
- # },
3423
- # },
3424
- # description: "Description",
3425
- # entity_id: "EntityId", # required
3426
- # entity_name: "EntityName",
3427
- # parent_entity_update: {
3428
- # parent_entity_id: "ParentEntityId",
3429
- # update_type: "UPDATE", # required, accepts UPDATE, DELETE
3430
- # },
3431
- # workspace_id: "Id", # required
3432
- # }
3433
- #
3434
- # @!attribute [rw] component_updates
3435
- # An object that maps strings to the component updates in the request.
3436
- # Each string in the mapping must be unique to this object.
3437
- # @return [Hash<String,Types::ComponentUpdateRequest>]
3438
- #
3439
- # @!attribute [rw] description
3440
- # The description of the entity.
2874
+ # @!attribute [rw] workspace_id
2875
+ # The ID of the workspace that contains the entity.
3441
2876
  # @return [String]
3442
2877
  #
3443
2878
  # @!attribute [rw] entity_id
@@ -3448,55 +2883,83 @@ module Aws::IoTTwinMaker
3448
2883
  # The name of the entity.
3449
2884
  # @return [String]
3450
2885
  #
2886
+ # @!attribute [rw] description
2887
+ # The description of the entity.
2888
+ # @return [String]
2889
+ #
2890
+ # @!attribute [rw] component_updates
2891
+ # An object that maps strings to the component updates in the request.
2892
+ # Each string in the mapping must be unique to this object.
2893
+ # @return [Hash<String,Types::ComponentUpdateRequest>]
2894
+ #
3451
2895
  # @!attribute [rw] parent_entity_update
3452
2896
  # An object that describes the update request for a parent entity.
3453
2897
  # @return [Types::ParentEntityUpdateRequest]
3454
2898
  #
3455
- # @!attribute [rw] workspace_id
3456
- # The ID of the workspace that contains the entity.
3457
- # @return [String]
3458
- #
3459
2899
  class UpdateEntityRequest < Struct.new(
3460
- :component_updates,
3461
- :description,
2900
+ :workspace_id,
3462
2901
  :entity_id,
3463
2902
  :entity_name,
3464
- :parent_entity_update,
3465
- :workspace_id)
2903
+ :description,
2904
+ :component_updates,
2905
+ :parent_entity_update)
3466
2906
  SENSITIVE = []
3467
2907
  include Aws::Structure
3468
2908
  end
3469
2909
 
3470
- # @!attribute [rw] state
3471
- # The current state of the entity update.
3472
- # @return [String]
3473
- #
3474
2910
  # @!attribute [rw] update_date_time
3475
2911
  # The date and time when the entity was last updated.
3476
2912
  # @return [Time]
3477
2913
  #
2914
+ # @!attribute [rw] state
2915
+ # The current state of the entity update.
2916
+ # @return [String]
2917
+ #
3478
2918
  class UpdateEntityResponse < Struct.new(
3479
- :state,
3480
- :update_date_time)
2919
+ :update_date_time,
2920
+ :state)
3481
2921
  SENSITIVE = []
3482
2922
  include Aws::Structure
3483
2923
  end
3484
2924
 
3485
- # @note When making an API call, you may pass UpdateSceneRequest
3486
- # data as a hash:
3487
- #
3488
- # {
3489
- # capabilities: ["SceneCapability"],
3490
- # content_location: "S3Url",
3491
- # description: "Description",
3492
- # scene_id: "Id", # required
3493
- # workspace_id: "Id", # required
3494
- # }
2925
+ # @!attribute [rw] pricing_mode
2926
+ # The pricing mode.
2927
+ # @return [String]
3495
2928
  #
3496
- # @!attribute [rw] capabilities
3497
- # A list of capabilities that the scene uses to render.
2929
+ # @!attribute [rw] bundle_names
2930
+ # The bundle names.
3498
2931
  # @return [Array<String>]
3499
2932
  #
2933
+ class UpdatePricingPlanRequest < Struct.new(
2934
+ :pricing_mode,
2935
+ :bundle_names)
2936
+ SENSITIVE = []
2937
+ include Aws::Structure
2938
+ end
2939
+
2940
+ # @!attribute [rw] current_pricing_plan
2941
+ # Update the current pricing plan.
2942
+ # @return [Types::PricingPlan]
2943
+ #
2944
+ # @!attribute [rw] pending_pricing_plan
2945
+ # Update the pending pricing plan.
2946
+ # @return [Types::PricingPlan]
2947
+ #
2948
+ class UpdatePricingPlanResponse < Struct.new(
2949
+ :current_pricing_plan,
2950
+ :pending_pricing_plan)
2951
+ SENSITIVE = []
2952
+ include Aws::Structure
2953
+ end
2954
+
2955
+ # @!attribute [rw] workspace_id
2956
+ # The ID of the workspace that contains the scene.
2957
+ # @return [String]
2958
+ #
2959
+ # @!attribute [rw] scene_id
2960
+ # The ID of the scene.
2961
+ # @return [String]
2962
+ #
3500
2963
  # @!attribute [rw] content_location
3501
2964
  # The relative path that specifies the location of the content
3502
2965
  # definition file.
@@ -3506,20 +2969,16 @@ module Aws::IoTTwinMaker
3506
2969
  # The description of this scene.
3507
2970
  # @return [String]
3508
2971
  #
3509
- # @!attribute [rw] scene_id
3510
- # The ID of the scene.
3511
- # @return [String]
3512
- #
3513
- # @!attribute [rw] workspace_id
3514
- # The ID of the workspace that contains the scene.
3515
- # @return [String]
2972
+ # @!attribute [rw] capabilities
2973
+ # A list of capabilities that the scene uses to render.
2974
+ # @return [Array<String>]
3516
2975
  #
3517
2976
  class UpdateSceneRequest < Struct.new(
3518
- :capabilities,
2977
+ :workspace_id,
2978
+ :scene_id,
3519
2979
  :content_location,
3520
2980
  :description,
3521
- :scene_id,
3522
- :workspace_id)
2981
+ :capabilities)
3523
2982
  SENSITIVE = []
3524
2983
  include Aws::Structure
3525
2984
  end
@@ -3534,14 +2993,9 @@ module Aws::IoTTwinMaker
3534
2993
  include Aws::Structure
3535
2994
  end
3536
2995
 
3537
- # @note When making an API call, you may pass UpdateWorkspaceRequest
3538
- # data as a hash:
3539
- #
3540
- # {
3541
- # description: "Description",
3542
- # role: "RoleArn",
3543
- # workspace_id: "Id", # required
3544
- # }
2996
+ # @!attribute [rw] workspace_id
2997
+ # The ID of the workspace.
2998
+ # @return [String]
3545
2999
  #
3546
3000
  # @!attribute [rw] description
3547
3001
  # The description of the workspace.
@@ -3551,14 +3005,10 @@ module Aws::IoTTwinMaker
3551
3005
  # The ARN of the execution role associated with the workspace.
3552
3006
  # @return [String]
3553
3007
  #
3554
- # @!attribute [rw] workspace_id
3555
- # The ID of the workspace.
3556
- # @return [String]
3557
- #
3558
3008
  class UpdateWorkspaceRequest < Struct.new(
3009
+ :workspace_id,
3559
3010
  :description,
3560
- :role,
3561
- :workspace_id)
3011
+ :role)
3562
3012
  SENSITIVE = []
3563
3013
  include Aws::Structure
3564
3014
  end
@@ -3586,32 +3036,32 @@ module Aws::IoTTwinMaker
3586
3036
 
3587
3037
  # An object that contains information about a workspace.
3588
3038
  #
3039
+ # @!attribute [rw] workspace_id
3040
+ # The ID of the workspace.
3041
+ # @return [String]
3042
+ #
3589
3043
  # @!attribute [rw] arn
3590
3044
  # The ARN of the workspace.
3591
3045
  # @return [String]
3592
3046
  #
3593
- # @!attribute [rw] creation_date_time
3594
- # The date and time when the workspace was created.
3595
- # @return [Time]
3596
- #
3597
3047
  # @!attribute [rw] description
3598
3048
  # The description of the workspace.
3599
3049
  # @return [String]
3600
3050
  #
3051
+ # @!attribute [rw] creation_date_time
3052
+ # The date and time when the workspace was created.
3053
+ # @return [Time]
3054
+ #
3601
3055
  # @!attribute [rw] update_date_time
3602
3056
  # The date and time when the workspace was last updated.
3603
3057
  # @return [Time]
3604
3058
  #
3605
- # @!attribute [rw] workspace_id
3606
- # The ID of the workspace.
3607
- # @return [String]
3608
- #
3609
3059
  class WorkspaceSummary < Struct.new(
3060
+ :workspace_id,
3610
3061
  :arn,
3611
- :creation_date_time,
3612
3062
  :description,
3613
- :update_date_time,
3614
- :workspace_id)
3063
+ :creation_date_time,
3064
+ :update_date_time)
3615
3065
  SENSITIVE = []
3616
3066
  include Aws::Structure
3617
3067
  end