aws-sdk-iotsitewise 1.23.0 → 1.27.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotsitewise.rb +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +406 -199
- data/lib/aws-sdk-iotsitewise/client_api.rb +147 -26
- data/lib/aws-sdk-iotsitewise/types.rb +750 -240
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 245f60df12ec946f7a4e0fbc14727bc578da0c816fcd9459b4ca5643c9708971
|
4
|
+
data.tar.gz: 195510e5eb76a9f52ef6cedb2a57d05e8ed27c4b439c157c3ce2327c33f2d2c5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c76ef9ed7e3e0c65fa4364dac73f076c4ed8b8c71a863b549eb61c22ebc92d4efa3e9cb700925b16487d843c4beb39541dbf84f9770ea469efc1685f57ba376f
|
7
|
+
data.tar.gz: 3ff92ef8e696bbdb40e27e607efe0f9be4dba2b807e86627bee2a37bdad16391cf67a9645f823cf53b256c5c56ec14f3fd070c36b1a5e887718c831c73c88c86
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.27.0 (2021-07-29)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Added support for AWS IoT SiteWise Edge. You can now create an AWS IoT SiteWise gateway that runs on AWS IoT Greengrass V2. With the gateway, you can collect local server and equipment data, process the data, and export the selected data from the edge to the AWS Cloud.
|
8
|
+
|
9
|
+
1.26.0 (2021-07-28)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.25.0 (2021-07-15)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Update the default endpoint for the APIs used to manage asset models, assets, gateways, tags, and account configurations. If you have firewalls with strict egress rules, configure the rules to grant you access to api.iotsitewise.[region].amazonaws.com or api.iotsitewise.[cn-region].amazonaws.com.cn.
|
18
|
+
|
19
|
+
1.24.0 (2021-07-07)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - This release add storage configuration APIs for AWS IoT SiteWise.
|
23
|
+
|
4
24
|
1.23.0 (2021-05-27)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.27.0
|
data/lib/aws-sdk-iotsitewise.rb
CHANGED
@@ -329,7 +329,7 @@ module Aws::IoTSiteWise
|
|
329
329
|
|
330
330
|
# Associates a child asset with the given parent asset through a
|
331
331
|
# hierarchy defined in the parent asset's model. For more information,
|
332
|
-
# see [Associating assets][1] in the *
|
332
|
+
# see [Associating assets][1] in the *IoT SiteWise User Guide*.
|
333
333
|
#
|
334
334
|
#
|
335
335
|
#
|
@@ -342,7 +342,7 @@ module Aws::IoTSiteWise
|
|
342
342
|
# The ID of a hierarchy in the parent asset's model. Hierarchies allow
|
343
343
|
# different groupings of assets to be formed that all come from the same
|
344
344
|
# asset model. For more information, see [Asset hierarchies][1] in the
|
345
|
-
# *
|
345
|
+
# *IoT SiteWise User Guide*.
|
346
346
|
#
|
347
347
|
#
|
348
348
|
#
|
@@ -377,7 +377,7 @@ module Aws::IoTSiteWise
|
|
377
377
|
req.send_request(options)
|
378
378
|
end
|
379
379
|
|
380
|
-
# Associates a group (batch) of assets with an
|
380
|
+
# Associates a group (batch) of assets with an IoT SiteWise Monitor
|
381
381
|
# project.
|
382
382
|
#
|
383
383
|
# @option params [required, String] :project_id
|
@@ -420,8 +420,8 @@ module Aws::IoTSiteWise
|
|
420
420
|
req.send_request(options)
|
421
421
|
end
|
422
422
|
|
423
|
-
# Disassociates a group (batch) of assets from an
|
424
|
-
#
|
423
|
+
# Disassociates a group (batch) of assets from an IoT SiteWise Monitor
|
424
|
+
# project.
|
425
425
|
#
|
426
426
|
# @option params [required, String] :project_id
|
427
427
|
# The ID of the project from which to disassociate the assets.
|
@@ -463,10 +463,9 @@ module Aws::IoTSiteWise
|
|
463
463
|
req.send_request(options)
|
464
464
|
end
|
465
465
|
|
466
|
-
# Sends a list of asset property values to
|
467
|
-
#
|
468
|
-
#
|
469
|
-
# Guide*.
|
466
|
+
# Sends a list of asset property values to IoT SiteWise. Each value is a
|
467
|
+
# timestamp-quality-value (TQV) data point. For more information, see
|
468
|
+
# [Ingesting data using the API][1] in the *IoT SiteWise User Guide*.
|
470
469
|
#
|
471
470
|
# To identify an asset property, you must specify one of the following:
|
472
471
|
#
|
@@ -476,21 +475,21 @@ module Aws::IoTSiteWise
|
|
476
475
|
# `/company/windfarm/3/turbine/7/temperature`). To define an asset
|
477
476
|
# property's alias, see [UpdateAssetProperty][2].
|
478
477
|
#
|
479
|
-
# With respect to Unix epoch time,
|
480
|
-
#
|
481
|
-
#
|
482
|
-
#
|
483
|
-
#
|
478
|
+
# With respect to Unix epoch time, IoT SiteWise accepts only TQVs that
|
479
|
+
# have a timestamp of no more than 7 days in the past and no more than
|
480
|
+
# 10 minutes in the future. IoT SiteWise rejects timestamps outside of
|
481
|
+
# the inclusive range of \[-7 days, +10 minutes\] and returns a
|
482
|
+
# `TimestampOutOfRangeException` error.
|
484
483
|
#
|
485
|
-
# For each asset property,
|
486
|
-
#
|
487
|
-
#
|
488
|
-
#
|
484
|
+
# For each asset property, IoT SiteWise overwrites TQVs with duplicate
|
485
|
+
# timestamps unless the newer TQV has a different quality. For example,
|
486
|
+
# if you store a TQV `\{T1, GOOD, V1\}`, then storing `\{T1, GOOD, V2\}`
|
487
|
+
# replaces the existing TQV.
|
489
488
|
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
489
|
+
# IoT SiteWise authorizes access to each `BatchPutAssetPropertyValue`
|
490
|
+
# entry individually. For more information, see
|
491
|
+
# [BatchPutAssetPropertyValue authorization][3] in the *IoT SiteWise
|
492
|
+
# User Guide*.
|
494
493
|
#
|
495
494
|
#
|
496
495
|
#
|
@@ -552,16 +551,17 @@ module Aws::IoTSiteWise
|
|
552
551
|
req.send_request(options)
|
553
552
|
end
|
554
553
|
|
555
|
-
# Creates an access policy that grants the specified identity (
|
556
|
-
# user,
|
557
|
-
# SiteWise Monitor portal or project
|
554
|
+
# Creates an access policy that grants the specified identity (Amazon
|
555
|
+
# Web Services SSO user, Amazon Web Services SSO group, or IAM user)
|
556
|
+
# access to the specified IoT SiteWise Monitor portal or project
|
557
|
+
# resource.
|
558
558
|
#
|
559
559
|
# @option params [required, Types::Identity] :access_policy_identity
|
560
|
-
# The identity for this access policy. Choose an
|
561
|
-
# SSO group, or an IAM user.
|
560
|
+
# The identity for this access policy. Choose an Amazon Web Services SSO
|
561
|
+
# user, an Amazon Web Services SSO group, or an IAM user.
|
562
562
|
#
|
563
563
|
# @option params [required, Types::Resource] :access_policy_resource
|
564
|
-
# The
|
564
|
+
# The IoT SiteWise Monitor resource for this access policy. Choose
|
565
565
|
# either a portal or a project.
|
566
566
|
#
|
567
567
|
# @option params [required, String] :access_policy_permission
|
@@ -578,8 +578,8 @@ module Aws::IoTSiteWise
|
|
578
578
|
#
|
579
579
|
# @option params [Hash<String,String>] :tags
|
580
580
|
# A list of key-value pairs that contain metadata for the access policy.
|
581
|
-
# For more information, see [Tagging your
|
582
|
-
#
|
581
|
+
# For more information, see [Tagging your IoT SiteWise resources][1] in
|
582
|
+
# the *IoT SiteWise User Guide*.
|
583
583
|
#
|
584
584
|
#
|
585
585
|
#
|
@@ -635,7 +635,7 @@ module Aws::IoTSiteWise
|
|
635
635
|
end
|
636
636
|
|
637
637
|
# Creates an asset from an existing asset model. For more information,
|
638
|
-
# see [Creating assets][1] in the *
|
638
|
+
# see [Creating assets][1] in the *IoT SiteWise User Guide*.
|
639
639
|
#
|
640
640
|
#
|
641
641
|
#
|
@@ -657,8 +657,8 @@ module Aws::IoTSiteWise
|
|
657
657
|
#
|
658
658
|
# @option params [Hash<String,String>] :tags
|
659
659
|
# A list of key-value pairs that contain metadata for the asset. For
|
660
|
-
# more information, see [Tagging your
|
661
|
-
#
|
660
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
661
|
+
# *IoT SiteWise User Guide*.
|
662
662
|
#
|
663
663
|
#
|
664
664
|
#
|
@@ -688,6 +688,9 @@ module Aws::IoTSiteWise
|
|
688
688
|
# resp.asset_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
689
689
|
# resp.asset_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
690
690
|
# resp.asset_status.error.message #=> String
|
691
|
+
# resp.asset_status.error.details #=> Array
|
692
|
+
# resp.asset_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
693
|
+
# resp.asset_status.error.details[0].message #=> String
|
691
694
|
#
|
692
695
|
# @overload create_asset(params = {})
|
693
696
|
# @param [Hash] params ({})
|
@@ -701,7 +704,7 @@ module Aws::IoTSiteWise
|
|
701
704
|
# you can easily create assets of the same type that have standardized
|
702
705
|
# definitions. Each asset created from a model inherits the asset
|
703
706
|
# model's property and hierarchy definitions. For more information, see
|
704
|
-
# [Defining asset models][1] in the *
|
707
|
+
# [Defining asset models][1] in the *IoT SiteWise User Guide*.
|
705
708
|
#
|
706
709
|
#
|
707
710
|
#
|
@@ -715,10 +718,10 @@ module Aws::IoTSiteWise
|
|
715
718
|
#
|
716
719
|
# @option params [Array<Types::AssetModelPropertyDefinition>] :asset_model_properties
|
717
720
|
# The property definitions of the asset model. For more information, see
|
718
|
-
# [Asset properties][1] in the *
|
721
|
+
# [Asset properties][1] in the *IoT SiteWise User Guide*.
|
719
722
|
#
|
720
723
|
# You can specify up to 200 properties per asset model. For more
|
721
|
-
# information, see [Quotas][2] in the *
|
724
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
722
725
|
#
|
723
726
|
#
|
724
727
|
#
|
@@ -729,10 +732,10 @@ module Aws::IoTSiteWise
|
|
729
732
|
# The hierarchy definitions of the asset model. Each hierarchy specifies
|
730
733
|
# an asset model whose assets can be children of any other assets
|
731
734
|
# created from this asset model. For more information, see [Asset
|
732
|
-
# hierarchies][1] in the *
|
735
|
+
# hierarchies][1] in the *IoT SiteWise User Guide*.
|
733
736
|
#
|
734
737
|
# You can specify up to 10 hierarchies per asset model. For more
|
735
|
-
# information, see [Quotas][2] in the *
|
738
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
736
739
|
#
|
737
740
|
#
|
738
741
|
#
|
@@ -756,8 +759,8 @@ module Aws::IoTSiteWise
|
|
756
759
|
#
|
757
760
|
# @option params [Hash<String,String>] :tags
|
758
761
|
# A list of key-value pairs that contain metadata for the asset model.
|
759
|
-
# For more information, see [Tagging your
|
760
|
-
#
|
762
|
+
# For more information, see [Tagging your IoT SiteWise resources][1] in
|
763
|
+
# the *IoT SiteWise User Guide*.
|
761
764
|
#
|
762
765
|
#
|
763
766
|
#
|
@@ -785,6 +788,11 @@ module Aws::IoTSiteWise
|
|
785
788
|
# default_value: "DefaultValue",
|
786
789
|
# },
|
787
790
|
# measurement: {
|
791
|
+
# processing_config: {
|
792
|
+
# forwarding_config: { # required
|
793
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
794
|
+
# },
|
795
|
+
# },
|
788
796
|
# },
|
789
797
|
# transform: {
|
790
798
|
# expression: "Expression", # required
|
@@ -797,6 +805,12 @@ module Aws::IoTSiteWise
|
|
797
805
|
# },
|
798
806
|
# },
|
799
807
|
# ],
|
808
|
+
# processing_config: {
|
809
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
810
|
+
# forwarding_config: {
|
811
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
812
|
+
# },
|
813
|
+
# },
|
800
814
|
# },
|
801
815
|
# metric: {
|
802
816
|
# expression: "Expression", # required
|
@@ -814,6 +828,9 @@ module Aws::IoTSiteWise
|
|
814
828
|
# interval: "Interval", # required
|
815
829
|
# },
|
816
830
|
# },
|
831
|
+
# processing_config: {
|
832
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
833
|
+
# },
|
817
834
|
# },
|
818
835
|
# },
|
819
836
|
# },
|
@@ -840,6 +857,11 @@ module Aws::IoTSiteWise
|
|
840
857
|
# default_value: "DefaultValue",
|
841
858
|
# },
|
842
859
|
# measurement: {
|
860
|
+
# processing_config: {
|
861
|
+
# forwarding_config: { # required
|
862
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
863
|
+
# },
|
864
|
+
# },
|
843
865
|
# },
|
844
866
|
# transform: {
|
845
867
|
# expression: "Expression", # required
|
@@ -852,6 +874,12 @@ module Aws::IoTSiteWise
|
|
852
874
|
# },
|
853
875
|
# },
|
854
876
|
# ],
|
877
|
+
# processing_config: {
|
878
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
879
|
+
# forwarding_config: {
|
880
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
881
|
+
# },
|
882
|
+
# },
|
855
883
|
# },
|
856
884
|
# metric: {
|
857
885
|
# expression: "Expression", # required
|
@@ -869,6 +897,9 @@ module Aws::IoTSiteWise
|
|
869
897
|
# interval: "Interval", # required
|
870
898
|
# },
|
871
899
|
# },
|
900
|
+
# processing_config: {
|
901
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
902
|
+
# },
|
872
903
|
# },
|
873
904
|
# },
|
874
905
|
# },
|
@@ -888,6 +919,9 @@ module Aws::IoTSiteWise
|
|
888
919
|
# resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
|
889
920
|
# resp.asset_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
890
921
|
# resp.asset_model_status.error.message #=> String
|
922
|
+
# resp.asset_model_status.error.details #=> Array
|
923
|
+
# resp.asset_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
924
|
+
# resp.asset_model_status.error.details[0].message #=> String
|
891
925
|
#
|
892
926
|
# @overload create_asset_model(params = {})
|
893
927
|
# @param [Hash] params ({})
|
@@ -896,7 +930,7 @@ module Aws::IoTSiteWise
|
|
896
930
|
req.send_request(options)
|
897
931
|
end
|
898
932
|
|
899
|
-
# Creates a dashboard in an
|
933
|
+
# Creates a dashboard in an IoT SiteWise Monitor project.
|
900
934
|
#
|
901
935
|
# @option params [required, String] :project_id
|
902
936
|
# The ID of the project in which to create the dashboard.
|
@@ -909,8 +943,8 @@ module Aws::IoTSiteWise
|
|
909
943
|
#
|
910
944
|
# @option params [required, String] :dashboard_definition
|
911
945
|
# The dashboard definition specified in a JSON literal. For detailed
|
912
|
-
# information, see [Creating dashboards (CLI)][1] in the *
|
913
|
-
#
|
946
|
+
# information, see [Creating dashboards (CLI)][1] in the *IoT SiteWise
|
947
|
+
# User Guide*.
|
914
948
|
#
|
915
949
|
#
|
916
950
|
#
|
@@ -926,8 +960,8 @@ module Aws::IoTSiteWise
|
|
926
960
|
#
|
927
961
|
# @option params [Hash<String,String>] :tags
|
928
962
|
# A list of key-value pairs that contain metadata for the dashboard. For
|
929
|
-
# more information, see [Tagging your
|
930
|
-
#
|
963
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
964
|
+
# *IoT SiteWise User Guide*.
|
931
965
|
#
|
932
966
|
#
|
933
967
|
#
|
@@ -964,9 +998,9 @@ module Aws::IoTSiteWise
|
|
964
998
|
end
|
965
999
|
|
966
1000
|
# Creates a gateway, which is a virtual or edge device that delivers
|
967
|
-
# industrial data streams from local servers to
|
968
|
-
#
|
969
|
-
#
|
1001
|
+
# industrial data streams from local servers to IoT SiteWise. For more
|
1002
|
+
# information, see [Ingesting data using a gateway][1] in the *IoT
|
1003
|
+
# SiteWise User Guide*.
|
970
1004
|
#
|
971
1005
|
#
|
972
1006
|
#
|
@@ -981,8 +1015,8 @@ module Aws::IoTSiteWise
|
|
981
1015
|
#
|
982
1016
|
# @option params [Hash<String,String>] :tags
|
983
1017
|
# A list of key-value pairs that contain metadata for the gateway. For
|
984
|
-
# more information, see [Tagging your
|
985
|
-
#
|
1018
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
1019
|
+
# *IoT SiteWise User Guide*.
|
986
1020
|
#
|
987
1021
|
#
|
988
1022
|
#
|
@@ -998,9 +1032,12 @@ module Aws::IoTSiteWise
|
|
998
1032
|
# resp = client.create_gateway({
|
999
1033
|
# gateway_name: "Name", # required
|
1000
1034
|
# gateway_platform: { # required
|
1001
|
-
# greengrass: {
|
1035
|
+
# greengrass: {
|
1002
1036
|
# group_arn: "ARN", # required
|
1003
1037
|
# },
|
1038
|
+
# greengrass_v2: {
|
1039
|
+
# core_device_thing_name: "CoreDeviceThingName", # required
|
1040
|
+
# },
|
1004
1041
|
# },
|
1005
1042
|
# tags: {
|
1006
1043
|
# "TagKey" => "TagValue",
|
@@ -1019,13 +1056,13 @@ module Aws::IoTSiteWise
|
|
1019
1056
|
req.send_request(options)
|
1020
1057
|
end
|
1021
1058
|
|
1022
|
-
# Creates a portal, which can contain projects and dashboards.
|
1023
|
-
# SiteWise Monitor uses
|
1024
|
-
# manage user permissions.
|
1059
|
+
# Creates a portal, which can contain projects and dashboards. IoT
|
1060
|
+
# SiteWise Monitor uses Amazon Web Services SSO or IAM to authenticate
|
1061
|
+
# portal users and manage user permissions.
|
1025
1062
|
#
|
1026
1063
|
# <note markdown="1"> Before you can sign in to a new portal, you must add at least one
|
1027
1064
|
# identity to that portal. For more information, see [Adding or removing
|
1028
|
-
# portal administrators][1] in the *
|
1065
|
+
# portal administrators][1] in the *IoT SiteWise User Guide*.
|
1029
1066
|
#
|
1030
1067
|
# </note>
|
1031
1068
|
#
|
@@ -1040,7 +1077,7 @@ module Aws::IoTSiteWise
|
|
1040
1077
|
# A description for the portal.
|
1041
1078
|
#
|
1042
1079
|
# @option params [required, String] :portal_contact_email
|
1043
|
-
# The
|
1080
|
+
# The Amazon Web Services administrator's contact email address.
|
1044
1081
|
#
|
1045
1082
|
# @option params [String] :client_token
|
1046
1083
|
# A unique case-sensitive identifier that you can provide to ensure the
|
@@ -1056,9 +1093,9 @@ module Aws::IoTSiteWise
|
|
1056
1093
|
#
|
1057
1094
|
# @option params [required, String] :role_arn
|
1058
1095
|
# The [ARN][1] of a service role that allows the portal's users to
|
1059
|
-
# access your
|
1060
|
-
# information, see [Using service roles for
|
1061
|
-
#
|
1096
|
+
# access your IoT SiteWise resources on your behalf. For more
|
1097
|
+
# information, see [Using service roles for IoT SiteWise Monitor][2] in
|
1098
|
+
# the *IoT SiteWise User Guide*.
|
1062
1099
|
#
|
1063
1100
|
#
|
1064
1101
|
#
|
@@ -1067,8 +1104,8 @@ module Aws::IoTSiteWise
|
|
1067
1104
|
#
|
1068
1105
|
# @option params [Hash<String,String>] :tags
|
1069
1106
|
# A list of key-value pairs that contain metadata for the portal. For
|
1070
|
-
# more information, see [Tagging your
|
1071
|
-
#
|
1107
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
1108
|
+
# *IoT SiteWise User Guide*.
|
1072
1109
|
#
|
1073
1110
|
#
|
1074
1111
|
#
|
@@ -1078,14 +1115,15 @@ module Aws::IoTSiteWise
|
|
1078
1115
|
# The service to use to authenticate users to the portal. Choose from
|
1079
1116
|
# the following options:
|
1080
1117
|
#
|
1081
|
-
# * `SSO` – The portal uses
|
1082
|
-
# manage user permissions. Before you can
|
1083
|
-
#
|
1084
|
-
#
|
1085
|
-
#
|
1086
|
-
# Regions
|
1118
|
+
# * `SSO` – The portal uses Amazon Web Services Single Sign On to
|
1119
|
+
# authenticate users and manage user permissions. Before you can
|
1120
|
+
# create a portal that uses Amazon Web Services SSO, you must enable
|
1121
|
+
# Amazon Web Services SSO. For more information, see [Enabling Amazon
|
1122
|
+
# Web Services SSO][1] in the *IoT SiteWise User Guide*. This option
|
1123
|
+
# is only available in Amazon Web Services Regions other than the
|
1124
|
+
# China Regions.
|
1087
1125
|
#
|
1088
|
-
# * `IAM` – The portal uses
|
1126
|
+
# * `IAM` – The portal uses Identity and Access Management to
|
1089
1127
|
# authenticate users and manage user permissions. This option is only
|
1090
1128
|
# available in the China Regions.
|
1091
1129
|
#
|
@@ -1100,19 +1138,24 @@ module Aws::IoTSiteWise
|
|
1100
1138
|
# @option params [String] :notification_sender_email
|
1101
1139
|
# The email address that sends alarm notifications.
|
1102
1140
|
#
|
1103
|
-
# If you use the
|
1104
|
-
#
|
1105
|
-
# SES][1].
|
1141
|
+
# If you use the [IoT Events managed Lambda function][1] to manage your
|
1142
|
+
# emails, you must [verify the sender email address in Amazon SES][2].
|
1106
1143
|
#
|
1107
1144
|
#
|
1108
1145
|
#
|
1109
|
-
# [1]: https://docs.aws.amazon.com/
|
1146
|
+
# [1]: https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html
|
1147
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html
|
1110
1148
|
#
|
1111
1149
|
# @option params [Types::Alarms] :alarms
|
1112
|
-
# Contains the configuration information of an alarm created in an
|
1113
|
-
#
|
1150
|
+
# Contains the configuration information of an alarm created in an IoT
|
1151
|
+
# SiteWise Monitor portal. You can use the alarm to monitor an asset
|
1114
1152
|
# property and get notified when the asset property value is outside a
|
1115
|
-
# specified range. For more information, see
|
1153
|
+
# specified range. For more information, see [Monitoring with alarms][1]
|
1154
|
+
# in the *IoT SiteWise Application Guide*.
|
1155
|
+
#
|
1156
|
+
#
|
1157
|
+
#
|
1158
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
|
1116
1159
|
#
|
1117
1160
|
# @return [Types::CreatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1118
1161
|
#
|
@@ -1183,8 +1226,8 @@ module Aws::IoTSiteWise
|
|
1183
1226
|
#
|
1184
1227
|
# @option params [Hash<String,String>] :tags
|
1185
1228
|
# A list of key-value pairs that contain metadata for the project. For
|
1186
|
-
# more information, see [Tagging your
|
1187
|
-
#
|
1229
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
1230
|
+
# *IoT SiteWise User Guide*.
|
1188
1231
|
#
|
1189
1232
|
#
|
1190
1233
|
#
|
@@ -1220,8 +1263,8 @@ module Aws::IoTSiteWise
|
|
1220
1263
|
end
|
1221
1264
|
|
1222
1265
|
# Deletes an access policy that grants the specified identity access to
|
1223
|
-
# the specified
|
1224
|
-
# operation to revoke access to an
|
1266
|
+
# the specified IoT SiteWise Monitor resource. You can use this
|
1267
|
+
# operation to revoke access to an IoT SiteWise Monitor resource.
|
1225
1268
|
#
|
1226
1269
|
# @option params [required, String] :access_policy_id
|
1227
1270
|
# The ID of the access policy to be deleted.
|
@@ -1251,8 +1294,7 @@ module Aws::IoTSiteWise
|
|
1251
1294
|
end
|
1252
1295
|
|
1253
1296
|
# Deletes an asset. This action can't be undone. For more information,
|
1254
|
-
# see [Deleting assets and models][1] in the *
|
1255
|
-
# Guide*.
|
1297
|
+
# see [Deleting assets and models][1] in the *IoT SiteWise User Guide*.
|
1256
1298
|
#
|
1257
1299
|
# <note markdown="1"> You can't delete an asset that's associated to another asset. For
|
1258
1300
|
# more information, see [DisassociateAssets][2].
|
@@ -1291,6 +1333,9 @@ module Aws::IoTSiteWise
|
|
1291
1333
|
# resp.asset_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
1292
1334
|
# resp.asset_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
1293
1335
|
# resp.asset_status.error.message #=> String
|
1336
|
+
# resp.asset_status.error.details #=> Array
|
1337
|
+
# resp.asset_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
1338
|
+
# resp.asset_status.error.details[0].message #=> String
|
1294
1339
|
#
|
1295
1340
|
# @overload delete_asset(params = {})
|
1296
1341
|
# @param [Hash] params ({})
|
@@ -1304,7 +1349,7 @@ module Aws::IoTSiteWise
|
|
1304
1349
|
# model. Also, you can't delete an asset model if a parent asset model
|
1305
1350
|
# exists that contains a property formula expression that depends on the
|
1306
1351
|
# asset model that you want to delete. For more information, see
|
1307
|
-
# [Deleting assets and models][1] in the *
|
1352
|
+
# [Deleting assets and models][1] in the *IoT SiteWise User Guide*.
|
1308
1353
|
#
|
1309
1354
|
#
|
1310
1355
|
#
|
@@ -1337,6 +1382,9 @@ module Aws::IoTSiteWise
|
|
1337
1382
|
# resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
|
1338
1383
|
# resp.asset_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
1339
1384
|
# resp.asset_model_status.error.message #=> String
|
1385
|
+
# resp.asset_model_status.error.details #=> Array
|
1386
|
+
# resp.asset_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
1387
|
+
# resp.asset_model_status.error.details[0].message #=> String
|
1340
1388
|
#
|
1341
1389
|
# @overload delete_asset_model(params = {})
|
1342
1390
|
# @param [Hash] params ({})
|
@@ -1345,7 +1393,7 @@ module Aws::IoTSiteWise
|
|
1345
1393
|
req.send_request(options)
|
1346
1394
|
end
|
1347
1395
|
|
1348
|
-
# Deletes a dashboard from
|
1396
|
+
# Deletes a dashboard from IoT SiteWise Monitor.
|
1349
1397
|
#
|
1350
1398
|
# @option params [required, String] :dashboard_id
|
1351
1399
|
# The ID of the dashboard to delete.
|
@@ -1374,8 +1422,8 @@ module Aws::IoTSiteWise
|
|
1374
1422
|
req.send_request(options)
|
1375
1423
|
end
|
1376
1424
|
|
1377
|
-
# Deletes a gateway from
|
1378
|
-
#
|
1425
|
+
# Deletes a gateway from IoT SiteWise. When you delete a gateway, some
|
1426
|
+
# of the gateway's files remain in your gateway's file system.
|
1379
1427
|
#
|
1380
1428
|
# @option params [required, String] :gateway_id
|
1381
1429
|
# The ID of the gateway to delete.
|
@@ -1395,7 +1443,7 @@ module Aws::IoTSiteWise
|
|
1395
1443
|
req.send_request(options)
|
1396
1444
|
end
|
1397
1445
|
|
1398
|
-
# Deletes a portal from
|
1446
|
+
# Deletes a portal from IoT SiteWise Monitor.
|
1399
1447
|
#
|
1400
1448
|
# @option params [required, String] :portal_id
|
1401
1449
|
# The ID of the portal to delete.
|
@@ -1432,7 +1480,7 @@ module Aws::IoTSiteWise
|
|
1432
1480
|
req.send_request(options)
|
1433
1481
|
end
|
1434
1482
|
|
1435
|
-
# Deletes a project from
|
1483
|
+
# Deletes a project from IoT SiteWise Monitor.
|
1436
1484
|
#
|
1437
1485
|
# @option params [required, String] :project_id
|
1438
1486
|
# The ID of the project.
|
@@ -1462,7 +1510,7 @@ module Aws::IoTSiteWise
|
|
1462
1510
|
end
|
1463
1511
|
|
1464
1512
|
# Describes an access policy, which specifies an identity's access to
|
1465
|
-
# an
|
1513
|
+
# an IoT SiteWise Monitor portal or project.
|
1466
1514
|
#
|
1467
1515
|
# @option params [required, String] :access_policy_id
|
1468
1516
|
# The ID of the access policy.
|
@@ -1564,6 +1612,9 @@ module Aws::IoTSiteWise
|
|
1564
1612
|
# resp.asset_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
1565
1613
|
# resp.asset_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
1566
1614
|
# resp.asset_status.error.message #=> String
|
1615
|
+
# resp.asset_status.error.details #=> Array
|
1616
|
+
# resp.asset_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
1617
|
+
# resp.asset_status.error.details[0].message #=> String
|
1567
1618
|
#
|
1568
1619
|
#
|
1569
1620
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -1615,17 +1666,21 @@ module Aws::IoTSiteWise
|
|
1615
1666
|
# resp.asset_model_properties[0].data_type_spec #=> String
|
1616
1667
|
# resp.asset_model_properties[0].unit #=> String
|
1617
1668
|
# resp.asset_model_properties[0].type.attribute.default_value #=> String
|
1669
|
+
# resp.asset_model_properties[0].type.measurement.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
|
1618
1670
|
# resp.asset_model_properties[0].type.transform.expression #=> String
|
1619
1671
|
# resp.asset_model_properties[0].type.transform.variables #=> Array
|
1620
1672
|
# resp.asset_model_properties[0].type.transform.variables[0].name #=> String
|
1621
1673
|
# resp.asset_model_properties[0].type.transform.variables[0].value.property_id #=> String
|
1622
1674
|
# resp.asset_model_properties[0].type.transform.variables[0].value.hierarchy_id #=> String
|
1675
|
+
# resp.asset_model_properties[0].type.transform.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
|
1676
|
+
# resp.asset_model_properties[0].type.transform.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
|
1623
1677
|
# resp.asset_model_properties[0].type.metric.expression #=> String
|
1624
1678
|
# resp.asset_model_properties[0].type.metric.variables #=> Array
|
1625
1679
|
# resp.asset_model_properties[0].type.metric.variables[0].name #=> String
|
1626
1680
|
# resp.asset_model_properties[0].type.metric.variables[0].value.property_id #=> String
|
1627
1681
|
# resp.asset_model_properties[0].type.metric.variables[0].value.hierarchy_id #=> String
|
1628
1682
|
# resp.asset_model_properties[0].type.metric.window.tumbling.interval #=> String
|
1683
|
+
# resp.asset_model_properties[0].type.metric.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
|
1629
1684
|
# resp.asset_model_hierarchies #=> Array
|
1630
1685
|
# resp.asset_model_hierarchies[0].id #=> String
|
1631
1686
|
# resp.asset_model_hierarchies[0].name #=> String
|
@@ -1641,22 +1696,29 @@ module Aws::IoTSiteWise
|
|
1641
1696
|
# resp.asset_model_composite_models[0].properties[0].data_type_spec #=> String
|
1642
1697
|
# resp.asset_model_composite_models[0].properties[0].unit #=> String
|
1643
1698
|
# resp.asset_model_composite_models[0].properties[0].type.attribute.default_value #=> String
|
1699
|
+
# resp.asset_model_composite_models[0].properties[0].type.measurement.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
|
1644
1700
|
# resp.asset_model_composite_models[0].properties[0].type.transform.expression #=> String
|
1645
1701
|
# resp.asset_model_composite_models[0].properties[0].type.transform.variables #=> Array
|
1646
1702
|
# resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].name #=> String
|
1647
1703
|
# resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].value.property_id #=> String
|
1648
1704
|
# resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].value.hierarchy_id #=> String
|
1705
|
+
# resp.asset_model_composite_models[0].properties[0].type.transform.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
|
1706
|
+
# resp.asset_model_composite_models[0].properties[0].type.transform.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
|
1649
1707
|
# resp.asset_model_composite_models[0].properties[0].type.metric.expression #=> String
|
1650
1708
|
# resp.asset_model_composite_models[0].properties[0].type.metric.variables #=> Array
|
1651
1709
|
# resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].name #=> String
|
1652
1710
|
# resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].value.property_id #=> String
|
1653
1711
|
# resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].value.hierarchy_id #=> String
|
1654
1712
|
# resp.asset_model_composite_models[0].properties[0].type.metric.window.tumbling.interval #=> String
|
1713
|
+
# resp.asset_model_composite_models[0].properties[0].type.metric.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
|
1655
1714
|
# resp.asset_model_creation_date #=> Time
|
1656
1715
|
# resp.asset_model_last_update_date #=> Time
|
1657
1716
|
# resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
|
1658
1717
|
# resp.asset_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
1659
1718
|
# resp.asset_model_status.error.message #=> String
|
1719
|
+
# resp.asset_model_status.error.details #=> Array
|
1720
|
+
# resp.asset_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
1721
|
+
# resp.asset_model_status.error.details[0].message #=> String
|
1660
1722
|
#
|
1661
1723
|
#
|
1662
1724
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -1721,17 +1783,21 @@ module Aws::IoTSiteWise
|
|
1721
1783
|
# resp.asset_property.data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1722
1784
|
# resp.asset_property.unit #=> String
|
1723
1785
|
# resp.asset_property.type.attribute.default_value #=> String
|
1786
|
+
# resp.asset_property.type.measurement.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
|
1724
1787
|
# resp.asset_property.type.transform.expression #=> String
|
1725
1788
|
# resp.asset_property.type.transform.variables #=> Array
|
1726
1789
|
# resp.asset_property.type.transform.variables[0].name #=> String
|
1727
1790
|
# resp.asset_property.type.transform.variables[0].value.property_id #=> String
|
1728
1791
|
# resp.asset_property.type.transform.variables[0].value.hierarchy_id #=> String
|
1792
|
+
# resp.asset_property.type.transform.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
|
1793
|
+
# resp.asset_property.type.transform.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
|
1729
1794
|
# resp.asset_property.type.metric.expression #=> String
|
1730
1795
|
# resp.asset_property.type.metric.variables #=> Array
|
1731
1796
|
# resp.asset_property.type.metric.variables[0].name #=> String
|
1732
1797
|
# resp.asset_property.type.metric.variables[0].value.property_id #=> String
|
1733
1798
|
# resp.asset_property.type.metric.variables[0].value.hierarchy_id #=> String
|
1734
1799
|
# resp.asset_property.type.metric.window.tumbling.interval #=> String
|
1800
|
+
# resp.asset_property.type.metric.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
|
1735
1801
|
# resp.composite_model.name #=> String
|
1736
1802
|
# resp.composite_model.type #=> String
|
1737
1803
|
# resp.composite_model.asset_property.id #=> String
|
@@ -1742,17 +1808,21 @@ module Aws::IoTSiteWise
|
|
1742
1808
|
# resp.composite_model.asset_property.data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
1743
1809
|
# resp.composite_model.asset_property.unit #=> String
|
1744
1810
|
# resp.composite_model.asset_property.type.attribute.default_value #=> String
|
1811
|
+
# resp.composite_model.asset_property.type.measurement.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
|
1745
1812
|
# resp.composite_model.asset_property.type.transform.expression #=> String
|
1746
1813
|
# resp.composite_model.asset_property.type.transform.variables #=> Array
|
1747
1814
|
# resp.composite_model.asset_property.type.transform.variables[0].name #=> String
|
1748
1815
|
# resp.composite_model.asset_property.type.transform.variables[0].value.property_id #=> String
|
1749
1816
|
# resp.composite_model.asset_property.type.transform.variables[0].value.hierarchy_id #=> String
|
1817
|
+
# resp.composite_model.asset_property.type.transform.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
|
1818
|
+
# resp.composite_model.asset_property.type.transform.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
|
1750
1819
|
# resp.composite_model.asset_property.type.metric.expression #=> String
|
1751
1820
|
# resp.composite_model.asset_property.type.metric.variables #=> Array
|
1752
1821
|
# resp.composite_model.asset_property.type.metric.variables[0].name #=> String
|
1753
1822
|
# resp.composite_model.asset_property.type.metric.variables[0].value.property_id #=> String
|
1754
1823
|
# resp.composite_model.asset_property.type.metric.variables[0].value.hierarchy_id #=> String
|
1755
1824
|
# resp.composite_model.asset_property.type.metric.window.tumbling.interval #=> String
|
1825
|
+
# resp.composite_model.asset_property.type.metric.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
|
1756
1826
|
#
|
1757
1827
|
# @overload describe_asset_property(params = {})
|
1758
1828
|
# @param [Hash] params ({})
|
@@ -1802,9 +1872,9 @@ module Aws::IoTSiteWise
|
|
1802
1872
|
end
|
1803
1873
|
|
1804
1874
|
# Retrieves information about the default encryption configuration for
|
1805
|
-
# the
|
1806
|
-
# information, see [Key management][1] in the *
|
1807
|
-
# Guide*.
|
1875
|
+
# the Amazon Web Services account in the default or specified Region.
|
1876
|
+
# For more information, see [Key management][1] in the *IoT SiteWise
|
1877
|
+
# User Guide*.
|
1808
1878
|
#
|
1809
1879
|
#
|
1810
1880
|
#
|
@@ -1858,9 +1928,10 @@ module Aws::IoTSiteWise
|
|
1858
1928
|
# resp.gateway_name #=> String
|
1859
1929
|
# resp.gateway_arn #=> String
|
1860
1930
|
# resp.gateway_platform.greengrass.group_arn #=> String
|
1931
|
+
# resp.gateway_platform.greengrass_v2.core_device_thing_name #=> String
|
1861
1932
|
# resp.gateway_capability_summaries #=> Array
|
1862
1933
|
# resp.gateway_capability_summaries[0].capability_namespace #=> String
|
1863
|
-
# resp.gateway_capability_summaries[0].capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED"
|
1934
|
+
# resp.gateway_capability_summaries[0].capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", "UNKNOWN"
|
1864
1935
|
# resp.creation_date #=> Time
|
1865
1936
|
# resp.last_update_date #=> Time
|
1866
1937
|
#
|
@@ -1874,9 +1945,9 @@ module Aws::IoTSiteWise
|
|
1874
1945
|
# Retrieves information about a gateway capability configuration. Each
|
1875
1946
|
# gateway capability defines data sources for a gateway. A capability
|
1876
1947
|
# configuration can contain multiple data source configurations. If you
|
1877
|
-
# define OPC-UA sources for a gateway in the
|
1878
|
-
#
|
1879
|
-
#
|
1948
|
+
# define OPC-UA sources for a gateway in the IoT SiteWise console, all
|
1949
|
+
# of your OPC-UA sources are stored in one capability configuration. To
|
1950
|
+
# list all capability configurations for a gateway, use
|
1880
1951
|
# [DescribeGateway][1].
|
1881
1952
|
#
|
1882
1953
|
#
|
@@ -1888,8 +1959,8 @@ module Aws::IoTSiteWise
|
|
1888
1959
|
#
|
1889
1960
|
# @option params [required, String] :capability_namespace
|
1890
1961
|
# The namespace of the capability configuration. For example, if you
|
1891
|
-
# configure OPC-UA sources from the
|
1892
|
-
#
|
1962
|
+
# configure OPC-UA sources from the IoT SiteWise console, your OPC-UA
|
1963
|
+
# capability configuration has the namespace
|
1893
1964
|
# `iotsitewise:opcuacollector:version`, where `version` is a number such
|
1894
1965
|
# as `1`.
|
1895
1966
|
#
|
@@ -1912,7 +1983,7 @@ module Aws::IoTSiteWise
|
|
1912
1983
|
# resp.gateway_id #=> String
|
1913
1984
|
# resp.capability_namespace #=> String
|
1914
1985
|
# resp.capability_configuration #=> String
|
1915
|
-
# resp.capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED"
|
1986
|
+
# resp.capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", "UNKNOWN"
|
1916
1987
|
#
|
1917
1988
|
# @overload describe_gateway_capability_configuration(params = {})
|
1918
1989
|
# @param [Hash] params ({})
|
@@ -1921,7 +1992,7 @@ module Aws::IoTSiteWise
|
|
1921
1992
|
req.send_request(options)
|
1922
1993
|
end
|
1923
1994
|
|
1924
|
-
# Retrieves the current
|
1995
|
+
# Retrieves the current IoT SiteWise logging options.
|
1925
1996
|
#
|
1926
1997
|
# @return [Types::DescribeLoggingOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1927
1998
|
#
|
@@ -2040,6 +2111,39 @@ module Aws::IoTSiteWise
|
|
2040
2111
|
req.send_request(options)
|
2041
2112
|
end
|
2042
2113
|
|
2114
|
+
# Retrieves information about the storage configuration for IoT
|
2115
|
+
# SiteWise.
|
2116
|
+
#
|
2117
|
+
# <note markdown="1"> Exporting data to Amazon S3 is currently in preview release and is
|
2118
|
+
# subject to change. We recommend that you use this feature only with
|
2119
|
+
# test data, and not in production environments.
|
2120
|
+
#
|
2121
|
+
# </note>
|
2122
|
+
#
|
2123
|
+
# @return [Types::DescribeStorageConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2124
|
+
#
|
2125
|
+
# * {Types::DescribeStorageConfigurationResponse#storage_type #storage_type} => String
|
2126
|
+
# * {Types::DescribeStorageConfigurationResponse#multi_layer_storage #multi_layer_storage} => Types::MultiLayerStorage
|
2127
|
+
# * {Types::DescribeStorageConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
|
2128
|
+
# * {Types::DescribeStorageConfigurationResponse#last_update_date #last_update_date} => Time
|
2129
|
+
#
|
2130
|
+
# @example Response structure
|
2131
|
+
#
|
2132
|
+
# resp.storage_type #=> String, one of "SITEWISE_DEFAULT_STORAGE", "MULTI_LAYER_STORAGE"
|
2133
|
+
# resp.multi_layer_storage.customer_managed_s3_storage.s3_resource_arn #=> String
|
2134
|
+
# resp.multi_layer_storage.customer_managed_s3_storage.role_arn #=> String
|
2135
|
+
# resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
2136
|
+
# resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
2137
|
+
# resp.configuration_status.error.message #=> String
|
2138
|
+
# resp.last_update_date #=> Time
|
2139
|
+
#
|
2140
|
+
# @overload describe_storage_configuration(params = {})
|
2141
|
+
# @param [Hash] params ({})
|
2142
|
+
def describe_storage_configuration(params = {}, options = {})
|
2143
|
+
req = build_request(:describe_storage_configuration, params)
|
2144
|
+
req.send_request(options)
|
2145
|
+
end
|
2146
|
+
|
2043
2147
|
# Disassociates a child asset from the given parent asset through a
|
2044
2148
|
# hierarchy defined in the parent asset's model.
|
2045
2149
|
#
|
@@ -2051,7 +2155,7 @@ module Aws::IoTSiteWise
|
|
2051
2155
|
# different groupings of assets to be formed that all come from the same
|
2052
2156
|
# asset model. You can use the hierarchy ID to identify the correct
|
2053
2157
|
# asset to disassociate. For more information, see [Asset
|
2054
|
-
# hierarchies][1] in the *
|
2158
|
+
# hierarchies][1] in the *IoT SiteWise User Guide*.
|
2055
2159
|
#
|
2056
2160
|
#
|
2057
2161
|
#
|
@@ -2087,7 +2191,7 @@ module Aws::IoTSiteWise
|
|
2087
2191
|
end
|
2088
2192
|
|
2089
2193
|
# Gets aggregated values for an asset property. For more information,
|
2090
|
-
# see [Querying aggregates][1] in the *
|
2194
|
+
# see [Querying aggregates][1] in the *IoT SiteWise User Guide*.
|
2091
2195
|
#
|
2092
2196
|
# To identify an asset property, you must specify one of the following:
|
2093
2197
|
#
|
@@ -2109,11 +2213,11 @@ module Aws::IoTSiteWise
|
|
2109
2213
|
# The ID of the asset property.
|
2110
2214
|
#
|
2111
2215
|
# @option params [String] :property_alias
|
2112
|
-
# The
|
2113
|
-
#
|
2216
|
+
# The alias that identifies the property, such as an OPC-UA server data
|
2217
|
+
# stream path (for example,
|
2114
2218
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2115
2219
|
# see [Mapping industrial data streams to asset properties][1] in the
|
2116
|
-
# *
|
2220
|
+
# *IoT SiteWise User Guide*.
|
2117
2221
|
#
|
2118
2222
|
#
|
2119
2223
|
#
|
@@ -2145,7 +2249,7 @@ module Aws::IoTSiteWise
|
|
2145
2249
|
# The token to be used for the next set of paginated results.
|
2146
2250
|
#
|
2147
2251
|
# @option params [Integer] :max_results
|
2148
|
-
# The maximum number of results to
|
2252
|
+
# The maximum number of results to return for each paginated request.
|
2149
2253
|
#
|
2150
2254
|
# Default: 100
|
2151
2255
|
#
|
@@ -2193,7 +2297,7 @@ module Aws::IoTSiteWise
|
|
2193
2297
|
end
|
2194
2298
|
|
2195
2299
|
# Gets an asset property's current value. For more information, see
|
2196
|
-
# [Querying current values][1] in the *
|
2300
|
+
# [Querying current values][1] in the *IoT SiteWise User Guide*.
|
2197
2301
|
#
|
2198
2302
|
# To identify an asset property, you must specify one of the following:
|
2199
2303
|
#
|
@@ -2215,11 +2319,11 @@ module Aws::IoTSiteWise
|
|
2215
2319
|
# The ID of the asset property.
|
2216
2320
|
#
|
2217
2321
|
# @option params [String] :property_alias
|
2218
|
-
# The
|
2219
|
-
#
|
2322
|
+
# The alias that identifies the property, such as an OPC-UA server data
|
2323
|
+
# stream path (for example,
|
2220
2324
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2221
2325
|
# see [Mapping industrial data streams to asset properties][1] in the
|
2222
|
-
# *
|
2326
|
+
# *IoT SiteWise User Guide*.
|
2223
2327
|
#
|
2224
2328
|
#
|
2225
2329
|
#
|
@@ -2255,8 +2359,7 @@ module Aws::IoTSiteWise
|
|
2255
2359
|
end
|
2256
2360
|
|
2257
2361
|
# Gets the history of an asset property's values. For more information,
|
2258
|
-
# see [Querying historical values][1] in the *
|
2259
|
-
# Guide*.
|
2362
|
+
# see [Querying historical values][1] in the *IoT SiteWise User Guide*.
|
2260
2363
|
#
|
2261
2364
|
# To identify an asset property, you must specify one of the following:
|
2262
2365
|
#
|
@@ -2278,11 +2381,11 @@ module Aws::IoTSiteWise
|
|
2278
2381
|
# The ID of the asset property.
|
2279
2382
|
#
|
2280
2383
|
# @option params [String] :property_alias
|
2281
|
-
# The
|
2282
|
-
#
|
2384
|
+
# The alias that identifies the property, such as an OPC-UA server data
|
2385
|
+
# stream path (for example,
|
2283
2386
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2284
2387
|
# see [Mapping industrial data streams to asset properties][1] in the
|
2285
|
-
# *
|
2388
|
+
# *IoT SiteWise User Guide*.
|
2286
2389
|
#
|
2287
2390
|
#
|
2288
2391
|
#
|
@@ -2308,7 +2411,7 @@ module Aws::IoTSiteWise
|
|
2308
2411
|
# The token to be used for the next set of paginated results.
|
2309
2412
|
#
|
2310
2413
|
# @option params [Integer] :max_results
|
2311
|
-
# The maximum number of results to
|
2414
|
+
# The maximum number of results to return for each paginated request.
|
2312
2415
|
#
|
2313
2416
|
# Default: 100
|
2314
2417
|
#
|
@@ -2357,10 +2460,6 @@ module Aws::IoTSiteWise
|
|
2357
2460
|
# operation to return the interpolated temperature values for a wind
|
2358
2461
|
# turbine every 24 hours over a duration of 7 days.
|
2359
2462
|
#
|
2360
|
-
# <note markdown="1"> This API isn't available in China (Beijing).
|
2361
|
-
#
|
2362
|
-
# </note>
|
2363
|
-
#
|
2364
2463
|
# To identify an asset property, you must specify one of the following:
|
2365
2464
|
#
|
2366
2465
|
# * The `assetId` and `propertyId` of an asset property.
|
@@ -2380,11 +2479,11 @@ module Aws::IoTSiteWise
|
|
2380
2479
|
# The ID of the asset property.
|
2381
2480
|
#
|
2382
2481
|
# @option params [String] :property_alias
|
2383
|
-
# The
|
2384
|
-
#
|
2482
|
+
# The alias that identifies the property, such as an OPC-UA server data
|
2483
|
+
# stream path (for example,
|
2385
2484
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2386
2485
|
# see [Mapping industrial data streams to asset properties][1] in the
|
2387
|
-
# *
|
2486
|
+
# *IoT SiteWise User Guide*.
|
2388
2487
|
#
|
2389
2488
|
#
|
2390
2489
|
#
|
@@ -2417,7 +2516,7 @@ module Aws::IoTSiteWise
|
|
2417
2516
|
# The token to be used for the next set of paginated results.
|
2418
2517
|
#
|
2419
2518
|
# @option params [Integer] :max_results
|
2420
|
-
# The maximum number of results to
|
2519
|
+
# The maximum number of results to return for each paginated request. If
|
2421
2520
|
# not specified, the default value is 10.
|
2422
2521
|
#
|
2423
2522
|
# @option params [required, String] :type
|
@@ -2467,13 +2566,14 @@ module Aws::IoTSiteWise
|
|
2467
2566
|
req.send_request(options)
|
2468
2567
|
end
|
2469
2568
|
|
2470
|
-
# Retrieves a paginated list of access policies for an identity (an
|
2471
|
-
# SSO user, an
|
2472
|
-
# Monitor resource (a portal or project).
|
2569
|
+
# Retrieves a paginated list of access policies for an identity (an
|
2570
|
+
# Amazon Web Services SSO user, an Amazon Web Services SSO group, or an
|
2571
|
+
# IAM user) or an IoT SiteWise Monitor resource (a portal or project).
|
2473
2572
|
#
|
2474
2573
|
# @option params [String] :identity_type
|
2475
|
-
# The type of identity (
|
2476
|
-
# parameter is required if you
|
2574
|
+
# The type of identity (Amazon Web Services SSO user, Amazon Web
|
2575
|
+
# Services SSO group, or IAM user). This parameter is required if you
|
2576
|
+
# specify `identityId`.
|
2477
2577
|
#
|
2478
2578
|
# @option params [String] :identity_id
|
2479
2579
|
# The ID of the identity. This parameter is required if you specify
|
@@ -2500,7 +2600,7 @@ module Aws::IoTSiteWise
|
|
2500
2600
|
# The token to be used for the next set of paginated results.
|
2501
2601
|
#
|
2502
2602
|
# @option params [Integer] :max_results
|
2503
|
-
# The maximum number of results to
|
2603
|
+
# The maximum number of results to return for each paginated request.
|
2504
2604
|
#
|
2505
2605
|
# Default: 50
|
2506
2606
|
#
|
@@ -2551,7 +2651,7 @@ module Aws::IoTSiteWise
|
|
2551
2651
|
# The token to be used for the next set of paginated results.
|
2552
2652
|
#
|
2553
2653
|
# @option params [Integer] :max_results
|
2554
|
-
# The maximum number of results to
|
2654
|
+
# The maximum number of results to return for each paginated request.
|
2555
2655
|
#
|
2556
2656
|
# Default: 50
|
2557
2657
|
#
|
@@ -2581,6 +2681,9 @@ module Aws::IoTSiteWise
|
|
2581
2681
|
# resp.asset_model_summaries[0].status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
|
2582
2682
|
# resp.asset_model_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
2583
2683
|
# resp.asset_model_summaries[0].status.error.message #=> String
|
2684
|
+
# resp.asset_model_summaries[0].status.error.details #=> Array
|
2685
|
+
# resp.asset_model_summaries[0].status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
2686
|
+
# resp.asset_model_summaries[0].status.error.details[0].message #=> String
|
2584
2687
|
# resp.next_token #=> String
|
2585
2688
|
#
|
2586
2689
|
# @overload list_asset_models(params = {})
|
@@ -2612,7 +2715,7 @@ module Aws::IoTSiteWise
|
|
2612
2715
|
# The token to be used for the next set of paginated results.
|
2613
2716
|
#
|
2614
2717
|
# @option params [Integer] :max_results
|
2615
|
-
# The maximum number of results to
|
2718
|
+
# The maximum number of results to return for each paginated request.
|
2616
2719
|
#
|
2617
2720
|
# @return [Types::ListAssetRelationshipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2618
2721
|
#
|
@@ -2666,7 +2769,7 @@ module Aws::IoTSiteWise
|
|
2666
2769
|
# The token to be used for the next set of paginated results.
|
2667
2770
|
#
|
2668
2771
|
# @option params [Integer] :max_results
|
2669
|
-
# The maximum number of results to
|
2772
|
+
# The maximum number of results to return for each paginated request.
|
2670
2773
|
#
|
2671
2774
|
# Default: 50
|
2672
2775
|
#
|
@@ -2714,6 +2817,9 @@ module Aws::IoTSiteWise
|
|
2714
2817
|
# resp.asset_summaries[0].status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
2715
2818
|
# resp.asset_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
2716
2819
|
# resp.asset_summaries[0].status.error.message #=> String
|
2820
|
+
# resp.asset_summaries[0].status.error.details #=> Array
|
2821
|
+
# resp.asset_summaries[0].status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
2822
|
+
# resp.asset_summaries[0].status.error.details[0].message #=> String
|
2717
2823
|
# resp.asset_summaries[0].hierarchies #=> Array
|
2718
2824
|
# resp.asset_summaries[0].hierarchies[0].id #=> String
|
2719
2825
|
# resp.asset_summaries[0].hierarchies[0].name #=> String
|
@@ -2744,8 +2850,8 @@ module Aws::IoTSiteWise
|
|
2744
2850
|
# [DescribeAssetModel][2] operations. This parameter is required if you
|
2745
2851
|
# choose `CHILD` for `traversalDirection`.
|
2746
2852
|
#
|
2747
|
-
# For more information, see [Asset hierarchies][3] in the *
|
2748
|
-
#
|
2853
|
+
# For more information, see [Asset hierarchies][3] in the *IoT SiteWise
|
2854
|
+
# User Guide*.
|
2749
2855
|
#
|
2750
2856
|
#
|
2751
2857
|
#
|
@@ -2769,7 +2875,7 @@ module Aws::IoTSiteWise
|
|
2769
2875
|
# The token to be used for the next set of paginated results.
|
2770
2876
|
#
|
2771
2877
|
# @option params [Integer] :max_results
|
2772
|
-
# The maximum number of results to
|
2878
|
+
# The maximum number of results to return for each paginated request.
|
2773
2879
|
#
|
2774
2880
|
# Default: 50
|
2775
2881
|
#
|
@@ -2802,6 +2908,9 @@ module Aws::IoTSiteWise
|
|
2802
2908
|
# resp.asset_summaries[0].status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
2803
2909
|
# resp.asset_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
2804
2910
|
# resp.asset_summaries[0].status.error.message #=> String
|
2911
|
+
# resp.asset_summaries[0].status.error.details #=> Array
|
2912
|
+
# resp.asset_summaries[0].status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
2913
|
+
# resp.asset_summaries[0].status.error.details[0].message #=> String
|
2805
2914
|
# resp.asset_summaries[0].hierarchies #=> Array
|
2806
2915
|
# resp.asset_summaries[0].hierarchies[0].id #=> String
|
2807
2916
|
# resp.asset_summaries[0].hierarchies[0].name #=> String
|
@@ -2814,8 +2923,8 @@ module Aws::IoTSiteWise
|
|
2814
2923
|
req.send_request(options)
|
2815
2924
|
end
|
2816
2925
|
|
2817
|
-
# Retrieves a paginated list of dashboards for an
|
2818
|
-
#
|
2926
|
+
# Retrieves a paginated list of dashboards for an IoT SiteWise Monitor
|
2927
|
+
# project.
|
2819
2928
|
#
|
2820
2929
|
# @option params [required, String] :project_id
|
2821
2930
|
# The ID of the project.
|
@@ -2824,7 +2933,7 @@ module Aws::IoTSiteWise
|
|
2824
2933
|
# The token to be used for the next set of paginated results.
|
2825
2934
|
#
|
2826
2935
|
# @option params [Integer] :max_results
|
2827
|
-
# The maximum number of results to
|
2936
|
+
# The maximum number of results to return for each paginated request.
|
2828
2937
|
#
|
2829
2938
|
# Default: 50
|
2830
2939
|
#
|
@@ -2866,7 +2975,7 @@ module Aws::IoTSiteWise
|
|
2866
2975
|
# The token to be used for the next set of paginated results.
|
2867
2976
|
#
|
2868
2977
|
# @option params [Integer] :max_results
|
2869
|
-
# The maximum number of results to
|
2978
|
+
# The maximum number of results to return for each paginated request.
|
2870
2979
|
#
|
2871
2980
|
# Default: 50
|
2872
2981
|
#
|
@@ -2889,9 +2998,11 @@ module Aws::IoTSiteWise
|
|
2889
2998
|
# resp.gateway_summaries #=> Array
|
2890
2999
|
# resp.gateway_summaries[0].gateway_id #=> String
|
2891
3000
|
# resp.gateway_summaries[0].gateway_name #=> String
|
3001
|
+
# resp.gateway_summaries[0].gateway_platform.greengrass.group_arn #=> String
|
3002
|
+
# resp.gateway_summaries[0].gateway_platform.greengrass_v2.core_device_thing_name #=> String
|
2892
3003
|
# resp.gateway_summaries[0].gateway_capability_summaries #=> Array
|
2893
3004
|
# resp.gateway_summaries[0].gateway_capability_summaries[0].capability_namespace #=> String
|
2894
|
-
# resp.gateway_summaries[0].gateway_capability_summaries[0].capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED"
|
3005
|
+
# resp.gateway_summaries[0].gateway_capability_summaries[0].capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", "UNKNOWN"
|
2895
3006
|
# resp.gateway_summaries[0].creation_date #=> Time
|
2896
3007
|
# resp.gateway_summaries[0].last_update_date #=> Time
|
2897
3008
|
# resp.next_token #=> String
|
@@ -2903,13 +3014,13 @@ module Aws::IoTSiteWise
|
|
2903
3014
|
req.send_request(options)
|
2904
3015
|
end
|
2905
3016
|
|
2906
|
-
# Retrieves a paginated list of
|
3017
|
+
# Retrieves a paginated list of IoT SiteWise Monitor portals.
|
2907
3018
|
#
|
2908
3019
|
# @option params [String] :next_token
|
2909
3020
|
# The token to be used for the next set of paginated results.
|
2910
3021
|
#
|
2911
3022
|
# @option params [Integer] :max_results
|
2912
|
-
# The maximum number of results to
|
3023
|
+
# The maximum number of results to return for each paginated request.
|
2913
3024
|
#
|
2914
3025
|
# Default: 50
|
2915
3026
|
#
|
@@ -2949,8 +3060,8 @@ module Aws::IoTSiteWise
|
|
2949
3060
|
req.send_request(options)
|
2950
3061
|
end
|
2951
3062
|
|
2952
|
-
# Retrieves a paginated list of assets associated with an
|
2953
|
-
#
|
3063
|
+
# Retrieves a paginated list of assets associated with an IoT SiteWise
|
3064
|
+
# Monitor project.
|
2954
3065
|
#
|
2955
3066
|
# @option params [required, String] :project_id
|
2956
3067
|
# The ID of the project.
|
@@ -2959,7 +3070,7 @@ module Aws::IoTSiteWise
|
|
2959
3070
|
# The token to be used for the next set of paginated results.
|
2960
3071
|
#
|
2961
3072
|
# @option params [Integer] :max_results
|
2962
|
-
# The maximum number of results to
|
3073
|
+
# The maximum number of results to return for each paginated request.
|
2963
3074
|
#
|
2964
3075
|
# Default: 50
|
2965
3076
|
#
|
@@ -2991,7 +3102,7 @@ module Aws::IoTSiteWise
|
|
2991
3102
|
req.send_request(options)
|
2992
3103
|
end
|
2993
3104
|
|
2994
|
-
# Retrieves a paginated list of projects for an
|
3105
|
+
# Retrieves a paginated list of projects for an IoT SiteWise Monitor
|
2995
3106
|
# portal.
|
2996
3107
|
#
|
2997
3108
|
# @option params [required, String] :portal_id
|
@@ -3001,7 +3112,7 @@ module Aws::IoTSiteWise
|
|
3001
3112
|
# The token to be used for the next set of paginated results.
|
3002
3113
|
#
|
3003
3114
|
# @option params [Integer] :max_results
|
3004
|
-
# The maximum number of results to
|
3115
|
+
# The maximum number of results to return for each paginated request.
|
3005
3116
|
#
|
3006
3117
|
# Default: 50
|
3007
3118
|
#
|
@@ -3037,7 +3148,7 @@ module Aws::IoTSiteWise
|
|
3037
3148
|
req.send_request(options)
|
3038
3149
|
end
|
3039
3150
|
|
3040
|
-
# Retrieves the list of tags for an
|
3151
|
+
# Retrieves the list of tags for an IoT SiteWise resource.
|
3041
3152
|
#
|
3042
3153
|
# @option params [required, String] :resource_arn
|
3043
3154
|
# The [ARN][1] of the resource.
|
@@ -3068,9 +3179,9 @@ module Aws::IoTSiteWise
|
|
3068
3179
|
req.send_request(options)
|
3069
3180
|
end
|
3070
3181
|
|
3071
|
-
# Sets the default encryption configuration for the
|
3072
|
-
# more information, see [Key management][1] in the *
|
3073
|
-
# User Guide*.
|
3182
|
+
# Sets the default encryption configuration for the Amazon Web Services
|
3183
|
+
# account. For more information, see [Key management][1] in the *IoT
|
3184
|
+
# SiteWise User Guide*.
|
3074
3185
|
#
|
3075
3186
|
#
|
3076
3187
|
#
|
@@ -3081,8 +3192,7 @@ module Aws::IoTSiteWise
|
|
3081
3192
|
#
|
3082
3193
|
# @option params [String] :kms_key_id
|
3083
3194
|
# The Key ID of the customer managed customer master key (CMK) used for
|
3084
|
-
#
|
3085
|
-
# `KMS_BASED_ENCRYPTION`.
|
3195
|
+
# KMS encryption. This is required if you use `KMS_BASED_ENCRYPTION`.
|
3086
3196
|
#
|
3087
3197
|
# @return [Types::PutDefaultEncryptionConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3088
3198
|
#
|
@@ -3112,7 +3222,7 @@ module Aws::IoTSiteWise
|
|
3112
3222
|
req.send_request(options)
|
3113
3223
|
end
|
3114
3224
|
|
3115
|
-
# Sets logging options for
|
3225
|
+
# Sets logging options for IoT SiteWise.
|
3116
3226
|
#
|
3117
3227
|
# @option params [required, Types::LoggingOptions] :logging_options
|
3118
3228
|
# The logging options to set.
|
@@ -3134,8 +3244,66 @@ module Aws::IoTSiteWise
|
|
3134
3244
|
req.send_request(options)
|
3135
3245
|
end
|
3136
3246
|
|
3137
|
-
#
|
3138
|
-
#
|
3247
|
+
# Configures storage settings for IoT SiteWise.
|
3248
|
+
#
|
3249
|
+
# <note markdown="1"> Exporting data to Amazon S3 is currently in preview release and is
|
3250
|
+
# subject to change. We recommend that you use this feature only with
|
3251
|
+
# test data, and not in production environments.
|
3252
|
+
#
|
3253
|
+
# </note>
|
3254
|
+
#
|
3255
|
+
# @option params [required, String] :storage_type
|
3256
|
+
# The type of storage that you specified for your data. The storage type
|
3257
|
+
# can be one of the following values:
|
3258
|
+
#
|
3259
|
+
# * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise replicates your data into
|
3260
|
+
# a service managed database.
|
3261
|
+
#
|
3262
|
+
# * `MULTI_LAYER_STORAGE` – IoT SiteWise replicates your data into a
|
3263
|
+
# service managed database and saves a copy of your raw data and
|
3264
|
+
# metadata in an Amazon S3 object that you specified.
|
3265
|
+
#
|
3266
|
+
# @option params [Types::MultiLayerStorage] :multi_layer_storage
|
3267
|
+
# Identifies a storage destination. If you specified
|
3268
|
+
# `MULTI_LAYER_STORAGE` for the storage type, you must specify a
|
3269
|
+
# `MultiLayerStorage` object.
|
3270
|
+
#
|
3271
|
+
# @return [Types::PutStorageConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3272
|
+
#
|
3273
|
+
# * {Types::PutStorageConfigurationResponse#storage_type #storage_type} => String
|
3274
|
+
# * {Types::PutStorageConfigurationResponse#multi_layer_storage #multi_layer_storage} => Types::MultiLayerStorage
|
3275
|
+
# * {Types::PutStorageConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
|
3276
|
+
#
|
3277
|
+
# @example Request syntax with placeholder values
|
3278
|
+
#
|
3279
|
+
# resp = client.put_storage_configuration({
|
3280
|
+
# storage_type: "SITEWISE_DEFAULT_STORAGE", # required, accepts SITEWISE_DEFAULT_STORAGE, MULTI_LAYER_STORAGE
|
3281
|
+
# multi_layer_storage: {
|
3282
|
+
# customer_managed_s3_storage: { # required
|
3283
|
+
# s3_resource_arn: "ARN", # required
|
3284
|
+
# role_arn: "ARN", # required
|
3285
|
+
# },
|
3286
|
+
# },
|
3287
|
+
# })
|
3288
|
+
#
|
3289
|
+
# @example Response structure
|
3290
|
+
#
|
3291
|
+
# resp.storage_type #=> String, one of "SITEWISE_DEFAULT_STORAGE", "MULTI_LAYER_STORAGE"
|
3292
|
+
# resp.multi_layer_storage.customer_managed_s3_storage.s3_resource_arn #=> String
|
3293
|
+
# resp.multi_layer_storage.customer_managed_s3_storage.role_arn #=> String
|
3294
|
+
# resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
3295
|
+
# resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
3296
|
+
# resp.configuration_status.error.message #=> String
|
3297
|
+
#
|
3298
|
+
# @overload put_storage_configuration(params = {})
|
3299
|
+
# @param [Hash] params ({})
|
3300
|
+
def put_storage_configuration(params = {}, options = {})
|
3301
|
+
req = build_request(:put_storage_configuration, params)
|
3302
|
+
req.send_request(options)
|
3303
|
+
end
|
3304
|
+
|
3305
|
+
# Adds tags to an IoT SiteWise resource. If a tag already exists for the
|
3306
|
+
# resource, this operation updates the tag's value.
|
3139
3307
|
#
|
3140
3308
|
# @option params [required, String] :resource_arn
|
3141
3309
|
# The [ARN][1] of the resource to tag.
|
@@ -3146,8 +3314,8 @@ module Aws::IoTSiteWise
|
|
3146
3314
|
#
|
3147
3315
|
# @option params [required, Hash<String,String>] :tags
|
3148
3316
|
# A list of key-value pairs that contain metadata for the resource. For
|
3149
|
-
# more information, see [Tagging your
|
3150
|
-
#
|
3317
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
3318
|
+
# *IoT SiteWise User Guide*.
|
3151
3319
|
#
|
3152
3320
|
#
|
3153
3321
|
#
|
@@ -3171,7 +3339,7 @@ module Aws::IoTSiteWise
|
|
3171
3339
|
req.send_request(options)
|
3172
3340
|
end
|
3173
3341
|
|
3174
|
-
# Removes a tag from an
|
3342
|
+
# Removes a tag from an IoT SiteWise resource.
|
3175
3343
|
#
|
3176
3344
|
# @option params [required, String] :resource_arn
|
3177
3345
|
# The [ARN][1] of the resource to untag.
|
@@ -3200,17 +3368,17 @@ module Aws::IoTSiteWise
|
|
3200
3368
|
end
|
3201
3369
|
|
3202
3370
|
# Updates an existing access policy that specifies an identity's access
|
3203
|
-
# to an
|
3371
|
+
# to an IoT SiteWise Monitor portal or project resource.
|
3204
3372
|
#
|
3205
3373
|
# @option params [required, String] :access_policy_id
|
3206
3374
|
# The ID of the access policy.
|
3207
3375
|
#
|
3208
3376
|
# @option params [required, Types::Identity] :access_policy_identity
|
3209
|
-
# The identity for this access policy. Choose an
|
3210
|
-
# SSO group, or an IAM user.
|
3377
|
+
# The identity for this access policy. Choose an Amazon Web Services SSO
|
3378
|
+
# user, an Amazon Web Services SSO group, or an IAM user.
|
3211
3379
|
#
|
3212
3380
|
# @option params [required, Types::Resource] :access_policy_resource
|
3213
|
-
# The
|
3381
|
+
# The IoT SiteWise Monitor resource for this access policy. Choose
|
3214
3382
|
# either a portal or a project.
|
3215
3383
|
#
|
3216
3384
|
# @option params [required, String] :access_policy_permission
|
@@ -3265,7 +3433,7 @@ module Aws::IoTSiteWise
|
|
3265
3433
|
end
|
3266
3434
|
|
3267
3435
|
# Updates an asset's name. For more information, see [Updating assets
|
3268
|
-
# and models][1] in the *
|
3436
|
+
# and models][1] in the *IoT SiteWise User Guide*.
|
3269
3437
|
#
|
3270
3438
|
#
|
3271
3439
|
#
|
@@ -3302,6 +3470,9 @@ module Aws::IoTSiteWise
|
|
3302
3470
|
# resp.asset_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
3303
3471
|
# resp.asset_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
3304
3472
|
# resp.asset_status.error.message #=> String
|
3473
|
+
# resp.asset_status.error.details #=> Array
|
3474
|
+
# resp.asset_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
3475
|
+
# resp.asset_status.error.details[0].message #=> String
|
3305
3476
|
#
|
3306
3477
|
# @overload update_asset(params = {})
|
3307
3478
|
# @param [Hash] params ({})
|
@@ -3313,20 +3484,20 @@ module Aws::IoTSiteWise
|
|
3313
3484
|
# Updates an asset model and all of the assets that were created from
|
3314
3485
|
# the model. Each asset created from the model inherits the updated
|
3315
3486
|
# asset model's property and hierarchy definitions. For more
|
3316
|
-
# information, see [Updating assets and models][1] in the *
|
3317
|
-
#
|
3487
|
+
# information, see [Updating assets and models][1] in the *IoT SiteWise
|
3488
|
+
# User Guide*.
|
3318
3489
|
#
|
3319
3490
|
# This operation overwrites the existing model with the provided model.
|
3320
3491
|
# To avoid deleting your asset model's properties or hierarchies, you
|
3321
3492
|
# must include their IDs and definitions in the updated asset model
|
3322
3493
|
# payload. For more information, see [DescribeAssetModel][2].
|
3323
3494
|
#
|
3324
|
-
# If you remove a property from an asset model,
|
3325
|
-
#
|
3326
|
-
#
|
3327
|
-
#
|
3328
|
-
#
|
3329
|
-
#
|
3495
|
+
# If you remove a property from an asset model, IoT SiteWise deletes
|
3496
|
+
# all
|
3497
|
+
# previous data for that property. If you remove a hierarchy definition
|
3498
|
+
# from an asset model, IoT SiteWise disassociates every asset associated
|
3499
|
+
# with that hierarchy. You can't change the type or data type of an
|
3500
|
+
# existing property.
|
3330
3501
|
#
|
3331
3502
|
#
|
3332
3503
|
#
|
@@ -3344,11 +3515,11 @@ module Aws::IoTSiteWise
|
|
3344
3515
|
#
|
3345
3516
|
# @option params [Array<Types::AssetModelProperty>] :asset_model_properties
|
3346
3517
|
# The updated property definitions of the asset model. For more
|
3347
|
-
# information, see [Asset properties][1] in the *
|
3518
|
+
# information, see [Asset properties][1] in the *IoT SiteWise User
|
3348
3519
|
# Guide*.
|
3349
3520
|
#
|
3350
3521
|
# You can specify up to 200 properties per asset model. For more
|
3351
|
-
# information, see [Quotas][2] in the *
|
3522
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
3352
3523
|
#
|
3353
3524
|
#
|
3354
3525
|
#
|
@@ -3359,10 +3530,10 @@ module Aws::IoTSiteWise
|
|
3359
3530
|
# The updated hierarchy definitions of the asset model. Each hierarchy
|
3360
3531
|
# specifies an asset model whose assets can be children of any other
|
3361
3532
|
# assets created from this asset model. For more information, see [Asset
|
3362
|
-
# hierarchies][1] in the *
|
3533
|
+
# hierarchies][1] in the *IoT SiteWise User Guide*.
|
3363
3534
|
#
|
3364
3535
|
# You can specify up to 10 hierarchies per asset model. For more
|
3365
|
-
# information, see [Quotas][2] in the *
|
3536
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
3366
3537
|
#
|
3367
3538
|
#
|
3368
3539
|
#
|
@@ -3406,6 +3577,11 @@ module Aws::IoTSiteWise
|
|
3406
3577
|
# default_value: "DefaultValue",
|
3407
3578
|
# },
|
3408
3579
|
# measurement: {
|
3580
|
+
# processing_config: {
|
3581
|
+
# forwarding_config: { # required
|
3582
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
3583
|
+
# },
|
3584
|
+
# },
|
3409
3585
|
# },
|
3410
3586
|
# transform: {
|
3411
3587
|
# expression: "Expression", # required
|
@@ -3418,6 +3594,12 @@ module Aws::IoTSiteWise
|
|
3418
3594
|
# },
|
3419
3595
|
# },
|
3420
3596
|
# ],
|
3597
|
+
# processing_config: {
|
3598
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
3599
|
+
# forwarding_config: {
|
3600
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
3601
|
+
# },
|
3602
|
+
# },
|
3421
3603
|
# },
|
3422
3604
|
# metric: {
|
3423
3605
|
# expression: "Expression", # required
|
@@ -3435,6 +3617,9 @@ module Aws::IoTSiteWise
|
|
3435
3617
|
# interval: "Interval", # required
|
3436
3618
|
# },
|
3437
3619
|
# },
|
3620
|
+
# processing_config: {
|
3621
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
3622
|
+
# },
|
3438
3623
|
# },
|
3439
3624
|
# },
|
3440
3625
|
# },
|
@@ -3463,6 +3648,11 @@ module Aws::IoTSiteWise
|
|
3463
3648
|
# default_value: "DefaultValue",
|
3464
3649
|
# },
|
3465
3650
|
# measurement: {
|
3651
|
+
# processing_config: {
|
3652
|
+
# forwarding_config: { # required
|
3653
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
3654
|
+
# },
|
3655
|
+
# },
|
3466
3656
|
# },
|
3467
3657
|
# transform: {
|
3468
3658
|
# expression: "Expression", # required
|
@@ -3475,6 +3665,12 @@ module Aws::IoTSiteWise
|
|
3475
3665
|
# },
|
3476
3666
|
# },
|
3477
3667
|
# ],
|
3668
|
+
# processing_config: {
|
3669
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
3670
|
+
# forwarding_config: {
|
3671
|
+
# state: "DISABLED", # required, accepts DISABLED, ENABLED
|
3672
|
+
# },
|
3673
|
+
# },
|
3478
3674
|
# },
|
3479
3675
|
# metric: {
|
3480
3676
|
# expression: "Expression", # required
|
@@ -3492,6 +3688,9 @@ module Aws::IoTSiteWise
|
|
3492
3688
|
# interval: "Interval", # required
|
3493
3689
|
# },
|
3494
3690
|
# },
|
3691
|
+
# processing_config: {
|
3692
|
+
# compute_location: "EDGE", # required, accepts EDGE, CLOUD
|
3693
|
+
# },
|
3495
3694
|
# },
|
3496
3695
|
# },
|
3497
3696
|
# },
|
@@ -3506,6 +3705,9 @@ module Aws::IoTSiteWise
|
|
3506
3705
|
# resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
|
3507
3706
|
# resp.asset_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
3508
3707
|
# resp.asset_model_status.error.message #=> String
|
3708
|
+
# resp.asset_model_status.error.details #=> Array
|
3709
|
+
# resp.asset_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
3710
|
+
# resp.asset_model_status.error.details[0].message #=> String
|
3509
3711
|
#
|
3510
3712
|
# @overload update_asset_model(params = {})
|
3511
3713
|
# @param [Hash] params ({})
|
@@ -3533,11 +3735,11 @@ module Aws::IoTSiteWise
|
|
3533
3735
|
# The ID of the asset property to be updated.
|
3534
3736
|
#
|
3535
3737
|
# @option params [String] :property_alias
|
3536
|
-
# The
|
3537
|
-
#
|
3738
|
+
# The alias that identifies the property, such as an OPC-UA server data
|
3739
|
+
# stream path (for example,
|
3538
3740
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
3539
3741
|
# see [Mapping industrial data streams to asset properties][1] in the
|
3540
|
-
# *
|
3742
|
+
# *IoT SiteWise User Guide*.
|
3541
3743
|
#
|
3542
3744
|
# If you omit this parameter, the alias is removed from the property.
|
3543
3745
|
#
|
@@ -3547,9 +3749,9 @@ module Aws::IoTSiteWise
|
|
3547
3749
|
#
|
3548
3750
|
# @option params [String] :property_notification_state
|
3549
3751
|
# The MQTT notification state (enabled or disabled) for this asset
|
3550
|
-
# property. When the notification state is enabled,
|
3752
|
+
# property. When the notification state is enabled, IoT SiteWise
|
3551
3753
|
# publishes property value updates to a unique MQTT topic. For more
|
3552
|
-
# information, see [Interacting with other services][1] in the *
|
3754
|
+
# information, see [Interacting with other services][1] in the *IoT
|
3553
3755
|
# SiteWise User Guide*.
|
3554
3756
|
#
|
3555
3757
|
# If you omit this parameter, the notification state is set to
|
@@ -3586,7 +3788,7 @@ module Aws::IoTSiteWise
|
|
3586
3788
|
req.send_request(options)
|
3587
3789
|
end
|
3588
3790
|
|
3589
|
-
# Updates an
|
3791
|
+
# Updates an IoT SiteWise Monitor dashboard.
|
3590
3792
|
#
|
3591
3793
|
# @option params [required, String] :dashboard_id
|
3592
3794
|
# The ID of the dashboard to update.
|
@@ -3599,8 +3801,8 @@ module Aws::IoTSiteWise
|
|
3599
3801
|
#
|
3600
3802
|
# @option params [required, String] :dashboard_definition
|
3601
3803
|
# The new dashboard definition, as specified in a JSON literal. For
|
3602
|
-
# detailed information, see [Creating dashboards (CLI)][1] in the *
|
3603
|
-
#
|
3804
|
+
# detailed information, see [Creating dashboards (CLI)][1] in the *IoT
|
3805
|
+
# SiteWise User Guide*.
|
3604
3806
|
#
|
3605
3807
|
#
|
3606
3808
|
#
|
@@ -3660,8 +3862,8 @@ module Aws::IoTSiteWise
|
|
3660
3862
|
# Updates a gateway capability configuration or defines a new capability
|
3661
3863
|
# configuration. Each gateway capability defines data sources for a
|
3662
3864
|
# gateway. A capability configuration can contain multiple data source
|
3663
|
-
# configurations. If you define OPC-UA sources for a gateway in the
|
3664
|
-
#
|
3865
|
+
# configurations. If you define OPC-UA sources for a gateway in the IoT
|
3866
|
+
# SiteWise console, all of your OPC-UA sources are stored in one
|
3665
3867
|
# capability configuration. To list all capability configurations for a
|
3666
3868
|
# gateway, use [DescribeGateway][1].
|
3667
3869
|
#
|
@@ -3674,7 +3876,7 @@ module Aws::IoTSiteWise
|
|
3674
3876
|
#
|
3675
3877
|
# @option params [required, String] :capability_namespace
|
3676
3878
|
# The namespace of the gateway capability configuration to be updated.
|
3677
|
-
# For example, if you configure OPC-UA sources from the
|
3879
|
+
# For example, if you configure OPC-UA sources from the IoT SiteWise
|
3678
3880
|
# console, your OPC-UA capability configuration has the namespace
|
3679
3881
|
# `iotsitewise:opcuacollector:version`, where `version` is a number such
|
3680
3882
|
# as `1`.
|
@@ -3682,7 +3884,7 @@ module Aws::IoTSiteWise
|
|
3682
3884
|
# @option params [required, String] :capability_configuration
|
3683
3885
|
# The JSON document that defines the configuration for the gateway
|
3684
3886
|
# capability. For more information, see [Configuring data sources
|
3685
|
-
# (CLI)][1] in the *
|
3887
|
+
# (CLI)][1] in the *IoT SiteWise User Guide*.
|
3686
3888
|
#
|
3687
3889
|
#
|
3688
3890
|
#
|
@@ -3704,7 +3906,7 @@ module Aws::IoTSiteWise
|
|
3704
3906
|
# @example Response structure
|
3705
3907
|
#
|
3706
3908
|
# resp.capability_namespace #=> String
|
3707
|
-
# resp.capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED"
|
3909
|
+
# resp.capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", "UNKNOWN"
|
3708
3910
|
#
|
3709
3911
|
# @overload update_gateway_capability_configuration(params = {})
|
3710
3912
|
# @param [Hash] params ({})
|
@@ -3713,7 +3915,7 @@ module Aws::IoTSiteWise
|
|
3713
3915
|
req.send_request(options)
|
3714
3916
|
end
|
3715
3917
|
|
3716
|
-
# Updates an
|
3918
|
+
# Updates an IoT SiteWise Monitor portal.
|
3717
3919
|
#
|
3718
3920
|
# @option params [required, String] :portal_id
|
3719
3921
|
# The ID of the portal to update.
|
@@ -3725,7 +3927,7 @@ module Aws::IoTSiteWise
|
|
3725
3927
|
# A new description for the portal.
|
3726
3928
|
#
|
3727
3929
|
# @option params [required, String] :portal_contact_email
|
3728
|
-
# The
|
3930
|
+
# The Amazon Web Services administrator's contact email address.
|
3729
3931
|
#
|
3730
3932
|
# @option params [Types::Image] :portal_logo_image
|
3731
3933
|
# Contains an image that is one of the following:
|
@@ -3737,9 +3939,9 @@ module Aws::IoTSiteWise
|
|
3737
3939
|
#
|
3738
3940
|
# @option params [required, String] :role_arn
|
3739
3941
|
# The [ARN][1] of a service role that allows the portal's users to
|
3740
|
-
# access your
|
3741
|
-
# information, see [Using service roles for
|
3742
|
-
#
|
3942
|
+
# access your IoT SiteWise resources on your behalf. For more
|
3943
|
+
# information, see [Using service roles for IoT SiteWise Monitor][2] in
|
3944
|
+
# the *IoT SiteWise User Guide*.
|
3743
3945
|
#
|
3744
3946
|
#
|
3745
3947
|
#
|
@@ -3758,10 +3960,15 @@ module Aws::IoTSiteWise
|
|
3758
3960
|
# The email address that sends alarm notifications.
|
3759
3961
|
#
|
3760
3962
|
# @option params [Types::Alarms] :alarms
|
3761
|
-
# Contains the configuration information of an alarm created in an
|
3762
|
-
#
|
3963
|
+
# Contains the configuration information of an alarm created in an IoT
|
3964
|
+
# SiteWise Monitor portal. You can use the alarm to monitor an asset
|
3763
3965
|
# property and get notified when the asset property value is outside a
|
3764
|
-
# specified range. For more information, see
|
3966
|
+
# specified range. For more information, see [Monitoring with alarms][1]
|
3967
|
+
# in the *IoT SiteWise Application Guide*.
|
3968
|
+
#
|
3969
|
+
#
|
3970
|
+
#
|
3971
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
|
3765
3972
|
#
|
3766
3973
|
# @return [Types::UpdatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3767
3974
|
#
|
@@ -3803,7 +4010,7 @@ module Aws::IoTSiteWise
|
|
3803
4010
|
req.send_request(options)
|
3804
4011
|
end
|
3805
4012
|
|
3806
|
-
# Updates an
|
4013
|
+
# Updates an IoT SiteWise Monitor project.
|
3807
4014
|
#
|
3808
4015
|
# @option params [required, String] :project_id
|
3809
4016
|
# The ID of the project to update.
|
@@ -3853,7 +4060,7 @@ module Aws::IoTSiteWise
|
|
3853
4060
|
params: params,
|
3854
4061
|
config: config)
|
3855
4062
|
context[:gem_name] = 'aws-sdk-iotsitewise'
|
3856
|
-
context[:gem_version] = '1.
|
4063
|
+
context[:gem_version] = '1.27.0'
|
3857
4064
|
Seahorse::Client::Request.new(handlers, context)
|
3858
4065
|
end
|
3859
4066
|
|