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