aws-sdk-iotsitewise 1.3.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: 7826dafb616d111f03f07fbf2922e5f329de65a4653b8ac35f7fd4bb729af2ff
4
- data.tar.gz: d26707b7b308d2785558cf23cd3c99690207592c7d2d7d4d0cbf0b280bf9c16a
3
+ metadata.gz: 3413819aa5f83d783a0ca93e2e3b46ccf4f00f34103fd159c3278fb31ed0e321
4
+ data.tar.gz: 3eae5d96f91101a79b444272fcfd97a1d70e52a8cea0023a9264c06641d7ea29
5
5
  SHA512:
6
- metadata.gz: 0b2994a9ae635d6b73a45f247bfa2e066cb52d340d128ae792261f1c464ef7c48ce9c29e956bdf2b575074caf855851b2b9968e3d2ed2db20b36934f86372648
7
- data.tar.gz: dc976383e0095908fe7a7df8a7206b1400a7873f27e4e0f66095b9da8acbf1221d29c1f76e3b30368238933fbee18e7ae45663a8e425e7c88e525efed974fd2f
6
+ metadata.gz: 0f8d94ad11735f1913e3228b02dd0176bb8beef85581b58d2a3162d28d1545ff88e9107cbd68459d562e12e030b8450b1bab04f55bb1ca884e6500e85058618f
7
+ data.tar.gz: 92125b5d90c7033e9339eb437a38a5e10214cdb5b4fd9c01c769a19ccd865de1c7761ad7f55f9d49bad831566b79e7ce1a00b4b2a070b913ecf9cf9d581acbdc
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -43,9 +45,9 @@ require_relative 'aws-sdk-iotsitewise/customizations'
43
45
  #
44
46
  # See {Errors} for more information.
45
47
  #
46
- # @service
48
+ # @!group service
47
49
  module Aws::IoTSiteWise
48
50
 
49
- GEM_VERSION = '1.3.0'
51
+ GEM_VERSION = '1.9.0'
50
52
 
51
53
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
26
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
30
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
31
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
29
32
 
@@ -69,6 +72,7 @@ module Aws::IoTSiteWise
69
72
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
70
73
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
71
74
  add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
72
76
  add_plugin(Aws::Plugins::SignatureV4)
73
77
  add_plugin(Aws::Plugins::Protocols::RestJson)
74
78
 
@@ -81,13 +85,28 @@ module Aws::IoTSiteWise
81
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
82
86
  # credentials.
83
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
+ #
84
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
85
103
  # from an EC2 IMDS on an EC2 instance.
86
104
  #
87
- # * `Aws::SharedCredentials` - Used for loading credentials from a
88
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
89
107
  #
90
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
91
110
  #
92
111
  # When `:credentials` are not configured directly, the following
93
112
  # locations will be searched for credentials:
@@ -97,10 +116,10 @@ module Aws::IoTSiteWise
97
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
98
117
  # * `~/.aws/credentials`
99
118
  # * `~/.aws/config`
100
- # * EC2 IMDS instance profile - When used by default, the timeouts are
101
- # very aggressive. Construct and pass an instance of
102
- # `Aws::InstanceProfileCredentails` to enable retries and extended
103
- # 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.
104
123
  #
105
124
  # @option options [required, String] :region
106
125
  # The AWS region to connect to. The configured `:region` is
@@ -161,7 +180,7 @@ module Aws::IoTSiteWise
161
180
  # @option options [String] :endpoint
162
181
  # The client endpoint is normally constructed from the `:region`
163
182
  # option. You should only configure an `:endpoint` when connecting
164
- # to test endpoints. This should be a valid HTTP(S) URI.
183
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
165
184
  #
166
185
  # @option options [Integer] :endpoint_cache_max_entries (1000)
167
186
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -176,7 +195,7 @@ module Aws::IoTSiteWise
176
195
  # requests fetching endpoints information. Defaults to 60 sec.
177
196
  #
178
197
  # @option options [Boolean] :endpoint_discovery (false)
179
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
198
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
180
199
  #
181
200
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
182
201
  # The log formatter.
@@ -310,7 +329,7 @@ module Aws::IoTSiteWise
310
329
 
311
330
  # Associates a child asset with the given parent asset through a
312
331
  # hierarchy defined in the parent asset's model. For more information,
313
- # see [Associating Assets][1] in the *AWS IoT SiteWise User Guide*.
332
+ # see [Associating assets][1] in the *AWS IoT SiteWise User Guide*.
314
333
  #
315
334
  #
316
335
  #
@@ -322,7 +341,7 @@ module Aws::IoTSiteWise
322
341
  # @option params [required, String] :hierarchy_id
323
342
  # The ID of a hierarchy in the parent asset's model. Hierarchies allow
324
343
  # different groupings of assets to be formed that all come from the same
325
- # asset model. For more information, see [Asset Hierarchies][1] in the
344
+ # asset model. For more information, see [Asset hierarchies][1] in the
326
345
  # *AWS IoT SiteWise User Guide*.
327
346
  #
328
347
  #
@@ -446,7 +465,7 @@ module Aws::IoTSiteWise
446
465
 
447
466
  # Sends a list of asset property values to AWS IoT SiteWise. Each value
448
467
  # is a timestamp-quality-value (TQV) data point. For more information,
449
- # 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
450
469
  # Guide*.
451
470
  #
452
471
  # To identify an asset property, you must specify one of the following:
@@ -468,10 +487,16 @@ module Aws::IoTSiteWise
468
487
  # example, if you store a TQV `\{T1, GOOD, V1\}`, then storing `\{T1,
469
488
  # GOOD, V2\}` replaces the existing TQV.
470
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
+ #
471
495
  #
472
496
  #
473
497
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html
474
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
475
500
  #
476
501
  # @option params [required, Array<Types::PutAssetPropertyValueEntry>] :entries
477
502
  # The list of asset property value entries for the batch put request.
@@ -604,7 +629,7 @@ module Aws::IoTSiteWise
604
629
  end
605
630
 
606
631
  # Creates an asset from an existing asset model. For more information,
607
- # see [Creating Assets][1] in the *AWS IoT SiteWise User Guide*.
632
+ # see [Creating assets][1] in the *AWS IoT SiteWise User Guide*.
608
633
  #
609
634
  #
610
635
  #
@@ -670,7 +695,7 @@ module Aws::IoTSiteWise
670
695
  # you can easily create assets of the same type that have standardized
671
696
  # definitions. Each asset created from a model inherits the asset
672
697
  # model's property and hierarchy definitions. For more information, see
673
- # [Defining Asset Models][1] in the *AWS IoT SiteWise User Guide*.
698
+ # [Defining asset models][1] in the *AWS IoT SiteWise User Guide*.
674
699
  #
675
700
  #
676
701
  #
@@ -684,7 +709,7 @@ module Aws::IoTSiteWise
684
709
  #
685
710
  # @option params [Array<Types::AssetModelPropertyDefinition>] :asset_model_properties
686
711
  # The property definitions of the asset model. For more information, see
687
- # [Asset Properties][1] in the *AWS IoT SiteWise User Guide*.
712
+ # [Asset properties][1] in the *AWS IoT SiteWise User Guide*.
688
713
  #
689
714
  # You can specify up to 200 properties per asset model. For more
690
715
  # information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
@@ -698,7 +723,7 @@ module Aws::IoTSiteWise
698
723
  # The hierarchy definitions of the asset model. Each hierarchy specifies
699
724
  # an asset model whose assets can be children of any other assets
700
725
  # created from this asset model. For more information, see [Asset
701
- # Hierarchies][1] in the *AWS IoT SiteWise User Guide*.
726
+ # hierarchies][1] in the *AWS IoT SiteWise User Guide*.
702
727
  #
703
728
  # You can specify up to 10 hierarchies per asset model. For more
704
729
  # information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
@@ -819,7 +844,7 @@ module Aws::IoTSiteWise
819
844
  #
820
845
  # @option params [required, String] :dashboard_definition
821
846
  # The dashboard definition specified in a JSON literal. For detailed
822
- # information, see [Creating Dashboards (CLI)][1] in the *AWS IoT
847
+ # information, see [Creating dashboards (CLI)][1] in the *AWS IoT
823
848
  # SiteWise User Guide*.
824
849
  #
825
850
  #
@@ -930,14 +955,14 @@ module Aws::IoTSiteWise
930
955
  end
931
956
 
932
957
  # Creates a portal, which can contain projects and dashboards. Before
933
- # you can create a portal, you must configure AWS Single Sign-On in the
934
- # current Region. AWS IoT SiteWise Monitor uses AWS SSO to manage user
935
- # permissions. For more information, see [Enabling AWS SSO][1] in the
936
- # *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*.
937
962
  #
938
963
  # <note markdown="1"> Before you can sign in to a new portal, you must add at least one AWS
939
964
  # SSO user or group to that portal. For more information, see [Adding or
940
- # Removing Portal Administrators][2] in the *AWS IoT SiteWise User
965
+ # removing portal administrators][2] in the *AWS IoT SiteWise User
941
966
  # Guide*.
942
967
  #
943
968
  # </note>
@@ -1019,7 +1044,7 @@ module Aws::IoTSiteWise
1019
1044
  # resp.portal_arn #=> String
1020
1045
  # resp.portal_start_url #=> String
1021
1046
  # resp.portal_status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
1022
- # 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"
1023
1048
  # resp.portal_status.error.message #=> String
1024
1049
  # resp.sso_application_id #=> String
1025
1050
  #
@@ -1120,7 +1145,7 @@ module Aws::IoTSiteWise
1120
1145
  end
1121
1146
 
1122
1147
  # Deletes an asset. This action can't be undone. For more information,
1123
- # 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
1124
1149
  # Guide*.
1125
1150
  #
1126
1151
  # <note markdown="1"> You can't delete an asset that's associated to another asset. For
@@ -1173,7 +1198,7 @@ module Aws::IoTSiteWise
1173
1198
  # model. Also, you can't delete an asset model if a parent asset model
1174
1199
  # exists that contains a property formula expression that depends on the
1175
1200
  # asset model that you want to delete. For more information, see
1176
- # [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*.
1177
1202
  #
1178
1203
  #
1179
1204
  #
@@ -1297,7 +1322,7 @@ module Aws::IoTSiteWise
1297
1322
  # @example Response structure
1298
1323
  #
1299
1324
  # resp.portal_status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
1300
- # 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"
1301
1326
  # resp.portal_status.error.message #=> String
1302
1327
  #
1303
1328
  # @overload delete_portal(params = {})
@@ -1505,7 +1530,21 @@ module Aws::IoTSiteWise
1505
1530
  req.send_request(options)
1506
1531
  end
1507
1532
 
1508
- # 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
1509
1548
  #
1510
1549
  # @option params [required, String] :asset_id
1511
1550
  # The ID of the asset.
@@ -1742,7 +1781,7 @@ module Aws::IoTSiteWise
1742
1781
  # resp.portal_start_url #=> String
1743
1782
  # resp.portal_contact_email #=> String
1744
1783
  # resp.portal_status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
1745
- # 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"
1746
1785
  # resp.portal_status.error.message #=> String
1747
1786
  # resp.portal_creation_date #=> Time
1748
1787
  # resp.portal_last_update_date #=> Time
@@ -1812,7 +1851,7 @@ module Aws::IoTSiteWise
1812
1851
  # different groupings of assets to be formed that all come from the same
1813
1852
  # asset model. You can use the hierarchy ID to identify the correct
1814
1853
  # asset to disassociate. For more information, see [Asset
1815
- # Hierarchies][1] in the *AWS IoT SiteWise User Guide*.
1854
+ # hierarchies][1] in the *AWS IoT SiteWise User Guide*.
1816
1855
  #
1817
1856
  #
1818
1857
  #
@@ -1848,8 +1887,7 @@ module Aws::IoTSiteWise
1848
1887
  end
1849
1888
 
1850
1889
  # Gets aggregated values for an asset property. For more information,
1851
- # see [Querying Aggregated Property Values][1] in the *AWS IoT SiteWise
1852
- # User Guide*.
1890
+ # see [Querying aggregates][1] in the *AWS IoT SiteWise User Guide*.
1853
1891
  #
1854
1892
  # To identify an asset property, you must specify one of the following:
1855
1893
  #
@@ -1874,7 +1912,7 @@ module Aws::IoTSiteWise
1874
1912
  # The property alias that identifies the property, such as an OPC-UA
1875
1913
  # server data stream path (for example,
1876
1914
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
1877
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
1915
+ # see [Mapping industrial data streams to asset properties][1] in the
1878
1916
  # *AWS IoT SiteWise User Guide*.
1879
1917
  #
1880
1918
  #
@@ -1901,12 +1939,16 @@ module Aws::IoTSiteWise
1901
1939
  # @option params [String] :time_ordering
1902
1940
  # The chronological sorting order of the requested information.
1903
1941
  #
1942
+ # Default: `ASCENDING`
1943
+ #
1904
1944
  # @option params [String] :next_token
1905
1945
  # The token to be used for the next set of paginated results.
1906
1946
  #
1907
1947
  # @option params [Integer] :max_results
1908
1948
  # The maximum number of results to be returned per paginated request.
1909
1949
  #
1950
+ # Default: 100
1951
+ #
1910
1952
  # @return [Types::GetAssetPropertyAggregatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1911
1953
  #
1912
1954
  # * {Types::GetAssetPropertyAggregatesResponse#aggregated_values #aggregated_values} => Array&lt;Types::AggregatedValue&gt;
@@ -1951,8 +1993,7 @@ module Aws::IoTSiteWise
1951
1993
  end
1952
1994
 
1953
1995
  # Gets an asset property's current value. For more information, see
1954
- # [Querying Current Property Values][1] in the *AWS IoT SiteWise User
1955
- # Guide*.
1996
+ # [Querying current values][1] in the *AWS IoT SiteWise User Guide*.
1956
1997
  #
1957
1998
  # To identify an asset property, you must specify one of the following:
1958
1999
  #
@@ -1977,7 +2018,7 @@ module Aws::IoTSiteWise
1977
2018
  # The property alias that identifies the property, such as an OPC-UA
1978
2019
  # server data stream path (for example,
1979
2020
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
1980
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
2021
+ # see [Mapping industrial data streams to asset properties][1] in the
1981
2022
  # *AWS IoT SiteWise User Guide*.
1982
2023
  #
1983
2024
  #
@@ -2014,8 +2055,8 @@ module Aws::IoTSiteWise
2014
2055
  end
2015
2056
 
2016
2057
  # Gets the history of an asset property's values. For more information,
2017
- # see [Querying Historical Property Values][1] in the *AWS IoT SiteWise
2018
- # User Guide*.
2058
+ # see [Querying historical values][1] in the *AWS IoT SiteWise User
2059
+ # Guide*.
2019
2060
  #
2020
2061
  # To identify an asset property, you must specify one of the following:
2021
2062
  #
@@ -2040,18 +2081,18 @@ module Aws::IoTSiteWise
2040
2081
  # The property alias that identifies the property, such as an OPC-UA
2041
2082
  # server data stream path (for example,
2042
2083
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
2043
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
2084
+ # see [Mapping industrial data streams to asset properties][1] in the
2044
2085
  # *AWS IoT SiteWise User Guide*.
2045
2086
  #
2046
2087
  #
2047
2088
  #
2048
2089
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
2049
2090
  #
2050
- # @option params [required, Time,DateTime,Date,Integer,String] :start_date
2091
+ # @option params [Time,DateTime,Date,Integer,String] :start_date
2051
2092
  # The exclusive start of the range from which to query historical data,
2052
2093
  # expressed in seconds in Unix epoch time.
2053
2094
  #
2054
- # @option params [required, Time,DateTime,Date,Integer,String] :end_date
2095
+ # @option params [Time,DateTime,Date,Integer,String] :end_date
2055
2096
  # The inclusive end of the range from which to query historical data,
2056
2097
  # expressed in seconds in Unix epoch time.
2057
2098
  #
@@ -2061,12 +2102,16 @@ module Aws::IoTSiteWise
2061
2102
  # @option params [String] :time_ordering
2062
2103
  # The chronological sorting order of the requested information.
2063
2104
  #
2105
+ # Default: `ASCENDING`
2106
+ #
2064
2107
  # @option params [String] :next_token
2065
2108
  # The token to be used for the next set of paginated results.
2066
2109
  #
2067
2110
  # @option params [Integer] :max_results
2068
2111
  # The maximum number of results to be returned per paginated request.
2069
2112
  #
2113
+ # Default: 100
2114
+ #
2070
2115
  # @return [Types::GetAssetPropertyValueHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2071
2116
  #
2072
2117
  # * {Types::GetAssetPropertyValueHistoryResponse#asset_property_value_history #asset_property_value_history} => Array&lt;Types::AssetPropertyValue&gt;
@@ -2080,8 +2125,8 @@ module Aws::IoTSiteWise
2080
2125
  # asset_id: "ID",
2081
2126
  # property_id: "ID",
2082
2127
  # property_alias: "AssetPropertyAlias",
2083
- # start_date: Time.now, # required
2084
- # end_date: Time.now, # required
2128
+ # start_date: Time.now,
2129
+ # end_date: Time.now,
2085
2130
  # qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
2086
2131
  # time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
2087
2132
  # next_token: "NextToken",
@@ -2133,6 +2178,8 @@ module Aws::IoTSiteWise
2133
2178
  # @option params [Integer] :max_results
2134
2179
  # The maximum number of results to be returned per paginated request.
2135
2180
  #
2181
+ # Default: 50
2182
+ #
2136
2183
  # @return [Types::ListAccessPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2137
2184
  #
2138
2185
  # * {Types::ListAccessPoliciesResponse#access_policy_summaries #access_policy_summaries} => Array&lt;Types::AccessPolicySummary&gt;
@@ -2179,6 +2226,8 @@ module Aws::IoTSiteWise
2179
2226
  # @option params [Integer] :max_results
2180
2227
  # The maximum number of results to be returned per paginated request.
2181
2228
  #
2229
+ # Default: 50
2230
+ #
2182
2231
  # @return [Types::ListAssetModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2183
2232
  #
2184
2233
  # * {Types::ListAssetModelsResponse#asset_model_summaries #asset_model_summaries} => Array&lt;Types::AssetModelSummary&gt;
@@ -2237,13 +2286,15 @@ module Aws::IoTSiteWise
2237
2286
  # @option params [Integer] :max_results
2238
2287
  # The maximum number of results to be returned per paginated request.
2239
2288
  #
2289
+ # Default: 50
2290
+ #
2240
2291
  # @option params [String] :asset_model_id
2241
2292
  # The ID of the asset model by which to filter the list of assets. This
2242
2293
  # parameter is required if you choose `ALL` for `filter`.
2243
2294
  #
2244
2295
  # @option params [String] :filter
2245
2296
  # The filter for the requested list of assets. Choose one of the
2246
- # following options. Defaults to `ALL`.
2297
+ # following options:
2247
2298
  #
2248
2299
  # * `ALL` – The list includes all assets for a given asset model ID. The
2249
2300
  # `assetModelId` parameter is required if you filter by `ALL`.
@@ -2251,6 +2302,8 @@ module Aws::IoTSiteWise
2251
2302
  # * `TOP_LEVEL` – The list includes only top-level assets in the asset
2252
2303
  # hierarchy tree.
2253
2304
  #
2305
+ # Default: `ALL`
2306
+ #
2254
2307
  # @return [Types::ListAssetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2255
2308
  #
2256
2309
  # * {Types::ListAssetsResponse#asset_summaries #asset_summaries} => Array&lt;Types::AssetSummary&gt;
@@ -2291,18 +2344,25 @@ module Aws::IoTSiteWise
2291
2344
  req.send_request(options)
2292
2345
  end
2293
2346
 
2294
- # Retrieves a paginated list of the assets associated to a parent asset
2295
- # (`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.
2296
2355
  #
2297
2356
  # @option params [required, String] :asset_id
2298
- # The ID of the parent asset.
2357
+ # The ID of the asset to query.
2299
2358
  #
2300
- # @option params [required, String] :hierarchy_id
2301
- # The hierarchy ID (of the parent asset model) whose associated assets
2302
- # are returned. To find a hierarchy ID, use the [DescribeAsset][1] or
2303
- # [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`.
2304
2364
  #
2305
- # For more information, see [Asset Hierarchies][3] in the *AWS IoT
2365
+ # For more information, see [Asset hierarchies][3] in the *AWS IoT
2306
2366
  # SiteWise User Guide*.
2307
2367
  #
2308
2368
  #
@@ -2311,12 +2371,26 @@ module Aws::IoTSiteWise
2311
2371
  # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html
2312
2372
  # [3]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
2313
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
+ #
2314
2386
  # @option params [String] :next_token
2315
2387
  # The token to be used for the next set of paginated results.
2316
2388
  #
2317
2389
  # @option params [Integer] :max_results
2318
2390
  # The maximum number of results to be returned per paginated request.
2319
2391
  #
2392
+ # Default: 50
2393
+ #
2320
2394
  # @return [Types::ListAssociatedAssetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2321
2395
  #
2322
2396
  # * {Types::ListAssociatedAssetsResponse#asset_summaries #asset_summaries} => Array&lt;Types::AssociatedAssetsSummary&gt;
@@ -2328,7 +2402,8 @@ module Aws::IoTSiteWise
2328
2402
  #
2329
2403
  # resp = client.list_associated_assets({
2330
2404
  # asset_id: "ID", # required
2331
- # hierarchy_id: "ID", # required
2405
+ # hierarchy_id: "ID",
2406
+ # traversal_direction: "PARENT", # accepts PARENT, CHILD
2332
2407
  # next_token: "NextToken",
2333
2408
  # max_results: 1,
2334
2409
  # })
@@ -2369,6 +2444,8 @@ module Aws::IoTSiteWise
2369
2444
  # @option params [Integer] :max_results
2370
2445
  # The maximum number of results to be returned per paginated request.
2371
2446
  #
2447
+ # Default: 50
2448
+ #
2372
2449
  # @return [Types::ListDashboardsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2373
2450
  #
2374
2451
  # * {Types::ListDashboardsResponse#dashboard_summaries #dashboard_summaries} => Array&lt;Types::DashboardSummary&gt;
@@ -2409,6 +2486,8 @@ module Aws::IoTSiteWise
2409
2486
  # @option params [Integer] :max_results
2410
2487
  # The maximum number of results to be returned per paginated request.
2411
2488
  #
2489
+ # Default: 50
2490
+ #
2412
2491
  # @return [Types::ListGatewaysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2413
2492
  #
2414
2493
  # * {Types::ListGatewaysResponse#gateway_summaries #gateway_summaries} => Array&lt;Types::GatewaySummary&gt;
@@ -2450,6 +2529,8 @@ module Aws::IoTSiteWise
2450
2529
  # @option params [Integer] :max_results
2451
2530
  # The maximum number of results to be returned per paginated request.
2452
2531
  #
2532
+ # Default: 50
2533
+ #
2453
2534
  # @return [Types::ListPortalsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2454
2535
  #
2455
2536
  # * {Types::ListPortalsResponse#portal_summaries #portal_summaries} => Array&lt;Types::PortalSummary&gt;
@@ -2474,6 +2555,9 @@ module Aws::IoTSiteWise
2474
2555
  # resp.portal_summaries[0].creation_date #=> Time
2475
2556
  # resp.portal_summaries[0].last_update_date #=> Time
2476
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
2477
2561
  # resp.next_token #=> String
2478
2562
  #
2479
2563
  # @overload list_portals(params = {})
@@ -2495,6 +2579,8 @@ module Aws::IoTSiteWise
2495
2579
  # @option params [Integer] :max_results
2496
2580
  # The maximum number of results to be returned per paginated request.
2497
2581
  #
2582
+ # Default: 50
2583
+ #
2498
2584
  # @return [Types::ListProjectAssetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2499
2585
  #
2500
2586
  # * {Types::ListProjectAssetsResponse#asset_ids #asset_ids} => Array&lt;String&gt;
@@ -2535,6 +2621,8 @@ module Aws::IoTSiteWise
2535
2621
  # @option params [Integer] :max_results
2536
2622
  # The maximum number of results to be returned per paginated request.
2537
2623
  #
2624
+ # Default: 50
2625
+ #
2538
2626
  # @return [Types::ListProjectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2539
2627
  #
2540
2628
  # * {Types::ListProjectsResponse#project_summaries #project_summaries} => Array&lt;Types::ProjectSummary&gt;
@@ -2745,8 +2833,8 @@ module Aws::IoTSiteWise
2745
2833
  req.send_request(options)
2746
2834
  end
2747
2835
 
2748
- # Updates an asset's name. For more information, see [Updating Assets
2749
- # 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*.
2750
2838
  #
2751
2839
  #
2752
2840
  #
@@ -2794,7 +2882,7 @@ module Aws::IoTSiteWise
2794
2882
  # Updates an asset model and all of the assets that were created from
2795
2883
  # the model. Each asset created from the model inherits the updated
2796
2884
  # asset model's property and hierarchy definitions. For more
2797
- # information, see [Updating Assets and Models][1] in the *AWS IoT
2885
+ # information, see [Updating assets and models][1] in the *AWS IoT
2798
2886
  # SiteWise User Guide*.
2799
2887
  #
2800
2888
  # This operation overwrites the existing model with the provided model.
@@ -2825,7 +2913,7 @@ module Aws::IoTSiteWise
2825
2913
  #
2826
2914
  # @option params [Array<Types::AssetModelProperty>] :asset_model_properties
2827
2915
  # The updated property definitions of the asset model. For more
2828
- # information, see [Asset Properties][1] in the *AWS IoT SiteWise User
2916
+ # information, see [Asset properties][1] in the *AWS IoT SiteWise User
2829
2917
  # Guide*.
2830
2918
  #
2831
2919
  # You can specify up to 200 properties per asset model. For more
@@ -2840,7 +2928,7 @@ module Aws::IoTSiteWise
2840
2928
  # The updated hierarchy definitions of the asset model. Each hierarchy
2841
2929
  # specifies an asset model whose assets can be children of any other
2842
2930
  # assets created from this asset model. For more information, see [Asset
2843
- # Hierarchies][1] in the *AWS IoT SiteWise User Guide*.
2931
+ # hierarchies][1] in the *AWS IoT SiteWise User Guide*.
2844
2932
  #
2845
2933
  # You can specify up to 10 hierarchies per asset model. For more
2846
2934
  # information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
@@ -2957,7 +3045,7 @@ module Aws::IoTSiteWise
2957
3045
  # The property alias that identifies the property, such as an OPC-UA
2958
3046
  # server data stream path (for example,
2959
3047
  # `/company/windfarm/3/turbine/7/temperature`). For more information,
2960
- # see [Mapping Industrial Data Streams to Asset Properties][1] in the
3048
+ # see [Mapping industrial data streams to asset properties][1] in the
2961
3049
  # *AWS IoT SiteWise User Guide*.
2962
3050
  #
2963
3051
  # If you omit this parameter, the alias is removed from the property.
@@ -2970,7 +3058,7 @@ module Aws::IoTSiteWise
2970
3058
  # The MQTT notification state (enabled or disabled) for this asset
2971
3059
  # property. When the notification state is enabled, AWS IoT SiteWise
2972
3060
  # publishes property value updates to a unique MQTT topic. For more
2973
- # information, see [Interacting with Other Services][1] in the *AWS IoT
3061
+ # information, see [Interacting with other services][1] in the *AWS IoT
2974
3062
  # SiteWise User Guide*.
2975
3063
  #
2976
3064
  # If you omit this parameter, the notification state is set to
@@ -3020,7 +3108,7 @@ module Aws::IoTSiteWise
3020
3108
  #
3021
3109
  # @option params [required, String] :dashboard_definition
3022
3110
  # The new dashboard definition, as specified in a JSON literal. For
3023
- # detailed information, see [Creating Dashboards (CLI)][1] in the *AWS
3111
+ # detailed information, see [Creating dashboards (CLI)][1] in the *AWS
3024
3112
  # IoT SiteWise User Guide*.
3025
3113
  #
3026
3114
  #
@@ -3200,7 +3288,7 @@ module Aws::IoTSiteWise
3200
3288
  # @example Response structure
3201
3289
  #
3202
3290
  # resp.portal_status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
3203
- # 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"
3204
3292
  # resp.portal_status.error.message #=> String
3205
3293
  #
3206
3294
  # @overload update_portal(params = {})
@@ -3260,7 +3348,7 @@ module Aws::IoTSiteWise
3260
3348
  params: params,
3261
3349
  config: config)
3262
3350
  context[:gem_name] = 'aws-sdk-iotsitewise'
3263
- context[:gem_version] = '1.3.0'
3351
+ context[:gem_version] = '1.9.0'
3264
3352
  Seahorse::Client::Request.new(handlers, context)
3265
3353
  end
3266
3354