aws-sdk-iotsitewise 1.22.0 → 1.26.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 +309 -184
- data/lib/aws-sdk-iotsitewise/client_api.rb +117 -25
- data/lib/aws-sdk-iotsitewise/types.rb +489 -215
- 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: d76f0d8f79d2b4f6b5dbcf3d71f9001a61d869c7cbba94a42c76f4b3fe2f4211
|
4
|
+
data.tar.gz: 65cfd64e7653dfdedc7620709ebd55522e5fbf02e4469bab8380ecf5fca984b1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 19dce4783ac78e337042d31ee2e44166d31d7f8e28abcca83dab450e26d6351909d60ac101ed47a716549f83965a9f7b0a84077bb1725087ea0cec169cc7ddc9
|
7
|
+
data.tar.gz: e4b0c2272e5b9b9f4d3ab72860e8db34404d8afd544fd04cd1d42ffa66c5159a381ab7d9e58d6a2ff409ae5b45a30067a56474850131b972de50545be459dd64
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.26.0 (2021-07-28)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.25.0 (2021-07-15)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* 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.
|
13
|
+
|
14
|
+
1.24.0 (2021-07-07)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - This release add storage configuration APIs for AWS IoT SiteWise.
|
18
|
+
|
19
|
+
1.23.0 (2021-05-27)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - IoT SiteWise Monitor Portal API updates to add alarms feature configuration.
|
23
|
+
|
4
24
|
1.22.0 (2021-05-18)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.26.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
|
#
|
@@ -701,7 +701,7 @@ module Aws::IoTSiteWise
|
|
701
701
|
# you can easily create assets of the same type that have standardized
|
702
702
|
# definitions. Each asset created from a model inherits the asset
|
703
703
|
# model's property and hierarchy definitions. For more information, see
|
704
|
-
# [Defining asset models][1] in the *
|
704
|
+
# [Defining asset models][1] in the *IoT SiteWise User Guide*.
|
705
705
|
#
|
706
706
|
#
|
707
707
|
#
|
@@ -715,10 +715,10 @@ module Aws::IoTSiteWise
|
|
715
715
|
#
|
716
716
|
# @option params [Array<Types::AssetModelPropertyDefinition>] :asset_model_properties
|
717
717
|
# The property definitions of the asset model. For more information, see
|
718
|
-
# [Asset properties][1] in the *
|
718
|
+
# [Asset properties][1] in the *IoT SiteWise User Guide*.
|
719
719
|
#
|
720
720
|
# You can specify up to 200 properties per asset model. For more
|
721
|
-
# information, see [Quotas][2] in the *
|
721
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
722
722
|
#
|
723
723
|
#
|
724
724
|
#
|
@@ -729,10 +729,10 @@ module Aws::IoTSiteWise
|
|
729
729
|
# The hierarchy definitions of the asset model. Each hierarchy specifies
|
730
730
|
# an asset model whose assets can be children of any other assets
|
731
731
|
# created from this asset model. For more information, see [Asset
|
732
|
-
# hierarchies][1] in the *
|
732
|
+
# hierarchies][1] in the *IoT SiteWise User Guide*.
|
733
733
|
#
|
734
734
|
# You can specify up to 10 hierarchies per asset model. For more
|
735
|
-
# information, see [Quotas][2] in the *
|
735
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
736
736
|
#
|
737
737
|
#
|
738
738
|
#
|
@@ -756,8 +756,8 @@ module Aws::IoTSiteWise
|
|
756
756
|
#
|
757
757
|
# @option params [Hash<String,String>] :tags
|
758
758
|
# A list of key-value pairs that contain metadata for the asset model.
|
759
|
-
# For more information, see [Tagging your
|
760
|
-
#
|
759
|
+
# For more information, see [Tagging your IoT SiteWise resources][1] in
|
760
|
+
# the *IoT SiteWise User Guide*.
|
761
761
|
#
|
762
762
|
#
|
763
763
|
#
|
@@ -896,7 +896,7 @@ module Aws::IoTSiteWise
|
|
896
896
|
req.send_request(options)
|
897
897
|
end
|
898
898
|
|
899
|
-
# Creates a dashboard in an
|
899
|
+
# Creates a dashboard in an IoT SiteWise Monitor project.
|
900
900
|
#
|
901
901
|
# @option params [required, String] :project_id
|
902
902
|
# The ID of the project in which to create the dashboard.
|
@@ -909,8 +909,8 @@ module Aws::IoTSiteWise
|
|
909
909
|
#
|
910
910
|
# @option params [required, String] :dashboard_definition
|
911
911
|
# The dashboard definition specified in a JSON literal. For detailed
|
912
|
-
# information, see [Creating dashboards (CLI)][1] in the *
|
913
|
-
#
|
912
|
+
# information, see [Creating dashboards (CLI)][1] in the *IoT SiteWise
|
913
|
+
# User Guide*.
|
914
914
|
#
|
915
915
|
#
|
916
916
|
#
|
@@ -926,8 +926,8 @@ module Aws::IoTSiteWise
|
|
926
926
|
#
|
927
927
|
# @option params [Hash<String,String>] :tags
|
928
928
|
# A list of key-value pairs that contain metadata for the dashboard. For
|
929
|
-
# more information, see [Tagging your
|
930
|
-
#
|
929
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
930
|
+
# *IoT SiteWise User Guide*.
|
931
931
|
#
|
932
932
|
#
|
933
933
|
#
|
@@ -964,9 +964,9 @@ module Aws::IoTSiteWise
|
|
964
964
|
end
|
965
965
|
|
966
966
|
# Creates a gateway, which is a virtual or edge device that delivers
|
967
|
-
# industrial data streams from local servers to
|
968
|
-
#
|
969
|
-
#
|
967
|
+
# industrial data streams from local servers to IoT SiteWise. For more
|
968
|
+
# information, see [Ingesting data using a gateway][1] in the *IoT
|
969
|
+
# SiteWise User Guide*.
|
970
970
|
#
|
971
971
|
#
|
972
972
|
#
|
@@ -981,8 +981,8 @@ module Aws::IoTSiteWise
|
|
981
981
|
#
|
982
982
|
# @option params [Hash<String,String>] :tags
|
983
983
|
# A list of key-value pairs that contain metadata for the gateway. For
|
984
|
-
# more information, see [Tagging your
|
985
|
-
#
|
984
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
985
|
+
# *IoT SiteWise User Guide*.
|
986
986
|
#
|
987
987
|
#
|
988
988
|
#
|
@@ -1019,13 +1019,13 @@ module Aws::IoTSiteWise
|
|
1019
1019
|
req.send_request(options)
|
1020
1020
|
end
|
1021
1021
|
|
1022
|
-
# Creates a portal, which can contain projects and dashboards.
|
1023
|
-
# SiteWise Monitor uses
|
1024
|
-
# manage user permissions.
|
1022
|
+
# Creates a portal, which can contain projects and dashboards. IoT
|
1023
|
+
# SiteWise Monitor uses Amazon Web Services SSO or IAM to authenticate
|
1024
|
+
# portal users and manage user permissions.
|
1025
1025
|
#
|
1026
1026
|
# <note markdown="1"> Before you can sign in to a new portal, you must add at least one
|
1027
1027
|
# identity to that portal. For more information, see [Adding or removing
|
1028
|
-
# portal administrators][1] in the *
|
1028
|
+
# portal administrators][1] in the *IoT SiteWise User Guide*.
|
1029
1029
|
#
|
1030
1030
|
# </note>
|
1031
1031
|
#
|
@@ -1040,7 +1040,7 @@ module Aws::IoTSiteWise
|
|
1040
1040
|
# A description for the portal.
|
1041
1041
|
#
|
1042
1042
|
# @option params [required, String] :portal_contact_email
|
1043
|
-
# The
|
1043
|
+
# The Amazon Web Services administrator's contact email address.
|
1044
1044
|
#
|
1045
1045
|
# @option params [String] :client_token
|
1046
1046
|
# A unique case-sensitive identifier that you can provide to ensure the
|
@@ -1056,9 +1056,9 @@ module Aws::IoTSiteWise
|
|
1056
1056
|
#
|
1057
1057
|
# @option params [required, String] :role_arn
|
1058
1058
|
# 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
|
-
#
|
1059
|
+
# access your IoT SiteWise resources on your behalf. For more
|
1060
|
+
# information, see [Using service roles for IoT SiteWise Monitor][2] in
|
1061
|
+
# the *IoT SiteWise User Guide*.
|
1062
1062
|
#
|
1063
1063
|
#
|
1064
1064
|
#
|
@@ -1067,8 +1067,8 @@ module Aws::IoTSiteWise
|
|
1067
1067
|
#
|
1068
1068
|
# @option params [Hash<String,String>] :tags
|
1069
1069
|
# A list of key-value pairs that contain metadata for the portal. For
|
1070
|
-
# more information, see [Tagging your
|
1071
|
-
#
|
1070
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
1071
|
+
# *IoT SiteWise User Guide*.
|
1072
1072
|
#
|
1073
1073
|
#
|
1074
1074
|
#
|
@@ -1078,14 +1078,15 @@ module Aws::IoTSiteWise
|
|
1078
1078
|
# The service to use to authenticate users to the portal. Choose from
|
1079
1079
|
# the following options:
|
1080
1080
|
#
|
1081
|
-
# * `SSO` – The portal uses
|
1082
|
-
# manage user permissions. Before you can
|
1083
|
-
#
|
1084
|
-
#
|
1085
|
-
#
|
1086
|
-
# Regions
|
1081
|
+
# * `SSO` – The portal uses Amazon Web Services Single Sign On to
|
1082
|
+
# authenticate users and manage user permissions. Before you can
|
1083
|
+
# create a portal that uses Amazon Web Services SSO, you must enable
|
1084
|
+
# Amazon Web Services SSO. For more information, see [Enabling Amazon
|
1085
|
+
# Web Services SSO][1] in the *IoT SiteWise User Guide*. This option
|
1086
|
+
# is only available in Amazon Web Services Regions other than the
|
1087
|
+
# China Regions.
|
1087
1088
|
#
|
1088
|
-
# * `IAM` – The portal uses
|
1089
|
+
# * `IAM` – The portal uses Identity and Access Management to
|
1089
1090
|
# authenticate users and manage user permissions. This option is only
|
1090
1091
|
# available in the China Regions.
|
1091
1092
|
#
|
@@ -1097,6 +1098,28 @@ module Aws::IoTSiteWise
|
|
1097
1098
|
#
|
1098
1099
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso
|
1099
1100
|
#
|
1101
|
+
# @option params [String] :notification_sender_email
|
1102
|
+
# The email address that sends alarm notifications.
|
1103
|
+
#
|
1104
|
+
# If you use the [IoT Events managed Lambda function][1] to manage your
|
1105
|
+
# emails, you must [verify the sender email address in Amazon SES][2].
|
1106
|
+
#
|
1107
|
+
#
|
1108
|
+
#
|
1109
|
+
# [1]: https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html
|
1110
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html
|
1111
|
+
#
|
1112
|
+
# @option params [Types::Alarms] :alarms
|
1113
|
+
# Contains the configuration information of an alarm created in an IoT
|
1114
|
+
# SiteWise Monitor portal. You can use the alarm to monitor an asset
|
1115
|
+
# property and get notified when the asset property value is outside a
|
1116
|
+
# specified range. For more information, see [Monitoring with alarms][1]
|
1117
|
+
# in the *IoT SiteWise Application Guide*.
|
1118
|
+
#
|
1119
|
+
#
|
1120
|
+
#
|
1121
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
|
1122
|
+
#
|
1100
1123
|
# @return [Types::CreatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1101
1124
|
#
|
1102
1125
|
# * {Types::CreatePortalResponse#portal_id #portal_id} => String
|
@@ -1121,6 +1144,11 @@ module Aws::IoTSiteWise
|
|
1121
1144
|
# "TagKey" => "TagValue",
|
1122
1145
|
# },
|
1123
1146
|
# portal_auth_mode: "IAM", # accepts IAM, SSO
|
1147
|
+
# notification_sender_email: "Email",
|
1148
|
+
# alarms: {
|
1149
|
+
# alarm_role_arn: "ARN", # required
|
1150
|
+
# notification_lambda_arn: "ARN",
|
1151
|
+
# },
|
1124
1152
|
# })
|
1125
1153
|
#
|
1126
1154
|
# @example Response structure
|
@@ -1161,8 +1189,8 @@ module Aws::IoTSiteWise
|
|
1161
1189
|
#
|
1162
1190
|
# @option params [Hash<String,String>] :tags
|
1163
1191
|
# A list of key-value pairs that contain metadata for the project. For
|
1164
|
-
# more information, see [Tagging your
|
1165
|
-
#
|
1192
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
1193
|
+
# *IoT SiteWise User Guide*.
|
1166
1194
|
#
|
1167
1195
|
#
|
1168
1196
|
#
|
@@ -1198,8 +1226,8 @@ module Aws::IoTSiteWise
|
|
1198
1226
|
end
|
1199
1227
|
|
1200
1228
|
# Deletes an access policy that grants the specified identity access to
|
1201
|
-
# the specified
|
1202
|
-
# operation to revoke access to an
|
1229
|
+
# the specified IoT SiteWise Monitor resource. You can use this
|
1230
|
+
# operation to revoke access to an IoT SiteWise Monitor resource.
|
1203
1231
|
#
|
1204
1232
|
# @option params [required, String] :access_policy_id
|
1205
1233
|
# The ID of the access policy to be deleted.
|
@@ -1229,8 +1257,7 @@ module Aws::IoTSiteWise
|
|
1229
1257
|
end
|
1230
1258
|
|
1231
1259
|
# Deletes an asset. This action can't be undone. For more information,
|
1232
|
-
# see [Deleting assets and models][1] in the *
|
1233
|
-
# Guide*.
|
1260
|
+
# see [Deleting assets and models][1] in the *IoT SiteWise User Guide*.
|
1234
1261
|
#
|
1235
1262
|
# <note markdown="1"> You can't delete an asset that's associated to another asset. For
|
1236
1263
|
# more information, see [DisassociateAssets][2].
|
@@ -1282,7 +1309,7 @@ module Aws::IoTSiteWise
|
|
1282
1309
|
# model. Also, you can't delete an asset model if a parent asset model
|
1283
1310
|
# exists that contains a property formula expression that depends on the
|
1284
1311
|
# asset model that you want to delete. For more information, see
|
1285
|
-
# [Deleting assets and models][1] in the *
|
1312
|
+
# [Deleting assets and models][1] in the *IoT SiteWise User Guide*.
|
1286
1313
|
#
|
1287
1314
|
#
|
1288
1315
|
#
|
@@ -1323,7 +1350,7 @@ module Aws::IoTSiteWise
|
|
1323
1350
|
req.send_request(options)
|
1324
1351
|
end
|
1325
1352
|
|
1326
|
-
# Deletes a dashboard from
|
1353
|
+
# Deletes a dashboard from IoT SiteWise Monitor.
|
1327
1354
|
#
|
1328
1355
|
# @option params [required, String] :dashboard_id
|
1329
1356
|
# The ID of the dashboard to delete.
|
@@ -1352,8 +1379,8 @@ module Aws::IoTSiteWise
|
|
1352
1379
|
req.send_request(options)
|
1353
1380
|
end
|
1354
1381
|
|
1355
|
-
# Deletes a gateway from
|
1356
|
-
#
|
1382
|
+
# Deletes a gateway from IoT SiteWise. When you delete a gateway, some
|
1383
|
+
# of the gateway's files remain in your gateway's file system.
|
1357
1384
|
#
|
1358
1385
|
# @option params [required, String] :gateway_id
|
1359
1386
|
# The ID of the gateway to delete.
|
@@ -1373,7 +1400,7 @@ module Aws::IoTSiteWise
|
|
1373
1400
|
req.send_request(options)
|
1374
1401
|
end
|
1375
1402
|
|
1376
|
-
# Deletes a portal from
|
1403
|
+
# Deletes a portal from IoT SiteWise Monitor.
|
1377
1404
|
#
|
1378
1405
|
# @option params [required, String] :portal_id
|
1379
1406
|
# The ID of the portal to delete.
|
@@ -1410,7 +1437,7 @@ module Aws::IoTSiteWise
|
|
1410
1437
|
req.send_request(options)
|
1411
1438
|
end
|
1412
1439
|
|
1413
|
-
# Deletes a project from
|
1440
|
+
# Deletes a project from IoT SiteWise Monitor.
|
1414
1441
|
#
|
1415
1442
|
# @option params [required, String] :project_id
|
1416
1443
|
# The ID of the project.
|
@@ -1440,7 +1467,7 @@ module Aws::IoTSiteWise
|
|
1440
1467
|
end
|
1441
1468
|
|
1442
1469
|
# Describes an access policy, which specifies an identity's access to
|
1443
|
-
# an
|
1470
|
+
# an IoT SiteWise Monitor portal or project.
|
1444
1471
|
#
|
1445
1472
|
# @option params [required, String] :access_policy_id
|
1446
1473
|
# The ID of the access policy.
|
@@ -1780,9 +1807,9 @@ module Aws::IoTSiteWise
|
|
1780
1807
|
end
|
1781
1808
|
|
1782
1809
|
# Retrieves information about the default encryption configuration for
|
1783
|
-
# the
|
1784
|
-
# information, see [Key management][1] in the *
|
1785
|
-
# Guide*.
|
1810
|
+
# the Amazon Web Services account in the default or specified Region.
|
1811
|
+
# For more information, see [Key management][1] in the *IoT SiteWise
|
1812
|
+
# User Guide*.
|
1786
1813
|
#
|
1787
1814
|
#
|
1788
1815
|
#
|
@@ -1852,9 +1879,9 @@ module Aws::IoTSiteWise
|
|
1852
1879
|
# Retrieves information about a gateway capability configuration. Each
|
1853
1880
|
# gateway capability defines data sources for a gateway. A capability
|
1854
1881
|
# configuration can contain multiple data source configurations. If you
|
1855
|
-
# define OPC-UA sources for a gateway in the
|
1856
|
-
#
|
1857
|
-
#
|
1882
|
+
# define OPC-UA sources for a gateway in the IoT SiteWise console, all
|
1883
|
+
# of your OPC-UA sources are stored in one capability configuration. To
|
1884
|
+
# list all capability configurations for a gateway, use
|
1858
1885
|
# [DescribeGateway][1].
|
1859
1886
|
#
|
1860
1887
|
#
|
@@ -1866,8 +1893,8 @@ module Aws::IoTSiteWise
|
|
1866
1893
|
#
|
1867
1894
|
# @option params [required, String] :capability_namespace
|
1868
1895
|
# The namespace of the capability configuration. For example, if you
|
1869
|
-
# configure OPC-UA sources from the
|
1870
|
-
#
|
1896
|
+
# configure OPC-UA sources from the IoT SiteWise console, your OPC-UA
|
1897
|
+
# capability configuration has the namespace
|
1871
1898
|
# `iotsitewise:opcuacollector:version`, where `version` is a number such
|
1872
1899
|
# as `1`.
|
1873
1900
|
#
|
@@ -1899,7 +1926,7 @@ module Aws::IoTSiteWise
|
|
1899
1926
|
req.send_request(options)
|
1900
1927
|
end
|
1901
1928
|
|
1902
|
-
# Retrieves the current
|
1929
|
+
# Retrieves the current IoT SiteWise logging options.
|
1903
1930
|
#
|
1904
1931
|
# @return [Types::DescribeLoggingOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1905
1932
|
#
|
@@ -1936,6 +1963,8 @@ module Aws::IoTSiteWise
|
|
1936
1963
|
# * {Types::DescribePortalResponse#portal_logo_image_location #portal_logo_image_location} => Types::ImageLocation
|
1937
1964
|
# * {Types::DescribePortalResponse#role_arn #role_arn} => String
|
1938
1965
|
# * {Types::DescribePortalResponse#portal_auth_mode #portal_auth_mode} => String
|
1966
|
+
# * {Types::DescribePortalResponse#notification_sender_email #notification_sender_email} => String
|
1967
|
+
# * {Types::DescribePortalResponse#alarms #alarms} => Types::Alarms
|
1939
1968
|
#
|
1940
1969
|
# @example Request syntax with placeholder values
|
1941
1970
|
#
|
@@ -1961,6 +1990,9 @@ module Aws::IoTSiteWise
|
|
1961
1990
|
# resp.portal_logo_image_location.url #=> String
|
1962
1991
|
# resp.role_arn #=> String
|
1963
1992
|
# resp.portal_auth_mode #=> String, one of "IAM", "SSO"
|
1993
|
+
# resp.notification_sender_email #=> String
|
1994
|
+
# resp.alarms.alarm_role_arn #=> String
|
1995
|
+
# resp.alarms.notification_lambda_arn #=> String
|
1964
1996
|
#
|
1965
1997
|
#
|
1966
1998
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -2013,6 +2045,33 @@ module Aws::IoTSiteWise
|
|
2013
2045
|
req.send_request(options)
|
2014
2046
|
end
|
2015
2047
|
|
2048
|
+
# Retrieves information about the storage configuration for IoT
|
2049
|
+
# SiteWise.
|
2050
|
+
#
|
2051
|
+
# @return [Types::DescribeStorageConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2052
|
+
#
|
2053
|
+
# * {Types::DescribeStorageConfigurationResponse#storage_type #storage_type} => String
|
2054
|
+
# * {Types::DescribeStorageConfigurationResponse#multi_layer_storage #multi_layer_storage} => Types::MultiLayerStorage
|
2055
|
+
# * {Types::DescribeStorageConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
|
2056
|
+
# * {Types::DescribeStorageConfigurationResponse#last_update_date #last_update_date} => Time
|
2057
|
+
#
|
2058
|
+
# @example Response structure
|
2059
|
+
#
|
2060
|
+
# resp.storage_type #=> String, one of "SITEWISE_DEFAULT_STORAGE", "MULTI_LAYER_STORAGE"
|
2061
|
+
# resp.multi_layer_storage.customer_managed_s3_storage.s3_resource_arn #=> String
|
2062
|
+
# resp.multi_layer_storage.customer_managed_s3_storage.role_arn #=> String
|
2063
|
+
# resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
2064
|
+
# resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
2065
|
+
# resp.configuration_status.error.message #=> String
|
2066
|
+
# resp.last_update_date #=> Time
|
2067
|
+
#
|
2068
|
+
# @overload describe_storage_configuration(params = {})
|
2069
|
+
# @param [Hash] params ({})
|
2070
|
+
def describe_storage_configuration(params = {}, options = {})
|
2071
|
+
req = build_request(:describe_storage_configuration, params)
|
2072
|
+
req.send_request(options)
|
2073
|
+
end
|
2074
|
+
|
2016
2075
|
# Disassociates a child asset from the given parent asset through a
|
2017
2076
|
# hierarchy defined in the parent asset's model.
|
2018
2077
|
#
|
@@ -2024,7 +2083,7 @@ module Aws::IoTSiteWise
|
|
2024
2083
|
# different groupings of assets to be formed that all come from the same
|
2025
2084
|
# asset model. You can use the hierarchy ID to identify the correct
|
2026
2085
|
# asset to disassociate. For more information, see [Asset
|
2027
|
-
# hierarchies][1] in the *
|
2086
|
+
# hierarchies][1] in the *IoT SiteWise User Guide*.
|
2028
2087
|
#
|
2029
2088
|
#
|
2030
2089
|
#
|
@@ -2060,7 +2119,7 @@ module Aws::IoTSiteWise
|
|
2060
2119
|
end
|
2061
2120
|
|
2062
2121
|
# Gets aggregated values for an asset property. For more information,
|
2063
|
-
# see [Querying aggregates][1] in the *
|
2122
|
+
# see [Querying aggregates][1] in the *IoT SiteWise User Guide*.
|
2064
2123
|
#
|
2065
2124
|
# To identify an asset property, you must specify one of the following:
|
2066
2125
|
#
|
@@ -2082,11 +2141,11 @@ module Aws::IoTSiteWise
|
|
2082
2141
|
# The ID of the asset property.
|
2083
2142
|
#
|
2084
2143
|
# @option params [String] :property_alias
|
2085
|
-
# The
|
2086
|
-
#
|
2144
|
+
# The alias that identifies the property, such as an OPC-UA server data
|
2145
|
+
# stream path (for example,
|
2087
2146
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2088
2147
|
# see [Mapping industrial data streams to asset properties][1] in the
|
2089
|
-
# *
|
2148
|
+
# *IoT SiteWise User Guide*.
|
2090
2149
|
#
|
2091
2150
|
#
|
2092
2151
|
#
|
@@ -2118,7 +2177,7 @@ module Aws::IoTSiteWise
|
|
2118
2177
|
# The token to be used for the next set of paginated results.
|
2119
2178
|
#
|
2120
2179
|
# @option params [Integer] :max_results
|
2121
|
-
# The maximum number of results to
|
2180
|
+
# The maximum number of results to return for each paginated request.
|
2122
2181
|
#
|
2123
2182
|
# Default: 100
|
2124
2183
|
#
|
@@ -2166,7 +2225,7 @@ module Aws::IoTSiteWise
|
|
2166
2225
|
end
|
2167
2226
|
|
2168
2227
|
# Gets an asset property's current value. For more information, see
|
2169
|
-
# [Querying current values][1] in the *
|
2228
|
+
# [Querying current values][1] in the *IoT SiteWise User Guide*.
|
2170
2229
|
#
|
2171
2230
|
# To identify an asset property, you must specify one of the following:
|
2172
2231
|
#
|
@@ -2188,11 +2247,11 @@ module Aws::IoTSiteWise
|
|
2188
2247
|
# The ID of the asset property.
|
2189
2248
|
#
|
2190
2249
|
# @option params [String] :property_alias
|
2191
|
-
# The
|
2192
|
-
#
|
2250
|
+
# The alias that identifies the property, such as an OPC-UA server data
|
2251
|
+
# stream path (for example,
|
2193
2252
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2194
2253
|
# see [Mapping industrial data streams to asset properties][1] in the
|
2195
|
-
# *
|
2254
|
+
# *IoT SiteWise User Guide*.
|
2196
2255
|
#
|
2197
2256
|
#
|
2198
2257
|
#
|
@@ -2228,8 +2287,7 @@ module Aws::IoTSiteWise
|
|
2228
2287
|
end
|
2229
2288
|
|
2230
2289
|
# Gets the history of an asset property's values. For more information,
|
2231
|
-
# see [Querying historical values][1] in the *
|
2232
|
-
# Guide*.
|
2290
|
+
# see [Querying historical values][1] in the *IoT SiteWise User Guide*.
|
2233
2291
|
#
|
2234
2292
|
# To identify an asset property, you must specify one of the following:
|
2235
2293
|
#
|
@@ -2251,11 +2309,11 @@ module Aws::IoTSiteWise
|
|
2251
2309
|
# The ID of the asset property.
|
2252
2310
|
#
|
2253
2311
|
# @option params [String] :property_alias
|
2254
|
-
# The
|
2255
|
-
#
|
2312
|
+
# The alias that identifies the property, such as an OPC-UA server data
|
2313
|
+
# stream path (for example,
|
2256
2314
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2257
2315
|
# see [Mapping industrial data streams to asset properties][1] in the
|
2258
|
-
# *
|
2316
|
+
# *IoT SiteWise User Guide*.
|
2259
2317
|
#
|
2260
2318
|
#
|
2261
2319
|
#
|
@@ -2281,7 +2339,7 @@ module Aws::IoTSiteWise
|
|
2281
2339
|
# The token to be used for the next set of paginated results.
|
2282
2340
|
#
|
2283
2341
|
# @option params [Integer] :max_results
|
2284
|
-
# The maximum number of results to
|
2342
|
+
# The maximum number of results to return for each paginated request.
|
2285
2343
|
#
|
2286
2344
|
# Default: 100
|
2287
2345
|
#
|
@@ -2330,10 +2388,6 @@ module Aws::IoTSiteWise
|
|
2330
2388
|
# operation to return the interpolated temperature values for a wind
|
2331
2389
|
# turbine every 24 hours over a duration of 7 days.
|
2332
2390
|
#
|
2333
|
-
# <note markdown="1"> This API isn't available in China (Beijing).
|
2334
|
-
#
|
2335
|
-
# </note>
|
2336
|
-
#
|
2337
2391
|
# To identify an asset property, you must specify one of the following:
|
2338
2392
|
#
|
2339
2393
|
# * The `assetId` and `propertyId` of an asset property.
|
@@ -2353,11 +2407,11 @@ module Aws::IoTSiteWise
|
|
2353
2407
|
# The ID of the asset property.
|
2354
2408
|
#
|
2355
2409
|
# @option params [String] :property_alias
|
2356
|
-
# The
|
2357
|
-
#
|
2410
|
+
# The alias that identifies the property, such as an OPC-UA server data
|
2411
|
+
# stream path (for example,
|
2358
2412
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2359
2413
|
# see [Mapping industrial data streams to asset properties][1] in the
|
2360
|
-
# *
|
2414
|
+
# *IoT SiteWise User Guide*.
|
2361
2415
|
#
|
2362
2416
|
#
|
2363
2417
|
#
|
@@ -2390,7 +2444,7 @@ module Aws::IoTSiteWise
|
|
2390
2444
|
# The token to be used for the next set of paginated results.
|
2391
2445
|
#
|
2392
2446
|
# @option params [Integer] :max_results
|
2393
|
-
# The maximum number of results to
|
2447
|
+
# The maximum number of results to return for each paginated request. If
|
2394
2448
|
# not specified, the default value is 10.
|
2395
2449
|
#
|
2396
2450
|
# @option params [required, String] :type
|
@@ -2440,13 +2494,14 @@ module Aws::IoTSiteWise
|
|
2440
2494
|
req.send_request(options)
|
2441
2495
|
end
|
2442
2496
|
|
2443
|
-
# Retrieves a paginated list of access policies for an identity (an
|
2444
|
-
# SSO user, an
|
2445
|
-
# Monitor resource (a portal or project).
|
2497
|
+
# Retrieves a paginated list of access policies for an identity (an
|
2498
|
+
# Amazon Web Services SSO user, an Amazon Web Services SSO group, or an
|
2499
|
+
# IAM user) or an IoT SiteWise Monitor resource (a portal or project).
|
2446
2500
|
#
|
2447
2501
|
# @option params [String] :identity_type
|
2448
|
-
# The type of identity (
|
2449
|
-
# parameter is required if you
|
2502
|
+
# The type of identity (Amazon Web Services SSO user, Amazon Web
|
2503
|
+
# Services SSO group, or IAM user). This parameter is required if you
|
2504
|
+
# specify `identityId`.
|
2450
2505
|
#
|
2451
2506
|
# @option params [String] :identity_id
|
2452
2507
|
# The ID of the identity. This parameter is required if you specify
|
@@ -2473,7 +2528,7 @@ module Aws::IoTSiteWise
|
|
2473
2528
|
# The token to be used for the next set of paginated results.
|
2474
2529
|
#
|
2475
2530
|
# @option params [Integer] :max_results
|
2476
|
-
# The maximum number of results to
|
2531
|
+
# The maximum number of results to return for each paginated request.
|
2477
2532
|
#
|
2478
2533
|
# Default: 50
|
2479
2534
|
#
|
@@ -2524,7 +2579,7 @@ module Aws::IoTSiteWise
|
|
2524
2579
|
# The token to be used for the next set of paginated results.
|
2525
2580
|
#
|
2526
2581
|
# @option params [Integer] :max_results
|
2527
|
-
# The maximum number of results to
|
2582
|
+
# The maximum number of results to return for each paginated request.
|
2528
2583
|
#
|
2529
2584
|
# Default: 50
|
2530
2585
|
#
|
@@ -2585,7 +2640,7 @@ module Aws::IoTSiteWise
|
|
2585
2640
|
# The token to be used for the next set of paginated results.
|
2586
2641
|
#
|
2587
2642
|
# @option params [Integer] :max_results
|
2588
|
-
# The maximum number of results to
|
2643
|
+
# The maximum number of results to return for each paginated request.
|
2589
2644
|
#
|
2590
2645
|
# @return [Types::ListAssetRelationshipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2591
2646
|
#
|
@@ -2639,7 +2694,7 @@ module Aws::IoTSiteWise
|
|
2639
2694
|
# The token to be used for the next set of paginated results.
|
2640
2695
|
#
|
2641
2696
|
# @option params [Integer] :max_results
|
2642
|
-
# The maximum number of results to
|
2697
|
+
# The maximum number of results to return for each paginated request.
|
2643
2698
|
#
|
2644
2699
|
# Default: 50
|
2645
2700
|
#
|
@@ -2717,8 +2772,8 @@ module Aws::IoTSiteWise
|
|
2717
2772
|
# [DescribeAssetModel][2] operations. This parameter is required if you
|
2718
2773
|
# choose `CHILD` for `traversalDirection`.
|
2719
2774
|
#
|
2720
|
-
# For more information, see [Asset hierarchies][3] in the *
|
2721
|
-
#
|
2775
|
+
# For more information, see [Asset hierarchies][3] in the *IoT SiteWise
|
2776
|
+
# User Guide*.
|
2722
2777
|
#
|
2723
2778
|
#
|
2724
2779
|
#
|
@@ -2742,7 +2797,7 @@ module Aws::IoTSiteWise
|
|
2742
2797
|
# The token to be used for the next set of paginated results.
|
2743
2798
|
#
|
2744
2799
|
# @option params [Integer] :max_results
|
2745
|
-
# The maximum number of results to
|
2800
|
+
# The maximum number of results to return for each paginated request.
|
2746
2801
|
#
|
2747
2802
|
# Default: 50
|
2748
2803
|
#
|
@@ -2787,8 +2842,8 @@ module Aws::IoTSiteWise
|
|
2787
2842
|
req.send_request(options)
|
2788
2843
|
end
|
2789
2844
|
|
2790
|
-
# Retrieves a paginated list of dashboards for an
|
2791
|
-
#
|
2845
|
+
# Retrieves a paginated list of dashboards for an IoT SiteWise Monitor
|
2846
|
+
# project.
|
2792
2847
|
#
|
2793
2848
|
# @option params [required, String] :project_id
|
2794
2849
|
# The ID of the project.
|
@@ -2797,7 +2852,7 @@ module Aws::IoTSiteWise
|
|
2797
2852
|
# The token to be used for the next set of paginated results.
|
2798
2853
|
#
|
2799
2854
|
# @option params [Integer] :max_results
|
2800
|
-
# The maximum number of results to
|
2855
|
+
# The maximum number of results to return for each paginated request.
|
2801
2856
|
#
|
2802
2857
|
# Default: 50
|
2803
2858
|
#
|
@@ -2839,7 +2894,7 @@ module Aws::IoTSiteWise
|
|
2839
2894
|
# The token to be used for the next set of paginated results.
|
2840
2895
|
#
|
2841
2896
|
# @option params [Integer] :max_results
|
2842
|
-
# The maximum number of results to
|
2897
|
+
# The maximum number of results to return for each paginated request.
|
2843
2898
|
#
|
2844
2899
|
# Default: 50
|
2845
2900
|
#
|
@@ -2876,13 +2931,13 @@ module Aws::IoTSiteWise
|
|
2876
2931
|
req.send_request(options)
|
2877
2932
|
end
|
2878
2933
|
|
2879
|
-
# Retrieves a paginated list of
|
2934
|
+
# Retrieves a paginated list of IoT SiteWise Monitor portals.
|
2880
2935
|
#
|
2881
2936
|
# @option params [String] :next_token
|
2882
2937
|
# The token to be used for the next set of paginated results.
|
2883
2938
|
#
|
2884
2939
|
# @option params [Integer] :max_results
|
2885
|
-
# The maximum number of results to
|
2940
|
+
# The maximum number of results to return for each paginated request.
|
2886
2941
|
#
|
2887
2942
|
# Default: 50
|
2888
2943
|
#
|
@@ -2922,8 +2977,8 @@ module Aws::IoTSiteWise
|
|
2922
2977
|
req.send_request(options)
|
2923
2978
|
end
|
2924
2979
|
|
2925
|
-
# Retrieves a paginated list of assets associated with an
|
2926
|
-
#
|
2980
|
+
# Retrieves a paginated list of assets associated with an IoT SiteWise
|
2981
|
+
# Monitor project.
|
2927
2982
|
#
|
2928
2983
|
# @option params [required, String] :project_id
|
2929
2984
|
# The ID of the project.
|
@@ -2932,7 +2987,7 @@ module Aws::IoTSiteWise
|
|
2932
2987
|
# The token to be used for the next set of paginated results.
|
2933
2988
|
#
|
2934
2989
|
# @option params [Integer] :max_results
|
2935
|
-
# The maximum number of results to
|
2990
|
+
# The maximum number of results to return for each paginated request.
|
2936
2991
|
#
|
2937
2992
|
# Default: 50
|
2938
2993
|
#
|
@@ -2964,7 +3019,7 @@ module Aws::IoTSiteWise
|
|
2964
3019
|
req.send_request(options)
|
2965
3020
|
end
|
2966
3021
|
|
2967
|
-
# Retrieves a paginated list of projects for an
|
3022
|
+
# Retrieves a paginated list of projects for an IoT SiteWise Monitor
|
2968
3023
|
# portal.
|
2969
3024
|
#
|
2970
3025
|
# @option params [required, String] :portal_id
|
@@ -2974,7 +3029,7 @@ module Aws::IoTSiteWise
|
|
2974
3029
|
# The token to be used for the next set of paginated results.
|
2975
3030
|
#
|
2976
3031
|
# @option params [Integer] :max_results
|
2977
|
-
# The maximum number of results to
|
3032
|
+
# The maximum number of results to return for each paginated request.
|
2978
3033
|
#
|
2979
3034
|
# Default: 50
|
2980
3035
|
#
|
@@ -3010,7 +3065,7 @@ module Aws::IoTSiteWise
|
|
3010
3065
|
req.send_request(options)
|
3011
3066
|
end
|
3012
3067
|
|
3013
|
-
# Retrieves the list of tags for an
|
3068
|
+
# Retrieves the list of tags for an IoT SiteWise resource.
|
3014
3069
|
#
|
3015
3070
|
# @option params [required, String] :resource_arn
|
3016
3071
|
# The [ARN][1] of the resource.
|
@@ -3041,9 +3096,9 @@ module Aws::IoTSiteWise
|
|
3041
3096
|
req.send_request(options)
|
3042
3097
|
end
|
3043
3098
|
|
3044
|
-
# Sets the default encryption configuration for the
|
3045
|
-
# more information, see [Key management][1] in the *
|
3046
|
-
# User Guide*.
|
3099
|
+
# Sets the default encryption configuration for the Amazon Web Services
|
3100
|
+
# account. For more information, see [Key management][1] in the *IoT
|
3101
|
+
# SiteWise User Guide*.
|
3047
3102
|
#
|
3048
3103
|
#
|
3049
3104
|
#
|
@@ -3054,8 +3109,7 @@ module Aws::IoTSiteWise
|
|
3054
3109
|
#
|
3055
3110
|
# @option params [String] :kms_key_id
|
3056
3111
|
# The Key ID of the customer managed customer master key (CMK) used for
|
3057
|
-
#
|
3058
|
-
# `KMS_BASED_ENCRYPTION`.
|
3112
|
+
# KMS encryption. This is required if you use `KMS_BASED_ENCRYPTION`.
|
3059
3113
|
#
|
3060
3114
|
# @return [Types::PutDefaultEncryptionConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3061
3115
|
#
|
@@ -3085,7 +3139,7 @@ module Aws::IoTSiteWise
|
|
3085
3139
|
req.send_request(options)
|
3086
3140
|
end
|
3087
3141
|
|
3088
|
-
# Sets logging options for
|
3142
|
+
# Sets logging options for IoT SiteWise.
|
3089
3143
|
#
|
3090
3144
|
# @option params [required, Types::LoggingOptions] :logging_options
|
3091
3145
|
# The logging options to set.
|
@@ -3107,8 +3161,60 @@ module Aws::IoTSiteWise
|
|
3107
3161
|
req.send_request(options)
|
3108
3162
|
end
|
3109
3163
|
|
3110
|
-
#
|
3111
|
-
#
|
3164
|
+
# Configures storage settings for IoT SiteWise.
|
3165
|
+
#
|
3166
|
+
# @option params [required, String] :storage_type
|
3167
|
+
# The type of storage that you specified for your data. The storage type
|
3168
|
+
# can be one of the following values:
|
3169
|
+
#
|
3170
|
+
# * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise replicates your data into
|
3171
|
+
# a service managed database.
|
3172
|
+
#
|
3173
|
+
# * `MULTI_LAYER_STORAGE` – IoT SiteWise replicates your data into a
|
3174
|
+
# service managed database and saves a copy of your raw data and
|
3175
|
+
# metadata in an Amazon S3 object that you specified.
|
3176
|
+
#
|
3177
|
+
# @option params [Types::MultiLayerStorage] :multi_layer_storage
|
3178
|
+
# Identifies a storage destination. If you specified
|
3179
|
+
# `MULTI_LAYER_STORAGE` for the storage type, you must specify a
|
3180
|
+
# `MultiLayerStorage` object.
|
3181
|
+
#
|
3182
|
+
# @return [Types::PutStorageConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3183
|
+
#
|
3184
|
+
# * {Types::PutStorageConfigurationResponse#storage_type #storage_type} => String
|
3185
|
+
# * {Types::PutStorageConfigurationResponse#multi_layer_storage #multi_layer_storage} => Types::MultiLayerStorage
|
3186
|
+
# * {Types::PutStorageConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
|
3187
|
+
#
|
3188
|
+
# @example Request syntax with placeholder values
|
3189
|
+
#
|
3190
|
+
# resp = client.put_storage_configuration({
|
3191
|
+
# storage_type: "SITEWISE_DEFAULT_STORAGE", # required, accepts SITEWISE_DEFAULT_STORAGE, MULTI_LAYER_STORAGE
|
3192
|
+
# multi_layer_storage: {
|
3193
|
+
# customer_managed_s3_storage: { # required
|
3194
|
+
# s3_resource_arn: "ARN", # required
|
3195
|
+
# role_arn: "ARN", # required
|
3196
|
+
# },
|
3197
|
+
# },
|
3198
|
+
# })
|
3199
|
+
#
|
3200
|
+
# @example Response structure
|
3201
|
+
#
|
3202
|
+
# resp.storage_type #=> String, one of "SITEWISE_DEFAULT_STORAGE", "MULTI_LAYER_STORAGE"
|
3203
|
+
# resp.multi_layer_storage.customer_managed_s3_storage.s3_resource_arn #=> String
|
3204
|
+
# resp.multi_layer_storage.customer_managed_s3_storage.role_arn #=> String
|
3205
|
+
# resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
3206
|
+
# resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
3207
|
+
# resp.configuration_status.error.message #=> String
|
3208
|
+
#
|
3209
|
+
# @overload put_storage_configuration(params = {})
|
3210
|
+
# @param [Hash] params ({})
|
3211
|
+
def put_storage_configuration(params = {}, options = {})
|
3212
|
+
req = build_request(:put_storage_configuration, params)
|
3213
|
+
req.send_request(options)
|
3214
|
+
end
|
3215
|
+
|
3216
|
+
# Adds tags to an IoT SiteWise resource. If a tag already exists for the
|
3217
|
+
# resource, this operation updates the tag's value.
|
3112
3218
|
#
|
3113
3219
|
# @option params [required, String] :resource_arn
|
3114
3220
|
# The [ARN][1] of the resource to tag.
|
@@ -3119,8 +3225,8 @@ module Aws::IoTSiteWise
|
|
3119
3225
|
#
|
3120
3226
|
# @option params [required, Hash<String,String>] :tags
|
3121
3227
|
# A list of key-value pairs that contain metadata for the resource. For
|
3122
|
-
# more information, see [Tagging your
|
3123
|
-
#
|
3228
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
3229
|
+
# *IoT SiteWise User Guide*.
|
3124
3230
|
#
|
3125
3231
|
#
|
3126
3232
|
#
|
@@ -3144,7 +3250,7 @@ module Aws::IoTSiteWise
|
|
3144
3250
|
req.send_request(options)
|
3145
3251
|
end
|
3146
3252
|
|
3147
|
-
# Removes a tag from an
|
3253
|
+
# Removes a tag from an IoT SiteWise resource.
|
3148
3254
|
#
|
3149
3255
|
# @option params [required, String] :resource_arn
|
3150
3256
|
# The [ARN][1] of the resource to untag.
|
@@ -3173,17 +3279,17 @@ module Aws::IoTSiteWise
|
|
3173
3279
|
end
|
3174
3280
|
|
3175
3281
|
# Updates an existing access policy that specifies an identity's access
|
3176
|
-
# to an
|
3282
|
+
# to an IoT SiteWise Monitor portal or project resource.
|
3177
3283
|
#
|
3178
3284
|
# @option params [required, String] :access_policy_id
|
3179
3285
|
# The ID of the access policy.
|
3180
3286
|
#
|
3181
3287
|
# @option params [required, Types::Identity] :access_policy_identity
|
3182
|
-
# The identity for this access policy. Choose an
|
3183
|
-
# SSO group, or an IAM user.
|
3288
|
+
# The identity for this access policy. Choose an Amazon Web Services SSO
|
3289
|
+
# user, an Amazon Web Services SSO group, or an IAM user.
|
3184
3290
|
#
|
3185
3291
|
# @option params [required, Types::Resource] :access_policy_resource
|
3186
|
-
# The
|
3292
|
+
# The IoT SiteWise Monitor resource for this access policy. Choose
|
3187
3293
|
# either a portal or a project.
|
3188
3294
|
#
|
3189
3295
|
# @option params [required, String] :access_policy_permission
|
@@ -3238,7 +3344,7 @@ module Aws::IoTSiteWise
|
|
3238
3344
|
end
|
3239
3345
|
|
3240
3346
|
# Updates an asset's name. For more information, see [Updating assets
|
3241
|
-
# and models][1] in the *
|
3347
|
+
# and models][1] in the *IoT SiteWise User Guide*.
|
3242
3348
|
#
|
3243
3349
|
#
|
3244
3350
|
#
|
@@ -3286,20 +3392,20 @@ module Aws::IoTSiteWise
|
|
3286
3392
|
# Updates an asset model and all of the assets that were created from
|
3287
3393
|
# the model. Each asset created from the model inherits the updated
|
3288
3394
|
# asset model's property and hierarchy definitions. For more
|
3289
|
-
# information, see [Updating assets and models][1] in the *
|
3290
|
-
#
|
3395
|
+
# information, see [Updating assets and models][1] in the *IoT SiteWise
|
3396
|
+
# User Guide*.
|
3291
3397
|
#
|
3292
3398
|
# This operation overwrites the existing model with the provided model.
|
3293
3399
|
# To avoid deleting your asset model's properties or hierarchies, you
|
3294
3400
|
# must include their IDs and definitions in the updated asset model
|
3295
3401
|
# payload. For more information, see [DescribeAssetModel][2].
|
3296
3402
|
#
|
3297
|
-
# If you remove a property from an asset model,
|
3298
|
-
#
|
3299
|
-
#
|
3300
|
-
#
|
3301
|
-
#
|
3302
|
-
#
|
3403
|
+
# If you remove a property from an asset model, IoT SiteWise deletes
|
3404
|
+
# all
|
3405
|
+
# previous data for that property. If you remove a hierarchy definition
|
3406
|
+
# from an asset model, IoT SiteWise disassociates every asset associated
|
3407
|
+
# with that hierarchy. You can't change the type or data type of an
|
3408
|
+
# existing property.
|
3303
3409
|
#
|
3304
3410
|
#
|
3305
3411
|
#
|
@@ -3317,11 +3423,11 @@ module Aws::IoTSiteWise
|
|
3317
3423
|
#
|
3318
3424
|
# @option params [Array<Types::AssetModelProperty>] :asset_model_properties
|
3319
3425
|
# The updated property definitions of the asset model. For more
|
3320
|
-
# information, see [Asset properties][1] in the *
|
3426
|
+
# information, see [Asset properties][1] in the *IoT SiteWise User
|
3321
3427
|
# Guide*.
|
3322
3428
|
#
|
3323
3429
|
# You can specify up to 200 properties per asset model. For more
|
3324
|
-
# information, see [Quotas][2] in the *
|
3430
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
3325
3431
|
#
|
3326
3432
|
#
|
3327
3433
|
#
|
@@ -3332,10 +3438,10 @@ module Aws::IoTSiteWise
|
|
3332
3438
|
# The updated hierarchy definitions of the asset model. Each hierarchy
|
3333
3439
|
# specifies an asset model whose assets can be children of any other
|
3334
3440
|
# assets created from this asset model. For more information, see [Asset
|
3335
|
-
# hierarchies][1] in the *
|
3441
|
+
# hierarchies][1] in the *IoT SiteWise User Guide*.
|
3336
3442
|
#
|
3337
3443
|
# You can specify up to 10 hierarchies per asset model. For more
|
3338
|
-
# information, see [Quotas][2] in the *
|
3444
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
3339
3445
|
#
|
3340
3446
|
#
|
3341
3447
|
#
|
@@ -3506,11 +3612,11 @@ module Aws::IoTSiteWise
|
|
3506
3612
|
# The ID of the asset property to be updated.
|
3507
3613
|
#
|
3508
3614
|
# @option params [String] :property_alias
|
3509
|
-
# The
|
3510
|
-
#
|
3615
|
+
# The alias that identifies the property, such as an OPC-UA server data
|
3616
|
+
# stream path (for example,
|
3511
3617
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
3512
3618
|
# see [Mapping industrial data streams to asset properties][1] in the
|
3513
|
-
# *
|
3619
|
+
# *IoT SiteWise User Guide*.
|
3514
3620
|
#
|
3515
3621
|
# If you omit this parameter, the alias is removed from the property.
|
3516
3622
|
#
|
@@ -3520,9 +3626,9 @@ module Aws::IoTSiteWise
|
|
3520
3626
|
#
|
3521
3627
|
# @option params [String] :property_notification_state
|
3522
3628
|
# The MQTT notification state (enabled or disabled) for this asset
|
3523
|
-
# property. When the notification state is enabled,
|
3629
|
+
# property. When the notification state is enabled, IoT SiteWise
|
3524
3630
|
# publishes property value updates to a unique MQTT topic. For more
|
3525
|
-
# information, see [Interacting with other services][1] in the *
|
3631
|
+
# information, see [Interacting with other services][1] in the *IoT
|
3526
3632
|
# SiteWise User Guide*.
|
3527
3633
|
#
|
3528
3634
|
# If you omit this parameter, the notification state is set to
|
@@ -3559,7 +3665,7 @@ module Aws::IoTSiteWise
|
|
3559
3665
|
req.send_request(options)
|
3560
3666
|
end
|
3561
3667
|
|
3562
|
-
# Updates an
|
3668
|
+
# Updates an IoT SiteWise Monitor dashboard.
|
3563
3669
|
#
|
3564
3670
|
# @option params [required, String] :dashboard_id
|
3565
3671
|
# The ID of the dashboard to update.
|
@@ -3572,8 +3678,8 @@ module Aws::IoTSiteWise
|
|
3572
3678
|
#
|
3573
3679
|
# @option params [required, String] :dashboard_definition
|
3574
3680
|
# The new dashboard definition, as specified in a JSON literal. For
|
3575
|
-
# detailed information, see [Creating dashboards (CLI)][1] in the *
|
3576
|
-
#
|
3681
|
+
# detailed information, see [Creating dashboards (CLI)][1] in the *IoT
|
3682
|
+
# SiteWise User Guide*.
|
3577
3683
|
#
|
3578
3684
|
#
|
3579
3685
|
#
|
@@ -3633,8 +3739,8 @@ module Aws::IoTSiteWise
|
|
3633
3739
|
# Updates a gateway capability configuration or defines a new capability
|
3634
3740
|
# configuration. Each gateway capability defines data sources for a
|
3635
3741
|
# gateway. A capability configuration can contain multiple data source
|
3636
|
-
# configurations. If you define OPC-UA sources for a gateway in the
|
3637
|
-
#
|
3742
|
+
# configurations. If you define OPC-UA sources for a gateway in the IoT
|
3743
|
+
# SiteWise console, all of your OPC-UA sources are stored in one
|
3638
3744
|
# capability configuration. To list all capability configurations for a
|
3639
3745
|
# gateway, use [DescribeGateway][1].
|
3640
3746
|
#
|
@@ -3647,7 +3753,7 @@ module Aws::IoTSiteWise
|
|
3647
3753
|
#
|
3648
3754
|
# @option params [required, String] :capability_namespace
|
3649
3755
|
# The namespace of the gateway capability configuration to be updated.
|
3650
|
-
# For example, if you configure OPC-UA sources from the
|
3756
|
+
# For example, if you configure OPC-UA sources from the IoT SiteWise
|
3651
3757
|
# console, your OPC-UA capability configuration has the namespace
|
3652
3758
|
# `iotsitewise:opcuacollector:version`, where `version` is a number such
|
3653
3759
|
# as `1`.
|
@@ -3655,7 +3761,7 @@ module Aws::IoTSiteWise
|
|
3655
3761
|
# @option params [required, String] :capability_configuration
|
3656
3762
|
# The JSON document that defines the configuration for the gateway
|
3657
3763
|
# capability. For more information, see [Configuring data sources
|
3658
|
-
# (CLI)][1] in the *
|
3764
|
+
# (CLI)][1] in the *IoT SiteWise User Guide*.
|
3659
3765
|
#
|
3660
3766
|
#
|
3661
3767
|
#
|
@@ -3686,7 +3792,7 @@ module Aws::IoTSiteWise
|
|
3686
3792
|
req.send_request(options)
|
3687
3793
|
end
|
3688
3794
|
|
3689
|
-
# Updates an
|
3795
|
+
# Updates an IoT SiteWise Monitor portal.
|
3690
3796
|
#
|
3691
3797
|
# @option params [required, String] :portal_id
|
3692
3798
|
# The ID of the portal to update.
|
@@ -3698,7 +3804,7 @@ module Aws::IoTSiteWise
|
|
3698
3804
|
# A new description for the portal.
|
3699
3805
|
#
|
3700
3806
|
# @option params [required, String] :portal_contact_email
|
3701
|
-
# The
|
3807
|
+
# The Amazon Web Services administrator's contact email address.
|
3702
3808
|
#
|
3703
3809
|
# @option params [Types::Image] :portal_logo_image
|
3704
3810
|
# Contains an image that is one of the following:
|
@@ -3710,9 +3816,9 @@ module Aws::IoTSiteWise
|
|
3710
3816
|
#
|
3711
3817
|
# @option params [required, String] :role_arn
|
3712
3818
|
# The [ARN][1] of a service role that allows the portal's users to
|
3713
|
-
# access your
|
3714
|
-
# information, see [Using service roles for
|
3715
|
-
#
|
3819
|
+
# access your IoT SiteWise resources on your behalf. For more
|
3820
|
+
# information, see [Using service roles for IoT SiteWise Monitor][2] in
|
3821
|
+
# the *IoT SiteWise User Guide*.
|
3716
3822
|
#
|
3717
3823
|
#
|
3718
3824
|
#
|
@@ -3727,6 +3833,20 @@ module Aws::IoTSiteWise
|
|
3727
3833
|
# **A suitable default value is auto-generated.** You should normally
|
3728
3834
|
# not need to pass this option.**
|
3729
3835
|
#
|
3836
|
+
# @option params [String] :notification_sender_email
|
3837
|
+
# The email address that sends alarm notifications.
|
3838
|
+
#
|
3839
|
+
# @option params [Types::Alarms] :alarms
|
3840
|
+
# Contains the configuration information of an alarm created in an IoT
|
3841
|
+
# SiteWise Monitor portal. You can use the alarm to monitor an asset
|
3842
|
+
# property and get notified when the asset property value is outside a
|
3843
|
+
# specified range. For more information, see [Monitoring with alarms][1]
|
3844
|
+
# in the *IoT SiteWise Application Guide*.
|
3845
|
+
#
|
3846
|
+
#
|
3847
|
+
#
|
3848
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
|
3849
|
+
#
|
3730
3850
|
# @return [Types::UpdatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3731
3851
|
#
|
3732
3852
|
# * {Types::UpdatePortalResponse#portal_status #portal_status} => Types::PortalStatus
|
@@ -3747,6 +3867,11 @@ module Aws::IoTSiteWise
|
|
3747
3867
|
# },
|
3748
3868
|
# role_arn: "ARN", # required
|
3749
3869
|
# client_token: "ClientToken",
|
3870
|
+
# notification_sender_email: "Email",
|
3871
|
+
# alarms: {
|
3872
|
+
# alarm_role_arn: "ARN", # required
|
3873
|
+
# notification_lambda_arn: "ARN",
|
3874
|
+
# },
|
3750
3875
|
# })
|
3751
3876
|
#
|
3752
3877
|
# @example Response structure
|
@@ -3762,7 +3887,7 @@ module Aws::IoTSiteWise
|
|
3762
3887
|
req.send_request(options)
|
3763
3888
|
end
|
3764
3889
|
|
3765
|
-
# Updates an
|
3890
|
+
# Updates an IoT SiteWise Monitor project.
|
3766
3891
|
#
|
3767
3892
|
# @option params [required, String] :project_id
|
3768
3893
|
# The ID of the project to update.
|
@@ -3812,7 +3937,7 @@ module Aws::IoTSiteWise
|
|
3812
3937
|
params: params,
|
3813
3938
|
config: config)
|
3814
3939
|
context[:gem_name] = 'aws-sdk-iotsitewise'
|
3815
|
-
context[:gem_version] = '1.
|
3940
|
+
context[:gem_version] = '1.26.0'
|
3816
3941
|
Seahorse::Client::Request.new(handlers, context)
|
3817
3942
|
end
|
3818
3943
|
|