aws-sdk-iotsitewise 1.67.0 → 1.69.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.
@@ -459,23 +459,6 @@ module Aws::IoTSiteWise
459
459
  # composite model definition is applied to all assets created from the
460
460
  # asset model.
461
461
  #
462
- # @!attribute [rw] name
463
- # The name of the composite model.
464
- # @return [String]
465
- #
466
- # @!attribute [rw] description
467
- # The description of the composite model.
468
- # @return [String]
469
- #
470
- # @!attribute [rw] type
471
- # The type of the composite model. For alarm composite models, this
472
- # type is `AWS/ALARM`.
473
- # @return [String]
474
- #
475
- # @!attribute [rw] properties
476
- # The asset property definitions for this composite model.
477
- # @return [Array<Types::AssetModelPropertyDefinition>]
478
- #
479
462
  # @!attribute [rw] id
480
463
  # The ID to assign to the composite model, if desired. IoT SiteWise
481
464
  # automatically generates a unique ID for you, so this parameter is
@@ -495,13 +478,30 @@ module Aws::IoTSiteWise
495
478
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
496
479
  # @return [String]
497
480
  #
481
+ # @!attribute [rw] name
482
+ # The name of the composite model.
483
+ # @return [String]
484
+ #
485
+ # @!attribute [rw] description
486
+ # The description of the composite model.
487
+ # @return [String]
488
+ #
489
+ # @!attribute [rw] type
490
+ # The type of the composite model. For alarm composite models, this
491
+ # type is `AWS/ALARM`.
492
+ # @return [String]
493
+ #
494
+ # @!attribute [rw] properties
495
+ # The asset property definitions for this composite model.
496
+ # @return [Array<Types::AssetModelPropertyDefinition>]
497
+ #
498
498
  class AssetModelCompositeModelDefinition < Struct.new(
499
+ :id,
500
+ :external_id,
499
501
  :name,
500
502
  :description,
501
503
  :type,
502
- :properties,
503
- :id,
504
- :external_id)
504
+ :properties)
505
505
  SENSITIVE = []
506
506
  include Aws::Structure
507
507
  end
@@ -527,7 +527,7 @@ module Aws::IoTSiteWise
527
527
  # Contains a summary of the composite model.
528
528
  #
529
529
  # @!attribute [rw] id
530
- # The ID of the the composite model that this summary describes..
530
+ # The ID of the composite model that this summary describes..
531
531
  # @return [String]
532
532
  #
533
533
  # @!attribute [rw] external_id
@@ -541,24 +541,16 @@ module Aws::IoTSiteWise
541
541
  # @return [String]
542
542
  #
543
543
  # @!attribute [rw] name
544
- # The name of the the composite model that this summary describes..
544
+ # The name of the composite model that this summary describes..
545
545
  # @return [String]
546
546
  #
547
547
  # @!attribute [rw] type
548
- # The type of asset model.
549
- #
550
- # * **ASSET\_MODEL** – (default) An asset model that you can use to
551
- # create assets. Can't be included as a component in another asset
552
- # model.
553
- #
554
- # * **COMPONENT\_MODEL** – A reusable component that you can include
555
- # in the composite models of other asset models. You can't create
556
- # assets directly from this type of asset model.
548
+ # The composite model type. Valid values are `AWS/ALARM`, `CUSTOM`, or
549
+ # ` AWS/L4E_ANOMALY`.
557
550
  # @return [String]
558
551
  #
559
552
  # @!attribute [rw] description
560
- # The description of the the composite model that this summary
561
- # describes..
553
+ # The description of the composite model that this summary describes..
562
554
  # @return [String]
563
555
  #
564
556
  # @!attribute [rw] path
@@ -603,6 +595,21 @@ module Aws::IoTSiteWise
603
595
  # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
604
596
  # @return [String]
605
597
  #
598
+ # @!attribute [rw] external_id
599
+ # The external ID (if any) provided in the [CreateAssetModel][1] or
600
+ # [UpdateAssetModel][2] operation. You can assign an external ID by
601
+ # specifying this value as part of a call to [UpdateAssetModel][2].
602
+ # However, you can't change the external ID if one is already
603
+ # assigned. For more information, see [Using external IDs][3] in the
604
+ # *IoT SiteWise User Guide*.
605
+ #
606
+ #
607
+ #
608
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html
609
+ # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
610
+ # [3]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
611
+ # @return [String]
612
+ #
606
613
  # @!attribute [rw] name
607
614
  # The name of the asset model hierarchy that you specify by using the
608
615
  # [CreateAssetModel][1] or [UpdateAssetModel][2] API operation.
@@ -629,26 +636,11 @@ module Aws::IoTSiteWise
629
636
  # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
630
637
  # @return [String]
631
638
  #
632
- # @!attribute [rw] external_id
633
- # The external ID (if any) provided in the [CreateAssetModel][1] or
634
- # [UpdateAssetModel][2] operation. You can assign an external ID by
635
- # specifying this value as part of a call to [UpdateAssetModel][2].
636
- # However, you can't change the external ID if one is already
637
- # assigned. For more information, see [Using external IDs][3] in the
638
- # *IoT SiteWise User Guide*.
639
- #
640
- #
641
- #
642
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html
643
- # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
644
- # [3]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
645
- # @return [String]
646
- #
647
639
  class AssetModelHierarchy < Struct.new(
648
640
  :id,
641
+ :external_id,
649
642
  :name,
650
- :child_asset_model_id,
651
- :external_id)
643
+ :child_asset_model_id)
652
644
  SENSITIVE = []
653
645
  include Aws::Structure
654
646
  end
@@ -657,6 +649,25 @@ module Aws::IoTSiteWise
657
649
  # asset model hierarchy determines the kind (or type) of asset that can
658
650
  # belong to a hierarchy.
659
651
  #
652
+ # @!attribute [rw] id
653
+ # The ID to assign to the asset model hierarchy, if desired. IoT
654
+ # SiteWise automatically generates a unique ID for you, so this
655
+ # parameter is never required. However, if you prefer to supply your
656
+ # own ID instead, you can specify it here in UUID format. If you
657
+ # specify your own ID, it must be globally unique.
658
+ # @return [String]
659
+ #
660
+ # @!attribute [rw] external_id
661
+ # An external ID to assign to the asset model hierarchy. The external
662
+ # ID must be unique among asset model hierarchies within this asset
663
+ # model. For more information, see [Using external IDs][1] in the *IoT
664
+ # SiteWise User Guide*.
665
+ #
666
+ #
667
+ #
668
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
669
+ # @return [String]
670
+ #
660
671
  # @!attribute [rw] name
661
672
  # The name of the asset model hierarchy definition (as specified in
662
673
  # the [CreateAssetModel][1] or [UpdateAssetModel][2] API operation).
@@ -678,30 +689,11 @@ module Aws::IoTSiteWise
678
689
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
679
690
  # @return [String]
680
691
  #
681
- # @!attribute [rw] id
682
- # The ID to assign to the asset model hierarchy, if desired. IoT
683
- # SiteWise automatically generates a unique ID for you, so this
684
- # parameter is never required. However, if you prefer to supply your
685
- # own ID instead, you can specify it here in UUID format. If you
686
- # specify your own ID, it must be globally unique.
687
- # @return [String]
688
- #
689
- # @!attribute [rw] external_id
690
- # An external ID to assign to the asset model hierarchy. The external
691
- # ID must be unique among asset model hierarchies within this asset
692
- # model. For more information, see [Using external IDs][1] in the *IoT
693
- # SiteWise User Guide*.
694
- #
695
- #
696
- #
697
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
698
- # @return [String]
699
- #
700
692
  class AssetModelHierarchyDefinition < Struct.new(
701
- :name,
702
- :child_asset_model_id,
703
693
  :id,
704
- :external_id)
694
+ :external_id,
695
+ :name,
696
+ :child_asset_model_id)
705
697
  SENSITIVE = []
706
698
  include Aws::Structure
707
699
  end
@@ -730,6 +722,21 @@ module Aws::IoTSiteWise
730
722
  # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
731
723
  # @return [String]
732
724
  #
725
+ # @!attribute [rw] external_id
726
+ # The external ID (if any) provided in the [CreateAssetModel][1] or
727
+ # [UpdateAssetModel][2] operation. You can assign an external ID by
728
+ # specifying this value as part of a call to [UpdateAssetModel][2].
729
+ # However, you can't change the external ID if one is already
730
+ # assigned. For more information, see [Using external IDs][3] in the
731
+ # *IoT SiteWise User Guide*.
732
+ #
733
+ #
734
+ #
735
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html
736
+ # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
737
+ # [3]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
738
+ # @return [String]
739
+ #
733
740
  # @!attribute [rw] name
734
741
  # The name of the asset model property.
735
742
  # @return [String]
@@ -756,30 +763,15 @@ module Aws::IoTSiteWise
756
763
  # model.
757
764
  # @return [Array<Types::AssetModelPropertyPathSegment>]
758
765
  #
759
- # @!attribute [rw] external_id
760
- # The external ID (if any) provided in the [CreateAssetModel][1] or
761
- # [UpdateAssetModel][2] operation. You can assign an external ID by
762
- # specifying this value as part of a call to [UpdateAssetModel][2].
763
- # However, you can't change the external ID if one is already
764
- # assigned. For more information, see [Using external IDs][3] in the
765
- # *IoT SiteWise User Guide*.
766
- #
767
- #
768
- #
769
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html
770
- # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
771
- # [3]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
772
- # @return [String]
773
- #
774
766
  class AssetModelProperty < Struct.new(
775
767
  :id,
768
+ :external_id,
776
769
  :name,
777
770
  :data_type,
778
771
  :data_type_spec,
779
772
  :unit,
780
773
  :type,
781
- :path,
782
- :external_id)
774
+ :path)
783
775
  SENSITIVE = []
784
776
  include Aws::Structure
785
777
  end
@@ -787,6 +779,25 @@ module Aws::IoTSiteWise
787
779
  # Contains an asset model property definition. This property definition
788
780
  # is applied to all assets created from the asset model.
789
781
  #
782
+ # @!attribute [rw] id
783
+ # The ID to assign to the asset model property, if desired. IoT
784
+ # SiteWise automatically generates a unique ID for you, so this
785
+ # parameter is never required. However, if you prefer to supply your
786
+ # own ID instead, you can specify it here in UUID format. If you
787
+ # specify your own ID, it must be globally unique.
788
+ # @return [String]
789
+ #
790
+ # @!attribute [rw] external_id
791
+ # An external ID to assign to the property definition. The external ID
792
+ # must be unique among property definitions within this asset model.
793
+ # For more information, see [Using external IDs][1] in the *IoT
794
+ # SiteWise User Guide*.
795
+ #
796
+ #
797
+ #
798
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
799
+ # @return [String]
800
+ #
790
801
  # @!attribute [rw] name
791
802
  # The name of the property definition.
792
803
  # @return [String]
@@ -816,33 +827,14 @@ module Aws::IoTSiteWise
816
827
  # specify one type in a property definition.
817
828
  # @return [Types::PropertyType]
818
829
  #
819
- # @!attribute [rw] id
820
- # The ID to assign to the asset model property, if desired. IoT
821
- # SiteWise automatically generates a unique ID for you, so this
822
- # parameter is never required. However, if you prefer to supply your
823
- # own ID instead, you can specify it here in UUID format. If you
824
- # specify your own ID, it must be globally unique.
825
- # @return [String]
826
- #
827
- # @!attribute [rw] external_id
828
- # An external ID to assign to the property definition. The external ID
829
- # must be unique among property definitions within this asset model.
830
- # For more information, see [Using external IDs][1] in the *IoT
831
- # SiteWise User Guide*.
832
- #
833
- #
834
- #
835
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
836
- # @return [String]
837
- #
838
830
  class AssetModelPropertyDefinition < Struct.new(
831
+ :id,
832
+ :external_id,
839
833
  :name,
840
834
  :data_type,
841
835
  :data_type_spec,
842
836
  :unit,
843
- :type,
844
- :id,
845
- :external_id)
837
+ :type)
846
838
  SENSITIVE = []
847
839
  include Aws::Structure
848
840
  end
@@ -871,6 +863,15 @@ module Aws::IoTSiteWise
871
863
  # The ID of the property.
872
864
  # @return [String]
873
865
  #
866
+ # @!attribute [rw] external_id
867
+ # The external ID of the property. For more information, see [Using
868
+ # external IDs][1] in the *IoT SiteWise User Guide*.
869
+ #
870
+ #
871
+ #
872
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
873
+ # @return [String]
874
+ #
874
875
  # @!attribute [rw] name
875
876
  # The name of the property.
876
877
  # @return [String]
@@ -903,25 +904,16 @@ module Aws::IoTSiteWise
903
904
  # model.
904
905
  # @return [Array<Types::AssetModelPropertyPathSegment>]
905
906
  #
906
- # @!attribute [rw] external_id
907
- # The external ID of the property. For more information, see [Using
908
- # external IDs][1] in the *IoT SiteWise User Guide*.
909
- #
910
- #
911
- #
912
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
913
- # @return [String]
914
- #
915
907
  class AssetModelPropertySummary < Struct.new(
916
908
  :id,
909
+ :external_id,
917
910
  :name,
918
911
  :data_type,
919
912
  :data_type_spec,
920
913
  :unit,
921
914
  :type,
922
915
  :asset_model_composite_model_id,
923
- :path,
924
- :external_id)
916
+ :path)
925
917
  SENSITIVE = []
926
918
  include Aws::Structure
927
919
  end
@@ -955,6 +947,15 @@ module Aws::IoTSiteWise
955
947
  # The ID of the asset model (used with IoT SiteWise API operations).
956
948
  # @return [String]
957
949
  #
950
+ # @!attribute [rw] external_id
951
+ # The external ID of the asset model. For more information, see [Using
952
+ # external IDs][1] in the *IoT SiteWise User Guide*.
953
+ #
954
+ #
955
+ #
956
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
957
+ # @return [String]
958
+ #
958
959
  # @!attribute [rw] arn
959
960
  # The [ARN][1] of the asset model, which has the following format.
960
961
  #
@@ -969,6 +970,18 @@ module Aws::IoTSiteWise
969
970
  # The name of the asset model.
970
971
  # @return [String]
971
972
  #
973
+ # @!attribute [rw] asset_model_type
974
+ # The type of asset model.
975
+ #
976
+ # * **ASSET\_MODEL** – (default) An asset model that you can use to
977
+ # create assets. Can't be included as a component in another asset
978
+ # model.
979
+ #
980
+ # * **COMPONENT\_MODEL** – A reusable component that you can include
981
+ # in the composite models of other asset models. You can't create
982
+ # assets directly from this type of asset model.
983
+ # @return [String]
984
+ #
972
985
  # @!attribute [rw] description
973
986
  # The asset model description.
974
987
  # @return [String]
@@ -985,37 +998,21 @@ module Aws::IoTSiteWise
985
998
  # The current status of the asset model.
986
999
  # @return [Types::AssetModelStatus]
987
1000
  #
988
- # @!attribute [rw] asset_model_type
989
- # The type of asset model.
990
- #
991
- # * **ASSET\_MODEL** – (default) An asset model that you can use to
992
- # create assets. Can't be included as a component in another asset
993
- # model.
994
- #
995
- # * **COMPONENT\_MODEL** – A reusable component that you can include
996
- # in the composite models of other asset models. You can't create
997
- # assets directly from this type of asset model.
998
- # @return [String]
999
- #
1000
- # @!attribute [rw] external_id
1001
- # The external ID of the asset model. For more information, see [Using
1002
- # external IDs][1] in the *IoT SiteWise User Guide*.
1003
- #
1004
- #
1005
- #
1006
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
1001
+ # @!attribute [rw] version
1002
+ # The version number of the asset model.
1007
1003
  # @return [String]
1008
1004
  #
1009
1005
  class AssetModelSummary < Struct.new(
1010
1006
  :id,
1007
+ :external_id,
1011
1008
  :arn,
1012
1009
  :name,
1010
+ :asset_model_type,
1013
1011
  :description,
1014
1012
  :creation_date,
1015
1013
  :last_update_date,
1016
1014
  :status,
1017
- :asset_model_type,
1018
- :external_id)
1015
+ :version)
1019
1016
  SENSITIVE = []
1020
1017
  include Aws::Structure
1021
1018
  end
@@ -2558,11 +2555,6 @@ module Aws::IoTSiteWise
2558
2555
  # The ID of the asset model this composite model is a part of.
2559
2556
  # @return [String]
2560
2557
  #
2561
- # @!attribute [rw] parent_asset_model_composite_model_id
2562
- # The ID of the parent composite model in this asset model
2563
- # relationship.
2564
- # @return [String]
2565
- #
2566
2558
  # @!attribute [rw] asset_model_composite_model_external_id
2567
2559
  # An external ID to assign to the composite model.
2568
2560
  #
@@ -2572,6 +2564,11 @@ module Aws::IoTSiteWise
2572
2564
  # the model or property from the created model it's a part of.
2573
2565
  # @return [String]
2574
2566
  #
2567
+ # @!attribute [rw] parent_asset_model_composite_model_id
2568
+ # The ID of the parent composite model in this asset model
2569
+ # relationship.
2570
+ # @return [String]
2571
+ #
2575
2572
  # @!attribute [rw] asset_model_composite_model_id
2576
2573
  # The ID of the composite model. IoT SiteWise automatically generates
2577
2574
  # a unique ID for you, so this parameter is never required. However,
@@ -2585,7 +2582,7 @@ module Aws::IoTSiteWise
2585
2582
  # @return [String]
2586
2583
  #
2587
2584
  # @!attribute [rw] asset_model_composite_model_name
2588
- # A unique, friendly name for the composite model.
2585
+ # A unique name for the composite model.
2589
2586
  # @return [String]
2590
2587
  #
2591
2588
  # @!attribute [rw] asset_model_composite_model_type
@@ -2603,32 +2600,62 @@ module Aws::IoTSiteWise
2603
2600
  # @return [String]
2604
2601
  #
2605
2602
  # @!attribute [rw] composed_asset_model_id
2606
- # The ID of a composite model on this asset.
2603
+ # The ID of a component model which is reused to create this composite
2604
+ # model.
2607
2605
  # @return [String]
2608
2606
  #
2609
2607
  # @!attribute [rw] asset_model_composite_model_properties
2610
2608
  # The property definitions of the composite model. For more
2611
- # information, see &lt;LINK&gt;.
2609
+ # information, see [ Inline custom composite models][1] in the *IoT
2610
+ # SiteWise User Guide*.
2612
2611
  #
2613
2612
  # You can specify up to 200 properties per composite model. For more
2614
- # information, see [Quotas][1] in the *IoT SiteWise User Guide*.
2613
+ # information, see [Quotas][2] in the *IoT SiteWise User Guide*.
2615
2614
  #
2616
2615
  #
2617
2616
  #
2618
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
2617
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models
2618
+ # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
2619
2619
  # @return [Array<Types::AssetModelPropertyDefinition>]
2620
2620
  #
2621
+ # @!attribute [rw] if_match
2622
+ # The expected current entity tag (ETag) for the asset model’s latest
2623
+ # or active version (specified using `matchForVersionType`). The
2624
+ # create request is rejected if the tag does not match the latest or
2625
+ # active version's current entity tag. See [Optimistic locking for
2626
+ # asset model writes][1] in the *IoT SiteWise User Guide*.
2627
+ #
2628
+ #
2629
+ #
2630
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
2631
+ # @return [String]
2632
+ #
2633
+ # @!attribute [rw] if_none_match
2634
+ # Accepts ***** to reject the create request if an active version
2635
+ # (specified using `matchForVersionType` as `ACTIVE`) already exists
2636
+ # for the asset model.
2637
+ # @return [String]
2638
+ #
2639
+ # @!attribute [rw] match_for_version_type
2640
+ # Specifies the asset model version type (`LATEST` or `ACTIVE`) used
2641
+ # in conjunction with `If-Match` or `If-None-Match` headers to
2642
+ # determine the target ETag for the create operation.
2643
+ # @return [String]
2644
+ #
2621
2645
  class CreateAssetModelCompositeModelRequest < Struct.new(
2622
2646
  :asset_model_id,
2623
- :parent_asset_model_composite_model_id,
2624
2647
  :asset_model_composite_model_external_id,
2648
+ :parent_asset_model_composite_model_id,
2625
2649
  :asset_model_composite_model_id,
2626
2650
  :asset_model_composite_model_description,
2627
2651
  :asset_model_composite_model_name,
2628
2652
  :asset_model_composite_model_type,
2629
2653
  :client_token,
2630
2654
  :composed_asset_model_id,
2631
- :asset_model_composite_model_properties)
2655
+ :asset_model_composite_model_properties,
2656
+ :if_match,
2657
+ :if_none_match,
2658
+ :match_for_version_type)
2632
2659
  SENSITIVE = []
2633
2660
  include Aws::Structure
2634
2661
  end
@@ -2661,7 +2688,38 @@ module Aws::IoTSiteWise
2661
2688
  end
2662
2689
 
2663
2690
  # @!attribute [rw] asset_model_name
2664
- # A unique, friendly name for the asset model.
2691
+ # A unique name for the asset model.
2692
+ # @return [String]
2693
+ #
2694
+ # @!attribute [rw] asset_model_type
2695
+ # The type of asset model.
2696
+ #
2697
+ # * **ASSET\_MODEL** – (default) An asset model that you can use to
2698
+ # create assets. Can't be included as a component in another asset
2699
+ # model.
2700
+ #
2701
+ # * **COMPONENT\_MODEL** – A reusable component that you can include
2702
+ # in the composite models of other asset models. You can't create
2703
+ # assets directly from this type of asset model.
2704
+ # @return [String]
2705
+ #
2706
+ # @!attribute [rw] asset_model_id
2707
+ # The ID to assign to the asset model, if desired. IoT SiteWise
2708
+ # automatically generates a unique ID for you, so this parameter is
2709
+ # never required. However, if you prefer to supply your own ID
2710
+ # instead, you can specify it here in UUID format. If you specify your
2711
+ # own ID, it must be globally unique.
2712
+ # @return [String]
2713
+ #
2714
+ # @!attribute [rw] asset_model_external_id
2715
+ # An external ID to assign to the asset model. The external ID must be
2716
+ # unique within your Amazon Web Services account. For more
2717
+ # information, see [Using external IDs][1] in the *IoT SiteWise User
2718
+ # Guide*.
2719
+ #
2720
+ #
2721
+ #
2722
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
2665
2723
  # @return [String]
2666
2724
  #
2667
2725
  # @!attribute [rw] asset_model_description
@@ -2706,13 +2764,15 @@ module Aws::IoTSiteWise
2706
2764
  #
2707
2765
  # <note markdown="1"> When creating custom composite models, you need to use
2708
2766
  # [CreateAssetModelCompositeModel][1]. For more information, see
2709
- # &lt;LINK&gt;.
2767
+ # [Creating custom composite models (Components)][2] in the *IoT
2768
+ # SiteWise User Guide*.
2710
2769
  #
2711
2770
  # </note>
2712
2771
  #
2713
2772
  #
2714
2773
  #
2715
2774
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html
2775
+ # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html
2716
2776
  # @return [Array<Types::AssetModelCompositeModelDefinition>]
2717
2777
  #
2718
2778
  # @!attribute [rw] client_token
@@ -2734,48 +2794,17 @@ module Aws::IoTSiteWise
2734
2794
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
2735
2795
  # @return [Hash<String,String>]
2736
2796
  #
2737
- # @!attribute [rw] asset_model_id
2738
- # The ID to assign to the asset model, if desired. IoT SiteWise
2739
- # automatically generates a unique ID for you, so this parameter is
2740
- # never required. However, if you prefer to supply your own ID
2741
- # instead, you can specify it here in UUID format. If you specify your
2742
- # own ID, it must be globally unique.
2743
- # @return [String]
2744
- #
2745
- # @!attribute [rw] asset_model_external_id
2746
- # An external ID to assign to the asset model. The external ID must be
2747
- # unique within your Amazon Web Services account. For more
2748
- # information, see [Using external IDs][1] in the *IoT SiteWise User
2749
- # Guide*.
2750
- #
2751
- #
2752
- #
2753
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
2754
- # @return [String]
2755
- #
2756
- # @!attribute [rw] asset_model_type
2757
- # The type of asset model.
2758
- #
2759
- # * **ASSET\_MODEL** – (default) An asset model that you can use to
2760
- # create assets. Can't be included as a component in another asset
2761
- # model.
2762
- #
2763
- # * **COMPONENT\_MODEL** – A reusable component that you can include
2764
- # in the composite models of other asset models. You can't create
2765
- # assets directly from this type of asset model.
2766
- # @return [String]
2767
- #
2768
2797
  class CreateAssetModelRequest < Struct.new(
2769
2798
  :asset_model_name,
2799
+ :asset_model_type,
2800
+ :asset_model_id,
2801
+ :asset_model_external_id,
2770
2802
  :asset_model_description,
2771
2803
  :asset_model_properties,
2772
2804
  :asset_model_hierarchies,
2773
2805
  :asset_model_composite_models,
2774
2806
  :client_token,
2775
- :tags,
2776
- :asset_model_id,
2777
- :asset_model_external_id,
2778
- :asset_model_type)
2807
+ :tags)
2779
2808
  SENSITIVE = []
2780
2809
  include Aws::Structure
2781
2810
  end
@@ -3072,7 +3101,7 @@ module Aws::IoTSiteWise
3072
3101
  end
3073
3102
 
3074
3103
  # @!attribute [rw] gateway_name
3075
- # A unique, friendly name for the gateway.
3104
+ # A unique name for the gateway.
3076
3105
  # @return [String]
3077
3106
  #
3078
3107
  # @!attribute [rw] gateway_platform
@@ -3474,10 +3503,37 @@ module Aws::IoTSiteWise
3474
3503
  # not need to pass this option.
3475
3504
  # @return [String]
3476
3505
  #
3506
+ # @!attribute [rw] if_match
3507
+ # The expected current entity tag (ETag) for the asset model’s latest
3508
+ # or active version (specified using `matchForVersionType`). The
3509
+ # delete request is rejected if the tag does not match the latest or
3510
+ # active version's current entity tag. See [Optimistic locking for
3511
+ # asset model writes][1] in the *IoT SiteWise User Guide*.
3512
+ #
3513
+ #
3514
+ #
3515
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
3516
+ # @return [String]
3517
+ #
3518
+ # @!attribute [rw] if_none_match
3519
+ # Accepts ***** to reject the delete request if an active version
3520
+ # (specified using `matchForVersionType` as `ACTIVE`) already exists
3521
+ # for the asset model.
3522
+ # @return [String]
3523
+ #
3524
+ # @!attribute [rw] match_for_version_type
3525
+ # Specifies the asset model version type (`LATEST` or `ACTIVE`) used
3526
+ # in conjunction with `If-Match` or `If-None-Match` headers to
3527
+ # determine the target ETag for the delete operation.
3528
+ # @return [String]
3529
+ #
3477
3530
  class DeleteAssetModelCompositeModelRequest < Struct.new(
3478
3531
  :asset_model_id,
3479
3532
  :asset_model_composite_model_id,
3480
- :client_token)
3533
+ :client_token,
3534
+ :if_match,
3535
+ :if_none_match,
3536
+ :match_for_version_type)
3481
3537
  SENSITIVE = []
3482
3538
  include Aws::Structure
3483
3539
  end
@@ -3518,9 +3574,36 @@ module Aws::IoTSiteWise
3518
3574
  # not need to pass this option.
3519
3575
  # @return [String]
3520
3576
  #
3577
+ # @!attribute [rw] if_match
3578
+ # The expected current entity tag (ETag) for the asset model’s latest
3579
+ # or active version (specified using `matchForVersionType`). The
3580
+ # delete request is rejected if the tag does not match the latest or
3581
+ # active version's current entity tag. See [Optimistic locking for
3582
+ # asset model writes][1] in the *IoT SiteWise User Guide*.
3583
+ #
3584
+ #
3585
+ #
3586
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
3587
+ # @return [String]
3588
+ #
3589
+ # @!attribute [rw] if_none_match
3590
+ # Accepts ***** to reject the delete request if an active version
3591
+ # (specified using `matchForVersionType` as `ACTIVE`) already exists
3592
+ # for the asset model.
3593
+ # @return [String]
3594
+ #
3595
+ # @!attribute [rw] match_for_version_type
3596
+ # Specifies the asset model version type (`LATEST` or `ACTIVE`) used
3597
+ # in conjunction with `If-Match` or `If-None-Match` headers to
3598
+ # determine the target ETag for the delete operation.
3599
+ # @return [String]
3600
+ #
3521
3601
  class DeleteAssetModelRequest < Struct.new(
3522
3602
  :asset_model_id,
3523
- :client_token)
3603
+ :client_token,
3604
+ :if_match,
3605
+ :if_none_match,
3606
+ :match_for_version_type)
3524
3607
  SENSITIVE = []
3525
3608
  include Aws::Structure
3526
3609
  end
@@ -3918,9 +4001,21 @@ module Aws::IoTSiteWise
3918
4001
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
3919
4002
  # @return [String]
3920
4003
  #
4004
+ # @!attribute [rw] asset_model_version
4005
+ # The version alias that specifies the latest or active version of the
4006
+ # asset model. The details are returned in the response. The default
4007
+ # value is `LATEST`. See [ Asset model versions][1] in the *IoT
4008
+ # SiteWise User Guide*.
4009
+ #
4010
+ #
4011
+ #
4012
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
4013
+ # @return [String]
4014
+ #
3921
4015
  class DescribeAssetModelCompositeModelRequest < Struct.new(
3922
4016
  :asset_model_id,
3923
- :asset_model_composite_model_id)
4017
+ :asset_model_composite_model_id,
4018
+ :asset_model_version)
3924
4019
  SENSITIVE = []
3925
4020
  include Aws::Structure
3926
4021
  end
@@ -4008,9 +4103,21 @@ module Aws::IoTSiteWise
4008
4103
  # Whether or not to exclude asset model properties from the response.
4009
4104
  # @return [Boolean]
4010
4105
  #
4106
+ # @!attribute [rw] asset_model_version
4107
+ # The version alias that specifies the latest or active version of the
4108
+ # asset model. The details are returned in the response. The default
4109
+ # value is `LATEST`. See [ Asset model versions][1] in the *IoT
4110
+ # SiteWise User Guide*.
4111
+ #
4112
+ #
4113
+ #
4114
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
4115
+ # @return [String]
4116
+ #
4011
4117
  class DescribeAssetModelRequest < Struct.new(
4012
4118
  :asset_model_id,
4013
- :exclude_properties)
4119
+ :exclude_properties,
4120
+ :asset_model_version)
4014
4121
  SENSITIVE = []
4015
4122
  include Aws::Structure
4016
4123
  end
@@ -4019,6 +4126,10 @@ module Aws::IoTSiteWise
4019
4126
  # The ID of the asset model, in UUID format.
4020
4127
  # @return [String]
4021
4128
  #
4129
+ # @!attribute [rw] asset_model_external_id
4130
+ # The external ID of the asset model, if any.
4131
+ # @return [String]
4132
+ #
4022
4133
  # @!attribute [rw] asset_model_arn
4023
4134
  # The [ARN][1] of the asset model, which has the following format.
4024
4135
  #
@@ -4033,6 +4144,18 @@ module Aws::IoTSiteWise
4033
4144
  # The name of the asset model.
4034
4145
  # @return [String]
4035
4146
  #
4147
+ # @!attribute [rw] asset_model_type
4148
+ # The type of asset model.
4149
+ #
4150
+ # * **ASSET\_MODEL** – (default) An asset model that you can use to
4151
+ # create assets. Can't be included as a component in another asset
4152
+ # model.
4153
+ #
4154
+ # * **COMPONENT\_MODEL** – A reusable component that you can include
4155
+ # in the composite models of other asset models. You can't create
4156
+ # assets directly from this type of asset model.
4157
+ # @return [String]
4158
+ #
4036
4159
  # @!attribute [rw] asset_model_description
4037
4160
  # The asset model's description.
4038
4161
  # @return [String]
@@ -4057,6 +4180,11 @@ module Aws::IoTSiteWise
4057
4180
  # those with those of type `AWS/ALARMS`.
4058
4181
  # @return [Array<Types::AssetModelCompositeModel>]
4059
4182
  #
4183
+ # @!attribute [rw] asset_model_composite_model_summaries
4184
+ # The list of the immediate child custom composite model summaries for
4185
+ # the asset model.
4186
+ # @return [Array<Types::AssetModelCompositeModelSummary>]
4187
+ #
4060
4188
  # @!attribute [rw] asset_model_creation_date
4061
4189
  # The date the asset model was created, in Unix epoch time.
4062
4190
  # @return [Time]
@@ -4070,41 +4198,45 @@ module Aws::IoTSiteWise
4070
4198
  # any error message.
4071
4199
  # @return [Types::AssetModelStatus]
4072
4200
  #
4073
- # @!attribute [rw] asset_model_type
4074
- # The type of asset model.
4201
+ # @!attribute [rw] asset_model_version
4202
+ # The version of the asset model. See [ Asset model versions][1] in
4203
+ # the *IoT SiteWise User Guide*.
4075
4204
  #
4076
- # * **ASSET\_MODEL** – (default) An asset model that you can use to
4077
- # create assets. Can't be included as a component in another asset
4078
- # model.
4079
4205
  #
4080
- # * **COMPONENT\_MODEL** – A reusable component that you can include
4081
- # in the composite models of other asset models. You can't create
4082
- # assets directly from this type of asset model.
4206
+ #
4207
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
4083
4208
  # @return [String]
4084
4209
  #
4085
- # @!attribute [rw] asset_model_composite_model_summaries
4086
- # The list of the immediate child custom composite model summaries for
4087
- # the asset model.
4088
- # @return [Array<Types::AssetModelCompositeModelSummary>]
4210
+ # @!attribute [rw] e_tag
4211
+ # The entity tag (ETag) is a hash of the retrieved version of the
4212
+ # asset model. It's used to make concurrent updates safely to the
4213
+ # resource. See [Optimistic locking for asset model writes][1] in the
4214
+ # *IoT SiteWise User Guide*.
4089
4215
  #
4090
- # @!attribute [rw] asset_model_external_id
4091
- # The external ID of the asset model, if any.
4216
+ # See [ Optimistic locking for asset model writes][1] in the *IoT
4217
+ # SiteWise User Guide*.
4218
+ #
4219
+ #
4220
+ #
4221
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
4092
4222
  # @return [String]
4093
4223
  #
4094
4224
  class DescribeAssetModelResponse < Struct.new(
4095
4225
  :asset_model_id,
4226
+ :asset_model_external_id,
4096
4227
  :asset_model_arn,
4097
4228
  :asset_model_name,
4229
+ :asset_model_type,
4098
4230
  :asset_model_description,
4099
4231
  :asset_model_properties,
4100
4232
  :asset_model_hierarchies,
4101
4233
  :asset_model_composite_models,
4234
+ :asset_model_composite_model_summaries,
4102
4235
  :asset_model_creation_date,
4103
4236
  :asset_model_last_update_date,
4104
4237
  :asset_model_status,
4105
- :asset_model_type,
4106
- :asset_model_composite_model_summaries,
4107
- :asset_model_external_id)
4238
+ :asset_model_version,
4239
+ :e_tag)
4108
4240
  SENSITIVE = []
4109
4241
  include Aws::Structure
4110
4242
  end
@@ -5325,9 +5457,15 @@ module Aws::IoTSiteWise
5325
5457
  # A gateway that runs on IoT Greengrass V2.
5326
5458
  # @return [Types::GreengrassV2]
5327
5459
  #
5460
+ # @!attribute [rw] siemens_ie
5461
+ # A SiteWise Edge gateway that runs on a Siemens Industrial Edge
5462
+ # Device.
5463
+ # @return [Types::SiemensIE]
5464
+ #
5328
5465
  class GatewayPlatform < Struct.new(
5329
5466
  :greengrass,
5330
- :greengrass_v2)
5467
+ :greengrass_v2,
5468
+ :siemens_ie)
5331
5469
  SENSITIVE = []
5332
5470
  include Aws::Structure
5333
5471
  end
@@ -5339,7 +5477,7 @@ module Aws::IoTSiteWise
5339
5477
  # @return [String]
5340
5478
  #
5341
5479
  # @!attribute [rw] gateway_name
5342
- # The name of the asset.
5480
+ # The name of the gateway.
5343
5481
  # @return [String]
5344
5482
  #
5345
5483
  # @!attribute [rw] gateway_platform
@@ -5760,13 +5898,13 @@ module Aws::IoTSiteWise
5760
5898
  # @!attribute [rw] group_arn
5761
5899
  # The [ARN][1] of the Greengrass group. For more information about how
5762
5900
  # to find a group's ARN, see [ListGroups][2] and [GetGroup][3] in the
5763
- # *IoT Greengrass API Reference*.
5901
+ # *IoT Greengrass V1 API Reference*.
5764
5902
  #
5765
5903
  #
5766
5904
  #
5767
5905
  # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
5768
- # [2]: https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html
5769
- # [3]: https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html
5906
+ # [2]: https://docs.aws.amazon.com/greengrass/v1/apireference/listgroups-get.html
5907
+ # [3]: https://docs.aws.amazon.com/greengrass/v1/apireference/getgroup-get.html
5770
5908
  # @return [String]
5771
5909
  #
5772
5910
  class Greengrass < Struct.new(
@@ -6201,10 +6339,22 @@ module Aws::IoTSiteWise
6201
6339
  # Default: 50
6202
6340
  # @return [Integer]
6203
6341
  #
6342
+ # @!attribute [rw] asset_model_version
6343
+ # The version alias that specifies the latest or active version of the
6344
+ # asset model. The details are returned in the response. The default
6345
+ # value is `LATEST`. See [ Asset model versions][1] in the *IoT
6346
+ # SiteWise User Guide*.
6347
+ #
6348
+ #
6349
+ #
6350
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
6351
+ # @return [String]
6352
+ #
6204
6353
  class ListAssetModelCompositeModelsRequest < Struct.new(
6205
6354
  :asset_model_id,
6206
6355
  :next_token,
6207
- :max_results)
6356
+ :max_results,
6357
+ :asset_model_version)
6208
6358
  SENSITIVE = []
6209
6359
  include Aws::Structure
6210
6360
  end
@@ -6258,11 +6408,23 @@ module Aws::IoTSiteWise
6258
6408
  # Default: `BASE`
6259
6409
  # @return [String]
6260
6410
  #
6411
+ # @!attribute [rw] asset_model_version
6412
+ # The version alias that specifies the latest or active version of the
6413
+ # asset model. The details are returned in the response. The default
6414
+ # value is `LATEST`. See [ Asset model versions][1] in the *IoT
6415
+ # SiteWise User Guide*.
6416
+ #
6417
+ #
6418
+ #
6419
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
6420
+ # @return [String]
6421
+ #
6261
6422
  class ListAssetModelPropertiesRequest < Struct.new(
6262
6423
  :asset_model_id,
6263
6424
  :next_token,
6264
6425
  :max_results,
6265
- :filter)
6426
+ :filter,
6427
+ :asset_model_version)
6266
6428
  SENSITIVE = []
6267
6429
  include Aws::Structure
6268
6430
  end
@@ -6284,6 +6446,18 @@ module Aws::IoTSiteWise
6284
6446
  include Aws::Structure
6285
6447
  end
6286
6448
 
6449
+ # @!attribute [rw] asset_model_types
6450
+ # The type of asset model. If you don't provide an `assetModelTypes`,
6451
+ # all types of asset models are returned.
6452
+ #
6453
+ # * **ASSET\_MODEL** – An asset model that you can use to create
6454
+ # assets. Can't be included as a component in another asset model.
6455
+ #
6456
+ # * **COMPONENT\_MODEL** – A reusable component that you can include
6457
+ # in the composite models of other asset models. You can't create
6458
+ # assets directly from this type of asset model.
6459
+ # @return [Array<String>]
6460
+ #
6287
6461
  # @!attribute [rw] next_token
6288
6462
  # The token to be used for the next set of paginated results.
6289
6463
  # @return [String]
@@ -6294,22 +6468,22 @@ module Aws::IoTSiteWise
6294
6468
  # Default: 50
6295
6469
  # @return [Integer]
6296
6470
  #
6297
- # @!attribute [rw] asset_model_types
6298
- # The type of asset model.
6471
+ # @!attribute [rw] asset_model_version
6472
+ # The version alias that specifies the latest or active version of the
6473
+ # asset model. The details are returned in the response. The default
6474
+ # value is `LATEST`. See [ Asset model versions][1] in the *IoT
6475
+ # SiteWise User Guide*.
6299
6476
  #
6300
- # * **ASSET\_MODEL** – (default) An asset model that you can use to
6301
- # create assets. Can't be included as a component in another asset
6302
- # model.
6303
6477
  #
6304
- # * **COMPONENT\_MODEL** – A reusable component that you can include
6305
- # in the composite models of other asset models. You can't create
6306
- # assets directly from this type of asset model.
6307
- # @return [Array<String>]
6478
+ #
6479
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
6480
+ # @return [String]
6308
6481
  #
6309
6482
  class ListAssetModelsRequest < Struct.new(
6483
+ :asset_model_types,
6310
6484
  :next_token,
6311
6485
  :max_results,
6312
- :asset_model_types)
6486
+ :asset_model_version)
6313
6487
  SENSITIVE = []
6314
6488
  include Aws::Structure
6315
6489
  end
@@ -6518,24 +6692,22 @@ module Aws::IoTSiteWise
6518
6692
  # @return [String]
6519
6693
  #
6520
6694
  # @!attribute [rw] hierarchy_id
6695
+ # (Optional) If you don't provide a `hierarchyId`, all the immediate
6696
+ # assets in the `traversalDirection` will be returned.
6697
+ #
6521
6698
  # The ID of the hierarchy by which child assets are associated to the
6522
6699
  # asset. (This can be either the actual ID in UUID format, or else
6523
6700
  # `externalId:` followed by the external ID, if it has one. For more
6524
6701
  # information, see [Referencing objects with external IDs][1] in the
6525
- # *IoT SiteWise User Guide*.) To find a hierarchy ID, use the
6526
- # [DescribeAsset][2] or [DescribeAssetModel][3] operations. This
6527
- # parameter is required if you choose `CHILD` for
6528
- # `traversalDirection`.
6702
+ # *IoT SiteWise User Guide*.)
6529
6703
  #
6530
- # For more information, see [Asset hierarchies][4] in the *IoT
6704
+ # For more information, see [Asset hierarchies][2] in the *IoT
6531
6705
  # SiteWise User Guide*.
6532
6706
  #
6533
6707
  #
6534
6708
  #
6535
6709
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
6536
- # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html
6537
- # [3]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html
6538
- # [4]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
6710
+ # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
6539
6711
  # @return [String]
6540
6712
  #
6541
6713
  # @!attribute [rw] traversal_direction
@@ -6543,8 +6715,7 @@ module Aws::IoTSiteWise
6543
6715
  # options:
6544
6716
  #
6545
6717
  # * `CHILD` – The list includes all child assets associated to the
6546
- # asset. The `hierarchyId` parameter is required if you choose
6547
- # `CHILD`.
6718
+ # asset.
6548
6719
  #
6549
6720
  # * `PARENT` – The list includes the asset's parent asset.
6550
6721
  #
@@ -7193,6 +7364,30 @@ module Aws::IoTSiteWise
7193
7364
  include Aws::Structure
7194
7365
  end
7195
7366
 
7367
+ # The precondition in one or more of the request-header fields evaluated
7368
+ # to `FALSE`.
7369
+ #
7370
+ # @!attribute [rw] message
7371
+ # @return [String]
7372
+ #
7373
+ # @!attribute [rw] resource_id
7374
+ # The ID of the resource on which precondition failed with this
7375
+ # operation.
7376
+ # @return [String]
7377
+ #
7378
+ # @!attribute [rw] resource_arn
7379
+ # The ARN of the resource on which precondition failed with this
7380
+ # operation.
7381
+ # @return [String]
7382
+ #
7383
+ class PreconditionFailedException < Struct.new(
7384
+ :message,
7385
+ :resource_id,
7386
+ :resource_arn)
7387
+ SENSITIVE = []
7388
+ include Aws::Structure
7389
+ end
7390
+
7196
7391
  # Identifies a specific IoT SiteWise Monitor project.
7197
7392
  #
7198
7393
  # @!attribute [rw] id
@@ -7724,6 +7919,19 @@ module Aws::IoTSiteWise
7724
7919
  include Aws::Structure
7725
7920
  end
7726
7921
 
7922
+ # Contains details for a SiteWise Edge gateway that runs on a Siemens
7923
+ # Industrial Edge Device.
7924
+ #
7925
+ # @!attribute [rw] iot_core_thing_name
7926
+ # The name of the IoT Thing for your SiteWise Edge gateway.
7927
+ # @return [String]
7928
+ #
7929
+ class SiemensIE < Struct.new(
7930
+ :iot_core_thing_name)
7931
+ SENSITIVE = []
7932
+ include Aws::Structure
7933
+ end
7934
+
7727
7935
  # @!attribute [rw] resource_arn
7728
7936
  # The [ARN][1] of the resource to tag.
7729
7937
  #
@@ -8139,7 +8347,7 @@ module Aws::IoTSiteWise
8139
8347
  # @return [String]
8140
8348
  #
8141
8349
  # @!attribute [rw] asset_model_composite_model_name
8142
- # A unique, friendly name for the composite model.
8350
+ # A unique name for the composite model.
8143
8351
  # @return [String]
8144
8352
  #
8145
8353
  # @!attribute [rw] client_token
@@ -8153,16 +8361,42 @@ module Aws::IoTSiteWise
8153
8361
  #
8154
8362
  # @!attribute [rw] asset_model_composite_model_properties
8155
8363
  # The property definitions of the composite model. For more
8156
- # information, see &lt;LINK&gt;.
8364
+ # information, see [ Inline custom composite models][1] in the *IoT
8365
+ # SiteWise User Guide*.
8157
8366
  #
8158
8367
  # You can specify up to 200 properties per composite model. For more
8159
- # information, see [Quotas][1] in the *IoT SiteWise User Guide*.
8368
+ # information, see [Quotas][2] in the *IoT SiteWise User Guide*.
8160
8369
  #
8161
8370
  #
8162
8371
  #
8163
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
8372
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models
8373
+ # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
8164
8374
  # @return [Array<Types::AssetModelProperty>]
8165
8375
  #
8376
+ # @!attribute [rw] if_match
8377
+ # The expected current entity tag (ETag) for the asset model’s latest
8378
+ # or active version (specified using `matchForVersionType`). The
8379
+ # update request is rejected if the tag does not match the latest or
8380
+ # active version's current entity tag. See [Optimistic locking for
8381
+ # asset model writes][1] in the *IoT SiteWise User Guide*.
8382
+ #
8383
+ #
8384
+ #
8385
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
8386
+ # @return [String]
8387
+ #
8388
+ # @!attribute [rw] if_none_match
8389
+ # Accepts ***** to reject the update request if an active version
8390
+ # (specified using `matchForVersionType` as `ACTIVE`) already exists
8391
+ # for the asset model.
8392
+ # @return [String]
8393
+ #
8394
+ # @!attribute [rw] match_for_version_type
8395
+ # Specifies the asset model version type (`LATEST` or `ACTIVE`) used
8396
+ # in conjunction with `If-Match` or `If-None-Match` headers to
8397
+ # determine the target ETag for the update operation.
8398
+ # @return [String]
8399
+ #
8166
8400
  class UpdateAssetModelCompositeModelRequest < Struct.new(
8167
8401
  :asset_model_id,
8168
8402
  :asset_model_composite_model_id,
@@ -8170,7 +8404,10 @@ module Aws::IoTSiteWise
8170
8404
  :asset_model_composite_model_description,
8171
8405
  :asset_model_composite_model_name,
8172
8406
  :client_token,
8173
- :asset_model_composite_model_properties)
8407
+ :asset_model_composite_model_properties,
8408
+ :if_match,
8409
+ :if_none_match,
8410
+ :match_for_version_type)
8174
8411
  SENSITIVE = []
8175
8412
  include Aws::Structure
8176
8413
  end
@@ -8207,8 +8444,19 @@ module Aws::IoTSiteWise
8207
8444
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
8208
8445
  # @return [String]
8209
8446
  #
8447
+ # @!attribute [rw] asset_model_external_id
8448
+ # An external ID to assign to the asset model. The asset model must
8449
+ # not already have an external ID. The external ID must be unique
8450
+ # within your Amazon Web Services account. For more information, see
8451
+ # [Using external IDs][1] in the *IoT SiteWise User Guide*.
8452
+ #
8453
+ #
8454
+ #
8455
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
8456
+ # @return [String]
8457
+ #
8210
8458
  # @!attribute [rw] asset_model_name
8211
- # A unique, friendly name for the asset model.
8459
+ # A unique name for the asset model.
8212
8460
  # @return [String]
8213
8461
  #
8214
8462
  # @!attribute [rw] asset_model_description
@@ -8254,13 +8502,15 @@ module Aws::IoTSiteWise
8254
8502
  #
8255
8503
  # <note markdown="1"> When creating custom composite models, you need to use
8256
8504
  # [CreateAssetModelCompositeModel][1]. For more information, see
8257
- # &lt;LINK&gt;.
8505
+ # [Creating custom composite models (Components)][2] in the *IoT
8506
+ # SiteWise User Guide*.
8258
8507
  #
8259
8508
  # </note>
8260
8509
  #
8261
8510
  #
8262
8511
  #
8263
8512
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html
8513
+ # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html
8264
8514
  # @return [Array<Types::AssetModelCompositeModel>]
8265
8515
  #
8266
8516
  # @!attribute [rw] client_token
@@ -8272,26 +8522,42 @@ module Aws::IoTSiteWise
8272
8522
  # not need to pass this option.
8273
8523
  # @return [String]
8274
8524
  #
8275
- # @!attribute [rw] asset_model_external_id
8276
- # An external ID to assign to the asset model. The asset model must
8277
- # not already have an external ID. The external ID must be unique
8278
- # within your Amazon Web Services account. For more information, see
8279
- # [Using external IDs][1] in the *IoT SiteWise User Guide*.
8525
+ # @!attribute [rw] if_match
8526
+ # The expected current entity tag (ETag) for the asset model’s latest
8527
+ # or active version (specified using `matchForVersionType`). The
8528
+ # update request is rejected if the tag does not match the latest or
8529
+ # active version's current entity tag. See [Optimistic locking for
8530
+ # asset model writes][1] in the *IoT SiteWise User Guide*.
8280
8531
  #
8281
8532
  #
8282
8533
  #
8283
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
8534
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
8535
+ # @return [String]
8536
+ #
8537
+ # @!attribute [rw] if_none_match
8538
+ # Accepts ***** to reject the update request if an active version
8539
+ # (specified using `matchForVersionType` as `ACTIVE`) already exists
8540
+ # for the asset model.
8541
+ # @return [String]
8542
+ #
8543
+ # @!attribute [rw] match_for_version_type
8544
+ # Specifies the asset model version type (`LATEST` or `ACTIVE`) used
8545
+ # in conjunction with `If-Match` or `If-None-Match` headers to
8546
+ # determine the target ETag for the update operation.
8284
8547
  # @return [String]
8285
8548
  #
8286
8549
  class UpdateAssetModelRequest < Struct.new(
8287
8550
  :asset_model_id,
8551
+ :asset_model_external_id,
8288
8552
  :asset_model_name,
8289
8553
  :asset_model_description,
8290
8554
  :asset_model_properties,
8291
8555
  :asset_model_hierarchies,
8292
8556
  :asset_model_composite_models,
8293
8557
  :client_token,
8294
- :asset_model_external_id)
8558
+ :if_match,
8559
+ :if_none_match,
8560
+ :match_for_version_type)
8295
8561
  SENSITIVE = []
8296
8562
  include Aws::Structure
8297
8563
  end
@@ -8549,7 +8815,7 @@ module Aws::IoTSiteWise
8549
8815
  # @return [String]
8550
8816
  #
8551
8817
  # @!attribute [rw] gateway_name
8552
- # A unique, friendly name for the gateway.
8818
+ # A unique name for the gateway.
8553
8819
  # @return [String]
8554
8820
  #
8555
8821
  class UpdateGatewayRequest < Struct.new(
@@ -8753,8 +9019,7 @@ module Aws::IoTSiteWise
8753
9019
  # @return [String]
8754
9020
  #
8755
9021
  # @!attribute [rw] integer_value
8756
- # Asset property data of type integer (number that's greater than or
8757
- # equal to zero).
9022
+ # Asset property data of type integer (whole number).
8758
9023
  # @return [Integer]
8759
9024
  #
8760
9025
  # @!attribute [rw] double_value