aws-sdk-iottwinmaker 1.6.0 → 1.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iottwinmaker/client.rb +1002 -471
- data/lib/aws-sdk-iottwinmaker/client_api.rb +557 -118
- data/lib/aws-sdk-iottwinmaker/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-iottwinmaker/endpoint_provider.rb +75 -77
- data/lib/aws-sdk-iottwinmaker/endpoints.rb +112 -0
- data/lib/aws-sdk-iottwinmaker/errors.rb +20 -0
- data/lib/aws-sdk-iottwinmaker/plugins/endpoints.rb +16 -0
- data/lib/aws-sdk-iottwinmaker/types.rb +1426 -1976
- data/lib/aws-sdk-iottwinmaker.rb +1 -1
- metadata +2 -2
@@ -370,13 +370,13 @@ module Aws::IoTTwinMaker
|
|
370
370
|
|
371
371
|
# Sets values for multiple time series properties.
|
372
372
|
#
|
373
|
+
# @option params [required, String] :workspace_id
|
374
|
+
# The ID of the workspace that contains the properties to set.
|
375
|
+
#
|
373
376
|
# @option params [required, Array<Types::PropertyValueEntry>] :entries
|
374
377
|
# An object that maps strings to the property value entries to set. Each
|
375
378
|
# string in the mapping must be unique to this object.
|
376
379
|
#
|
377
|
-
# @option params [required, String] :workspace_id
|
378
|
-
# The ID of the workspace that contains the properties to set.
|
379
|
-
#
|
380
380
|
# @return [Types::BatchPutPropertyValuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
381
381
|
#
|
382
382
|
# * {Types::BatchPutPropertyValuesResponse#error_entries #error_entries} => Array<Types::BatchPutPropertyErrorEntry>
|
@@ -384,75 +384,75 @@ module Aws::IoTTwinMaker
|
|
384
384
|
# @example Request syntax with placeholder values
|
385
385
|
#
|
386
386
|
# resp = client.batch_put_property_values({
|
387
|
+
# workspace_id: "Id", # required
|
387
388
|
# entries: [ # required
|
388
389
|
# {
|
389
390
|
# entity_property_reference: { # required
|
390
391
|
# component_name: "Name",
|
391
|
-
# entity_id: "EntityId",
|
392
392
|
# external_id_property: {
|
393
393
|
# "String" => "String",
|
394
394
|
# },
|
395
|
+
# entity_id: "EntityId",
|
395
396
|
# property_name: "Name", # required
|
396
397
|
# },
|
397
398
|
# property_values: [
|
398
399
|
# {
|
399
|
-
# time: "Time",
|
400
400
|
# timestamp: Time.now,
|
401
401
|
# value: { # required
|
402
402
|
# boolean_value: false,
|
403
403
|
# double_value: 1.0,
|
404
|
-
# expression: "Expression",
|
405
404
|
# integer_value: 1,
|
405
|
+
# long_value: 1,
|
406
|
+
# string_value: "String",
|
406
407
|
# list_value: [
|
407
408
|
# {
|
408
409
|
# # recursive DataValue
|
409
410
|
# },
|
410
411
|
# ],
|
411
|
-
# long_value: 1,
|
412
412
|
# map_value: {
|
413
413
|
# "String" => {
|
414
414
|
# # recursive DataValue
|
415
415
|
# },
|
416
416
|
# },
|
417
417
|
# relationship_value: {
|
418
|
-
# target_component_name: "Name",
|
419
418
|
# target_entity_id: "EntityId",
|
419
|
+
# target_component_name: "Name",
|
420
420
|
# },
|
421
|
-
#
|
421
|
+
# expression: "Expression",
|
422
422
|
# },
|
423
|
+
# time: "Time",
|
423
424
|
# },
|
424
425
|
# ],
|
425
426
|
# },
|
426
427
|
# ],
|
427
|
-
# workspace_id: "Id", # required
|
428
428
|
# })
|
429
429
|
#
|
430
430
|
# @example Response structure
|
431
431
|
#
|
432
432
|
# resp.error_entries #=> Array
|
433
433
|
# resp.error_entries[0].errors #=> Array
|
434
|
+
# resp.error_entries[0].errors[0].error_code #=> String
|
435
|
+
# resp.error_entries[0].errors[0].error_message #=> String
|
434
436
|
# resp.error_entries[0].errors[0].entry.entity_property_reference.component_name #=> String
|
435
|
-
# resp.error_entries[0].errors[0].entry.entity_property_reference.entity_id #=> String
|
436
437
|
# resp.error_entries[0].errors[0].entry.entity_property_reference.external_id_property #=> Hash
|
437
438
|
# resp.error_entries[0].errors[0].entry.entity_property_reference.external_id_property["String"] #=> String
|
439
|
+
# resp.error_entries[0].errors[0].entry.entity_property_reference.entity_id #=> String
|
438
440
|
# resp.error_entries[0].errors[0].entry.entity_property_reference.property_name #=> String
|
439
441
|
# resp.error_entries[0].errors[0].entry.property_values #=> Array
|
440
|
-
# resp.error_entries[0].errors[0].entry.property_values[0].time #=> String
|
441
442
|
# resp.error_entries[0].errors[0].entry.property_values[0].timestamp #=> Time
|
442
443
|
# resp.error_entries[0].errors[0].entry.property_values[0].value.boolean_value #=> Boolean
|
443
444
|
# resp.error_entries[0].errors[0].entry.property_values[0].value.double_value #=> Float
|
444
|
-
# resp.error_entries[0].errors[0].entry.property_values[0].value.expression #=> String
|
445
445
|
# resp.error_entries[0].errors[0].entry.property_values[0].value.integer_value #=> Integer
|
446
|
+
# resp.error_entries[0].errors[0].entry.property_values[0].value.long_value #=> Integer
|
447
|
+
# resp.error_entries[0].errors[0].entry.property_values[0].value.string_value #=> String
|
446
448
|
# resp.error_entries[0].errors[0].entry.property_values[0].value.list_value #=> Array
|
447
449
|
# resp.error_entries[0].errors[0].entry.property_values[0].value.list_value[0] #=> Types::DataValue
|
448
|
-
# resp.error_entries[0].errors[0].entry.property_values[0].value.long_value #=> Integer
|
449
450
|
# resp.error_entries[0].errors[0].entry.property_values[0].value.map_value #=> Hash
|
450
451
|
# resp.error_entries[0].errors[0].entry.property_values[0].value.map_value["String"] #=> Types::DataValue
|
451
|
-
# resp.error_entries[0].errors[0].entry.property_values[0].value.relationship_value.target_component_name #=> String
|
452
452
|
# resp.error_entries[0].errors[0].entry.property_values[0].value.relationship_value.target_entity_id #=> String
|
453
|
-
# resp.error_entries[0].errors[0].entry.property_values[0].value.
|
454
|
-
# resp.error_entries[0].errors[0].
|
455
|
-
# resp.error_entries[0].errors[0].
|
453
|
+
# resp.error_entries[0].errors[0].entry.property_values[0].value.relationship_value.target_component_name #=> String
|
454
|
+
# resp.error_entries[0].errors[0].entry.property_values[0].value.expression #=> String
|
455
|
+
# resp.error_entries[0].errors[0].entry.property_values[0].time #=> String
|
456
456
|
#
|
457
457
|
# @overload batch_put_property_values(params = {})
|
458
458
|
# @param [Hash] params ({})
|
@@ -463,12 +463,24 @@ module Aws::IoTTwinMaker
|
|
463
463
|
|
464
464
|
# Creates a component type.
|
465
465
|
#
|
466
|
+
# @option params [required, String] :workspace_id
|
467
|
+
# The ID of the workspace that contains the component type.
|
468
|
+
#
|
469
|
+
# @option params [Boolean] :is_singleton
|
470
|
+
# A Boolean value that specifies whether an entity can have more than
|
471
|
+
# one component of this type.
|
472
|
+
#
|
466
473
|
# @option params [required, String] :component_type_id
|
467
474
|
# The ID of the component type.
|
468
475
|
#
|
469
476
|
# @option params [String] :description
|
470
477
|
# The description of the component type.
|
471
478
|
#
|
479
|
+
# @option params [Hash<String,Types::PropertyDefinitionRequest>] :property_definitions
|
480
|
+
# An object that maps strings to the property definitions in the
|
481
|
+
# component type. Each string in the mapping must be unique to this
|
482
|
+
# object.
|
483
|
+
#
|
472
484
|
# @option params [Array<String>] :extends_from
|
473
485
|
# Specifies the parent component type to extend.
|
474
486
|
#
|
@@ -476,20 +488,13 @@ module Aws::IoTTwinMaker
|
|
476
488
|
# An object that maps strings to the functions in the component type.
|
477
489
|
# Each string in the mapping must be unique to this object.
|
478
490
|
#
|
479
|
-
# @option params [Boolean] :is_singleton
|
480
|
-
# A Boolean value that specifies whether an entity can have more than
|
481
|
-
# one component of this type.
|
482
|
-
#
|
483
|
-
# @option params [Hash<String,Types::PropertyDefinitionRequest>] :property_definitions
|
484
|
-
# An object that maps strings to the property definitions in the
|
485
|
-
# component type. Each string in the mapping must be unique to this
|
486
|
-
# object.
|
487
|
-
#
|
488
491
|
# @option params [Hash<String,String>] :tags
|
489
492
|
# Metadata that you can use to manage the component type.
|
490
493
|
#
|
491
|
-
# @option params [
|
492
|
-
#
|
494
|
+
# @option params [Hash<String,Types::PropertyGroupRequest>] :property_groups
|
495
|
+
#
|
496
|
+
# @option params [String] :component_type_name
|
497
|
+
# A friendly name for the component type.
|
493
498
|
#
|
494
499
|
# @return [Types::CreateComponentTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
495
500
|
#
|
@@ -500,92 +505,100 @@ module Aws::IoTTwinMaker
|
|
500
505
|
# @example Request syntax with placeholder values
|
501
506
|
#
|
502
507
|
# resp = client.create_component_type({
|
508
|
+
# workspace_id: "Id", # required
|
509
|
+
# is_singleton: false,
|
503
510
|
# component_type_id: "ComponentTypeId", # required
|
504
511
|
# description: "Description",
|
505
|
-
# extends_from: ["ComponentTypeId"],
|
506
|
-
# functions: {
|
507
|
-
# "Name" => {
|
508
|
-
# implemented_by: {
|
509
|
-
# is_native: false,
|
510
|
-
# lambda: {
|
511
|
-
# arn: "LambdaArn", # required
|
512
|
-
# },
|
513
|
-
# },
|
514
|
-
# required_properties: ["Name"],
|
515
|
-
# scope: "ENTITY", # accepts ENTITY, WORKSPACE
|
516
|
-
# },
|
517
|
-
# },
|
518
|
-
# is_singleton: false,
|
519
512
|
# property_definitions: {
|
520
513
|
# "Name" => {
|
521
|
-
# configuration: {
|
522
|
-
# "Name" => "Value",
|
523
|
-
# },
|
524
514
|
# data_type: {
|
515
|
+
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
516
|
+
# nested_type: {
|
517
|
+
# # recursive DataType
|
518
|
+
# },
|
525
519
|
# allowed_values: [
|
526
520
|
# {
|
527
521
|
# boolean_value: false,
|
528
522
|
# double_value: 1.0,
|
529
|
-
# expression: "Expression",
|
530
523
|
# integer_value: 1,
|
524
|
+
# long_value: 1,
|
525
|
+
# string_value: "String",
|
531
526
|
# list_value: {
|
532
527
|
# # recursive DataValueList
|
533
528
|
# },
|
534
|
-
# long_value: 1,
|
535
529
|
# map_value: {
|
536
530
|
# "String" => {
|
537
531
|
# # recursive DataValue
|
538
532
|
# },
|
539
533
|
# },
|
540
534
|
# relationship_value: {
|
541
|
-
# target_component_name: "Name",
|
542
535
|
# target_entity_id: "EntityId",
|
536
|
+
# target_component_name: "Name",
|
543
537
|
# },
|
544
|
-
#
|
538
|
+
# expression: "Expression",
|
545
539
|
# },
|
546
540
|
# ],
|
547
|
-
#
|
548
|
-
# # recursive DataType
|
549
|
-
# },
|
541
|
+
# unit_of_measure: "String",
|
550
542
|
# relationship: {
|
551
|
-
# relationship_type: "String",
|
552
543
|
# target_component_type_id: "ComponentTypeId",
|
544
|
+
# relationship_type: "String",
|
553
545
|
# },
|
554
|
-
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
555
|
-
# unit_of_measure: "String",
|
556
546
|
# },
|
547
|
+
# is_required_in_entity: false,
|
548
|
+
# is_external_id: false,
|
549
|
+
# is_stored_externally: false,
|
550
|
+
# is_time_series: false,
|
557
551
|
# default_value: {
|
558
552
|
# boolean_value: false,
|
559
553
|
# double_value: 1.0,
|
560
|
-
# expression: "Expression",
|
561
554
|
# integer_value: 1,
|
555
|
+
# long_value: 1,
|
556
|
+
# string_value: "String",
|
562
557
|
# list_value: [
|
563
558
|
# {
|
564
559
|
# # recursive DataValue
|
565
560
|
# },
|
566
561
|
# ],
|
567
|
-
# long_value: 1,
|
568
562
|
# map_value: {
|
569
563
|
# "String" => {
|
570
564
|
# # recursive DataValue
|
571
565
|
# },
|
572
566
|
# },
|
573
567
|
# relationship_value: {
|
574
|
-
# target_component_name: "Name",
|
575
568
|
# target_entity_id: "EntityId",
|
569
|
+
# target_component_name: "Name",
|
576
570
|
# },
|
577
|
-
#
|
571
|
+
# expression: "Expression",
|
572
|
+
# },
|
573
|
+
# configuration: {
|
574
|
+
# "Name" => "Value",
|
575
|
+
# },
|
576
|
+
# display_name: "PropertyDisplayName",
|
577
|
+
# },
|
578
|
+
# },
|
579
|
+
# extends_from: ["ComponentTypeId"],
|
580
|
+
# functions: {
|
581
|
+
# "Name" => {
|
582
|
+
# required_properties: ["Name"],
|
583
|
+
# scope: "ENTITY", # accepts ENTITY, WORKSPACE
|
584
|
+
# implemented_by: {
|
585
|
+
# lambda: {
|
586
|
+
# arn: "LambdaArn", # required
|
587
|
+
# },
|
588
|
+
# is_native: false,
|
578
589
|
# },
|
579
|
-
# is_external_id: false,
|
580
|
-
# is_required_in_entity: false,
|
581
|
-
# is_stored_externally: false,
|
582
|
-
# is_time_series: false,
|
583
590
|
# },
|
584
591
|
# },
|
585
592
|
# tags: {
|
586
593
|
# "TagKey" => "TagValue",
|
587
594
|
# },
|
588
|
-
#
|
595
|
+
# property_groups: {
|
596
|
+
# "Name" => {
|
597
|
+
# group_type: "TABULAR", # accepts TABULAR
|
598
|
+
# property_names: ["Name"],
|
599
|
+
# },
|
600
|
+
# },
|
601
|
+
# component_type_name: "ComponentTypeName",
|
589
602
|
# })
|
590
603
|
#
|
591
604
|
# @example Response structure
|
@@ -603,12 +616,8 @@ module Aws::IoTTwinMaker
|
|
603
616
|
|
604
617
|
# Creates an entity.
|
605
618
|
#
|
606
|
-
# @option params [
|
607
|
-
#
|
608
|
-
# string in the mapping must be unique to this object.
|
609
|
-
#
|
610
|
-
# @option params [String] :description
|
611
|
-
# The description of the entity.
|
619
|
+
# @option params [required, String] :workspace_id
|
620
|
+
# The ID of the workspace that contains the entity.
|
612
621
|
#
|
613
622
|
# @option params [String] :entity_id
|
614
623
|
# The ID of the entity.
|
@@ -616,137 +625,149 @@ module Aws::IoTTwinMaker
|
|
616
625
|
# @option params [required, String] :entity_name
|
617
626
|
# The name of the entity.
|
618
627
|
#
|
628
|
+
# @option params [String] :description
|
629
|
+
# The description of the entity.
|
630
|
+
#
|
631
|
+
# @option params [Hash<String,Types::ComponentRequest>] :components
|
632
|
+
# An object that maps strings to the components in the entity. Each
|
633
|
+
# string in the mapping must be unique to this object.
|
634
|
+
#
|
619
635
|
# @option params [String] :parent_entity_id
|
620
636
|
# The ID of the entity's parent entity.
|
621
637
|
#
|
622
638
|
# @option params [Hash<String,String>] :tags
|
623
639
|
# Metadata that you can use to manage the entity.
|
624
640
|
#
|
625
|
-
# @option params [required, String] :workspace_id
|
626
|
-
# The ID of the workspace that contains the entity.
|
627
|
-
#
|
628
641
|
# @return [Types::CreateEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
629
642
|
#
|
643
|
+
# * {Types::CreateEntityResponse#entity_id #entity_id} => String
|
630
644
|
# * {Types::CreateEntityResponse#arn #arn} => String
|
631
645
|
# * {Types::CreateEntityResponse#creation_date_time #creation_date_time} => Time
|
632
|
-
# * {Types::CreateEntityResponse#entity_id #entity_id} => String
|
633
646
|
# * {Types::CreateEntityResponse#state #state} => String
|
634
647
|
#
|
635
648
|
# @example Request syntax with placeholder values
|
636
649
|
#
|
637
650
|
# resp = client.create_entity({
|
651
|
+
# workspace_id: "Id", # required
|
652
|
+
# entity_id: "EntityId",
|
653
|
+
# entity_name: "EntityName", # required
|
654
|
+
# description: "Description",
|
638
655
|
# components: {
|
639
656
|
# "Name" => {
|
640
|
-
# component_type_id: "ComponentTypeId",
|
641
657
|
# description: "Description",
|
658
|
+
# component_type_id: "ComponentTypeId",
|
642
659
|
# properties: {
|
643
660
|
# "Name" => {
|
644
661
|
# definition: {
|
645
|
-
# configuration: {
|
646
|
-
# "Name" => "Value",
|
647
|
-
# },
|
648
662
|
# data_type: {
|
663
|
+
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
664
|
+
# nested_type: {
|
665
|
+
# # recursive DataType
|
666
|
+
# },
|
649
667
|
# allowed_values: [
|
650
668
|
# {
|
651
669
|
# boolean_value: false,
|
652
670
|
# double_value: 1.0,
|
653
|
-
# expression: "Expression",
|
654
671
|
# integer_value: 1,
|
672
|
+
# long_value: 1,
|
673
|
+
# string_value: "String",
|
655
674
|
# list_value: {
|
656
675
|
# # recursive DataValueList
|
657
676
|
# },
|
658
|
-
# long_value: 1,
|
659
677
|
# map_value: {
|
660
678
|
# "String" => {
|
661
679
|
# # recursive DataValue
|
662
680
|
# },
|
663
681
|
# },
|
664
682
|
# relationship_value: {
|
665
|
-
# target_component_name: "Name",
|
666
683
|
# target_entity_id: "EntityId",
|
684
|
+
# target_component_name: "Name",
|
667
685
|
# },
|
668
|
-
#
|
686
|
+
# expression: "Expression",
|
669
687
|
# },
|
670
688
|
# ],
|
671
|
-
#
|
672
|
-
# # recursive DataType
|
673
|
-
# },
|
689
|
+
# unit_of_measure: "String",
|
674
690
|
# relationship: {
|
675
|
-
# relationship_type: "String",
|
676
691
|
# target_component_type_id: "ComponentTypeId",
|
692
|
+
# relationship_type: "String",
|
677
693
|
# },
|
678
|
-
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
679
|
-
# unit_of_measure: "String",
|
680
694
|
# },
|
695
|
+
# is_required_in_entity: false,
|
696
|
+
# is_external_id: false,
|
697
|
+
# is_stored_externally: false,
|
698
|
+
# is_time_series: false,
|
681
699
|
# default_value: {
|
682
700
|
# boolean_value: false,
|
683
701
|
# double_value: 1.0,
|
684
|
-
# expression: "Expression",
|
685
702
|
# integer_value: 1,
|
703
|
+
# long_value: 1,
|
704
|
+
# string_value: "String",
|
686
705
|
# list_value: [
|
687
706
|
# {
|
688
707
|
# # recursive DataValue
|
689
708
|
# },
|
690
709
|
# ],
|
691
|
-
# long_value: 1,
|
692
710
|
# map_value: {
|
693
711
|
# "String" => {
|
694
712
|
# # recursive DataValue
|
695
713
|
# },
|
696
714
|
# },
|
697
715
|
# relationship_value: {
|
698
|
-
# target_component_name: "Name",
|
699
716
|
# target_entity_id: "EntityId",
|
717
|
+
# target_component_name: "Name",
|
700
718
|
# },
|
701
|
-
#
|
719
|
+
# expression: "Expression",
|
702
720
|
# },
|
703
|
-
#
|
704
|
-
#
|
705
|
-
#
|
706
|
-
#
|
721
|
+
# configuration: {
|
722
|
+
# "Name" => "Value",
|
723
|
+
# },
|
724
|
+
# display_name: "PropertyDisplayName",
|
707
725
|
# },
|
708
|
-
# update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
|
709
726
|
# value: {
|
710
727
|
# boolean_value: false,
|
711
728
|
# double_value: 1.0,
|
712
|
-
# expression: "Expression",
|
713
729
|
# integer_value: 1,
|
730
|
+
# long_value: 1,
|
731
|
+
# string_value: "String",
|
714
732
|
# list_value: [
|
715
733
|
# {
|
716
734
|
# # recursive DataValue
|
717
735
|
# },
|
718
736
|
# ],
|
719
|
-
# long_value: 1,
|
720
737
|
# map_value: {
|
721
738
|
# "String" => {
|
722
739
|
# # recursive DataValue
|
723
740
|
# },
|
724
741
|
# },
|
725
742
|
# relationship_value: {
|
726
|
-
# target_component_name: "Name",
|
727
743
|
# target_entity_id: "EntityId",
|
744
|
+
# target_component_name: "Name",
|
728
745
|
# },
|
729
|
-
#
|
746
|
+
# expression: "Expression",
|
730
747
|
# },
|
748
|
+
# update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
|
749
|
+
# },
|
750
|
+
# },
|
751
|
+
# property_groups: {
|
752
|
+
# "Name" => {
|
753
|
+
# group_type: "TABULAR", # accepts TABULAR
|
754
|
+
# property_names: ["Name"],
|
755
|
+
# update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
|
731
756
|
# },
|
732
757
|
# },
|
733
758
|
# },
|
734
759
|
# },
|
735
|
-
# description: "Description",
|
736
|
-
# entity_id: "EntityId",
|
737
|
-
# entity_name: "EntityName", # required
|
738
760
|
# parent_entity_id: "ParentEntityId",
|
739
761
|
# tags: {
|
740
762
|
# "TagKey" => "TagValue",
|
741
763
|
# },
|
742
|
-
# workspace_id: "Id", # required
|
743
764
|
# })
|
744
765
|
#
|
745
766
|
# @example Response structure
|
746
767
|
#
|
768
|
+
# resp.entity_id #=> String
|
747
769
|
# resp.arn #=> String
|
748
770
|
# resp.creation_date_time #=> Time
|
749
|
-
# resp.entity_id #=> String
|
750
771
|
# resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
751
772
|
#
|
752
773
|
# @overload create_entity(params = {})
|
@@ -758,8 +779,11 @@ module Aws::IoTTwinMaker
|
|
758
779
|
|
759
780
|
# Creates a scene.
|
760
781
|
#
|
761
|
-
# @option params [
|
762
|
-
#
|
782
|
+
# @option params [required, String] :workspace_id
|
783
|
+
# The ID of the workspace that contains the scene.
|
784
|
+
#
|
785
|
+
# @option params [required, String] :scene_id
|
786
|
+
# The ID of the scene.
|
763
787
|
#
|
764
788
|
# @option params [required, String] :content_location
|
765
789
|
# The relative path that specifies the location of the content
|
@@ -768,15 +792,12 @@ module Aws::IoTTwinMaker
|
|
768
792
|
# @option params [String] :description
|
769
793
|
# The description for this scene.
|
770
794
|
#
|
771
|
-
# @option params [
|
772
|
-
#
|
795
|
+
# @option params [Array<String>] :capabilities
|
796
|
+
# A list of capabilities that the scene uses to render itself.
|
773
797
|
#
|
774
798
|
# @option params [Hash<String,String>] :tags
|
775
799
|
# Metadata that you can use to manage the scene.
|
776
800
|
#
|
777
|
-
# @option params [required, String] :workspace_id
|
778
|
-
# The ID of the workspace that contains the scene.
|
779
|
-
#
|
780
801
|
# @return [Types::CreateSceneResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
781
802
|
#
|
782
803
|
# * {Types::CreateSceneResponse#arn #arn} => String
|
@@ -785,14 +806,14 @@ module Aws::IoTTwinMaker
|
|
785
806
|
# @example Request syntax with placeholder values
|
786
807
|
#
|
787
808
|
# resp = client.create_scene({
|
788
|
-
#
|
809
|
+
# workspace_id: "Id", # required
|
810
|
+
# scene_id: "Id", # required
|
789
811
|
# content_location: "S3Url", # required
|
790
812
|
# description: "Description",
|
791
|
-
#
|
813
|
+
# capabilities: ["SceneCapability"],
|
792
814
|
# tags: {
|
793
815
|
# "TagKey" => "TagValue",
|
794
816
|
# },
|
795
|
-
# workspace_id: "Id", # required
|
796
817
|
# })
|
797
818
|
#
|
798
819
|
# @example Response structure
|
@@ -807,24 +828,74 @@ module Aws::IoTTwinMaker
|
|
807
828
|
req.send_request(options)
|
808
829
|
end
|
809
830
|
|
810
|
-
#
|
831
|
+
# This action creates a SyncJob.
|
811
832
|
#
|
812
|
-
# @option params [String] :
|
813
|
-
# The
|
833
|
+
# @option params [required, String] :workspace_id
|
834
|
+
# The workspace Id.
|
814
835
|
#
|
815
|
-
# @option params [required, String] :
|
816
|
-
# The
|
836
|
+
# @option params [required, String] :sync_source
|
837
|
+
# The sync source.
|
817
838
|
#
|
818
|
-
#
|
819
|
-
#
|
820
|
-
#
|
839
|
+
# <note markdown="1"> Currently the only supported syncSoucre is `SITEWISE `.
|
840
|
+
#
|
841
|
+
# </note>
|
842
|
+
#
|
843
|
+
# @option params [required, String] :sync_role
|
844
|
+
# The SyncJob IAM role. This IAM role is used by the sync job to read
|
845
|
+
# from the syncSource, and create, update or delete the corresponding
|
846
|
+
# resources.
|
821
847
|
#
|
822
848
|
# @option params [Hash<String,String>] :tags
|
823
|
-
#
|
849
|
+
# The SyncJob tags.
|
850
|
+
#
|
851
|
+
# @return [Types::CreateSyncJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
852
|
+
#
|
853
|
+
# * {Types::CreateSyncJobResponse#arn #arn} => String
|
854
|
+
# * {Types::CreateSyncJobResponse#creation_date_time #creation_date_time} => Time
|
855
|
+
# * {Types::CreateSyncJobResponse#state #state} => String
|
856
|
+
#
|
857
|
+
# @example Request syntax with placeholder values
|
858
|
+
#
|
859
|
+
# resp = client.create_sync_job({
|
860
|
+
# workspace_id: "Id", # required
|
861
|
+
# sync_source: "SyncSource", # required
|
862
|
+
# sync_role: "RoleArn", # required
|
863
|
+
# tags: {
|
864
|
+
# "TagKey" => "TagValue",
|
865
|
+
# },
|
866
|
+
# })
|
867
|
+
#
|
868
|
+
# @example Response structure
|
869
|
+
#
|
870
|
+
# resp.arn #=> String
|
871
|
+
# resp.creation_date_time #=> Time
|
872
|
+
# resp.state #=> String, one of "CREATING", "INITIALIZING", "ACTIVE", "DELETING", "ERROR"
|
873
|
+
#
|
874
|
+
# @overload create_sync_job(params = {})
|
875
|
+
# @param [Hash] params ({})
|
876
|
+
def create_sync_job(params = {}, options = {})
|
877
|
+
req = build_request(:create_sync_job, params)
|
878
|
+
req.send_request(options)
|
879
|
+
end
|
880
|
+
|
881
|
+
# Creates a workplace.
|
824
882
|
#
|
825
883
|
# @option params [required, String] :workspace_id
|
826
884
|
# The ID of the workspace.
|
827
885
|
#
|
886
|
+
# @option params [String] :description
|
887
|
+
# The description of the workspace.
|
888
|
+
#
|
889
|
+
# @option params [required, String] :s3_location
|
890
|
+
# The ARN of the S3 bucket where resources associated with the workspace
|
891
|
+
# are stored.
|
892
|
+
#
|
893
|
+
# @option params [required, String] :role
|
894
|
+
# The ARN of the execution role associated with the workspace.
|
895
|
+
#
|
896
|
+
# @option params [Hash<String,String>] :tags
|
897
|
+
# Metadata that you can use to manage the workspace
|
898
|
+
#
|
828
899
|
# @return [Types::CreateWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
829
900
|
#
|
830
901
|
# * {Types::CreateWorkspaceResponse#arn #arn} => String
|
@@ -833,13 +904,13 @@ module Aws::IoTTwinMaker
|
|
833
904
|
# @example Request syntax with placeholder values
|
834
905
|
#
|
835
906
|
# resp = client.create_workspace({
|
907
|
+
# workspace_id: "Id", # required
|
836
908
|
# description: "Description",
|
837
|
-
# role: "RoleArn", # required
|
838
909
|
# s3_location: "S3Location", # required
|
910
|
+
# role: "RoleArn", # required
|
839
911
|
# tags: {
|
840
912
|
# "TagKey" => "TagValue",
|
841
913
|
# },
|
842
|
-
# workspace_id: "Id", # required
|
843
914
|
# })
|
844
915
|
#
|
845
916
|
# @example Response structure
|
@@ -856,12 +927,12 @@ module Aws::IoTTwinMaker
|
|
856
927
|
|
857
928
|
# Deletes a component type.
|
858
929
|
#
|
859
|
-
# @option params [required, String] :component_type_id
|
860
|
-
# The ID of the component type to delete.
|
861
|
-
#
|
862
930
|
# @option params [required, String] :workspace_id
|
863
931
|
# The ID of the workspace that contains the component type.
|
864
932
|
#
|
933
|
+
# @option params [required, String] :component_type_id
|
934
|
+
# The ID of the component type to delete.
|
935
|
+
#
|
865
936
|
# @return [Types::DeleteComponentTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
866
937
|
#
|
867
938
|
# * {Types::DeleteComponentTypeResponse#state #state} => String
|
@@ -869,8 +940,8 @@ module Aws::IoTTwinMaker
|
|
869
940
|
# @example Request syntax with placeholder values
|
870
941
|
#
|
871
942
|
# resp = client.delete_component_type({
|
872
|
-
# component_type_id: "ComponentTypeId", # required
|
873
943
|
# workspace_id: "Id", # required
|
944
|
+
# component_type_id: "ComponentTypeId", # required
|
874
945
|
# })
|
875
946
|
#
|
876
947
|
# @example Response structure
|
@@ -886,6 +957,9 @@ module Aws::IoTTwinMaker
|
|
886
957
|
|
887
958
|
# Deletes an entity.
|
888
959
|
#
|
960
|
+
# @option params [required, String] :workspace_id
|
961
|
+
# The ID of the workspace that contains the entity to delete.
|
962
|
+
#
|
889
963
|
# @option params [required, String] :entity_id
|
890
964
|
# The ID of the entity to delete.
|
891
965
|
#
|
@@ -893,9 +967,6 @@ module Aws::IoTTwinMaker
|
|
893
967
|
# A Boolean value that specifies whether the operation deletes child
|
894
968
|
# entities.
|
895
969
|
#
|
896
|
-
# @option params [required, String] :workspace_id
|
897
|
-
# The ID of the workspace that contains the entity to delete.
|
898
|
-
#
|
899
970
|
# @return [Types::DeleteEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
900
971
|
#
|
901
972
|
# * {Types::DeleteEntityResponse#state #state} => String
|
@@ -903,9 +974,9 @@ module Aws::IoTTwinMaker
|
|
903
974
|
# @example Request syntax with placeholder values
|
904
975
|
#
|
905
976
|
# resp = client.delete_entity({
|
977
|
+
# workspace_id: "Id", # required
|
906
978
|
# entity_id: "EntityId", # required
|
907
979
|
# is_recursive: false,
|
908
|
-
# workspace_id: "Id", # required
|
909
980
|
# })
|
910
981
|
#
|
911
982
|
# @example Response structure
|
@@ -921,19 +992,19 @@ module Aws::IoTTwinMaker
|
|
921
992
|
|
922
993
|
# Deletes a scene.
|
923
994
|
#
|
924
|
-
# @option params [required, String] :scene_id
|
925
|
-
# The ID of the scene to delete.
|
926
|
-
#
|
927
995
|
# @option params [required, String] :workspace_id
|
928
996
|
# The ID of the workspace.
|
929
997
|
#
|
998
|
+
# @option params [required, String] :scene_id
|
999
|
+
# The ID of the scene to delete.
|
1000
|
+
#
|
930
1001
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
931
1002
|
#
|
932
1003
|
# @example Request syntax with placeholder values
|
933
1004
|
#
|
934
1005
|
# resp = client.delete_scene({
|
935
|
-
# scene_id: "Id", # required
|
936
1006
|
# workspace_id: "Id", # required
|
1007
|
+
# scene_id: "Id", # required
|
937
1008
|
# })
|
938
1009
|
#
|
939
1010
|
# @overload delete_scene(params = {})
|
@@ -943,6 +1014,40 @@ module Aws::IoTTwinMaker
|
|
943
1014
|
req.send_request(options)
|
944
1015
|
end
|
945
1016
|
|
1017
|
+
# Delete the SyncJob.
|
1018
|
+
#
|
1019
|
+
# @option params [required, String] :workspace_id
|
1020
|
+
# The workspace Id.
|
1021
|
+
#
|
1022
|
+
# @option params [required, String] :sync_source
|
1023
|
+
# The sync source.
|
1024
|
+
#
|
1025
|
+
# <note markdown="1"> Currently the only supported syncSoucre is `SITEWISE `.
|
1026
|
+
#
|
1027
|
+
# </note>
|
1028
|
+
#
|
1029
|
+
# @return [Types::DeleteSyncJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1030
|
+
#
|
1031
|
+
# * {Types::DeleteSyncJobResponse#state #state} => String
|
1032
|
+
#
|
1033
|
+
# @example Request syntax with placeholder values
|
1034
|
+
#
|
1035
|
+
# resp = client.delete_sync_job({
|
1036
|
+
# workspace_id: "Id", # required
|
1037
|
+
# sync_source: "SyncSource", # required
|
1038
|
+
# })
|
1039
|
+
#
|
1040
|
+
# @example Response structure
|
1041
|
+
#
|
1042
|
+
# resp.state #=> String, one of "CREATING", "INITIALIZING", "ACTIVE", "DELETING", "ERROR"
|
1043
|
+
#
|
1044
|
+
# @overload delete_sync_job(params = {})
|
1045
|
+
# @param [Hash] params ({})
|
1046
|
+
def delete_sync_job(params = {}, options = {})
|
1047
|
+
req = build_request(:delete_sync_job, params)
|
1048
|
+
req.send_request(options)
|
1049
|
+
end
|
1050
|
+
|
946
1051
|
# Deletes a workspace.
|
947
1052
|
#
|
948
1053
|
# @option params [required, String] :workspace_id
|
@@ -963,99 +1068,161 @@ module Aws::IoTTwinMaker
|
|
963
1068
|
req.send_request(options)
|
964
1069
|
end
|
965
1070
|
|
966
|
-
#
|
1071
|
+
# Run queries to access information from your knowledge graph of
|
1072
|
+
# entities within individual workspaces.
|
967
1073
|
#
|
968
|
-
# @option params [required, String] :
|
969
|
-
# The ID of the
|
1074
|
+
# @option params [required, String] :workspace_id
|
1075
|
+
# The ID of the workspace.
|
1076
|
+
#
|
1077
|
+
# @option params [required, String] :query_statement
|
1078
|
+
# The query statement.
|
1079
|
+
#
|
1080
|
+
# @option params [Integer] :max_results
|
1081
|
+
# The maximum number of results to return at one time. The default is
|
1082
|
+
# 25.
|
1083
|
+
#
|
1084
|
+
# Valid Range: Minimum value of 1. Maximum value of 250.
|
1085
|
+
#
|
1086
|
+
# @option params [String] :next_token
|
1087
|
+
# The string that specifies the next page of results.
|
1088
|
+
#
|
1089
|
+
# @return [Types::ExecuteQueryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1090
|
+
#
|
1091
|
+
# * {Types::ExecuteQueryResponse#column_descriptions #column_descriptions} => Array<Types::ColumnDescription>
|
1092
|
+
# * {Types::ExecuteQueryResponse#rows #rows} => Array<Types::Row>
|
1093
|
+
# * {Types::ExecuteQueryResponse#next_token #next_token} => String
|
1094
|
+
#
|
1095
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1096
|
+
#
|
1097
|
+
# @example Request syntax with placeholder values
|
1098
|
+
#
|
1099
|
+
# resp = client.execute_query({
|
1100
|
+
# workspace_id: "Id", # required
|
1101
|
+
# query_statement: "QueryStatement", # required
|
1102
|
+
# max_results: 1,
|
1103
|
+
# next_token: "NextToken",
|
1104
|
+
# })
|
1105
|
+
#
|
1106
|
+
# @example Response structure
|
1107
|
+
#
|
1108
|
+
# resp.column_descriptions #=> Array
|
1109
|
+
# resp.column_descriptions[0].name #=> String
|
1110
|
+
# resp.column_descriptions[0].type #=> String, one of "NODE", "EDGE", "VALUE"
|
1111
|
+
# resp.rows #=> Array
|
1112
|
+
# resp.rows[0].row_data #=> Array
|
1113
|
+
# resp.next_token #=> String
|
1114
|
+
#
|
1115
|
+
# @overload execute_query(params = {})
|
1116
|
+
# @param [Hash] params ({})
|
1117
|
+
def execute_query(params = {}, options = {})
|
1118
|
+
req = build_request(:execute_query, params)
|
1119
|
+
req.send_request(options)
|
1120
|
+
end
|
1121
|
+
|
1122
|
+
# Retrieves information about a component type.
|
970
1123
|
#
|
971
1124
|
# @option params [required, String] :workspace_id
|
972
1125
|
# The ID of the workspace that contains the component type.
|
973
1126
|
#
|
1127
|
+
# @option params [required, String] :component_type_id
|
1128
|
+
# The ID of the component type.
|
1129
|
+
#
|
974
1130
|
# @return [Types::GetComponentTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
975
1131
|
#
|
976
|
-
# * {Types::GetComponentTypeResponse#
|
1132
|
+
# * {Types::GetComponentTypeResponse#workspace_id #workspace_id} => String
|
1133
|
+
# * {Types::GetComponentTypeResponse#is_singleton #is_singleton} => Boolean
|
977
1134
|
# * {Types::GetComponentTypeResponse#component_type_id #component_type_id} => String
|
978
|
-
# * {Types::GetComponentTypeResponse#creation_date_time #creation_date_time} => Time
|
979
1135
|
# * {Types::GetComponentTypeResponse#description #description} => String
|
1136
|
+
# * {Types::GetComponentTypeResponse#property_definitions #property_definitions} => Hash<String,Types::PropertyDefinitionResponse>
|
980
1137
|
# * {Types::GetComponentTypeResponse#extends_from #extends_from} => Array<String>
|
981
1138
|
# * {Types::GetComponentTypeResponse#functions #functions} => Hash<String,Types::FunctionResponse>
|
1139
|
+
# * {Types::GetComponentTypeResponse#creation_date_time #creation_date_time} => Time
|
1140
|
+
# * {Types::GetComponentTypeResponse#update_date_time #update_date_time} => Time
|
1141
|
+
# * {Types::GetComponentTypeResponse#arn #arn} => String
|
982
1142
|
# * {Types::GetComponentTypeResponse#is_abstract #is_abstract} => Boolean
|
983
1143
|
# * {Types::GetComponentTypeResponse#is_schema_initialized #is_schema_initialized} => Boolean
|
984
|
-
# * {Types::GetComponentTypeResponse#is_singleton #is_singleton} => Boolean
|
985
|
-
# * {Types::GetComponentTypeResponse#property_definitions #property_definitions} => Hash<String,Types::PropertyDefinitionResponse>
|
986
1144
|
# * {Types::GetComponentTypeResponse#status #status} => Types::Status
|
987
|
-
# * {Types::GetComponentTypeResponse#
|
988
|
-
# * {Types::GetComponentTypeResponse#
|
1145
|
+
# * {Types::GetComponentTypeResponse#property_groups #property_groups} => Hash<String,Types::PropertyGroupResponse>
|
1146
|
+
# * {Types::GetComponentTypeResponse#sync_source #sync_source} => String
|
1147
|
+
# * {Types::GetComponentTypeResponse#component_type_name #component_type_name} => String
|
989
1148
|
#
|
990
1149
|
# @example Request syntax with placeholder values
|
991
1150
|
#
|
992
1151
|
# resp = client.get_component_type({
|
993
|
-
# component_type_id: "ComponentTypeId", # required
|
994
1152
|
# workspace_id: "Id", # required
|
1153
|
+
# component_type_id: "ComponentTypeId", # required
|
995
1154
|
# })
|
996
1155
|
#
|
997
1156
|
# @example Response structure
|
998
1157
|
#
|
999
|
-
# resp.
|
1158
|
+
# resp.workspace_id #=> String
|
1159
|
+
# resp.is_singleton #=> Boolean
|
1000
1160
|
# resp.component_type_id #=> String
|
1001
|
-
# resp.creation_date_time #=> Time
|
1002
1161
|
# resp.description #=> String
|
1003
|
-
# resp.extends_from #=> Array
|
1004
|
-
# resp.extends_from[0] #=> String
|
1005
|
-
# resp.functions #=> Hash
|
1006
|
-
# resp.functions["Name"].implemented_by.is_native #=> Boolean
|
1007
|
-
# resp.functions["Name"].implemented_by.lambda.arn #=> String
|
1008
|
-
# resp.functions["Name"].is_inherited #=> Boolean
|
1009
|
-
# resp.functions["Name"].required_properties #=> Array
|
1010
|
-
# resp.functions["Name"].required_properties[0] #=> String
|
1011
|
-
# resp.functions["Name"].scope #=> String, one of "ENTITY", "WORKSPACE"
|
1012
|
-
# resp.is_abstract #=> Boolean
|
1013
|
-
# resp.is_schema_initialized #=> Boolean
|
1014
|
-
# resp.is_singleton #=> Boolean
|
1015
1162
|
# resp.property_definitions #=> Hash
|
1016
|
-
# resp.property_definitions["Name"].
|
1017
|
-
# resp.property_definitions["Name"].
|
1163
|
+
# resp.property_definitions["Name"].data_type.type #=> String, one of "RELATIONSHIP", "STRING", "LONG", "BOOLEAN", "INTEGER", "DOUBLE", "LIST", "MAP"
|
1164
|
+
# resp.property_definitions["Name"].data_type.nested_type #=> Types::DataType
|
1018
1165
|
# resp.property_definitions["Name"].data_type.allowed_values #=> Array
|
1019
1166
|
# resp.property_definitions["Name"].data_type.allowed_values[0].boolean_value #=> Boolean
|
1020
1167
|
# resp.property_definitions["Name"].data_type.allowed_values[0].double_value #=> Float
|
1021
|
-
# resp.property_definitions["Name"].data_type.allowed_values[0].expression #=> String
|
1022
1168
|
# resp.property_definitions["Name"].data_type.allowed_values[0].integer_value #=> Integer
|
1023
|
-
# resp.property_definitions["Name"].data_type.allowed_values[0].list_value #=> Types::DataValueList
|
1024
1169
|
# resp.property_definitions["Name"].data_type.allowed_values[0].long_value #=> Integer
|
1170
|
+
# resp.property_definitions["Name"].data_type.allowed_values[0].string_value #=> String
|
1171
|
+
# resp.property_definitions["Name"].data_type.allowed_values[0].list_value #=> Types::DataValueList
|
1025
1172
|
# resp.property_definitions["Name"].data_type.allowed_values[0].map_value #=> Hash
|
1026
1173
|
# resp.property_definitions["Name"].data_type.allowed_values[0].map_value["String"] #=> Types::DataValue
|
1027
|
-
# resp.property_definitions["Name"].data_type.allowed_values[0].relationship_value.target_component_name #=> String
|
1028
1174
|
# resp.property_definitions["Name"].data_type.allowed_values[0].relationship_value.target_entity_id #=> String
|
1029
|
-
# resp.property_definitions["Name"].data_type.allowed_values[0].
|
1030
|
-
# resp.property_definitions["Name"].data_type.
|
1031
|
-
# resp.property_definitions["Name"].data_type.relationship.relationship_type #=> String
|
1032
|
-
# resp.property_definitions["Name"].data_type.relationship.target_component_type_id #=> String
|
1033
|
-
# resp.property_definitions["Name"].data_type.type #=> String, one of "RELATIONSHIP", "STRING", "LONG", "BOOLEAN", "INTEGER", "DOUBLE", "LIST", "MAP"
|
1175
|
+
# resp.property_definitions["Name"].data_type.allowed_values[0].relationship_value.target_component_name #=> String
|
1176
|
+
# resp.property_definitions["Name"].data_type.allowed_values[0].expression #=> String
|
1034
1177
|
# resp.property_definitions["Name"].data_type.unit_of_measure #=> String
|
1178
|
+
# resp.property_definitions["Name"].data_type.relationship.target_component_type_id #=> String
|
1179
|
+
# resp.property_definitions["Name"].data_type.relationship.relationship_type #=> String
|
1180
|
+
# resp.property_definitions["Name"].is_time_series #=> Boolean
|
1181
|
+
# resp.property_definitions["Name"].is_required_in_entity #=> Boolean
|
1182
|
+
# resp.property_definitions["Name"].is_external_id #=> Boolean
|
1183
|
+
# resp.property_definitions["Name"].is_stored_externally #=> Boolean
|
1184
|
+
# resp.property_definitions["Name"].is_imported #=> Boolean
|
1185
|
+
# resp.property_definitions["Name"].is_final #=> Boolean
|
1186
|
+
# resp.property_definitions["Name"].is_inherited #=> Boolean
|
1035
1187
|
# resp.property_definitions["Name"].default_value.boolean_value #=> Boolean
|
1036
1188
|
# resp.property_definitions["Name"].default_value.double_value #=> Float
|
1037
|
-
# resp.property_definitions["Name"].default_value.expression #=> String
|
1038
1189
|
# resp.property_definitions["Name"].default_value.integer_value #=> Integer
|
1190
|
+
# resp.property_definitions["Name"].default_value.long_value #=> Integer
|
1191
|
+
# resp.property_definitions["Name"].default_value.string_value #=> String
|
1039
1192
|
# resp.property_definitions["Name"].default_value.list_value #=> Array
|
1040
1193
|
# resp.property_definitions["Name"].default_value.list_value[0] #=> Types::DataValue
|
1041
|
-
# resp.property_definitions["Name"].default_value.long_value #=> Integer
|
1042
1194
|
# resp.property_definitions["Name"].default_value.map_value #=> Hash
|
1043
1195
|
# resp.property_definitions["Name"].default_value.map_value["String"] #=> Types::DataValue
|
1044
|
-
# resp.property_definitions["Name"].default_value.relationship_value.target_component_name #=> String
|
1045
1196
|
# resp.property_definitions["Name"].default_value.relationship_value.target_entity_id #=> String
|
1046
|
-
# resp.property_definitions["Name"].default_value.
|
1047
|
-
# resp.property_definitions["Name"].
|
1048
|
-
# resp.property_definitions["Name"].
|
1049
|
-
# resp.property_definitions["Name"].
|
1050
|
-
# resp.property_definitions["Name"].
|
1051
|
-
# resp.
|
1052
|
-
# resp.
|
1053
|
-
# resp.
|
1054
|
-
# resp.
|
1055
|
-
# resp.
|
1056
|
-
# resp.
|
1197
|
+
# resp.property_definitions["Name"].default_value.relationship_value.target_component_name #=> String
|
1198
|
+
# resp.property_definitions["Name"].default_value.expression #=> String
|
1199
|
+
# resp.property_definitions["Name"].configuration #=> Hash
|
1200
|
+
# resp.property_definitions["Name"].configuration["Name"] #=> String
|
1201
|
+
# resp.property_definitions["Name"].display_name #=> String
|
1202
|
+
# resp.extends_from #=> Array
|
1203
|
+
# resp.extends_from[0] #=> String
|
1204
|
+
# resp.functions #=> Hash
|
1205
|
+
# resp.functions["Name"].required_properties #=> Array
|
1206
|
+
# resp.functions["Name"].required_properties[0] #=> String
|
1207
|
+
# resp.functions["Name"].scope #=> String, one of "ENTITY", "WORKSPACE"
|
1208
|
+
# resp.functions["Name"].implemented_by.lambda.arn #=> String
|
1209
|
+
# resp.functions["Name"].implemented_by.is_native #=> Boolean
|
1210
|
+
# resp.functions["Name"].is_inherited #=> Boolean
|
1211
|
+
# resp.creation_date_time #=> Time
|
1057
1212
|
# resp.update_date_time #=> Time
|
1058
|
-
# resp.
|
1213
|
+
# resp.arn #=> String
|
1214
|
+
# resp.is_abstract #=> Boolean
|
1215
|
+
# resp.is_schema_initialized #=> Boolean
|
1216
|
+
# resp.status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1217
|
+
# resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR"
|
1218
|
+
# resp.status.error.message #=> String
|
1219
|
+
# resp.property_groups #=> Hash
|
1220
|
+
# resp.property_groups["Name"].group_type #=> String, one of "TABULAR"
|
1221
|
+
# resp.property_groups["Name"].property_names #=> Array
|
1222
|
+
# resp.property_groups["Name"].property_names[0] #=> String
|
1223
|
+
# resp.property_groups["Name"].is_inherited #=> Boolean
|
1224
|
+
# resp.sync_source #=> String
|
1225
|
+
# resp.component_type_name #=> String
|
1059
1226
|
#
|
1060
1227
|
# @overload get_component_type(params = {})
|
1061
1228
|
# @param [Hash] params ({})
|
@@ -1066,106 +1233,115 @@ module Aws::IoTTwinMaker
|
|
1066
1233
|
|
1067
1234
|
# Retrieves information about an entity.
|
1068
1235
|
#
|
1069
|
-
# @option params [required, String] :entity_id
|
1070
|
-
# The ID of the entity.
|
1071
|
-
#
|
1072
1236
|
# @option params [required, String] :workspace_id
|
1073
1237
|
# The ID of the workspace.
|
1074
1238
|
#
|
1239
|
+
# @option params [required, String] :entity_id
|
1240
|
+
# The ID of the entity.
|
1241
|
+
#
|
1075
1242
|
# @return [Types::GetEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1076
1243
|
#
|
1077
|
-
# * {Types::GetEntityResponse#arn #arn} => String
|
1078
|
-
# * {Types::GetEntityResponse#components #components} => Hash<String,Types::ComponentResponse>
|
1079
|
-
# * {Types::GetEntityResponse#creation_date_time #creation_date_time} => Time
|
1080
|
-
# * {Types::GetEntityResponse#description #description} => String
|
1081
1244
|
# * {Types::GetEntityResponse#entity_id #entity_id} => String
|
1082
1245
|
# * {Types::GetEntityResponse#entity_name #entity_name} => String
|
1083
|
-
# * {Types::GetEntityResponse#
|
1084
|
-
# * {Types::GetEntityResponse#parent_entity_id #parent_entity_id} => String
|
1246
|
+
# * {Types::GetEntityResponse#arn #arn} => String
|
1085
1247
|
# * {Types::GetEntityResponse#status #status} => Types::Status
|
1086
|
-
# * {Types::GetEntityResponse#update_date_time #update_date_time} => Time
|
1087
1248
|
# * {Types::GetEntityResponse#workspace_id #workspace_id} => String
|
1249
|
+
# * {Types::GetEntityResponse#description #description} => String
|
1250
|
+
# * {Types::GetEntityResponse#components #components} => Hash<String,Types::ComponentResponse>
|
1251
|
+
# * {Types::GetEntityResponse#parent_entity_id #parent_entity_id} => String
|
1252
|
+
# * {Types::GetEntityResponse#has_child_entities #has_child_entities} => Boolean
|
1253
|
+
# * {Types::GetEntityResponse#creation_date_time #creation_date_time} => Time
|
1254
|
+
# * {Types::GetEntityResponse#update_date_time #update_date_time} => Time
|
1255
|
+
# * {Types::GetEntityResponse#sync_source #sync_source} => String
|
1088
1256
|
#
|
1089
1257
|
# @example Request syntax with placeholder values
|
1090
1258
|
#
|
1091
1259
|
# resp = client.get_entity({
|
1092
|
-
# entity_id: "EntityId", # required
|
1093
1260
|
# workspace_id: "Id", # required
|
1261
|
+
# entity_id: "EntityId", # required
|
1094
1262
|
# })
|
1095
1263
|
#
|
1096
1264
|
# @example Response structure
|
1097
1265
|
#
|
1266
|
+
# resp.entity_id #=> String
|
1267
|
+
# resp.entity_name #=> String
|
1098
1268
|
# resp.arn #=> String
|
1269
|
+
# resp.status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1270
|
+
# resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR"
|
1271
|
+
# resp.status.error.message #=> String
|
1272
|
+
# resp.workspace_id #=> String
|
1273
|
+
# resp.description #=> String
|
1099
1274
|
# resp.components #=> Hash
|
1100
1275
|
# resp.components["Name"].component_name #=> String
|
1276
|
+
# resp.components["Name"].description #=> String
|
1101
1277
|
# resp.components["Name"].component_type_id #=> String
|
1278
|
+
# resp.components["Name"].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1279
|
+
# resp.components["Name"].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR"
|
1280
|
+
# resp.components["Name"].status.error.message #=> String
|
1102
1281
|
# resp.components["Name"].defined_in #=> String
|
1103
|
-
# resp.components["Name"].description #=> String
|
1104
1282
|
# resp.components["Name"].properties #=> Hash
|
1105
|
-
# resp.components["Name"].properties["Name"].definition.
|
1106
|
-
# resp.components["Name"].properties["Name"].definition.
|
1283
|
+
# resp.components["Name"].properties["Name"].definition.data_type.type #=> String, one of "RELATIONSHIP", "STRING", "LONG", "BOOLEAN", "INTEGER", "DOUBLE", "LIST", "MAP"
|
1284
|
+
# resp.components["Name"].properties["Name"].definition.data_type.nested_type #=> Types::DataType
|
1107
1285
|
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values #=> Array
|
1108
1286
|
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].boolean_value #=> Boolean
|
1109
1287
|
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].double_value #=> Float
|
1110
|
-
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].expression #=> String
|
1111
1288
|
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].integer_value #=> Integer
|
1112
|
-
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].list_value #=> Types::DataValueList
|
1113
1289
|
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].long_value #=> Integer
|
1290
|
+
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].string_value #=> String
|
1291
|
+
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].list_value #=> Types::DataValueList
|
1114
1292
|
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].map_value #=> Hash
|
1115
1293
|
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].map_value["String"] #=> Types::DataValue
|
1116
|
-
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].relationship_value.target_component_name #=> String
|
1117
1294
|
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].relationship_value.target_entity_id #=> String
|
1118
|
-
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].
|
1119
|
-
# resp.components["Name"].properties["Name"].definition.data_type.
|
1120
|
-
# resp.components["Name"].properties["Name"].definition.data_type.relationship.relationship_type #=> String
|
1121
|
-
# resp.components["Name"].properties["Name"].definition.data_type.relationship.target_component_type_id #=> String
|
1122
|
-
# resp.components["Name"].properties["Name"].definition.data_type.type #=> String, one of "RELATIONSHIP", "STRING", "LONG", "BOOLEAN", "INTEGER", "DOUBLE", "LIST", "MAP"
|
1295
|
+
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].relationship_value.target_component_name #=> String
|
1296
|
+
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].expression #=> String
|
1123
1297
|
# resp.components["Name"].properties["Name"].definition.data_type.unit_of_measure #=> String
|
1298
|
+
# resp.components["Name"].properties["Name"].definition.data_type.relationship.target_component_type_id #=> String
|
1299
|
+
# resp.components["Name"].properties["Name"].definition.data_type.relationship.relationship_type #=> String
|
1300
|
+
# resp.components["Name"].properties["Name"].definition.is_time_series #=> Boolean
|
1301
|
+
# resp.components["Name"].properties["Name"].definition.is_required_in_entity #=> Boolean
|
1302
|
+
# resp.components["Name"].properties["Name"].definition.is_external_id #=> Boolean
|
1303
|
+
# resp.components["Name"].properties["Name"].definition.is_stored_externally #=> Boolean
|
1304
|
+
# resp.components["Name"].properties["Name"].definition.is_imported #=> Boolean
|
1305
|
+
# resp.components["Name"].properties["Name"].definition.is_final #=> Boolean
|
1306
|
+
# resp.components["Name"].properties["Name"].definition.is_inherited #=> Boolean
|
1124
1307
|
# resp.components["Name"].properties["Name"].definition.default_value.boolean_value #=> Boolean
|
1125
1308
|
# resp.components["Name"].properties["Name"].definition.default_value.double_value #=> Float
|
1126
|
-
# resp.components["Name"].properties["Name"].definition.default_value.expression #=> String
|
1127
1309
|
# resp.components["Name"].properties["Name"].definition.default_value.integer_value #=> Integer
|
1310
|
+
# resp.components["Name"].properties["Name"].definition.default_value.long_value #=> Integer
|
1311
|
+
# resp.components["Name"].properties["Name"].definition.default_value.string_value #=> String
|
1128
1312
|
# resp.components["Name"].properties["Name"].definition.default_value.list_value #=> Array
|
1129
1313
|
# resp.components["Name"].properties["Name"].definition.default_value.list_value[0] #=> Types::DataValue
|
1130
|
-
# resp.components["Name"].properties["Name"].definition.default_value.long_value #=> Integer
|
1131
1314
|
# resp.components["Name"].properties["Name"].definition.default_value.map_value #=> Hash
|
1132
1315
|
# resp.components["Name"].properties["Name"].definition.default_value.map_value["String"] #=> Types::DataValue
|
1133
|
-
# resp.components["Name"].properties["Name"].definition.default_value.relationship_value.target_component_name #=> String
|
1134
1316
|
# resp.components["Name"].properties["Name"].definition.default_value.relationship_value.target_entity_id #=> String
|
1135
|
-
# resp.components["Name"].properties["Name"].definition.default_value.
|
1136
|
-
# resp.components["Name"].properties["Name"].definition.
|
1137
|
-
# resp.components["Name"].properties["Name"].definition.
|
1138
|
-
# resp.components["Name"].properties["Name"].definition.
|
1139
|
-
# resp.components["Name"].properties["Name"].definition.
|
1140
|
-
# resp.components["Name"].properties["Name"].definition.is_required_in_entity #=> Boolean
|
1141
|
-
# resp.components["Name"].properties["Name"].definition.is_stored_externally #=> Boolean
|
1142
|
-
# resp.components["Name"].properties["Name"].definition.is_time_series #=> Boolean
|
1317
|
+
# resp.components["Name"].properties["Name"].definition.default_value.relationship_value.target_component_name #=> String
|
1318
|
+
# resp.components["Name"].properties["Name"].definition.default_value.expression #=> String
|
1319
|
+
# resp.components["Name"].properties["Name"].definition.configuration #=> Hash
|
1320
|
+
# resp.components["Name"].properties["Name"].definition.configuration["Name"] #=> String
|
1321
|
+
# resp.components["Name"].properties["Name"].definition.display_name #=> String
|
1143
1322
|
# resp.components["Name"].properties["Name"].value.boolean_value #=> Boolean
|
1144
1323
|
# resp.components["Name"].properties["Name"].value.double_value #=> Float
|
1145
|
-
# resp.components["Name"].properties["Name"].value.expression #=> String
|
1146
1324
|
# resp.components["Name"].properties["Name"].value.integer_value #=> Integer
|
1325
|
+
# resp.components["Name"].properties["Name"].value.long_value #=> Integer
|
1326
|
+
# resp.components["Name"].properties["Name"].value.string_value #=> String
|
1147
1327
|
# resp.components["Name"].properties["Name"].value.list_value #=> Array
|
1148
1328
|
# resp.components["Name"].properties["Name"].value.list_value[0] #=> Types::DataValue
|
1149
|
-
# resp.components["Name"].properties["Name"].value.long_value #=> Integer
|
1150
1329
|
# resp.components["Name"].properties["Name"].value.map_value #=> Hash
|
1151
1330
|
# resp.components["Name"].properties["Name"].value.map_value["String"] #=> Types::DataValue
|
1152
|
-
# resp.components["Name"].properties["Name"].value.relationship_value.target_component_name #=> String
|
1153
1331
|
# resp.components["Name"].properties["Name"].value.relationship_value.target_entity_id #=> String
|
1154
|
-
# resp.components["Name"].properties["Name"].value.
|
1155
|
-
# resp.components["Name"].
|
1156
|
-
# resp.components["Name"].
|
1157
|
-
# resp.components["Name"].
|
1158
|
-
# resp.
|
1159
|
-
# resp.
|
1160
|
-
# resp.
|
1161
|
-
# resp.
|
1162
|
-
# resp.has_child_entities #=> Boolean
|
1332
|
+
# resp.components["Name"].properties["Name"].value.relationship_value.target_component_name #=> String
|
1333
|
+
# resp.components["Name"].properties["Name"].value.expression #=> String
|
1334
|
+
# resp.components["Name"].property_groups #=> Hash
|
1335
|
+
# resp.components["Name"].property_groups["Name"].group_type #=> String, one of "TABULAR"
|
1336
|
+
# resp.components["Name"].property_groups["Name"].property_names #=> Array
|
1337
|
+
# resp.components["Name"].property_groups["Name"].property_names[0] #=> String
|
1338
|
+
# resp.components["Name"].property_groups["Name"].is_inherited #=> Boolean
|
1339
|
+
# resp.components["Name"].sync_source #=> String
|
1163
1340
|
# resp.parent_entity_id #=> String
|
1164
|
-
# resp.
|
1165
|
-
# resp.
|
1166
|
-
# resp.status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1341
|
+
# resp.has_child_entities #=> Boolean
|
1342
|
+
# resp.creation_date_time #=> Time
|
1167
1343
|
# resp.update_date_time #=> Time
|
1168
|
-
# resp.
|
1344
|
+
# resp.sync_source #=> String
|
1169
1345
|
#
|
1170
1346
|
# @overload get_entity(params = {})
|
1171
1347
|
# @param [Hash] params ({})
|
@@ -1174,6 +1350,39 @@ module Aws::IoTTwinMaker
|
|
1174
1350
|
req.send_request(options)
|
1175
1351
|
end
|
1176
1352
|
|
1353
|
+
# Gets the pricing plan.
|
1354
|
+
#
|
1355
|
+
# @return [Types::GetPricingPlanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1356
|
+
#
|
1357
|
+
# * {Types::GetPricingPlanResponse#current_pricing_plan #current_pricing_plan} => Types::PricingPlan
|
1358
|
+
# * {Types::GetPricingPlanResponse#pending_pricing_plan #pending_pricing_plan} => Types::PricingPlan
|
1359
|
+
#
|
1360
|
+
# @example Response structure
|
1361
|
+
#
|
1362
|
+
# resp.current_pricing_plan.billable_entity_count #=> Integer
|
1363
|
+
# resp.current_pricing_plan.bundle_information.bundle_names #=> Array
|
1364
|
+
# resp.current_pricing_plan.bundle_information.bundle_names[0] #=> String
|
1365
|
+
# resp.current_pricing_plan.bundle_information.pricing_tier #=> String, one of "TIER_1", "TIER_2", "TIER_3", "TIER_4"
|
1366
|
+
# resp.current_pricing_plan.effective_date_time #=> Time
|
1367
|
+
# resp.current_pricing_plan.pricing_mode #=> String, one of "BASIC", "STANDARD", "TIERED_BUNDLE"
|
1368
|
+
# resp.current_pricing_plan.update_date_time #=> Time
|
1369
|
+
# resp.current_pricing_plan.update_reason #=> String, one of "DEFAULT", "PRICING_TIER_UPDATE", "ENTITY_COUNT_UPDATE", "PRICING_MODE_UPDATE", "OVERWRITTEN"
|
1370
|
+
# resp.pending_pricing_plan.billable_entity_count #=> Integer
|
1371
|
+
# resp.pending_pricing_plan.bundle_information.bundle_names #=> Array
|
1372
|
+
# resp.pending_pricing_plan.bundle_information.bundle_names[0] #=> String
|
1373
|
+
# resp.pending_pricing_plan.bundle_information.pricing_tier #=> String, one of "TIER_1", "TIER_2", "TIER_3", "TIER_4"
|
1374
|
+
# resp.pending_pricing_plan.effective_date_time #=> Time
|
1375
|
+
# resp.pending_pricing_plan.pricing_mode #=> String, one of "BASIC", "STANDARD", "TIERED_BUNDLE"
|
1376
|
+
# resp.pending_pricing_plan.update_date_time #=> Time
|
1377
|
+
# resp.pending_pricing_plan.update_reason #=> String, one of "DEFAULT", "PRICING_TIER_UPDATE", "ENTITY_COUNT_UPDATE", "PRICING_MODE_UPDATE", "OVERWRITTEN"
|
1378
|
+
#
|
1379
|
+
# @overload get_pricing_plan(params = {})
|
1380
|
+
# @param [Hash] params ({})
|
1381
|
+
def get_pricing_plan(params = {}, options = {})
|
1382
|
+
req = build_request(:get_pricing_plan, params)
|
1383
|
+
req.send_request(options)
|
1384
|
+
end
|
1385
|
+
|
1177
1386
|
# Gets the property values for a component, component type, entity, or
|
1178
1387
|
# workspace.
|
1179
1388
|
#
|
@@ -1196,9 +1405,28 @@ module Aws::IoTTwinMaker
|
|
1196
1405
|
# @option params [required, String] :workspace_id
|
1197
1406
|
# The ID of the workspace whose values the operation returns.
|
1198
1407
|
#
|
1408
|
+
# @option params [Integer] :max_results
|
1409
|
+
# The maximum number of results to return at one time. The default is
|
1410
|
+
# 25.
|
1411
|
+
#
|
1412
|
+
# Valid Range: Minimum value of 1. Maximum value of 250.
|
1413
|
+
#
|
1414
|
+
# @option params [String] :next_token
|
1415
|
+
# The string that specifies the next page of results.
|
1416
|
+
#
|
1417
|
+
# @option params [String] :property_group_name
|
1418
|
+
# The property group name.
|
1419
|
+
#
|
1420
|
+
# @option params [Types::TabularConditions] :tabular_conditions
|
1421
|
+
# The tabular conditions.
|
1422
|
+
#
|
1199
1423
|
# @return [Types::GetPropertyValueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1200
1424
|
#
|
1201
1425
|
# * {Types::GetPropertyValueResponse#property_values #property_values} => Hash<String,Types::PropertyLatestValue>
|
1426
|
+
# * {Types::GetPropertyValueResponse#next_token #next_token} => String
|
1427
|
+
# * {Types::GetPropertyValueResponse#tabular_property_values #tabular_property_values} => Array<Array<Hash<String,Types::DataValue>>>
|
1428
|
+
#
|
1429
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1202
1430
|
#
|
1203
1431
|
# @example Request syntax with placeholder values
|
1204
1432
|
#
|
@@ -1208,28 +1436,83 @@ module Aws::IoTTwinMaker
|
|
1208
1436
|
# entity_id: "EntityId",
|
1209
1437
|
# selected_properties: ["String"], # required
|
1210
1438
|
# workspace_id: "Id", # required
|
1439
|
+
# max_results: 1,
|
1440
|
+
# next_token: "NextToken",
|
1441
|
+
# property_group_name: "Name",
|
1442
|
+
# tabular_conditions: {
|
1443
|
+
# order_by: [
|
1444
|
+
# {
|
1445
|
+
# order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1446
|
+
# property_name: "String", # required
|
1447
|
+
# },
|
1448
|
+
# ],
|
1449
|
+
# property_filters: [
|
1450
|
+
# {
|
1451
|
+
# property_name: "String",
|
1452
|
+
# operator: "String",
|
1453
|
+
# value: {
|
1454
|
+
# boolean_value: false,
|
1455
|
+
# double_value: 1.0,
|
1456
|
+
# integer_value: 1,
|
1457
|
+
# long_value: 1,
|
1458
|
+
# string_value: "String",
|
1459
|
+
# list_value: [
|
1460
|
+
# {
|
1461
|
+
# # recursive DataValue
|
1462
|
+
# },
|
1463
|
+
# ],
|
1464
|
+
# map_value: {
|
1465
|
+
# "String" => {
|
1466
|
+
# # recursive DataValue
|
1467
|
+
# },
|
1468
|
+
# },
|
1469
|
+
# relationship_value: {
|
1470
|
+
# target_entity_id: "EntityId",
|
1471
|
+
# target_component_name: "Name",
|
1472
|
+
# },
|
1473
|
+
# expression: "Expression",
|
1474
|
+
# },
|
1475
|
+
# },
|
1476
|
+
# ],
|
1477
|
+
# },
|
1211
1478
|
# })
|
1212
1479
|
#
|
1213
1480
|
# @example Response structure
|
1214
1481
|
#
|
1215
1482
|
# resp.property_values #=> Hash
|
1216
1483
|
# resp.property_values["Name"].property_reference.component_name #=> String
|
1217
|
-
# resp.property_values["Name"].property_reference.entity_id #=> String
|
1218
1484
|
# resp.property_values["Name"].property_reference.external_id_property #=> Hash
|
1219
1485
|
# resp.property_values["Name"].property_reference.external_id_property["String"] #=> String
|
1486
|
+
# resp.property_values["Name"].property_reference.entity_id #=> String
|
1220
1487
|
# resp.property_values["Name"].property_reference.property_name #=> String
|
1221
1488
|
# resp.property_values["Name"].property_value.boolean_value #=> Boolean
|
1222
1489
|
# resp.property_values["Name"].property_value.double_value #=> Float
|
1223
|
-
# resp.property_values["Name"].property_value.expression #=> String
|
1224
1490
|
# resp.property_values["Name"].property_value.integer_value #=> Integer
|
1491
|
+
# resp.property_values["Name"].property_value.long_value #=> Integer
|
1492
|
+
# resp.property_values["Name"].property_value.string_value #=> String
|
1225
1493
|
# resp.property_values["Name"].property_value.list_value #=> Array
|
1226
1494
|
# resp.property_values["Name"].property_value.list_value[0] #=> Types::DataValue
|
1227
|
-
# resp.property_values["Name"].property_value.long_value #=> Integer
|
1228
1495
|
# resp.property_values["Name"].property_value.map_value #=> Hash
|
1229
1496
|
# resp.property_values["Name"].property_value.map_value["String"] #=> Types::DataValue
|
1230
|
-
# resp.property_values["Name"].property_value.relationship_value.target_component_name #=> String
|
1231
1497
|
# resp.property_values["Name"].property_value.relationship_value.target_entity_id #=> String
|
1232
|
-
# resp.property_values["Name"].property_value.
|
1498
|
+
# resp.property_values["Name"].property_value.relationship_value.target_component_name #=> String
|
1499
|
+
# resp.property_values["Name"].property_value.expression #=> String
|
1500
|
+
# resp.next_token #=> String
|
1501
|
+
# resp.tabular_property_values #=> Array
|
1502
|
+
# resp.tabular_property_values[0] #=> Array
|
1503
|
+
# resp.tabular_property_values[0][0] #=> Hash
|
1504
|
+
# resp.tabular_property_values[0][0]["Name"].boolean_value #=> Boolean
|
1505
|
+
# resp.tabular_property_values[0][0]["Name"].double_value #=> Float
|
1506
|
+
# resp.tabular_property_values[0][0]["Name"].integer_value #=> Integer
|
1507
|
+
# resp.tabular_property_values[0][0]["Name"].long_value #=> Integer
|
1508
|
+
# resp.tabular_property_values[0][0]["Name"].string_value #=> String
|
1509
|
+
# resp.tabular_property_values[0][0]["Name"].list_value #=> Array
|
1510
|
+
# resp.tabular_property_values[0][0]["Name"].list_value[0] #=> Types::DataValue
|
1511
|
+
# resp.tabular_property_values[0][0]["Name"].map_value #=> Hash
|
1512
|
+
# resp.tabular_property_values[0][0]["Name"].map_value["String"] #=> Types::DataValue
|
1513
|
+
# resp.tabular_property_values[0][0]["Name"].relationship_value.target_entity_id #=> String
|
1514
|
+
# resp.tabular_property_values[0][0]["Name"].relationship_value.target_component_name #=> String
|
1515
|
+
# resp.tabular_property_values[0][0]["Name"].expression #=> String
|
1233
1516
|
#
|
1234
1517
|
# @overload get_property_value(params = {})
|
1235
1518
|
# @param [Hash] params ({})
|
@@ -1245,143 +1528,146 @@ module Aws::IoTTwinMaker
|
|
1245
1528
|
# queries, specify values for `componentName` and `entityId`. For
|
1246
1529
|
# cross-entity quries, specify a value for `componentTypeId`.
|
1247
1530
|
#
|
1531
|
+
# @option params [required, String] :workspace_id
|
1532
|
+
# The ID of the workspace.
|
1533
|
+
#
|
1534
|
+
# @option params [String] :entity_id
|
1535
|
+
# The ID of the entity.
|
1536
|
+
#
|
1248
1537
|
# @option params [String] :component_name
|
1249
1538
|
# The name of the component.
|
1250
1539
|
#
|
1251
1540
|
# @option params [String] :component_type_id
|
1252
1541
|
# The ID of the component type.
|
1253
1542
|
#
|
1254
|
-
# @option params [
|
1255
|
-
#
|
1256
|
-
#
|
1257
|
-
# @option params [String] :end_time
|
1258
|
-
# The ISO8601 DateTime of the latest property value to return.
|
1259
|
-
#
|
1260
|
-
# For more information about the ISO8601 DateTime format, see the data
|
1261
|
-
# type [PropertyValue][1].
|
1262
|
-
#
|
1543
|
+
# @option params [required, Array<String>] :selected_properties
|
1544
|
+
# A list of properties whose value histories the request retrieves.
|
1263
1545
|
#
|
1546
|
+
# @option params [Array<Types::PropertyFilter>] :property_filters
|
1547
|
+
# A list of objects that filter the property value history request.
|
1264
1548
|
#
|
1265
|
-
#
|
1549
|
+
# @option params [Time,DateTime,Date,Integer,String] :start_date_time
|
1550
|
+
# The date and time of the earliest property value to return.
|
1266
1551
|
#
|
1267
|
-
# @option params [String] :
|
1268
|
-
# The
|
1552
|
+
# @option params [Time,DateTime,Date,Integer,String] :end_date_time
|
1553
|
+
# The date and time of the latest property value to return.
|
1269
1554
|
#
|
1270
1555
|
# @option params [Types::InterpolationParameters] :interpolation
|
1271
1556
|
# An object that specifies the interpolation type and the interval over
|
1272
1557
|
# which to interpolate data.
|
1273
1558
|
#
|
1274
|
-
# @option params [Integer] :max_results
|
1275
|
-
# The maximum number of results to return.
|
1276
|
-
#
|
1277
1559
|
# @option params [String] :next_token
|
1278
1560
|
# The string that specifies the next page of results.
|
1279
1561
|
#
|
1562
|
+
# @option params [Integer] :max_results
|
1563
|
+
# The maximum number of results to return at one time. The default is
|
1564
|
+
# 25.
|
1565
|
+
#
|
1566
|
+
# Valid Range: Minimum value of 1. Maximum value of 250.
|
1567
|
+
#
|
1280
1568
|
# @option params [String] :order_by_time
|
1281
1569
|
# The time direction to use in the result order.
|
1282
1570
|
#
|
1283
|
-
# @option params [
|
1284
|
-
#
|
1571
|
+
# @option params [String] :start_time
|
1572
|
+
# The ISO8601 DateTime of the earliest property value to return.
|
1285
1573
|
#
|
1286
|
-
#
|
1287
|
-
#
|
1574
|
+
# For more information about the ISO8601 DateTime format, see the data
|
1575
|
+
# type [PropertyValue][1].
|
1288
1576
|
#
|
1289
|
-
# @option params [Time,DateTime,Date,Integer,String] :start_date_time
|
1290
|
-
# The date and time of the earliest property value to return.
|
1291
1577
|
#
|
1292
|
-
#
|
1293
|
-
#
|
1578
|
+
#
|
1579
|
+
# [1]: https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html
|
1580
|
+
#
|
1581
|
+
# @option params [String] :end_time
|
1582
|
+
# The ISO8601 DateTime of the latest property value to return.
|
1294
1583
|
#
|
1295
1584
|
# For more information about the ISO8601 DateTime format, see the data
|
1296
1585
|
# type [PropertyValue][1].
|
1297
1586
|
#
|
1298
1587
|
#
|
1299
1588
|
#
|
1300
|
-
# [1]: https://docs.aws.amazon.com/
|
1301
|
-
#
|
1302
|
-
# @option params [required, String] :workspace_id
|
1303
|
-
# The ID of the workspace.
|
1589
|
+
# [1]: https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html
|
1304
1590
|
#
|
1305
1591
|
# @return [Types::GetPropertyValueHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1306
1592
|
#
|
1307
|
-
# * {Types::GetPropertyValueHistoryResponse#next_token #next_token} => String
|
1308
1593
|
# * {Types::GetPropertyValueHistoryResponse#property_values #property_values} => Array<Types::PropertyValueHistory>
|
1594
|
+
# * {Types::GetPropertyValueHistoryResponse#next_token #next_token} => String
|
1309
1595
|
#
|
1310
1596
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1311
1597
|
#
|
1312
1598
|
# @example Request syntax with placeholder values
|
1313
1599
|
#
|
1314
1600
|
# resp = client.get_property_value_history({
|
1601
|
+
# workspace_id: "Id", # required
|
1602
|
+
# entity_id: "EntityId",
|
1315
1603
|
# component_name: "Name",
|
1316
1604
|
# component_type_id: "ComponentTypeId",
|
1317
|
-
#
|
1318
|
-
# end_time: "Time",
|
1319
|
-
# entity_id: "EntityId",
|
1320
|
-
# interpolation: {
|
1321
|
-
# interpolation_type: "LINEAR", # accepts LINEAR
|
1322
|
-
# interval_in_seconds: 1,
|
1323
|
-
# },
|
1324
|
-
# max_results: 1,
|
1325
|
-
# next_token: "NextToken",
|
1326
|
-
# order_by_time: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1605
|
+
# selected_properties: ["String"], # required
|
1327
1606
|
# property_filters: [
|
1328
1607
|
# {
|
1329
|
-
# operator: "String",
|
1330
1608
|
# property_name: "String",
|
1609
|
+
# operator: "String",
|
1331
1610
|
# value: {
|
1332
1611
|
# boolean_value: false,
|
1333
1612
|
# double_value: 1.0,
|
1334
|
-
# expression: "Expression",
|
1335
1613
|
# integer_value: 1,
|
1614
|
+
# long_value: 1,
|
1615
|
+
# string_value: "String",
|
1336
1616
|
# list_value: [
|
1337
1617
|
# {
|
1338
1618
|
# # recursive DataValue
|
1339
1619
|
# },
|
1340
1620
|
# ],
|
1341
|
-
# long_value: 1,
|
1342
1621
|
# map_value: {
|
1343
1622
|
# "String" => {
|
1344
1623
|
# # recursive DataValue
|
1345
1624
|
# },
|
1346
1625
|
# },
|
1347
1626
|
# relationship_value: {
|
1348
|
-
# target_component_name: "Name",
|
1349
1627
|
# target_entity_id: "EntityId",
|
1628
|
+
# target_component_name: "Name",
|
1350
1629
|
# },
|
1351
|
-
#
|
1630
|
+
# expression: "Expression",
|
1352
1631
|
# },
|
1353
1632
|
# },
|
1354
1633
|
# ],
|
1355
|
-
# selected_properties: ["String"], # required
|
1356
1634
|
# start_date_time: Time.now,
|
1635
|
+
# end_date_time: Time.now,
|
1636
|
+
# interpolation: {
|
1637
|
+
# interpolation_type: "LINEAR", # accepts LINEAR
|
1638
|
+
# interval_in_seconds: 1,
|
1639
|
+
# },
|
1640
|
+
# next_token: "NextToken",
|
1641
|
+
# max_results: 1,
|
1642
|
+
# order_by_time: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1357
1643
|
# start_time: "Time",
|
1358
|
-
#
|
1644
|
+
# end_time: "Time",
|
1359
1645
|
# })
|
1360
1646
|
#
|
1361
1647
|
# @example Response structure
|
1362
1648
|
#
|
1363
|
-
# resp.next_token #=> String
|
1364
1649
|
# resp.property_values #=> Array
|
1365
1650
|
# resp.property_values[0].entity_property_reference.component_name #=> String
|
1366
|
-
# resp.property_values[0].entity_property_reference.entity_id #=> String
|
1367
1651
|
# resp.property_values[0].entity_property_reference.external_id_property #=> Hash
|
1368
1652
|
# resp.property_values[0].entity_property_reference.external_id_property["String"] #=> String
|
1653
|
+
# resp.property_values[0].entity_property_reference.entity_id #=> String
|
1369
1654
|
# resp.property_values[0].entity_property_reference.property_name #=> String
|
1370
1655
|
# resp.property_values[0].values #=> Array
|
1371
|
-
# resp.property_values[0].values[0].time #=> String
|
1372
1656
|
# resp.property_values[0].values[0].timestamp #=> Time
|
1373
1657
|
# resp.property_values[0].values[0].value.boolean_value #=> Boolean
|
1374
1658
|
# resp.property_values[0].values[0].value.double_value #=> Float
|
1375
|
-
# resp.property_values[0].values[0].value.expression #=> String
|
1376
1659
|
# resp.property_values[0].values[0].value.integer_value #=> Integer
|
1660
|
+
# resp.property_values[0].values[0].value.long_value #=> Integer
|
1661
|
+
# resp.property_values[0].values[0].value.string_value #=> String
|
1377
1662
|
# resp.property_values[0].values[0].value.list_value #=> Array
|
1378
1663
|
# resp.property_values[0].values[0].value.list_value[0] #=> Types::DataValue
|
1379
|
-
# resp.property_values[0].values[0].value.long_value #=> Integer
|
1380
1664
|
# resp.property_values[0].values[0].value.map_value #=> Hash
|
1381
1665
|
# resp.property_values[0].values[0].value.map_value["String"] #=> Types::DataValue
|
1382
|
-
# resp.property_values[0].values[0].value.relationship_value.target_component_name #=> String
|
1383
1666
|
# resp.property_values[0].values[0].value.relationship_value.target_entity_id #=> String
|
1384
|
-
# resp.property_values[0].values[0].value.
|
1667
|
+
# resp.property_values[0].values[0].value.relationship_value.target_component_name #=> String
|
1668
|
+
# resp.property_values[0].values[0].value.expression #=> String
|
1669
|
+
# resp.property_values[0].values[0].time #=> String
|
1670
|
+
# resp.next_token #=> String
|
1385
1671
|
#
|
1386
1672
|
# @overload get_property_value_history(params = {})
|
1387
1673
|
# @param [Hash] params ({})
|
@@ -1392,41 +1678,41 @@ module Aws::IoTTwinMaker
|
|
1392
1678
|
|
1393
1679
|
# Retrieves information about a scene.
|
1394
1680
|
#
|
1395
|
-
# @option params [required, String] :scene_id
|
1396
|
-
# The ID of the scene.
|
1397
|
-
#
|
1398
1681
|
# @option params [required, String] :workspace_id
|
1399
1682
|
# The ID of the workspace that contains the scene.
|
1400
1683
|
#
|
1684
|
+
# @option params [required, String] :scene_id
|
1685
|
+
# The ID of the scene.
|
1686
|
+
#
|
1401
1687
|
# @return [Types::GetSceneResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1402
1688
|
#
|
1403
|
-
# * {Types::GetSceneResponse#
|
1404
|
-
# * {Types::GetSceneResponse#
|
1689
|
+
# * {Types::GetSceneResponse#workspace_id #workspace_id} => String
|
1690
|
+
# * {Types::GetSceneResponse#scene_id #scene_id} => String
|
1405
1691
|
# * {Types::GetSceneResponse#content_location #content_location} => String
|
1692
|
+
# * {Types::GetSceneResponse#arn #arn} => String
|
1406
1693
|
# * {Types::GetSceneResponse#creation_date_time #creation_date_time} => Time
|
1407
|
-
# * {Types::GetSceneResponse#description #description} => String
|
1408
|
-
# * {Types::GetSceneResponse#scene_id #scene_id} => String
|
1409
1694
|
# * {Types::GetSceneResponse#update_date_time #update_date_time} => Time
|
1410
|
-
# * {Types::GetSceneResponse#
|
1695
|
+
# * {Types::GetSceneResponse#description #description} => String
|
1696
|
+
# * {Types::GetSceneResponse#capabilities #capabilities} => Array<String>
|
1411
1697
|
#
|
1412
1698
|
# @example Request syntax with placeholder values
|
1413
1699
|
#
|
1414
1700
|
# resp = client.get_scene({
|
1415
|
-
# scene_id: "Id", # required
|
1416
1701
|
# workspace_id: "Id", # required
|
1702
|
+
# scene_id: "Id", # required
|
1417
1703
|
# })
|
1418
1704
|
#
|
1419
1705
|
# @example Response structure
|
1420
1706
|
#
|
1421
|
-
# resp.
|
1422
|
-
# resp.
|
1423
|
-
# resp.capabilities[0] #=> String
|
1707
|
+
# resp.workspace_id #=> String
|
1708
|
+
# resp.scene_id #=> String
|
1424
1709
|
# resp.content_location #=> String
|
1710
|
+
# resp.arn #=> String
|
1425
1711
|
# resp.creation_date_time #=> Time
|
1426
|
-
# resp.description #=> String
|
1427
|
-
# resp.scene_id #=> String
|
1428
1712
|
# resp.update_date_time #=> Time
|
1429
|
-
# resp.
|
1713
|
+
# resp.description #=> String
|
1714
|
+
# resp.capabilities #=> Array
|
1715
|
+
# resp.capabilities[0] #=> String
|
1430
1716
|
#
|
1431
1717
|
# @overload get_scene(params = {})
|
1432
1718
|
# @param [Hash] params ({})
|
@@ -1435,6 +1721,54 @@ module Aws::IoTTwinMaker
|
|
1435
1721
|
req.send_request(options)
|
1436
1722
|
end
|
1437
1723
|
|
1724
|
+
# Gets the SyncJob.
|
1725
|
+
#
|
1726
|
+
# @option params [required, String] :sync_source
|
1727
|
+
# The sync soucre.
|
1728
|
+
#
|
1729
|
+
# <note markdown="1"> Currently the only supported syncSoucre is `SITEWISE `.
|
1730
|
+
#
|
1731
|
+
# </note>
|
1732
|
+
#
|
1733
|
+
# @option params [String] :workspace_id
|
1734
|
+
# The workspace Id.
|
1735
|
+
#
|
1736
|
+
# @return [Types::GetSyncJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1737
|
+
#
|
1738
|
+
# * {Types::GetSyncJobResponse#arn #arn} => String
|
1739
|
+
# * {Types::GetSyncJobResponse#workspace_id #workspace_id} => String
|
1740
|
+
# * {Types::GetSyncJobResponse#sync_source #sync_source} => String
|
1741
|
+
# * {Types::GetSyncJobResponse#sync_role #sync_role} => String
|
1742
|
+
# * {Types::GetSyncJobResponse#status #status} => Types::SyncJobStatus
|
1743
|
+
# * {Types::GetSyncJobResponse#creation_date_time #creation_date_time} => Time
|
1744
|
+
# * {Types::GetSyncJobResponse#update_date_time #update_date_time} => Time
|
1745
|
+
#
|
1746
|
+
# @example Request syntax with placeholder values
|
1747
|
+
#
|
1748
|
+
# resp = client.get_sync_job({
|
1749
|
+
# sync_source: "SyncSource", # required
|
1750
|
+
# workspace_id: "Id",
|
1751
|
+
# })
|
1752
|
+
#
|
1753
|
+
# @example Response structure
|
1754
|
+
#
|
1755
|
+
# resp.arn #=> String
|
1756
|
+
# resp.workspace_id #=> String
|
1757
|
+
# resp.sync_source #=> String
|
1758
|
+
# resp.sync_role #=> String
|
1759
|
+
# resp.status.state #=> String, one of "CREATING", "INITIALIZING", "ACTIVE", "DELETING", "ERROR"
|
1760
|
+
# resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR"
|
1761
|
+
# resp.status.error.message #=> String
|
1762
|
+
# resp.creation_date_time #=> Time
|
1763
|
+
# resp.update_date_time #=> Time
|
1764
|
+
#
|
1765
|
+
# @overload get_sync_job(params = {})
|
1766
|
+
# @param [Hash] params ({})
|
1767
|
+
def get_sync_job(params = {}, options = {})
|
1768
|
+
req = build_request(:get_sync_job, params)
|
1769
|
+
req.send_request(options)
|
1770
|
+
end
|
1771
|
+
|
1438
1772
|
# Retrieves information about a workspace.
|
1439
1773
|
#
|
1440
1774
|
# @option params [required, String] :workspace_id
|
@@ -1442,13 +1776,13 @@ module Aws::IoTTwinMaker
|
|
1442
1776
|
#
|
1443
1777
|
# @return [Types::GetWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1444
1778
|
#
|
1779
|
+
# * {Types::GetWorkspaceResponse#workspace_id #workspace_id} => String
|
1445
1780
|
# * {Types::GetWorkspaceResponse#arn #arn} => String
|
1446
|
-
# * {Types::GetWorkspaceResponse#creation_date_time #creation_date_time} => Time
|
1447
1781
|
# * {Types::GetWorkspaceResponse#description #description} => String
|
1448
|
-
# * {Types::GetWorkspaceResponse#role #role} => String
|
1449
1782
|
# * {Types::GetWorkspaceResponse#s3_location #s3_location} => String
|
1783
|
+
# * {Types::GetWorkspaceResponse#role #role} => String
|
1784
|
+
# * {Types::GetWorkspaceResponse#creation_date_time #creation_date_time} => Time
|
1450
1785
|
# * {Types::GetWorkspaceResponse#update_date_time #update_date_time} => Time
|
1451
|
-
# * {Types::GetWorkspaceResponse#workspace_id #workspace_id} => String
|
1452
1786
|
#
|
1453
1787
|
# @example Request syntax with placeholder values
|
1454
1788
|
#
|
@@ -1458,13 +1792,13 @@ module Aws::IoTTwinMaker
|
|
1458
1792
|
#
|
1459
1793
|
# @example Response structure
|
1460
1794
|
#
|
1795
|
+
# resp.workspace_id #=> String
|
1461
1796
|
# resp.arn #=> String
|
1462
|
-
# resp.creation_date_time #=> Time
|
1463
1797
|
# resp.description #=> String
|
1464
|
-
# resp.role #=> String
|
1465
1798
|
# resp.s3_location #=> String
|
1799
|
+
# resp.role #=> String
|
1800
|
+
# resp.creation_date_time #=> Time
|
1466
1801
|
# resp.update_date_time #=> Time
|
1467
|
-
# resp.workspace_id #=> String
|
1468
1802
|
#
|
1469
1803
|
# @overload get_workspace(params = {})
|
1470
1804
|
# @param [Hash] params ({})
|
@@ -1475,56 +1809,60 @@ module Aws::IoTTwinMaker
|
|
1475
1809
|
|
1476
1810
|
# Lists all component types in a workspace.
|
1477
1811
|
#
|
1812
|
+
# @option params [required, String] :workspace_id
|
1813
|
+
# The ID of the workspace.
|
1814
|
+
#
|
1478
1815
|
# @option params [Array<Types::ListComponentTypesFilter>] :filters
|
1479
1816
|
# A list of objects that filter the request.
|
1480
1817
|
#
|
1481
|
-
# @option params [Integer] :max_results
|
1482
|
-
# The maximum number of results to display.
|
1483
|
-
#
|
1484
1818
|
# @option params [String] :next_token
|
1485
1819
|
# The string that specifies the next page of results.
|
1486
1820
|
#
|
1487
|
-
# @option params [
|
1488
|
-
# The
|
1821
|
+
# @option params [Integer] :max_results
|
1822
|
+
# The maximum number of results to return at one time. The default is
|
1823
|
+
# 25.
|
1824
|
+
#
|
1825
|
+
# Valid Range: Minimum value of 1. Maximum value of 250.
|
1489
1826
|
#
|
1490
1827
|
# @return [Types::ListComponentTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1491
1828
|
#
|
1829
|
+
# * {Types::ListComponentTypesResponse#workspace_id #workspace_id} => String
|
1492
1830
|
# * {Types::ListComponentTypesResponse#component_type_summaries #component_type_summaries} => Array<Types::ComponentTypeSummary>
|
1493
|
-
# * {Types::ListComponentTypesResponse#max_results #max_results} => Integer
|
1494
1831
|
# * {Types::ListComponentTypesResponse#next_token #next_token} => String
|
1495
|
-
# * {Types::ListComponentTypesResponse#
|
1832
|
+
# * {Types::ListComponentTypesResponse#max_results #max_results} => Integer
|
1496
1833
|
#
|
1497
1834
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1498
1835
|
#
|
1499
1836
|
# @example Request syntax with placeholder values
|
1500
1837
|
#
|
1501
1838
|
# resp = client.list_component_types({
|
1839
|
+
# workspace_id: "Id", # required
|
1502
1840
|
# filters: [
|
1503
1841
|
# {
|
1504
1842
|
# extends_from: "ComponentTypeId",
|
1505
|
-
# is_abstract: false,
|
1506
1843
|
# namespace: "String",
|
1844
|
+
# is_abstract: false,
|
1507
1845
|
# },
|
1508
1846
|
# ],
|
1509
|
-
# max_results: 1,
|
1510
1847
|
# next_token: "NextToken",
|
1511
|
-
#
|
1848
|
+
# max_results: 1,
|
1512
1849
|
# })
|
1513
1850
|
#
|
1514
1851
|
# @example Response structure
|
1515
1852
|
#
|
1853
|
+
# resp.workspace_id #=> String
|
1516
1854
|
# resp.component_type_summaries #=> Array
|
1517
1855
|
# resp.component_type_summaries[0].arn #=> String
|
1518
1856
|
# resp.component_type_summaries[0].component_type_id #=> String
|
1519
1857
|
# resp.component_type_summaries[0].creation_date_time #=> Time
|
1858
|
+
# resp.component_type_summaries[0].update_date_time #=> Time
|
1520
1859
|
# resp.component_type_summaries[0].description #=> String
|
1521
|
-
# resp.component_type_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
1522
|
-
# resp.component_type_summaries[0].status.error.message #=> String
|
1523
1860
|
# resp.component_type_summaries[0].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1524
|
-
# resp.component_type_summaries[0].
|
1525
|
-
# resp.
|
1861
|
+
# resp.component_type_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR"
|
1862
|
+
# resp.component_type_summaries[0].status.error.message #=> String
|
1863
|
+
# resp.component_type_summaries[0].component_type_name #=> String
|
1526
1864
|
# resp.next_token #=> String
|
1527
|
-
# resp.
|
1865
|
+
# resp.max_results #=> Integer
|
1528
1866
|
#
|
1529
1867
|
# @overload list_component_types(params = {})
|
1530
1868
|
# @param [Hash] params ({})
|
@@ -1535,6 +1873,9 @@ module Aws::IoTTwinMaker
|
|
1535
1873
|
|
1536
1874
|
# Lists all entities in a workspace.
|
1537
1875
|
#
|
1876
|
+
# @option params [required, String] :workspace_id
|
1877
|
+
# The ID of the workspace.
|
1878
|
+
#
|
1538
1879
|
# @option params [Array<Types::ListEntitiesFilter>] :filters
|
1539
1880
|
# A list of objects that filter the request.
|
1540
1881
|
#
|
@@ -1543,14 +1884,14 @@ module Aws::IoTTwinMaker
|
|
1543
1884
|
# </note>
|
1544
1885
|
#
|
1545
1886
|
# @option params [Integer] :max_results
|
1546
|
-
# The maximum number of results to
|
1887
|
+
# The maximum number of results to return at one time. The default is
|
1888
|
+
# 25.
|
1889
|
+
#
|
1890
|
+
# Valid Range: Minimum value of 1. Maximum value of 250.
|
1547
1891
|
#
|
1548
1892
|
# @option params [String] :next_token
|
1549
1893
|
# The string that specifies the next page of results.
|
1550
1894
|
#
|
1551
|
-
# @option params [required, String] :workspace_id
|
1552
|
-
# The ID of the workspace.
|
1553
|
-
#
|
1554
1895
|
# @return [Types::ListEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1555
1896
|
#
|
1556
1897
|
# * {Types::ListEntitiesResponse#entity_summaries #entity_summaries} => Array<Types::EntitySummary>
|
@@ -1561,31 +1902,31 @@ module Aws::IoTTwinMaker
|
|
1561
1902
|
# @example Request syntax with placeholder values
|
1562
1903
|
#
|
1563
1904
|
# resp = client.list_entities({
|
1905
|
+
# workspace_id: "Id", # required
|
1564
1906
|
# filters: [
|
1565
1907
|
# {
|
1908
|
+
# parent_entity_id: "ParentEntityId",
|
1566
1909
|
# component_type_id: "ComponentTypeId",
|
1567
1910
|
# external_id: "String",
|
1568
|
-
# parent_entity_id: "ParentEntityId",
|
1569
1911
|
# },
|
1570
1912
|
# ],
|
1571
1913
|
# max_results: 1,
|
1572
1914
|
# next_token: "NextToken",
|
1573
|
-
# workspace_id: "Id", # required
|
1574
1915
|
# })
|
1575
1916
|
#
|
1576
1917
|
# @example Response structure
|
1577
1918
|
#
|
1578
1919
|
# resp.entity_summaries #=> Array
|
1579
|
-
# resp.entity_summaries[0].arn #=> String
|
1580
|
-
# resp.entity_summaries[0].creation_date_time #=> Time
|
1581
|
-
# resp.entity_summaries[0].description #=> String
|
1582
1920
|
# resp.entity_summaries[0].entity_id #=> String
|
1583
1921
|
# resp.entity_summaries[0].entity_name #=> String
|
1584
|
-
# resp.entity_summaries[0].
|
1922
|
+
# resp.entity_summaries[0].arn #=> String
|
1585
1923
|
# resp.entity_summaries[0].parent_entity_id #=> String
|
1586
|
-
# resp.entity_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
1587
|
-
# resp.entity_summaries[0].status.error.message #=> String
|
1588
1924
|
# resp.entity_summaries[0].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1925
|
+
# resp.entity_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR"
|
1926
|
+
# resp.entity_summaries[0].status.error.message #=> String
|
1927
|
+
# resp.entity_summaries[0].description #=> String
|
1928
|
+
# resp.entity_summaries[0].has_child_entities #=> Boolean
|
1929
|
+
# resp.entity_summaries[0].creation_date_time #=> Time
|
1589
1930
|
# resp.entity_summaries[0].update_date_time #=> Time
|
1590
1931
|
# resp.next_token #=> String
|
1591
1932
|
#
|
@@ -1598,40 +1939,40 @@ module Aws::IoTTwinMaker
|
|
1598
1939
|
|
1599
1940
|
# Lists all scenes in a workspace.
|
1600
1941
|
#
|
1942
|
+
# @option params [required, String] :workspace_id
|
1943
|
+
# The ID of the workspace that contains the scenes.
|
1944
|
+
#
|
1601
1945
|
# @option params [Integer] :max_results
|
1602
1946
|
# Specifies the maximum number of results to display.
|
1603
1947
|
#
|
1604
1948
|
# @option params [String] :next_token
|
1605
1949
|
# The string that specifies the next page of results.
|
1606
1950
|
#
|
1607
|
-
# @option params [required, String] :workspace_id
|
1608
|
-
# The ID of the workspace that contains the scenes.
|
1609
|
-
#
|
1610
1951
|
# @return [Types::ListScenesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1611
1952
|
#
|
1612
|
-
# * {Types::ListScenesResponse#next_token #next_token} => String
|
1613
1953
|
# * {Types::ListScenesResponse#scene_summaries #scene_summaries} => Array<Types::SceneSummary>
|
1954
|
+
# * {Types::ListScenesResponse#next_token #next_token} => String
|
1614
1955
|
#
|
1615
1956
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1616
1957
|
#
|
1617
1958
|
# @example Request syntax with placeholder values
|
1618
1959
|
#
|
1619
1960
|
# resp = client.list_scenes({
|
1961
|
+
# workspace_id: "Id", # required
|
1620
1962
|
# max_results: 1,
|
1621
1963
|
# next_token: "NextToken",
|
1622
|
-
# workspace_id: "Id", # required
|
1623
1964
|
# })
|
1624
1965
|
#
|
1625
1966
|
# @example Response structure
|
1626
1967
|
#
|
1627
|
-
# resp.next_token #=> String
|
1628
1968
|
# resp.scene_summaries #=> Array
|
1629
|
-
# resp.scene_summaries[0].
|
1969
|
+
# resp.scene_summaries[0].scene_id #=> String
|
1630
1970
|
# resp.scene_summaries[0].content_location #=> String
|
1971
|
+
# resp.scene_summaries[0].arn #=> String
|
1631
1972
|
# resp.scene_summaries[0].creation_date_time #=> Time
|
1632
|
-
# resp.scene_summaries[0].description #=> String
|
1633
|
-
# resp.scene_summaries[0].scene_id #=> String
|
1634
1973
|
# resp.scene_summaries[0].update_date_time #=> Time
|
1974
|
+
# resp.scene_summaries[0].description #=> String
|
1975
|
+
# resp.next_token #=> String
|
1635
1976
|
#
|
1636
1977
|
# @overload list_scenes(params = {})
|
1637
1978
|
# @param [Hash] params ({})
|
@@ -1640,35 +1981,154 @@ module Aws::IoTTwinMaker
|
|
1640
1981
|
req.send_request(options)
|
1641
1982
|
end
|
1642
1983
|
|
1984
|
+
# List all SyncJobs.
|
1985
|
+
#
|
1986
|
+
# @option params [required, String] :workspace_id
|
1987
|
+
# The ID of the workspace that contains the sync job.
|
1988
|
+
#
|
1989
|
+
# @option params [Integer] :max_results
|
1990
|
+
# The maximum number of results to return at one time. The default is
|
1991
|
+
# 50.
|
1992
|
+
#
|
1993
|
+
# Valid Range: Minimum value of 0. Maximum value of 200.
|
1994
|
+
#
|
1995
|
+
# @option params [String] :next_token
|
1996
|
+
# The string that specifies the next page of results.
|
1997
|
+
#
|
1998
|
+
# @return [Types::ListSyncJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1999
|
+
#
|
2000
|
+
# * {Types::ListSyncJobsResponse#sync_job_summaries #sync_job_summaries} => Array<Types::SyncJobSummary>
|
2001
|
+
# * {Types::ListSyncJobsResponse#next_token #next_token} => String
|
2002
|
+
#
|
2003
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2004
|
+
#
|
2005
|
+
# @example Request syntax with placeholder values
|
2006
|
+
#
|
2007
|
+
# resp = client.list_sync_jobs({
|
2008
|
+
# workspace_id: "Id", # required
|
2009
|
+
# max_results: 1,
|
2010
|
+
# next_token: "NextToken",
|
2011
|
+
# })
|
2012
|
+
#
|
2013
|
+
# @example Response structure
|
2014
|
+
#
|
2015
|
+
# resp.sync_job_summaries #=> Array
|
2016
|
+
# resp.sync_job_summaries[0].arn #=> String
|
2017
|
+
# resp.sync_job_summaries[0].workspace_id #=> String
|
2018
|
+
# resp.sync_job_summaries[0].sync_source #=> String
|
2019
|
+
# resp.sync_job_summaries[0].status.state #=> String, one of "CREATING", "INITIALIZING", "ACTIVE", "DELETING", "ERROR"
|
2020
|
+
# resp.sync_job_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR"
|
2021
|
+
# resp.sync_job_summaries[0].status.error.message #=> String
|
2022
|
+
# resp.sync_job_summaries[0].creation_date_time #=> Time
|
2023
|
+
# resp.sync_job_summaries[0].update_date_time #=> Time
|
2024
|
+
# resp.next_token #=> String
|
2025
|
+
#
|
2026
|
+
# @overload list_sync_jobs(params = {})
|
2027
|
+
# @param [Hash] params ({})
|
2028
|
+
def list_sync_jobs(params = {}, options = {})
|
2029
|
+
req = build_request(:list_sync_jobs, params)
|
2030
|
+
req.send_request(options)
|
2031
|
+
end
|
2032
|
+
|
2033
|
+
# Lists the sync resources.
|
2034
|
+
#
|
2035
|
+
# @option params [required, String] :workspace_id
|
2036
|
+
# The ID of the workspace that contains the sync job.
|
2037
|
+
#
|
2038
|
+
# @option params [required, String] :sync_source
|
2039
|
+
# The sync soucre.
|
2040
|
+
#
|
2041
|
+
# <note markdown="1"> Currently the only supported syncSoucre is `SITEWISE `.
|
2042
|
+
#
|
2043
|
+
# </note>
|
2044
|
+
#
|
2045
|
+
# @option params [Array<Types::SyncResourceFilter>] :filters
|
2046
|
+
# A list of objects that filter the request.
|
2047
|
+
#
|
2048
|
+
# @option params [Integer] :max_results
|
2049
|
+
# The maximum number of results to return at one time. The default is
|
2050
|
+
# 50.
|
2051
|
+
#
|
2052
|
+
# Valid Range: Minimum value of 0. Maximum value of 200.
|
2053
|
+
#
|
2054
|
+
# @option params [String] :next_token
|
2055
|
+
# The string that specifies the next page of results.
|
2056
|
+
#
|
2057
|
+
# @return [Types::ListSyncResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2058
|
+
#
|
2059
|
+
# * {Types::ListSyncResourcesResponse#sync_resources #sync_resources} => Array<Types::SyncResourceSummary>
|
2060
|
+
# * {Types::ListSyncResourcesResponse#next_token #next_token} => String
|
2061
|
+
#
|
2062
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2063
|
+
#
|
2064
|
+
# @example Request syntax with placeholder values
|
2065
|
+
#
|
2066
|
+
# resp = client.list_sync_resources({
|
2067
|
+
# workspace_id: "Id", # required
|
2068
|
+
# sync_source: "SyncSource", # required
|
2069
|
+
# filters: [
|
2070
|
+
# {
|
2071
|
+
# state: "INITIALIZING", # accepts INITIALIZING, PROCESSING, DELETED, IN_SYNC, ERROR
|
2072
|
+
# resource_type: "ENTITY", # accepts ENTITY, COMPONENT_TYPE
|
2073
|
+
# resource_id: "Id",
|
2074
|
+
# external_id: "Id",
|
2075
|
+
# },
|
2076
|
+
# ],
|
2077
|
+
# max_results: 1,
|
2078
|
+
# next_token: "NextToken",
|
2079
|
+
# })
|
2080
|
+
#
|
2081
|
+
# @example Response structure
|
2082
|
+
#
|
2083
|
+
# resp.sync_resources #=> Array
|
2084
|
+
# resp.sync_resources[0].resource_type #=> String, one of "ENTITY", "COMPONENT_TYPE"
|
2085
|
+
# resp.sync_resources[0].external_id #=> String
|
2086
|
+
# resp.sync_resources[0].resource_id #=> String
|
2087
|
+
# resp.sync_resources[0].status.state #=> String, one of "INITIALIZING", "PROCESSING", "DELETED", "IN_SYNC", "ERROR"
|
2088
|
+
# resp.sync_resources[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR"
|
2089
|
+
# resp.sync_resources[0].status.error.message #=> String
|
2090
|
+
# resp.sync_resources[0].update_date_time #=> Time
|
2091
|
+
# resp.next_token #=> String
|
2092
|
+
#
|
2093
|
+
# @overload list_sync_resources(params = {})
|
2094
|
+
# @param [Hash] params ({})
|
2095
|
+
def list_sync_resources(params = {}, options = {})
|
2096
|
+
req = build_request(:list_sync_resources, params)
|
2097
|
+
req.send_request(options)
|
2098
|
+
end
|
2099
|
+
|
1643
2100
|
# Lists all tags associated with a resource.
|
1644
2101
|
#
|
2102
|
+
# @option params [required, String] :resource_arn
|
2103
|
+
# The ARN of the resource.
|
2104
|
+
#
|
1645
2105
|
# @option params [Integer] :max_results
|
1646
|
-
# The maximum number of results to
|
2106
|
+
# The maximum number of results to return at one time. The default is
|
2107
|
+
# 25.
|
2108
|
+
#
|
2109
|
+
# Valid Range: Minimum value of 1. Maximum value of 250.
|
1647
2110
|
#
|
1648
2111
|
# @option params [String] :next_token
|
1649
2112
|
# The string that specifies the next page of results.
|
1650
2113
|
#
|
1651
|
-
# @option params [required, String] :resource_arn
|
1652
|
-
# The ARN of the resource.
|
1653
|
-
#
|
1654
2114
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1655
2115
|
#
|
1656
|
-
# * {Types::ListTagsForResourceResponse#next_token #next_token} => String
|
1657
2116
|
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
2117
|
+
# * {Types::ListTagsForResourceResponse#next_token #next_token} => String
|
1658
2118
|
#
|
1659
2119
|
# @example Request syntax with placeholder values
|
1660
2120
|
#
|
1661
2121
|
# resp = client.list_tags_for_resource({
|
2122
|
+
# resource_arn: "TwinMakerArn", # required
|
1662
2123
|
# max_results: 1,
|
1663
2124
|
# next_token: "NextToken",
|
1664
|
-
# resource_arn: "TwinMakerArn", # required
|
1665
2125
|
# })
|
1666
2126
|
#
|
1667
2127
|
# @example Response structure
|
1668
2128
|
#
|
1669
|
-
# resp.next_token #=> String
|
1670
2129
|
# resp.tags #=> Hash
|
1671
2130
|
# resp.tags["TagKey"] #=> String
|
2131
|
+
# resp.next_token #=> String
|
1672
2132
|
#
|
1673
2133
|
# @overload list_tags_for_resource(params = {})
|
1674
2134
|
# @param [Hash] params ({})
|
@@ -1680,15 +2140,18 @@ module Aws::IoTTwinMaker
|
|
1680
2140
|
# Retrieves information about workspaces in the current account.
|
1681
2141
|
#
|
1682
2142
|
# @option params [Integer] :max_results
|
1683
|
-
# The maximum number of results to
|
2143
|
+
# The maximum number of results to return at one time. The default is
|
2144
|
+
# 25.
|
2145
|
+
#
|
2146
|
+
# Valid Range: Minimum value of 1. Maximum value of 250.
|
1684
2147
|
#
|
1685
2148
|
# @option params [String] :next_token
|
1686
2149
|
# The string that specifies the next page of results.
|
1687
2150
|
#
|
1688
2151
|
# @return [Types::ListWorkspacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1689
2152
|
#
|
1690
|
-
# * {Types::ListWorkspacesResponse#next_token #next_token} => String
|
1691
2153
|
# * {Types::ListWorkspacesResponse#workspace_summaries #workspace_summaries} => Array<Types::WorkspaceSummary>
|
2154
|
+
# * {Types::ListWorkspacesResponse#next_token #next_token} => String
|
1692
2155
|
#
|
1693
2156
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1694
2157
|
#
|
@@ -1701,13 +2164,13 @@ module Aws::IoTTwinMaker
|
|
1701
2164
|
#
|
1702
2165
|
# @example Response structure
|
1703
2166
|
#
|
1704
|
-
# resp.next_token #=> String
|
1705
2167
|
# resp.workspace_summaries #=> Array
|
2168
|
+
# resp.workspace_summaries[0].workspace_id #=> String
|
1706
2169
|
# resp.workspace_summaries[0].arn #=> String
|
1707
|
-
# resp.workspace_summaries[0].creation_date_time #=> Time
|
1708
2170
|
# resp.workspace_summaries[0].description #=> String
|
2171
|
+
# resp.workspace_summaries[0].creation_date_time #=> Time
|
1709
2172
|
# resp.workspace_summaries[0].update_date_time #=> Time
|
1710
|
-
# resp.
|
2173
|
+
# resp.next_token #=> String
|
1711
2174
|
#
|
1712
2175
|
# @overload list_workspaces(params = {})
|
1713
2176
|
# @param [Hash] params ({})
|
@@ -1769,12 +2232,24 @@ module Aws::IoTTwinMaker
|
|
1769
2232
|
|
1770
2233
|
# Updates information in a component type.
|
1771
2234
|
#
|
2235
|
+
# @option params [required, String] :workspace_id
|
2236
|
+
# The ID of the workspace.
|
2237
|
+
#
|
2238
|
+
# @option params [Boolean] :is_singleton
|
2239
|
+
# A Boolean value that specifies whether an entity can have more than
|
2240
|
+
# one component of this type.
|
2241
|
+
#
|
1772
2242
|
# @option params [required, String] :component_type_id
|
1773
2243
|
# The ID of the component type.
|
1774
2244
|
#
|
1775
2245
|
# @option params [String] :description
|
1776
2246
|
# The description of the component type.
|
1777
2247
|
#
|
2248
|
+
# @option params [Hash<String,Types::PropertyDefinitionRequest>] :property_definitions
|
2249
|
+
# An object that maps strings to the property definitions in the
|
2250
|
+
# component type. Each string in the mapping must be unique to this
|
2251
|
+
# object.
|
2252
|
+
#
|
1778
2253
|
# @option params [Array<String>] :extends_from
|
1779
2254
|
# Specifies the component type that this component type extends.
|
1780
2255
|
#
|
@@ -1782,119 +2257,121 @@ module Aws::IoTTwinMaker
|
|
1782
2257
|
# An object that maps strings to the functions in the component type.
|
1783
2258
|
# Each string in the mapping must be unique to this object.
|
1784
2259
|
#
|
1785
|
-
# @option params [
|
1786
|
-
#
|
1787
|
-
# one component of this type.
|
1788
|
-
#
|
1789
|
-
# @option params [Hash<String,Types::PropertyDefinitionRequest>] :property_definitions
|
1790
|
-
# An object that maps strings to the property definitions in the
|
1791
|
-
# component type. Each string in the mapping must be unique to this
|
1792
|
-
# object.
|
2260
|
+
# @option params [Hash<String,Types::PropertyGroupRequest>] :property_groups
|
2261
|
+
# The property groups
|
1793
2262
|
#
|
1794
|
-
# @option params [
|
1795
|
-
# The
|
2263
|
+
# @option params [String] :component_type_name
|
2264
|
+
# The component type name.
|
1796
2265
|
#
|
1797
2266
|
# @return [Types::UpdateComponentTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1798
2267
|
#
|
2268
|
+
# * {Types::UpdateComponentTypeResponse#workspace_id #workspace_id} => String
|
1799
2269
|
# * {Types::UpdateComponentTypeResponse#arn #arn} => String
|
1800
2270
|
# * {Types::UpdateComponentTypeResponse#component_type_id #component_type_id} => String
|
1801
2271
|
# * {Types::UpdateComponentTypeResponse#state #state} => String
|
1802
|
-
# * {Types::UpdateComponentTypeResponse#workspace_id #workspace_id} => String
|
1803
2272
|
#
|
1804
2273
|
# @example Request syntax with placeholder values
|
1805
2274
|
#
|
1806
2275
|
# resp = client.update_component_type({
|
2276
|
+
# workspace_id: "Id", # required
|
2277
|
+
# is_singleton: false,
|
1807
2278
|
# component_type_id: "ComponentTypeId", # required
|
1808
2279
|
# description: "Description",
|
1809
|
-
# extends_from: ["ComponentTypeId"],
|
1810
|
-
# functions: {
|
1811
|
-
# "Name" => {
|
1812
|
-
# implemented_by: {
|
1813
|
-
# is_native: false,
|
1814
|
-
# lambda: {
|
1815
|
-
# arn: "LambdaArn", # required
|
1816
|
-
# },
|
1817
|
-
# },
|
1818
|
-
# required_properties: ["Name"],
|
1819
|
-
# scope: "ENTITY", # accepts ENTITY, WORKSPACE
|
1820
|
-
# },
|
1821
|
-
# },
|
1822
|
-
# is_singleton: false,
|
1823
2280
|
# property_definitions: {
|
1824
2281
|
# "Name" => {
|
1825
|
-
# configuration: {
|
1826
|
-
# "Name" => "Value",
|
1827
|
-
# },
|
1828
2282
|
# data_type: {
|
2283
|
+
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
2284
|
+
# nested_type: {
|
2285
|
+
# # recursive DataType
|
2286
|
+
# },
|
1829
2287
|
# allowed_values: [
|
1830
2288
|
# {
|
1831
2289
|
# boolean_value: false,
|
1832
2290
|
# double_value: 1.0,
|
1833
|
-
# expression: "Expression",
|
1834
2291
|
# integer_value: 1,
|
2292
|
+
# long_value: 1,
|
2293
|
+
# string_value: "String",
|
1835
2294
|
# list_value: {
|
1836
2295
|
# # recursive DataValueList
|
1837
2296
|
# },
|
1838
|
-
# long_value: 1,
|
1839
2297
|
# map_value: {
|
1840
2298
|
# "String" => {
|
1841
2299
|
# # recursive DataValue
|
1842
2300
|
# },
|
1843
2301
|
# },
|
1844
2302
|
# relationship_value: {
|
1845
|
-
# target_component_name: "Name",
|
1846
2303
|
# target_entity_id: "EntityId",
|
2304
|
+
# target_component_name: "Name",
|
1847
2305
|
# },
|
1848
|
-
#
|
2306
|
+
# expression: "Expression",
|
1849
2307
|
# },
|
1850
2308
|
# ],
|
1851
|
-
#
|
1852
|
-
# # recursive DataType
|
1853
|
-
# },
|
2309
|
+
# unit_of_measure: "String",
|
1854
2310
|
# relationship: {
|
1855
|
-
# relationship_type: "String",
|
1856
2311
|
# target_component_type_id: "ComponentTypeId",
|
2312
|
+
# relationship_type: "String",
|
1857
2313
|
# },
|
1858
|
-
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
1859
|
-
# unit_of_measure: "String",
|
1860
2314
|
# },
|
2315
|
+
# is_required_in_entity: false,
|
2316
|
+
# is_external_id: false,
|
2317
|
+
# is_stored_externally: false,
|
2318
|
+
# is_time_series: false,
|
1861
2319
|
# default_value: {
|
1862
2320
|
# boolean_value: false,
|
1863
2321
|
# double_value: 1.0,
|
1864
|
-
# expression: "Expression",
|
1865
2322
|
# integer_value: 1,
|
2323
|
+
# long_value: 1,
|
2324
|
+
# string_value: "String",
|
1866
2325
|
# list_value: [
|
1867
2326
|
# {
|
1868
2327
|
# # recursive DataValue
|
1869
2328
|
# },
|
1870
2329
|
# ],
|
1871
|
-
# long_value: 1,
|
1872
2330
|
# map_value: {
|
1873
2331
|
# "String" => {
|
1874
2332
|
# # recursive DataValue
|
1875
2333
|
# },
|
1876
2334
|
# },
|
1877
2335
|
# relationship_value: {
|
1878
|
-
# target_component_name: "Name",
|
1879
2336
|
# target_entity_id: "EntityId",
|
2337
|
+
# target_component_name: "Name",
|
1880
2338
|
# },
|
1881
|
-
#
|
2339
|
+
# expression: "Expression",
|
1882
2340
|
# },
|
1883
|
-
#
|
1884
|
-
#
|
1885
|
-
#
|
1886
|
-
#
|
2341
|
+
# configuration: {
|
2342
|
+
# "Name" => "Value",
|
2343
|
+
# },
|
2344
|
+
# display_name: "PropertyDisplayName",
|
1887
2345
|
# },
|
1888
2346
|
# },
|
1889
|
-
#
|
2347
|
+
# extends_from: ["ComponentTypeId"],
|
2348
|
+
# functions: {
|
2349
|
+
# "Name" => {
|
2350
|
+
# required_properties: ["Name"],
|
2351
|
+
# scope: "ENTITY", # accepts ENTITY, WORKSPACE
|
2352
|
+
# implemented_by: {
|
2353
|
+
# lambda: {
|
2354
|
+
# arn: "LambdaArn", # required
|
2355
|
+
# },
|
2356
|
+
# is_native: false,
|
2357
|
+
# },
|
2358
|
+
# },
|
2359
|
+
# },
|
2360
|
+
# property_groups: {
|
2361
|
+
# "Name" => {
|
2362
|
+
# group_type: "TABULAR", # accepts TABULAR
|
2363
|
+
# property_names: ["Name"],
|
2364
|
+
# },
|
2365
|
+
# },
|
2366
|
+
# component_type_name: "ComponentTypeName",
|
1890
2367
|
# })
|
1891
2368
|
#
|
1892
2369
|
# @example Response structure
|
1893
2370
|
#
|
2371
|
+
# resp.workspace_id #=> String
|
1894
2372
|
# resp.arn #=> String
|
1895
2373
|
# resp.component_type_id #=> String
|
1896
2374
|
# resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1897
|
-
# resp.workspace_id #=> String
|
1898
2375
|
#
|
1899
2376
|
# @overload update_component_type(params = {})
|
1900
2377
|
# @param [Hash] params ({})
|
@@ -1905,12 +2382,8 @@ module Aws::IoTTwinMaker
|
|
1905
2382
|
|
1906
2383
|
# Updates an entity.
|
1907
2384
|
#
|
1908
|
-
# @option params [
|
1909
|
-
#
|
1910
|
-
# Each string in the mapping must be unique to this object.
|
1911
|
-
#
|
1912
|
-
# @option params [String] :description
|
1913
|
-
# The description of the entity.
|
2385
|
+
# @option params [required, String] :workspace_id
|
2386
|
+
# The ID of the workspace that contains the entity.
|
1914
2387
|
#
|
1915
2388
|
# @option params [required, String] :entity_id
|
1916
2389
|
# The ID of the entity.
|
@@ -1918,132 +2391,144 @@ module Aws::IoTTwinMaker
|
|
1918
2391
|
# @option params [String] :entity_name
|
1919
2392
|
# The name of the entity.
|
1920
2393
|
#
|
2394
|
+
# @option params [String] :description
|
2395
|
+
# The description of the entity.
|
2396
|
+
#
|
2397
|
+
# @option params [Hash<String,Types::ComponentUpdateRequest>] :component_updates
|
2398
|
+
# An object that maps strings to the component updates in the request.
|
2399
|
+
# Each string in the mapping must be unique to this object.
|
2400
|
+
#
|
1921
2401
|
# @option params [Types::ParentEntityUpdateRequest] :parent_entity_update
|
1922
2402
|
# An object that describes the update request for a parent entity.
|
1923
2403
|
#
|
1924
|
-
# @option params [required, String] :workspace_id
|
1925
|
-
# The ID of the workspace that contains the entity.
|
1926
|
-
#
|
1927
2404
|
# @return [Types::UpdateEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1928
2405
|
#
|
1929
|
-
# * {Types::UpdateEntityResponse#state #state} => String
|
1930
2406
|
# * {Types::UpdateEntityResponse#update_date_time #update_date_time} => Time
|
2407
|
+
# * {Types::UpdateEntityResponse#state #state} => String
|
1931
2408
|
#
|
1932
2409
|
# @example Request syntax with placeholder values
|
1933
2410
|
#
|
1934
2411
|
# resp = client.update_entity({
|
2412
|
+
# workspace_id: "Id", # required
|
2413
|
+
# entity_id: "EntityId", # required
|
2414
|
+
# entity_name: "EntityName",
|
2415
|
+
# description: "Description",
|
1935
2416
|
# component_updates: {
|
1936
2417
|
# "Name" => {
|
1937
|
-
#
|
2418
|
+
# update_type: "CREATE", # accepts CREATE, UPDATE, DELETE
|
1938
2419
|
# description: "Description",
|
2420
|
+
# component_type_id: "ComponentTypeId",
|
1939
2421
|
# property_updates: {
|
1940
2422
|
# "Name" => {
|
1941
2423
|
# definition: {
|
1942
|
-
# configuration: {
|
1943
|
-
# "Name" => "Value",
|
1944
|
-
# },
|
1945
2424
|
# data_type: {
|
2425
|
+
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
2426
|
+
# nested_type: {
|
2427
|
+
# # recursive DataType
|
2428
|
+
# },
|
1946
2429
|
# allowed_values: [
|
1947
2430
|
# {
|
1948
2431
|
# boolean_value: false,
|
1949
2432
|
# double_value: 1.0,
|
1950
|
-
# expression: "Expression",
|
1951
2433
|
# integer_value: 1,
|
2434
|
+
# long_value: 1,
|
2435
|
+
# string_value: "String",
|
1952
2436
|
# list_value: {
|
1953
2437
|
# # recursive DataValueList
|
1954
2438
|
# },
|
1955
|
-
# long_value: 1,
|
1956
2439
|
# map_value: {
|
1957
2440
|
# "String" => {
|
1958
2441
|
# # recursive DataValue
|
1959
2442
|
# },
|
1960
2443
|
# },
|
1961
2444
|
# relationship_value: {
|
1962
|
-
# target_component_name: "Name",
|
1963
2445
|
# target_entity_id: "EntityId",
|
2446
|
+
# target_component_name: "Name",
|
1964
2447
|
# },
|
1965
|
-
#
|
2448
|
+
# expression: "Expression",
|
1966
2449
|
# },
|
1967
2450
|
# ],
|
1968
|
-
#
|
1969
|
-
# # recursive DataType
|
1970
|
-
# },
|
2451
|
+
# unit_of_measure: "String",
|
1971
2452
|
# relationship: {
|
1972
|
-
# relationship_type: "String",
|
1973
2453
|
# target_component_type_id: "ComponentTypeId",
|
2454
|
+
# relationship_type: "String",
|
1974
2455
|
# },
|
1975
|
-
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
1976
|
-
# unit_of_measure: "String",
|
1977
2456
|
# },
|
2457
|
+
# is_required_in_entity: false,
|
2458
|
+
# is_external_id: false,
|
2459
|
+
# is_stored_externally: false,
|
2460
|
+
# is_time_series: false,
|
1978
2461
|
# default_value: {
|
1979
2462
|
# boolean_value: false,
|
1980
2463
|
# double_value: 1.0,
|
1981
|
-
# expression: "Expression",
|
1982
2464
|
# integer_value: 1,
|
2465
|
+
# long_value: 1,
|
2466
|
+
# string_value: "String",
|
1983
2467
|
# list_value: [
|
1984
2468
|
# {
|
1985
2469
|
# # recursive DataValue
|
1986
2470
|
# },
|
1987
2471
|
# ],
|
1988
|
-
# long_value: 1,
|
1989
2472
|
# map_value: {
|
1990
2473
|
# "String" => {
|
1991
2474
|
# # recursive DataValue
|
1992
2475
|
# },
|
1993
2476
|
# },
|
1994
2477
|
# relationship_value: {
|
1995
|
-
# target_component_name: "Name",
|
1996
2478
|
# target_entity_id: "EntityId",
|
2479
|
+
# target_component_name: "Name",
|
1997
2480
|
# },
|
1998
|
-
#
|
2481
|
+
# expression: "Expression",
|
1999
2482
|
# },
|
2000
|
-
#
|
2001
|
-
#
|
2002
|
-
#
|
2003
|
-
#
|
2483
|
+
# configuration: {
|
2484
|
+
# "Name" => "Value",
|
2485
|
+
# },
|
2486
|
+
# display_name: "PropertyDisplayName",
|
2004
2487
|
# },
|
2005
|
-
# update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
|
2006
2488
|
# value: {
|
2007
2489
|
# boolean_value: false,
|
2008
2490
|
# double_value: 1.0,
|
2009
|
-
# expression: "Expression",
|
2010
2491
|
# integer_value: 1,
|
2492
|
+
# long_value: 1,
|
2493
|
+
# string_value: "String",
|
2011
2494
|
# list_value: [
|
2012
2495
|
# {
|
2013
2496
|
# # recursive DataValue
|
2014
2497
|
# },
|
2015
2498
|
# ],
|
2016
|
-
# long_value: 1,
|
2017
2499
|
# map_value: {
|
2018
2500
|
# "String" => {
|
2019
2501
|
# # recursive DataValue
|
2020
2502
|
# },
|
2021
2503
|
# },
|
2022
2504
|
# relationship_value: {
|
2023
|
-
# target_component_name: "Name",
|
2024
2505
|
# target_entity_id: "EntityId",
|
2506
|
+
# target_component_name: "Name",
|
2025
2507
|
# },
|
2026
|
-
#
|
2508
|
+
# expression: "Expression",
|
2027
2509
|
# },
|
2510
|
+
# update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
|
2511
|
+
# },
|
2512
|
+
# },
|
2513
|
+
# property_group_updates: {
|
2514
|
+
# "Name" => {
|
2515
|
+
# group_type: "TABULAR", # accepts TABULAR
|
2516
|
+
# property_names: ["Name"],
|
2517
|
+
# update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
|
2028
2518
|
# },
|
2029
2519
|
# },
|
2030
|
-
# update_type: "CREATE", # accepts CREATE, UPDATE, DELETE
|
2031
2520
|
# },
|
2032
2521
|
# },
|
2033
|
-
# description: "Description",
|
2034
|
-
# entity_id: "EntityId", # required
|
2035
|
-
# entity_name: "EntityName",
|
2036
2522
|
# parent_entity_update: {
|
2037
|
-
# parent_entity_id: "ParentEntityId",
|
2038
2523
|
# update_type: "UPDATE", # required, accepts UPDATE, DELETE
|
2524
|
+
# parent_entity_id: "ParentEntityId",
|
2039
2525
|
# },
|
2040
|
-
# workspace_id: "Id", # required
|
2041
2526
|
# })
|
2042
2527
|
#
|
2043
2528
|
# @example Response structure
|
2044
2529
|
#
|
2045
|
-
# resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
2046
2530
|
# resp.update_date_time #=> Time
|
2531
|
+
# resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
2047
2532
|
#
|
2048
2533
|
# @overload update_entity(params = {})
|
2049
2534
|
# @param [Hash] params ({})
|
@@ -2052,10 +2537,59 @@ module Aws::IoTTwinMaker
|
|
2052
2537
|
req.send_request(options)
|
2053
2538
|
end
|
2054
2539
|
|
2540
|
+
# Update the pricing plan.
|
2541
|
+
#
|
2542
|
+
# @option params [required, String] :pricing_mode
|
2543
|
+
# The pricing mode.
|
2544
|
+
#
|
2545
|
+
# @option params [Array<String>] :bundle_names
|
2546
|
+
# The bundle names.
|
2547
|
+
#
|
2548
|
+
# @return [Types::UpdatePricingPlanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2549
|
+
#
|
2550
|
+
# * {Types::UpdatePricingPlanResponse#current_pricing_plan #current_pricing_plan} => Types::PricingPlan
|
2551
|
+
# * {Types::UpdatePricingPlanResponse#pending_pricing_plan #pending_pricing_plan} => Types::PricingPlan
|
2552
|
+
#
|
2553
|
+
# @example Request syntax with placeholder values
|
2554
|
+
#
|
2555
|
+
# resp = client.update_pricing_plan({
|
2556
|
+
# pricing_mode: "BASIC", # required, accepts BASIC, STANDARD, TIERED_BUNDLE
|
2557
|
+
# bundle_names: ["BundleName"],
|
2558
|
+
# })
|
2559
|
+
#
|
2560
|
+
# @example Response structure
|
2561
|
+
#
|
2562
|
+
# resp.current_pricing_plan.billable_entity_count #=> Integer
|
2563
|
+
# resp.current_pricing_plan.bundle_information.bundle_names #=> Array
|
2564
|
+
# resp.current_pricing_plan.bundle_information.bundle_names[0] #=> String
|
2565
|
+
# resp.current_pricing_plan.bundle_information.pricing_tier #=> String, one of "TIER_1", "TIER_2", "TIER_3", "TIER_4"
|
2566
|
+
# resp.current_pricing_plan.effective_date_time #=> Time
|
2567
|
+
# resp.current_pricing_plan.pricing_mode #=> String, one of "BASIC", "STANDARD", "TIERED_BUNDLE"
|
2568
|
+
# resp.current_pricing_plan.update_date_time #=> Time
|
2569
|
+
# resp.current_pricing_plan.update_reason #=> String, one of "DEFAULT", "PRICING_TIER_UPDATE", "ENTITY_COUNT_UPDATE", "PRICING_MODE_UPDATE", "OVERWRITTEN"
|
2570
|
+
# resp.pending_pricing_plan.billable_entity_count #=> Integer
|
2571
|
+
# resp.pending_pricing_plan.bundle_information.bundle_names #=> Array
|
2572
|
+
# resp.pending_pricing_plan.bundle_information.bundle_names[0] #=> String
|
2573
|
+
# resp.pending_pricing_plan.bundle_information.pricing_tier #=> String, one of "TIER_1", "TIER_2", "TIER_3", "TIER_4"
|
2574
|
+
# resp.pending_pricing_plan.effective_date_time #=> Time
|
2575
|
+
# resp.pending_pricing_plan.pricing_mode #=> String, one of "BASIC", "STANDARD", "TIERED_BUNDLE"
|
2576
|
+
# resp.pending_pricing_plan.update_date_time #=> Time
|
2577
|
+
# resp.pending_pricing_plan.update_reason #=> String, one of "DEFAULT", "PRICING_TIER_UPDATE", "ENTITY_COUNT_UPDATE", "PRICING_MODE_UPDATE", "OVERWRITTEN"
|
2578
|
+
#
|
2579
|
+
# @overload update_pricing_plan(params = {})
|
2580
|
+
# @param [Hash] params ({})
|
2581
|
+
def update_pricing_plan(params = {}, options = {})
|
2582
|
+
req = build_request(:update_pricing_plan, params)
|
2583
|
+
req.send_request(options)
|
2584
|
+
end
|
2585
|
+
|
2055
2586
|
# Updates a scene.
|
2056
2587
|
#
|
2057
|
-
# @option params [
|
2058
|
-
#
|
2588
|
+
# @option params [required, String] :workspace_id
|
2589
|
+
# The ID of the workspace that contains the scene.
|
2590
|
+
#
|
2591
|
+
# @option params [required, String] :scene_id
|
2592
|
+
# The ID of the scene.
|
2059
2593
|
#
|
2060
2594
|
# @option params [String] :content_location
|
2061
2595
|
# The relative path that specifies the location of the content
|
@@ -2064,11 +2598,8 @@ module Aws::IoTTwinMaker
|
|
2064
2598
|
# @option params [String] :description
|
2065
2599
|
# The description of this scene.
|
2066
2600
|
#
|
2067
|
-
# @option params [
|
2068
|
-
#
|
2069
|
-
#
|
2070
|
-
# @option params [required, String] :workspace_id
|
2071
|
-
# The ID of the workspace that contains the scene.
|
2601
|
+
# @option params [Array<String>] :capabilities
|
2602
|
+
# A list of capabilities that the scene uses to render.
|
2072
2603
|
#
|
2073
2604
|
# @return [Types::UpdateSceneResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2074
2605
|
#
|
@@ -2077,11 +2608,11 @@ module Aws::IoTTwinMaker
|
|
2077
2608
|
# @example Request syntax with placeholder values
|
2078
2609
|
#
|
2079
2610
|
# resp = client.update_scene({
|
2080
|
-
#
|
2611
|
+
# workspace_id: "Id", # required
|
2612
|
+
# scene_id: "Id", # required
|
2081
2613
|
# content_location: "S3Url",
|
2082
2614
|
# description: "Description",
|
2083
|
-
#
|
2084
|
-
# workspace_id: "Id", # required
|
2615
|
+
# capabilities: ["SceneCapability"],
|
2085
2616
|
# })
|
2086
2617
|
#
|
2087
2618
|
# @example Response structure
|
@@ -2097,15 +2628,15 @@ module Aws::IoTTwinMaker
|
|
2097
2628
|
|
2098
2629
|
# Updates a workspace.
|
2099
2630
|
#
|
2631
|
+
# @option params [required, String] :workspace_id
|
2632
|
+
# The ID of the workspace.
|
2633
|
+
#
|
2100
2634
|
# @option params [String] :description
|
2101
2635
|
# The description of the workspace.
|
2102
2636
|
#
|
2103
2637
|
# @option params [String] :role
|
2104
2638
|
# The ARN of the execution role associated with the workspace.
|
2105
2639
|
#
|
2106
|
-
# @option params [required, String] :workspace_id
|
2107
|
-
# The ID of the workspace.
|
2108
|
-
#
|
2109
2640
|
# @return [Types::UpdateWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2110
2641
|
#
|
2111
2642
|
# * {Types::UpdateWorkspaceResponse#update_date_time #update_date_time} => Time
|
@@ -2113,9 +2644,9 @@ module Aws::IoTTwinMaker
|
|
2113
2644
|
# @example Request syntax with placeholder values
|
2114
2645
|
#
|
2115
2646
|
# resp = client.update_workspace({
|
2647
|
+
# workspace_id: "Id", # required
|
2116
2648
|
# description: "Description",
|
2117
2649
|
# role: "RoleArn",
|
2118
|
-
# workspace_id: "Id", # required
|
2119
2650
|
# })
|
2120
2651
|
#
|
2121
2652
|
# @example Response structure
|
@@ -2142,7 +2673,7 @@ module Aws::IoTTwinMaker
|
|
2142
2673
|
params: params,
|
2143
2674
|
config: config)
|
2144
2675
|
context[:gem_name] = 'aws-sdk-iottwinmaker'
|
2145
|
-
context[:gem_version] = '1.
|
2676
|
+
context[:gem_version] = '1.8.0'
|
2146
2677
|
Seahorse::Client::Request.new(handlers, context)
|
2147
2678
|
end
|
2148
2679
|
|