aws-sdk-iotsitewise 1.7.0 → 1.13.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: 6d40aa59f20cc98859d378e72cec692a2d0a6c3fd5ab0bca81fc7406ed17bbf3
4
- data.tar.gz: 47f137ce6881e5b33e80e6307f501eaf1cb25c20b8e54565fe55f2811483c69b
3
+ metadata.gz: 4da4706f27771303084a228e4d77c78f8baeb62d585db701dd025fce0cb48bae
4
+ data.tar.gz: 792ade8ab265b9c3a3166ad6314e58e63f9ba95657e3211d062aab8becb3a858
5
5
  SHA512:
6
- metadata.gz: d8fcefde76ef8924013e4d245a4a4dc8712a1704c9a6809f3defd8768058bd8b5acc0bcdeeeaf5dcd5af183a9522ef8bc10ff4567370bc5c99efb7ca03588786
7
- data.tar.gz: ad8dc57c4874fac189048cbaeff202e1652d8dbe6dd3d9975ce1a8619790ccb9253f1ff286f08e8d528e96c533fc335cfafbb19b48b7f1dcde5a2c3fc74433b7
6
+ metadata.gz: 77680cee2e8a3be430d1e07bbdad6d044af82b067f4c133e75bb7b05ba6bb8448d5d59e6ce22a6a7cce391949ffe2481e0afbce90350d7a66e61d36c2d2d642f
7
+ data.tar.gz: 62f2d78a0cd8edb5b404bb7ec3e366c387cd4eb102a649982351d64c801269cac596195a05bd1a0d4468c40bde2d3a511fa2bd10d16f28b9b6fe4396414887dd
@@ -7,6 +7,7 @@
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
10
+
10
11
  require 'aws-sdk-core'
11
12
  require 'aws-sigv4'
12
13
 
@@ -45,9 +46,9 @@ require_relative 'aws-sdk-iotsitewise/customizations'
45
46
  #
46
47
  # See {Errors} for more information.
47
48
  #
48
- # @service
49
+ # @!group service
49
50
  module Aws::IoTSiteWise
50
51
 
51
- GEM_VERSION = '1.7.0'
52
+ GEM_VERSION = '1.13.0'
52
53
 
53
54
  end
@@ -85,13 +85,28 @@ module Aws::IoTSiteWise
85
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
86
  # credentials.
87
87
  #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
88
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
89
103
  # from an EC2 IMDS on an EC2 instance.
90
104
  #
91
- # * `Aws::SharedCredentials` - Used for loading credentials from a
92
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
93
107
  #
94
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
95
110
  #
96
111
  # When `:credentials` are not configured directly, the following
97
112
  # locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::IoTSiteWise
101
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
102
117
  # * `~/.aws/credentials`
103
118
  # * `~/.aws/config`
104
- # * EC2 IMDS instance profile - When used by default, the timeouts are
105
- # very aggressive. Construct and pass an instance of
106
- # `Aws::InstanceProfileCredentails` to enable retries and extended
107
- # timeouts.
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
108
123
  #
109
124
  # @option options [required, String] :region
110
125
  # The AWS region to connect to. The configured `:region` is
@@ -314,7 +329,7 @@ module Aws::IoTSiteWise
314
329
 
315
330
  # Associates a child asset with the given parent asset through a
316
331
  # hierarchy defined in the parent asset's model. For more information,
317
- # see [Associating Assets][1] in the *AWS IoT SiteWise User Guide*.
332
+ # see [Associating assets][1] in the *AWS IoT SiteWise User Guide*.
318
333
  #
319
334
  #
320
335
  #
@@ -326,7 +341,7 @@ module Aws::IoTSiteWise
326
341
  # @option params [required, String] :hierarchy_id
327
342
  # The ID of a hierarchy in the parent asset's model. Hierarchies allow
328
343
  # different groupings of assets to be formed that all come from the same
329
- # asset model. For more information, see [Asset Hierarchies][1] in the
344
+ # asset model. For more information, see [Asset hierarchies][1] in the
330
345
  # *AWS IoT SiteWise User Guide*.
331
346
  #
332
347
  #
@@ -450,7 +465,7 @@ module Aws::IoTSiteWise
450
465
 
451
466
  # Sends a list of asset property values to AWS IoT SiteWise. Each value
452
467
  # is a timestamp-quality-value (TQV) data point. For more information,
453
- # see [Ingesting Data Using the API][1] in the *AWS IoT SiteWise User
468
+ # see [Ingesting data using the API][1] in the *AWS IoT SiteWise User
454
469
  # Guide*.
455
470
  #
456
471
  # To identify an asset property, you must specify one of the following:
@@ -472,10 +487,16 @@ module Aws::IoTSiteWise
472
487
  # example, if you store a TQV `\{T1, GOOD, V1\}`, then storing `\{T1,
473
488
  # GOOD, V2\}` replaces the existing TQV.
474
489
  #
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*.
494
+ #
475
495
  #
476
496
  #
477
497
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html
478
498
  # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
499
+ # [3]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-batchputassetpropertyvalue-action
479
500
  #
480
501
  # @option params [required, Array<Types::PutAssetPropertyValueEntry>] :entries
481
502
  # The list of asset property value entries for the batch put request.
@@ -531,17 +552,17 @@ module Aws::IoTSiteWise
531
552
  req.send_request(options)
532
553
  end
533
554
 
534
- # Creates an access policy that grants the specified AWS Single Sign-On
535
- # user or group access to the specified AWS IoT SiteWise Monitor portal
536
- # or project resource.
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.
537
558
  #
538
559
  # @option params [required, Types::Identity] :access_policy_identity
539
- # The identity for this access policy. Choose either a `user` or a
540
- # `group` but not both.
560
+ # The identity for this access policy. Choose an AWS SSO user, an AWS
561
+ # SSO group, or an IAM user.
541
562
  #
542
563
  # @option params [required, Types::Resource] :access_policy_resource
543
564
  # The AWS IoT SiteWise Monitor resource for this access policy. Choose
544
- # either `portal` or `project` but not both.
565
+ # either a portal or a project.
545
566
  #
546
567
  # @option params [required, String] :access_policy_permission
547
568
  # The permission level for this access policy. Note that a project
@@ -579,6 +600,9 @@ module Aws::IoTSiteWise
579
600
  # group: {
580
601
  # id: "IdentityId", # required
581
602
  # },
603
+ # iam_user: {
604
+ # arn: "ARN", # required
605
+ # },
582
606
  # },
583
607
  # access_policy_resource: { # required
584
608
  # portal: {
@@ -608,7 +632,7 @@ module Aws::IoTSiteWise
608
632
  end
609
633
 
610
634
  # Creates an asset from an existing asset model. For more information,
611
- # see [Creating Assets][1] in the *AWS IoT SiteWise User Guide*.
635
+ # see [Creating assets][1] in the *AWS IoT SiteWise User Guide*.
612
636
  #
613
637
  #
614
638
  #
@@ -674,7 +698,7 @@ module Aws::IoTSiteWise
674
698
  # you can easily create assets of the same type that have standardized
675
699
  # definitions. Each asset created from a model inherits the asset
676
700
  # model's property and hierarchy definitions. For more information, see
677
- # [Defining Asset Models][1] in the *AWS IoT SiteWise User Guide*.
701
+ # [Defining asset models][1] in the *AWS IoT SiteWise User Guide*.
678
702
  #
679
703
  #
680
704
  #
@@ -688,7 +712,7 @@ module Aws::IoTSiteWise
688
712
  #
689
713
  # @option params [Array<Types::AssetModelPropertyDefinition>] :asset_model_properties
690
714
  # The property definitions of the asset model. For more information, see
691
- # [Asset Properties][1] in the *AWS IoT SiteWise User Guide*.
715
+ # [Asset properties][1] in the *AWS IoT SiteWise User Guide*.
692
716
  #
693
717
  # You can specify up to 200 properties per asset model. For more
694
718
  # information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
@@ -702,7 +726,7 @@ module Aws::IoTSiteWise
702
726
  # The hierarchy definitions of the asset model. Each hierarchy specifies
703
727
  # an asset model whose assets can be children of any other assets
704
728
  # created from this asset model. For more information, see [Asset
705
- # Hierarchies][1] in the *AWS IoT SiteWise User Guide*.
729
+ # hierarchies][1] in the *AWS IoT SiteWise User Guide*.
706
730
  #
707
731
  # You can specify up to 10 hierarchies per asset model. For more
708
732
  # information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
@@ -823,7 +847,7 @@ module Aws::IoTSiteWise
823
847
  #
824
848
  # @option params [required, String] :dashboard_definition
825
849
  # The dashboard definition specified in a JSON literal. For detailed
826
- # information, see [Creating Dashboards (CLI)][1] in the *AWS IoT
850
+ # information, see [Creating dashboards (CLI)][1] in the *AWS IoT
827
851
  # SiteWise User Guide*.
828
852
  #
829
853
  #
@@ -933,23 +957,19 @@ module Aws::IoTSiteWise
933
957
  req.send_request(options)
934
958
  end
935
959
 
936
- # Creates a portal, which can contain projects and dashboards. Before
937
- # you can create a portal, you must configure AWS Single Sign-On in the
938
- # current Region. AWS IoT SiteWise Monitor uses AWS SSO to manage user
939
- # permissions. For more information, see [Enabling AWS SSO][1] in the
940
- # *AWS IoT SiteWise User Guide*.
960
+ # Creates a portal, which can contain projects and dashboards. AWS IoT
961
+ # SiteWise Monitor uses AWS SSO or IAM to authenticate portal users and
962
+ # manage user permissions.
941
963
  #
942
- # <note markdown="1"> Before you can sign in to a new portal, you must add at least one AWS
943
- # SSO user or group to that portal. For more information, see [Adding or
944
- # Removing Portal Administrators][2] in the *AWS IoT SiteWise User
945
- # Guide*.
964
+ # <note markdown="1"> Before you can sign in to a new portal, you must add at least one
965
+ # identity to that portal. For more information, see [Adding or removing
966
+ # portal administrators][1] in the *AWS IoT SiteWise User Guide*.
946
967
  #
947
968
  # </note>
948
969
  #
949
970
  #
950
971
  #
951
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso
952
- # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins
972
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins
953
973
  #
954
974
  # @option params [required, String] :portal_name
955
975
  # A friendly name for the portal.
@@ -992,6 +1012,30 @@ module Aws::IoTSiteWise
992
1012
  #
993
1013
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
994
1014
  #
1015
+ # @option params [String] :portal_auth_mode
1016
+ # The service to use to authenticate users to the portal. Choose from
1017
+ # the following options:
1018
+ #
1019
+ # * `SSO` – The portal uses AWS Single Sign-On to authenticate users and
1020
+ # manage user permissions. Before you can create a portal that uses
1021
+ # AWS SSO, you must enable AWS SSO. For more information, see
1022
+ # [Enabling AWS SSO][1] in the *AWS IoT SiteWise User Guide*. This
1023
+ # option is only available in AWS Regions other than the China
1024
+ # Regions.
1025
+ #
1026
+ # * `IAM` – The portal uses AWS Identity and Access Management (IAM) to
1027
+ # authenticate users and manage user permissions. IAM users must have
1028
+ # the `iotsitewise:CreatePresignedPortalUrl` permission to sign in to
1029
+ # the portal. This option is only available in the China Regions.
1030
+ #
1031
+ # You can't change this value after you create a portal.
1032
+ #
1033
+ # Default: `SSO`
1034
+ #
1035
+ #
1036
+ #
1037
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso
1038
+ #
995
1039
  # @return [Types::CreatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
996
1040
  #
997
1041
  # * {Types::CreatePortalResponse#portal_id #portal_id} => String
@@ -1015,6 +1059,7 @@ module Aws::IoTSiteWise
1015
1059
  # tags: {
1016
1060
  # "TagKey" => "TagValue",
1017
1061
  # },
1062
+ # portal_auth_mode: "IAM", # accepts IAM, SSO
1018
1063
  # })
1019
1064
  #
1020
1065
  # @example Response structure
@@ -1023,7 +1068,7 @@ module Aws::IoTSiteWise
1023
1068
  # resp.portal_arn #=> String
1024
1069
  # resp.portal_start_url #=> String
1025
1070
  # resp.portal_status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
1026
- # resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE"
1071
+ # resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
1027
1072
  # resp.portal_status.error.message #=> String
1028
1073
  # resp.sso_application_id #=> String
1029
1074
  #
@@ -1091,10 +1136,9 @@ module Aws::IoTSiteWise
1091
1136
  req.send_request(options)
1092
1137
  end
1093
1138
 
1094
- # Deletes an access policy that grants the specified AWS Single Sign-On
1095
- # identity access to the specified AWS IoT SiteWise Monitor resource.
1096
- # You can use this operation to revoke access to an AWS IoT SiteWise
1097
- # Monitor resource.
1139
+ # Deletes an access policy that grants the specified identity access to
1140
+ # the specified AWS IoT SiteWise Monitor resource. You can use this
1141
+ # operation to revoke access to an AWS IoT SiteWise Monitor resource.
1098
1142
  #
1099
1143
  # @option params [required, String] :access_policy_id
1100
1144
  # The ID of the access policy to be deleted.
@@ -1124,7 +1168,7 @@ module Aws::IoTSiteWise
1124
1168
  end
1125
1169
 
1126
1170
  # Deletes an asset. This action can't be undone. For more information,
1127
- # see [Deleting Assets and Models][1] in the *AWS IoT SiteWise User
1171
+ # see [Deleting assets and models][1] in the *AWS IoT SiteWise User
1128
1172
  # Guide*.
1129
1173
  #
1130
1174
  # <note markdown="1"> You can't delete an asset that's associated to another asset. For
@@ -1177,7 +1221,7 @@ module Aws::IoTSiteWise
1177
1221
  # model. Also, you can't delete an asset model if a parent asset model
1178
1222
  # exists that contains a property formula expression that depends on the
1179
1223
  # asset model that you want to delete. For more information, see
1180
- # [Deleting Assets and Models][1] in the *AWS IoT SiteWise User Guide*.
1224
+ # [Deleting assets and models][1] in the *AWS IoT SiteWise User Guide*.
1181
1225
  #
1182
1226
  #
1183
1227
  #
@@ -1249,12 +1293,6 @@ module Aws::IoTSiteWise
1249
1293
 
1250
1294
  # Deletes a gateway from AWS IoT SiteWise. When you delete a gateway,
1251
1295
  # some of the gateway's files remain in your gateway's file system.
1252
- # For more information, see [Data retention][1] in the *AWS IoT SiteWise
1253
- # User Guide*.
1254
- #
1255
- #
1256
- #
1257
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-retention.html
1258
1296
  #
1259
1297
  # @option params [required, String] :gateway_id
1260
1298
  # The ID of the gateway to delete.
@@ -1301,7 +1339,7 @@ module Aws::IoTSiteWise
1301
1339
  # @example Response structure
1302
1340
  #
1303
1341
  # resp.portal_status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
1304
- # resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE"
1342
+ # resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
1305
1343
  # resp.portal_status.error.message #=> String
1306
1344
  #
1307
1345
  # @overload delete_portal(params = {})
@@ -1340,8 +1378,8 @@ module Aws::IoTSiteWise
1340
1378
  req.send_request(options)
1341
1379
  end
1342
1380
 
1343
- # Describes an access policy, which specifies an AWS SSO user or
1344
- # group's access to an AWS IoT SiteWise Monitor portal or project.
1381
+ # Describes an access policy, which specifies an identity's access to
1382
+ # an AWS IoT SiteWise Monitor portal or project.
1345
1383
  #
1346
1384
  # @option params [required, String] :access_policy_id
1347
1385
  # The ID of the access policy.
@@ -1368,6 +1406,7 @@ module Aws::IoTSiteWise
1368
1406
  # resp.access_policy_arn #=> String
1369
1407
  # resp.access_policy_identity.user.id #=> String
1370
1408
  # resp.access_policy_identity.group.id #=> String
1409
+ # resp.access_policy_identity.iam_user.arn #=> String
1371
1410
  # resp.access_policy_resource.portal.id #=> String
1372
1411
  # resp.access_policy_resource.project.id #=> String
1373
1412
  # resp.access_policy_permission #=> String, one of "ADMINISTRATOR", "VIEWER"
@@ -1509,7 +1548,21 @@ module Aws::IoTSiteWise
1509
1548
  req.send_request(options)
1510
1549
  end
1511
1550
 
1512
- # Retrieves information about an asset's property.
1551
+ # Retrieves information about an asset property.
1552
+ #
1553
+ # <note markdown="1"> When you call this operation for an attribute property, this response
1554
+ # includes the default attribute value that you define in the asset
1555
+ # model. If you update the default value in the model, this operation's
1556
+ # response includes the new default value.
1557
+ #
1558
+ # </note>
1559
+ #
1560
+ # This operation doesn't return the value of the asset property. To get
1561
+ # the value of an asset property, use [GetAssetPropertyValue][1].
1562
+ #
1563
+ #
1564
+ #
1565
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_GetAssetPropertyValue.html
1513
1566
  #
1514
1567
  # @option params [required, String] :asset_id
1515
1568
  # The ID of the asset.
@@ -1729,6 +1782,7 @@ module Aws::IoTSiteWise
1729
1782
  # * {Types::DescribePortalResponse#portal_last_update_date #portal_last_update_date} => Time
1730
1783
  # * {Types::DescribePortalResponse#portal_logo_image_location #portal_logo_image_location} => Types::ImageLocation
1731
1784
  # * {Types::DescribePortalResponse#role_arn #role_arn} => String
1785
+ # * {Types::DescribePortalResponse#portal_auth_mode #portal_auth_mode} => String
1732
1786
  #
1733
1787
  # @example Request syntax with placeholder values
1734
1788
  #
@@ -1746,13 +1800,14 @@ module Aws::IoTSiteWise
1746
1800
  # resp.portal_start_url #=> String
1747
1801
  # resp.portal_contact_email #=> String
1748
1802
  # resp.portal_status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
1749
- # resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE"
1803
+ # resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
1750
1804
  # resp.portal_status.error.message #=> String
1751
1805
  # resp.portal_creation_date #=> Time
1752
1806
  # resp.portal_last_update_date #=> Time
1753
1807
  # resp.portal_logo_image_location.id #=> String
1754
1808
  # resp.portal_logo_image_location.url #=> String
1755
1809
  # resp.role_arn #=> String
1810
+ # resp.portal_auth_mode #=> String, one of "IAM", "SSO"
1756
1811
  #
1757
1812
  #
1758
1813
  # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
@@ -1816,7 +1871,7 @@ module Aws::IoTSiteWise
1816
1871
  # different groupings of assets to be formed that all come from the same
1817
1872
  # asset model. You can use the hierarchy ID to identify the correct
1818
1873
  # asset to disassociate. For more information, see [Asset
1819
- # Hierarchies][1] in the *AWS IoT SiteWise User Guide*.
1874
+ # hierarchies][1] in the *AWS IoT SiteWise User Guide*.
1820
1875
  #
1821
1876
  #
1822
1877
  #
@@ -1852,8 +1907,7 @@ module Aws::IoTSiteWise
1852
1907
  end
1853
1908
 
1854
1909
  # Gets aggregated values for an asset property. For more information,
1855
- # see [Querying Aggregated Property Values][1] in the *AWS IoT SiteWise
1856
- # User Guide*.
1910
+ # see [Querying aggregates][1] in the *AWS IoT SiteWise User Guide*.
1857
1911
  #
1858
1912
  # To identify an asset property, you must specify one of the following:
1859
1913
  #
@@ -1878,7 +1932,7 @@ module Aws::IoTSiteWise
1878
1932
  # The property alias that identifies the property, such as an OPC-UA
1879
1933
  # server data stream path (for example,
1880
1934
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
1881
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
1935
+ # see [Mapping industrial data streams to asset properties][1] in the
1882
1936
  # *AWS IoT SiteWise User Guide*.
1883
1937
  #
1884
1938
  #
@@ -1905,12 +1959,16 @@ module Aws::IoTSiteWise
1905
1959
  # @option params [String] :time_ordering
1906
1960
  # The chronological sorting order of the requested information.
1907
1961
  #
1962
+ # Default: `ASCENDING`
1963
+ #
1908
1964
  # @option params [String] :next_token
1909
1965
  # The token to be used for the next set of paginated results.
1910
1966
  #
1911
1967
  # @option params [Integer] :max_results
1912
1968
  # The maximum number of results to be returned per paginated request.
1913
1969
  #
1970
+ # Default: 100
1971
+ #
1914
1972
  # @return [Types::GetAssetPropertyAggregatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1915
1973
  #
1916
1974
  # * {Types::GetAssetPropertyAggregatesResponse#aggregated_values #aggregated_values} => Array&lt;Types::AggregatedValue&gt;
@@ -1955,8 +2013,7 @@ module Aws::IoTSiteWise
1955
2013
  end
1956
2014
 
1957
2015
  # Gets an asset property's current value. For more information, see
1958
- # [Querying Current Property Values][1] in the *AWS IoT SiteWise User
1959
- # Guide*.
2016
+ # [Querying current values][1] in the *AWS IoT SiteWise User Guide*.
1960
2017
  #
1961
2018
  # To identify an asset property, you must specify one of the following:
1962
2019
  #
@@ -1981,7 +2038,7 @@ module Aws::IoTSiteWise
1981
2038
  # The property alias that identifies the property, such as an OPC-UA
1982
2039
  # server data stream path (for example,
1983
2040
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
1984
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
2041
+ # see [Mapping industrial data streams to asset properties][1] in the
1985
2042
  # *AWS IoT SiteWise User Guide*.
1986
2043
  #
1987
2044
  #
@@ -2018,8 +2075,8 @@ module Aws::IoTSiteWise
2018
2075
  end
2019
2076
 
2020
2077
  # Gets the history of an asset property's values. For more information,
2021
- # see [Querying Historical Property Values][1] in the *AWS IoT SiteWise
2022
- # User Guide*.
2078
+ # see [Querying historical values][1] in the *AWS IoT SiteWise User
2079
+ # Guide*.
2023
2080
  #
2024
2081
  # To identify an asset property, you must specify one of the following:
2025
2082
  #
@@ -2044,7 +2101,7 @@ module Aws::IoTSiteWise
2044
2101
  # The property alias that identifies the property, such as an OPC-UA
2045
2102
  # server data stream path (for example,
2046
2103
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
2047
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
2104
+ # see [Mapping industrial data streams to asset properties][1] in the
2048
2105
  # *AWS IoT SiteWise User Guide*.
2049
2106
  #
2050
2107
  #
@@ -2065,12 +2122,16 @@ module Aws::IoTSiteWise
2065
2122
  # @option params [String] :time_ordering
2066
2123
  # The chronological sorting order of the requested information.
2067
2124
  #
2125
+ # Default: `ASCENDING`
2126
+ #
2068
2127
  # @option params [String] :next_token
2069
2128
  # The token to be used for the next set of paginated results.
2070
2129
  #
2071
2130
  # @option params [Integer] :max_results
2072
2131
  # The maximum number of results to be returned per paginated request.
2073
2132
  #
2133
+ # Default: 100
2134
+ #
2074
2135
  # @return [Types::GetAssetPropertyValueHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2075
2136
  #
2076
2137
  # * {Types::GetAssetPropertyValueHistoryResponse#asset_property_value_history #asset_property_value_history} => Array&lt;Types::AssetPropertyValue&gt;
@@ -2111,17 +2172,17 @@ module Aws::IoTSiteWise
2111
2172
  req.send_request(options)
2112
2173
  end
2113
2174
 
2114
- # Retrieves a paginated list of access policies for an AWS SSO identity
2115
- # (a user or group) or an AWS IoT SiteWise Monitor resource (a portal or
2116
- # project).
2175
+ # Retrieves a paginated list of access policies for an identity (an AWS
2176
+ # SSO user, an AWS SSO group, or an IAM user) or an AWS IoT SiteWise
2177
+ # Monitor resource (a portal or project).
2117
2178
  #
2118
2179
  # @option params [String] :identity_type
2119
- # The type of identity (user or group). This parameter is required if
2120
- # you specify `identityId`.
2180
+ # The type of identity (AWS SSO user, AWS SSO group, or IAM user). This
2181
+ # parameter is required if you specify `identityId`.
2121
2182
  #
2122
2183
  # @option params [String] :identity_id
2123
2184
  # The ID of the identity. This parameter is required if you specify
2124
- # `identityType`.
2185
+ # `USER` or `GROUP` for `identityType`.
2125
2186
  #
2126
2187
  # @option params [String] :resource_type
2127
2188
  # The type of resource (portal or project). This parameter is required
@@ -2131,12 +2192,23 @@ module Aws::IoTSiteWise
2131
2192
  # The ID of the resource. This parameter is required if you specify
2132
2193
  # `resourceType`.
2133
2194
  #
2195
+ # @option params [String] :iam_arn
2196
+ # The ARN of the IAM user. For more information, see [IAM ARNs][1] in
2197
+ # the *IAM User Guide*. This parameter is required if you specify `IAM`
2198
+ # for `identityType`.
2199
+ #
2200
+ #
2201
+ #
2202
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html
2203
+ #
2134
2204
  # @option params [String] :next_token
2135
2205
  # The token to be used for the next set of paginated results.
2136
2206
  #
2137
2207
  # @option params [Integer] :max_results
2138
2208
  # The maximum number of results to be returned per paginated request.
2139
2209
  #
2210
+ # Default: 50
2211
+ #
2140
2212
  # @return [Types::ListAccessPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2141
2213
  #
2142
2214
  # * {Types::ListAccessPoliciesResponse#access_policy_summaries #access_policy_summaries} => Array&lt;Types::AccessPolicySummary&gt;
@@ -2147,10 +2219,11 @@ module Aws::IoTSiteWise
2147
2219
  # @example Request syntax with placeholder values
2148
2220
  #
2149
2221
  # resp = client.list_access_policies({
2150
- # identity_type: "USER", # accepts USER, GROUP
2222
+ # identity_type: "USER", # accepts USER, GROUP, IAM
2151
2223
  # identity_id: "IdentityId",
2152
2224
  # resource_type: "PORTAL", # accepts PORTAL, PROJECT
2153
2225
  # resource_id: "ID",
2226
+ # iam_arn: "ARN",
2154
2227
  # next_token: "NextToken",
2155
2228
  # max_results: 1,
2156
2229
  # })
@@ -2161,6 +2234,7 @@ module Aws::IoTSiteWise
2161
2234
  # resp.access_policy_summaries[0].id #=> String
2162
2235
  # resp.access_policy_summaries[0].identity.user.id #=> String
2163
2236
  # resp.access_policy_summaries[0].identity.group.id #=> String
2237
+ # resp.access_policy_summaries[0].identity.iam_user.arn #=> String
2164
2238
  # resp.access_policy_summaries[0].resource.portal.id #=> String
2165
2239
  # resp.access_policy_summaries[0].resource.project.id #=> String
2166
2240
  # resp.access_policy_summaries[0].permission #=> String, one of "ADMINISTRATOR", "VIEWER"
@@ -2183,6 +2257,8 @@ module Aws::IoTSiteWise
2183
2257
  # @option params [Integer] :max_results
2184
2258
  # The maximum number of results to be returned per paginated request.
2185
2259
  #
2260
+ # Default: 50
2261
+ #
2186
2262
  # @return [Types::ListAssetModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2187
2263
  #
2188
2264
  # * {Types::ListAssetModelsResponse#asset_model_summaries #asset_model_summaries} => Array&lt;Types::AssetModelSummary&gt;
@@ -2241,13 +2317,15 @@ module Aws::IoTSiteWise
2241
2317
  # @option params [Integer] :max_results
2242
2318
  # The maximum number of results to be returned per paginated request.
2243
2319
  #
2320
+ # Default: 50
2321
+ #
2244
2322
  # @option params [String] :asset_model_id
2245
2323
  # The ID of the asset model by which to filter the list of assets. This
2246
2324
  # parameter is required if you choose `ALL` for `filter`.
2247
2325
  #
2248
2326
  # @option params [String] :filter
2249
2327
  # The filter for the requested list of assets. Choose one of the
2250
- # following options. Defaults to `ALL`.
2328
+ # following options:
2251
2329
  #
2252
2330
  # * `ALL` – The list includes all assets for a given asset model ID. The
2253
2331
  # `assetModelId` parameter is required if you filter by `ALL`.
@@ -2255,6 +2333,8 @@ module Aws::IoTSiteWise
2255
2333
  # * `TOP_LEVEL` – The list includes only top-level assets in the asset
2256
2334
  # hierarchy tree.
2257
2335
  #
2336
+ # Default: `ALL`
2337
+ #
2258
2338
  # @return [Types::ListAssetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2259
2339
  #
2260
2340
  # * {Types::ListAssetsResponse#asset_summaries #asset_summaries} => Array&lt;Types::AssetSummary&gt;
@@ -2295,18 +2375,25 @@ module Aws::IoTSiteWise
2295
2375
  req.send_request(options)
2296
2376
  end
2297
2377
 
2298
- # Retrieves a paginated list of the assets associated to a parent asset
2299
- # (`assetId`) by a given hierarchy (`hierarchyId`).
2378
+ # Retrieves a paginated list of associated assets.
2379
+ #
2380
+ # You can use this operation to do the following:
2381
+ #
2382
+ # * List child assets associated to a parent asset by a hierarchy that
2383
+ # you specify.
2384
+ #
2385
+ # * List an asset's parent asset.
2300
2386
  #
2301
2387
  # @option params [required, String] :asset_id
2302
- # The ID of the parent asset.
2388
+ # The ID of the asset to query.
2303
2389
  #
2304
- # @option params [required, String] :hierarchy_id
2305
- # The hierarchy ID (of the parent asset model) whose associated assets
2306
- # are returned. To find a hierarchy ID, use the [DescribeAsset][1] or
2307
- # [DescribeAssetModel][2] actions.
2390
+ # @option params [String] :hierarchy_id
2391
+ # The ID of the hierarchy by which child assets are associated to the
2392
+ # asset. To find a hierarchy ID, use the [DescribeAsset][1] or
2393
+ # [DescribeAssetModel][2] operations. This parameter is required if you
2394
+ # choose `CHILD` for `traversalDirection`.
2308
2395
  #
2309
- # For more information, see [Asset Hierarchies][3] in the *AWS IoT
2396
+ # For more information, see [Asset hierarchies][3] in the *AWS IoT
2310
2397
  # SiteWise User Guide*.
2311
2398
  #
2312
2399
  #
@@ -2315,12 +2402,26 @@ module Aws::IoTSiteWise
2315
2402
  # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html
2316
2403
  # [3]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
2317
2404
  #
2405
+ # @option params [String] :traversal_direction
2406
+ # The direction to list associated assets. Choose one of the following
2407
+ # options:
2408
+ #
2409
+ # * `CHILD` – The list includes all child assets associated to the
2410
+ # asset. The `hierarchyId` parameter is required if you choose
2411
+ # `CHILD`.
2412
+ #
2413
+ # * `PARENT` – The list includes the asset's parent asset.
2414
+ #
2415
+ # Default: `CHILD`
2416
+ #
2318
2417
  # @option params [String] :next_token
2319
2418
  # The token to be used for the next set of paginated results.
2320
2419
  #
2321
2420
  # @option params [Integer] :max_results
2322
2421
  # The maximum number of results to be returned per paginated request.
2323
2422
  #
2423
+ # Default: 50
2424
+ #
2324
2425
  # @return [Types::ListAssociatedAssetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2325
2426
  #
2326
2427
  # * {Types::ListAssociatedAssetsResponse#asset_summaries #asset_summaries} => Array&lt;Types::AssociatedAssetsSummary&gt;
@@ -2332,7 +2433,8 @@ module Aws::IoTSiteWise
2332
2433
  #
2333
2434
  # resp = client.list_associated_assets({
2334
2435
  # asset_id: "ID", # required
2335
- # hierarchy_id: "ID", # required
2436
+ # hierarchy_id: "ID",
2437
+ # traversal_direction: "PARENT", # accepts PARENT, CHILD
2336
2438
  # next_token: "NextToken",
2337
2439
  # max_results: 1,
2338
2440
  # })
@@ -2373,6 +2475,8 @@ module Aws::IoTSiteWise
2373
2475
  # @option params [Integer] :max_results
2374
2476
  # The maximum number of results to be returned per paginated request.
2375
2477
  #
2478
+ # Default: 50
2479
+ #
2376
2480
  # @return [Types::ListDashboardsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2377
2481
  #
2378
2482
  # * {Types::ListDashboardsResponse#dashboard_summaries #dashboard_summaries} => Array&lt;Types::DashboardSummary&gt;
@@ -2413,6 +2517,8 @@ module Aws::IoTSiteWise
2413
2517
  # @option params [Integer] :max_results
2414
2518
  # The maximum number of results to be returned per paginated request.
2415
2519
  #
2520
+ # Default: 50
2521
+ #
2416
2522
  # @return [Types::ListGatewaysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2417
2523
  #
2418
2524
  # * {Types::ListGatewaysResponse#gateway_summaries #gateway_summaries} => Array&lt;Types::GatewaySummary&gt;
@@ -2454,6 +2560,8 @@ module Aws::IoTSiteWise
2454
2560
  # @option params [Integer] :max_results
2455
2561
  # The maximum number of results to be returned per paginated request.
2456
2562
  #
2563
+ # Default: 50
2564
+ #
2457
2565
  # @return [Types::ListPortalsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2458
2566
  #
2459
2567
  # * {Types::ListPortalsResponse#portal_summaries #portal_summaries} => Array&lt;Types::PortalSummary&gt;
@@ -2478,6 +2586,9 @@ module Aws::IoTSiteWise
2478
2586
  # resp.portal_summaries[0].creation_date #=> Time
2479
2587
  # resp.portal_summaries[0].last_update_date #=> Time
2480
2588
  # resp.portal_summaries[0].role_arn #=> String
2589
+ # resp.portal_summaries[0].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
2590
+ # resp.portal_summaries[0].status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
2591
+ # resp.portal_summaries[0].status.error.message #=> String
2481
2592
  # resp.next_token #=> String
2482
2593
  #
2483
2594
  # @overload list_portals(params = {})
@@ -2499,6 +2610,8 @@ module Aws::IoTSiteWise
2499
2610
  # @option params [Integer] :max_results
2500
2611
  # The maximum number of results to be returned per paginated request.
2501
2612
  #
2613
+ # Default: 50
2614
+ #
2502
2615
  # @return [Types::ListProjectAssetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2503
2616
  #
2504
2617
  # * {Types::ListProjectAssetsResponse#asset_ids #asset_ids} => Array&lt;String&gt;
@@ -2539,6 +2652,8 @@ module Aws::IoTSiteWise
2539
2652
  # @option params [Integer] :max_results
2540
2653
  # The maximum number of results to be returned per paginated request.
2541
2654
  #
2655
+ # Default: 50
2656
+ #
2542
2657
  # @return [Types::ListProjectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2543
2658
  #
2544
2659
  # * {Types::ListProjectsResponse#project_summaries #project_summaries} => Array&lt;Types::ProjectSummary&gt;
@@ -2689,20 +2804,19 @@ module Aws::IoTSiteWise
2689
2804
  req.send_request(options)
2690
2805
  end
2691
2806
 
2692
- # Updates an existing access policy that specifies an AWS SSO user or
2693
- # group's access to an AWS IoT SiteWise Monitor portal or project
2694
- # resource.
2807
+ # Updates an existing access policy that specifies an identity's access
2808
+ # to an AWS IoT SiteWise Monitor portal or project resource.
2695
2809
  #
2696
2810
  # @option params [required, String] :access_policy_id
2697
2811
  # The ID of the access policy.
2698
2812
  #
2699
2813
  # @option params [required, Types::Identity] :access_policy_identity
2700
- # The identity for this access policy. Choose either a `user` or a
2701
- # `group` but not both.
2814
+ # The identity for this access policy. Choose an AWS SSO user, an AWS
2815
+ # SSO group, or an IAM user.
2702
2816
  #
2703
2817
  # @option params [required, Types::Resource] :access_policy_resource
2704
2818
  # The AWS IoT SiteWise Monitor resource for this access policy. Choose
2705
- # either `portal` or `project` but not both.
2819
+ # either a portal or a project.
2706
2820
  #
2707
2821
  # @option params [required, String] :access_policy_permission
2708
2822
  # The permission level for this access policy. Note that a project
@@ -2729,6 +2843,9 @@ module Aws::IoTSiteWise
2729
2843
  # group: {
2730
2844
  # id: "IdentityId", # required
2731
2845
  # },
2846
+ # iam_user: {
2847
+ # arn: "ARN", # required
2848
+ # },
2732
2849
  # },
2733
2850
  # access_policy_resource: { # required
2734
2851
  # portal: {
@@ -2749,8 +2866,8 @@ module Aws::IoTSiteWise
2749
2866
  req.send_request(options)
2750
2867
  end
2751
2868
 
2752
- # Updates an asset's name. For more information, see [Updating Assets
2753
- # and Models][1] in the *AWS IoT SiteWise User Guide*.
2869
+ # Updates an asset's name. For more information, see [Updating assets
2870
+ # and models][1] in the *AWS IoT SiteWise User Guide*.
2754
2871
  #
2755
2872
  #
2756
2873
  #
@@ -2798,7 +2915,7 @@ module Aws::IoTSiteWise
2798
2915
  # Updates an asset model and all of the assets that were created from
2799
2916
  # the model. Each asset created from the model inherits the updated
2800
2917
  # asset model's property and hierarchy definitions. For more
2801
- # information, see [Updating Assets and Models][1] in the *AWS IoT
2918
+ # information, see [Updating assets and models][1] in the *AWS IoT
2802
2919
  # SiteWise User Guide*.
2803
2920
  #
2804
2921
  # This operation overwrites the existing model with the provided model.
@@ -2806,12 +2923,12 @@ module Aws::IoTSiteWise
2806
2923
  # must include their IDs and definitions in the updated asset model
2807
2924
  # payload. For more information, see [DescribeAssetModel][2].
2808
2925
  #
2809
- # If you remove a property from an asset model or update a property's
2810
- # formula expression, AWS IoT SiteWise deletes all previous data for
2811
- # that property. If you remove a hierarchy definition from an asset
2812
- # model, AWS IoT SiteWise disassociates every asset associated with that
2813
- # hierarchy. You can't change the type or data type of an existing
2814
- # property.
2926
+ # If you remove a property from an asset model, AWS IoT SiteWise
2927
+ # deletes
2928
+ # all previous data for that property. If you remove a hierarchy
2929
+ # definition from an asset model, AWS IoT SiteWise disassociates every
2930
+ # asset associated with that hierarchy. You can't change the type or
2931
+ # data type of an existing property.
2815
2932
  #
2816
2933
  #
2817
2934
  #
@@ -2829,7 +2946,7 @@ module Aws::IoTSiteWise
2829
2946
  #
2830
2947
  # @option params [Array<Types::AssetModelProperty>] :asset_model_properties
2831
2948
  # The updated property definitions of the asset model. For more
2832
- # information, see [Asset Properties][1] in the *AWS IoT SiteWise User
2949
+ # information, see [Asset properties][1] in the *AWS IoT SiteWise User
2833
2950
  # Guide*.
2834
2951
  #
2835
2952
  # You can specify up to 200 properties per asset model. For more
@@ -2844,7 +2961,7 @@ module Aws::IoTSiteWise
2844
2961
  # The updated hierarchy definitions of the asset model. Each hierarchy
2845
2962
  # specifies an asset model whose assets can be children of any other
2846
2963
  # assets created from this asset model. For more information, see [Asset
2847
- # Hierarchies][1] in the *AWS IoT SiteWise User Guide*.
2964
+ # hierarchies][1] in the *AWS IoT SiteWise User Guide*.
2848
2965
  #
2849
2966
  # You can specify up to 10 hierarchies per asset model. For more
2850
2967
  # information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
@@ -2961,7 +3078,7 @@ module Aws::IoTSiteWise
2961
3078
  # The property alias that identifies the property, such as an OPC-UA
2962
3079
  # server data stream path (for example,
2963
3080
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
2964
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
3081
+ # see [Mapping industrial data streams to asset properties][1] in the
2965
3082
  # *AWS IoT SiteWise User Guide*.
2966
3083
  #
2967
3084
  # If you omit this parameter, the alias is removed from the property.
@@ -2974,7 +3091,7 @@ module Aws::IoTSiteWise
2974
3091
  # The MQTT notification state (enabled or disabled) for this asset
2975
3092
  # property. When the notification state is enabled, AWS IoT SiteWise
2976
3093
  # publishes property value updates to a unique MQTT topic. For more
2977
- # information, see [Interacting with Other Services][1] in the *AWS IoT
3094
+ # information, see [Interacting with other services][1] in the *AWS IoT
2978
3095
  # SiteWise User Guide*.
2979
3096
  #
2980
3097
  # If you omit this parameter, the notification state is set to
@@ -3024,7 +3141,7 @@ module Aws::IoTSiteWise
3024
3141
  #
3025
3142
  # @option params [required, String] :dashboard_definition
3026
3143
  # The new dashboard definition, as specified in a JSON literal. For
3027
- # detailed information, see [Creating Dashboards (CLI)][1] in the *AWS
3144
+ # detailed information, see [Creating dashboards (CLI)][1] in the *AWS
3028
3145
  # IoT SiteWise User Guide*.
3029
3146
  #
3030
3147
  #
@@ -3204,7 +3321,7 @@ module Aws::IoTSiteWise
3204
3321
  # @example Response structure
3205
3322
  #
3206
3323
  # resp.portal_status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
3207
- # resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE"
3324
+ # resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
3208
3325
  # resp.portal_status.error.message #=> String
3209
3326
  #
3210
3327
  # @overload update_portal(params = {})
@@ -3264,7 +3381,7 @@ module Aws::IoTSiteWise
3264
3381
  params: params,
3265
3382
  config: config)
3266
3383
  context[:gem_name] = 'aws-sdk-iotsitewise'
3267
- context[:gem_version] = '1.7.0'
3384
+ context[:gem_version] = '1.13.0'
3268
3385
  Seahorse::Client::Request.new(handlers, context)
3269
3386
  end
3270
3387