aws-sdk-iottwinmaker 1.17.0 → 1.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iottwinmaker/client.rb +751 -17
- data/lib/aws-sdk-iottwinmaker/client_api.rb +420 -4
- data/lib/aws-sdk-iottwinmaker/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-iottwinmaker/endpoints.rb +84 -0
- data/lib/aws-sdk-iottwinmaker/plugins/endpoints.rb +12 -0
- data/lib/aws-sdk-iottwinmaker/types.rb +971 -27
- data/lib/aws-sdk-iottwinmaker.rb +1 -1
- metadata +5 -5
@@ -409,6 +409,7 @@ module Aws::IoTTwinMaker
|
|
409
409
|
# {
|
410
410
|
# entity_property_reference: { # required
|
411
411
|
# component_name: "Name",
|
412
|
+
# component_path: "ComponentPath",
|
412
413
|
# external_id_property: {
|
413
414
|
# "String" => "String",
|
414
415
|
# },
|
@@ -454,6 +455,7 @@ module Aws::IoTTwinMaker
|
|
454
455
|
# resp.error_entries[0].errors[0].error_code #=> String
|
455
456
|
# resp.error_entries[0].errors[0].error_message #=> String
|
456
457
|
# resp.error_entries[0].errors[0].entry.entity_property_reference.component_name #=> String
|
458
|
+
# resp.error_entries[0].errors[0].entry.entity_property_reference.component_path #=> String
|
457
459
|
# resp.error_entries[0].errors[0].entry.entity_property_reference.external_id_property #=> Hash
|
458
460
|
# resp.error_entries[0].errors[0].entry.entity_property_reference.external_id_property["String"] #=> String
|
459
461
|
# resp.error_entries[0].errors[0].entry.entity_property_reference.entity_id #=> String
|
@@ -481,6 +483,46 @@ module Aws::IoTTwinMaker
|
|
481
483
|
req.send_request(options)
|
482
484
|
end
|
483
485
|
|
486
|
+
# Cancels the metadata transfer job.
|
487
|
+
#
|
488
|
+
# @option params [required, String] :metadata_transfer_job_id
|
489
|
+
# The metadata transfer job Id.
|
490
|
+
#
|
491
|
+
# @return [Types::CancelMetadataTransferJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
492
|
+
#
|
493
|
+
# * {Types::CancelMetadataTransferJobResponse#metadata_transfer_job_id #metadata_transfer_job_id} => String
|
494
|
+
# * {Types::CancelMetadataTransferJobResponse#arn #arn} => String
|
495
|
+
# * {Types::CancelMetadataTransferJobResponse#update_date_time #update_date_time} => Time
|
496
|
+
# * {Types::CancelMetadataTransferJobResponse#status #status} => Types::MetadataTransferJobStatus
|
497
|
+
# * {Types::CancelMetadataTransferJobResponse#progress #progress} => Types::MetadataTransferJobProgress
|
498
|
+
#
|
499
|
+
# @example Request syntax with placeholder values
|
500
|
+
#
|
501
|
+
# resp = client.cancel_metadata_transfer_job({
|
502
|
+
# metadata_transfer_job_id: "Id", # required
|
503
|
+
# })
|
504
|
+
#
|
505
|
+
# @example Response structure
|
506
|
+
#
|
507
|
+
# resp.metadata_transfer_job_id #=> String
|
508
|
+
# resp.arn #=> String
|
509
|
+
# resp.update_date_time #=> Time
|
510
|
+
# resp.status.state #=> String, one of "VALIDATING", "PENDING", "RUNNING", "CANCELLING", "ERROR", "COMPLETED", "CANCELLED"
|
511
|
+
# resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE"
|
512
|
+
# resp.status.error.message #=> String
|
513
|
+
# resp.status.queued_position #=> Integer
|
514
|
+
# resp.progress.total_count #=> Integer
|
515
|
+
# resp.progress.succeeded_count #=> Integer
|
516
|
+
# resp.progress.skipped_count #=> Integer
|
517
|
+
# resp.progress.failed_count #=> Integer
|
518
|
+
#
|
519
|
+
# @overload cancel_metadata_transfer_job(params = {})
|
520
|
+
# @param [Hash] params ({})
|
521
|
+
def cancel_metadata_transfer_job(params = {}, options = {})
|
522
|
+
req = build_request(:cancel_metadata_transfer_job, params)
|
523
|
+
req.send_request(options)
|
524
|
+
end
|
525
|
+
|
484
526
|
# Creates a component type.
|
485
527
|
#
|
486
528
|
# @option params [required, String] :workspace_id
|
@@ -516,6 +558,11 @@ module Aws::IoTTwinMaker
|
|
516
558
|
# @option params [String] :component_type_name
|
517
559
|
# A friendly name for the component type.
|
518
560
|
#
|
561
|
+
# @option params [Hash<String,Types::CompositeComponentTypeRequest>] :composite_component_types
|
562
|
+
# This is an object that maps strings to `compositeComponentTypes` of
|
563
|
+
# the `componentType`. `CompositeComponentType` is referenced by
|
564
|
+
# `componentTypeId`.
|
565
|
+
#
|
519
566
|
# @return [Types::CreateComponentTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
520
567
|
#
|
521
568
|
# * {Types::CreateComponentTypeResponse#arn #arn} => String
|
@@ -619,6 +666,11 @@ module Aws::IoTTwinMaker
|
|
619
666
|
# },
|
620
667
|
# },
|
621
668
|
# component_type_name: "ComponentTypeName",
|
669
|
+
# composite_component_types: {
|
670
|
+
# "Name" => {
|
671
|
+
# component_type_id: "ComponentTypeId",
|
672
|
+
# },
|
673
|
+
# },
|
622
674
|
# })
|
623
675
|
#
|
624
676
|
# @example Response structure
|
@@ -652,6 +704,11 @@ module Aws::IoTTwinMaker
|
|
652
704
|
# An object that maps strings to the components in the entity. Each
|
653
705
|
# string in the mapping must be unique to this object.
|
654
706
|
#
|
707
|
+
# @option params [Hash<String,Types::CompositeComponentRequest>] :composite_components
|
708
|
+
# This is an object that maps strings to `compositeComponent` updates in
|
709
|
+
# the request. Each key of the map represents the `componentPath` of the
|
710
|
+
# `compositeComponent`.
|
711
|
+
#
|
655
712
|
# @option params [String] :parent_entity_id
|
656
713
|
# The ID of the entity's parent entity.
|
657
714
|
#
|
@@ -777,6 +834,110 @@ module Aws::IoTTwinMaker
|
|
777
834
|
# },
|
778
835
|
# },
|
779
836
|
# },
|
837
|
+
# composite_components: {
|
838
|
+
# "ComponentPath" => {
|
839
|
+
# description: "Description",
|
840
|
+
# properties: {
|
841
|
+
# "Name" => {
|
842
|
+
# definition: {
|
843
|
+
# data_type: {
|
844
|
+
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
845
|
+
# nested_type: {
|
846
|
+
# # recursive DataType
|
847
|
+
# },
|
848
|
+
# allowed_values: [
|
849
|
+
# {
|
850
|
+
# boolean_value: false,
|
851
|
+
# double_value: 1.0,
|
852
|
+
# integer_value: 1,
|
853
|
+
# long_value: 1,
|
854
|
+
# string_value: "String",
|
855
|
+
# list_value: {
|
856
|
+
# # recursive DataValueList
|
857
|
+
# },
|
858
|
+
# map_value: {
|
859
|
+
# "String" => {
|
860
|
+
# # recursive DataValue
|
861
|
+
# },
|
862
|
+
# },
|
863
|
+
# relationship_value: {
|
864
|
+
# target_entity_id: "EntityId",
|
865
|
+
# target_component_name: "Name",
|
866
|
+
# },
|
867
|
+
# expression: "Expression",
|
868
|
+
# },
|
869
|
+
# ],
|
870
|
+
# unit_of_measure: "String",
|
871
|
+
# relationship: {
|
872
|
+
# target_component_type_id: "ComponentTypeId",
|
873
|
+
# relationship_type: "String",
|
874
|
+
# },
|
875
|
+
# },
|
876
|
+
# is_required_in_entity: false,
|
877
|
+
# is_external_id: false,
|
878
|
+
# is_stored_externally: false,
|
879
|
+
# is_time_series: false,
|
880
|
+
# default_value: {
|
881
|
+
# boolean_value: false,
|
882
|
+
# double_value: 1.0,
|
883
|
+
# integer_value: 1,
|
884
|
+
# long_value: 1,
|
885
|
+
# string_value: "String",
|
886
|
+
# list_value: [
|
887
|
+
# {
|
888
|
+
# # recursive DataValue
|
889
|
+
# },
|
890
|
+
# ],
|
891
|
+
# map_value: {
|
892
|
+
# "String" => {
|
893
|
+
# # recursive DataValue
|
894
|
+
# },
|
895
|
+
# },
|
896
|
+
# relationship_value: {
|
897
|
+
# target_entity_id: "EntityId",
|
898
|
+
# target_component_name: "Name",
|
899
|
+
# },
|
900
|
+
# expression: "Expression",
|
901
|
+
# },
|
902
|
+
# configuration: {
|
903
|
+
# "Name" => "Value",
|
904
|
+
# },
|
905
|
+
# display_name: "PropertyDisplayName",
|
906
|
+
# },
|
907
|
+
# value: {
|
908
|
+
# boolean_value: false,
|
909
|
+
# double_value: 1.0,
|
910
|
+
# integer_value: 1,
|
911
|
+
# long_value: 1,
|
912
|
+
# string_value: "String",
|
913
|
+
# list_value: [
|
914
|
+
# {
|
915
|
+
# # recursive DataValue
|
916
|
+
# },
|
917
|
+
# ],
|
918
|
+
# map_value: {
|
919
|
+
# "String" => {
|
920
|
+
# # recursive DataValue
|
921
|
+
# },
|
922
|
+
# },
|
923
|
+
# relationship_value: {
|
924
|
+
# target_entity_id: "EntityId",
|
925
|
+
# target_component_name: "Name",
|
926
|
+
# },
|
927
|
+
# expression: "Expression",
|
928
|
+
# },
|
929
|
+
# update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
|
930
|
+
# },
|
931
|
+
# },
|
932
|
+
# property_groups: {
|
933
|
+
# "Name" => {
|
934
|
+
# group_type: "TABULAR", # accepts TABULAR
|
935
|
+
# property_names: ["Name"],
|
936
|
+
# update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
|
937
|
+
# },
|
938
|
+
# },
|
939
|
+
# },
|
940
|
+
# },
|
780
941
|
# parent_entity_id: "ParentEntityId",
|
781
942
|
# tags: {
|
782
943
|
# "TagKey" => "TagValue",
|
@@ -797,6 +958,99 @@ module Aws::IoTTwinMaker
|
|
797
958
|
req.send_request(options)
|
798
959
|
end
|
799
960
|
|
961
|
+
# Creates a new metadata transfer job.
|
962
|
+
#
|
963
|
+
# @option params [String] :metadata_transfer_job_id
|
964
|
+
# The metadata transfer job Id.
|
965
|
+
#
|
966
|
+
# @option params [String] :description
|
967
|
+
# The metadata transfer job description.
|
968
|
+
#
|
969
|
+
# @option params [required, Array<Types::SourceConfiguration>] :sources
|
970
|
+
# The metadata transfer job sources.
|
971
|
+
#
|
972
|
+
# @option params [required, Types::DestinationConfiguration] :destination
|
973
|
+
# The metadata transfer job destination.
|
974
|
+
#
|
975
|
+
# @return [Types::CreateMetadataTransferJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
976
|
+
#
|
977
|
+
# * {Types::CreateMetadataTransferJobResponse#metadata_transfer_job_id #metadata_transfer_job_id} => String
|
978
|
+
# * {Types::CreateMetadataTransferJobResponse#arn #arn} => String
|
979
|
+
# * {Types::CreateMetadataTransferJobResponse#creation_date_time #creation_date_time} => Time
|
980
|
+
# * {Types::CreateMetadataTransferJobResponse#status #status} => Types::MetadataTransferJobStatus
|
981
|
+
#
|
982
|
+
# @example Request syntax with placeholder values
|
983
|
+
#
|
984
|
+
# resp = client.create_metadata_transfer_job({
|
985
|
+
# metadata_transfer_job_id: "Id",
|
986
|
+
# description: "Description",
|
987
|
+
# sources: [ # required
|
988
|
+
# {
|
989
|
+
# type: "s3", # required, accepts s3, iotsitewise, iottwinmaker
|
990
|
+
# s3_configuration: {
|
991
|
+
# location: "S3SourceLocation", # required
|
992
|
+
# },
|
993
|
+
# iot_site_wise_configuration: {
|
994
|
+
# filters: [
|
995
|
+
# {
|
996
|
+
# filter_by_asset_model: {
|
997
|
+
# asset_model_id: "Uuid",
|
998
|
+
# asset_model_external_id: "SiteWiseExternalId",
|
999
|
+
# include_offspring: false,
|
1000
|
+
# include_assets: false,
|
1001
|
+
# },
|
1002
|
+
# filter_by_asset: {
|
1003
|
+
# asset_id: "Uuid",
|
1004
|
+
# asset_external_id: "SiteWiseExternalId",
|
1005
|
+
# include_offspring: false,
|
1006
|
+
# include_asset_model: false,
|
1007
|
+
# },
|
1008
|
+
# },
|
1009
|
+
# ],
|
1010
|
+
# },
|
1011
|
+
# iot_twin_maker_configuration: {
|
1012
|
+
# workspace: "TwinMakerArn", # required
|
1013
|
+
# filters: [
|
1014
|
+
# {
|
1015
|
+
# filter_by_component_type: {
|
1016
|
+
# component_type_id: "ComponentTypeId", # required
|
1017
|
+
# },
|
1018
|
+
# filter_by_entity: {
|
1019
|
+
# entity_id: "EntityId", # required
|
1020
|
+
# },
|
1021
|
+
# },
|
1022
|
+
# ],
|
1023
|
+
# },
|
1024
|
+
# },
|
1025
|
+
# ],
|
1026
|
+
# destination: { # required
|
1027
|
+
# type: "s3", # required, accepts s3, iotsitewise, iottwinmaker
|
1028
|
+
# s3_configuration: {
|
1029
|
+
# location: "S3DestinationLocation", # required
|
1030
|
+
# },
|
1031
|
+
# iot_twin_maker_configuration: {
|
1032
|
+
# workspace: "TwinMakerArn", # required
|
1033
|
+
# },
|
1034
|
+
# },
|
1035
|
+
# })
|
1036
|
+
#
|
1037
|
+
# @example Response structure
|
1038
|
+
#
|
1039
|
+
# resp.metadata_transfer_job_id #=> String
|
1040
|
+
# resp.arn #=> String
|
1041
|
+
# resp.creation_date_time #=> Time
|
1042
|
+
# resp.status.state #=> String, one of "VALIDATING", "PENDING", "RUNNING", "CANCELLING", "ERROR", "COMPLETED", "CANCELLED"
|
1043
|
+
# resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE"
|
1044
|
+
# resp.status.error.message #=> String
|
1045
|
+
# resp.status.queued_position #=> Integer
|
1046
|
+
#
|
1047
|
+
# @overload create_metadata_transfer_job(params = {})
|
1048
|
+
# @param [Hash] params ({})
|
1049
|
+
def create_metadata_transfer_job(params = {}, options = {})
|
1050
|
+
req = build_request(:create_metadata_transfer_job, params)
|
1051
|
+
req.send_request(options)
|
1052
|
+
end
|
1053
|
+
|
800
1054
|
# Creates a scene.
|
801
1055
|
#
|
802
1056
|
# @option params [required, String] :workspace_id
|
@@ -912,11 +1166,11 @@ module Aws::IoTTwinMaker
|
|
912
1166
|
# @option params [String] :description
|
913
1167
|
# The description of the workspace.
|
914
1168
|
#
|
915
|
-
# @option params [
|
1169
|
+
# @option params [String] :s3_location
|
916
1170
|
# The ARN of the S3 bucket where resources associated with the workspace
|
917
1171
|
# are stored.
|
918
1172
|
#
|
919
|
-
# @option params [
|
1173
|
+
# @option params [String] :role
|
920
1174
|
# The ARN of the execution role associated with the workspace.
|
921
1175
|
#
|
922
1176
|
# @option params [Hash<String,String>] :tags
|
@@ -932,8 +1186,8 @@ module Aws::IoTTwinMaker
|
|
932
1186
|
# resp = client.create_workspace({
|
933
1187
|
# workspace_id: "Id", # required
|
934
1188
|
# description: "Description",
|
935
|
-
# s3_location: "S3Location",
|
936
|
-
# role: "RoleArn",
|
1189
|
+
# s3_location: "S3Location",
|
1190
|
+
# role: "RoleArn",
|
937
1191
|
# tags: {
|
938
1192
|
# "TagKey" => "TagValue",
|
939
1193
|
# },
|
@@ -1079,7 +1333,9 @@ module Aws::IoTTwinMaker
|
|
1079
1333
|
# @option params [required, String] :workspace_id
|
1080
1334
|
# The ID of the workspace to delete.
|
1081
1335
|
#
|
1082
|
-
# @return [
|
1336
|
+
# @return [Types::DeleteWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1337
|
+
#
|
1338
|
+
# * {Types::DeleteWorkspaceResponse#message #message} => String
|
1083
1339
|
#
|
1084
1340
|
# @example Request syntax with placeholder values
|
1085
1341
|
#
|
@@ -1087,6 +1343,10 @@ module Aws::IoTTwinMaker
|
|
1087
1343
|
# workspace_id: "Id", # required
|
1088
1344
|
# })
|
1089
1345
|
#
|
1346
|
+
# @example Response structure
|
1347
|
+
#
|
1348
|
+
# resp.message #=> String
|
1349
|
+
#
|
1090
1350
|
# @overload delete_workspace(params = {})
|
1091
1351
|
# @param [Hash] params ({})
|
1092
1352
|
def delete_workspace(params = {}, options = {})
|
@@ -1097,6 +1357,16 @@ module Aws::IoTTwinMaker
|
|
1097
1357
|
# Run queries to access information from your knowledge graph of
|
1098
1358
|
# entities within individual workspaces.
|
1099
1359
|
#
|
1360
|
+
# <note markdown="1"> The ExecuteQuery action only works with [Amazon Web Services Java
|
1361
|
+
# SDK2][1]. ExecuteQuery will not work with any Amazon Web Services Java
|
1362
|
+
# SDK version < 2.x.
|
1363
|
+
#
|
1364
|
+
# </note>
|
1365
|
+
#
|
1366
|
+
#
|
1367
|
+
#
|
1368
|
+
# [1]: https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/home.html
|
1369
|
+
#
|
1100
1370
|
# @option params [required, String] :workspace_id
|
1101
1371
|
# The ID of the workspace.
|
1102
1372
|
#
|
@@ -1105,9 +1375,7 @@ module Aws::IoTTwinMaker
|
|
1105
1375
|
#
|
1106
1376
|
# @option params [Integer] :max_results
|
1107
1377
|
# The maximum number of results to return at one time. The default is
|
1108
|
-
#
|
1109
|
-
#
|
1110
|
-
# Valid Range: Minimum value of 1. Maximum value of 250.
|
1378
|
+
# 50.
|
1111
1379
|
#
|
1112
1380
|
# @option params [String] :next_token
|
1113
1381
|
# The string that specifies the next page of results.
|
@@ -1171,6 +1439,7 @@ module Aws::IoTTwinMaker
|
|
1171
1439
|
# * {Types::GetComponentTypeResponse#property_groups #property_groups} => Hash<String,Types::PropertyGroupResponse>
|
1172
1440
|
# * {Types::GetComponentTypeResponse#sync_source #sync_source} => String
|
1173
1441
|
# * {Types::GetComponentTypeResponse#component_type_name #component_type_name} => String
|
1442
|
+
# * {Types::GetComponentTypeResponse#composite_component_types #composite_component_types} => Hash<String,Types::CompositeComponentTypeResponse>
|
1174
1443
|
#
|
1175
1444
|
# @example Request syntax with placeholder values
|
1176
1445
|
#
|
@@ -1240,7 +1509,7 @@ module Aws::IoTTwinMaker
|
|
1240
1509
|
# resp.is_abstract #=> Boolean
|
1241
1510
|
# resp.is_schema_initialized #=> Boolean
|
1242
1511
|
# resp.status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1243
|
-
# resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR"
|
1512
|
+
# resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE"
|
1244
1513
|
# resp.status.error.message #=> String
|
1245
1514
|
# resp.property_groups #=> Hash
|
1246
1515
|
# resp.property_groups["Name"].group_type #=> String, one of "TABULAR"
|
@@ -1249,6 +1518,9 @@ module Aws::IoTTwinMaker
|
|
1249
1518
|
# resp.property_groups["Name"].is_inherited #=> Boolean
|
1250
1519
|
# resp.sync_source #=> String
|
1251
1520
|
# resp.component_type_name #=> String
|
1521
|
+
# resp.composite_component_types #=> Hash
|
1522
|
+
# resp.composite_component_types["Name"].component_type_id #=> String
|
1523
|
+
# resp.composite_component_types["Name"].is_inherited #=> Boolean
|
1252
1524
|
#
|
1253
1525
|
# @overload get_component_type(params = {})
|
1254
1526
|
# @param [Hash] params ({})
|
@@ -1279,6 +1551,7 @@ module Aws::IoTTwinMaker
|
|
1279
1551
|
# * {Types::GetEntityResponse#creation_date_time #creation_date_time} => Time
|
1280
1552
|
# * {Types::GetEntityResponse#update_date_time #update_date_time} => Time
|
1281
1553
|
# * {Types::GetEntityResponse#sync_source #sync_source} => String
|
1554
|
+
# * {Types::GetEntityResponse#are_all_components_returned #are_all_components_returned} => Boolean
|
1282
1555
|
#
|
1283
1556
|
# @example Request syntax with placeholder values
|
1284
1557
|
#
|
@@ -1293,7 +1566,7 @@ module Aws::IoTTwinMaker
|
|
1293
1566
|
# resp.entity_name #=> String
|
1294
1567
|
# resp.arn #=> String
|
1295
1568
|
# resp.status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1296
|
-
# resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR"
|
1569
|
+
# resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE"
|
1297
1570
|
# resp.status.error.message #=> String
|
1298
1571
|
# resp.workspace_id #=> String
|
1299
1572
|
# resp.description #=> String
|
@@ -1302,7 +1575,7 @@ module Aws::IoTTwinMaker
|
|
1302
1575
|
# resp.components["Name"].description #=> String
|
1303
1576
|
# resp.components["Name"].component_type_id #=> String
|
1304
1577
|
# resp.components["Name"].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1305
|
-
# resp.components["Name"].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR"
|
1578
|
+
# resp.components["Name"].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE"
|
1306
1579
|
# resp.components["Name"].status.error.message #=> String
|
1307
1580
|
# resp.components["Name"].defined_in #=> String
|
1308
1581
|
# resp.components["Name"].properties #=> Hash
|
@@ -1357,17 +1630,36 @@ module Aws::IoTTwinMaker
|
|
1357
1630
|
# resp.components["Name"].properties["Name"].value.relationship_value.target_entity_id #=> String
|
1358
1631
|
# resp.components["Name"].properties["Name"].value.relationship_value.target_component_name #=> String
|
1359
1632
|
# resp.components["Name"].properties["Name"].value.expression #=> String
|
1633
|
+
# resp.components["Name"].properties["Name"].are_all_property_values_returned #=> Boolean
|
1360
1634
|
# resp.components["Name"].property_groups #=> Hash
|
1361
1635
|
# resp.components["Name"].property_groups["Name"].group_type #=> String, one of "TABULAR"
|
1362
1636
|
# resp.components["Name"].property_groups["Name"].property_names #=> Array
|
1363
1637
|
# resp.components["Name"].property_groups["Name"].property_names[0] #=> String
|
1364
1638
|
# resp.components["Name"].property_groups["Name"].is_inherited #=> Boolean
|
1365
1639
|
# resp.components["Name"].sync_source #=> String
|
1640
|
+
# resp.components["Name"].are_all_properties_returned #=> Boolean
|
1641
|
+
# resp.components["Name"].composite_components #=> Hash
|
1642
|
+
# resp.components["Name"].composite_components["Name"].component_name #=> String
|
1643
|
+
# resp.components["Name"].composite_components["Name"].component_type_id #=> String
|
1644
|
+
# resp.components["Name"].composite_components["Name"].defined_in #=> String
|
1645
|
+
# resp.components["Name"].composite_components["Name"].description #=> String
|
1646
|
+
# resp.components["Name"].composite_components["Name"].property_groups #=> Hash
|
1647
|
+
# resp.components["Name"].composite_components["Name"].property_groups["Name"].group_type #=> String, one of "TABULAR"
|
1648
|
+
# resp.components["Name"].composite_components["Name"].property_groups["Name"].property_names #=> Array
|
1649
|
+
# resp.components["Name"].composite_components["Name"].property_groups["Name"].property_names[0] #=> String
|
1650
|
+
# resp.components["Name"].composite_components["Name"].property_groups["Name"].is_inherited #=> Boolean
|
1651
|
+
# resp.components["Name"].composite_components["Name"].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1652
|
+
# resp.components["Name"].composite_components["Name"].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE"
|
1653
|
+
# resp.components["Name"].composite_components["Name"].status.error.message #=> String
|
1654
|
+
# resp.components["Name"].composite_components["Name"].sync_source #=> String
|
1655
|
+
# resp.components["Name"].composite_components["Name"].component_path #=> String
|
1656
|
+
# resp.components["Name"].are_all_composite_components_returned #=> Boolean
|
1366
1657
|
# resp.parent_entity_id #=> String
|
1367
1658
|
# resp.has_child_entities #=> Boolean
|
1368
1659
|
# resp.creation_date_time #=> Time
|
1369
1660
|
# resp.update_date_time #=> Time
|
1370
1661
|
# resp.sync_source #=> String
|
1662
|
+
# resp.are_all_components_returned #=> Boolean
|
1371
1663
|
#
|
1372
1664
|
# @overload get_entity(params = {})
|
1373
1665
|
# @param [Hash] params ({})
|
@@ -1376,6 +1668,75 @@ module Aws::IoTTwinMaker
|
|
1376
1668
|
req.send_request(options)
|
1377
1669
|
end
|
1378
1670
|
|
1671
|
+
# Gets a nmetadata transfer job.
|
1672
|
+
#
|
1673
|
+
# @option params [required, String] :metadata_transfer_job_id
|
1674
|
+
# The metadata transfer job Id.
|
1675
|
+
#
|
1676
|
+
# @return [Types::GetMetadataTransferJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1677
|
+
#
|
1678
|
+
# * {Types::GetMetadataTransferJobResponse#metadata_transfer_job_id #metadata_transfer_job_id} => String
|
1679
|
+
# * {Types::GetMetadataTransferJobResponse#arn #arn} => String
|
1680
|
+
# * {Types::GetMetadataTransferJobResponse#description #description} => String
|
1681
|
+
# * {Types::GetMetadataTransferJobResponse#sources #sources} => Array<Types::SourceConfiguration>
|
1682
|
+
# * {Types::GetMetadataTransferJobResponse#destination #destination} => Types::DestinationConfiguration
|
1683
|
+
# * {Types::GetMetadataTransferJobResponse#metadata_transfer_job_role #metadata_transfer_job_role} => String
|
1684
|
+
# * {Types::GetMetadataTransferJobResponse#report_url #report_url} => String
|
1685
|
+
# * {Types::GetMetadataTransferJobResponse#creation_date_time #creation_date_time} => Time
|
1686
|
+
# * {Types::GetMetadataTransferJobResponse#update_date_time #update_date_time} => Time
|
1687
|
+
# * {Types::GetMetadataTransferJobResponse#status #status} => Types::MetadataTransferJobStatus
|
1688
|
+
# * {Types::GetMetadataTransferJobResponse#progress #progress} => Types::MetadataTransferJobProgress
|
1689
|
+
#
|
1690
|
+
# @example Request syntax with placeholder values
|
1691
|
+
#
|
1692
|
+
# resp = client.get_metadata_transfer_job({
|
1693
|
+
# metadata_transfer_job_id: "Id", # required
|
1694
|
+
# })
|
1695
|
+
#
|
1696
|
+
# @example Response structure
|
1697
|
+
#
|
1698
|
+
# resp.metadata_transfer_job_id #=> String
|
1699
|
+
# resp.arn #=> String
|
1700
|
+
# resp.description #=> String
|
1701
|
+
# resp.sources #=> Array
|
1702
|
+
# resp.sources[0].type #=> String, one of "s3", "iotsitewise", "iottwinmaker"
|
1703
|
+
# resp.sources[0].s3_configuration.location #=> String
|
1704
|
+
# resp.sources[0].iot_site_wise_configuration.filters #=> Array
|
1705
|
+
# resp.sources[0].iot_site_wise_configuration.filters[0].filter_by_asset_model.asset_model_id #=> String
|
1706
|
+
# resp.sources[0].iot_site_wise_configuration.filters[0].filter_by_asset_model.asset_model_external_id #=> String
|
1707
|
+
# resp.sources[0].iot_site_wise_configuration.filters[0].filter_by_asset_model.include_offspring #=> Boolean
|
1708
|
+
# resp.sources[0].iot_site_wise_configuration.filters[0].filter_by_asset_model.include_assets #=> Boolean
|
1709
|
+
# resp.sources[0].iot_site_wise_configuration.filters[0].filter_by_asset.asset_id #=> String
|
1710
|
+
# resp.sources[0].iot_site_wise_configuration.filters[0].filter_by_asset.asset_external_id #=> String
|
1711
|
+
# resp.sources[0].iot_site_wise_configuration.filters[0].filter_by_asset.include_offspring #=> Boolean
|
1712
|
+
# resp.sources[0].iot_site_wise_configuration.filters[0].filter_by_asset.include_asset_model #=> Boolean
|
1713
|
+
# resp.sources[0].iot_twin_maker_configuration.workspace #=> String
|
1714
|
+
# resp.sources[0].iot_twin_maker_configuration.filters #=> Array
|
1715
|
+
# resp.sources[0].iot_twin_maker_configuration.filters[0].filter_by_component_type.component_type_id #=> String
|
1716
|
+
# resp.sources[0].iot_twin_maker_configuration.filters[0].filter_by_entity.entity_id #=> String
|
1717
|
+
# resp.destination.type #=> String, one of "s3", "iotsitewise", "iottwinmaker"
|
1718
|
+
# resp.destination.s3_configuration.location #=> String
|
1719
|
+
# resp.destination.iot_twin_maker_configuration.workspace #=> String
|
1720
|
+
# resp.metadata_transfer_job_role #=> String
|
1721
|
+
# resp.report_url #=> String
|
1722
|
+
# resp.creation_date_time #=> Time
|
1723
|
+
# resp.update_date_time #=> Time
|
1724
|
+
# resp.status.state #=> String, one of "VALIDATING", "PENDING", "RUNNING", "CANCELLING", "ERROR", "COMPLETED", "CANCELLED"
|
1725
|
+
# resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE"
|
1726
|
+
# resp.status.error.message #=> String
|
1727
|
+
# resp.status.queued_position #=> Integer
|
1728
|
+
# resp.progress.total_count #=> Integer
|
1729
|
+
# resp.progress.succeeded_count #=> Integer
|
1730
|
+
# resp.progress.skipped_count #=> Integer
|
1731
|
+
# resp.progress.failed_count #=> Integer
|
1732
|
+
#
|
1733
|
+
# @overload get_metadata_transfer_job(params = {})
|
1734
|
+
# @param [Hash] params ({})
|
1735
|
+
def get_metadata_transfer_job(params = {}, options = {})
|
1736
|
+
req = build_request(:get_metadata_transfer_job, params)
|
1737
|
+
req.send_request(options)
|
1738
|
+
end
|
1739
|
+
|
1379
1740
|
# Gets the pricing plan.
|
1380
1741
|
#
|
1381
1742
|
# @return [Types::GetPricingPlanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -1418,6 +1779,10 @@ module Aws::IoTTwinMaker
|
|
1418
1779
|
# @option params [String] :component_name
|
1419
1780
|
# The name of the component whose property values the operation returns.
|
1420
1781
|
#
|
1782
|
+
# @option params [String] :component_path
|
1783
|
+
# This string specifies the path to the composite component, starting
|
1784
|
+
# from the top-level component.
|
1785
|
+
#
|
1421
1786
|
# @option params [String] :component_type_id
|
1422
1787
|
# The ID of the component type whose property values the operation
|
1423
1788
|
# returns.
|
@@ -1458,6 +1823,7 @@ module Aws::IoTTwinMaker
|
|
1458
1823
|
#
|
1459
1824
|
# resp = client.get_property_value({
|
1460
1825
|
# component_name: "Name",
|
1826
|
+
# component_path: "ComponentPath",
|
1461
1827
|
# component_type_id: "ComponentTypeId",
|
1462
1828
|
# entity_id: "EntityId",
|
1463
1829
|
# selected_properties: ["String"], # required
|
@@ -1507,6 +1873,7 @@ module Aws::IoTTwinMaker
|
|
1507
1873
|
#
|
1508
1874
|
# resp.property_values #=> Hash
|
1509
1875
|
# resp.property_values["Name"].property_reference.component_name #=> String
|
1876
|
+
# resp.property_values["Name"].property_reference.component_path #=> String
|
1510
1877
|
# resp.property_values["Name"].property_reference.external_id_property #=> Hash
|
1511
1878
|
# resp.property_values["Name"].property_reference.external_id_property["String"] #=> String
|
1512
1879
|
# resp.property_values["Name"].property_reference.entity_id #=> String
|
@@ -1563,6 +1930,10 @@ module Aws::IoTTwinMaker
|
|
1563
1930
|
# @option params [String] :component_name
|
1564
1931
|
# The name of the component.
|
1565
1932
|
#
|
1933
|
+
# @option params [String] :component_path
|
1934
|
+
# This string specifies the path to the composite component, starting
|
1935
|
+
# from the top-level component.
|
1936
|
+
#
|
1566
1937
|
# @option params [String] :component_type_id
|
1567
1938
|
# The ID of the component type.
|
1568
1939
|
#
|
@@ -1627,6 +1998,7 @@ module Aws::IoTTwinMaker
|
|
1627
1998
|
# workspace_id: "Id", # required
|
1628
1999
|
# entity_id: "EntityId",
|
1629
2000
|
# component_name: "Name",
|
2001
|
+
# component_path: "ComponentPath",
|
1630
2002
|
# component_type_id: "ComponentTypeId",
|
1631
2003
|
# selected_properties: ["String"], # required
|
1632
2004
|
# property_filters: [
|
@@ -1674,6 +2046,7 @@ module Aws::IoTTwinMaker
|
|
1674
2046
|
#
|
1675
2047
|
# resp.property_values #=> Array
|
1676
2048
|
# resp.property_values[0].entity_property_reference.component_name #=> String
|
2049
|
+
# resp.property_values[0].entity_property_reference.component_path #=> String
|
1677
2050
|
# resp.property_values[0].entity_property_reference.external_id_property #=> Hash
|
1678
2051
|
# resp.property_values[0].entity_property_reference.external_id_property["String"] #=> String
|
1679
2052
|
# resp.property_values[0].entity_property_reference.entity_id #=> String
|
@@ -1792,7 +2165,7 @@ module Aws::IoTTwinMaker
|
|
1792
2165
|
# resp.sync_source #=> String
|
1793
2166
|
# resp.sync_role #=> String
|
1794
2167
|
# resp.status.state #=> String, one of "CREATING", "INITIALIZING", "ACTIVE", "DELETING", "ERROR"
|
1795
|
-
# resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR"
|
2168
|
+
# resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE"
|
1796
2169
|
# resp.status.error.message #=> String
|
1797
2170
|
# resp.creation_date_time #=> Time
|
1798
2171
|
# resp.update_date_time #=> Time
|
@@ -1814,6 +2187,7 @@ module Aws::IoTTwinMaker
|
|
1814
2187
|
# * {Types::GetWorkspaceResponse#workspace_id #workspace_id} => String
|
1815
2188
|
# * {Types::GetWorkspaceResponse#arn #arn} => String
|
1816
2189
|
# * {Types::GetWorkspaceResponse#description #description} => String
|
2190
|
+
# * {Types::GetWorkspaceResponse#linked_services #linked_services} => Array<String>
|
1817
2191
|
# * {Types::GetWorkspaceResponse#s3_location #s3_location} => String
|
1818
2192
|
# * {Types::GetWorkspaceResponse#role #role} => String
|
1819
2193
|
# * {Types::GetWorkspaceResponse#creation_date_time #creation_date_time} => Time
|
@@ -1830,6 +2204,8 @@ module Aws::IoTTwinMaker
|
|
1830
2204
|
# resp.workspace_id #=> String
|
1831
2205
|
# resp.arn #=> String
|
1832
2206
|
# resp.description #=> String
|
2207
|
+
# resp.linked_services #=> Array
|
2208
|
+
# resp.linked_services[0] #=> String
|
1833
2209
|
# resp.s3_location #=> String
|
1834
2210
|
# resp.role #=> String
|
1835
2211
|
# resp.creation_date_time #=> Time
|
@@ -1893,7 +2269,7 @@ module Aws::IoTTwinMaker
|
|
1893
2269
|
# resp.component_type_summaries[0].update_date_time #=> Time
|
1894
2270
|
# resp.component_type_summaries[0].description #=> String
|
1895
2271
|
# resp.component_type_summaries[0].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1896
|
-
# resp.component_type_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR"
|
2272
|
+
# resp.component_type_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE"
|
1897
2273
|
# resp.component_type_summaries[0].status.error.message #=> String
|
1898
2274
|
# resp.component_type_summaries[0].component_type_name #=> String
|
1899
2275
|
# resp.next_token #=> String
|
@@ -1906,6 +2282,68 @@ module Aws::IoTTwinMaker
|
|
1906
2282
|
req.send_request(options)
|
1907
2283
|
end
|
1908
2284
|
|
2285
|
+
# This API lists the components of an entity.
|
2286
|
+
#
|
2287
|
+
# @option params [required, String] :workspace_id
|
2288
|
+
# The workspace ID.
|
2289
|
+
#
|
2290
|
+
# @option params [required, String] :entity_id
|
2291
|
+
# The ID for the entity whose metadata (component/properties) is
|
2292
|
+
# returned by the operation.
|
2293
|
+
#
|
2294
|
+
# @option params [String] :component_path
|
2295
|
+
# This string specifies the path to the composite component, starting
|
2296
|
+
# from the top-level component.
|
2297
|
+
#
|
2298
|
+
# @option params [Integer] :max_results
|
2299
|
+
# The maximum number of results returned at one time. The default is 25.
|
2300
|
+
#
|
2301
|
+
# @option params [String] :next_token
|
2302
|
+
# The string that specifies the next page of results.
|
2303
|
+
#
|
2304
|
+
# @return [Types::ListComponentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2305
|
+
#
|
2306
|
+
# * {Types::ListComponentsResponse#component_summaries #component_summaries} => Array<Types::ComponentSummary>
|
2307
|
+
# * {Types::ListComponentsResponse#next_token #next_token} => String
|
2308
|
+
#
|
2309
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2310
|
+
#
|
2311
|
+
# @example Request syntax with placeholder values
|
2312
|
+
#
|
2313
|
+
# resp = client.list_components({
|
2314
|
+
# workspace_id: "Id", # required
|
2315
|
+
# entity_id: "EntityId", # required
|
2316
|
+
# component_path: "ComponentPath",
|
2317
|
+
# max_results: 1,
|
2318
|
+
# next_token: "NextToken",
|
2319
|
+
# })
|
2320
|
+
#
|
2321
|
+
# @example Response structure
|
2322
|
+
#
|
2323
|
+
# resp.component_summaries #=> Array
|
2324
|
+
# resp.component_summaries[0].component_name #=> String
|
2325
|
+
# resp.component_summaries[0].component_type_id #=> String
|
2326
|
+
# resp.component_summaries[0].defined_in #=> String
|
2327
|
+
# resp.component_summaries[0].description #=> String
|
2328
|
+
# resp.component_summaries[0].property_groups #=> Hash
|
2329
|
+
# resp.component_summaries[0].property_groups["Name"].group_type #=> String, one of "TABULAR"
|
2330
|
+
# resp.component_summaries[0].property_groups["Name"].property_names #=> Array
|
2331
|
+
# resp.component_summaries[0].property_groups["Name"].property_names[0] #=> String
|
2332
|
+
# resp.component_summaries[0].property_groups["Name"].is_inherited #=> Boolean
|
2333
|
+
# resp.component_summaries[0].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
2334
|
+
# resp.component_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE"
|
2335
|
+
# resp.component_summaries[0].status.error.message #=> String
|
2336
|
+
# resp.component_summaries[0].sync_source #=> String
|
2337
|
+
# resp.component_summaries[0].component_path #=> String
|
2338
|
+
# resp.next_token #=> String
|
2339
|
+
#
|
2340
|
+
# @overload list_components(params = {})
|
2341
|
+
# @param [Hash] params ({})
|
2342
|
+
def list_components(params = {}, options = {})
|
2343
|
+
req = build_request(:list_components, params)
|
2344
|
+
req.send_request(options)
|
2345
|
+
end
|
2346
|
+
|
1909
2347
|
# Lists all entities in a workspace.
|
1910
2348
|
#
|
1911
2349
|
# @option params [required, String] :workspace_id
|
@@ -1957,7 +2395,7 @@ module Aws::IoTTwinMaker
|
|
1957
2395
|
# resp.entity_summaries[0].arn #=> String
|
1958
2396
|
# resp.entity_summaries[0].parent_entity_id #=> String
|
1959
2397
|
# resp.entity_summaries[0].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1960
|
-
# resp.entity_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR"
|
2398
|
+
# resp.entity_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE"
|
1961
2399
|
# resp.entity_summaries[0].status.error.message #=> String
|
1962
2400
|
# resp.entity_summaries[0].description #=> String
|
1963
2401
|
# resp.entity_summaries[0].has_child_entities #=> Boolean
|
@@ -1972,6 +2410,175 @@ module Aws::IoTTwinMaker
|
|
1972
2410
|
req.send_request(options)
|
1973
2411
|
end
|
1974
2412
|
|
2413
|
+
# Lists the metadata transfer jobs.
|
2414
|
+
#
|
2415
|
+
# @option params [required, String] :source_type
|
2416
|
+
# The metadata transfer job's source type.
|
2417
|
+
#
|
2418
|
+
# @option params [required, String] :destination_type
|
2419
|
+
# The metadata transfer job's destination type.
|
2420
|
+
#
|
2421
|
+
# @option params [Array<Types::ListMetadataTransferJobsFilter>] :filters
|
2422
|
+
# An object that filters metadata transfer jobs.
|
2423
|
+
#
|
2424
|
+
# @option params [String] :next_token
|
2425
|
+
# The string that specifies the next page of results.
|
2426
|
+
#
|
2427
|
+
# @option params [Integer] :max_results
|
2428
|
+
# The maximum number of results to return at one time.
|
2429
|
+
#
|
2430
|
+
# @return [Types::ListMetadataTransferJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2431
|
+
#
|
2432
|
+
# * {Types::ListMetadataTransferJobsResponse#metadata_transfer_job_summaries #metadata_transfer_job_summaries} => Array<Types::MetadataTransferJobSummary>
|
2433
|
+
# * {Types::ListMetadataTransferJobsResponse#next_token #next_token} => String
|
2434
|
+
#
|
2435
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2436
|
+
#
|
2437
|
+
# @example Request syntax with placeholder values
|
2438
|
+
#
|
2439
|
+
# resp = client.list_metadata_transfer_jobs({
|
2440
|
+
# source_type: "s3", # required, accepts s3, iotsitewise, iottwinmaker
|
2441
|
+
# destination_type: "s3", # required, accepts s3, iotsitewise, iottwinmaker
|
2442
|
+
# filters: [
|
2443
|
+
# {
|
2444
|
+
# workspace_id: "Id",
|
2445
|
+
# state: "VALIDATING", # accepts VALIDATING, PENDING, RUNNING, CANCELLING, ERROR, COMPLETED, CANCELLED
|
2446
|
+
# },
|
2447
|
+
# ],
|
2448
|
+
# next_token: "NextToken",
|
2449
|
+
# max_results: 1,
|
2450
|
+
# })
|
2451
|
+
#
|
2452
|
+
# @example Response structure
|
2453
|
+
#
|
2454
|
+
# resp.metadata_transfer_job_summaries #=> Array
|
2455
|
+
# resp.metadata_transfer_job_summaries[0].metadata_transfer_job_id #=> String
|
2456
|
+
# resp.metadata_transfer_job_summaries[0].arn #=> String
|
2457
|
+
# resp.metadata_transfer_job_summaries[0].creation_date_time #=> Time
|
2458
|
+
# resp.metadata_transfer_job_summaries[0].update_date_time #=> Time
|
2459
|
+
# resp.metadata_transfer_job_summaries[0].status.state #=> String, one of "VALIDATING", "PENDING", "RUNNING", "CANCELLING", "ERROR", "COMPLETED", "CANCELLED"
|
2460
|
+
# resp.metadata_transfer_job_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE"
|
2461
|
+
# resp.metadata_transfer_job_summaries[0].status.error.message #=> String
|
2462
|
+
# resp.metadata_transfer_job_summaries[0].status.queued_position #=> Integer
|
2463
|
+
# resp.metadata_transfer_job_summaries[0].progress.total_count #=> Integer
|
2464
|
+
# resp.metadata_transfer_job_summaries[0].progress.succeeded_count #=> Integer
|
2465
|
+
# resp.metadata_transfer_job_summaries[0].progress.skipped_count #=> Integer
|
2466
|
+
# resp.metadata_transfer_job_summaries[0].progress.failed_count #=> Integer
|
2467
|
+
# resp.next_token #=> String
|
2468
|
+
#
|
2469
|
+
# @overload list_metadata_transfer_jobs(params = {})
|
2470
|
+
# @param [Hash] params ({})
|
2471
|
+
def list_metadata_transfer_jobs(params = {}, options = {})
|
2472
|
+
req = build_request(:list_metadata_transfer_jobs, params)
|
2473
|
+
req.send_request(options)
|
2474
|
+
end
|
2475
|
+
|
2476
|
+
# This API lists the properties of a component.
|
2477
|
+
#
|
2478
|
+
# @option params [required, String] :workspace_id
|
2479
|
+
# The workspace ID.
|
2480
|
+
#
|
2481
|
+
# @option params [String] :component_name
|
2482
|
+
# The name of the component whose properties are returned by the
|
2483
|
+
# operation.
|
2484
|
+
#
|
2485
|
+
# @option params [String] :component_path
|
2486
|
+
# This string specifies the path to the composite component, starting
|
2487
|
+
# from the top-level component.
|
2488
|
+
#
|
2489
|
+
# @option params [required, String] :entity_id
|
2490
|
+
# The ID for the entity whose metadata (component/properties) is
|
2491
|
+
# returned by the operation.
|
2492
|
+
#
|
2493
|
+
# @option params [Integer] :max_results
|
2494
|
+
# The maximum number of results returned at one time. The default is 25.
|
2495
|
+
#
|
2496
|
+
# @option params [String] :next_token
|
2497
|
+
# The string that specifies the next page of results.
|
2498
|
+
#
|
2499
|
+
# @return [Types::ListPropertiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2500
|
+
#
|
2501
|
+
# * {Types::ListPropertiesResponse#property_summaries #property_summaries} => Array<Types::PropertySummary>
|
2502
|
+
# * {Types::ListPropertiesResponse#next_token #next_token} => String
|
2503
|
+
#
|
2504
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2505
|
+
#
|
2506
|
+
# @example Request syntax with placeholder values
|
2507
|
+
#
|
2508
|
+
# resp = client.list_properties({
|
2509
|
+
# workspace_id: "Id", # required
|
2510
|
+
# component_name: "Name",
|
2511
|
+
# component_path: "ComponentPath",
|
2512
|
+
# entity_id: "EntityId", # required
|
2513
|
+
# max_results: 1,
|
2514
|
+
# next_token: "NextToken",
|
2515
|
+
# })
|
2516
|
+
#
|
2517
|
+
# @example Response structure
|
2518
|
+
#
|
2519
|
+
# resp.property_summaries #=> Array
|
2520
|
+
# resp.property_summaries[0].definition.data_type.type #=> String, one of "RELATIONSHIP", "STRING", "LONG", "BOOLEAN", "INTEGER", "DOUBLE", "LIST", "MAP"
|
2521
|
+
# resp.property_summaries[0].definition.data_type.nested_type #=> Types::DataType
|
2522
|
+
# resp.property_summaries[0].definition.data_type.allowed_values #=> Array
|
2523
|
+
# resp.property_summaries[0].definition.data_type.allowed_values[0].boolean_value #=> Boolean
|
2524
|
+
# resp.property_summaries[0].definition.data_type.allowed_values[0].double_value #=> Float
|
2525
|
+
# resp.property_summaries[0].definition.data_type.allowed_values[0].integer_value #=> Integer
|
2526
|
+
# resp.property_summaries[0].definition.data_type.allowed_values[0].long_value #=> Integer
|
2527
|
+
# resp.property_summaries[0].definition.data_type.allowed_values[0].string_value #=> String
|
2528
|
+
# resp.property_summaries[0].definition.data_type.allowed_values[0].list_value #=> Types::DataValueList
|
2529
|
+
# resp.property_summaries[0].definition.data_type.allowed_values[0].map_value #=> Hash
|
2530
|
+
# resp.property_summaries[0].definition.data_type.allowed_values[0].map_value["String"] #=> Types::DataValue
|
2531
|
+
# resp.property_summaries[0].definition.data_type.allowed_values[0].relationship_value.target_entity_id #=> String
|
2532
|
+
# resp.property_summaries[0].definition.data_type.allowed_values[0].relationship_value.target_component_name #=> String
|
2533
|
+
# resp.property_summaries[0].definition.data_type.allowed_values[0].expression #=> String
|
2534
|
+
# resp.property_summaries[0].definition.data_type.unit_of_measure #=> String
|
2535
|
+
# resp.property_summaries[0].definition.data_type.relationship.target_component_type_id #=> String
|
2536
|
+
# resp.property_summaries[0].definition.data_type.relationship.relationship_type #=> String
|
2537
|
+
# resp.property_summaries[0].definition.is_time_series #=> Boolean
|
2538
|
+
# resp.property_summaries[0].definition.is_required_in_entity #=> Boolean
|
2539
|
+
# resp.property_summaries[0].definition.is_external_id #=> Boolean
|
2540
|
+
# resp.property_summaries[0].definition.is_stored_externally #=> Boolean
|
2541
|
+
# resp.property_summaries[0].definition.is_imported #=> Boolean
|
2542
|
+
# resp.property_summaries[0].definition.is_final #=> Boolean
|
2543
|
+
# resp.property_summaries[0].definition.is_inherited #=> Boolean
|
2544
|
+
# resp.property_summaries[0].definition.default_value.boolean_value #=> Boolean
|
2545
|
+
# resp.property_summaries[0].definition.default_value.double_value #=> Float
|
2546
|
+
# resp.property_summaries[0].definition.default_value.integer_value #=> Integer
|
2547
|
+
# resp.property_summaries[0].definition.default_value.long_value #=> Integer
|
2548
|
+
# resp.property_summaries[0].definition.default_value.string_value #=> String
|
2549
|
+
# resp.property_summaries[0].definition.default_value.list_value #=> Array
|
2550
|
+
# resp.property_summaries[0].definition.default_value.list_value[0] #=> Types::DataValue
|
2551
|
+
# resp.property_summaries[0].definition.default_value.map_value #=> Hash
|
2552
|
+
# resp.property_summaries[0].definition.default_value.map_value["String"] #=> Types::DataValue
|
2553
|
+
# resp.property_summaries[0].definition.default_value.relationship_value.target_entity_id #=> String
|
2554
|
+
# resp.property_summaries[0].definition.default_value.relationship_value.target_component_name #=> String
|
2555
|
+
# resp.property_summaries[0].definition.default_value.expression #=> String
|
2556
|
+
# resp.property_summaries[0].definition.configuration #=> Hash
|
2557
|
+
# resp.property_summaries[0].definition.configuration["Name"] #=> String
|
2558
|
+
# resp.property_summaries[0].definition.display_name #=> String
|
2559
|
+
# resp.property_summaries[0].property_name #=> String
|
2560
|
+
# resp.property_summaries[0].value.boolean_value #=> Boolean
|
2561
|
+
# resp.property_summaries[0].value.double_value #=> Float
|
2562
|
+
# resp.property_summaries[0].value.integer_value #=> Integer
|
2563
|
+
# resp.property_summaries[0].value.long_value #=> Integer
|
2564
|
+
# resp.property_summaries[0].value.string_value #=> String
|
2565
|
+
# resp.property_summaries[0].value.list_value #=> Array
|
2566
|
+
# resp.property_summaries[0].value.list_value[0] #=> Types::DataValue
|
2567
|
+
# resp.property_summaries[0].value.map_value #=> Hash
|
2568
|
+
# resp.property_summaries[0].value.map_value["String"] #=> Types::DataValue
|
2569
|
+
# resp.property_summaries[0].value.relationship_value.target_entity_id #=> String
|
2570
|
+
# resp.property_summaries[0].value.relationship_value.target_component_name #=> String
|
2571
|
+
# resp.property_summaries[0].value.expression #=> String
|
2572
|
+
# resp.property_summaries[0].are_all_property_values_returned #=> Boolean
|
2573
|
+
# resp.next_token #=> String
|
2574
|
+
#
|
2575
|
+
# @overload list_properties(params = {})
|
2576
|
+
# @param [Hash] params ({})
|
2577
|
+
def list_properties(params = {}, options = {})
|
2578
|
+
req = build_request(:list_properties, params)
|
2579
|
+
req.send_request(options)
|
2580
|
+
end
|
2581
|
+
|
1975
2582
|
# Lists all scenes in a workspace.
|
1976
2583
|
#
|
1977
2584
|
# @option params [required, String] :workspace_id
|
@@ -2052,7 +2659,7 @@ module Aws::IoTTwinMaker
|
|
2052
2659
|
# resp.sync_job_summaries[0].workspace_id #=> String
|
2053
2660
|
# resp.sync_job_summaries[0].sync_source #=> String
|
2054
2661
|
# resp.sync_job_summaries[0].status.state #=> String, one of "CREATING", "INITIALIZING", "ACTIVE", "DELETING", "ERROR"
|
2055
|
-
# resp.sync_job_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR"
|
2662
|
+
# resp.sync_job_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE"
|
2056
2663
|
# resp.sync_job_summaries[0].status.error.message #=> String
|
2057
2664
|
# resp.sync_job_summaries[0].creation_date_time #=> Time
|
2058
2665
|
# resp.sync_job_summaries[0].update_date_time #=> Time
|
@@ -2128,7 +2735,7 @@ module Aws::IoTTwinMaker
|
|
2128
2735
|
# resp.sync_resources[0].external_id #=> String
|
2129
2736
|
# resp.sync_resources[0].resource_id #=> String
|
2130
2737
|
# resp.sync_resources[0].status.state #=> String, one of "INITIALIZING", "PROCESSING", "DELETED", "IN_SYNC", "ERROR"
|
2131
|
-
# resp.sync_resources[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR"
|
2738
|
+
# resp.sync_resources[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE"
|
2132
2739
|
# resp.sync_resources[0].status.error.message #=> String
|
2133
2740
|
# resp.sync_resources[0].update_date_time #=> Time
|
2134
2741
|
# resp.next_token #=> String
|
@@ -2211,6 +2818,8 @@ module Aws::IoTTwinMaker
|
|
2211
2818
|
# resp.workspace_summaries[0].workspace_id #=> String
|
2212
2819
|
# resp.workspace_summaries[0].arn #=> String
|
2213
2820
|
# resp.workspace_summaries[0].description #=> String
|
2821
|
+
# resp.workspace_summaries[0].linked_services #=> Array
|
2822
|
+
# resp.workspace_summaries[0].linked_services[0] #=> String
|
2214
2823
|
# resp.workspace_summaries[0].creation_date_time #=> Time
|
2215
2824
|
# resp.workspace_summaries[0].update_date_time #=> Time
|
2216
2825
|
# resp.next_token #=> String
|
@@ -2306,6 +2915,11 @@ module Aws::IoTTwinMaker
|
|
2306
2915
|
# @option params [String] :component_type_name
|
2307
2916
|
# The component type name.
|
2308
2917
|
#
|
2918
|
+
# @option params [Hash<String,Types::CompositeComponentTypeRequest>] :composite_component_types
|
2919
|
+
# This is an object that maps strings to `compositeComponentTypes` of
|
2920
|
+
# the `componentType`. `CompositeComponentType` is referenced by
|
2921
|
+
# `componentTypeId`.
|
2922
|
+
#
|
2309
2923
|
# @return [Types::UpdateComponentTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2310
2924
|
#
|
2311
2925
|
# * {Types::UpdateComponentTypeResponse#workspace_id #workspace_id} => String
|
@@ -2407,6 +3021,11 @@ module Aws::IoTTwinMaker
|
|
2407
3021
|
# },
|
2408
3022
|
# },
|
2409
3023
|
# component_type_name: "ComponentTypeName",
|
3024
|
+
# composite_component_types: {
|
3025
|
+
# "Name" => {
|
3026
|
+
# component_type_id: "ComponentTypeId",
|
3027
|
+
# },
|
3028
|
+
# },
|
2410
3029
|
# })
|
2411
3030
|
#
|
2412
3031
|
# @example Response structure
|
@@ -2441,6 +3060,11 @@ module Aws::IoTTwinMaker
|
|
2441
3060
|
# An object that maps strings to the component updates in the request.
|
2442
3061
|
# Each string in the mapping must be unique to this object.
|
2443
3062
|
#
|
3063
|
+
# @option params [Hash<String,Types::CompositeComponentUpdateRequest>] :composite_component_updates
|
3064
|
+
# This is an object that maps strings to `compositeComponent` updates in
|
3065
|
+
# the request. Each key of the map represents the `componentPath` of the
|
3066
|
+
# `compositeComponent`.
|
3067
|
+
#
|
2444
3068
|
# @option params [Types::ParentEntityUpdateRequest] :parent_entity_update
|
2445
3069
|
# An object that describes the update request for a parent entity.
|
2446
3070
|
#
|
@@ -2562,6 +3186,111 @@ module Aws::IoTTwinMaker
|
|
2562
3186
|
# },
|
2563
3187
|
# },
|
2564
3188
|
# },
|
3189
|
+
# composite_component_updates: {
|
3190
|
+
# "ComponentPath" => {
|
3191
|
+
# update_type: "CREATE", # accepts CREATE, UPDATE, DELETE
|
3192
|
+
# description: "Description",
|
3193
|
+
# property_updates: {
|
3194
|
+
# "Name" => {
|
3195
|
+
# definition: {
|
3196
|
+
# data_type: {
|
3197
|
+
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
3198
|
+
# nested_type: {
|
3199
|
+
# # recursive DataType
|
3200
|
+
# },
|
3201
|
+
# allowed_values: [
|
3202
|
+
# {
|
3203
|
+
# boolean_value: false,
|
3204
|
+
# double_value: 1.0,
|
3205
|
+
# integer_value: 1,
|
3206
|
+
# long_value: 1,
|
3207
|
+
# string_value: "String",
|
3208
|
+
# list_value: {
|
3209
|
+
# # recursive DataValueList
|
3210
|
+
# },
|
3211
|
+
# map_value: {
|
3212
|
+
# "String" => {
|
3213
|
+
# # recursive DataValue
|
3214
|
+
# },
|
3215
|
+
# },
|
3216
|
+
# relationship_value: {
|
3217
|
+
# target_entity_id: "EntityId",
|
3218
|
+
# target_component_name: "Name",
|
3219
|
+
# },
|
3220
|
+
# expression: "Expression",
|
3221
|
+
# },
|
3222
|
+
# ],
|
3223
|
+
# unit_of_measure: "String",
|
3224
|
+
# relationship: {
|
3225
|
+
# target_component_type_id: "ComponentTypeId",
|
3226
|
+
# relationship_type: "String",
|
3227
|
+
# },
|
3228
|
+
# },
|
3229
|
+
# is_required_in_entity: false,
|
3230
|
+
# is_external_id: false,
|
3231
|
+
# is_stored_externally: false,
|
3232
|
+
# is_time_series: false,
|
3233
|
+
# default_value: {
|
3234
|
+
# boolean_value: false,
|
3235
|
+
# double_value: 1.0,
|
3236
|
+
# integer_value: 1,
|
3237
|
+
# long_value: 1,
|
3238
|
+
# string_value: "String",
|
3239
|
+
# list_value: [
|
3240
|
+
# {
|
3241
|
+
# # recursive DataValue
|
3242
|
+
# },
|
3243
|
+
# ],
|
3244
|
+
# map_value: {
|
3245
|
+
# "String" => {
|
3246
|
+
# # recursive DataValue
|
3247
|
+
# },
|
3248
|
+
# },
|
3249
|
+
# relationship_value: {
|
3250
|
+
# target_entity_id: "EntityId",
|
3251
|
+
# target_component_name: "Name",
|
3252
|
+
# },
|
3253
|
+
# expression: "Expression",
|
3254
|
+
# },
|
3255
|
+
# configuration: {
|
3256
|
+
# "Name" => "Value",
|
3257
|
+
# },
|
3258
|
+
# display_name: "PropertyDisplayName",
|
3259
|
+
# },
|
3260
|
+
# value: {
|
3261
|
+
# boolean_value: false,
|
3262
|
+
# double_value: 1.0,
|
3263
|
+
# integer_value: 1,
|
3264
|
+
# long_value: 1,
|
3265
|
+
# string_value: "String",
|
3266
|
+
# list_value: [
|
3267
|
+
# {
|
3268
|
+
# # recursive DataValue
|
3269
|
+
# },
|
3270
|
+
# ],
|
3271
|
+
# map_value: {
|
3272
|
+
# "String" => {
|
3273
|
+
# # recursive DataValue
|
3274
|
+
# },
|
3275
|
+
# },
|
3276
|
+
# relationship_value: {
|
3277
|
+
# target_entity_id: "EntityId",
|
3278
|
+
# target_component_name: "Name",
|
3279
|
+
# },
|
3280
|
+
# expression: "Expression",
|
3281
|
+
# },
|
3282
|
+
# update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
|
3283
|
+
# },
|
3284
|
+
# },
|
3285
|
+
# property_group_updates: {
|
3286
|
+
# "Name" => {
|
3287
|
+
# group_type: "TABULAR", # accepts TABULAR
|
3288
|
+
# property_names: ["Name"],
|
3289
|
+
# update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
|
3290
|
+
# },
|
3291
|
+
# },
|
3292
|
+
# },
|
3293
|
+
# },
|
2565
3294
|
# parent_entity_update: {
|
2566
3295
|
# update_type: "UPDATE", # required, accepts UPDATE, DELETE
|
2567
3296
|
# parent_entity_id: "ParentEntityId",
|
@@ -2686,6 +3415,10 @@ module Aws::IoTTwinMaker
|
|
2686
3415
|
# @option params [String] :role
|
2687
3416
|
# The ARN of the execution role associated with the workspace.
|
2688
3417
|
#
|
3418
|
+
# @option params [String] :s3_location
|
3419
|
+
# The ARN of the S3 bucket where resources associated with the workspace
|
3420
|
+
# are stored.
|
3421
|
+
#
|
2689
3422
|
# @return [Types::UpdateWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2690
3423
|
#
|
2691
3424
|
# * {Types::UpdateWorkspaceResponse#update_date_time #update_date_time} => Time
|
@@ -2696,6 +3429,7 @@ module Aws::IoTTwinMaker
|
|
2696
3429
|
# workspace_id: "Id", # required
|
2697
3430
|
# description: "Description",
|
2698
3431
|
# role: "RoleArn",
|
3432
|
+
# s3_location: "S3Location",
|
2699
3433
|
# })
|
2700
3434
|
#
|
2701
3435
|
# @example Response structure
|
@@ -2722,7 +3456,7 @@ module Aws::IoTTwinMaker
|
|
2722
3456
|
params: params,
|
2723
3457
|
config: config)
|
2724
3458
|
context[:gem_name] = 'aws-sdk-iottwinmaker'
|
2725
|
-
context[:gem_version] = '1.
|
3459
|
+
context[:gem_version] = '1.19.0'
|
2726
3460
|
Seahorse::Client::Request.new(handlers, context)
|
2727
3461
|
end
|
2728
3462
|
|