aws-sdk-iotsitewise 1.23.0 → 1.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: af97c5fc1bae0732e47062bced832b10873250302dea4c9ff75720a132828e67
4
- data.tar.gz: 0f02d47cbf5944af9ae663f643f7b79579af2d2563d3af0d433673526a63f0c6
3
+ metadata.gz: b90440fabc4d937879dbcfff213c2a8114cd5c3017d73255bb092b29c25ddee5
4
+ data.tar.gz: 6efeda662d9994377eef27293b783ea7fa767903ec79e1512f10b80a2d5bfc47
5
5
  SHA512:
6
- metadata.gz: 2cc711b359d9f3cade65fca22e6fc2410206ed311d92d5f57c67498d2693ae41815ed22be6c672a889da6fd2e6c6b12bd6921884701052174cabf3d5f3a22f30
7
- data.tar.gz: 14b228dbd31a586f44ea0babb5ecfbe9455aeeb960dc2185a252026b2492e198a6fe97e992a215ca8a0a05a9a44d91cddcba89e451ba16ec2bd9d28b5637b6e9
6
+ metadata.gz: 05ab000b2bb354e384a067ff9e0136c1b555371b83b2d20626364828e6741bf861143213e6f606eed5d6caffb1d2aea7577154eeaf12f0ad3016c18cc89e1a0d
7
+ data.tar.gz: 6bd7960685d92cc3799921231809bff5af4d95d7c75c85b7ce6159503e40d4570f3ecbc0b755ac5f42c13c12904be511d3090861179bd405166aaee728bddf34
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.24.0 (2021-07-07)
5
+ ------------------
6
+
7
+ * Feature - This release add storage configuration APIs for AWS IoT SiteWise.
8
+
4
9
  1.23.0 (2021-05-27)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.23.0
1
+ 1.24.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.23.0'
52
+ GEM_VERSION = '1.24.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 10 minutes in the future. AWS IoT SiteWise rejects timestamps
482
- # outside of the inclusive range of \[-7 days, +10 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
  #
@@ -1100,19 +1101,24 @@ module Aws::IoTSiteWise
1100
1101
  # @option params [String] :notification_sender_email
1101
1102
  # The email address that sends alarm notifications.
1102
1103
  #
1103
- # If you use the AWS IoT Events managed AWS Lambda function to manage
1104
- # your emails, you must [verify the sender email address in Amazon
1105
- # SES][1].
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
1106
  #
1107
1107
  #
1108
1108
  #
1109
- # [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html
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
1110
1111
  #
1111
1112
  # @option params [Types::Alarms] :alarms
1112
- # Contains the configuration information of an alarm created in an AWS
1113
- # IoT SiteWise Monitor portal. You can use the alarm to monitor an asset
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
1114
1115
  # property and get notified when the asset property value is outside a
1115
- # specified range. For more information, see .
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
1116
1122
  #
1117
1123
  # @return [Types::CreatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1118
1124
  #
@@ -1183,8 +1189,8 @@ module Aws::IoTSiteWise
1183
1189
  #
1184
1190
  # @option params [Hash<String,String>] :tags
1185
1191
  # A list of key-value pairs that contain metadata for the project. For
1186
- # more information, see [Tagging your AWS IoT SiteWise resources][1] in
1187
- # the *AWS IoT SiteWise User Guide*.
1192
+ # more information, see [Tagging your IoT SiteWise resources][1] in the
1193
+ # *IoT SiteWise User Guide*.
1188
1194
  #
1189
1195
  #
1190
1196
  #
@@ -1220,8 +1226,8 @@ module Aws::IoTSiteWise
1220
1226
  end
1221
1227
 
1222
1228
  # Deletes an access policy that grants the specified identity access to
1223
- # the specified AWS IoT SiteWise Monitor resource. You can use this
1224
- # 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.
1225
1231
  #
1226
1232
  # @option params [required, String] :access_policy_id
1227
1233
  # The ID of the access policy to be deleted.
@@ -1251,8 +1257,7 @@ module Aws::IoTSiteWise
1251
1257
  end
1252
1258
 
1253
1259
  # Deletes an asset. This action can't be undone. For more information,
1254
- # see [Deleting assets and models][1] in the *AWS IoT SiteWise User
1255
- # Guide*.
1260
+ # see [Deleting assets and models][1] in the *IoT SiteWise User Guide*.
1256
1261
  #
1257
1262
  # <note markdown="1"> You can't delete an asset that's associated to another asset. For
1258
1263
  # more information, see [DisassociateAssets][2].
@@ -1304,7 +1309,7 @@ module Aws::IoTSiteWise
1304
1309
  # model. Also, you can't delete an asset model if a parent asset model
1305
1310
  # exists that contains a property formula expression that depends on the
1306
1311
  # asset model that you want to delete. For more information, see
1307
- # [Deleting assets and models][1] in the *AWS IoT SiteWise User Guide*.
1312
+ # [Deleting assets and models][1] in the *IoT SiteWise User Guide*.
1308
1313
  #
1309
1314
  #
1310
1315
  #
@@ -1345,7 +1350,7 @@ module Aws::IoTSiteWise
1345
1350
  req.send_request(options)
1346
1351
  end
1347
1352
 
1348
- # Deletes a dashboard from AWS IoT SiteWise Monitor.
1353
+ # Deletes a dashboard from IoT SiteWise Monitor.
1349
1354
  #
1350
1355
  # @option params [required, String] :dashboard_id
1351
1356
  # The ID of the dashboard to delete.
@@ -1374,8 +1379,8 @@ module Aws::IoTSiteWise
1374
1379
  req.send_request(options)
1375
1380
  end
1376
1381
 
1377
- # Deletes a gateway from AWS IoT SiteWise. When you delete a gateway,
1378
- # 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.
1379
1384
  #
1380
1385
  # @option params [required, String] :gateway_id
1381
1386
  # The ID of the gateway to delete.
@@ -1395,7 +1400,7 @@ module Aws::IoTSiteWise
1395
1400
  req.send_request(options)
1396
1401
  end
1397
1402
 
1398
- # Deletes a portal from AWS IoT SiteWise Monitor.
1403
+ # Deletes a portal from IoT SiteWise Monitor.
1399
1404
  #
1400
1405
  # @option params [required, String] :portal_id
1401
1406
  # The ID of the portal to delete.
@@ -1432,7 +1437,7 @@ module Aws::IoTSiteWise
1432
1437
  req.send_request(options)
1433
1438
  end
1434
1439
 
1435
- # Deletes a project from AWS IoT SiteWise Monitor.
1440
+ # Deletes a project from IoT SiteWise Monitor.
1436
1441
  #
1437
1442
  # @option params [required, String] :project_id
1438
1443
  # The ID of the project.
@@ -1462,7 +1467,7 @@ module Aws::IoTSiteWise
1462
1467
  end
1463
1468
 
1464
1469
  # Describes an access policy, which specifies an identity's access to
1465
- # an AWS IoT SiteWise Monitor portal or project.
1470
+ # an IoT SiteWise Monitor portal or project.
1466
1471
  #
1467
1472
  # @option params [required, String] :access_policy_id
1468
1473
  # The ID of the access policy.
@@ -1802,9 +1807,9 @@ module Aws::IoTSiteWise
1802
1807
  end
1803
1808
 
1804
1809
  # Retrieves information about the default encryption configuration for
1805
- # the AWS account in the default or specified region. For more
1806
- # information, see [Key management][1] in the *AWS IoT SiteWise User
1807
- # 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*.
1808
1813
  #
1809
1814
  #
1810
1815
  #
@@ -1874,9 +1879,9 @@ module Aws::IoTSiteWise
1874
1879
  # Retrieves information about a gateway capability configuration. Each
1875
1880
  # gateway capability defines data sources for a gateway. A capability
1876
1881
  # configuration can contain multiple data source configurations. If you
1877
- # define OPC-UA sources for a gateway in the AWS IoT SiteWise console,
1878
- # all of your OPC-UA sources are stored in one capability configuration.
1879
- # 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
1880
1885
  # [DescribeGateway][1].
1881
1886
  #
1882
1887
  #
@@ -1888,8 +1893,8 @@ module Aws::IoTSiteWise
1888
1893
  #
1889
1894
  # @option params [required, String] :capability_namespace
1890
1895
  # The namespace of the capability configuration. For example, if you
1891
- # configure OPC-UA sources from the AWS IoT SiteWise console, your
1892
- # 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
1893
1898
  # `iotsitewise:opcuacollector:version`, where `version` is a number such
1894
1899
  # as `1`.
1895
1900
  #
@@ -1921,7 +1926,7 @@ module Aws::IoTSiteWise
1921
1926
  req.send_request(options)
1922
1927
  end
1923
1928
 
1924
- # Retrieves the current AWS IoT SiteWise logging options.
1929
+ # Retrieves the current IoT SiteWise logging options.
1925
1930
  #
1926
1931
  # @return [Types::DescribeLoggingOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1927
1932
  #
@@ -2040,6 +2045,33 @@ module Aws::IoTSiteWise
2040
2045
  req.send_request(options)
2041
2046
  end
2042
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
+
2043
2075
  # Disassociates a child asset from the given parent asset through a
2044
2076
  # hierarchy defined in the parent asset's model.
2045
2077
  #
@@ -2051,7 +2083,7 @@ module Aws::IoTSiteWise
2051
2083
  # different groupings of assets to be formed that all come from the same
2052
2084
  # asset model. You can use the hierarchy ID to identify the correct
2053
2085
  # asset to disassociate. For more information, see [Asset
2054
- # hierarchies][1] in the *AWS IoT SiteWise User Guide*.
2086
+ # hierarchies][1] in the *IoT SiteWise User Guide*.
2055
2087
  #
2056
2088
  #
2057
2089
  #
@@ -2087,7 +2119,7 @@ module Aws::IoTSiteWise
2087
2119
  end
2088
2120
 
2089
2121
  # Gets aggregated values for an asset property. For more information,
2090
- # see [Querying aggregates][1] in the *AWS IoT SiteWise User Guide*.
2122
+ # see [Querying aggregates][1] in the *IoT SiteWise User Guide*.
2091
2123
  #
2092
2124
  # To identify an asset property, you must specify one of the following:
2093
2125
  #
@@ -2109,11 +2141,11 @@ module Aws::IoTSiteWise
2109
2141
  # The ID of the asset property.
2110
2142
  #
2111
2143
  # @option params [String] :property_alias
2112
- # The property alias that identifies the property, such as an OPC-UA
2113
- # 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,
2114
2146
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
2115
2147
  # see [Mapping industrial data streams to asset properties][1] in the
2116
- # *AWS IoT SiteWise User Guide*.
2148
+ # *IoT SiteWise User Guide*.
2117
2149
  #
2118
2150
  #
2119
2151
  #
@@ -2145,7 +2177,7 @@ module Aws::IoTSiteWise
2145
2177
  # The token to be used for the next set of paginated results.
2146
2178
  #
2147
2179
  # @option params [Integer] :max_results
2148
- # The maximum number of results to be returned per paginated request.
2180
+ # The maximum number of results to return for each paginated request.
2149
2181
  #
2150
2182
  # Default: 100
2151
2183
  #
@@ -2193,7 +2225,7 @@ module Aws::IoTSiteWise
2193
2225
  end
2194
2226
 
2195
2227
  # Gets an asset property's current value. For more information, see
2196
- # [Querying current values][1] in the *AWS IoT SiteWise User Guide*.
2228
+ # [Querying current values][1] in the *IoT SiteWise User Guide*.
2197
2229
  #
2198
2230
  # To identify an asset property, you must specify one of the following:
2199
2231
  #
@@ -2215,11 +2247,11 @@ module Aws::IoTSiteWise
2215
2247
  # The ID of the asset property.
2216
2248
  #
2217
2249
  # @option params [String] :property_alias
2218
- # The property alias that identifies the property, such as an OPC-UA
2219
- # 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,
2220
2252
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
2221
2253
  # see [Mapping industrial data streams to asset properties][1] in the
2222
- # *AWS IoT SiteWise User Guide*.
2254
+ # *IoT SiteWise User Guide*.
2223
2255
  #
2224
2256
  #
2225
2257
  #
@@ -2255,8 +2287,7 @@ module Aws::IoTSiteWise
2255
2287
  end
2256
2288
 
2257
2289
  # Gets the history of an asset property's values. For more information,
2258
- # see [Querying historical values][1] in the *AWS IoT SiteWise User
2259
- # Guide*.
2290
+ # see [Querying historical values][1] in the *IoT SiteWise User Guide*.
2260
2291
  #
2261
2292
  # To identify an asset property, you must specify one of the following:
2262
2293
  #
@@ -2278,11 +2309,11 @@ module Aws::IoTSiteWise
2278
2309
  # The ID of the asset property.
2279
2310
  #
2280
2311
  # @option params [String] :property_alias
2281
- # The property alias that identifies the property, such as an OPC-UA
2282
- # 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,
2283
2314
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
2284
2315
  # see [Mapping industrial data streams to asset properties][1] in the
2285
- # *AWS IoT SiteWise User Guide*.
2316
+ # *IoT SiteWise User Guide*.
2286
2317
  #
2287
2318
  #
2288
2319
  #
@@ -2308,7 +2339,7 @@ module Aws::IoTSiteWise
2308
2339
  # The token to be used for the next set of paginated results.
2309
2340
  #
2310
2341
  # @option params [Integer] :max_results
2311
- # The maximum number of results to be returned per paginated request.
2342
+ # The maximum number of results to return for each paginated request.
2312
2343
  #
2313
2344
  # Default: 100
2314
2345
  #
@@ -2357,10 +2388,6 @@ module Aws::IoTSiteWise
2357
2388
  # operation to return the interpolated temperature values for a wind
2358
2389
  # turbine every 24 hours over a duration of 7 days.
2359
2390
  #
2360
- # <note markdown="1"> This API isn't available in China (Beijing).
2361
- #
2362
- # </note>
2363
- #
2364
2391
  # To identify an asset property, you must specify one of the following:
2365
2392
  #
2366
2393
  # * The `assetId` and `propertyId` of an asset property.
@@ -2380,11 +2407,11 @@ module Aws::IoTSiteWise
2380
2407
  # The ID of the asset property.
2381
2408
  #
2382
2409
  # @option params [String] :property_alias
2383
- # The property alias that identifies the property, such as an OPC-UA
2384
- # 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,
2385
2412
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
2386
2413
  # see [Mapping industrial data streams to asset properties][1] in the
2387
- # *AWS IoT SiteWise User Guide*.
2414
+ # *IoT SiteWise User Guide*.
2388
2415
  #
2389
2416
  #
2390
2417
  #
@@ -2417,7 +2444,7 @@ module Aws::IoTSiteWise
2417
2444
  # The token to be used for the next set of paginated results.
2418
2445
  #
2419
2446
  # @option params [Integer] :max_results
2420
- # 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
2421
2448
  # not specified, the default value is 10.
2422
2449
  #
2423
2450
  # @option params [required, String] :type
@@ -2467,13 +2494,14 @@ module Aws::IoTSiteWise
2467
2494
  req.send_request(options)
2468
2495
  end
2469
2496
 
2470
- # Retrieves a paginated list of access policies for an identity (an AWS
2471
- # SSO user, an AWS SSO group, or an IAM user) or an AWS IoT SiteWise
2472
- # 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).
2473
2500
  #
2474
2501
  # @option params [String] :identity_type
2475
- # The type of identity (AWS SSO user, AWS SSO group, or IAM user). This
2476
- # 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`.
2477
2505
  #
2478
2506
  # @option params [String] :identity_id
2479
2507
  # The ID of the identity. This parameter is required if you specify
@@ -2500,7 +2528,7 @@ module Aws::IoTSiteWise
2500
2528
  # The token to be used for the next set of paginated results.
2501
2529
  #
2502
2530
  # @option params [Integer] :max_results
2503
- # The maximum number of results to be returned per paginated request.
2531
+ # The maximum number of results to return for each paginated request.
2504
2532
  #
2505
2533
  # Default: 50
2506
2534
  #
@@ -2551,7 +2579,7 @@ module Aws::IoTSiteWise
2551
2579
  # The token to be used for the next set of paginated results.
2552
2580
  #
2553
2581
  # @option params [Integer] :max_results
2554
- # The maximum number of results to be returned per paginated request.
2582
+ # The maximum number of results to return for each paginated request.
2555
2583
  #
2556
2584
  # Default: 50
2557
2585
  #
@@ -2612,7 +2640,7 @@ module Aws::IoTSiteWise
2612
2640
  # The token to be used for the next set of paginated results.
2613
2641
  #
2614
2642
  # @option params [Integer] :max_results
2615
- # The maximum number of results to be returned per paginated request.
2643
+ # The maximum number of results to return for each paginated request.
2616
2644
  #
2617
2645
  # @return [Types::ListAssetRelationshipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2618
2646
  #
@@ -2666,7 +2694,7 @@ module Aws::IoTSiteWise
2666
2694
  # The token to be used for the next set of paginated results.
2667
2695
  #
2668
2696
  # @option params [Integer] :max_results
2669
- # The maximum number of results to be returned per paginated request.
2697
+ # The maximum number of results to return for each paginated request.
2670
2698
  #
2671
2699
  # Default: 50
2672
2700
  #
@@ -2744,8 +2772,8 @@ module Aws::IoTSiteWise
2744
2772
  # [DescribeAssetModel][2] operations. This parameter is required if you
2745
2773
  # choose `CHILD` for `traversalDirection`.
2746
2774
  #
2747
- # For more information, see [Asset hierarchies][3] in the *AWS IoT
2748
- # SiteWise User Guide*.
2775
+ # For more information, see [Asset hierarchies][3] in the *IoT SiteWise
2776
+ # User Guide*.
2749
2777
  #
2750
2778
  #
2751
2779
  #
@@ -2769,7 +2797,7 @@ module Aws::IoTSiteWise
2769
2797
  # The token to be used for the next set of paginated results.
2770
2798
  #
2771
2799
  # @option params [Integer] :max_results
2772
- # The maximum number of results to be returned per paginated request.
2800
+ # The maximum number of results to return for each paginated request.
2773
2801
  #
2774
2802
  # Default: 50
2775
2803
  #
@@ -2814,8 +2842,8 @@ module Aws::IoTSiteWise
2814
2842
  req.send_request(options)
2815
2843
  end
2816
2844
 
2817
- # Retrieves a paginated list of dashboards for an AWS IoT SiteWise
2818
- # Monitor project.
2845
+ # Retrieves a paginated list of dashboards for an IoT SiteWise Monitor
2846
+ # project.
2819
2847
  #
2820
2848
  # @option params [required, String] :project_id
2821
2849
  # The ID of the project.
@@ -2824,7 +2852,7 @@ module Aws::IoTSiteWise
2824
2852
  # The token to be used for the next set of paginated results.
2825
2853
  #
2826
2854
  # @option params [Integer] :max_results
2827
- # The maximum number of results to be returned per paginated request.
2855
+ # The maximum number of results to return for each paginated request.
2828
2856
  #
2829
2857
  # Default: 50
2830
2858
  #
@@ -2866,7 +2894,7 @@ module Aws::IoTSiteWise
2866
2894
  # The token to be used for the next set of paginated results.
2867
2895
  #
2868
2896
  # @option params [Integer] :max_results
2869
- # The maximum number of results to be returned per paginated request.
2897
+ # The maximum number of results to return for each paginated request.
2870
2898
  #
2871
2899
  # Default: 50
2872
2900
  #
@@ -2903,13 +2931,13 @@ module Aws::IoTSiteWise
2903
2931
  req.send_request(options)
2904
2932
  end
2905
2933
 
2906
- # Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
2934
+ # Retrieves a paginated list of IoT SiteWise Monitor portals.
2907
2935
  #
2908
2936
  # @option params [String] :next_token
2909
2937
  # The token to be used for the next set of paginated results.
2910
2938
  #
2911
2939
  # @option params [Integer] :max_results
2912
- # The maximum number of results to be returned per paginated request.
2940
+ # The maximum number of results to return for each paginated request.
2913
2941
  #
2914
2942
  # Default: 50
2915
2943
  #
@@ -2949,8 +2977,8 @@ module Aws::IoTSiteWise
2949
2977
  req.send_request(options)
2950
2978
  end
2951
2979
 
2952
- # Retrieves a paginated list of assets associated with an AWS IoT
2953
- # SiteWise Monitor project.
2980
+ # Retrieves a paginated list of assets associated with an IoT SiteWise
2981
+ # Monitor project.
2954
2982
  #
2955
2983
  # @option params [required, String] :project_id
2956
2984
  # The ID of the project.
@@ -2959,7 +2987,7 @@ module Aws::IoTSiteWise
2959
2987
  # The token to be used for the next set of paginated results.
2960
2988
  #
2961
2989
  # @option params [Integer] :max_results
2962
- # The maximum number of results to be returned per paginated request.
2990
+ # The maximum number of results to return for each paginated request.
2963
2991
  #
2964
2992
  # Default: 50
2965
2993
  #
@@ -2991,7 +3019,7 @@ module Aws::IoTSiteWise
2991
3019
  req.send_request(options)
2992
3020
  end
2993
3021
 
2994
- # Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor
3022
+ # Retrieves a paginated list of projects for an IoT SiteWise Monitor
2995
3023
  # portal.
2996
3024
  #
2997
3025
  # @option params [required, String] :portal_id
@@ -3001,7 +3029,7 @@ module Aws::IoTSiteWise
3001
3029
  # The token to be used for the next set of paginated results.
3002
3030
  #
3003
3031
  # @option params [Integer] :max_results
3004
- # The maximum number of results to be returned per paginated request.
3032
+ # The maximum number of results to return for each paginated request.
3005
3033
  #
3006
3034
  # Default: 50
3007
3035
  #
@@ -3037,7 +3065,7 @@ module Aws::IoTSiteWise
3037
3065
  req.send_request(options)
3038
3066
  end
3039
3067
 
3040
- # Retrieves the list of tags for an AWS IoT SiteWise resource.
3068
+ # Retrieves the list of tags for an IoT SiteWise resource.
3041
3069
  #
3042
3070
  # @option params [required, String] :resource_arn
3043
3071
  # The [ARN][1] of the resource.
@@ -3068,9 +3096,9 @@ module Aws::IoTSiteWise
3068
3096
  req.send_request(options)
3069
3097
  end
3070
3098
 
3071
- # Sets the default encryption configuration for the AWS account. For
3072
- # more information, see [Key management][1] in the *AWS IoT SiteWise
3073
- # 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*.
3074
3102
  #
3075
3103
  #
3076
3104
  #
@@ -3081,8 +3109,7 @@ module Aws::IoTSiteWise
3081
3109
  #
3082
3110
  # @option params [String] :kms_key_id
3083
3111
  # The Key ID of the customer managed customer master key (CMK) used for
3084
- # AWS KMS encryption. This is required if you use
3085
- # `KMS_BASED_ENCRYPTION`.
3112
+ # KMS encryption. This is required if you use `KMS_BASED_ENCRYPTION`.
3086
3113
  #
3087
3114
  # @return [Types::PutDefaultEncryptionConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3088
3115
  #
@@ -3112,7 +3139,7 @@ module Aws::IoTSiteWise
3112
3139
  req.send_request(options)
3113
3140
  end
3114
3141
 
3115
- # Sets logging options for AWS IoT SiteWise.
3142
+ # Sets logging options for IoT SiteWise.
3116
3143
  #
3117
3144
  # @option params [required, Types::LoggingOptions] :logging_options
3118
3145
  # The logging options to set.
@@ -3134,8 +3161,60 @@ module Aws::IoTSiteWise
3134
3161
  req.send_request(options)
3135
3162
  end
3136
3163
 
3137
- # Adds tags to an AWS IoT SiteWise resource. If a tag already exists for
3138
- # 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.
3139
3218
  #
3140
3219
  # @option params [required, String] :resource_arn
3141
3220
  # The [ARN][1] of the resource to tag.
@@ -3146,8 +3225,8 @@ module Aws::IoTSiteWise
3146
3225
  #
3147
3226
  # @option params [required, Hash<String,String>] :tags
3148
3227
  # A list of key-value pairs that contain metadata for the resource. For
3149
- # more information, see [Tagging your AWS IoT SiteWise resources][1] in
3150
- # the *AWS IoT SiteWise User Guide*.
3228
+ # more information, see [Tagging your IoT SiteWise resources][1] in the
3229
+ # *IoT SiteWise User Guide*.
3151
3230
  #
3152
3231
  #
3153
3232
  #
@@ -3171,7 +3250,7 @@ module Aws::IoTSiteWise
3171
3250
  req.send_request(options)
3172
3251
  end
3173
3252
 
3174
- # Removes a tag from an AWS IoT SiteWise resource.
3253
+ # Removes a tag from an IoT SiteWise resource.
3175
3254
  #
3176
3255
  # @option params [required, String] :resource_arn
3177
3256
  # The [ARN][1] of the resource to untag.
@@ -3200,17 +3279,17 @@ module Aws::IoTSiteWise
3200
3279
  end
3201
3280
 
3202
3281
  # Updates an existing access policy that specifies an identity's access
3203
- # to an AWS IoT SiteWise Monitor portal or project resource.
3282
+ # to an IoT SiteWise Monitor portal or project resource.
3204
3283
  #
3205
3284
  # @option params [required, String] :access_policy_id
3206
3285
  # The ID of the access policy.
3207
3286
  #
3208
3287
  # @option params [required, Types::Identity] :access_policy_identity
3209
- # The identity for this access policy. Choose an AWS SSO user, an AWS
3210
- # 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.
3211
3290
  #
3212
3291
  # @option params [required, Types::Resource] :access_policy_resource
3213
- # The AWS IoT SiteWise Monitor resource for this access policy. Choose
3292
+ # The IoT SiteWise Monitor resource for this access policy. Choose
3214
3293
  # either a portal or a project.
3215
3294
  #
3216
3295
  # @option params [required, String] :access_policy_permission
@@ -3265,7 +3344,7 @@ module Aws::IoTSiteWise
3265
3344
  end
3266
3345
 
3267
3346
  # Updates an asset's name. For more information, see [Updating assets
3268
- # and models][1] in the *AWS IoT SiteWise User Guide*.
3347
+ # and models][1] in the *IoT SiteWise User Guide*.
3269
3348
  #
3270
3349
  #
3271
3350
  #
@@ -3313,20 +3392,20 @@ module Aws::IoTSiteWise
3313
3392
  # Updates an asset model and all of the assets that were created from
3314
3393
  # the model. Each asset created from the model inherits the updated
3315
3394
  # asset model's property and hierarchy definitions. For more
3316
- # information, see [Updating assets and models][1] in the *AWS IoT
3317
- # SiteWise User Guide*.
3395
+ # information, see [Updating assets and models][1] in the *IoT SiteWise
3396
+ # User Guide*.
3318
3397
  #
3319
3398
  # This operation overwrites the existing model with the provided model.
3320
3399
  # To avoid deleting your asset model's properties or hierarchies, you
3321
3400
  # must include their IDs and definitions in the updated asset model
3322
3401
  # payload. For more information, see [DescribeAssetModel][2].
3323
3402
  #
3324
- # If you remove a property from an asset model, AWS IoT SiteWise
3325
- # deletes
3326
- # all previous data for that property. If you remove a hierarchy
3327
- # definition from an asset model, AWS IoT SiteWise disassociates every
3328
- # asset associated with that hierarchy. You can't change the type or
3329
- # 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.
3330
3409
  #
3331
3410
  #
3332
3411
  #
@@ -3344,11 +3423,11 @@ module Aws::IoTSiteWise
3344
3423
  #
3345
3424
  # @option params [Array<Types::AssetModelProperty>] :asset_model_properties
3346
3425
  # The updated property definitions of the asset model. For more
3347
- # information, see [Asset properties][1] in the *AWS IoT SiteWise User
3426
+ # information, see [Asset properties][1] in the *IoT SiteWise User
3348
3427
  # Guide*.
3349
3428
  #
3350
3429
  # You can specify up to 200 properties per asset model. For more
3351
- # information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
3430
+ # information, see [Quotas][2] in the *IoT SiteWise User Guide*.
3352
3431
  #
3353
3432
  #
3354
3433
  #
@@ -3359,10 +3438,10 @@ module Aws::IoTSiteWise
3359
3438
  # The updated hierarchy definitions of the asset model. Each hierarchy
3360
3439
  # specifies an asset model whose assets can be children of any other
3361
3440
  # assets created from this asset model. For more information, see [Asset
3362
- # hierarchies][1] in the *AWS IoT SiteWise User Guide*.
3441
+ # hierarchies][1] in the *IoT SiteWise User Guide*.
3363
3442
  #
3364
3443
  # You can specify up to 10 hierarchies per asset model. For more
3365
- # information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
3444
+ # information, see [Quotas][2] in the *IoT SiteWise User Guide*.
3366
3445
  #
3367
3446
  #
3368
3447
  #
@@ -3533,11 +3612,11 @@ module Aws::IoTSiteWise
3533
3612
  # The ID of the asset property to be updated.
3534
3613
  #
3535
3614
  # @option params [String] :property_alias
3536
- # The property alias that identifies the property, such as an OPC-UA
3537
- # 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,
3538
3617
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
3539
3618
  # see [Mapping industrial data streams to asset properties][1] in the
3540
- # *AWS IoT SiteWise User Guide*.
3619
+ # *IoT SiteWise User Guide*.
3541
3620
  #
3542
3621
  # If you omit this parameter, the alias is removed from the property.
3543
3622
  #
@@ -3547,9 +3626,9 @@ module Aws::IoTSiteWise
3547
3626
  #
3548
3627
  # @option params [String] :property_notification_state
3549
3628
  # The MQTT notification state (enabled or disabled) for this asset
3550
- # property. When the notification state is enabled, AWS IoT SiteWise
3629
+ # property. When the notification state is enabled, IoT SiteWise
3551
3630
  # publishes property value updates to a unique MQTT topic. For more
3552
- # information, see [Interacting with other services][1] in the *AWS IoT
3631
+ # information, see [Interacting with other services][1] in the *IoT
3553
3632
  # SiteWise User Guide*.
3554
3633
  #
3555
3634
  # If you omit this parameter, the notification state is set to
@@ -3586,7 +3665,7 @@ module Aws::IoTSiteWise
3586
3665
  req.send_request(options)
3587
3666
  end
3588
3667
 
3589
- # Updates an AWS IoT SiteWise Monitor dashboard.
3668
+ # Updates an IoT SiteWise Monitor dashboard.
3590
3669
  #
3591
3670
  # @option params [required, String] :dashboard_id
3592
3671
  # The ID of the dashboard to update.
@@ -3599,8 +3678,8 @@ module Aws::IoTSiteWise
3599
3678
  #
3600
3679
  # @option params [required, String] :dashboard_definition
3601
3680
  # The new dashboard definition, as specified in a JSON literal. For
3602
- # detailed information, see [Creating dashboards (CLI)][1] in the *AWS
3603
- # IoT SiteWise User Guide*.
3681
+ # detailed information, see [Creating dashboards (CLI)][1] in the *IoT
3682
+ # SiteWise User Guide*.
3604
3683
  #
3605
3684
  #
3606
3685
  #
@@ -3660,8 +3739,8 @@ module Aws::IoTSiteWise
3660
3739
  # Updates a gateway capability configuration or defines a new capability
3661
3740
  # configuration. Each gateway capability defines data sources for a
3662
3741
  # gateway. A capability configuration can contain multiple data source
3663
- # configurations. If you define OPC-UA sources for a gateway in the AWS
3664
- # 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
3665
3744
  # capability configuration. To list all capability configurations for a
3666
3745
  # gateway, use [DescribeGateway][1].
3667
3746
  #
@@ -3674,7 +3753,7 @@ module Aws::IoTSiteWise
3674
3753
  #
3675
3754
  # @option params [required, String] :capability_namespace
3676
3755
  # The namespace of the gateway capability configuration to be updated.
3677
- # 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
3678
3757
  # console, your OPC-UA capability configuration has the namespace
3679
3758
  # `iotsitewise:opcuacollector:version`, where `version` is a number such
3680
3759
  # as `1`.
@@ -3682,7 +3761,7 @@ module Aws::IoTSiteWise
3682
3761
  # @option params [required, String] :capability_configuration
3683
3762
  # The JSON document that defines the configuration for the gateway
3684
3763
  # capability. For more information, see [Configuring data sources
3685
- # (CLI)][1] in the *AWS IoT SiteWise User Guide*.
3764
+ # (CLI)][1] in the *IoT SiteWise User Guide*.
3686
3765
  #
3687
3766
  #
3688
3767
  #
@@ -3713,7 +3792,7 @@ module Aws::IoTSiteWise
3713
3792
  req.send_request(options)
3714
3793
  end
3715
3794
 
3716
- # Updates an AWS IoT SiteWise Monitor portal.
3795
+ # Updates an IoT SiteWise Monitor portal.
3717
3796
  #
3718
3797
  # @option params [required, String] :portal_id
3719
3798
  # The ID of the portal to update.
@@ -3725,7 +3804,7 @@ module Aws::IoTSiteWise
3725
3804
  # A new description for the portal.
3726
3805
  #
3727
3806
  # @option params [required, String] :portal_contact_email
3728
- # The AWS administrator's contact email address.
3807
+ # The Amazon Web Services administrator's contact email address.
3729
3808
  #
3730
3809
  # @option params [Types::Image] :portal_logo_image
3731
3810
  # Contains an image that is one of the following:
@@ -3737,9 +3816,9 @@ module Aws::IoTSiteWise
3737
3816
  #
3738
3817
  # @option params [required, String] :role_arn
3739
3818
  # The [ARN][1] of a service role that allows the portal's users to
3740
- # access your AWS IoT SiteWise resources on your behalf. For more
3741
- # information, see [Using service roles for AWS IoT SiteWise Monitor][2]
3742
- # 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*.
3743
3822
  #
3744
3823
  #
3745
3824
  #
@@ -3758,10 +3837,15 @@ module Aws::IoTSiteWise
3758
3837
  # The email address that sends alarm notifications.
3759
3838
  #
3760
3839
  # @option params [Types::Alarms] :alarms
3761
- # Contains the configuration information of an alarm created in an AWS
3762
- # IoT SiteWise Monitor portal. You can use the alarm to monitor an asset
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
3763
3842
  # property and get notified when the asset property value is outside a
3764
- # specified range. For more information, see .
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
3765
3849
  #
3766
3850
  # @return [Types::UpdatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3767
3851
  #
@@ -3803,7 +3887,7 @@ module Aws::IoTSiteWise
3803
3887
  req.send_request(options)
3804
3888
  end
3805
3889
 
3806
- # Updates an AWS IoT SiteWise Monitor project.
3890
+ # Updates an IoT SiteWise Monitor project.
3807
3891
  #
3808
3892
  # @option params [required, String] :project_id
3809
3893
  # The ID of the project to update.
@@ -3853,7 +3937,7 @@ module Aws::IoTSiteWise
3853
3937
  params: params,
3854
3938
  config: config)
3855
3939
  context[:gem_name] = 'aws-sdk-iotsitewise'
3856
- context[:gem_version] = '1.23.0'
3940
+ context[:gem_version] = '1.24.0'
3857
3941
  Seahorse::Client::Request.new(handlers, context)
3858
3942
  end
3859
3943