aws-sdk-iottwinmaker 1.6.0 → 1.7.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iottwinmaker/client.rb +727 -466
- data/lib/aws-sdk-iottwinmaker/client_api.rb +337 -118
- data/lib/aws-sdk-iottwinmaker/endpoints.rb +42 -0
- data/lib/aws-sdk-iottwinmaker/errors.rb +20 -0
- data/lib/aws-sdk-iottwinmaker/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-iottwinmaker/types.rb +1518 -965
- 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,10 @@ 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
|
-
# The ID of the workspace that contains the component type.
|
494
|
+
# @option params [Hash<String,Types::PropertyGroupRequest>] :property_groups
|
493
495
|
#
|
494
496
|
# @return [Types::CreateComponentTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
495
497
|
#
|
@@ -500,92 +502,98 @@ module Aws::IoTTwinMaker
|
|
500
502
|
# @example Request syntax with placeholder values
|
501
503
|
#
|
502
504
|
# resp = client.create_component_type({
|
505
|
+
# workspace_id: "Id", # required
|
506
|
+
# is_singleton: false,
|
503
507
|
# component_type_id: "ComponentTypeId", # required
|
504
508
|
# 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
509
|
# property_definitions: {
|
520
510
|
# "Name" => {
|
521
|
-
# configuration: {
|
522
|
-
# "Name" => "Value",
|
523
|
-
# },
|
524
511
|
# data_type: {
|
512
|
+
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
513
|
+
# nested_type: {
|
514
|
+
# # recursive DataType
|
515
|
+
# },
|
525
516
|
# allowed_values: [
|
526
517
|
# {
|
527
518
|
# boolean_value: false,
|
528
519
|
# double_value: 1.0,
|
529
|
-
# expression: "Expression",
|
530
520
|
# integer_value: 1,
|
521
|
+
# long_value: 1,
|
522
|
+
# string_value: "String",
|
531
523
|
# list_value: {
|
532
524
|
# # recursive DataValueList
|
533
525
|
# },
|
534
|
-
# long_value: 1,
|
535
526
|
# map_value: {
|
536
527
|
# "String" => {
|
537
528
|
# # recursive DataValue
|
538
529
|
# },
|
539
530
|
# },
|
540
531
|
# relationship_value: {
|
541
|
-
# target_component_name: "Name",
|
542
532
|
# target_entity_id: "EntityId",
|
533
|
+
# target_component_name: "Name",
|
543
534
|
# },
|
544
|
-
#
|
535
|
+
# expression: "Expression",
|
545
536
|
# },
|
546
537
|
# ],
|
547
|
-
#
|
548
|
-
# # recursive DataType
|
549
|
-
# },
|
538
|
+
# unit_of_measure: "String",
|
550
539
|
# relationship: {
|
551
|
-
# relationship_type: "String",
|
552
540
|
# target_component_type_id: "ComponentTypeId",
|
541
|
+
# relationship_type: "String",
|
553
542
|
# },
|
554
|
-
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
555
|
-
# unit_of_measure: "String",
|
556
543
|
# },
|
544
|
+
# is_required_in_entity: false,
|
545
|
+
# is_external_id: false,
|
546
|
+
# is_stored_externally: false,
|
547
|
+
# is_time_series: false,
|
557
548
|
# default_value: {
|
558
549
|
# boolean_value: false,
|
559
550
|
# double_value: 1.0,
|
560
|
-
# expression: "Expression",
|
561
551
|
# integer_value: 1,
|
552
|
+
# long_value: 1,
|
553
|
+
# string_value: "String",
|
562
554
|
# list_value: [
|
563
555
|
# {
|
564
556
|
# # recursive DataValue
|
565
557
|
# },
|
566
558
|
# ],
|
567
|
-
# long_value: 1,
|
568
559
|
# map_value: {
|
569
560
|
# "String" => {
|
570
561
|
# # recursive DataValue
|
571
562
|
# },
|
572
563
|
# },
|
573
564
|
# relationship_value: {
|
574
|
-
# target_component_name: "Name",
|
575
565
|
# target_entity_id: "EntityId",
|
566
|
+
# target_component_name: "Name",
|
576
567
|
# },
|
577
|
-
#
|
568
|
+
# expression: "Expression",
|
569
|
+
# },
|
570
|
+
# configuration: {
|
571
|
+
# "Name" => "Value",
|
572
|
+
# },
|
573
|
+
# },
|
574
|
+
# },
|
575
|
+
# extends_from: ["ComponentTypeId"],
|
576
|
+
# functions: {
|
577
|
+
# "Name" => {
|
578
|
+
# required_properties: ["Name"],
|
579
|
+
# scope: "ENTITY", # accepts ENTITY, WORKSPACE
|
580
|
+
# implemented_by: {
|
581
|
+
# lambda: {
|
582
|
+
# arn: "LambdaArn", # required
|
583
|
+
# },
|
584
|
+
# is_native: false,
|
578
585
|
# },
|
579
|
-
# is_external_id: false,
|
580
|
-
# is_required_in_entity: false,
|
581
|
-
# is_stored_externally: false,
|
582
|
-
# is_time_series: false,
|
583
586
|
# },
|
584
587
|
# },
|
585
588
|
# tags: {
|
586
589
|
# "TagKey" => "TagValue",
|
587
590
|
# },
|
588
|
-
#
|
591
|
+
# property_groups: {
|
592
|
+
# "Name" => {
|
593
|
+
# group_type: "TABULAR", # accepts TABULAR
|
594
|
+
# property_names: ["Name"],
|
595
|
+
# },
|
596
|
+
# },
|
589
597
|
# })
|
590
598
|
#
|
591
599
|
# @example Response structure
|
@@ -603,12 +611,8 @@ module Aws::IoTTwinMaker
|
|
603
611
|
|
604
612
|
# Creates an entity.
|
605
613
|
#
|
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.
|
614
|
+
# @option params [required, String] :workspace_id
|
615
|
+
# The ID of the workspace that contains the entity.
|
612
616
|
#
|
613
617
|
# @option params [String] :entity_id
|
614
618
|
# The ID of the entity.
|
@@ -616,137 +620,148 @@ module Aws::IoTTwinMaker
|
|
616
620
|
# @option params [required, String] :entity_name
|
617
621
|
# The name of the entity.
|
618
622
|
#
|
623
|
+
# @option params [String] :description
|
624
|
+
# The description of the entity.
|
625
|
+
#
|
626
|
+
# @option params [Hash<String,Types::ComponentRequest>] :components
|
627
|
+
# An object that maps strings to the components in the entity. Each
|
628
|
+
# string in the mapping must be unique to this object.
|
629
|
+
#
|
619
630
|
# @option params [String] :parent_entity_id
|
620
631
|
# The ID of the entity's parent entity.
|
621
632
|
#
|
622
633
|
# @option params [Hash<String,String>] :tags
|
623
634
|
# Metadata that you can use to manage the entity.
|
624
635
|
#
|
625
|
-
# @option params [required, String] :workspace_id
|
626
|
-
# The ID of the workspace that contains the entity.
|
627
|
-
#
|
628
636
|
# @return [Types::CreateEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
629
637
|
#
|
638
|
+
# * {Types::CreateEntityResponse#entity_id #entity_id} => String
|
630
639
|
# * {Types::CreateEntityResponse#arn #arn} => String
|
631
640
|
# * {Types::CreateEntityResponse#creation_date_time #creation_date_time} => Time
|
632
|
-
# * {Types::CreateEntityResponse#entity_id #entity_id} => String
|
633
641
|
# * {Types::CreateEntityResponse#state #state} => String
|
634
642
|
#
|
635
643
|
# @example Request syntax with placeholder values
|
636
644
|
#
|
637
645
|
# resp = client.create_entity({
|
646
|
+
# workspace_id: "Id", # required
|
647
|
+
# entity_id: "EntityId",
|
648
|
+
# entity_name: "EntityName", # required
|
649
|
+
# description: "Description",
|
638
650
|
# components: {
|
639
651
|
# "Name" => {
|
640
|
-
# component_type_id: "ComponentTypeId",
|
641
652
|
# description: "Description",
|
653
|
+
# component_type_id: "ComponentTypeId",
|
642
654
|
# properties: {
|
643
655
|
# "Name" => {
|
644
656
|
# definition: {
|
645
|
-
# configuration: {
|
646
|
-
# "Name" => "Value",
|
647
|
-
# },
|
648
657
|
# data_type: {
|
658
|
+
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
659
|
+
# nested_type: {
|
660
|
+
# # recursive DataType
|
661
|
+
# },
|
649
662
|
# allowed_values: [
|
650
663
|
# {
|
651
664
|
# boolean_value: false,
|
652
665
|
# double_value: 1.0,
|
653
|
-
# expression: "Expression",
|
654
666
|
# integer_value: 1,
|
667
|
+
# long_value: 1,
|
668
|
+
# string_value: "String",
|
655
669
|
# list_value: {
|
656
670
|
# # recursive DataValueList
|
657
671
|
# },
|
658
|
-
# long_value: 1,
|
659
672
|
# map_value: {
|
660
673
|
# "String" => {
|
661
674
|
# # recursive DataValue
|
662
675
|
# },
|
663
676
|
# },
|
664
677
|
# relationship_value: {
|
665
|
-
# target_component_name: "Name",
|
666
678
|
# target_entity_id: "EntityId",
|
679
|
+
# target_component_name: "Name",
|
667
680
|
# },
|
668
|
-
#
|
681
|
+
# expression: "Expression",
|
669
682
|
# },
|
670
683
|
# ],
|
671
|
-
#
|
672
|
-
# # recursive DataType
|
673
|
-
# },
|
684
|
+
# unit_of_measure: "String",
|
674
685
|
# relationship: {
|
675
|
-
# relationship_type: "String",
|
676
686
|
# target_component_type_id: "ComponentTypeId",
|
687
|
+
# relationship_type: "String",
|
677
688
|
# },
|
678
|
-
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
679
|
-
# unit_of_measure: "String",
|
680
689
|
# },
|
690
|
+
# is_required_in_entity: false,
|
691
|
+
# is_external_id: false,
|
692
|
+
# is_stored_externally: false,
|
693
|
+
# is_time_series: false,
|
681
694
|
# default_value: {
|
682
695
|
# boolean_value: false,
|
683
696
|
# double_value: 1.0,
|
684
|
-
# expression: "Expression",
|
685
697
|
# integer_value: 1,
|
698
|
+
# long_value: 1,
|
699
|
+
# string_value: "String",
|
686
700
|
# list_value: [
|
687
701
|
# {
|
688
702
|
# # recursive DataValue
|
689
703
|
# },
|
690
704
|
# ],
|
691
|
-
# long_value: 1,
|
692
705
|
# map_value: {
|
693
706
|
# "String" => {
|
694
707
|
# # recursive DataValue
|
695
708
|
# },
|
696
709
|
# },
|
697
710
|
# relationship_value: {
|
698
|
-
# target_component_name: "Name",
|
699
711
|
# target_entity_id: "EntityId",
|
712
|
+
# target_component_name: "Name",
|
700
713
|
# },
|
701
|
-
#
|
714
|
+
# expression: "Expression",
|
715
|
+
# },
|
716
|
+
# configuration: {
|
717
|
+
# "Name" => "Value",
|
702
718
|
# },
|
703
|
-
# is_external_id: false,
|
704
|
-
# is_required_in_entity: false,
|
705
|
-
# is_stored_externally: false,
|
706
|
-
# is_time_series: false,
|
707
719
|
# },
|
708
|
-
# update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
|
709
720
|
# value: {
|
710
721
|
# boolean_value: false,
|
711
722
|
# double_value: 1.0,
|
712
|
-
# expression: "Expression",
|
713
723
|
# integer_value: 1,
|
724
|
+
# long_value: 1,
|
725
|
+
# string_value: "String",
|
714
726
|
# list_value: [
|
715
727
|
# {
|
716
728
|
# # recursive DataValue
|
717
729
|
# },
|
718
730
|
# ],
|
719
|
-
# long_value: 1,
|
720
731
|
# map_value: {
|
721
732
|
# "String" => {
|
722
733
|
# # recursive DataValue
|
723
734
|
# },
|
724
735
|
# },
|
725
736
|
# relationship_value: {
|
726
|
-
# target_component_name: "Name",
|
727
737
|
# target_entity_id: "EntityId",
|
738
|
+
# target_component_name: "Name",
|
728
739
|
# },
|
729
|
-
#
|
740
|
+
# expression: "Expression",
|
730
741
|
# },
|
742
|
+
# update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
|
743
|
+
# },
|
744
|
+
# },
|
745
|
+
# property_groups: {
|
746
|
+
# "Name" => {
|
747
|
+
# group_type: "TABULAR", # accepts TABULAR
|
748
|
+
# property_names: ["Name"],
|
749
|
+
# update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
|
731
750
|
# },
|
732
751
|
# },
|
733
752
|
# },
|
734
753
|
# },
|
735
|
-
# description: "Description",
|
736
|
-
# entity_id: "EntityId",
|
737
|
-
# entity_name: "EntityName", # required
|
738
754
|
# parent_entity_id: "ParentEntityId",
|
739
755
|
# tags: {
|
740
756
|
# "TagKey" => "TagValue",
|
741
757
|
# },
|
742
|
-
# workspace_id: "Id", # required
|
743
758
|
# })
|
744
759
|
#
|
745
760
|
# @example Response structure
|
746
761
|
#
|
762
|
+
# resp.entity_id #=> String
|
747
763
|
# resp.arn #=> String
|
748
764
|
# resp.creation_date_time #=> Time
|
749
|
-
# resp.entity_id #=> String
|
750
765
|
# resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
751
766
|
#
|
752
767
|
# @overload create_entity(params = {})
|
@@ -758,8 +773,11 @@ module Aws::IoTTwinMaker
|
|
758
773
|
|
759
774
|
# Creates a scene.
|
760
775
|
#
|
761
|
-
# @option params [
|
762
|
-
#
|
776
|
+
# @option params [required, String] :workspace_id
|
777
|
+
# The ID of the workspace that contains the scene.
|
778
|
+
#
|
779
|
+
# @option params [required, String] :scene_id
|
780
|
+
# The ID of the scene.
|
763
781
|
#
|
764
782
|
# @option params [required, String] :content_location
|
765
783
|
# The relative path that specifies the location of the content
|
@@ -768,15 +786,12 @@ module Aws::IoTTwinMaker
|
|
768
786
|
# @option params [String] :description
|
769
787
|
# The description for this scene.
|
770
788
|
#
|
771
|
-
# @option params [
|
772
|
-
#
|
789
|
+
# @option params [Array<String>] :capabilities
|
790
|
+
# A list of capabilities that the scene uses to render itself.
|
773
791
|
#
|
774
792
|
# @option params [Hash<String,String>] :tags
|
775
793
|
# Metadata that you can use to manage the scene.
|
776
794
|
#
|
777
|
-
# @option params [required, String] :workspace_id
|
778
|
-
# The ID of the workspace that contains the scene.
|
779
|
-
#
|
780
795
|
# @return [Types::CreateSceneResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
781
796
|
#
|
782
797
|
# * {Types::CreateSceneResponse#arn #arn} => String
|
@@ -785,14 +800,14 @@ module Aws::IoTTwinMaker
|
|
785
800
|
# @example Request syntax with placeholder values
|
786
801
|
#
|
787
802
|
# resp = client.create_scene({
|
788
|
-
#
|
803
|
+
# workspace_id: "Id", # required
|
804
|
+
# scene_id: "Id", # required
|
789
805
|
# content_location: "S3Url", # required
|
790
806
|
# description: "Description",
|
791
|
-
#
|
807
|
+
# capabilities: ["SceneCapability"],
|
792
808
|
# tags: {
|
793
809
|
# "TagKey" => "TagValue",
|
794
810
|
# },
|
795
|
-
# workspace_id: "Id", # required
|
796
811
|
# })
|
797
812
|
#
|
798
813
|
# @example Response structure
|
@@ -809,22 +824,22 @@ module Aws::IoTTwinMaker
|
|
809
824
|
|
810
825
|
# Creates a workplace.
|
811
826
|
#
|
827
|
+
# @option params [required, String] :workspace_id
|
828
|
+
# The ID of the workspace.
|
829
|
+
#
|
812
830
|
# @option params [String] :description
|
813
831
|
# The description of the workspace.
|
814
832
|
#
|
815
|
-
# @option params [required, String] :role
|
816
|
-
# The ARN of the execution role associated with the workspace.
|
817
|
-
#
|
818
833
|
# @option params [required, String] :s3_location
|
819
834
|
# The ARN of the S3 bucket where resources associated with the workspace
|
820
835
|
# are stored.
|
821
836
|
#
|
837
|
+
# @option params [required, String] :role
|
838
|
+
# The ARN of the execution role associated with the workspace.
|
839
|
+
#
|
822
840
|
# @option params [Hash<String,String>] :tags
|
823
841
|
# Metadata that you can use to manage the workspace
|
824
842
|
#
|
825
|
-
# @option params [required, String] :workspace_id
|
826
|
-
# The ID of the workspace.
|
827
|
-
#
|
828
843
|
# @return [Types::CreateWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
829
844
|
#
|
830
845
|
# * {Types::CreateWorkspaceResponse#arn #arn} => String
|
@@ -833,13 +848,13 @@ module Aws::IoTTwinMaker
|
|
833
848
|
# @example Request syntax with placeholder values
|
834
849
|
#
|
835
850
|
# resp = client.create_workspace({
|
851
|
+
# workspace_id: "Id", # required
|
836
852
|
# description: "Description",
|
837
|
-
# role: "RoleArn", # required
|
838
853
|
# s3_location: "S3Location", # required
|
854
|
+
# role: "RoleArn", # required
|
839
855
|
# tags: {
|
840
856
|
# "TagKey" => "TagValue",
|
841
857
|
# },
|
842
|
-
# workspace_id: "Id", # required
|
843
858
|
# })
|
844
859
|
#
|
845
860
|
# @example Response structure
|
@@ -856,12 +871,12 @@ module Aws::IoTTwinMaker
|
|
856
871
|
|
857
872
|
# Deletes a component type.
|
858
873
|
#
|
859
|
-
# @option params [required, String] :component_type_id
|
860
|
-
# The ID of the component type to delete.
|
861
|
-
#
|
862
874
|
# @option params [required, String] :workspace_id
|
863
875
|
# The ID of the workspace that contains the component type.
|
864
876
|
#
|
877
|
+
# @option params [required, String] :component_type_id
|
878
|
+
# The ID of the component type to delete.
|
879
|
+
#
|
865
880
|
# @return [Types::DeleteComponentTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
866
881
|
#
|
867
882
|
# * {Types::DeleteComponentTypeResponse#state #state} => String
|
@@ -869,8 +884,8 @@ module Aws::IoTTwinMaker
|
|
869
884
|
# @example Request syntax with placeholder values
|
870
885
|
#
|
871
886
|
# resp = client.delete_component_type({
|
872
|
-
# component_type_id: "ComponentTypeId", # required
|
873
887
|
# workspace_id: "Id", # required
|
888
|
+
# component_type_id: "ComponentTypeId", # required
|
874
889
|
# })
|
875
890
|
#
|
876
891
|
# @example Response structure
|
@@ -886,6 +901,9 @@ module Aws::IoTTwinMaker
|
|
886
901
|
|
887
902
|
# Deletes an entity.
|
888
903
|
#
|
904
|
+
# @option params [required, String] :workspace_id
|
905
|
+
# The ID of the workspace that contains the entity to delete.
|
906
|
+
#
|
889
907
|
# @option params [required, String] :entity_id
|
890
908
|
# The ID of the entity to delete.
|
891
909
|
#
|
@@ -893,9 +911,6 @@ module Aws::IoTTwinMaker
|
|
893
911
|
# A Boolean value that specifies whether the operation deletes child
|
894
912
|
# entities.
|
895
913
|
#
|
896
|
-
# @option params [required, String] :workspace_id
|
897
|
-
# The ID of the workspace that contains the entity to delete.
|
898
|
-
#
|
899
914
|
# @return [Types::DeleteEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
900
915
|
#
|
901
916
|
# * {Types::DeleteEntityResponse#state #state} => String
|
@@ -903,9 +918,9 @@ module Aws::IoTTwinMaker
|
|
903
918
|
# @example Request syntax with placeholder values
|
904
919
|
#
|
905
920
|
# resp = client.delete_entity({
|
921
|
+
# workspace_id: "Id", # required
|
906
922
|
# entity_id: "EntityId", # required
|
907
923
|
# is_recursive: false,
|
908
|
-
# workspace_id: "Id", # required
|
909
924
|
# })
|
910
925
|
#
|
911
926
|
# @example Response structure
|
@@ -921,19 +936,19 @@ module Aws::IoTTwinMaker
|
|
921
936
|
|
922
937
|
# Deletes a scene.
|
923
938
|
#
|
924
|
-
# @option params [required, String] :scene_id
|
925
|
-
# The ID of the scene to delete.
|
926
|
-
#
|
927
939
|
# @option params [required, String] :workspace_id
|
928
940
|
# The ID of the workspace.
|
929
941
|
#
|
942
|
+
# @option params [required, String] :scene_id
|
943
|
+
# The ID of the scene to delete.
|
944
|
+
#
|
930
945
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
931
946
|
#
|
932
947
|
# @example Request syntax with placeholder values
|
933
948
|
#
|
934
949
|
# resp = client.delete_scene({
|
935
|
-
# scene_id: "Id", # required
|
936
950
|
# workspace_id: "Id", # required
|
951
|
+
# scene_id: "Id", # required
|
937
952
|
# })
|
938
953
|
#
|
939
954
|
# @overload delete_scene(params = {})
|
@@ -963,99 +978,156 @@ module Aws::IoTTwinMaker
|
|
963
978
|
req.send_request(options)
|
964
979
|
end
|
965
980
|
|
966
|
-
#
|
981
|
+
# Run queries to access information from your knowledge graph of
|
982
|
+
# entities within individual workspaces.
|
967
983
|
#
|
968
|
-
# @option params [required, String] :
|
969
|
-
# The ID of the
|
984
|
+
# @option params [required, String] :workspace_id
|
985
|
+
# The ID of the workspace.
|
986
|
+
#
|
987
|
+
# @option params [required, String] :query_statement
|
988
|
+
# The query statement.
|
989
|
+
#
|
990
|
+
# @option params [Integer] :max_results
|
991
|
+
# The maximum number of results to return at one time. The default is
|
992
|
+
# 25.
|
993
|
+
#
|
994
|
+
# Valid Range: Minimum value of 1. Maximum value of 250.
|
995
|
+
#
|
996
|
+
# @option params [String] :next_token
|
997
|
+
# The string that specifies the next page of results.
|
998
|
+
#
|
999
|
+
# @return [Types::ExecuteQueryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1000
|
+
#
|
1001
|
+
# * {Types::ExecuteQueryResponse#column_descriptions #column_descriptions} => Array<Types::ColumnDescription>
|
1002
|
+
# * {Types::ExecuteQueryResponse#rows #rows} => Array<Types::Row>
|
1003
|
+
# * {Types::ExecuteQueryResponse#next_token #next_token} => String
|
1004
|
+
#
|
1005
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1006
|
+
#
|
1007
|
+
# @example Request syntax with placeholder values
|
1008
|
+
#
|
1009
|
+
# resp = client.execute_query({
|
1010
|
+
# workspace_id: "Id", # required
|
1011
|
+
# query_statement: "QueryStatement", # required
|
1012
|
+
# max_results: 1,
|
1013
|
+
# next_token: "NextToken",
|
1014
|
+
# })
|
1015
|
+
#
|
1016
|
+
# @example Response structure
|
1017
|
+
#
|
1018
|
+
# resp.column_descriptions #=> Array
|
1019
|
+
# resp.column_descriptions[0].name #=> String
|
1020
|
+
# resp.column_descriptions[0].type #=> String, one of "NODE", "EDGE", "VALUE"
|
1021
|
+
# resp.rows #=> Array
|
1022
|
+
# resp.rows[0].row_data #=> Array
|
1023
|
+
# resp.next_token #=> String
|
1024
|
+
#
|
1025
|
+
# @overload execute_query(params = {})
|
1026
|
+
# @param [Hash] params ({})
|
1027
|
+
def execute_query(params = {}, options = {})
|
1028
|
+
req = build_request(:execute_query, params)
|
1029
|
+
req.send_request(options)
|
1030
|
+
end
|
1031
|
+
|
1032
|
+
# Retrieves information about a component type.
|
970
1033
|
#
|
971
1034
|
# @option params [required, String] :workspace_id
|
972
1035
|
# The ID of the workspace that contains the component type.
|
973
1036
|
#
|
1037
|
+
# @option params [required, String] :component_type_id
|
1038
|
+
# The ID of the component type.
|
1039
|
+
#
|
974
1040
|
# @return [Types::GetComponentTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
975
1041
|
#
|
976
|
-
# * {Types::GetComponentTypeResponse#
|
1042
|
+
# * {Types::GetComponentTypeResponse#workspace_id #workspace_id} => String
|
1043
|
+
# * {Types::GetComponentTypeResponse#is_singleton #is_singleton} => Boolean
|
977
1044
|
# * {Types::GetComponentTypeResponse#component_type_id #component_type_id} => String
|
978
|
-
# * {Types::GetComponentTypeResponse#creation_date_time #creation_date_time} => Time
|
979
1045
|
# * {Types::GetComponentTypeResponse#description #description} => String
|
1046
|
+
# * {Types::GetComponentTypeResponse#property_definitions #property_definitions} => Hash<String,Types::PropertyDefinitionResponse>
|
980
1047
|
# * {Types::GetComponentTypeResponse#extends_from #extends_from} => Array<String>
|
981
1048
|
# * {Types::GetComponentTypeResponse#functions #functions} => Hash<String,Types::FunctionResponse>
|
1049
|
+
# * {Types::GetComponentTypeResponse#creation_date_time #creation_date_time} => Time
|
1050
|
+
# * {Types::GetComponentTypeResponse#update_date_time #update_date_time} => Time
|
1051
|
+
# * {Types::GetComponentTypeResponse#arn #arn} => String
|
982
1052
|
# * {Types::GetComponentTypeResponse#is_abstract #is_abstract} => Boolean
|
983
1053
|
# * {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
1054
|
# * {Types::GetComponentTypeResponse#status #status} => Types::Status
|
987
|
-
# * {Types::GetComponentTypeResponse#
|
988
|
-
# * {Types::GetComponentTypeResponse#workspace_id #workspace_id} => String
|
1055
|
+
# * {Types::GetComponentTypeResponse#property_groups #property_groups} => Hash<String,Types::PropertyGroupResponse>
|
989
1056
|
#
|
990
1057
|
# @example Request syntax with placeholder values
|
991
1058
|
#
|
992
1059
|
# resp = client.get_component_type({
|
993
|
-
# component_type_id: "ComponentTypeId", # required
|
994
1060
|
# workspace_id: "Id", # required
|
1061
|
+
# component_type_id: "ComponentTypeId", # required
|
995
1062
|
# })
|
996
1063
|
#
|
997
1064
|
# @example Response structure
|
998
1065
|
#
|
999
|
-
# resp.
|
1066
|
+
# resp.workspace_id #=> String
|
1067
|
+
# resp.is_singleton #=> Boolean
|
1000
1068
|
# resp.component_type_id #=> String
|
1001
|
-
# resp.creation_date_time #=> Time
|
1002
1069
|
# 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
1070
|
# resp.property_definitions #=> Hash
|
1016
|
-
# resp.property_definitions["Name"].
|
1017
|
-
# resp.property_definitions["Name"].
|
1071
|
+
# resp.property_definitions["Name"].data_type.type #=> String, one of "RELATIONSHIP", "STRING", "LONG", "BOOLEAN", "INTEGER", "DOUBLE", "LIST", "MAP"
|
1072
|
+
# resp.property_definitions["Name"].data_type.nested_type #=> Types::DataType
|
1018
1073
|
# resp.property_definitions["Name"].data_type.allowed_values #=> Array
|
1019
1074
|
# resp.property_definitions["Name"].data_type.allowed_values[0].boolean_value #=> Boolean
|
1020
1075
|
# 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
1076
|
# 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
1077
|
# resp.property_definitions["Name"].data_type.allowed_values[0].long_value #=> Integer
|
1078
|
+
# resp.property_definitions["Name"].data_type.allowed_values[0].string_value #=> String
|
1079
|
+
# resp.property_definitions["Name"].data_type.allowed_values[0].list_value #=> Types::DataValueList
|
1025
1080
|
# resp.property_definitions["Name"].data_type.allowed_values[0].map_value #=> Hash
|
1026
1081
|
# 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
1082
|
# 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"
|
1083
|
+
# resp.property_definitions["Name"].data_type.allowed_values[0].relationship_value.target_component_name #=> String
|
1084
|
+
# resp.property_definitions["Name"].data_type.allowed_values[0].expression #=> String
|
1034
1085
|
# resp.property_definitions["Name"].data_type.unit_of_measure #=> String
|
1086
|
+
# resp.property_definitions["Name"].data_type.relationship.target_component_type_id #=> String
|
1087
|
+
# resp.property_definitions["Name"].data_type.relationship.relationship_type #=> String
|
1088
|
+
# resp.property_definitions["Name"].is_time_series #=> Boolean
|
1089
|
+
# resp.property_definitions["Name"].is_required_in_entity #=> Boolean
|
1090
|
+
# resp.property_definitions["Name"].is_external_id #=> Boolean
|
1091
|
+
# resp.property_definitions["Name"].is_stored_externally #=> Boolean
|
1092
|
+
# resp.property_definitions["Name"].is_imported #=> Boolean
|
1093
|
+
# resp.property_definitions["Name"].is_final #=> Boolean
|
1094
|
+
# resp.property_definitions["Name"].is_inherited #=> Boolean
|
1035
1095
|
# resp.property_definitions["Name"].default_value.boolean_value #=> Boolean
|
1036
1096
|
# resp.property_definitions["Name"].default_value.double_value #=> Float
|
1037
|
-
# resp.property_definitions["Name"].default_value.expression #=> String
|
1038
1097
|
# resp.property_definitions["Name"].default_value.integer_value #=> Integer
|
1098
|
+
# resp.property_definitions["Name"].default_value.long_value #=> Integer
|
1099
|
+
# resp.property_definitions["Name"].default_value.string_value #=> String
|
1039
1100
|
# resp.property_definitions["Name"].default_value.list_value #=> Array
|
1040
1101
|
# resp.property_definitions["Name"].default_value.list_value[0] #=> Types::DataValue
|
1041
|
-
# resp.property_definitions["Name"].default_value.long_value #=> Integer
|
1042
1102
|
# resp.property_definitions["Name"].default_value.map_value #=> Hash
|
1043
1103
|
# 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
1104
|
# 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.
|
1051
|
-
# resp.
|
1052
|
-
# resp.
|
1053
|
-
# resp.
|
1105
|
+
# resp.property_definitions["Name"].default_value.relationship_value.target_component_name #=> String
|
1106
|
+
# resp.property_definitions["Name"].default_value.expression #=> String
|
1107
|
+
# resp.property_definitions["Name"].configuration #=> Hash
|
1108
|
+
# resp.property_definitions["Name"].configuration["Name"] #=> String
|
1109
|
+
# resp.extends_from #=> Array
|
1110
|
+
# resp.extends_from[0] #=> String
|
1111
|
+
# resp.functions #=> Hash
|
1112
|
+
# resp.functions["Name"].required_properties #=> Array
|
1113
|
+
# resp.functions["Name"].required_properties[0] #=> String
|
1114
|
+
# resp.functions["Name"].scope #=> String, one of "ENTITY", "WORKSPACE"
|
1115
|
+
# resp.functions["Name"].implemented_by.lambda.arn #=> String
|
1116
|
+
# resp.functions["Name"].implemented_by.is_native #=> Boolean
|
1117
|
+
# resp.functions["Name"].is_inherited #=> Boolean
|
1118
|
+
# resp.creation_date_time #=> Time
|
1119
|
+
# resp.update_date_time #=> Time
|
1120
|
+
# resp.arn #=> String
|
1121
|
+
# resp.is_abstract #=> Boolean
|
1122
|
+
# resp.is_schema_initialized #=> Boolean
|
1123
|
+
# resp.status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1054
1124
|
# resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
1055
1125
|
# resp.status.error.message #=> String
|
1056
|
-
# resp.
|
1057
|
-
# resp.
|
1058
|
-
# resp.
|
1126
|
+
# resp.property_groups #=> Hash
|
1127
|
+
# resp.property_groups["Name"].group_type #=> String, one of "TABULAR"
|
1128
|
+
# resp.property_groups["Name"].property_names #=> Array
|
1129
|
+
# resp.property_groups["Name"].property_names[0] #=> String
|
1130
|
+
# resp.property_groups["Name"].is_inherited #=> Boolean
|
1059
1131
|
#
|
1060
1132
|
# @overload get_component_type(params = {})
|
1061
1133
|
# @param [Hash] params ({})
|
@@ -1066,106 +1138,111 @@ module Aws::IoTTwinMaker
|
|
1066
1138
|
|
1067
1139
|
# Retrieves information about an entity.
|
1068
1140
|
#
|
1069
|
-
# @option params [required, String] :entity_id
|
1070
|
-
# The ID of the entity.
|
1071
|
-
#
|
1072
1141
|
# @option params [required, String] :workspace_id
|
1073
1142
|
# The ID of the workspace.
|
1074
1143
|
#
|
1144
|
+
# @option params [required, String] :entity_id
|
1145
|
+
# The ID of the entity.
|
1146
|
+
#
|
1075
1147
|
# @return [Types::GetEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1076
1148
|
#
|
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
1149
|
# * {Types::GetEntityResponse#entity_id #entity_id} => String
|
1082
1150
|
# * {Types::GetEntityResponse#entity_name #entity_name} => String
|
1083
|
-
# * {Types::GetEntityResponse#
|
1084
|
-
# * {Types::GetEntityResponse#parent_entity_id #parent_entity_id} => String
|
1151
|
+
# * {Types::GetEntityResponse#arn #arn} => String
|
1085
1152
|
# * {Types::GetEntityResponse#status #status} => Types::Status
|
1086
|
-
# * {Types::GetEntityResponse#update_date_time #update_date_time} => Time
|
1087
1153
|
# * {Types::GetEntityResponse#workspace_id #workspace_id} => String
|
1154
|
+
# * {Types::GetEntityResponse#description #description} => String
|
1155
|
+
# * {Types::GetEntityResponse#components #components} => Hash<String,Types::ComponentResponse>
|
1156
|
+
# * {Types::GetEntityResponse#parent_entity_id #parent_entity_id} => String
|
1157
|
+
# * {Types::GetEntityResponse#has_child_entities #has_child_entities} => Boolean
|
1158
|
+
# * {Types::GetEntityResponse#creation_date_time #creation_date_time} => Time
|
1159
|
+
# * {Types::GetEntityResponse#update_date_time #update_date_time} => Time
|
1088
1160
|
#
|
1089
1161
|
# @example Request syntax with placeholder values
|
1090
1162
|
#
|
1091
1163
|
# resp = client.get_entity({
|
1092
|
-
# entity_id: "EntityId", # required
|
1093
1164
|
# workspace_id: "Id", # required
|
1165
|
+
# entity_id: "EntityId", # required
|
1094
1166
|
# })
|
1095
1167
|
#
|
1096
1168
|
# @example Response structure
|
1097
1169
|
#
|
1170
|
+
# resp.entity_id #=> String
|
1171
|
+
# resp.entity_name #=> String
|
1098
1172
|
# resp.arn #=> String
|
1173
|
+
# resp.status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1174
|
+
# resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
1175
|
+
# resp.status.error.message #=> String
|
1176
|
+
# resp.workspace_id #=> String
|
1177
|
+
# resp.description #=> String
|
1099
1178
|
# resp.components #=> Hash
|
1100
1179
|
# resp.components["Name"].component_name #=> String
|
1180
|
+
# resp.components["Name"].description #=> String
|
1101
1181
|
# resp.components["Name"].component_type_id #=> String
|
1182
|
+
# resp.components["Name"].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1183
|
+
# resp.components["Name"].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
1184
|
+
# resp.components["Name"].status.error.message #=> String
|
1102
1185
|
# resp.components["Name"].defined_in #=> String
|
1103
|
-
# resp.components["Name"].description #=> String
|
1104
1186
|
# resp.components["Name"].properties #=> Hash
|
1105
|
-
# resp.components["Name"].properties["Name"].definition.
|
1106
|
-
# resp.components["Name"].properties["Name"].definition.
|
1187
|
+
# resp.components["Name"].properties["Name"].definition.data_type.type #=> String, one of "RELATIONSHIP", "STRING", "LONG", "BOOLEAN", "INTEGER", "DOUBLE", "LIST", "MAP"
|
1188
|
+
# resp.components["Name"].properties["Name"].definition.data_type.nested_type #=> Types::DataType
|
1107
1189
|
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values #=> Array
|
1108
1190
|
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].boolean_value #=> Boolean
|
1109
1191
|
# 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
1192
|
# 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
1193
|
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].long_value #=> Integer
|
1194
|
+
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].string_value #=> String
|
1195
|
+
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].list_value #=> Types::DataValueList
|
1114
1196
|
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].map_value #=> Hash
|
1115
1197
|
# 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
1198
|
# 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"
|
1199
|
+
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].relationship_value.target_component_name #=> String
|
1200
|
+
# resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].expression #=> String
|
1123
1201
|
# resp.components["Name"].properties["Name"].definition.data_type.unit_of_measure #=> String
|
1202
|
+
# resp.components["Name"].properties["Name"].definition.data_type.relationship.target_component_type_id #=> String
|
1203
|
+
# resp.components["Name"].properties["Name"].definition.data_type.relationship.relationship_type #=> String
|
1204
|
+
# resp.components["Name"].properties["Name"].definition.is_time_series #=> Boolean
|
1205
|
+
# resp.components["Name"].properties["Name"].definition.is_required_in_entity #=> Boolean
|
1206
|
+
# resp.components["Name"].properties["Name"].definition.is_external_id #=> Boolean
|
1207
|
+
# resp.components["Name"].properties["Name"].definition.is_stored_externally #=> Boolean
|
1208
|
+
# resp.components["Name"].properties["Name"].definition.is_imported #=> Boolean
|
1209
|
+
# resp.components["Name"].properties["Name"].definition.is_final #=> Boolean
|
1210
|
+
# resp.components["Name"].properties["Name"].definition.is_inherited #=> Boolean
|
1124
1211
|
# resp.components["Name"].properties["Name"].definition.default_value.boolean_value #=> Boolean
|
1125
1212
|
# resp.components["Name"].properties["Name"].definition.default_value.double_value #=> Float
|
1126
|
-
# resp.components["Name"].properties["Name"].definition.default_value.expression #=> String
|
1127
1213
|
# resp.components["Name"].properties["Name"].definition.default_value.integer_value #=> Integer
|
1214
|
+
# resp.components["Name"].properties["Name"].definition.default_value.long_value #=> Integer
|
1215
|
+
# resp.components["Name"].properties["Name"].definition.default_value.string_value #=> String
|
1128
1216
|
# resp.components["Name"].properties["Name"].definition.default_value.list_value #=> Array
|
1129
1217
|
# 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
1218
|
# resp.components["Name"].properties["Name"].definition.default_value.map_value #=> Hash
|
1132
1219
|
# 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
1220
|
# 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.is_inherited #=> Boolean
|
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
|
1221
|
+
# resp.components["Name"].properties["Name"].definition.default_value.relationship_value.target_component_name #=> String
|
1222
|
+
# resp.components["Name"].properties["Name"].definition.default_value.expression #=> String
|
1223
|
+
# resp.components["Name"].properties["Name"].definition.configuration #=> Hash
|
1224
|
+
# resp.components["Name"].properties["Name"].definition.configuration["Name"] #=> String
|
1143
1225
|
# resp.components["Name"].properties["Name"].value.boolean_value #=> Boolean
|
1144
1226
|
# resp.components["Name"].properties["Name"].value.double_value #=> Float
|
1145
|
-
# resp.components["Name"].properties["Name"].value.expression #=> String
|
1146
1227
|
# resp.components["Name"].properties["Name"].value.integer_value #=> Integer
|
1228
|
+
# resp.components["Name"].properties["Name"].value.long_value #=> Integer
|
1229
|
+
# resp.components["Name"].properties["Name"].value.string_value #=> String
|
1147
1230
|
# resp.components["Name"].properties["Name"].value.list_value #=> Array
|
1148
1231
|
# resp.components["Name"].properties["Name"].value.list_value[0] #=> Types::DataValue
|
1149
|
-
# resp.components["Name"].properties["Name"].value.long_value #=> Integer
|
1150
1232
|
# resp.components["Name"].properties["Name"].value.map_value #=> Hash
|
1151
1233
|
# 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
1234
|
# 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.entity_name #=> String
|
1162
|
-
# resp.has_child_entities #=> Boolean
|
1235
|
+
# resp.components["Name"].properties["Name"].value.relationship_value.target_component_name #=> String
|
1236
|
+
# resp.components["Name"].properties["Name"].value.expression #=> String
|
1237
|
+
# resp.components["Name"].property_groups #=> Hash
|
1238
|
+
# resp.components["Name"].property_groups["Name"].group_type #=> String, one of "TABULAR"
|
1239
|
+
# resp.components["Name"].property_groups["Name"].property_names #=> Array
|
1240
|
+
# resp.components["Name"].property_groups["Name"].property_names[0] #=> String
|
1241
|
+
# resp.components["Name"].property_groups["Name"].is_inherited #=> Boolean
|
1163
1242
|
# resp.parent_entity_id #=> String
|
1164
|
-
# resp.
|
1165
|
-
# resp.
|
1166
|
-
# resp.status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1243
|
+
# resp.has_child_entities #=> Boolean
|
1244
|
+
# resp.creation_date_time #=> Time
|
1167
1245
|
# resp.update_date_time #=> Time
|
1168
|
-
# resp.workspace_id #=> String
|
1169
1246
|
#
|
1170
1247
|
# @overload get_entity(params = {})
|
1171
1248
|
# @param [Hash] params ({})
|
@@ -1174,6 +1251,39 @@ module Aws::IoTTwinMaker
|
|
1174
1251
|
req.send_request(options)
|
1175
1252
|
end
|
1176
1253
|
|
1254
|
+
# Gets the pricing plan.
|
1255
|
+
#
|
1256
|
+
# @return [Types::GetPricingPlanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1257
|
+
#
|
1258
|
+
# * {Types::GetPricingPlanResponse#current_pricing_plan #current_pricing_plan} => Types::PricingPlan
|
1259
|
+
# * {Types::GetPricingPlanResponse#pending_pricing_plan #pending_pricing_plan} => Types::PricingPlan
|
1260
|
+
#
|
1261
|
+
# @example Response structure
|
1262
|
+
#
|
1263
|
+
# resp.current_pricing_plan.billable_entity_count #=> Integer
|
1264
|
+
# resp.current_pricing_plan.bundle_information.bundle_names #=> Array
|
1265
|
+
# resp.current_pricing_plan.bundle_information.bundle_names[0] #=> String
|
1266
|
+
# resp.current_pricing_plan.bundle_information.pricing_tier #=> String, one of "TIER_1", "TIER_2", "TIER_3", "TIER_4"
|
1267
|
+
# resp.current_pricing_plan.effective_date_time #=> Time
|
1268
|
+
# resp.current_pricing_plan.pricing_mode #=> String, one of "BASIC", "STANDARD", "TIERED_BUNDLE"
|
1269
|
+
# resp.current_pricing_plan.update_date_time #=> Time
|
1270
|
+
# resp.current_pricing_plan.update_reason #=> String, one of "DEFAULT", "PRICING_TIER_UPDATE", "ENTITY_COUNT_UPDATE", "PRICING_MODE_UPDATE", "OVERWRITTEN"
|
1271
|
+
# resp.pending_pricing_plan.billable_entity_count #=> Integer
|
1272
|
+
# resp.pending_pricing_plan.bundle_information.bundle_names #=> Array
|
1273
|
+
# resp.pending_pricing_plan.bundle_information.bundle_names[0] #=> String
|
1274
|
+
# resp.pending_pricing_plan.bundle_information.pricing_tier #=> String, one of "TIER_1", "TIER_2", "TIER_3", "TIER_4"
|
1275
|
+
# resp.pending_pricing_plan.effective_date_time #=> Time
|
1276
|
+
# resp.pending_pricing_plan.pricing_mode #=> String, one of "BASIC", "STANDARD", "TIERED_BUNDLE"
|
1277
|
+
# resp.pending_pricing_plan.update_date_time #=> Time
|
1278
|
+
# resp.pending_pricing_plan.update_reason #=> String, one of "DEFAULT", "PRICING_TIER_UPDATE", "ENTITY_COUNT_UPDATE", "PRICING_MODE_UPDATE", "OVERWRITTEN"
|
1279
|
+
#
|
1280
|
+
# @overload get_pricing_plan(params = {})
|
1281
|
+
# @param [Hash] params ({})
|
1282
|
+
def get_pricing_plan(params = {}, options = {})
|
1283
|
+
req = build_request(:get_pricing_plan, params)
|
1284
|
+
req.send_request(options)
|
1285
|
+
end
|
1286
|
+
|
1177
1287
|
# Gets the property values for a component, component type, entity, or
|
1178
1288
|
# workspace.
|
1179
1289
|
#
|
@@ -1196,9 +1306,28 @@ module Aws::IoTTwinMaker
|
|
1196
1306
|
# @option params [required, String] :workspace_id
|
1197
1307
|
# The ID of the workspace whose values the operation returns.
|
1198
1308
|
#
|
1309
|
+
# @option params [Integer] :max_results
|
1310
|
+
# The maximum number of results to return at one time. The default is
|
1311
|
+
# 25.
|
1312
|
+
#
|
1313
|
+
# Valid Range: Minimum value of 1. Maximum value of 250.
|
1314
|
+
#
|
1315
|
+
# @option params [String] :next_token
|
1316
|
+
# The string that specifies the next page of results.
|
1317
|
+
#
|
1318
|
+
# @option params [String] :property_group_name
|
1319
|
+
# The property group name.
|
1320
|
+
#
|
1321
|
+
# @option params [Types::TabularConditions] :tabular_conditions
|
1322
|
+
# The tabular conditions.
|
1323
|
+
#
|
1199
1324
|
# @return [Types::GetPropertyValueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1200
1325
|
#
|
1201
1326
|
# * {Types::GetPropertyValueResponse#property_values #property_values} => Hash<String,Types::PropertyLatestValue>
|
1327
|
+
# * {Types::GetPropertyValueResponse#next_token #next_token} => String
|
1328
|
+
# * {Types::GetPropertyValueResponse#tabular_property_values #tabular_property_values} => Array<Array<Hash<String,Types::DataValue>>>
|
1329
|
+
#
|
1330
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1202
1331
|
#
|
1203
1332
|
# @example Request syntax with placeholder values
|
1204
1333
|
#
|
@@ -1208,28 +1337,83 @@ module Aws::IoTTwinMaker
|
|
1208
1337
|
# entity_id: "EntityId",
|
1209
1338
|
# selected_properties: ["String"], # required
|
1210
1339
|
# workspace_id: "Id", # required
|
1340
|
+
# max_results: 1,
|
1341
|
+
# next_token: "NextToken",
|
1342
|
+
# property_group_name: "Name",
|
1343
|
+
# tabular_conditions: {
|
1344
|
+
# order_by: [
|
1345
|
+
# {
|
1346
|
+
# order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1347
|
+
# property_name: "String", # required
|
1348
|
+
# },
|
1349
|
+
# ],
|
1350
|
+
# property_filters: [
|
1351
|
+
# {
|
1352
|
+
# property_name: "String",
|
1353
|
+
# operator: "String",
|
1354
|
+
# value: {
|
1355
|
+
# boolean_value: false,
|
1356
|
+
# double_value: 1.0,
|
1357
|
+
# integer_value: 1,
|
1358
|
+
# long_value: 1,
|
1359
|
+
# string_value: "String",
|
1360
|
+
# list_value: [
|
1361
|
+
# {
|
1362
|
+
# # recursive DataValue
|
1363
|
+
# },
|
1364
|
+
# ],
|
1365
|
+
# map_value: {
|
1366
|
+
# "String" => {
|
1367
|
+
# # recursive DataValue
|
1368
|
+
# },
|
1369
|
+
# },
|
1370
|
+
# relationship_value: {
|
1371
|
+
# target_entity_id: "EntityId",
|
1372
|
+
# target_component_name: "Name",
|
1373
|
+
# },
|
1374
|
+
# expression: "Expression",
|
1375
|
+
# },
|
1376
|
+
# },
|
1377
|
+
# ],
|
1378
|
+
# },
|
1211
1379
|
# })
|
1212
1380
|
#
|
1213
1381
|
# @example Response structure
|
1214
1382
|
#
|
1215
1383
|
# resp.property_values #=> Hash
|
1216
1384
|
# resp.property_values["Name"].property_reference.component_name #=> String
|
1217
|
-
# resp.property_values["Name"].property_reference.entity_id #=> String
|
1218
1385
|
# resp.property_values["Name"].property_reference.external_id_property #=> Hash
|
1219
1386
|
# resp.property_values["Name"].property_reference.external_id_property["String"] #=> String
|
1387
|
+
# resp.property_values["Name"].property_reference.entity_id #=> String
|
1220
1388
|
# resp.property_values["Name"].property_reference.property_name #=> String
|
1221
1389
|
# resp.property_values["Name"].property_value.boolean_value #=> Boolean
|
1222
1390
|
# resp.property_values["Name"].property_value.double_value #=> Float
|
1223
|
-
# resp.property_values["Name"].property_value.expression #=> String
|
1224
1391
|
# resp.property_values["Name"].property_value.integer_value #=> Integer
|
1392
|
+
# resp.property_values["Name"].property_value.long_value #=> Integer
|
1393
|
+
# resp.property_values["Name"].property_value.string_value #=> String
|
1225
1394
|
# resp.property_values["Name"].property_value.list_value #=> Array
|
1226
1395
|
# resp.property_values["Name"].property_value.list_value[0] #=> Types::DataValue
|
1227
|
-
# resp.property_values["Name"].property_value.long_value #=> Integer
|
1228
1396
|
# resp.property_values["Name"].property_value.map_value #=> Hash
|
1229
1397
|
# 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
1398
|
# resp.property_values["Name"].property_value.relationship_value.target_entity_id #=> String
|
1232
|
-
# resp.property_values["Name"].property_value.
|
1399
|
+
# resp.property_values["Name"].property_value.relationship_value.target_component_name #=> String
|
1400
|
+
# resp.property_values["Name"].property_value.expression #=> String
|
1401
|
+
# resp.next_token #=> String
|
1402
|
+
# resp.tabular_property_values #=> Array
|
1403
|
+
# resp.tabular_property_values[0] #=> Array
|
1404
|
+
# resp.tabular_property_values[0][0] #=> Hash
|
1405
|
+
# resp.tabular_property_values[0][0]["Name"].boolean_value #=> Boolean
|
1406
|
+
# resp.tabular_property_values[0][0]["Name"].double_value #=> Float
|
1407
|
+
# resp.tabular_property_values[0][0]["Name"].integer_value #=> Integer
|
1408
|
+
# resp.tabular_property_values[0][0]["Name"].long_value #=> Integer
|
1409
|
+
# resp.tabular_property_values[0][0]["Name"].string_value #=> String
|
1410
|
+
# resp.tabular_property_values[0][0]["Name"].list_value #=> Array
|
1411
|
+
# resp.tabular_property_values[0][0]["Name"].list_value[0] #=> Types::DataValue
|
1412
|
+
# resp.tabular_property_values[0][0]["Name"].map_value #=> Hash
|
1413
|
+
# resp.tabular_property_values[0][0]["Name"].map_value["String"] #=> Types::DataValue
|
1414
|
+
# resp.tabular_property_values[0][0]["Name"].relationship_value.target_entity_id #=> String
|
1415
|
+
# resp.tabular_property_values[0][0]["Name"].relationship_value.target_component_name #=> String
|
1416
|
+
# resp.tabular_property_values[0][0]["Name"].expression #=> String
|
1233
1417
|
#
|
1234
1418
|
# @overload get_property_value(params = {})
|
1235
1419
|
# @param [Hash] params ({})
|
@@ -1245,49 +1429,45 @@ module Aws::IoTTwinMaker
|
|
1245
1429
|
# queries, specify values for `componentName` and `entityId`. For
|
1246
1430
|
# cross-entity quries, specify a value for `componentTypeId`.
|
1247
1431
|
#
|
1432
|
+
# @option params [required, String] :workspace_id
|
1433
|
+
# The ID of the workspace.
|
1434
|
+
#
|
1435
|
+
# @option params [String] :entity_id
|
1436
|
+
# The ID of the entity.
|
1437
|
+
#
|
1248
1438
|
# @option params [String] :component_name
|
1249
1439
|
# The name of the component.
|
1250
1440
|
#
|
1251
1441
|
# @option params [String] :component_type_id
|
1252
1442
|
# The ID of the component type.
|
1253
1443
|
#
|
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
|
-
#
|
1444
|
+
# @option params [required, Array<String>] :selected_properties
|
1445
|
+
# A list of properties whose value histories the request retrieves.
|
1263
1446
|
#
|
1447
|
+
# @option params [Array<Types::PropertyFilter>] :property_filters
|
1448
|
+
# A list of objects that filter the property value history request.
|
1264
1449
|
#
|
1265
|
-
#
|
1450
|
+
# @option params [Time,DateTime,Date,Integer,String] :start_date_time
|
1451
|
+
# The date and time of the earliest property value to return.
|
1266
1452
|
#
|
1267
|
-
# @option params [String] :
|
1268
|
-
# The
|
1453
|
+
# @option params [Time,DateTime,Date,Integer,String] :end_date_time
|
1454
|
+
# The date and time of the latest property value to return.
|
1269
1455
|
#
|
1270
1456
|
# @option params [Types::InterpolationParameters] :interpolation
|
1271
1457
|
# An object that specifies the interpolation type and the interval over
|
1272
1458
|
# which to interpolate data.
|
1273
1459
|
#
|
1274
|
-
# @option params [Integer] :max_results
|
1275
|
-
# The maximum number of results to return.
|
1276
|
-
#
|
1277
1460
|
# @option params [String] :next_token
|
1278
1461
|
# The string that specifies the next page of results.
|
1279
1462
|
#
|
1280
|
-
# @option params [
|
1281
|
-
# The
|
1282
|
-
#
|
1283
|
-
# @option params [Array<Types::PropertyFilter>] :property_filters
|
1284
|
-
# A list of objects that filter the property value history request.
|
1463
|
+
# @option params [Integer] :max_results
|
1464
|
+
# The maximum number of results to return at one time. The default is
|
1465
|
+
# 25.
|
1285
1466
|
#
|
1286
|
-
#
|
1287
|
-
# A list of properties whose value histories the request retrieves.
|
1467
|
+
# Valid Range: Minimum value of 1. Maximum value of 250.
|
1288
1468
|
#
|
1289
|
-
# @option params [
|
1290
|
-
# The
|
1469
|
+
# @option params [String] :order_by_time
|
1470
|
+
# The time direction to use in the result order.
|
1291
1471
|
#
|
1292
1472
|
# @option params [String] :start_time
|
1293
1473
|
# The ISO8601 DateTime of the earliest property value to return.
|
@@ -1297,91 +1477,98 @@ module Aws::IoTTwinMaker
|
|
1297
1477
|
#
|
1298
1478
|
#
|
1299
1479
|
#
|
1300
|
-
# [1]: https://docs.aws.amazon.com/
|
1480
|
+
# [1]: https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html
|
1301
1481
|
#
|
1302
|
-
# @option params [
|
1303
|
-
# The
|
1482
|
+
# @option params [String] :end_time
|
1483
|
+
# The ISO8601 DateTime of the latest property value to return.
|
1484
|
+
#
|
1485
|
+
# For more information about the ISO8601 DateTime format, see the data
|
1486
|
+
# type [PropertyValue][1].
|
1487
|
+
#
|
1488
|
+
#
|
1489
|
+
#
|
1490
|
+
# [1]: https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html
|
1304
1491
|
#
|
1305
1492
|
# @return [Types::GetPropertyValueHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1306
1493
|
#
|
1307
|
-
# * {Types::GetPropertyValueHistoryResponse#next_token #next_token} => String
|
1308
1494
|
# * {Types::GetPropertyValueHistoryResponse#property_values #property_values} => Array<Types::PropertyValueHistory>
|
1495
|
+
# * {Types::GetPropertyValueHistoryResponse#next_token #next_token} => String
|
1309
1496
|
#
|
1310
1497
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1311
1498
|
#
|
1312
1499
|
# @example Request syntax with placeholder values
|
1313
1500
|
#
|
1314
1501
|
# resp = client.get_property_value_history({
|
1502
|
+
# workspace_id: "Id", # required
|
1503
|
+
# entity_id: "EntityId",
|
1315
1504
|
# component_name: "Name",
|
1316
1505
|
# 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
|
1506
|
+
# selected_properties: ["String"], # required
|
1327
1507
|
# property_filters: [
|
1328
1508
|
# {
|
1329
|
-
# operator: "String",
|
1330
1509
|
# property_name: "String",
|
1510
|
+
# operator: "String",
|
1331
1511
|
# value: {
|
1332
1512
|
# boolean_value: false,
|
1333
1513
|
# double_value: 1.0,
|
1334
|
-
# expression: "Expression",
|
1335
1514
|
# integer_value: 1,
|
1515
|
+
# long_value: 1,
|
1516
|
+
# string_value: "String",
|
1336
1517
|
# list_value: [
|
1337
1518
|
# {
|
1338
1519
|
# # recursive DataValue
|
1339
1520
|
# },
|
1340
1521
|
# ],
|
1341
|
-
# long_value: 1,
|
1342
1522
|
# map_value: {
|
1343
1523
|
# "String" => {
|
1344
1524
|
# # recursive DataValue
|
1345
1525
|
# },
|
1346
1526
|
# },
|
1347
1527
|
# relationship_value: {
|
1348
|
-
# target_component_name: "Name",
|
1349
1528
|
# target_entity_id: "EntityId",
|
1529
|
+
# target_component_name: "Name",
|
1350
1530
|
# },
|
1351
|
-
#
|
1531
|
+
# expression: "Expression",
|
1352
1532
|
# },
|
1353
1533
|
# },
|
1354
1534
|
# ],
|
1355
|
-
# selected_properties: ["String"], # required
|
1356
1535
|
# start_date_time: Time.now,
|
1536
|
+
# end_date_time: Time.now,
|
1537
|
+
# interpolation: {
|
1538
|
+
# interpolation_type: "LINEAR", # accepts LINEAR
|
1539
|
+
# interval_in_seconds: 1,
|
1540
|
+
# },
|
1541
|
+
# next_token: "NextToken",
|
1542
|
+
# max_results: 1,
|
1543
|
+
# order_by_time: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1357
1544
|
# start_time: "Time",
|
1358
|
-
#
|
1545
|
+
# end_time: "Time",
|
1359
1546
|
# })
|
1360
1547
|
#
|
1361
1548
|
# @example Response structure
|
1362
1549
|
#
|
1363
|
-
# resp.next_token #=> String
|
1364
1550
|
# resp.property_values #=> Array
|
1365
1551
|
# resp.property_values[0].entity_property_reference.component_name #=> String
|
1366
|
-
# resp.property_values[0].entity_property_reference.entity_id #=> String
|
1367
1552
|
# resp.property_values[0].entity_property_reference.external_id_property #=> Hash
|
1368
1553
|
# resp.property_values[0].entity_property_reference.external_id_property["String"] #=> String
|
1554
|
+
# resp.property_values[0].entity_property_reference.entity_id #=> String
|
1369
1555
|
# resp.property_values[0].entity_property_reference.property_name #=> String
|
1370
1556
|
# resp.property_values[0].values #=> Array
|
1371
|
-
# resp.property_values[0].values[0].time #=> String
|
1372
1557
|
# resp.property_values[0].values[0].timestamp #=> Time
|
1373
1558
|
# resp.property_values[0].values[0].value.boolean_value #=> Boolean
|
1374
1559
|
# resp.property_values[0].values[0].value.double_value #=> Float
|
1375
|
-
# resp.property_values[0].values[0].value.expression #=> String
|
1376
1560
|
# resp.property_values[0].values[0].value.integer_value #=> Integer
|
1561
|
+
# resp.property_values[0].values[0].value.long_value #=> Integer
|
1562
|
+
# resp.property_values[0].values[0].value.string_value #=> String
|
1377
1563
|
# resp.property_values[0].values[0].value.list_value #=> Array
|
1378
1564
|
# resp.property_values[0].values[0].value.list_value[0] #=> Types::DataValue
|
1379
|
-
# resp.property_values[0].values[0].value.long_value #=> Integer
|
1380
1565
|
# resp.property_values[0].values[0].value.map_value #=> Hash
|
1381
1566
|
# 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
1567
|
# resp.property_values[0].values[0].value.relationship_value.target_entity_id #=> String
|
1384
|
-
# resp.property_values[0].values[0].value.
|
1568
|
+
# resp.property_values[0].values[0].value.relationship_value.target_component_name #=> String
|
1569
|
+
# resp.property_values[0].values[0].value.expression #=> String
|
1570
|
+
# resp.property_values[0].values[0].time #=> String
|
1571
|
+
# resp.next_token #=> String
|
1385
1572
|
#
|
1386
1573
|
# @overload get_property_value_history(params = {})
|
1387
1574
|
# @param [Hash] params ({})
|
@@ -1392,41 +1579,41 @@ module Aws::IoTTwinMaker
|
|
1392
1579
|
|
1393
1580
|
# Retrieves information about a scene.
|
1394
1581
|
#
|
1395
|
-
# @option params [required, String] :scene_id
|
1396
|
-
# The ID of the scene.
|
1397
|
-
#
|
1398
1582
|
# @option params [required, String] :workspace_id
|
1399
1583
|
# The ID of the workspace that contains the scene.
|
1400
1584
|
#
|
1585
|
+
# @option params [required, String] :scene_id
|
1586
|
+
# The ID of the scene.
|
1587
|
+
#
|
1401
1588
|
# @return [Types::GetSceneResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1402
1589
|
#
|
1403
|
-
# * {Types::GetSceneResponse#
|
1404
|
-
# * {Types::GetSceneResponse#
|
1590
|
+
# * {Types::GetSceneResponse#workspace_id #workspace_id} => String
|
1591
|
+
# * {Types::GetSceneResponse#scene_id #scene_id} => String
|
1405
1592
|
# * {Types::GetSceneResponse#content_location #content_location} => String
|
1593
|
+
# * {Types::GetSceneResponse#arn #arn} => String
|
1406
1594
|
# * {Types::GetSceneResponse#creation_date_time #creation_date_time} => Time
|
1407
|
-
# * {Types::GetSceneResponse#description #description} => String
|
1408
|
-
# * {Types::GetSceneResponse#scene_id #scene_id} => String
|
1409
1595
|
# * {Types::GetSceneResponse#update_date_time #update_date_time} => Time
|
1410
|
-
# * {Types::GetSceneResponse#
|
1596
|
+
# * {Types::GetSceneResponse#description #description} => String
|
1597
|
+
# * {Types::GetSceneResponse#capabilities #capabilities} => Array<String>
|
1411
1598
|
#
|
1412
1599
|
# @example Request syntax with placeholder values
|
1413
1600
|
#
|
1414
1601
|
# resp = client.get_scene({
|
1415
|
-
# scene_id: "Id", # required
|
1416
1602
|
# workspace_id: "Id", # required
|
1603
|
+
# scene_id: "Id", # required
|
1417
1604
|
# })
|
1418
1605
|
#
|
1419
1606
|
# @example Response structure
|
1420
1607
|
#
|
1421
|
-
# resp.
|
1422
|
-
# resp.
|
1423
|
-
# resp.capabilities[0] #=> String
|
1608
|
+
# resp.workspace_id #=> String
|
1609
|
+
# resp.scene_id #=> String
|
1424
1610
|
# resp.content_location #=> String
|
1611
|
+
# resp.arn #=> String
|
1425
1612
|
# resp.creation_date_time #=> Time
|
1426
|
-
# resp.description #=> String
|
1427
|
-
# resp.scene_id #=> String
|
1428
1613
|
# resp.update_date_time #=> Time
|
1429
|
-
# resp.
|
1614
|
+
# resp.description #=> String
|
1615
|
+
# resp.capabilities #=> Array
|
1616
|
+
# resp.capabilities[0] #=> String
|
1430
1617
|
#
|
1431
1618
|
# @overload get_scene(params = {})
|
1432
1619
|
# @param [Hash] params ({})
|
@@ -1442,13 +1629,13 @@ module Aws::IoTTwinMaker
|
|
1442
1629
|
#
|
1443
1630
|
# @return [Types::GetWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1444
1631
|
#
|
1632
|
+
# * {Types::GetWorkspaceResponse#workspace_id #workspace_id} => String
|
1445
1633
|
# * {Types::GetWorkspaceResponse#arn #arn} => String
|
1446
|
-
# * {Types::GetWorkspaceResponse#creation_date_time #creation_date_time} => Time
|
1447
1634
|
# * {Types::GetWorkspaceResponse#description #description} => String
|
1448
|
-
# * {Types::GetWorkspaceResponse#role #role} => String
|
1449
1635
|
# * {Types::GetWorkspaceResponse#s3_location #s3_location} => String
|
1636
|
+
# * {Types::GetWorkspaceResponse#role #role} => String
|
1637
|
+
# * {Types::GetWorkspaceResponse#creation_date_time #creation_date_time} => Time
|
1450
1638
|
# * {Types::GetWorkspaceResponse#update_date_time #update_date_time} => Time
|
1451
|
-
# * {Types::GetWorkspaceResponse#workspace_id #workspace_id} => String
|
1452
1639
|
#
|
1453
1640
|
# @example Request syntax with placeholder values
|
1454
1641
|
#
|
@@ -1458,13 +1645,13 @@ module Aws::IoTTwinMaker
|
|
1458
1645
|
#
|
1459
1646
|
# @example Response structure
|
1460
1647
|
#
|
1648
|
+
# resp.workspace_id #=> String
|
1461
1649
|
# resp.arn #=> String
|
1462
|
-
# resp.creation_date_time #=> Time
|
1463
1650
|
# resp.description #=> String
|
1464
|
-
# resp.role #=> String
|
1465
1651
|
# resp.s3_location #=> String
|
1652
|
+
# resp.role #=> String
|
1653
|
+
# resp.creation_date_time #=> Time
|
1466
1654
|
# resp.update_date_time #=> Time
|
1467
|
-
# resp.workspace_id #=> String
|
1468
1655
|
#
|
1469
1656
|
# @overload get_workspace(params = {})
|
1470
1657
|
# @param [Hash] params ({})
|
@@ -1475,56 +1662,59 @@ module Aws::IoTTwinMaker
|
|
1475
1662
|
|
1476
1663
|
# Lists all component types in a workspace.
|
1477
1664
|
#
|
1665
|
+
# @option params [required, String] :workspace_id
|
1666
|
+
# The ID of the workspace.
|
1667
|
+
#
|
1478
1668
|
# @option params [Array<Types::ListComponentTypesFilter>] :filters
|
1479
1669
|
# A list of objects that filter the request.
|
1480
1670
|
#
|
1481
|
-
# @option params [Integer] :max_results
|
1482
|
-
# The maximum number of results to display.
|
1483
|
-
#
|
1484
1671
|
# @option params [String] :next_token
|
1485
1672
|
# The string that specifies the next page of results.
|
1486
1673
|
#
|
1487
|
-
# @option params [
|
1488
|
-
# The
|
1674
|
+
# @option params [Integer] :max_results
|
1675
|
+
# The maximum number of results to return at one time. The default is
|
1676
|
+
# 25.
|
1677
|
+
#
|
1678
|
+
# Valid Range: Minimum value of 1. Maximum value of 250.
|
1489
1679
|
#
|
1490
1680
|
# @return [Types::ListComponentTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1491
1681
|
#
|
1682
|
+
# * {Types::ListComponentTypesResponse#workspace_id #workspace_id} => String
|
1492
1683
|
# * {Types::ListComponentTypesResponse#component_type_summaries #component_type_summaries} => Array<Types::ComponentTypeSummary>
|
1493
|
-
# * {Types::ListComponentTypesResponse#max_results #max_results} => Integer
|
1494
1684
|
# * {Types::ListComponentTypesResponse#next_token #next_token} => String
|
1495
|
-
# * {Types::ListComponentTypesResponse#
|
1685
|
+
# * {Types::ListComponentTypesResponse#max_results #max_results} => Integer
|
1496
1686
|
#
|
1497
1687
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1498
1688
|
#
|
1499
1689
|
# @example Request syntax with placeholder values
|
1500
1690
|
#
|
1501
1691
|
# resp = client.list_component_types({
|
1692
|
+
# workspace_id: "Id", # required
|
1502
1693
|
# filters: [
|
1503
1694
|
# {
|
1504
1695
|
# extends_from: "ComponentTypeId",
|
1505
|
-
# is_abstract: false,
|
1506
1696
|
# namespace: "String",
|
1697
|
+
# is_abstract: false,
|
1507
1698
|
# },
|
1508
1699
|
# ],
|
1509
|
-
# max_results: 1,
|
1510
1700
|
# next_token: "NextToken",
|
1511
|
-
#
|
1701
|
+
# max_results: 1,
|
1512
1702
|
# })
|
1513
1703
|
#
|
1514
1704
|
# @example Response structure
|
1515
1705
|
#
|
1706
|
+
# resp.workspace_id #=> String
|
1516
1707
|
# resp.component_type_summaries #=> Array
|
1517
1708
|
# resp.component_type_summaries[0].arn #=> String
|
1518
1709
|
# resp.component_type_summaries[0].component_type_id #=> String
|
1519
1710
|
# resp.component_type_summaries[0].creation_date_time #=> Time
|
1711
|
+
# resp.component_type_summaries[0].update_date_time #=> Time
|
1520
1712
|
# resp.component_type_summaries[0].description #=> String
|
1713
|
+
# resp.component_type_summaries[0].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1521
1714
|
# resp.component_type_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
1522
1715
|
# resp.component_type_summaries[0].status.error.message #=> String
|
1523
|
-
# resp.component_type_summaries[0].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1524
|
-
# resp.component_type_summaries[0].update_date_time #=> Time
|
1525
|
-
# resp.max_results #=> Integer
|
1526
1716
|
# resp.next_token #=> String
|
1527
|
-
# resp.
|
1717
|
+
# resp.max_results #=> Integer
|
1528
1718
|
#
|
1529
1719
|
# @overload list_component_types(params = {})
|
1530
1720
|
# @param [Hash] params ({})
|
@@ -1535,6 +1725,9 @@ module Aws::IoTTwinMaker
|
|
1535
1725
|
|
1536
1726
|
# Lists all entities in a workspace.
|
1537
1727
|
#
|
1728
|
+
# @option params [required, String] :workspace_id
|
1729
|
+
# The ID of the workspace.
|
1730
|
+
#
|
1538
1731
|
# @option params [Array<Types::ListEntitiesFilter>] :filters
|
1539
1732
|
# A list of objects that filter the request.
|
1540
1733
|
#
|
@@ -1543,14 +1736,14 @@ module Aws::IoTTwinMaker
|
|
1543
1736
|
# </note>
|
1544
1737
|
#
|
1545
1738
|
# @option params [Integer] :max_results
|
1546
|
-
# The maximum number of results to
|
1739
|
+
# The maximum number of results to return at one time. The default is
|
1740
|
+
# 25.
|
1741
|
+
#
|
1742
|
+
# Valid Range: Minimum value of 1. Maximum value of 250.
|
1547
1743
|
#
|
1548
1744
|
# @option params [String] :next_token
|
1549
1745
|
# The string that specifies the next page of results.
|
1550
1746
|
#
|
1551
|
-
# @option params [required, String] :workspace_id
|
1552
|
-
# The ID of the workspace.
|
1553
|
-
#
|
1554
1747
|
# @return [Types::ListEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1555
1748
|
#
|
1556
1749
|
# * {Types::ListEntitiesResponse#entity_summaries #entity_summaries} => Array<Types::EntitySummary>
|
@@ -1561,31 +1754,31 @@ module Aws::IoTTwinMaker
|
|
1561
1754
|
# @example Request syntax with placeholder values
|
1562
1755
|
#
|
1563
1756
|
# resp = client.list_entities({
|
1757
|
+
# workspace_id: "Id", # required
|
1564
1758
|
# filters: [
|
1565
1759
|
# {
|
1760
|
+
# parent_entity_id: "ParentEntityId",
|
1566
1761
|
# component_type_id: "ComponentTypeId",
|
1567
1762
|
# external_id: "String",
|
1568
|
-
# parent_entity_id: "ParentEntityId",
|
1569
1763
|
# },
|
1570
1764
|
# ],
|
1571
1765
|
# max_results: 1,
|
1572
1766
|
# next_token: "NextToken",
|
1573
|
-
# workspace_id: "Id", # required
|
1574
1767
|
# })
|
1575
1768
|
#
|
1576
1769
|
# @example Response structure
|
1577
1770
|
#
|
1578
1771
|
# 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
1772
|
# resp.entity_summaries[0].entity_id #=> String
|
1583
1773
|
# resp.entity_summaries[0].entity_name #=> String
|
1584
|
-
# resp.entity_summaries[0].
|
1774
|
+
# resp.entity_summaries[0].arn #=> String
|
1585
1775
|
# resp.entity_summaries[0].parent_entity_id #=> String
|
1776
|
+
# resp.entity_summaries[0].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1586
1777
|
# resp.entity_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
1587
1778
|
# resp.entity_summaries[0].status.error.message #=> String
|
1588
|
-
# resp.entity_summaries[0].
|
1779
|
+
# resp.entity_summaries[0].description #=> String
|
1780
|
+
# resp.entity_summaries[0].has_child_entities #=> Boolean
|
1781
|
+
# resp.entity_summaries[0].creation_date_time #=> Time
|
1589
1782
|
# resp.entity_summaries[0].update_date_time #=> Time
|
1590
1783
|
# resp.next_token #=> String
|
1591
1784
|
#
|
@@ -1598,40 +1791,40 @@ module Aws::IoTTwinMaker
|
|
1598
1791
|
|
1599
1792
|
# Lists all scenes in a workspace.
|
1600
1793
|
#
|
1794
|
+
# @option params [required, String] :workspace_id
|
1795
|
+
# The ID of the workspace that contains the scenes.
|
1796
|
+
#
|
1601
1797
|
# @option params [Integer] :max_results
|
1602
1798
|
# Specifies the maximum number of results to display.
|
1603
1799
|
#
|
1604
1800
|
# @option params [String] :next_token
|
1605
1801
|
# The string that specifies the next page of results.
|
1606
1802
|
#
|
1607
|
-
# @option params [required, String] :workspace_id
|
1608
|
-
# The ID of the workspace that contains the scenes.
|
1609
|
-
#
|
1610
1803
|
# @return [Types::ListScenesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1611
1804
|
#
|
1612
|
-
# * {Types::ListScenesResponse#next_token #next_token} => String
|
1613
1805
|
# * {Types::ListScenesResponse#scene_summaries #scene_summaries} => Array<Types::SceneSummary>
|
1806
|
+
# * {Types::ListScenesResponse#next_token #next_token} => String
|
1614
1807
|
#
|
1615
1808
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1616
1809
|
#
|
1617
1810
|
# @example Request syntax with placeholder values
|
1618
1811
|
#
|
1619
1812
|
# resp = client.list_scenes({
|
1813
|
+
# workspace_id: "Id", # required
|
1620
1814
|
# max_results: 1,
|
1621
1815
|
# next_token: "NextToken",
|
1622
|
-
# workspace_id: "Id", # required
|
1623
1816
|
# })
|
1624
1817
|
#
|
1625
1818
|
# @example Response structure
|
1626
1819
|
#
|
1627
|
-
# resp.next_token #=> String
|
1628
1820
|
# resp.scene_summaries #=> Array
|
1629
|
-
# resp.scene_summaries[0].
|
1821
|
+
# resp.scene_summaries[0].scene_id #=> String
|
1630
1822
|
# resp.scene_summaries[0].content_location #=> String
|
1823
|
+
# resp.scene_summaries[0].arn #=> String
|
1631
1824
|
# resp.scene_summaries[0].creation_date_time #=> Time
|
1632
|
-
# resp.scene_summaries[0].description #=> String
|
1633
|
-
# resp.scene_summaries[0].scene_id #=> String
|
1634
1825
|
# resp.scene_summaries[0].update_date_time #=> Time
|
1826
|
+
# resp.scene_summaries[0].description #=> String
|
1827
|
+
# resp.next_token #=> String
|
1635
1828
|
#
|
1636
1829
|
# @overload list_scenes(params = {})
|
1637
1830
|
# @param [Hash] params ({})
|
@@ -1642,33 +1835,36 @@ module Aws::IoTTwinMaker
|
|
1642
1835
|
|
1643
1836
|
# Lists all tags associated with a resource.
|
1644
1837
|
#
|
1838
|
+
# @option params [required, String] :resource_arn
|
1839
|
+
# The ARN of the resource.
|
1840
|
+
#
|
1645
1841
|
# @option params [Integer] :max_results
|
1646
|
-
# The maximum number of results to
|
1842
|
+
# The maximum number of results to return at one time. The default is
|
1843
|
+
# 25.
|
1844
|
+
#
|
1845
|
+
# Valid Range: Minimum value of 1. Maximum value of 250.
|
1647
1846
|
#
|
1648
1847
|
# @option params [String] :next_token
|
1649
1848
|
# The string that specifies the next page of results.
|
1650
1849
|
#
|
1651
|
-
# @option params [required, String] :resource_arn
|
1652
|
-
# The ARN of the resource.
|
1653
|
-
#
|
1654
1850
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1655
1851
|
#
|
1656
|
-
# * {Types::ListTagsForResourceResponse#next_token #next_token} => String
|
1657
1852
|
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
1853
|
+
# * {Types::ListTagsForResourceResponse#next_token #next_token} => String
|
1658
1854
|
#
|
1659
1855
|
# @example Request syntax with placeholder values
|
1660
1856
|
#
|
1661
1857
|
# resp = client.list_tags_for_resource({
|
1858
|
+
# resource_arn: "TwinMakerArn", # required
|
1662
1859
|
# max_results: 1,
|
1663
1860
|
# next_token: "NextToken",
|
1664
|
-
# resource_arn: "TwinMakerArn", # required
|
1665
1861
|
# })
|
1666
1862
|
#
|
1667
1863
|
# @example Response structure
|
1668
1864
|
#
|
1669
|
-
# resp.next_token #=> String
|
1670
1865
|
# resp.tags #=> Hash
|
1671
1866
|
# resp.tags["TagKey"] #=> String
|
1867
|
+
# resp.next_token #=> String
|
1672
1868
|
#
|
1673
1869
|
# @overload list_tags_for_resource(params = {})
|
1674
1870
|
# @param [Hash] params ({})
|
@@ -1680,15 +1876,18 @@ module Aws::IoTTwinMaker
|
|
1680
1876
|
# Retrieves information about workspaces in the current account.
|
1681
1877
|
#
|
1682
1878
|
# @option params [Integer] :max_results
|
1683
|
-
# The maximum number of results to
|
1879
|
+
# The maximum number of results to return at one time. The default is
|
1880
|
+
# 25.
|
1881
|
+
#
|
1882
|
+
# Valid Range: Minimum value of 1. Maximum value of 250.
|
1684
1883
|
#
|
1685
1884
|
# @option params [String] :next_token
|
1686
1885
|
# The string that specifies the next page of results.
|
1687
1886
|
#
|
1688
1887
|
# @return [Types::ListWorkspacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1689
1888
|
#
|
1690
|
-
# * {Types::ListWorkspacesResponse#next_token #next_token} => String
|
1691
1889
|
# * {Types::ListWorkspacesResponse#workspace_summaries #workspace_summaries} => Array<Types::WorkspaceSummary>
|
1890
|
+
# * {Types::ListWorkspacesResponse#next_token #next_token} => String
|
1692
1891
|
#
|
1693
1892
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1694
1893
|
#
|
@@ -1701,13 +1900,13 @@ module Aws::IoTTwinMaker
|
|
1701
1900
|
#
|
1702
1901
|
# @example Response structure
|
1703
1902
|
#
|
1704
|
-
# resp.next_token #=> String
|
1705
1903
|
# resp.workspace_summaries #=> Array
|
1904
|
+
# resp.workspace_summaries[0].workspace_id #=> String
|
1706
1905
|
# resp.workspace_summaries[0].arn #=> String
|
1707
|
-
# resp.workspace_summaries[0].creation_date_time #=> Time
|
1708
1906
|
# resp.workspace_summaries[0].description #=> String
|
1907
|
+
# resp.workspace_summaries[0].creation_date_time #=> Time
|
1709
1908
|
# resp.workspace_summaries[0].update_date_time #=> Time
|
1710
|
-
# resp.
|
1909
|
+
# resp.next_token #=> String
|
1711
1910
|
#
|
1712
1911
|
# @overload list_workspaces(params = {})
|
1713
1912
|
# @param [Hash] params ({})
|
@@ -1769,12 +1968,24 @@ module Aws::IoTTwinMaker
|
|
1769
1968
|
|
1770
1969
|
# Updates information in a component type.
|
1771
1970
|
#
|
1971
|
+
# @option params [required, String] :workspace_id
|
1972
|
+
# The ID of the workspace that contains the component type.
|
1973
|
+
#
|
1974
|
+
# @option params [Boolean] :is_singleton
|
1975
|
+
# A Boolean value that specifies whether an entity can have more than
|
1976
|
+
# one component of this type.
|
1977
|
+
#
|
1772
1978
|
# @option params [required, String] :component_type_id
|
1773
1979
|
# The ID of the component type.
|
1774
1980
|
#
|
1775
1981
|
# @option params [String] :description
|
1776
1982
|
# The description of the component type.
|
1777
1983
|
#
|
1984
|
+
# @option params [Hash<String,Types::PropertyDefinitionRequest>] :property_definitions
|
1985
|
+
# An object that maps strings to the property definitions in the
|
1986
|
+
# component type. Each string in the mapping must be unique to this
|
1987
|
+
# object.
|
1988
|
+
#
|
1778
1989
|
# @option params [Array<String>] :extends_from
|
1779
1990
|
# Specifies the component type that this component type extends.
|
1780
1991
|
#
|
@@ -1782,119 +1993,116 @@ module Aws::IoTTwinMaker
|
|
1782
1993
|
# An object that maps strings to the functions in the component type.
|
1783
1994
|
# Each string in the mapping must be unique to this object.
|
1784
1995
|
#
|
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.
|
1793
|
-
#
|
1794
|
-
# @option params [required, String] :workspace_id
|
1795
|
-
# The ID of the workspace that contains the component type.
|
1996
|
+
# @option params [Hash<String,Types::PropertyGroupRequest>] :property_groups
|
1997
|
+
# The property groups
|
1796
1998
|
#
|
1797
1999
|
# @return [Types::UpdateComponentTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1798
2000
|
#
|
2001
|
+
# * {Types::UpdateComponentTypeResponse#workspace_id #workspace_id} => String
|
1799
2002
|
# * {Types::UpdateComponentTypeResponse#arn #arn} => String
|
1800
2003
|
# * {Types::UpdateComponentTypeResponse#component_type_id #component_type_id} => String
|
1801
2004
|
# * {Types::UpdateComponentTypeResponse#state #state} => String
|
1802
|
-
# * {Types::UpdateComponentTypeResponse#workspace_id #workspace_id} => String
|
1803
2005
|
#
|
1804
2006
|
# @example Request syntax with placeholder values
|
1805
2007
|
#
|
1806
2008
|
# resp = client.update_component_type({
|
2009
|
+
# workspace_id: "Id", # required
|
2010
|
+
# is_singleton: false,
|
1807
2011
|
# component_type_id: "ComponentTypeId", # required
|
1808
2012
|
# 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
2013
|
# property_definitions: {
|
1824
2014
|
# "Name" => {
|
1825
|
-
# configuration: {
|
1826
|
-
# "Name" => "Value",
|
1827
|
-
# },
|
1828
2015
|
# data_type: {
|
2016
|
+
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
2017
|
+
# nested_type: {
|
2018
|
+
# # recursive DataType
|
2019
|
+
# },
|
1829
2020
|
# allowed_values: [
|
1830
2021
|
# {
|
1831
2022
|
# boolean_value: false,
|
1832
2023
|
# double_value: 1.0,
|
1833
|
-
# expression: "Expression",
|
1834
2024
|
# integer_value: 1,
|
2025
|
+
# long_value: 1,
|
2026
|
+
# string_value: "String",
|
1835
2027
|
# list_value: {
|
1836
2028
|
# # recursive DataValueList
|
1837
2029
|
# },
|
1838
|
-
# long_value: 1,
|
1839
2030
|
# map_value: {
|
1840
2031
|
# "String" => {
|
1841
2032
|
# # recursive DataValue
|
1842
2033
|
# },
|
1843
2034
|
# },
|
1844
2035
|
# relationship_value: {
|
1845
|
-
# target_component_name: "Name",
|
1846
2036
|
# target_entity_id: "EntityId",
|
2037
|
+
# target_component_name: "Name",
|
1847
2038
|
# },
|
1848
|
-
#
|
2039
|
+
# expression: "Expression",
|
1849
2040
|
# },
|
1850
2041
|
# ],
|
1851
|
-
#
|
1852
|
-
# # recursive DataType
|
1853
|
-
# },
|
2042
|
+
# unit_of_measure: "String",
|
1854
2043
|
# relationship: {
|
1855
|
-
# relationship_type: "String",
|
1856
2044
|
# target_component_type_id: "ComponentTypeId",
|
2045
|
+
# relationship_type: "String",
|
1857
2046
|
# },
|
1858
|
-
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
1859
|
-
# unit_of_measure: "String",
|
1860
2047
|
# },
|
2048
|
+
# is_required_in_entity: false,
|
2049
|
+
# is_external_id: false,
|
2050
|
+
# is_stored_externally: false,
|
2051
|
+
# is_time_series: false,
|
1861
2052
|
# default_value: {
|
1862
2053
|
# boolean_value: false,
|
1863
2054
|
# double_value: 1.0,
|
1864
|
-
# expression: "Expression",
|
1865
2055
|
# integer_value: 1,
|
2056
|
+
# long_value: 1,
|
2057
|
+
# string_value: "String",
|
1866
2058
|
# list_value: [
|
1867
2059
|
# {
|
1868
2060
|
# # recursive DataValue
|
1869
2061
|
# },
|
1870
2062
|
# ],
|
1871
|
-
# long_value: 1,
|
1872
2063
|
# map_value: {
|
1873
2064
|
# "String" => {
|
1874
2065
|
# # recursive DataValue
|
1875
2066
|
# },
|
1876
2067
|
# },
|
1877
2068
|
# relationship_value: {
|
1878
|
-
# target_component_name: "Name",
|
1879
2069
|
# target_entity_id: "EntityId",
|
2070
|
+
# target_component_name: "Name",
|
1880
2071
|
# },
|
1881
|
-
#
|
2072
|
+
# expression: "Expression",
|
2073
|
+
# },
|
2074
|
+
# configuration: {
|
2075
|
+
# "Name" => "Value",
|
1882
2076
|
# },
|
1883
|
-
# is_external_id: false,
|
1884
|
-
# is_required_in_entity: false,
|
1885
|
-
# is_stored_externally: false,
|
1886
|
-
# is_time_series: false,
|
1887
2077
|
# },
|
1888
2078
|
# },
|
1889
|
-
#
|
2079
|
+
# extends_from: ["ComponentTypeId"],
|
2080
|
+
# functions: {
|
2081
|
+
# "Name" => {
|
2082
|
+
# required_properties: ["Name"],
|
2083
|
+
# scope: "ENTITY", # accepts ENTITY, WORKSPACE
|
2084
|
+
# implemented_by: {
|
2085
|
+
# lambda: {
|
2086
|
+
# arn: "LambdaArn", # required
|
2087
|
+
# },
|
2088
|
+
# is_native: false,
|
2089
|
+
# },
|
2090
|
+
# },
|
2091
|
+
# },
|
2092
|
+
# property_groups: {
|
2093
|
+
# "Name" => {
|
2094
|
+
# group_type: "TABULAR", # accepts TABULAR
|
2095
|
+
# property_names: ["Name"],
|
2096
|
+
# },
|
2097
|
+
# },
|
1890
2098
|
# })
|
1891
2099
|
#
|
1892
2100
|
# @example Response structure
|
1893
2101
|
#
|
2102
|
+
# resp.workspace_id #=> String
|
1894
2103
|
# resp.arn #=> String
|
1895
2104
|
# resp.component_type_id #=> String
|
1896
2105
|
# resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
1897
|
-
# resp.workspace_id #=> String
|
1898
2106
|
#
|
1899
2107
|
# @overload update_component_type(params = {})
|
1900
2108
|
# @param [Hash] params ({})
|
@@ -1905,12 +2113,8 @@ module Aws::IoTTwinMaker
|
|
1905
2113
|
|
1906
2114
|
# Updates an entity.
|
1907
2115
|
#
|
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.
|
2116
|
+
# @option params [required, String] :workspace_id
|
2117
|
+
# The ID of the workspace that contains the entity.
|
1914
2118
|
#
|
1915
2119
|
# @option params [required, String] :entity_id
|
1916
2120
|
# The ID of the entity.
|
@@ -1918,132 +2122,143 @@ module Aws::IoTTwinMaker
|
|
1918
2122
|
# @option params [String] :entity_name
|
1919
2123
|
# The name of the entity.
|
1920
2124
|
#
|
2125
|
+
# @option params [String] :description
|
2126
|
+
# The description of the entity.
|
2127
|
+
#
|
2128
|
+
# @option params [Hash<String,Types::ComponentUpdateRequest>] :component_updates
|
2129
|
+
# An object that maps strings to the component updates in the request.
|
2130
|
+
# Each string in the mapping must be unique to this object.
|
2131
|
+
#
|
1921
2132
|
# @option params [Types::ParentEntityUpdateRequest] :parent_entity_update
|
1922
2133
|
# An object that describes the update request for a parent entity.
|
1923
2134
|
#
|
1924
|
-
# @option params [required, String] :workspace_id
|
1925
|
-
# The ID of the workspace that contains the entity.
|
1926
|
-
#
|
1927
2135
|
# @return [Types::UpdateEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1928
2136
|
#
|
1929
|
-
# * {Types::UpdateEntityResponse#state #state} => String
|
1930
2137
|
# * {Types::UpdateEntityResponse#update_date_time #update_date_time} => Time
|
2138
|
+
# * {Types::UpdateEntityResponse#state #state} => String
|
1931
2139
|
#
|
1932
2140
|
# @example Request syntax with placeholder values
|
1933
2141
|
#
|
1934
2142
|
# resp = client.update_entity({
|
2143
|
+
# workspace_id: "Id", # required
|
2144
|
+
# entity_id: "EntityId", # required
|
2145
|
+
# entity_name: "EntityName",
|
2146
|
+
# description: "Description",
|
1935
2147
|
# component_updates: {
|
1936
2148
|
# "Name" => {
|
1937
|
-
#
|
2149
|
+
# update_type: "CREATE", # accepts CREATE, UPDATE, DELETE
|
1938
2150
|
# description: "Description",
|
2151
|
+
# component_type_id: "ComponentTypeId",
|
1939
2152
|
# property_updates: {
|
1940
2153
|
# "Name" => {
|
1941
2154
|
# definition: {
|
1942
|
-
# configuration: {
|
1943
|
-
# "Name" => "Value",
|
1944
|
-
# },
|
1945
2155
|
# data_type: {
|
2156
|
+
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
2157
|
+
# nested_type: {
|
2158
|
+
# # recursive DataType
|
2159
|
+
# },
|
1946
2160
|
# allowed_values: [
|
1947
2161
|
# {
|
1948
2162
|
# boolean_value: false,
|
1949
2163
|
# double_value: 1.0,
|
1950
|
-
# expression: "Expression",
|
1951
2164
|
# integer_value: 1,
|
2165
|
+
# long_value: 1,
|
2166
|
+
# string_value: "String",
|
1952
2167
|
# list_value: {
|
1953
2168
|
# # recursive DataValueList
|
1954
2169
|
# },
|
1955
|
-
# long_value: 1,
|
1956
2170
|
# map_value: {
|
1957
2171
|
# "String" => {
|
1958
2172
|
# # recursive DataValue
|
1959
2173
|
# },
|
1960
2174
|
# },
|
1961
2175
|
# relationship_value: {
|
1962
|
-
# target_component_name: "Name",
|
1963
2176
|
# target_entity_id: "EntityId",
|
2177
|
+
# target_component_name: "Name",
|
1964
2178
|
# },
|
1965
|
-
#
|
2179
|
+
# expression: "Expression",
|
1966
2180
|
# },
|
1967
2181
|
# ],
|
1968
|
-
#
|
1969
|
-
# # recursive DataType
|
1970
|
-
# },
|
2182
|
+
# unit_of_measure: "String",
|
1971
2183
|
# relationship: {
|
1972
|
-
# relationship_type: "String",
|
1973
2184
|
# target_component_type_id: "ComponentTypeId",
|
2185
|
+
# relationship_type: "String",
|
1974
2186
|
# },
|
1975
|
-
# type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
|
1976
|
-
# unit_of_measure: "String",
|
1977
2187
|
# },
|
2188
|
+
# is_required_in_entity: false,
|
2189
|
+
# is_external_id: false,
|
2190
|
+
# is_stored_externally: false,
|
2191
|
+
# is_time_series: false,
|
1978
2192
|
# default_value: {
|
1979
2193
|
# boolean_value: false,
|
1980
2194
|
# double_value: 1.0,
|
1981
|
-
# expression: "Expression",
|
1982
2195
|
# integer_value: 1,
|
2196
|
+
# long_value: 1,
|
2197
|
+
# string_value: "String",
|
1983
2198
|
# list_value: [
|
1984
2199
|
# {
|
1985
2200
|
# # recursive DataValue
|
1986
2201
|
# },
|
1987
2202
|
# ],
|
1988
|
-
# long_value: 1,
|
1989
2203
|
# map_value: {
|
1990
2204
|
# "String" => {
|
1991
2205
|
# # recursive DataValue
|
1992
2206
|
# },
|
1993
2207
|
# },
|
1994
2208
|
# relationship_value: {
|
1995
|
-
# target_component_name: "Name",
|
1996
2209
|
# target_entity_id: "EntityId",
|
2210
|
+
# target_component_name: "Name",
|
1997
2211
|
# },
|
1998
|
-
#
|
2212
|
+
# expression: "Expression",
|
2213
|
+
# },
|
2214
|
+
# configuration: {
|
2215
|
+
# "Name" => "Value",
|
1999
2216
|
# },
|
2000
|
-
# is_external_id: false,
|
2001
|
-
# is_required_in_entity: false,
|
2002
|
-
# is_stored_externally: false,
|
2003
|
-
# is_time_series: false,
|
2004
2217
|
# },
|
2005
|
-
# update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
|
2006
2218
|
# value: {
|
2007
2219
|
# boolean_value: false,
|
2008
2220
|
# double_value: 1.0,
|
2009
|
-
# expression: "Expression",
|
2010
2221
|
# integer_value: 1,
|
2222
|
+
# long_value: 1,
|
2223
|
+
# string_value: "String",
|
2011
2224
|
# list_value: [
|
2012
2225
|
# {
|
2013
2226
|
# # recursive DataValue
|
2014
2227
|
# },
|
2015
2228
|
# ],
|
2016
|
-
# long_value: 1,
|
2017
2229
|
# map_value: {
|
2018
2230
|
# "String" => {
|
2019
2231
|
# # recursive DataValue
|
2020
2232
|
# },
|
2021
2233
|
# },
|
2022
2234
|
# relationship_value: {
|
2023
|
-
# target_component_name: "Name",
|
2024
2235
|
# target_entity_id: "EntityId",
|
2236
|
+
# target_component_name: "Name",
|
2025
2237
|
# },
|
2026
|
-
#
|
2238
|
+
# expression: "Expression",
|
2027
2239
|
# },
|
2240
|
+
# update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
|
2241
|
+
# },
|
2242
|
+
# },
|
2243
|
+
# property_group_updates: {
|
2244
|
+
# "Name" => {
|
2245
|
+
# group_type: "TABULAR", # accepts TABULAR
|
2246
|
+
# property_names: ["Name"],
|
2247
|
+
# update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
|
2028
2248
|
# },
|
2029
2249
|
# },
|
2030
|
-
# update_type: "CREATE", # accepts CREATE, UPDATE, DELETE
|
2031
2250
|
# },
|
2032
2251
|
# },
|
2033
|
-
# description: "Description",
|
2034
|
-
# entity_id: "EntityId", # required
|
2035
|
-
# entity_name: "EntityName",
|
2036
2252
|
# parent_entity_update: {
|
2037
|
-
# parent_entity_id: "ParentEntityId",
|
2038
2253
|
# update_type: "UPDATE", # required, accepts UPDATE, DELETE
|
2254
|
+
# parent_entity_id: "ParentEntityId",
|
2039
2255
|
# },
|
2040
|
-
# workspace_id: "Id", # required
|
2041
2256
|
# })
|
2042
2257
|
#
|
2043
2258
|
# @example Response structure
|
2044
2259
|
#
|
2045
|
-
# resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
2046
2260
|
# resp.update_date_time #=> Time
|
2261
|
+
# resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
|
2047
2262
|
#
|
2048
2263
|
# @overload update_entity(params = {})
|
2049
2264
|
# @param [Hash] params ({})
|
@@ -2052,10 +2267,59 @@ module Aws::IoTTwinMaker
|
|
2052
2267
|
req.send_request(options)
|
2053
2268
|
end
|
2054
2269
|
|
2270
|
+
# Update the pricing plan.
|
2271
|
+
#
|
2272
|
+
# @option params [required, String] :pricing_mode
|
2273
|
+
# The pricing mode.
|
2274
|
+
#
|
2275
|
+
# @option params [Array<String>] :bundle_names
|
2276
|
+
# The bundle names.
|
2277
|
+
#
|
2278
|
+
# @return [Types::UpdatePricingPlanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2279
|
+
#
|
2280
|
+
# * {Types::UpdatePricingPlanResponse#current_pricing_plan #current_pricing_plan} => Types::PricingPlan
|
2281
|
+
# * {Types::UpdatePricingPlanResponse#pending_pricing_plan #pending_pricing_plan} => Types::PricingPlan
|
2282
|
+
#
|
2283
|
+
# @example Request syntax with placeholder values
|
2284
|
+
#
|
2285
|
+
# resp = client.update_pricing_plan({
|
2286
|
+
# pricing_mode: "BASIC", # required, accepts BASIC, STANDARD, TIERED_BUNDLE
|
2287
|
+
# bundle_names: ["BundleName"],
|
2288
|
+
# })
|
2289
|
+
#
|
2290
|
+
# @example Response structure
|
2291
|
+
#
|
2292
|
+
# resp.current_pricing_plan.billable_entity_count #=> Integer
|
2293
|
+
# resp.current_pricing_plan.bundle_information.bundle_names #=> Array
|
2294
|
+
# resp.current_pricing_plan.bundle_information.bundle_names[0] #=> String
|
2295
|
+
# resp.current_pricing_plan.bundle_information.pricing_tier #=> String, one of "TIER_1", "TIER_2", "TIER_3", "TIER_4"
|
2296
|
+
# resp.current_pricing_plan.effective_date_time #=> Time
|
2297
|
+
# resp.current_pricing_plan.pricing_mode #=> String, one of "BASIC", "STANDARD", "TIERED_BUNDLE"
|
2298
|
+
# resp.current_pricing_plan.update_date_time #=> Time
|
2299
|
+
# resp.current_pricing_plan.update_reason #=> String, one of "DEFAULT", "PRICING_TIER_UPDATE", "ENTITY_COUNT_UPDATE", "PRICING_MODE_UPDATE", "OVERWRITTEN"
|
2300
|
+
# resp.pending_pricing_plan.billable_entity_count #=> Integer
|
2301
|
+
# resp.pending_pricing_plan.bundle_information.bundle_names #=> Array
|
2302
|
+
# resp.pending_pricing_plan.bundle_information.bundle_names[0] #=> String
|
2303
|
+
# resp.pending_pricing_plan.bundle_information.pricing_tier #=> String, one of "TIER_1", "TIER_2", "TIER_3", "TIER_4"
|
2304
|
+
# resp.pending_pricing_plan.effective_date_time #=> Time
|
2305
|
+
# resp.pending_pricing_plan.pricing_mode #=> String, one of "BASIC", "STANDARD", "TIERED_BUNDLE"
|
2306
|
+
# resp.pending_pricing_plan.update_date_time #=> Time
|
2307
|
+
# resp.pending_pricing_plan.update_reason #=> String, one of "DEFAULT", "PRICING_TIER_UPDATE", "ENTITY_COUNT_UPDATE", "PRICING_MODE_UPDATE", "OVERWRITTEN"
|
2308
|
+
#
|
2309
|
+
# @overload update_pricing_plan(params = {})
|
2310
|
+
# @param [Hash] params ({})
|
2311
|
+
def update_pricing_plan(params = {}, options = {})
|
2312
|
+
req = build_request(:update_pricing_plan, params)
|
2313
|
+
req.send_request(options)
|
2314
|
+
end
|
2315
|
+
|
2055
2316
|
# Updates a scene.
|
2056
2317
|
#
|
2057
|
-
# @option params [
|
2058
|
-
#
|
2318
|
+
# @option params [required, String] :workspace_id
|
2319
|
+
# The ID of the workspace that contains the scene.
|
2320
|
+
#
|
2321
|
+
# @option params [required, String] :scene_id
|
2322
|
+
# The ID of the scene.
|
2059
2323
|
#
|
2060
2324
|
# @option params [String] :content_location
|
2061
2325
|
# The relative path that specifies the location of the content
|
@@ -2064,11 +2328,8 @@ module Aws::IoTTwinMaker
|
|
2064
2328
|
# @option params [String] :description
|
2065
2329
|
# The description of this scene.
|
2066
2330
|
#
|
2067
|
-
# @option params [
|
2068
|
-
#
|
2069
|
-
#
|
2070
|
-
# @option params [required, String] :workspace_id
|
2071
|
-
# The ID of the workspace that contains the scene.
|
2331
|
+
# @option params [Array<String>] :capabilities
|
2332
|
+
# A list of capabilities that the scene uses to render.
|
2072
2333
|
#
|
2073
2334
|
# @return [Types::UpdateSceneResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2074
2335
|
#
|
@@ -2077,11 +2338,11 @@ module Aws::IoTTwinMaker
|
|
2077
2338
|
# @example Request syntax with placeholder values
|
2078
2339
|
#
|
2079
2340
|
# resp = client.update_scene({
|
2080
|
-
#
|
2341
|
+
# workspace_id: "Id", # required
|
2342
|
+
# scene_id: "Id", # required
|
2081
2343
|
# content_location: "S3Url",
|
2082
2344
|
# description: "Description",
|
2083
|
-
#
|
2084
|
-
# workspace_id: "Id", # required
|
2345
|
+
# capabilities: ["SceneCapability"],
|
2085
2346
|
# })
|
2086
2347
|
#
|
2087
2348
|
# @example Response structure
|
@@ -2097,15 +2358,15 @@ module Aws::IoTTwinMaker
|
|
2097
2358
|
|
2098
2359
|
# Updates a workspace.
|
2099
2360
|
#
|
2361
|
+
# @option params [required, String] :workspace_id
|
2362
|
+
# The ID of the workspace.
|
2363
|
+
#
|
2100
2364
|
# @option params [String] :description
|
2101
2365
|
# The description of the workspace.
|
2102
2366
|
#
|
2103
2367
|
# @option params [String] :role
|
2104
2368
|
# The ARN of the execution role associated with the workspace.
|
2105
2369
|
#
|
2106
|
-
# @option params [required, String] :workspace_id
|
2107
|
-
# The ID of the workspace.
|
2108
|
-
#
|
2109
2370
|
# @return [Types::UpdateWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2110
2371
|
#
|
2111
2372
|
# * {Types::UpdateWorkspaceResponse#update_date_time #update_date_time} => Time
|
@@ -2113,9 +2374,9 @@ module Aws::IoTTwinMaker
|
|
2113
2374
|
# @example Request syntax with placeholder values
|
2114
2375
|
#
|
2115
2376
|
# resp = client.update_workspace({
|
2377
|
+
# workspace_id: "Id", # required
|
2116
2378
|
# description: "Description",
|
2117
2379
|
# role: "RoleArn",
|
2118
|
-
# workspace_id: "Id", # required
|
2119
2380
|
# })
|
2120
2381
|
#
|
2121
2382
|
# @example Response structure
|
@@ -2142,7 +2403,7 @@ module Aws::IoTTwinMaker
|
|
2142
2403
|
params: params,
|
2143
2404
|
config: config)
|
2144
2405
|
context[:gem_name] = 'aws-sdk-iottwinmaker'
|
2145
|
-
context[:gem_version] = '1.
|
2406
|
+
context[:gem_version] = '1.7.0'
|
2146
2407
|
Seahorse::Client::Request.new(handlers, context)
|
2147
2408
|
end
|
2148
2409
|
|