aws-sdk-iottwinmaker 1.16.0 → 1.18.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.
@@ -101,6 +101,46 @@ module Aws::IoTTwinMaker
101
101
  include Aws::Structure
102
102
  end
103
103
 
104
+ # @!attribute [rw] metadata_transfer_job_id
105
+ # The metadata transfer job Id.
106
+ # @return [String]
107
+ #
108
+ class CancelMetadataTransferJobRequest < Struct.new(
109
+ :metadata_transfer_job_id)
110
+ SENSITIVE = []
111
+ include Aws::Structure
112
+ end
113
+
114
+ # @!attribute [rw] metadata_transfer_job_id
115
+ # The metadata transfer job Id.
116
+ # @return [String]
117
+ #
118
+ # @!attribute [rw] arn
119
+ # The metadata transfer job ARN.
120
+ # @return [String]
121
+ #
122
+ # @!attribute [rw] update_date_time
123
+ # Used to update the DateTime property.
124
+ # @return [Time]
125
+ #
126
+ # @!attribute [rw] status
127
+ # The metadata transfer job's status.
128
+ # @return [Types::MetadataTransferJobStatus]
129
+ #
130
+ # @!attribute [rw] progress
131
+ # The metadata transfer job's progress.
132
+ # @return [Types::MetadataTransferJobProgress]
133
+ #
134
+ class CancelMetadataTransferJobResponse < Struct.new(
135
+ :metadata_transfer_job_id,
136
+ :arn,
137
+ :update_date_time,
138
+ :status,
139
+ :progress)
140
+ SENSITIVE = []
141
+ include Aws::Structure
142
+ end
143
+
104
144
  # A description of the column in the query results.
105
145
  #
106
146
  # @!attribute [rw] name
@@ -231,6 +271,22 @@ module Aws::IoTTwinMaker
231
271
  # job.
232
272
  # @return [String]
233
273
  #
274
+ # @!attribute [rw] are_all_properties_returned
275
+ # This flag notes whether all properties of the component are returned
276
+ # in the API response. The maximum number of properties returned is
277
+ # 800.
278
+ # @return [Boolean]
279
+ #
280
+ # @!attribute [rw] composite_components
281
+ # This lists objects that contain information about the
282
+ # `compositeComponents`.
283
+ # @return [Hash<String,Types::ComponentSummary>]
284
+ #
285
+ # @!attribute [rw] are_all_composite_components_returned
286
+ # This flag notes whether all `compositeComponents` are returned in
287
+ # the API response.
288
+ # @return [Boolean]
289
+ #
234
290
  class ComponentResponse < Struct.new(
235
291
  :component_name,
236
292
  :description,
@@ -239,7 +295,59 @@ module Aws::IoTTwinMaker
239
295
  :defined_in,
240
296
  :properties,
241
297
  :property_groups,
242
- :sync_source)
298
+ :sync_source,
299
+ :are_all_properties_returned,
300
+ :composite_components,
301
+ :are_all_composite_components_returned)
302
+ SENSITIVE = []
303
+ include Aws::Structure
304
+ end
305
+
306
+ # An object that returns information about a component summary.
307
+ #
308
+ # @!attribute [rw] component_name
309
+ # The name of the component.
310
+ # @return [String]
311
+ #
312
+ # @!attribute [rw] component_type_id
313
+ # The ID of the component type.
314
+ # @return [String]
315
+ #
316
+ # @!attribute [rw] defined_in
317
+ # The name of the property definition set in the request.
318
+ # @return [String]
319
+ #
320
+ # @!attribute [rw] description
321
+ # The description of the component request.
322
+ # @return [String]
323
+ #
324
+ # @!attribute [rw] property_groups
325
+ # The property groups.
326
+ # @return [Hash<String,Types::ComponentPropertyGroupResponse>]
327
+ #
328
+ # @!attribute [rw] status
329
+ # The status of the component type.
330
+ # @return [Types::Status]
331
+ #
332
+ # @!attribute [rw] sync_source
333
+ # The `syncSource` of the sync job, if this entity was created by a
334
+ # sync job.
335
+ # @return [String]
336
+ #
337
+ # @!attribute [rw] component_path
338
+ # This string specifies the path to the composite component, starting
339
+ # from the top-level component.
340
+ # @return [String]
341
+ #
342
+ class ComponentSummary < Struct.new(
343
+ :component_name,
344
+ :component_type_id,
345
+ :defined_in,
346
+ :description,
347
+ :property_groups,
348
+ :status,
349
+ :sync_source,
350
+ :component_path)
243
351
  SENSITIVE = []
244
352
  include Aws::Structure
245
353
  end
@@ -320,6 +428,95 @@ module Aws::IoTTwinMaker
320
428
  include Aws::Structure
321
429
  end
322
430
 
431
+ # An object that sets information about the composite component update
432
+ # request.
433
+ #
434
+ # @!attribute [rw] description
435
+ # The description of the component type.
436
+ # @return [String]
437
+ #
438
+ # @!attribute [rw] properties
439
+ # This is an object that maps strings to the properties to set in the
440
+ # component type. Each string in the mapping must be unique to this
441
+ # object.
442
+ # @return [Hash<String,Types::PropertyRequest>]
443
+ #
444
+ # @!attribute [rw] property_groups
445
+ # The property groups.
446
+ # @return [Hash<String,Types::ComponentPropertyGroupRequest>]
447
+ #
448
+ class CompositeComponentRequest < Struct.new(
449
+ :description,
450
+ :properties,
451
+ :property_groups)
452
+ SENSITIVE = []
453
+ include Aws::Structure
454
+ end
455
+
456
+ # An object that sets information about the composite component types of
457
+ # a component type.
458
+ #
459
+ # @!attribute [rw] component_type_id
460
+ # This is the `componentTypeId` that the `compositeComponentType`
461
+ # refers to.
462
+ # @return [String]
463
+ #
464
+ class CompositeComponentTypeRequest < Struct.new(
465
+ :component_type_id)
466
+ SENSITIVE = []
467
+ include Aws::Structure
468
+ end
469
+
470
+ # An object that returns information about the composite component types
471
+ # of a component type.
472
+ #
473
+ # @!attribute [rw] component_type_id
474
+ # This is the `componentTypeId` that this `compositeComponentType`
475
+ # refers to.
476
+ # @return [String]
477
+ #
478
+ # @!attribute [rw] is_inherited
479
+ # This boolean indicates whether this `compositeComponentType` is
480
+ # inherited from its parent.
481
+ # @return [Boolean]
482
+ #
483
+ class CompositeComponentTypeResponse < Struct.new(
484
+ :component_type_id,
485
+ :is_inherited)
486
+ SENSITIVE = []
487
+ include Aws::Structure
488
+ end
489
+
490
+ # An object that sets information about the composite component update
491
+ # request.
492
+ #
493
+ # @!attribute [rw] update_type
494
+ # The update type of the component update request.
495
+ # @return [String]
496
+ #
497
+ # @!attribute [rw] description
498
+ # The description of the component type.
499
+ # @return [String]
500
+ #
501
+ # @!attribute [rw] property_updates
502
+ # An object that maps strings to the properties to set in the
503
+ # component type update. Each string in the mapping must be unique to
504
+ # this object.
505
+ # @return [Hash<String,Types::PropertyRequest>]
506
+ #
507
+ # @!attribute [rw] property_group_updates
508
+ # The property group updates.
509
+ # @return [Hash<String,Types::ComponentPropertyGroupRequest>]
510
+ #
511
+ class CompositeComponentUpdateRequest < Struct.new(
512
+ :update_type,
513
+ :description,
514
+ :property_updates,
515
+ :property_group_updates)
516
+ SENSITIVE = []
517
+ include Aws::Structure
518
+ end
519
+
323
520
  # A conflict occurred.
324
521
  #
325
522
  # @!attribute [rw] message
@@ -396,6 +593,12 @@ module Aws::IoTTwinMaker
396
593
  # A friendly name for the component type.
397
594
  # @return [String]
398
595
  #
596
+ # @!attribute [rw] composite_component_types
597
+ # This is an object that maps strings to `compositeComponentTypes` of
598
+ # the `componentType`. `CompositeComponentType` is referenced by
599
+ # `componentTypeId`.
600
+ # @return [Hash<String,Types::CompositeComponentTypeRequest>]
601
+ #
399
602
  class CreateComponentTypeRequest < Struct.new(
400
603
  :workspace_id,
401
604
  :is_singleton,
@@ -406,7 +609,8 @@ module Aws::IoTTwinMaker
406
609
  :functions,
407
610
  :tags,
408
611
  :property_groups,
409
- :component_type_name)
612
+ :component_type_name,
613
+ :composite_component_types)
410
614
  SENSITIVE = []
411
615
  include Aws::Structure
412
616
  end
@@ -452,6 +656,12 @@ module Aws::IoTTwinMaker
452
656
  # string in the mapping must be unique to this object.
453
657
  # @return [Hash<String,Types::ComponentRequest>]
454
658
  #
659
+ # @!attribute [rw] composite_components
660
+ # This is an object that maps strings to `compositeComponent` updates
661
+ # in the request. Each key of the map represents the `componentPath`
662
+ # of the `compositeComponent`.
663
+ # @return [Hash<String,Types::CompositeComponentRequest>]
664
+ #
455
665
  # @!attribute [rw] parent_entity_id
456
666
  # The ID of the entity's parent entity.
457
667
  # @return [String]
@@ -466,6 +676,7 @@ module Aws::IoTTwinMaker
466
676
  :entity_name,
467
677
  :description,
468
678
  :components,
679
+ :composite_components,
469
680
  :parent_entity_id,
470
681
  :tags)
471
682
  SENSITIVE = []
@@ -497,6 +708,56 @@ module Aws::IoTTwinMaker
497
708
  include Aws::Structure
498
709
  end
499
710
 
711
+ # @!attribute [rw] metadata_transfer_job_id
712
+ # The metadata transfer job Id.
713
+ # @return [String]
714
+ #
715
+ # @!attribute [rw] description
716
+ # The metadata transfer job description.
717
+ # @return [String]
718
+ #
719
+ # @!attribute [rw] sources
720
+ # The metadata transfer job sources.
721
+ # @return [Array<Types::SourceConfiguration>]
722
+ #
723
+ # @!attribute [rw] destination
724
+ # The metadata transfer job destination.
725
+ # @return [Types::DestinationConfiguration]
726
+ #
727
+ class CreateMetadataTransferJobRequest < Struct.new(
728
+ :metadata_transfer_job_id,
729
+ :description,
730
+ :sources,
731
+ :destination)
732
+ SENSITIVE = []
733
+ include Aws::Structure
734
+ end
735
+
736
+ # @!attribute [rw] metadata_transfer_job_id
737
+ # The metadata transfer job Id.
738
+ # @return [String]
739
+ #
740
+ # @!attribute [rw] arn
741
+ # The metadata transfer job ARN.
742
+ # @return [String]
743
+ #
744
+ # @!attribute [rw] creation_date_time
745
+ # The The metadata transfer job creation DateTime property.
746
+ # @return [Time]
747
+ #
748
+ # @!attribute [rw] status
749
+ # The metadata transfer job response status.
750
+ # @return [Types::MetadataTransferJobStatus]
751
+ #
752
+ class CreateMetadataTransferJobResponse < Struct.new(
753
+ :metadata_transfer_job_id,
754
+ :arn,
755
+ :creation_date_time,
756
+ :status)
757
+ SENSITIVE = []
758
+ include Aws::Structure
759
+ end
760
+
500
761
  # @!attribute [rw] workspace_id
501
762
  # The ID of the workspace that contains the scene.
502
763
  # @return [String]
@@ -864,7 +1125,40 @@ module Aws::IoTTwinMaker
864
1125
  include Aws::Structure
865
1126
  end
866
1127
 
867
- class DeleteWorkspaceResponse < Aws::EmptyStructure; end
1128
+ # @!attribute [rw] message
1129
+ # The string that specifies the delete result for the workspace.
1130
+ # @return [String]
1131
+ #
1132
+ class DeleteWorkspaceResponse < Struct.new(
1133
+ :message)
1134
+ SENSITIVE = []
1135
+ include Aws::Structure
1136
+ end
1137
+
1138
+ # The \[link to action\] metadata transfer job destination
1139
+ # configuration.
1140
+ #
1141
+ # @!attribute [rw] type
1142
+ # The destination type.
1143
+ # @return [String]
1144
+ #
1145
+ # @!attribute [rw] s3_configuration
1146
+ # The metadata transfer job S3 configuration. \[need to add S3
1147
+ # entity\]
1148
+ # @return [Types::S3DestinationConfiguration]
1149
+ #
1150
+ # @!attribute [rw] iot_twin_maker_configuration
1151
+ # The metadata transfer job Amazon Web Services IoT TwinMaker
1152
+ # configuration.
1153
+ # @return [Types::IotTwinMakerDestinationConfiguration]
1154
+ #
1155
+ class DestinationConfiguration < Struct.new(
1156
+ :type,
1157
+ :s3_configuration,
1158
+ :iot_twin_maker_configuration)
1159
+ SENSITIVE = []
1160
+ include Aws::Structure
1161
+ end
868
1162
 
869
1163
  # An object that uniquely identifies an entity property.
870
1164
  #
@@ -872,6 +1166,11 @@ module Aws::IoTTwinMaker
872
1166
  # The name of the component.
873
1167
  # @return [String]
874
1168
  #
1169
+ # @!attribute [rw] component_path
1170
+ # This string specifies the path to the composite component, starting
1171
+ # from the top-level component.
1172
+ # @return [String]
1173
+ #
875
1174
  # @!attribute [rw] external_id_property
876
1175
  # A mapping of external IDs to property names. External IDs uniquely
877
1176
  # identify properties from external data stores.
@@ -887,6 +1186,7 @@ module Aws::IoTTwinMaker
887
1186
  #
888
1187
  class EntityPropertyReference < Struct.new(
889
1188
  :component_name,
1189
+ :component_path,
890
1190
  :external_id_property,
891
1191
  :entity_id,
892
1192
  :property_name)
@@ -921,8 +1221,8 @@ module Aws::IoTTwinMaker
921
1221
  # @return [String]
922
1222
  #
923
1223
  # @!attribute [rw] has_child_entities
924
- # A Boolean value that specifies whether the entity has child entities
925
- # or not.
1224
+ # An **eventual** Boolean value that specifies whether the entity has
1225
+ # child entities or not.
926
1226
  # @return [Boolean]
927
1227
  #
928
1228
  # @!attribute [rw] creation_date_time
@@ -974,9 +1274,7 @@ module Aws::IoTTwinMaker
974
1274
  #
975
1275
  # @!attribute [rw] max_results
976
1276
  # The maximum number of results to return at one time. The default is
977
- # 25.
978
- #
979
- # Valid Range: Minimum value of 1. Maximum value of 250.
1277
+ # 50.
980
1278
  # @return [Integer]
981
1279
  #
982
1280
  # @!attribute [rw] next_token
@@ -1012,6 +1310,84 @@ module Aws::IoTTwinMaker
1012
1310
  include Aws::Structure
1013
1311
  end
1014
1312
 
1313
+ # Filter by asset. \[TwinMaker asset\]
1314
+ #
1315
+ # @!attribute [rw] asset_id
1316
+ # Filter by asset Id.
1317
+ # @return [String]
1318
+ #
1319
+ # @!attribute [rw] asset_external_id
1320
+ # The external-Id property of an asset.
1321
+ # @return [String]
1322
+ #
1323
+ # @!attribute [rw] include_offspring
1324
+ # Includes sub-assets.\[need description hekp for this\]
1325
+ # @return [Boolean]
1326
+ #
1327
+ # @!attribute [rw] include_asset_model
1328
+ # Boolean to include the asset model.
1329
+ # @return [Boolean]
1330
+ #
1331
+ class FilterByAsset < Struct.new(
1332
+ :asset_id,
1333
+ :asset_external_id,
1334
+ :include_offspring,
1335
+ :include_asset_model)
1336
+ SENSITIVE = []
1337
+ include Aws::Structure
1338
+ end
1339
+
1340
+ # Filter by asset model.
1341
+ #
1342
+ # @!attribute [rw] asset_model_id
1343
+ # The asset model Id.
1344
+ # @return [String]
1345
+ #
1346
+ # @!attribute [rw] asset_model_external_id
1347
+ # The external-Id property of an asset model.
1348
+ # @return [String]
1349
+ #
1350
+ # @!attribute [rw] include_offspring
1351
+ # Include asset offspring. \[need desc.\]
1352
+ # @return [Boolean]
1353
+ #
1354
+ # @!attribute [rw] include_assets
1355
+ # Bolean to include assets.
1356
+ # @return [Boolean]
1357
+ #
1358
+ class FilterByAssetModel < Struct.new(
1359
+ :asset_model_id,
1360
+ :asset_model_external_id,
1361
+ :include_offspring,
1362
+ :include_assets)
1363
+ SENSITIVE = []
1364
+ include Aws::Structure
1365
+ end
1366
+
1367
+ # Filter by component type.
1368
+ #
1369
+ # @!attribute [rw] component_type_id
1370
+ # The component type Id.
1371
+ # @return [String]
1372
+ #
1373
+ class FilterByComponentType < Struct.new(
1374
+ :component_type_id)
1375
+ SENSITIVE = []
1376
+ include Aws::Structure
1377
+ end
1378
+
1379
+ # Vilter by entity.
1380
+ #
1381
+ # @!attribute [rw] entity_id
1382
+ # The entity Id.
1383
+ # @return [String]
1384
+ #
1385
+ class FilterByEntity < Struct.new(
1386
+ :entity_id)
1387
+ SENSITIVE = []
1388
+ include Aws::Structure
1389
+ end
1390
+
1015
1391
  # The function request body.
1016
1392
  #
1017
1393
  # @!attribute [rw] required_properties
@@ -1151,6 +1527,12 @@ module Aws::IoTTwinMaker
1151
1527
  # The component type name.
1152
1528
  # @return [String]
1153
1529
  #
1530
+ # @!attribute [rw] composite_component_types
1531
+ # This is an object that maps strings to `compositeComponentTypes` of
1532
+ # the `componentType`. `CompositeComponentType` is referenced by
1533
+ # `componentTypeId`.
1534
+ # @return [Hash<String,Types::CompositeComponentTypeResponse>]
1535
+ #
1154
1536
  class GetComponentTypeResponse < Struct.new(
1155
1537
  :workspace_id,
1156
1538
  :is_singleton,
@@ -1167,7 +1549,8 @@ module Aws::IoTTwinMaker
1167
1549
  :status,
1168
1550
  :property_groups,
1169
1551
  :sync_source,
1170
- :component_type_name)
1552
+ :component_type_name,
1553
+ :composite_component_types)
1171
1554
  SENSITIVE = []
1172
1555
  include Aws::Structure
1173
1556
  end
@@ -1238,6 +1621,11 @@ module Aws::IoTTwinMaker
1238
1621
  # job.
1239
1622
  # @return [String]
1240
1623
  #
1624
+ # @!attribute [rw] are_all_components_returned
1625
+ # This flag notes whether all components are returned in the API
1626
+ # response. The maximum number of components returned is 30.
1627
+ # @return [Boolean]
1628
+ #
1241
1629
  class GetEntityResponse < Struct.new(
1242
1630
  :entity_id,
1243
1631
  :entity_name,
@@ -1250,7 +1638,78 @@ module Aws::IoTTwinMaker
1250
1638
  :has_child_entities,
1251
1639
  :creation_date_time,
1252
1640
  :update_date_time,
1253
- :sync_source)
1641
+ :sync_source,
1642
+ :are_all_components_returned)
1643
+ SENSITIVE = []
1644
+ include Aws::Structure
1645
+ end
1646
+
1647
+ # @!attribute [rw] metadata_transfer_job_id
1648
+ # The metadata transfer job Id.
1649
+ # @return [String]
1650
+ #
1651
+ class GetMetadataTransferJobRequest < Struct.new(
1652
+ :metadata_transfer_job_id)
1653
+ SENSITIVE = []
1654
+ include Aws::Structure
1655
+ end
1656
+
1657
+ # @!attribute [rw] metadata_transfer_job_id
1658
+ # The metadata transfer job Id.
1659
+ # @return [String]
1660
+ #
1661
+ # @!attribute [rw] arn
1662
+ # The metadata transfer job ARN.
1663
+ # @return [String]
1664
+ #
1665
+ # @!attribute [rw] description
1666
+ # The metadata transfer job description.
1667
+ # @return [String]
1668
+ #
1669
+ # @!attribute [rw] sources
1670
+ # The metadata transfer job's sources.
1671
+ # @return [Array<Types::SourceConfiguration>]
1672
+ #
1673
+ # @!attribute [rw] destination
1674
+ # The metadata transfer job's destination.
1675
+ # @return [Types::DestinationConfiguration]
1676
+ #
1677
+ # @!attribute [rw] metadata_transfer_job_role
1678
+ # The metadata transfer job's role.
1679
+ # @return [String]
1680
+ #
1681
+ # @!attribute [rw] report_url
1682
+ # The metadata transfer job's report URL.
1683
+ # @return [String]
1684
+ #
1685
+ # @!attribute [rw] creation_date_time
1686
+ # The metadata transfer job's creation DateTime property.
1687
+ # @return [Time]
1688
+ #
1689
+ # @!attribute [rw] update_date_time
1690
+ # The metadata transfer job's update DateTime property.
1691
+ # @return [Time]
1692
+ #
1693
+ # @!attribute [rw] status
1694
+ # The metadata transfer job's status.
1695
+ # @return [Types::MetadataTransferJobStatus]
1696
+ #
1697
+ # @!attribute [rw] progress
1698
+ # The metadata transfer job's progress.
1699
+ # @return [Types::MetadataTransferJobProgress]
1700
+ #
1701
+ class GetMetadataTransferJobResponse < Struct.new(
1702
+ :metadata_transfer_job_id,
1703
+ :arn,
1704
+ :description,
1705
+ :sources,
1706
+ :destination,
1707
+ :metadata_transfer_job_role,
1708
+ :report_url,
1709
+ :creation_date_time,
1710
+ :update_date_time,
1711
+ :status,
1712
+ :progress)
1254
1713
  SENSITIVE = []
1255
1714
  include Aws::Structure
1256
1715
  end
@@ -1286,6 +1745,11 @@ module Aws::IoTTwinMaker
1286
1745
  # The name of the component.
1287
1746
  # @return [String]
1288
1747
  #
1748
+ # @!attribute [rw] component_path
1749
+ # This string specifies the path to the composite component, starting
1750
+ # from the top-level component.
1751
+ # @return [String]
1752
+ #
1289
1753
  # @!attribute [rw] component_type_id
1290
1754
  # The ID of the component type.
1291
1755
  # @return [String]
@@ -1352,6 +1816,7 @@ module Aws::IoTTwinMaker
1352
1816
  :workspace_id,
1353
1817
  :entity_id,
1354
1818
  :component_name,
1819
+ :component_path,
1355
1820
  :component_type_id,
1356
1821
  :selected_properties,
1357
1822
  :property_filters,
@@ -1389,6 +1854,11 @@ module Aws::IoTTwinMaker
1389
1854
  # returns.
1390
1855
  # @return [String]
1391
1856
  #
1857
+ # @!attribute [rw] component_path
1858
+ # This string specifies the path to the composite component, starting
1859
+ # from the top-level component.
1860
+ # @return [String]
1861
+ #
1392
1862
  # @!attribute [rw] component_type_id
1393
1863
  # The ID of the component type whose property values the operation
1394
1864
  # returns.
@@ -1427,6 +1897,7 @@ module Aws::IoTTwinMaker
1427
1897
  #
1428
1898
  class GetPropertyValueRequest < Struct.new(
1429
1899
  :component_name,
1900
+ :component_path,
1430
1901
  :component_type_id,
1431
1902
  :entity_id,
1432
1903
  :selected_properties,
@@ -1622,6 +2093,10 @@ module Aws::IoTTwinMaker
1622
2093
  # The description of the workspace.
1623
2094
  # @return [String]
1624
2095
  #
2096
+ # @!attribute [rw] linked_services
2097
+ # A list of services that are linked to the workspace.
2098
+ # @return [Array<String>]
2099
+ #
1625
2100
  # @!attribute [rw] s3_location
1626
2101
  # The ARN of the S3 bucket where resources associated with the
1627
2102
  # workspace are stored.
@@ -1643,6 +2118,7 @@ module Aws::IoTTwinMaker
1643
2118
  :workspace_id,
1644
2119
  :arn,
1645
2120
  :description,
2121
+ :linked_services,
1646
2122
  :s3_location,
1647
2123
  :role,
1648
2124
  :creation_date_time,
@@ -1651,32 +2127,130 @@ module Aws::IoTTwinMaker
1651
2127
  include Aws::Structure
1652
2128
  end
1653
2129
 
1654
- # An unexpected error has occurred.
2130
+ # An unexpected error has occurred.
2131
+ #
2132
+ # @!attribute [rw] message
2133
+ # @return [String]
2134
+ #
2135
+ class InternalServerException < Struct.new(
2136
+ :message)
2137
+ SENSITIVE = []
2138
+ include Aws::Structure
2139
+ end
2140
+
2141
+ # An object that specifies how to interpolate data in a list.
2142
+ #
2143
+ # @!attribute [rw] interpolation_type
2144
+ # The interpolation type.
2145
+ # @return [String]
2146
+ #
2147
+ # @!attribute [rw] interval_in_seconds
2148
+ # The interpolation time interval in seconds.
2149
+ # @return [Integer]
2150
+ #
2151
+ class InterpolationParameters < Struct.new(
2152
+ :interpolation_type,
2153
+ :interval_in_seconds)
2154
+ SENSITIVE = []
2155
+ include Aws::Structure
2156
+ end
2157
+
2158
+ # The metadata transfer job AWS IoT SiteWise source configuration.
2159
+ #
2160
+ # @!attribute [rw] filters
2161
+ # The AWS IoT SiteWise soucre configuration filters.
2162
+ # @return [Array<Types::IotSiteWiseSourceConfigurationFilter>]
2163
+ #
2164
+ class IotSiteWiseSourceConfiguration < Struct.new(
2165
+ :filters)
2166
+ SENSITIVE = []
2167
+ include Aws::Structure
2168
+ end
2169
+
2170
+ # The AWS IoT SiteWise soucre configuration filter.\[need held with desc
2171
+ # here\]
2172
+ #
2173
+ # @note IotSiteWiseSourceConfigurationFilter is a union - when making an API calls you must set exactly one of the members.
2174
+ #
2175
+ # @note IotSiteWiseSourceConfigurationFilter is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IotSiteWiseSourceConfigurationFilter corresponding to the set member.
2176
+ #
2177
+ # @!attribute [rw] filter_by_asset_model
2178
+ # Filter by asset model.
2179
+ # @return [Types::FilterByAssetModel]
2180
+ #
2181
+ # @!attribute [rw] filter_by_asset
2182
+ # Filter by asset.
2183
+ # @return [Types::FilterByAsset]
2184
+ #
2185
+ class IotSiteWiseSourceConfigurationFilter < Struct.new(
2186
+ :filter_by_asset_model,
2187
+ :filter_by_asset,
2188
+ :unknown)
2189
+ SENSITIVE = []
2190
+ include Aws::Structure
2191
+ include Aws::Structure::Union
2192
+
2193
+ class FilterByAssetModel < IotSiteWiseSourceConfigurationFilter; end
2194
+ class FilterByAsset < IotSiteWiseSourceConfigurationFilter; end
2195
+ class Unknown < IotSiteWiseSourceConfigurationFilter; end
2196
+ end
2197
+
2198
+ # The metadata transfer job AWS IoT TwinMaker destination configuration.
2199
+ #
2200
+ # @!attribute [rw] workspace
2201
+ # The IoT TwinMaker workspace.
2202
+ # @return [String]
2203
+ #
2204
+ class IotTwinMakerDestinationConfiguration < Struct.new(
2205
+ :workspace)
2206
+ SENSITIVE = []
2207
+ include Aws::Structure
2208
+ end
2209
+
2210
+ # The metadata transfer job AWS IoT TwinMaker source configuration.
1655
2211
  #
1656
- # @!attribute [rw] message
2212
+ # @!attribute [rw] workspace
2213
+ # The IoT TwinMaker workspace.
1657
2214
  # @return [String]
1658
2215
  #
1659
- class InternalServerException < Struct.new(
1660
- :message)
2216
+ # @!attribute [rw] filters
2217
+ # The metadata transfer job AWS IoT TwinMaker source configuration
2218
+ # filters.
2219
+ # @return [Array<Types::IotTwinMakerSourceConfigurationFilter>]
2220
+ #
2221
+ class IotTwinMakerSourceConfiguration < Struct.new(
2222
+ :workspace,
2223
+ :filters)
1661
2224
  SENSITIVE = []
1662
2225
  include Aws::Structure
1663
2226
  end
1664
2227
 
1665
- # An object that specifies how to interpolate data in a list.
2228
+ # The metadata transfer job AWS IoT TwinMaker source configuration
2229
+ # filter.
1666
2230
  #
1667
- # @!attribute [rw] interpolation_type
1668
- # The interpolation type.
1669
- # @return [String]
2231
+ # @note IotTwinMakerSourceConfigurationFilter is a union - when making an API calls you must set exactly one of the members.
1670
2232
  #
1671
- # @!attribute [rw] interval_in_seconds
1672
- # The interpolation time interval in seconds.
1673
- # @return [Integer]
2233
+ # @note IotTwinMakerSourceConfigurationFilter is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IotTwinMakerSourceConfigurationFilter corresponding to the set member.
1674
2234
  #
1675
- class InterpolationParameters < Struct.new(
1676
- :interpolation_type,
1677
- :interval_in_seconds)
2235
+ # @!attribute [rw] filter_by_component_type
2236
+ # Filter by component type.
2237
+ # @return [Types::FilterByComponentType]
2238
+ #
2239
+ # @!attribute [rw] filter_by_entity
2240
+ # Filter by entity.
2241
+ # @return [Types::FilterByEntity]
2242
+ #
2243
+ class IotTwinMakerSourceConfigurationFilter < Struct.new(
2244
+ :filter_by_component_type,
2245
+ :filter_by_entity,
2246
+ :unknown)
1678
2247
  SENSITIVE = []
1679
2248
  include Aws::Structure
2249
+ include Aws::Structure::Union
2250
+
2251
+ class FilterByComponentType < IotTwinMakerSourceConfigurationFilter; end
2252
+ class FilterByEntity < IotTwinMakerSourceConfigurationFilter; end
2253
+ class Unknown < IotTwinMakerSourceConfigurationFilter; end
1680
2254
  end
1681
2255
 
1682
2256
  # The Lambda function.
@@ -1781,6 +2355,54 @@ module Aws::IoTTwinMaker
1781
2355
  include Aws::Structure
1782
2356
  end
1783
2357
 
2358
+ # @!attribute [rw] workspace_id
2359
+ # The workspace ID.
2360
+ # @return [String]
2361
+ #
2362
+ # @!attribute [rw] entity_id
2363
+ # The ID for the entity whose metadata (component/properties) is
2364
+ # returned by the operation.
2365
+ # @return [String]
2366
+ #
2367
+ # @!attribute [rw] component_path
2368
+ # This string specifies the path to the composite component, starting
2369
+ # from the top-level component.
2370
+ # @return [String]
2371
+ #
2372
+ # @!attribute [rw] max_results
2373
+ # The maximum number of results returned at one time. The default is
2374
+ # 25.
2375
+ # @return [Integer]
2376
+ #
2377
+ # @!attribute [rw] next_token
2378
+ # The string that specifies the next page of results.
2379
+ # @return [String]
2380
+ #
2381
+ class ListComponentsRequest < Struct.new(
2382
+ :workspace_id,
2383
+ :entity_id,
2384
+ :component_path,
2385
+ :max_results,
2386
+ :next_token)
2387
+ SENSITIVE = []
2388
+ include Aws::Structure
2389
+ end
2390
+
2391
+ # @!attribute [rw] component_summaries
2392
+ # A list of objects that contain information about the components.
2393
+ # @return [Array<Types::ComponentSummary>]
2394
+ #
2395
+ # @!attribute [rw] next_token
2396
+ # The string that specifies the next page of component results.
2397
+ # @return [String]
2398
+ #
2399
+ class ListComponentsResponse < Struct.new(
2400
+ :component_summaries,
2401
+ :next_token)
2402
+ SENSITIVE = []
2403
+ include Aws::Structure
2404
+ end
2405
+
1784
2406
  # An object that filters items in a list of entities.
1785
2407
  #
1786
2408
  # @note ListEntitiesFilter is a union - when making an API calls you must set exactly one of the members.
@@ -1860,6 +2482,130 @@ module Aws::IoTTwinMaker
1860
2482
  include Aws::Structure
1861
2483
  end
1862
2484
 
2485
+ # The ListMetadataTransferJobs filter.
2486
+ #
2487
+ # @note ListMetadataTransferJobsFilter is a union - when making an API calls you must set exactly one of the members.
2488
+ #
2489
+ # @!attribute [rw] workspace_id
2490
+ # The workspace Id.
2491
+ # @return [String]
2492
+ #
2493
+ # @!attribute [rw] state
2494
+ # The filter state.
2495
+ # @return [String]
2496
+ #
2497
+ class ListMetadataTransferJobsFilter < Struct.new(
2498
+ :workspace_id,
2499
+ :state,
2500
+ :unknown)
2501
+ SENSITIVE = []
2502
+ include Aws::Structure
2503
+ include Aws::Structure::Union
2504
+
2505
+ class WorkspaceId < ListMetadataTransferJobsFilter; end
2506
+ class State < ListMetadataTransferJobsFilter; end
2507
+ class Unknown < ListMetadataTransferJobsFilter; end
2508
+ end
2509
+
2510
+ # @!attribute [rw] source_type
2511
+ # The metadata transfer job's source type.
2512
+ # @return [String]
2513
+ #
2514
+ # @!attribute [rw] destination_type
2515
+ # The metadata transfer job's destination type.
2516
+ # @return [String]
2517
+ #
2518
+ # @!attribute [rw] filters
2519
+ # An object that filters metadata transfer jobs.
2520
+ # @return [Array<Types::ListMetadataTransferJobsFilter>]
2521
+ #
2522
+ # @!attribute [rw] next_token
2523
+ # The string that specifies the next page of results.
2524
+ # @return [String]
2525
+ #
2526
+ # @!attribute [rw] max_results
2527
+ # The maximum number of results to return at one time.
2528
+ # @return [Integer]
2529
+ #
2530
+ class ListMetadataTransferJobsRequest < Struct.new(
2531
+ :source_type,
2532
+ :destination_type,
2533
+ :filters,
2534
+ :next_token,
2535
+ :max_results)
2536
+ SENSITIVE = []
2537
+ include Aws::Structure
2538
+ end
2539
+
2540
+ # @!attribute [rw] metadata_transfer_job_summaries
2541
+ # The metadata transfer job summaries.
2542
+ # @return [Array<Types::MetadataTransferJobSummary>]
2543
+ #
2544
+ # @!attribute [rw] next_token
2545
+ # The string that specifies the next page of results.
2546
+ # @return [String]
2547
+ #
2548
+ class ListMetadataTransferJobsResponse < Struct.new(
2549
+ :metadata_transfer_job_summaries,
2550
+ :next_token)
2551
+ SENSITIVE = []
2552
+ include Aws::Structure
2553
+ end
2554
+
2555
+ # @!attribute [rw] workspace_id
2556
+ # The workspace ID.
2557
+ # @return [String]
2558
+ #
2559
+ # @!attribute [rw] component_name
2560
+ # The name of the component whose properties are returned by the
2561
+ # operation.
2562
+ # @return [String]
2563
+ #
2564
+ # @!attribute [rw] component_path
2565
+ # This string specifies the path to the composite component, starting
2566
+ # from the top-level component.
2567
+ # @return [String]
2568
+ #
2569
+ # @!attribute [rw] entity_id
2570
+ # The ID for the entity whose metadata (component/properties) is
2571
+ # returned by the operation.
2572
+ # @return [String]
2573
+ #
2574
+ # @!attribute [rw] max_results
2575
+ # The maximum number of results returned at one time. The default is
2576
+ # 25.
2577
+ # @return [Integer]
2578
+ #
2579
+ # @!attribute [rw] next_token
2580
+ # The string that specifies the next page of results.
2581
+ # @return [String]
2582
+ #
2583
+ class ListPropertiesRequest < Struct.new(
2584
+ :workspace_id,
2585
+ :component_name,
2586
+ :component_path,
2587
+ :entity_id,
2588
+ :max_results,
2589
+ :next_token)
2590
+ SENSITIVE = []
2591
+ include Aws::Structure
2592
+ end
2593
+
2594
+ # @!attribute [rw] property_summaries
2595
+ # A list of objects that contain information about the properties.
2596
+ # @return [Array<Types::PropertySummary>]
2597
+ #
2598
+ # @!attribute [rw] next_token
2599
+ # The string that specifies the next page of property results.
2600
+ # @return [String]
2601
+ #
2602
+ class ListPropertiesResponse < Struct.new(
2603
+ :property_summaries,
2604
+ :next_token)
2605
+ SENSITIVE = []
2606
+ include Aws::Structure
2607
+ end
2608
+
1863
2609
  # @!attribute [rw] workspace_id
1864
2610
  # The ID of the workspace that contains the scenes.
1865
2611
  # @return [String]
@@ -2064,6 +2810,92 @@ module Aws::IoTTwinMaker
2064
2810
  include Aws::Structure
2065
2811
  end
2066
2812
 
2813
+ # The metadata transfer job's progress.
2814
+ #
2815
+ # @!attribute [rw] total_count
2816
+ # The total count. \[of what\]
2817
+ # @return [Integer]
2818
+ #
2819
+ # @!attribute [rw] succeeded_count
2820
+ # The succeeded count.
2821
+ # @return [Integer]
2822
+ #
2823
+ # @!attribute [rw] skipped_count
2824
+ # The skipped count.
2825
+ # @return [Integer]
2826
+ #
2827
+ # @!attribute [rw] failed_count
2828
+ # The failed count.
2829
+ # @return [Integer]
2830
+ #
2831
+ class MetadataTransferJobProgress < Struct.new(
2832
+ :total_count,
2833
+ :succeeded_count,
2834
+ :skipped_count,
2835
+ :failed_count)
2836
+ SENSITIVE = []
2837
+ include Aws::Structure
2838
+ end
2839
+
2840
+ # The metadata transfer job status.
2841
+ #
2842
+ # @!attribute [rw] state
2843
+ # The metadata transfer job state.
2844
+ # @return [String]
2845
+ #
2846
+ # @!attribute [rw] error
2847
+ # The metadata transfer job error.
2848
+ # @return [Types::ErrorDetails]
2849
+ #
2850
+ # @!attribute [rw] queued_position
2851
+ # The queued position.
2852
+ # @return [Integer]
2853
+ #
2854
+ class MetadataTransferJobStatus < Struct.new(
2855
+ :state,
2856
+ :error,
2857
+ :queued_position)
2858
+ SENSITIVE = []
2859
+ include Aws::Structure
2860
+ end
2861
+
2862
+ # The metadata transfer job summary.
2863
+ #
2864
+ # @!attribute [rw] metadata_transfer_job_id
2865
+ # The metadata transfer job summary Id.
2866
+ # @return [String]
2867
+ #
2868
+ # @!attribute [rw] arn
2869
+ # The metadata transfer job summary ARN.
2870
+ # @return [String]
2871
+ #
2872
+ # @!attribute [rw] creation_date_time
2873
+ # The metadata transfer job summary creation DateTime object.
2874
+ # @return [Time]
2875
+ #
2876
+ # @!attribute [rw] update_date_time
2877
+ # The metadata transfer job summary update DateTime object
2878
+ # @return [Time]
2879
+ #
2880
+ # @!attribute [rw] status
2881
+ # The metadata transfer job summary status.
2882
+ # @return [Types::MetadataTransferJobStatus]
2883
+ #
2884
+ # @!attribute [rw] progress
2885
+ # The metadata transfer job summary progess.
2886
+ # @return [Types::MetadataTransferJobProgress]
2887
+ #
2888
+ class MetadataTransferJobSummary < Struct.new(
2889
+ :metadata_transfer_job_id,
2890
+ :arn,
2891
+ :creation_date_time,
2892
+ :update_date_time,
2893
+ :status,
2894
+ :progress)
2895
+ SENSITIVE = []
2896
+ include Aws::Structure
2897
+ end
2898
+
2067
2899
  # Filter criteria that orders the return output. It can be sorted in
2068
2900
  # ascending or descending order.
2069
2901
  #
@@ -2368,9 +3200,45 @@ module Aws::IoTTwinMaker
2368
3200
  # The value of the property.
2369
3201
  # @return [Types::DataValue]
2370
3202
  #
3203
+ # @!attribute [rw] are_all_property_values_returned
3204
+ # This flag notes whether all values of a list or map type property
3205
+ # are returned in the API response. The maximum number of values per
3206
+ # property returned is 50.
3207
+ # @return [Boolean]
3208
+ #
2371
3209
  class PropertyResponse < Struct.new(
2372
3210
  :definition,
2373
- :value)
3211
+ :value,
3212
+ :are_all_property_values_returned)
3213
+ SENSITIVE = []
3214
+ include Aws::Structure
3215
+ end
3216
+
3217
+ # This is an object that contains the information of a property.
3218
+ #
3219
+ # @!attribute [rw] definition
3220
+ # This is the schema for the property.
3221
+ # @return [Types::PropertyDefinitionResponse]
3222
+ #
3223
+ # @!attribute [rw] property_name
3224
+ # This is the name of the property.
3225
+ # @return [String]
3226
+ #
3227
+ # @!attribute [rw] value
3228
+ # This is the value for the property.
3229
+ # @return [Types::DataValue]
3230
+ #
3231
+ # @!attribute [rw] are_all_property_values_returned
3232
+ # This flag notes whether all values of a list or map type property
3233
+ # are returned in the API response. The maximum number of values per
3234
+ # property returned is 50.
3235
+ # @return [Boolean]
3236
+ #
3237
+ class PropertySummary < Struct.new(
3238
+ :definition,
3239
+ :property_name,
3240
+ :value,
3241
+ :are_all_property_values_returned)
2374
3242
  SENSITIVE = []
2375
3243
  include Aws::Structure
2376
3244
  end
@@ -2535,6 +3403,30 @@ module Aws::IoTTwinMaker
2535
3403
  include Aws::Structure
2536
3404
  end
2537
3405
 
3406
+ # The S3 destination configuration.
3407
+ #
3408
+ # @!attribute [rw] location
3409
+ # The S3 destination configuration location.
3410
+ # @return [String]
3411
+ #
3412
+ class S3DestinationConfiguration < Struct.new(
3413
+ :location)
3414
+ SENSITIVE = []
3415
+ include Aws::Structure
3416
+ end
3417
+
3418
+ # The S3 destination source configuration.
3419
+ #
3420
+ # @!attribute [rw] location
3421
+ # The S3 destination source configuration location.
3422
+ # @return [String]
3423
+ #
3424
+ class S3SourceConfiguration < Struct.new(
3425
+ :location)
3426
+ SENSITIVE = []
3427
+ include Aws::Structure
3428
+ end
3429
+
2538
3430
  # The scene error.
2539
3431
  #
2540
3432
  # @!attribute [rw] code
@@ -2601,6 +3493,33 @@ module Aws::IoTTwinMaker
2601
3493
  include Aws::Structure
2602
3494
  end
2603
3495
 
3496
+ # The source configuration.
3497
+ #
3498
+ # @!attribute [rw] type
3499
+ # The source configuration type.
3500
+ # @return [String]
3501
+ #
3502
+ # @!attribute [rw] s3_configuration
3503
+ # The source configuration S3 configuration.
3504
+ # @return [Types::S3SourceConfiguration]
3505
+ #
3506
+ # @!attribute [rw] iot_site_wise_configuration
3507
+ # The source configuration IoT SiteWise configuration.
3508
+ # @return [Types::IotSiteWiseSourceConfiguration]
3509
+ #
3510
+ # @!attribute [rw] iot_twin_maker_configuration
3511
+ # The source configuration IoT TwinMaker configuration.
3512
+ # @return [Types::IotTwinMakerSourceConfiguration]
3513
+ #
3514
+ class SourceConfiguration < Struct.new(
3515
+ :type,
3516
+ :s3_configuration,
3517
+ :iot_site_wise_configuration,
3518
+ :iot_twin_maker_configuration)
3519
+ SENSITIVE = []
3520
+ include Aws::Structure
3521
+ end
3522
+
2604
3523
  # An object that represents the status of an entity, component,
2605
3524
  # component type, or workspace.
2606
3525
  #
@@ -2879,6 +3798,12 @@ module Aws::IoTTwinMaker
2879
3798
  # The component type name.
2880
3799
  # @return [String]
2881
3800
  #
3801
+ # @!attribute [rw] composite_component_types
3802
+ # This is an object that maps strings to `compositeComponentTypes` of
3803
+ # the `componentType`. `CompositeComponentType` is referenced by
3804
+ # `componentTypeId`.
3805
+ # @return [Hash<String,Types::CompositeComponentTypeRequest>]
3806
+ #
2882
3807
  class UpdateComponentTypeRequest < Struct.new(
2883
3808
  :workspace_id,
2884
3809
  :is_singleton,
@@ -2888,7 +3813,8 @@ module Aws::IoTTwinMaker
2888
3813
  :extends_from,
2889
3814
  :functions,
2890
3815
  :property_groups,
2891
- :component_type_name)
3816
+ :component_type_name,
3817
+ :composite_component_types)
2892
3818
  SENSITIVE = []
2893
3819
  include Aws::Structure
2894
3820
  end
@@ -2939,6 +3865,12 @@ module Aws::IoTTwinMaker
2939
3865
  # Each string in the mapping must be unique to this object.
2940
3866
  # @return [Hash<String,Types::ComponentUpdateRequest>]
2941
3867
  #
3868
+ # @!attribute [rw] composite_component_updates
3869
+ # This is an object that maps strings to `compositeComponent` updates
3870
+ # in the request. Each key of the map represents the `componentPath`
3871
+ # of the `compositeComponent`.
3872
+ # @return [Hash<String,Types::CompositeComponentUpdateRequest>]
3873
+ #
2942
3874
  # @!attribute [rw] parent_entity_update
2943
3875
  # An object that describes the update request for a parent entity.
2944
3876
  # @return [Types::ParentEntityUpdateRequest]
@@ -2949,6 +3881,7 @@ module Aws::IoTTwinMaker
2949
3881
  :entity_name,
2950
3882
  :description,
2951
3883
  :component_updates,
3884
+ :composite_component_updates,
2952
3885
  :parent_entity_update)
2953
3886
  SENSITIVE = []
2954
3887
  include Aws::Structure
@@ -3057,10 +3990,16 @@ module Aws::IoTTwinMaker
3057
3990
  # The ARN of the execution role associated with the workspace.
3058
3991
  # @return [String]
3059
3992
  #
3993
+ # @!attribute [rw] s3_location
3994
+ # The ARN of the S3 bucket where resources associated with the
3995
+ # workspace are stored.
3996
+ # @return [String]
3997
+ #
3060
3998
  class UpdateWorkspaceRequest < Struct.new(
3061
3999
  :workspace_id,
3062
4000
  :description,
3063
- :role)
4001
+ :role,
4002
+ :s3_location)
3064
4003
  SENSITIVE = []
3065
4004
  include Aws::Structure
3066
4005
  end
@@ -3100,6 +4039,10 @@ module Aws::IoTTwinMaker
3100
4039
  # The description of the workspace.
3101
4040
  # @return [String]
3102
4041
  #
4042
+ # @!attribute [rw] linked_services
4043
+ # A list of services that are linked to the workspace.
4044
+ # @return [Array<String>]
4045
+ #
3103
4046
  # @!attribute [rw] creation_date_time
3104
4047
  # The date and time when the workspace was created.
3105
4048
  # @return [Time]
@@ -3112,6 +4055,7 @@ module Aws::IoTTwinMaker
3112
4055
  :workspace_id,
3113
4056
  :arn,
3114
4057
  :description,
4058
+ :linked_services,
3115
4059
  :creation_date_time,
3116
4060
  :update_date_time)
3117
4061
  SENSITIVE = []