aws-sdk-iotsitewise 1.21.0 → 1.25.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7c789475f03b89d05d057235f39f636a2d8c27a90e6b738487cc818a1f00afa9
4
- data.tar.gz: b4fa70938975588276e959ed51a34ea23dd60e60cf9231b94b09412976a0c3dc
3
+ metadata.gz: 35824bf430fb3b0525893772f0421934d7e1af344bba3af10561cce7255b5927
4
+ data.tar.gz: 310af6c10f6cb4237b82c95093b2882fea3256b726aecd85e71601d35ed7872f
5
5
  SHA512:
6
- metadata.gz: 8c54299f95b473647d1a71e79294147053c33eb20beebc1170daac936c79a4c1378b83a7910368a542806084840ba260909e485c19286e41a00dc6bd15876a7d
7
- data.tar.gz: 8137218471e20566afeea65fd599988eef7028a0316f7cd18c74629158927d78f5c2026f08cf456776ac5ad8e679f8193066eb9c9dc3d012c9f931b3b02dc567
6
+ metadata.gz: ddb45048c0006e1f9ded00fa82730d1bb382d3250c6824d05c12bca8ec36183bcb69a4b539ae4c27e06fecac1b3222d545a12733ba3d4d0d7a70a626488181bc
7
+ data.tar.gz: 5eaf9b95e614bda702bf6062932e5c19934ed0b99e0ba1f2bbe5dcfe4c0d0cfc26f4addb45b964351b12099ebc9a2fc6c22203fa84f6bec3385bc95468fbb921
data/CHANGELOG.md CHANGED
@@ -1,6 +1,26 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.25.0 (2021-07-15)
5
+ ------------------
6
+
7
+ * 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.
8
+
9
+ 1.24.0 (2021-07-07)
10
+ ------------------
11
+
12
+ * Feature - This release add storage configuration APIs for AWS IoT SiteWise.
13
+
14
+ 1.23.0 (2021-05-27)
15
+ ------------------
16
+
17
+ * Feature - IoT SiteWise Monitor Portal API updates to add alarms feature configuration.
18
+
19
+ 1.22.0 (2021-05-18)
20
+ ------------------
21
+
22
+ * Feature - Documentation updates for AWS IoT SiteWise.
23
+
4
24
  1.21.0 (2021-04-28)
5
25
  ------------------
6
26
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.21.0
1
+ 1.25.0
@@ -49,6 +49,6 @@ require_relative 'aws-sdk-iotsitewise/customizations'
49
49
  # @!group service
50
50
  module Aws::IoTSiteWise
51
51
 
52
- GEM_VERSION = '1.21.0'
52
+ GEM_VERSION = '1.25.0'
53
53
 
54
54
  end
@@ -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 *AWS IoT SiteWise User Guide*.
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
- # *AWS IoT SiteWise User Guide*.
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 AWS IoT SiteWise Monitor
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 AWS IoT SiteWise
424
- # Monitor project.
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 AWS IoT SiteWise. Each value
467
- # is a timestamp-quality-value (TQV) data point. For more information,
468
- # see [Ingesting data using the API][1] in the *AWS IoT SiteWise User
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, AWS IoT SiteWise accepts only TQVs
480
- # that have a timestamp of no more than 7 days in the past and no more
481
- # than 5 minutes in the future. AWS IoT SiteWise rejects timestamps
482
- # outside of the inclusive range of \[-7 days, +5 minutes\] and returns
483
- # a `TimestampOutOfRangeException` error.
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, AWS IoT SiteWise overwrites TQVs with
486
- # duplicate timestamps unless the newer TQV has a different quality. For
487
- # example, if you store a TQV `\{T1, GOOD, V1\}`, then storing `\{T1,
488
- # GOOD, V2\}` replaces the existing TQV.
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
- # AWS IoT SiteWise authorizes access to each
491
- # `BatchPutAssetPropertyValue` entry individually. For more information,
492
- # see [BatchPutAssetPropertyValue authorization][3] in the *AWS IoT
493
- # SiteWise User Guide*.
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 (AWS SSO
556
- # user, AWS SSO group, or IAM user) access to the specified AWS IoT
557
- # SiteWise Monitor portal or project resource.
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 AWS SSO user, an AWS
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 AWS IoT SiteWise Monitor resource for this access policy. Choose
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 AWS IoT SiteWise resources][1]
582
- # in the *AWS IoT SiteWise User Guide*.
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 *AWS IoT SiteWise User Guide*.
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 AWS IoT SiteWise resources][1] in
661
- # the *AWS IoT SiteWise User Guide*.
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 *AWS IoT SiteWise User Guide*.
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 *AWS IoT SiteWise User Guide*.
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 *AWS IoT SiteWise User Guide*.
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 *AWS IoT SiteWise User Guide*.
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 *AWS IoT SiteWise User Guide*.
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 AWS IoT SiteWise resources][1]
760
- # in the *AWS IoT SiteWise User Guide*.
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 AWS IoT SiteWise Monitor project.
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 *AWS IoT
913
- # SiteWise User Guide*.
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 AWS IoT SiteWise resources][1] in
930
- # the *AWS IoT SiteWise User Guide*.
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 AWS IoT SiteWise. For
968
- # more information, see [Ingesting data using a gateway][1] in the *AWS
969
- # IoT SiteWise User Guide*.
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 AWS IoT SiteWise resources][1] in
985
- # the *AWS IoT SiteWise User Guide*.
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. AWS IoT
1023
- # SiteWise Monitor uses AWS SSO or IAM to authenticate portal users and
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 *AWS IoT SiteWise User Guide*.
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 AWS administrator's contact email address.
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 AWS IoT SiteWise resources on your behalf. For more
1060
- # information, see [Using service roles for AWS IoT SiteWise Monitor][2]
1061
- # in the *AWS IoT SiteWise User Guide*.
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 AWS IoT SiteWise resources][1] in
1071
- # the *AWS IoT SiteWise User Guide*.
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 AWS Single Sign-On to authenticate users and
1082
- # manage user permissions. Before you can create a portal that uses
1083
- # AWS SSO, you must enable AWS SSO. For more information, see
1084
- # [Enabling AWS SSO][1] in the *AWS IoT SiteWise User Guide*. This
1085
- # option is only available in AWS Regions other than the China
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 AWS Identity and Access Management (IAM) to
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 AWS IoT SiteWise resources][1] in
1165
- # the *AWS IoT SiteWise User Guide*.
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 AWS IoT SiteWise Monitor resource. You can use this
1202
- # operation to revoke access to an AWS IoT SiteWise Monitor resource.
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 *AWS IoT SiteWise User
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 *AWS IoT SiteWise User Guide*.
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 AWS IoT SiteWise Monitor.
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 AWS IoT SiteWise. When you delete a gateway,
1356
- # some of the gateway's files remain in your gateway's file system.
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 AWS IoT SiteWise Monitor.
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 AWS IoT SiteWise Monitor.
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 AWS IoT SiteWise Monitor portal or project.
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 AWS account in the default or specified region. For more
1784
- # information, see [Key management][1] in the *AWS IoT SiteWise User
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 AWS IoT SiteWise console,
1856
- # all of your OPC-UA sources are stored in one capability configuration.
1857
- # To list all capability configurations for a gateway, use
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 AWS IoT SiteWise console, your
1870
- # OPC-UA capability configuration has the namespace
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 AWS IoT SiteWise logging options.
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 *AWS IoT SiteWise User Guide*.
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 *AWS IoT SiteWise User Guide*.
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 property alias that identifies the property, such as an OPC-UA
2086
- # server data stream path (for example,
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
- # *AWS IoT SiteWise User Guide*.
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 be returned per paginated request.
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 *AWS IoT SiteWise User Guide*.
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 property alias that identifies the property, such as an OPC-UA
2192
- # server data stream path (for example,
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
- # *AWS IoT SiteWise User Guide*.
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 *AWS IoT SiteWise User
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 property alias that identifies the property, such as an OPC-UA
2255
- # server data stream path (for example,
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
- # *AWS IoT SiteWise User Guide*.
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 be returned per paginated request.
2342
+ # The maximum number of results to return for each paginated request.
2285
2343
  #
2286
2344
  # Default: 100
2287
2345
  #
@@ -2349,11 +2407,11 @@ module Aws::IoTSiteWise
2349
2407
  # The ID of the asset property.
2350
2408
  #
2351
2409
  # @option params [String] :property_alias
2352
- # The property alias that identifies the property, such as an OPC-UA
2353
- # server data stream path (for example,
2410
+ # The alias that identifies the property, such as an OPC-UA server data
2411
+ # stream path (for example,
2354
2412
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
2355
2413
  # see [Mapping industrial data streams to asset properties][1] in the
2356
- # *AWS IoT SiteWise User Guide*.
2414
+ # *IoT SiteWise User Guide*.
2357
2415
  #
2358
2416
  #
2359
2417
  #
@@ -2386,7 +2444,7 @@ module Aws::IoTSiteWise
2386
2444
  # The token to be used for the next set of paginated results.
2387
2445
  #
2388
2446
  # @option params [Integer] :max_results
2389
- # The maximum number of results to be returned per paginated request. If
2447
+ # The maximum number of results to return for each paginated request. If
2390
2448
  # not specified, the default value is 10.
2391
2449
  #
2392
2450
  # @option params [required, String] :type
@@ -2436,13 +2494,14 @@ module Aws::IoTSiteWise
2436
2494
  req.send_request(options)
2437
2495
  end
2438
2496
 
2439
- # Retrieves a paginated list of access policies for an identity (an AWS
2440
- # SSO user, an AWS SSO group, or an IAM user) or an AWS IoT SiteWise
2441
- # 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).
2442
2500
  #
2443
2501
  # @option params [String] :identity_type
2444
- # The type of identity (AWS SSO user, AWS SSO group, or IAM user). This
2445
- # parameter is required if you specify `identityId`.
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`.
2446
2505
  #
2447
2506
  # @option params [String] :identity_id
2448
2507
  # The ID of the identity. This parameter is required if you specify
@@ -2469,7 +2528,7 @@ module Aws::IoTSiteWise
2469
2528
  # The token to be used for the next set of paginated results.
2470
2529
  #
2471
2530
  # @option params [Integer] :max_results
2472
- # The maximum number of results to be returned per paginated request.
2531
+ # The maximum number of results to return for each paginated request.
2473
2532
  #
2474
2533
  # Default: 50
2475
2534
  #
@@ -2520,7 +2579,7 @@ module Aws::IoTSiteWise
2520
2579
  # The token to be used for the next set of paginated results.
2521
2580
  #
2522
2581
  # @option params [Integer] :max_results
2523
- # The maximum number of results to be returned per paginated request.
2582
+ # The maximum number of results to return for each paginated request.
2524
2583
  #
2525
2584
  # Default: 50
2526
2585
  #
@@ -2581,7 +2640,7 @@ module Aws::IoTSiteWise
2581
2640
  # The token to be used for the next set of paginated results.
2582
2641
  #
2583
2642
  # @option params [Integer] :max_results
2584
- # The maximum number of results to be returned per paginated request.
2643
+ # The maximum number of results to return for each paginated request.
2585
2644
  #
2586
2645
  # @return [Types::ListAssetRelationshipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2587
2646
  #
@@ -2635,7 +2694,7 @@ module Aws::IoTSiteWise
2635
2694
  # The token to be used for the next set of paginated results.
2636
2695
  #
2637
2696
  # @option params [Integer] :max_results
2638
- # The maximum number of results to be returned per paginated request.
2697
+ # The maximum number of results to return for each paginated request.
2639
2698
  #
2640
2699
  # Default: 50
2641
2700
  #
@@ -2713,8 +2772,8 @@ module Aws::IoTSiteWise
2713
2772
  # [DescribeAssetModel][2] operations. This parameter is required if you
2714
2773
  # choose `CHILD` for `traversalDirection`.
2715
2774
  #
2716
- # For more information, see [Asset hierarchies][3] in the *AWS IoT
2717
- # SiteWise User Guide*.
2775
+ # For more information, see [Asset hierarchies][3] in the *IoT SiteWise
2776
+ # User Guide*.
2718
2777
  #
2719
2778
  #
2720
2779
  #
@@ -2738,7 +2797,7 @@ module Aws::IoTSiteWise
2738
2797
  # The token to be used for the next set of paginated results.
2739
2798
  #
2740
2799
  # @option params [Integer] :max_results
2741
- # The maximum number of results to be returned per paginated request.
2800
+ # The maximum number of results to return for each paginated request.
2742
2801
  #
2743
2802
  # Default: 50
2744
2803
  #
@@ -2783,8 +2842,8 @@ module Aws::IoTSiteWise
2783
2842
  req.send_request(options)
2784
2843
  end
2785
2844
 
2786
- # Retrieves a paginated list of dashboards for an AWS IoT SiteWise
2787
- # Monitor project.
2845
+ # Retrieves a paginated list of dashboards for an IoT SiteWise Monitor
2846
+ # project.
2788
2847
  #
2789
2848
  # @option params [required, String] :project_id
2790
2849
  # The ID of the project.
@@ -2793,7 +2852,7 @@ module Aws::IoTSiteWise
2793
2852
  # The token to be used for the next set of paginated results.
2794
2853
  #
2795
2854
  # @option params [Integer] :max_results
2796
- # The maximum number of results to be returned per paginated request.
2855
+ # The maximum number of results to return for each paginated request.
2797
2856
  #
2798
2857
  # Default: 50
2799
2858
  #
@@ -2835,7 +2894,7 @@ module Aws::IoTSiteWise
2835
2894
  # The token to be used for the next set of paginated results.
2836
2895
  #
2837
2896
  # @option params [Integer] :max_results
2838
- # The maximum number of results to be returned per paginated request.
2897
+ # The maximum number of results to return for each paginated request.
2839
2898
  #
2840
2899
  # Default: 50
2841
2900
  #
@@ -2872,13 +2931,13 @@ module Aws::IoTSiteWise
2872
2931
  req.send_request(options)
2873
2932
  end
2874
2933
 
2875
- # Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
2934
+ # Retrieves a paginated list of IoT SiteWise Monitor portals.
2876
2935
  #
2877
2936
  # @option params [String] :next_token
2878
2937
  # The token to be used for the next set of paginated results.
2879
2938
  #
2880
2939
  # @option params [Integer] :max_results
2881
- # The maximum number of results to be returned per paginated request.
2940
+ # The maximum number of results to return for each paginated request.
2882
2941
  #
2883
2942
  # Default: 50
2884
2943
  #
@@ -2918,8 +2977,8 @@ module Aws::IoTSiteWise
2918
2977
  req.send_request(options)
2919
2978
  end
2920
2979
 
2921
- # Retrieves a paginated list of assets associated with an AWS IoT
2922
- # SiteWise Monitor project.
2980
+ # Retrieves a paginated list of assets associated with an IoT SiteWise
2981
+ # Monitor project.
2923
2982
  #
2924
2983
  # @option params [required, String] :project_id
2925
2984
  # The ID of the project.
@@ -2928,7 +2987,7 @@ module Aws::IoTSiteWise
2928
2987
  # The token to be used for the next set of paginated results.
2929
2988
  #
2930
2989
  # @option params [Integer] :max_results
2931
- # The maximum number of results to be returned per paginated request.
2990
+ # The maximum number of results to return for each paginated request.
2932
2991
  #
2933
2992
  # Default: 50
2934
2993
  #
@@ -2960,7 +3019,7 @@ module Aws::IoTSiteWise
2960
3019
  req.send_request(options)
2961
3020
  end
2962
3021
 
2963
- # Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor
3022
+ # Retrieves a paginated list of projects for an IoT SiteWise Monitor
2964
3023
  # portal.
2965
3024
  #
2966
3025
  # @option params [required, String] :portal_id
@@ -2970,7 +3029,7 @@ module Aws::IoTSiteWise
2970
3029
  # The token to be used for the next set of paginated results.
2971
3030
  #
2972
3031
  # @option params [Integer] :max_results
2973
- # The maximum number of results to be returned per paginated request.
3032
+ # The maximum number of results to return for each paginated request.
2974
3033
  #
2975
3034
  # Default: 50
2976
3035
  #
@@ -3006,7 +3065,7 @@ module Aws::IoTSiteWise
3006
3065
  req.send_request(options)
3007
3066
  end
3008
3067
 
3009
- # Retrieves the list of tags for an AWS IoT SiteWise resource.
3068
+ # Retrieves the list of tags for an IoT SiteWise resource.
3010
3069
  #
3011
3070
  # @option params [required, String] :resource_arn
3012
3071
  # The [ARN][1] of the resource.
@@ -3037,9 +3096,9 @@ module Aws::IoTSiteWise
3037
3096
  req.send_request(options)
3038
3097
  end
3039
3098
 
3040
- # Sets the default encryption configuration for the AWS account. For
3041
- # more information, see [Key management][1] in the *AWS IoT SiteWise
3042
- # 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*.
3043
3102
  #
3044
3103
  #
3045
3104
  #
@@ -3050,8 +3109,7 @@ module Aws::IoTSiteWise
3050
3109
  #
3051
3110
  # @option params [String] :kms_key_id
3052
3111
  # The Key ID of the customer managed customer master key (CMK) used for
3053
- # AWS KMS encryption. This is required if you use
3054
- # `KMS_BASED_ENCRYPTION`.
3112
+ # KMS encryption. This is required if you use `KMS_BASED_ENCRYPTION`.
3055
3113
  #
3056
3114
  # @return [Types::PutDefaultEncryptionConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3057
3115
  #
@@ -3081,7 +3139,7 @@ module Aws::IoTSiteWise
3081
3139
  req.send_request(options)
3082
3140
  end
3083
3141
 
3084
- # Sets logging options for AWS IoT SiteWise.
3142
+ # Sets logging options for IoT SiteWise.
3085
3143
  #
3086
3144
  # @option params [required, Types::LoggingOptions] :logging_options
3087
3145
  # The logging options to set.
@@ -3103,8 +3161,60 @@ module Aws::IoTSiteWise
3103
3161
  req.send_request(options)
3104
3162
  end
3105
3163
 
3106
- # Adds tags to an AWS IoT SiteWise resource. If a tag already exists for
3107
- # the resource, this operation updates the tag's value.
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.
3108
3218
  #
3109
3219
  # @option params [required, String] :resource_arn
3110
3220
  # The [ARN][1] of the resource to tag.
@@ -3115,8 +3225,8 @@ module Aws::IoTSiteWise
3115
3225
  #
3116
3226
  # @option params [required, Hash<String,String>] :tags
3117
3227
  # A list of key-value pairs that contain metadata for the resource. For
3118
- # more information, see [Tagging your AWS IoT SiteWise resources][1] in
3119
- # the *AWS IoT SiteWise User Guide*.
3228
+ # more information, see [Tagging your IoT SiteWise resources][1] in the
3229
+ # *IoT SiteWise User Guide*.
3120
3230
  #
3121
3231
  #
3122
3232
  #
@@ -3140,7 +3250,7 @@ module Aws::IoTSiteWise
3140
3250
  req.send_request(options)
3141
3251
  end
3142
3252
 
3143
- # Removes a tag from an AWS IoT SiteWise resource.
3253
+ # Removes a tag from an IoT SiteWise resource.
3144
3254
  #
3145
3255
  # @option params [required, String] :resource_arn
3146
3256
  # The [ARN][1] of the resource to untag.
@@ -3169,17 +3279,17 @@ module Aws::IoTSiteWise
3169
3279
  end
3170
3280
 
3171
3281
  # Updates an existing access policy that specifies an identity's access
3172
- # to an AWS IoT SiteWise Monitor portal or project resource.
3282
+ # to an IoT SiteWise Monitor portal or project resource.
3173
3283
  #
3174
3284
  # @option params [required, String] :access_policy_id
3175
3285
  # The ID of the access policy.
3176
3286
  #
3177
3287
  # @option params [required, Types::Identity] :access_policy_identity
3178
- # The identity for this access policy. Choose an AWS SSO user, an AWS
3179
- # 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.
3180
3290
  #
3181
3291
  # @option params [required, Types::Resource] :access_policy_resource
3182
- # The AWS IoT SiteWise Monitor resource for this access policy. Choose
3292
+ # The IoT SiteWise Monitor resource for this access policy. Choose
3183
3293
  # either a portal or a project.
3184
3294
  #
3185
3295
  # @option params [required, String] :access_policy_permission
@@ -3234,7 +3344,7 @@ module Aws::IoTSiteWise
3234
3344
  end
3235
3345
 
3236
3346
  # Updates an asset's name. For more information, see [Updating assets
3237
- # and models][1] in the *AWS IoT SiteWise User Guide*.
3347
+ # and models][1] in the *IoT SiteWise User Guide*.
3238
3348
  #
3239
3349
  #
3240
3350
  #
@@ -3282,20 +3392,20 @@ module Aws::IoTSiteWise
3282
3392
  # Updates an asset model and all of the assets that were created from
3283
3393
  # the model. Each asset created from the model inherits the updated
3284
3394
  # asset model's property and hierarchy definitions. For more
3285
- # information, see [Updating assets and models][1] in the *AWS IoT
3286
- # SiteWise User Guide*.
3395
+ # information, see [Updating assets and models][1] in the *IoT SiteWise
3396
+ # User Guide*.
3287
3397
  #
3288
3398
  # This operation overwrites the existing model with the provided model.
3289
3399
  # To avoid deleting your asset model's properties or hierarchies, you
3290
3400
  # must include their IDs and definitions in the updated asset model
3291
3401
  # payload. For more information, see [DescribeAssetModel][2].
3292
3402
  #
3293
- # If you remove a property from an asset model, AWS IoT SiteWise
3294
- # deletes
3295
- # all previous data for that property. If you remove a hierarchy
3296
- # definition from an asset model, AWS IoT SiteWise disassociates every
3297
- # asset associated with that hierarchy. You can't change the type or
3298
- # data type of an existing property.
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.
3299
3409
  #
3300
3410
  #
3301
3411
  #
@@ -3313,11 +3423,11 @@ module Aws::IoTSiteWise
3313
3423
  #
3314
3424
  # @option params [Array<Types::AssetModelProperty>] :asset_model_properties
3315
3425
  # The updated property definitions of the asset model. For more
3316
- # information, see [Asset properties][1] in the *AWS IoT SiteWise User
3426
+ # information, see [Asset properties][1] in the *IoT SiteWise User
3317
3427
  # Guide*.
3318
3428
  #
3319
3429
  # You can specify up to 200 properties per asset model. For more
3320
- # information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
3430
+ # information, see [Quotas][2] in the *IoT SiteWise User Guide*.
3321
3431
  #
3322
3432
  #
3323
3433
  #
@@ -3328,10 +3438,10 @@ module Aws::IoTSiteWise
3328
3438
  # The updated hierarchy definitions of the asset model. Each hierarchy
3329
3439
  # specifies an asset model whose assets can be children of any other
3330
3440
  # assets created from this asset model. For more information, see [Asset
3331
- # hierarchies][1] in the *AWS IoT SiteWise User Guide*.
3441
+ # hierarchies][1] in the *IoT SiteWise User Guide*.
3332
3442
  #
3333
3443
  # You can specify up to 10 hierarchies per asset model. For more
3334
- # information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
3444
+ # information, see [Quotas][2] in the *IoT SiteWise User Guide*.
3335
3445
  #
3336
3446
  #
3337
3447
  #
@@ -3502,11 +3612,11 @@ module Aws::IoTSiteWise
3502
3612
  # The ID of the asset property to be updated.
3503
3613
  #
3504
3614
  # @option params [String] :property_alias
3505
- # The property alias that identifies the property, such as an OPC-UA
3506
- # server data stream path (for example,
3615
+ # The alias that identifies the property, such as an OPC-UA server data
3616
+ # stream path (for example,
3507
3617
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
3508
3618
  # see [Mapping industrial data streams to asset properties][1] in the
3509
- # *AWS IoT SiteWise User Guide*.
3619
+ # *IoT SiteWise User Guide*.
3510
3620
  #
3511
3621
  # If you omit this parameter, the alias is removed from the property.
3512
3622
  #
@@ -3516,9 +3626,9 @@ module Aws::IoTSiteWise
3516
3626
  #
3517
3627
  # @option params [String] :property_notification_state
3518
3628
  # The MQTT notification state (enabled or disabled) for this asset
3519
- # property. When the notification state is enabled, AWS IoT SiteWise
3629
+ # property. When the notification state is enabled, IoT SiteWise
3520
3630
  # publishes property value updates to a unique MQTT topic. For more
3521
- # information, see [Interacting with other services][1] in the *AWS IoT
3631
+ # information, see [Interacting with other services][1] in the *IoT
3522
3632
  # SiteWise User Guide*.
3523
3633
  #
3524
3634
  # If you omit this parameter, the notification state is set to
@@ -3555,7 +3665,7 @@ module Aws::IoTSiteWise
3555
3665
  req.send_request(options)
3556
3666
  end
3557
3667
 
3558
- # Updates an AWS IoT SiteWise Monitor dashboard.
3668
+ # Updates an IoT SiteWise Monitor dashboard.
3559
3669
  #
3560
3670
  # @option params [required, String] :dashboard_id
3561
3671
  # The ID of the dashboard to update.
@@ -3568,8 +3678,8 @@ module Aws::IoTSiteWise
3568
3678
  #
3569
3679
  # @option params [required, String] :dashboard_definition
3570
3680
  # The new dashboard definition, as specified in a JSON literal. For
3571
- # detailed information, see [Creating dashboards (CLI)][1] in the *AWS
3572
- # IoT SiteWise User Guide*.
3681
+ # detailed information, see [Creating dashboards (CLI)][1] in the *IoT
3682
+ # SiteWise User Guide*.
3573
3683
  #
3574
3684
  #
3575
3685
  #
@@ -3629,8 +3739,8 @@ module Aws::IoTSiteWise
3629
3739
  # Updates a gateway capability configuration or defines a new capability
3630
3740
  # configuration. Each gateway capability defines data sources for a
3631
3741
  # gateway. A capability configuration can contain multiple data source
3632
- # configurations. If you define OPC-UA sources for a gateway in the AWS
3633
- # IoT SiteWise console, all of your OPC-UA sources are stored in one
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
3634
3744
  # capability configuration. To list all capability configurations for a
3635
3745
  # gateway, use [DescribeGateway][1].
3636
3746
  #
@@ -3643,7 +3753,7 @@ module Aws::IoTSiteWise
3643
3753
  #
3644
3754
  # @option params [required, String] :capability_namespace
3645
3755
  # The namespace of the gateway capability configuration to be updated.
3646
- # For example, if you configure OPC-UA sources from the AWS IoT SiteWise
3756
+ # For example, if you configure OPC-UA sources from the IoT SiteWise
3647
3757
  # console, your OPC-UA capability configuration has the namespace
3648
3758
  # `iotsitewise:opcuacollector:version`, where `version` is a number such
3649
3759
  # as `1`.
@@ -3651,7 +3761,7 @@ module Aws::IoTSiteWise
3651
3761
  # @option params [required, String] :capability_configuration
3652
3762
  # The JSON document that defines the configuration for the gateway
3653
3763
  # capability. For more information, see [Configuring data sources
3654
- # (CLI)][1] in the *AWS IoT SiteWise User Guide*.
3764
+ # (CLI)][1] in the *IoT SiteWise User Guide*.
3655
3765
  #
3656
3766
  #
3657
3767
  #
@@ -3682,7 +3792,7 @@ module Aws::IoTSiteWise
3682
3792
  req.send_request(options)
3683
3793
  end
3684
3794
 
3685
- # Updates an AWS IoT SiteWise Monitor portal.
3795
+ # Updates an IoT SiteWise Monitor portal.
3686
3796
  #
3687
3797
  # @option params [required, String] :portal_id
3688
3798
  # The ID of the portal to update.
@@ -3694,7 +3804,7 @@ module Aws::IoTSiteWise
3694
3804
  # A new description for the portal.
3695
3805
  #
3696
3806
  # @option params [required, String] :portal_contact_email
3697
- # The AWS administrator's contact email address.
3807
+ # The Amazon Web Services administrator's contact email address.
3698
3808
  #
3699
3809
  # @option params [Types::Image] :portal_logo_image
3700
3810
  # Contains an image that is one of the following:
@@ -3706,9 +3816,9 @@ module Aws::IoTSiteWise
3706
3816
  #
3707
3817
  # @option params [required, String] :role_arn
3708
3818
  # The [ARN][1] of a service role that allows the portal's users to
3709
- # access your AWS IoT SiteWise resources on your behalf. For more
3710
- # information, see [Using service roles for AWS IoT SiteWise Monitor][2]
3711
- # in the *AWS IoT SiteWise User Guide*.
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*.
3712
3822
  #
3713
3823
  #
3714
3824
  #
@@ -3723,6 +3833,20 @@ module Aws::IoTSiteWise
3723
3833
  # **A suitable default value is auto-generated.** You should normally
3724
3834
  # not need to pass this option.**
3725
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
+ #
3726
3850
  # @return [Types::UpdatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3727
3851
  #
3728
3852
  # * {Types::UpdatePortalResponse#portal_status #portal_status} => Types::PortalStatus
@@ -3743,6 +3867,11 @@ module Aws::IoTSiteWise
3743
3867
  # },
3744
3868
  # role_arn: "ARN", # required
3745
3869
  # client_token: "ClientToken",
3870
+ # notification_sender_email: "Email",
3871
+ # alarms: {
3872
+ # alarm_role_arn: "ARN", # required
3873
+ # notification_lambda_arn: "ARN",
3874
+ # },
3746
3875
  # })
3747
3876
  #
3748
3877
  # @example Response structure
@@ -3758,7 +3887,7 @@ module Aws::IoTSiteWise
3758
3887
  req.send_request(options)
3759
3888
  end
3760
3889
 
3761
- # Updates an AWS IoT SiteWise Monitor project.
3890
+ # Updates an IoT SiteWise Monitor project.
3762
3891
  #
3763
3892
  # @option params [required, String] :project_id
3764
3893
  # The ID of the project to update.
@@ -3808,7 +3937,7 @@ module Aws::IoTSiteWise
3808
3937
  params: params,
3809
3938
  config: config)
3810
3939
  context[:gem_name] = 'aws-sdk-iotsitewise'
3811
- context[:gem_version] = '1.21.0'
3940
+ context[:gem_version] = '1.25.0'
3812
3941
  Seahorse::Client::Request.new(handlers, context)
3813
3942
  end
3814
3943