aws-sdk-iotsitewise 1.7.0 → 1.9.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: 3413819aa5f83d783a0ca93e2e3b46ccf4f00f34103fd159c3278fb31ed0e321
4
+ data.tar.gz: 3eae5d96f91101a79b444272fcfd97a1d70e52a8cea0023a9264c06641d7ea29
5
5
  SHA512:
6
- metadata.gz: d8fcefde76ef8924013e4d245a4a4dc8712a1704c9a6809f3defd8768058bd8b5acc0bcdeeeaf5dcd5af183a9522ef8bc10ff4567370bc5c99efb7ca03588786
7
- data.tar.gz: ad8dc57c4874fac189048cbaeff202e1652d8dbe6dd3d9975ce1a8619790ccb9253f1ff286f08e8d528e96c533fc335cfafbb19b48b7f1dcde5a2c3fc74433b7
6
+ metadata.gz: 0f8d94ad11735f1913e3228b02dd0176bb8beef85581b58d2a3162d28d1545ff88e9107cbd68459d562e12e030b8450b1bab04f55bb1ca884e6500e85058618f
7
+ data.tar.gz: 92125b5d90c7033e9339eb437a38a5e10214cdb5b4fd9c01c769a19ccd865de1c7761ad7f55f9d49bad831566b79e7ce1a00b4b2a070b913ecf9cf9d581acbdc
@@ -45,9 +45,9 @@ require_relative 'aws-sdk-iotsitewise/customizations'
45
45
  #
46
46
  # See {Errors} for more information.
47
47
  #
48
- # @service
48
+ # @!group service
49
49
  module Aws::IoTSiteWise
50
50
 
51
- GEM_VERSION = '1.7.0'
51
+ GEM_VERSION = '1.9.0'
52
52
 
53
53
  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.
@@ -608,7 +629,7 @@ module Aws::IoTSiteWise
608
629
  end
609
630
 
610
631
  # Creates an asset from an existing asset model. For more information,
611
- # see [Creating Assets][1] in the *AWS IoT SiteWise User Guide*.
632
+ # see [Creating assets][1] in the *AWS IoT SiteWise User Guide*.
612
633
  #
613
634
  #
614
635
  #
@@ -674,7 +695,7 @@ module Aws::IoTSiteWise
674
695
  # you can easily create assets of the same type that have standardized
675
696
  # definitions. Each asset created from a model inherits the asset
676
697
  # model's property and hierarchy definitions. For more information, see
677
- # [Defining Asset Models][1] in the *AWS IoT SiteWise User Guide*.
698
+ # [Defining asset models][1] in the *AWS IoT SiteWise User Guide*.
678
699
  #
679
700
  #
680
701
  #
@@ -688,7 +709,7 @@ module Aws::IoTSiteWise
688
709
  #
689
710
  # @option params [Array<Types::AssetModelPropertyDefinition>] :asset_model_properties
690
711
  # The property definitions of the asset model. For more information, see
691
- # [Asset Properties][1] in the *AWS IoT SiteWise User Guide*.
712
+ # [Asset properties][1] in the *AWS IoT SiteWise User Guide*.
692
713
  #
693
714
  # You can specify up to 200 properties per asset model. For more
694
715
  # information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
@@ -702,7 +723,7 @@ module Aws::IoTSiteWise
702
723
  # The hierarchy definitions of the asset model. Each hierarchy specifies
703
724
  # an asset model whose assets can be children of any other assets
704
725
  # created from this asset model. For more information, see [Asset
705
- # Hierarchies][1] in the *AWS IoT SiteWise User Guide*.
726
+ # hierarchies][1] in the *AWS IoT SiteWise User Guide*.
706
727
  #
707
728
  # You can specify up to 10 hierarchies per asset model. For more
708
729
  # information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
@@ -823,7 +844,7 @@ module Aws::IoTSiteWise
823
844
  #
824
845
  # @option params [required, String] :dashboard_definition
825
846
  # The dashboard definition specified in a JSON literal. For detailed
826
- # information, see [Creating Dashboards (CLI)][1] in the *AWS IoT
847
+ # information, see [Creating dashboards (CLI)][1] in the *AWS IoT
827
848
  # SiteWise User Guide*.
828
849
  #
829
850
  #
@@ -934,14 +955,14 @@ module Aws::IoTSiteWise
934
955
  end
935
956
 
936
957
  # 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*.
958
+ # you can create a portal, you must enable AWS Single Sign-On. AWS IoT
959
+ # SiteWise Monitor uses AWS SSO to manage user permissions. For more
960
+ # information, see [Enabling AWS SSO][1] in the *AWS IoT SiteWise User
961
+ # Guide*.
941
962
  #
942
963
  # <note markdown="1"> Before you can sign in to a new portal, you must add at least one AWS
943
964
  # SSO user or group to that portal. For more information, see [Adding or
944
- # Removing Portal Administrators][2] in the *AWS IoT SiteWise User
965
+ # removing portal administrators][2] in the *AWS IoT SiteWise User
945
966
  # Guide*.
946
967
  #
947
968
  # </note>
@@ -1023,7 +1044,7 @@ module Aws::IoTSiteWise
1023
1044
  # resp.portal_arn #=> String
1024
1045
  # resp.portal_start_url #=> String
1025
1046
  # resp.portal_status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
1026
- # resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE"
1047
+ # resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
1027
1048
  # resp.portal_status.error.message #=> String
1028
1049
  # resp.sso_application_id #=> String
1029
1050
  #
@@ -1124,7 +1145,7 @@ module Aws::IoTSiteWise
1124
1145
  end
1125
1146
 
1126
1147
  # 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
1148
+ # see [Deleting assets and models][1] in the *AWS IoT SiteWise User
1128
1149
  # Guide*.
1129
1150
  #
1130
1151
  # <note markdown="1"> You can't delete an asset that's associated to another asset. For
@@ -1177,7 +1198,7 @@ module Aws::IoTSiteWise
1177
1198
  # model. Also, you can't delete an asset model if a parent asset model
1178
1199
  # exists that contains a property formula expression that depends on the
1179
1200
  # asset model that you want to delete. For more information, see
1180
- # [Deleting Assets and Models][1] in the *AWS IoT SiteWise User Guide*.
1201
+ # [Deleting assets and models][1] in the *AWS IoT SiteWise User Guide*.
1181
1202
  #
1182
1203
  #
1183
1204
  #
@@ -1301,7 +1322,7 @@ module Aws::IoTSiteWise
1301
1322
  # @example Response structure
1302
1323
  #
1303
1324
  # resp.portal_status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
1304
- # resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE"
1325
+ # resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
1305
1326
  # resp.portal_status.error.message #=> String
1306
1327
  #
1307
1328
  # @overload delete_portal(params = {})
@@ -1509,7 +1530,21 @@ module Aws::IoTSiteWise
1509
1530
  req.send_request(options)
1510
1531
  end
1511
1532
 
1512
- # Retrieves information about an asset's property.
1533
+ # Retrieves information about an asset property.
1534
+ #
1535
+ # <note markdown="1"> When you call this operation for an attribute property, this response
1536
+ # includes the default attribute value that you define in the asset
1537
+ # model. If you update the default value in the model, this operation's
1538
+ # response includes the new default value.
1539
+ #
1540
+ # </note>
1541
+ #
1542
+ # This operation doesn't return the value of the asset property. To get
1543
+ # the value of an asset property, use [GetAssetPropertyValue][1].
1544
+ #
1545
+ #
1546
+ #
1547
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_GetAssetPropertyValue.html
1513
1548
  #
1514
1549
  # @option params [required, String] :asset_id
1515
1550
  # The ID of the asset.
@@ -1746,7 +1781,7 @@ module Aws::IoTSiteWise
1746
1781
  # resp.portal_start_url #=> String
1747
1782
  # resp.portal_contact_email #=> String
1748
1783
  # resp.portal_status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
1749
- # resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE"
1784
+ # resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
1750
1785
  # resp.portal_status.error.message #=> String
1751
1786
  # resp.portal_creation_date #=> Time
1752
1787
  # resp.portal_last_update_date #=> Time
@@ -1816,7 +1851,7 @@ module Aws::IoTSiteWise
1816
1851
  # different groupings of assets to be formed that all come from the same
1817
1852
  # asset model. You can use the hierarchy ID to identify the correct
1818
1853
  # asset to disassociate. For more information, see [Asset
1819
- # Hierarchies][1] in the *AWS IoT SiteWise User Guide*.
1854
+ # hierarchies][1] in the *AWS IoT SiteWise User Guide*.
1820
1855
  #
1821
1856
  #
1822
1857
  #
@@ -1852,8 +1887,7 @@ module Aws::IoTSiteWise
1852
1887
  end
1853
1888
 
1854
1889
  # 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*.
1890
+ # see [Querying aggregates][1] in the *AWS IoT SiteWise User Guide*.
1857
1891
  #
1858
1892
  # To identify an asset property, you must specify one of the following:
1859
1893
  #
@@ -1878,7 +1912,7 @@ module Aws::IoTSiteWise
1878
1912
  # The property alias that identifies the property, such as an OPC-UA
1879
1913
  # server data stream path (for example,
1880
1914
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
1881
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
1915
+ # see [Mapping industrial data streams to asset properties][1] in the
1882
1916
  # *AWS IoT SiteWise User Guide*.
1883
1917
  #
1884
1918
  #
@@ -1905,12 +1939,16 @@ module Aws::IoTSiteWise
1905
1939
  # @option params [String] :time_ordering
1906
1940
  # The chronological sorting order of the requested information.
1907
1941
  #
1942
+ # Default: `ASCENDING`
1943
+ #
1908
1944
  # @option params [String] :next_token
1909
1945
  # The token to be used for the next set of paginated results.
1910
1946
  #
1911
1947
  # @option params [Integer] :max_results
1912
1948
  # The maximum number of results to be returned per paginated request.
1913
1949
  #
1950
+ # Default: 100
1951
+ #
1914
1952
  # @return [Types::GetAssetPropertyAggregatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1915
1953
  #
1916
1954
  # * {Types::GetAssetPropertyAggregatesResponse#aggregated_values #aggregated_values} => Array&lt;Types::AggregatedValue&gt;
@@ -1955,8 +1993,7 @@ module Aws::IoTSiteWise
1955
1993
  end
1956
1994
 
1957
1995
  # 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*.
1996
+ # [Querying current values][1] in the *AWS IoT SiteWise User Guide*.
1960
1997
  #
1961
1998
  # To identify an asset property, you must specify one of the following:
1962
1999
  #
@@ -1981,7 +2018,7 @@ module Aws::IoTSiteWise
1981
2018
  # The property alias that identifies the property, such as an OPC-UA
1982
2019
  # server data stream path (for example,
1983
2020
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
1984
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
2021
+ # see [Mapping industrial data streams to asset properties][1] in the
1985
2022
  # *AWS IoT SiteWise User Guide*.
1986
2023
  #
1987
2024
  #
@@ -2018,8 +2055,8 @@ module Aws::IoTSiteWise
2018
2055
  end
2019
2056
 
2020
2057
  # 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*.
2058
+ # see [Querying historical values][1] in the *AWS IoT SiteWise User
2059
+ # Guide*.
2023
2060
  #
2024
2061
  # To identify an asset property, you must specify one of the following:
2025
2062
  #
@@ -2044,7 +2081,7 @@ module Aws::IoTSiteWise
2044
2081
  # The property alias that identifies the property, such as an OPC-UA
2045
2082
  # server data stream path (for example,
2046
2083
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
2047
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
2084
+ # see [Mapping industrial data streams to asset properties][1] in the
2048
2085
  # *AWS IoT SiteWise User Guide*.
2049
2086
  #
2050
2087
  #
@@ -2065,12 +2102,16 @@ module Aws::IoTSiteWise
2065
2102
  # @option params [String] :time_ordering
2066
2103
  # The chronological sorting order of the requested information.
2067
2104
  #
2105
+ # Default: `ASCENDING`
2106
+ #
2068
2107
  # @option params [String] :next_token
2069
2108
  # The token to be used for the next set of paginated results.
2070
2109
  #
2071
2110
  # @option params [Integer] :max_results
2072
2111
  # The maximum number of results to be returned per paginated request.
2073
2112
  #
2113
+ # Default: 100
2114
+ #
2074
2115
  # @return [Types::GetAssetPropertyValueHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2075
2116
  #
2076
2117
  # * {Types::GetAssetPropertyValueHistoryResponse#asset_property_value_history #asset_property_value_history} => Array&lt;Types::AssetPropertyValue&gt;
@@ -2137,6 +2178,8 @@ module Aws::IoTSiteWise
2137
2178
  # @option params [Integer] :max_results
2138
2179
  # The maximum number of results to be returned per paginated request.
2139
2180
  #
2181
+ # Default: 50
2182
+ #
2140
2183
  # @return [Types::ListAccessPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2141
2184
  #
2142
2185
  # * {Types::ListAccessPoliciesResponse#access_policy_summaries #access_policy_summaries} => Array&lt;Types::AccessPolicySummary&gt;
@@ -2183,6 +2226,8 @@ module Aws::IoTSiteWise
2183
2226
  # @option params [Integer] :max_results
2184
2227
  # The maximum number of results to be returned per paginated request.
2185
2228
  #
2229
+ # Default: 50
2230
+ #
2186
2231
  # @return [Types::ListAssetModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2187
2232
  #
2188
2233
  # * {Types::ListAssetModelsResponse#asset_model_summaries #asset_model_summaries} => Array&lt;Types::AssetModelSummary&gt;
@@ -2241,13 +2286,15 @@ module Aws::IoTSiteWise
2241
2286
  # @option params [Integer] :max_results
2242
2287
  # The maximum number of results to be returned per paginated request.
2243
2288
  #
2289
+ # Default: 50
2290
+ #
2244
2291
  # @option params [String] :asset_model_id
2245
2292
  # The ID of the asset model by which to filter the list of assets. This
2246
2293
  # parameter is required if you choose `ALL` for `filter`.
2247
2294
  #
2248
2295
  # @option params [String] :filter
2249
2296
  # The filter for the requested list of assets. Choose one of the
2250
- # following options. Defaults to `ALL`.
2297
+ # following options:
2251
2298
  #
2252
2299
  # * `ALL` – The list includes all assets for a given asset model ID. The
2253
2300
  # `assetModelId` parameter is required if you filter by `ALL`.
@@ -2255,6 +2302,8 @@ module Aws::IoTSiteWise
2255
2302
  # * `TOP_LEVEL` – The list includes only top-level assets in the asset
2256
2303
  # hierarchy tree.
2257
2304
  #
2305
+ # Default: `ALL`
2306
+ #
2258
2307
  # @return [Types::ListAssetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2259
2308
  #
2260
2309
  # * {Types::ListAssetsResponse#asset_summaries #asset_summaries} => Array&lt;Types::AssetSummary&gt;
@@ -2295,18 +2344,25 @@ module Aws::IoTSiteWise
2295
2344
  req.send_request(options)
2296
2345
  end
2297
2346
 
2298
- # Retrieves a paginated list of the assets associated to a parent asset
2299
- # (`assetId`) by a given hierarchy (`hierarchyId`).
2347
+ # Retrieves a paginated list of associated assets.
2348
+ #
2349
+ # You can use this operation to do the following:
2350
+ #
2351
+ # * List child assets associated to a parent asset by a hierarchy that
2352
+ # you specify.
2353
+ #
2354
+ # * List an asset's parent asset.
2300
2355
  #
2301
2356
  # @option params [required, String] :asset_id
2302
- # The ID of the parent asset.
2357
+ # The ID of the asset to query.
2303
2358
  #
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.
2359
+ # @option params [String] :hierarchy_id
2360
+ # The ID of the hierarchy by which child assets are associated to the
2361
+ # asset. To find a hierarchy ID, use the [DescribeAsset][1] or
2362
+ # [DescribeAssetModel][2] operations. This parameter is required if you
2363
+ # choose `CHILD` for `traversalDirection`.
2308
2364
  #
2309
- # For more information, see [Asset Hierarchies][3] in the *AWS IoT
2365
+ # For more information, see [Asset hierarchies][3] in the *AWS IoT
2310
2366
  # SiteWise User Guide*.
2311
2367
  #
2312
2368
  #
@@ -2315,12 +2371,26 @@ module Aws::IoTSiteWise
2315
2371
  # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html
2316
2372
  # [3]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
2317
2373
  #
2374
+ # @option params [String] :traversal_direction
2375
+ # The direction to list associated assets. Choose one of the following
2376
+ # options:
2377
+ #
2378
+ # * `CHILD` – The list includes all child assets associated to the
2379
+ # asset. The `hierarchyId` parameter is required if you choose
2380
+ # `CHILD`.
2381
+ #
2382
+ # * `PARENT` – The list includes the asset's parent asset.
2383
+ #
2384
+ # Default: `CHILD`
2385
+ #
2318
2386
  # @option params [String] :next_token
2319
2387
  # The token to be used for the next set of paginated results.
2320
2388
  #
2321
2389
  # @option params [Integer] :max_results
2322
2390
  # The maximum number of results to be returned per paginated request.
2323
2391
  #
2392
+ # Default: 50
2393
+ #
2324
2394
  # @return [Types::ListAssociatedAssetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2325
2395
  #
2326
2396
  # * {Types::ListAssociatedAssetsResponse#asset_summaries #asset_summaries} => Array&lt;Types::AssociatedAssetsSummary&gt;
@@ -2332,7 +2402,8 @@ module Aws::IoTSiteWise
2332
2402
  #
2333
2403
  # resp = client.list_associated_assets({
2334
2404
  # asset_id: "ID", # required
2335
- # hierarchy_id: "ID", # required
2405
+ # hierarchy_id: "ID",
2406
+ # traversal_direction: "PARENT", # accepts PARENT, CHILD
2336
2407
  # next_token: "NextToken",
2337
2408
  # max_results: 1,
2338
2409
  # })
@@ -2373,6 +2444,8 @@ module Aws::IoTSiteWise
2373
2444
  # @option params [Integer] :max_results
2374
2445
  # The maximum number of results to be returned per paginated request.
2375
2446
  #
2447
+ # Default: 50
2448
+ #
2376
2449
  # @return [Types::ListDashboardsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2377
2450
  #
2378
2451
  # * {Types::ListDashboardsResponse#dashboard_summaries #dashboard_summaries} => Array&lt;Types::DashboardSummary&gt;
@@ -2413,6 +2486,8 @@ module Aws::IoTSiteWise
2413
2486
  # @option params [Integer] :max_results
2414
2487
  # The maximum number of results to be returned per paginated request.
2415
2488
  #
2489
+ # Default: 50
2490
+ #
2416
2491
  # @return [Types::ListGatewaysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2417
2492
  #
2418
2493
  # * {Types::ListGatewaysResponse#gateway_summaries #gateway_summaries} => Array&lt;Types::GatewaySummary&gt;
@@ -2454,6 +2529,8 @@ module Aws::IoTSiteWise
2454
2529
  # @option params [Integer] :max_results
2455
2530
  # The maximum number of results to be returned per paginated request.
2456
2531
  #
2532
+ # Default: 50
2533
+ #
2457
2534
  # @return [Types::ListPortalsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2458
2535
  #
2459
2536
  # * {Types::ListPortalsResponse#portal_summaries #portal_summaries} => Array&lt;Types::PortalSummary&gt;
@@ -2478,6 +2555,9 @@ module Aws::IoTSiteWise
2478
2555
  # resp.portal_summaries[0].creation_date #=> Time
2479
2556
  # resp.portal_summaries[0].last_update_date #=> Time
2480
2557
  # resp.portal_summaries[0].role_arn #=> String
2558
+ # resp.portal_summaries[0].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
2559
+ # resp.portal_summaries[0].status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
2560
+ # resp.portal_summaries[0].status.error.message #=> String
2481
2561
  # resp.next_token #=> String
2482
2562
  #
2483
2563
  # @overload list_portals(params = {})
@@ -2499,6 +2579,8 @@ module Aws::IoTSiteWise
2499
2579
  # @option params [Integer] :max_results
2500
2580
  # The maximum number of results to be returned per paginated request.
2501
2581
  #
2582
+ # Default: 50
2583
+ #
2502
2584
  # @return [Types::ListProjectAssetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2503
2585
  #
2504
2586
  # * {Types::ListProjectAssetsResponse#asset_ids #asset_ids} => Array&lt;String&gt;
@@ -2539,6 +2621,8 @@ module Aws::IoTSiteWise
2539
2621
  # @option params [Integer] :max_results
2540
2622
  # The maximum number of results to be returned per paginated request.
2541
2623
  #
2624
+ # Default: 50
2625
+ #
2542
2626
  # @return [Types::ListProjectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2543
2627
  #
2544
2628
  # * {Types::ListProjectsResponse#project_summaries #project_summaries} => Array&lt;Types::ProjectSummary&gt;
@@ -2749,8 +2833,8 @@ module Aws::IoTSiteWise
2749
2833
  req.send_request(options)
2750
2834
  end
2751
2835
 
2752
- # Updates an asset's name. For more information, see [Updating Assets
2753
- # and Models][1] in the *AWS IoT SiteWise User Guide*.
2836
+ # Updates an asset's name. For more information, see [Updating assets
2837
+ # and models][1] in the *AWS IoT SiteWise User Guide*.
2754
2838
  #
2755
2839
  #
2756
2840
  #
@@ -2798,7 +2882,7 @@ module Aws::IoTSiteWise
2798
2882
  # Updates an asset model and all of the assets that were created from
2799
2883
  # the model. Each asset created from the model inherits the updated
2800
2884
  # asset model's property and hierarchy definitions. For more
2801
- # information, see [Updating Assets and Models][1] in the *AWS IoT
2885
+ # information, see [Updating assets and models][1] in the *AWS IoT
2802
2886
  # SiteWise User Guide*.
2803
2887
  #
2804
2888
  # This operation overwrites the existing model with the provided model.
@@ -2829,7 +2913,7 @@ module Aws::IoTSiteWise
2829
2913
  #
2830
2914
  # @option params [Array<Types::AssetModelProperty>] :asset_model_properties
2831
2915
  # The updated property definitions of the asset model. For more
2832
- # information, see [Asset Properties][1] in the *AWS IoT SiteWise User
2916
+ # information, see [Asset properties][1] in the *AWS IoT SiteWise User
2833
2917
  # Guide*.
2834
2918
  #
2835
2919
  # You can specify up to 200 properties per asset model. For more
@@ -2844,7 +2928,7 @@ module Aws::IoTSiteWise
2844
2928
  # The updated hierarchy definitions of the asset model. Each hierarchy
2845
2929
  # specifies an asset model whose assets can be children of any other
2846
2930
  # assets created from this asset model. For more information, see [Asset
2847
- # Hierarchies][1] in the *AWS IoT SiteWise User Guide*.
2931
+ # hierarchies][1] in the *AWS IoT SiteWise User Guide*.
2848
2932
  #
2849
2933
  # You can specify up to 10 hierarchies per asset model. For more
2850
2934
  # information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
@@ -2961,7 +3045,7 @@ module Aws::IoTSiteWise
2961
3045
  # The property alias that identifies the property, such as an OPC-UA
2962
3046
  # server data stream path (for example,
2963
3047
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
2964
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
3048
+ # see [Mapping industrial data streams to asset properties][1] in the
2965
3049
  # *AWS IoT SiteWise User Guide*.
2966
3050
  #
2967
3051
  # If you omit this parameter, the alias is removed from the property.
@@ -2974,7 +3058,7 @@ module Aws::IoTSiteWise
2974
3058
  # The MQTT notification state (enabled or disabled) for this asset
2975
3059
  # property. When the notification state is enabled, AWS IoT SiteWise
2976
3060
  # publishes property value updates to a unique MQTT topic. For more
2977
- # information, see [Interacting with Other Services][1] in the *AWS IoT
3061
+ # information, see [Interacting with other services][1] in the *AWS IoT
2978
3062
  # SiteWise User Guide*.
2979
3063
  #
2980
3064
  # If you omit this parameter, the notification state is set to
@@ -3024,7 +3108,7 @@ module Aws::IoTSiteWise
3024
3108
  #
3025
3109
  # @option params [required, String] :dashboard_definition
3026
3110
  # The new dashboard definition, as specified in a JSON literal. For
3027
- # detailed information, see [Creating Dashboards (CLI)][1] in the *AWS
3111
+ # detailed information, see [Creating dashboards (CLI)][1] in the *AWS
3028
3112
  # IoT SiteWise User Guide*.
3029
3113
  #
3030
3114
  #
@@ -3204,7 +3288,7 @@ module Aws::IoTSiteWise
3204
3288
  # @example Response structure
3205
3289
  #
3206
3290
  # resp.portal_status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
3207
- # resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE"
3291
+ # resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
3208
3292
  # resp.portal_status.error.message #=> String
3209
3293
  #
3210
3294
  # @overload update_portal(params = {})
@@ -3264,7 +3348,7 @@ module Aws::IoTSiteWise
3264
3348
  params: params,
3265
3349
  config: config)
3266
3350
  context[:gem_name] = 'aws-sdk-iotsitewise'
3267
- context[:gem_version] = '1.7.0'
3351
+ context[:gem_version] = '1.9.0'
3268
3352
  Seahorse::Client::Request.new(handlers, context)
3269
3353
  end
3270
3354
 
@@ -247,6 +247,7 @@ module Aws::IoTSiteWise
247
247
  Timestamps = Shapes::ListShape.new(name: 'Timestamps')
248
248
  TooManyTagsException = Shapes::StructureShape.new(name: 'TooManyTagsException')
249
249
  Transform = Shapes::StructureShape.new(name: 'Transform')
250
+ TraversalDirection = Shapes::StringShape.new(name: 'TraversalDirection')
250
251
  TumblingWindow = Shapes::StructureShape.new(name: 'TumblingWindow')
251
252
  UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
252
253
  UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
@@ -848,7 +849,8 @@ module Aws::IoTSiteWise
848
849
  ListAssetsResponse.struct_class = Types::ListAssetsResponse
849
850
 
850
851
  ListAssociatedAssetsRequest.add_member(:asset_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "assetId"))
851
- ListAssociatedAssetsRequest.add_member(:hierarchy_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "querystring", location_name: "hierarchyId"))
852
+ ListAssociatedAssetsRequest.add_member(:hierarchy_id, Shapes::ShapeRef.new(shape: ID, location: "querystring", location_name: "hierarchyId"))
853
+ ListAssociatedAssetsRequest.add_member(:traversal_direction, Shapes::ShapeRef.new(shape: TraversalDirection, location: "querystring", location_name: "traversalDirection"))
852
854
  ListAssociatedAssetsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
853
855
  ListAssociatedAssetsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
854
856
  ListAssociatedAssetsRequest.struct_class = Types::ListAssociatedAssetsRequest
@@ -939,6 +941,7 @@ module Aws::IoTSiteWise
939
941
  PortalSummary.add_member(:creation_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationDate"))
940
942
  PortalSummary.add_member(:last_update_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateDate"))
941
943
  PortalSummary.add_member(:role_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "roleArn"))
944
+ PortalSummary.add_member(:status, Shapes::ShapeRef.new(shape: PortalStatus, required: true, location_name: "status"))
942
945
  PortalSummary.struct_class = Types::PortalSummary
943
946
 
944
947
  ProjectResource.add_member(:id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "id"))
@@ -384,7 +384,7 @@ module Aws::IoTSiteWise
384
384
  end
385
385
 
386
386
  # Contains current status information for an asset model. For more
387
- # information, see [Asset and Model States][1] in the *AWS IoT SiteWise
387
+ # information, see [Asset and model states][1] in the *AWS IoT SiteWise
388
388
  # User Guide*.
389
389
  #
390
390
  #
@@ -468,7 +468,7 @@ module Aws::IoTSiteWise
468
468
  # The property alias that identifies the property, such as an OPC-UA
469
469
  # server data stream path (for example,
470
470
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
471
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
471
+ # see [Mapping industrial data streams to asset properties][1] in the
472
472
  # *AWS IoT SiteWise User Guide*.
473
473
  #
474
474
  #
@@ -478,7 +478,7 @@ module Aws::IoTSiteWise
478
478
  #
479
479
  # @!attribute [rw] notification
480
480
  # The asset property's notification topic and state. For more
481
- # information, see [UpdateAssetProperty][1]
481
+ # information, see [UpdateAssetProperty][1].
482
482
  #
483
483
  #
484
484
  #
@@ -544,7 +544,7 @@ module Aws::IoTSiteWise
544
544
  end
545
545
 
546
546
  # Contains information about the current status of an asset. For more
547
- # information, see [Asset and Model States][1] in the *AWS IoT SiteWise
547
+ # information, see [Asset and model states][1] in the *AWS IoT SiteWise
548
548
  # User Guide*.
549
549
  #
550
550
  #
@@ -638,7 +638,7 @@ module Aws::IoTSiteWise
638
638
  # The ID of a hierarchy in the parent asset's model. Hierarchies
639
639
  # allow different groupings of assets to be formed that all come from
640
640
  # the same asset model. For more information, see [Asset
641
- # Hierarchies][1] in the *AWS IoT SiteWise User Guide*.
641
+ # hierarchies][1] in the *AWS IoT SiteWise User Guide*.
642
642
  #
643
643
  #
644
644
  #
@@ -739,7 +739,7 @@ module Aws::IoTSiteWise
739
739
  # The default value of the asset model property attribute. All assets
740
740
  # that you create from the asset model contain this attribute value.
741
741
  # You can update an attribute's value after you create an asset. For
742
- # more information, see [Updating Attribute Values][1] in the *AWS IoT
742
+ # more information, see [Updating attribute values][1] in the *AWS IoT
743
743
  # SiteWise User Guide*.
744
744
  #
745
745
  #
@@ -1123,7 +1123,7 @@ module Aws::IoTSiteWise
1123
1123
  #
1124
1124
  # @!attribute [rw] asset_model_properties
1125
1125
  # The property definitions of the asset model. For more information,
1126
- # see [Asset Properties][1] in the *AWS IoT SiteWise User Guide*.
1126
+ # see [Asset properties][1] in the *AWS IoT SiteWise User Guide*.
1127
1127
  #
1128
1128
  # You can specify up to 200 properties per asset model. For more
1129
1129
  # information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
@@ -1138,7 +1138,7 @@ module Aws::IoTSiteWise
1138
1138
  # The hierarchy definitions of the asset model. Each hierarchy
1139
1139
  # specifies an asset model whose assets can be children of any other
1140
1140
  # assets created from this asset model. For more information, see
1141
- # [Asset Hierarchies][1] in the *AWS IoT SiteWise User Guide*.
1141
+ # [Asset hierarchies][1] in the *AWS IoT SiteWise User Guide*.
1142
1142
  #
1143
1143
  # You can specify up to 10 hierarchies per asset model. For more
1144
1144
  # information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
@@ -1311,7 +1311,7 @@ module Aws::IoTSiteWise
1311
1311
  #
1312
1312
  # @!attribute [rw] dashboard_definition
1313
1313
  # The dashboard definition specified in a JSON literal. For detailed
1314
- # information, see [Creating Dashboards (CLI)][1] in the *AWS IoT
1314
+ # information, see [Creating dashboards (CLI)][1] in the *AWS IoT
1315
1315
  # SiteWise User Guide*.
1316
1316
  #
1317
1317
  #
@@ -2191,7 +2191,7 @@ module Aws::IoTSiteWise
2191
2191
  #
2192
2192
  # @!attribute [rw] dashboard_definition
2193
2193
  # The dashboard's definition JSON literal. For detailed information,
2194
- # see [Creating Dashboards (CLI)][1] in the *AWS IoT SiteWise User
2194
+ # see [Creating dashboards (CLI)][1] in the *AWS IoT SiteWise User
2195
2195
  # Guide*.
2196
2196
  #
2197
2197
  #
@@ -2552,7 +2552,7 @@ module Aws::IoTSiteWise
2552
2552
  # allow different groupings of assets to be formed that all come from
2553
2553
  # the same asset model. You can use the hierarchy ID to identify the
2554
2554
  # correct asset to disassociate. For more information, see [Asset
2555
- # Hierarchies][1] in the *AWS IoT SiteWise User Guide*.
2555
+ # hierarchies][1] in the *AWS IoT SiteWise User Guide*.
2556
2556
  #
2557
2557
  #
2558
2558
  #
@@ -2745,7 +2745,7 @@ module Aws::IoTSiteWise
2745
2745
  # The property alias that identifies the property, such as an OPC-UA
2746
2746
  # server data stream path (for example,
2747
2747
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
2748
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
2748
+ # see [Mapping industrial data streams to asset properties][1] in the
2749
2749
  # *AWS IoT SiteWise User Guide*.
2750
2750
  #
2751
2751
  #
@@ -2777,6 +2777,8 @@ module Aws::IoTSiteWise
2777
2777
  #
2778
2778
  # @!attribute [rw] time_ordering
2779
2779
  # The chronological sorting order of the requested information.
2780
+ #
2781
+ # Default: `ASCENDING`
2780
2782
  # @return [String]
2781
2783
  #
2782
2784
  # @!attribute [rw] next_token
@@ -2785,6 +2787,8 @@ module Aws::IoTSiteWise
2785
2787
  #
2786
2788
  # @!attribute [rw] max_results
2787
2789
  # The maximum number of results to be returned per paginated request.
2790
+ #
2791
+ # Default: 100
2788
2792
  # @return [Integer]
2789
2793
  #
2790
2794
  class GetAssetPropertyAggregatesRequest < Struct.new(
@@ -2846,7 +2850,7 @@ module Aws::IoTSiteWise
2846
2850
  # The property alias that identifies the property, such as an OPC-UA
2847
2851
  # server data stream path (for example,
2848
2852
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
2849
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
2853
+ # see [Mapping industrial data streams to asset properties][1] in the
2850
2854
  # *AWS IoT SiteWise User Guide*.
2851
2855
  #
2852
2856
  #
@@ -2870,6 +2874,8 @@ module Aws::IoTSiteWise
2870
2874
  #
2871
2875
  # @!attribute [rw] time_ordering
2872
2876
  # The chronological sorting order of the requested information.
2877
+ #
2878
+ # Default: `ASCENDING`
2873
2879
  # @return [String]
2874
2880
  #
2875
2881
  # @!attribute [rw] next_token
@@ -2878,6 +2884,8 @@ module Aws::IoTSiteWise
2878
2884
  #
2879
2885
  # @!attribute [rw] max_results
2880
2886
  # The maximum number of results to be returned per paginated request.
2887
+ #
2888
+ # Default: 100
2881
2889
  # @return [Integer]
2882
2890
  #
2883
2891
  class GetAssetPropertyValueHistoryRequest < Struct.new(
@@ -2931,7 +2939,7 @@ module Aws::IoTSiteWise
2931
2939
  # The property alias that identifies the property, such as an OPC-UA
2932
2940
  # server data stream path (for example,
2933
2941
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
2934
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
2942
+ # see [Mapping industrial data streams to asset properties][1] in the
2935
2943
  # *AWS IoT SiteWise User Guide*.
2936
2944
  #
2937
2945
  #
@@ -3214,6 +3222,8 @@ module Aws::IoTSiteWise
3214
3222
  #
3215
3223
  # @!attribute [rw] max_results
3216
3224
  # The maximum number of results to be returned per paginated request.
3225
+ #
3226
+ # Default: 50
3217
3227
  # @return [Integer]
3218
3228
  #
3219
3229
  class ListAccessPoliciesRequest < Struct.new(
@@ -3257,6 +3267,8 @@ module Aws::IoTSiteWise
3257
3267
  #
3258
3268
  # @!attribute [rw] max_results
3259
3269
  # The maximum number of results to be returned per paginated request.
3270
+ #
3271
+ # Default: 50
3260
3272
  # @return [Integer]
3261
3273
  #
3262
3274
  class ListAssetModelsRequest < Struct.new(
@@ -3298,6 +3310,8 @@ module Aws::IoTSiteWise
3298
3310
  #
3299
3311
  # @!attribute [rw] max_results
3300
3312
  # The maximum number of results to be returned per paginated request.
3313
+ #
3314
+ # Default: 50
3301
3315
  # @return [Integer]
3302
3316
  #
3303
3317
  # @!attribute [rw] asset_model_id
@@ -3307,13 +3321,15 @@ module Aws::IoTSiteWise
3307
3321
  #
3308
3322
  # @!attribute [rw] filter
3309
3323
  # The filter for the requested list of assets. Choose one of the
3310
- # following options. Defaults to `ALL`.
3324
+ # following options:
3311
3325
  #
3312
3326
  # * `ALL` – The list includes all assets for a given asset model ID.
3313
3327
  # The `assetModelId` parameter is required if you filter by `ALL`.
3314
3328
  #
3315
3329
  # * `TOP_LEVEL` – The list includes only top-level assets in the asset
3316
3330
  # hierarchy tree.
3331
+ #
3332
+ # Default: `ALL`
3317
3333
  # @return [String]
3318
3334
  #
3319
3335
  class ListAssetsRequest < Struct.new(
@@ -3346,21 +3362,23 @@ module Aws::IoTSiteWise
3346
3362
  #
3347
3363
  # {
3348
3364
  # asset_id: "ID", # required
3349
- # hierarchy_id: "ID", # required
3365
+ # hierarchy_id: "ID",
3366
+ # traversal_direction: "PARENT", # accepts PARENT, CHILD
3350
3367
  # next_token: "NextToken",
3351
3368
  # max_results: 1,
3352
3369
  # }
3353
3370
  #
3354
3371
  # @!attribute [rw] asset_id
3355
- # The ID of the parent asset.
3372
+ # The ID of the asset to query.
3356
3373
  # @return [String]
3357
3374
  #
3358
3375
  # @!attribute [rw] hierarchy_id
3359
- # The hierarchy ID (of the parent asset model) whose associated assets
3360
- # are returned. To find a hierarchy ID, use the [DescribeAsset][1] or
3361
- # [DescribeAssetModel][2] actions.
3376
+ # The ID of the hierarchy by which child assets are associated to the
3377
+ # asset. To find a hierarchy ID, use the [DescribeAsset][1] or
3378
+ # [DescribeAssetModel][2] operations. This parameter is required if
3379
+ # you choose `CHILD` for `traversalDirection`.
3362
3380
  #
3363
- # For more information, see [Asset Hierarchies][3] in the *AWS IoT
3381
+ # For more information, see [Asset hierarchies][3] in the *AWS IoT
3364
3382
  # SiteWise User Guide*.
3365
3383
  #
3366
3384
  #
@@ -3370,17 +3388,33 @@ module Aws::IoTSiteWise
3370
3388
  # [3]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
3371
3389
  # @return [String]
3372
3390
  #
3391
+ # @!attribute [rw] traversal_direction
3392
+ # The direction to list associated assets. Choose one of the following
3393
+ # options:
3394
+ #
3395
+ # * `CHILD` – The list includes all child assets associated to the
3396
+ # asset. The `hierarchyId` parameter is required if you choose
3397
+ # `CHILD`.
3398
+ #
3399
+ # * `PARENT` – The list includes the asset's parent asset.
3400
+ #
3401
+ # Default: `CHILD`
3402
+ # @return [String]
3403
+ #
3373
3404
  # @!attribute [rw] next_token
3374
3405
  # The token to be used for the next set of paginated results.
3375
3406
  # @return [String]
3376
3407
  #
3377
3408
  # @!attribute [rw] max_results
3378
3409
  # The maximum number of results to be returned per paginated request.
3410
+ #
3411
+ # Default: 50
3379
3412
  # @return [Integer]
3380
3413
  #
3381
3414
  class ListAssociatedAssetsRequest < Struct.new(
3382
3415
  :asset_id,
3383
3416
  :hierarchy_id,
3417
+ :traversal_direction,
3384
3418
  :next_token,
3385
3419
  :max_results)
3386
3420
  SENSITIVE = []
@@ -3422,6 +3456,8 @@ module Aws::IoTSiteWise
3422
3456
  #
3423
3457
  # @!attribute [rw] max_results
3424
3458
  # The maximum number of results to be returned per paginated request.
3459
+ #
3460
+ # Default: 50
3425
3461
  # @return [Integer]
3426
3462
  #
3427
3463
  class ListDashboardsRequest < Struct.new(
@@ -3462,6 +3498,8 @@ module Aws::IoTSiteWise
3462
3498
  #
3463
3499
  # @!attribute [rw] max_results
3464
3500
  # The maximum number of results to be returned per paginated request.
3501
+ #
3502
+ # Default: 50
3465
3503
  # @return [Integer]
3466
3504
  #
3467
3505
  class ListGatewaysRequest < Struct.new(
@@ -3501,6 +3539,8 @@ module Aws::IoTSiteWise
3501
3539
  #
3502
3540
  # @!attribute [rw] max_results
3503
3541
  # The maximum number of results to be returned per paginated request.
3542
+ #
3543
+ # Default: 50
3504
3544
  # @return [Integer]
3505
3545
  #
3506
3546
  class ListPortalsRequest < Struct.new(
@@ -3545,6 +3585,8 @@ module Aws::IoTSiteWise
3545
3585
  #
3546
3586
  # @!attribute [rw] max_results
3547
3587
  # The maximum number of results to be returned per paginated request.
3588
+ #
3589
+ # Default: 50
3548
3590
  # @return [Integer]
3549
3591
  #
3550
3592
  class ListProjectAssetsRequest < Struct.new(
@@ -3591,6 +3633,8 @@ module Aws::IoTSiteWise
3591
3633
  #
3592
3634
  # @!attribute [rw] max_results
3593
3635
  # The maximum number of results to be returned per paginated request.
3636
+ #
3637
+ # Default: 50
3594
3638
  # @return [Integer]
3595
3639
  #
3596
3640
  class ListProjectsRequest < Struct.new(
@@ -3869,6 +3913,10 @@ module Aws::IoTSiteWise
3869
3913
  # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html
3870
3914
  # @return [String]
3871
3915
  #
3916
+ # @!attribute [rw] status
3917
+ # Contains information about the current status of a portal.
3918
+ # @return [Types::PortalStatus]
3919
+ #
3872
3920
  class PortalSummary < Struct.new(
3873
3921
  :id,
3874
3922
  :name,
@@ -3876,7 +3924,8 @@ module Aws::IoTSiteWise
3876
3924
  :start_url,
3877
3925
  :creation_date,
3878
3926
  :last_update_date,
3879
- :role_arn)
3927
+ :role_arn,
3928
+ :status)
3880
3929
  SENSITIVE = []
3881
3930
  include Aws::Structure
3882
3931
  end
@@ -3946,7 +3995,7 @@ module Aws::IoTSiteWise
3946
3995
  # The property alias that identifies the property, such as an OPC-UA
3947
3996
  # server data stream path (for example,
3948
3997
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
3949
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
3998
+ # see [Mapping industrial data streams to asset properties][1] in the
3950
3999
  # *AWS IoT SiteWise User Guide*.
3951
4000
  #
3952
4001
  #
@@ -3956,7 +4005,7 @@ module Aws::IoTSiteWise
3956
4005
  #
3957
4006
  # @!attribute [rw] notification
3958
4007
  # The asset property's notification topic and state. For more
3959
- # information, see [UpdateAssetProperty][1]
4008
+ # information, see [UpdateAssetProperty][1].
3960
4009
  #
3961
4010
  #
3962
4011
  #
@@ -3991,7 +4040,7 @@ module Aws::IoTSiteWise
3991
4040
  # Contains asset property value notification information. When the
3992
4041
  # notification state is enabled, AWS IoT SiteWise publishes property
3993
4042
  # value updates to a unique MQTT topic. For more information, see
3994
- # [Interacting with Other Services][1] in the *AWS IoT SiteWise User
4043
+ # [Interacting with other services][1] in the *AWS IoT SiteWise User
3995
4044
  # Guide*.
3996
4045
  #
3997
4046
  #
@@ -4145,7 +4194,7 @@ module Aws::IoTSiteWise
4145
4194
  # The property alias that identifies the property, such as an OPC-UA
4146
4195
  # server data stream path (for example,
4147
4196
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
4148
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
4197
+ # see [Mapping industrial data streams to asset properties][1] in the
4149
4198
  # *AWS IoT SiteWise User Guide*.
4150
4199
  #
4151
4200
  #
@@ -4622,7 +4671,7 @@ module Aws::IoTSiteWise
4622
4671
  #
4623
4672
  # @!attribute [rw] asset_model_properties
4624
4673
  # The updated property definitions of the asset model. For more
4625
- # information, see [Asset Properties][1] in the *AWS IoT SiteWise User
4674
+ # information, see [Asset properties][1] in the *AWS IoT SiteWise User
4626
4675
  # Guide*.
4627
4676
  #
4628
4677
  # You can specify up to 200 properties per asset model. For more
@@ -4638,7 +4687,7 @@ module Aws::IoTSiteWise
4638
4687
  # The updated hierarchy definitions of the asset model. Each hierarchy
4639
4688
  # specifies an asset model whose assets can be children of any other
4640
4689
  # assets created from this asset model. For more information, see
4641
- # [Asset Hierarchies][1] in the *AWS IoT SiteWise User Guide*.
4690
+ # [Asset hierarchies][1] in the *AWS IoT SiteWise User Guide*.
4642
4691
  #
4643
4692
  # You can specify up to 10 hierarchies per asset model. For more
4644
4693
  # information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
@@ -4703,7 +4752,7 @@ module Aws::IoTSiteWise
4703
4752
  # The property alias that identifies the property, such as an OPC-UA
4704
4753
  # server data stream path (for example,
4705
4754
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
4706
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
4755
+ # see [Mapping industrial data streams to asset properties][1] in the
4707
4756
  # *AWS IoT SiteWise User Guide*.
4708
4757
  #
4709
4758
  # If you omit this parameter, the alias is removed from the property.
@@ -4717,7 +4766,7 @@ module Aws::IoTSiteWise
4717
4766
  # The MQTT notification state (enabled or disabled) for this asset
4718
4767
  # property. When the notification state is enabled, AWS IoT SiteWise
4719
4768
  # publishes property value updates to a unique MQTT topic. For more
4720
- # information, see [Interacting with Other Services][1] in the *AWS
4769
+ # information, see [Interacting with other services][1] in the *AWS
4721
4770
  # IoT SiteWise User Guide*.
4722
4771
  #
4723
4772
  # If you omit this parameter, the notification state is set to
@@ -4817,7 +4866,7 @@ module Aws::IoTSiteWise
4817
4866
  #
4818
4867
  # @!attribute [rw] dashboard_definition
4819
4868
  # The new dashboard definition, as specified in a JSON literal. For
4820
- # detailed information, see [Creating Dashboards (CLI)][1] in the *AWS
4869
+ # detailed information, see [Creating dashboards (CLI)][1] in the *AWS
4821
4870
  # IoT SiteWise User Guide*.
4822
4871
  #
4823
4872
  #
@@ -5107,7 +5156,7 @@ module Aws::IoTSiteWise
5107
5156
  # several hierarchies using the same model and therefore the same
5108
5157
  # `propertyId`. For example, you might have separately grouped assets
5109
5158
  # that come from the same asset model. For more information, see
5110
- # [Asset Hierarchies][1] in the *AWS IoT SiteWise User Guide*.
5159
+ # [Asset hierarchies][1] in the *AWS IoT SiteWise User Guide*.
5111
5160
  #
5112
5161
  #
5113
5162
  #
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-iotsitewise
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.7.0
4
+ version: 1.9.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-07-06 00:00:00.000000000 Z
11
+ date: 2020-08-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core