aws-sdk-iotsitewise 1.87.0 → 1.89.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 +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +752 -93
- data/lib/aws-sdk-iotsitewise/client_api.rb +489 -19
- data/lib/aws-sdk-iotsitewise/types.rb +1206 -185
- data/lib/aws-sdk-iotsitewise.rb +1 -1
- data/sig/client.rbs +221 -11
- data/sig/resource.rbs +1 -0
- data/sig/types.rbs +295 -12
- metadata +3 -3
@@ -97,7 +97,7 @@ module Aws::IoTSiteWise
|
|
97
97
|
# class name or an instance of a plugin class.
|
98
98
|
#
|
99
99
|
# @option options [required, Aws::CredentialProvider] :credentials
|
100
|
-
# Your AWS credentials. This can be an instance of any one of the
|
100
|
+
# Your AWS credentials used for authentication. This can be an instance of any one of the
|
101
101
|
# following classes:
|
102
102
|
#
|
103
103
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
@@ -130,18 +130,23 @@ module Aws::IoTSiteWise
|
|
130
130
|
# locations will be searched for credentials:
|
131
131
|
#
|
132
132
|
# * `Aws.config[:credentials]`
|
133
|
+
#
|
133
134
|
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
134
135
|
# `:account_id` options.
|
135
|
-
#
|
136
|
-
#
|
136
|
+
#
|
137
|
+
# * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
|
138
|
+
# `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
|
139
|
+
#
|
137
140
|
# * `~/.aws/credentials`
|
141
|
+
#
|
138
142
|
# * `~/.aws/config`
|
143
|
+
#
|
139
144
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
140
145
|
# are very aggressive. Construct and pass an instance of
|
141
146
|
# `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
142
147
|
# enable retries and extended timeouts. Instance profile credential
|
143
|
-
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
144
|
-
# to true
|
148
|
+
# fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
|
149
|
+
# to `true`.
|
145
150
|
#
|
146
151
|
# @option options [required, String] :region
|
147
152
|
# The AWS region to connect to. The configured `:region` is
|
@@ -169,6 +174,11 @@ module Aws::IoTSiteWise
|
|
169
174
|
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
170
175
|
# not retry instead of sleeping.
|
171
176
|
#
|
177
|
+
# @option options [Array<String>] :auth_scheme_preference
|
178
|
+
# A list of preferred authentication schemes to use when making a request. Supported values are:
|
179
|
+
# `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
|
180
|
+
# shared config as `auth_scheme_preference`, the value should be a comma-separated list.
|
181
|
+
#
|
172
182
|
# @option options [Boolean] :client_side_monitoring (false)
|
173
183
|
# When `true`, client-side metrics will be collected for all API requests from
|
174
184
|
# this client.
|
@@ -264,8 +274,8 @@ module Aws::IoTSiteWise
|
|
264
274
|
# When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
|
265
275
|
#
|
266
276
|
# @option options [String] :profile ("default")
|
267
|
-
# Used when loading credentials from the shared credentials file
|
268
|
-
#
|
277
|
+
# Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
|
278
|
+
# When not specified, 'default' is used.
|
269
279
|
#
|
270
280
|
# @option options [String] :request_checksum_calculation ("when_supported")
|
271
281
|
# Determines when a checksum will be calculated for request payloads. Values are:
|
@@ -378,7 +388,7 @@ module Aws::IoTSiteWise
|
|
378
388
|
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
379
389
|
#
|
380
390
|
# @option options [Aws::TokenProvider] :token_provider
|
381
|
-
#
|
391
|
+
# Your Bearer token used for authentication. This can be an instance of any one of the
|
382
392
|
# following classes:
|
383
393
|
#
|
384
394
|
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
@@ -1122,6 +1132,22 @@ module Aws::IoTSiteWise
|
|
1122
1132
|
#
|
1123
1133
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
1124
1134
|
#
|
1135
|
+
# @option params [String] :asset_id
|
1136
|
+
# The ID to assign to the asset, if desired. IoT SiteWise automatically
|
1137
|
+
# generates a unique ID for you, so this parameter is never required.
|
1138
|
+
# However, if you prefer to supply your own ID instead, you can specify
|
1139
|
+
# it here in UUID format. If you specify your own ID, it must be
|
1140
|
+
# globally unique.
|
1141
|
+
#
|
1142
|
+
# @option params [String] :asset_external_id
|
1143
|
+
# An external ID to assign to the asset. The external ID must be unique
|
1144
|
+
# within your Amazon Web Services account. For more information, see
|
1145
|
+
# [Using external IDs][1] in the *IoT SiteWise User Guide*.
|
1146
|
+
#
|
1147
|
+
#
|
1148
|
+
#
|
1149
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1150
|
+
#
|
1125
1151
|
# @option params [String] :client_token
|
1126
1152
|
# A unique case-sensitive identifier that you can provide to ensure the
|
1127
1153
|
# idempotency of the request. Don't reuse this client token if a new
|
@@ -1142,22 +1168,6 @@ module Aws::IoTSiteWise
|
|
1142
1168
|
# @option params [String] :asset_description
|
1143
1169
|
# A description for the asset.
|
1144
1170
|
#
|
1145
|
-
# @option params [String] :asset_id
|
1146
|
-
# The ID to assign to the asset, if desired. IoT SiteWise automatically
|
1147
|
-
# generates a unique ID for you, so this parameter is never required.
|
1148
|
-
# However, if you prefer to supply your own ID instead, you can specify
|
1149
|
-
# it here in UUID format. If you specify your own ID, it must be
|
1150
|
-
# globally unique.
|
1151
|
-
#
|
1152
|
-
# @option params [String] :asset_external_id
|
1153
|
-
# An external ID to assign to the asset. The external ID must be unique
|
1154
|
-
# within your Amazon Web Services account. For more information, see
|
1155
|
-
# [Using external IDs][1] in the *IoT SiteWise User Guide*.
|
1156
|
-
#
|
1157
|
-
#
|
1158
|
-
#
|
1159
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1160
|
-
#
|
1161
1171
|
# @return [Types::CreateAssetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1162
1172
|
#
|
1163
1173
|
# * {Types::CreateAssetResponse#asset_id #asset_id} => String
|
@@ -1169,13 +1179,13 @@ module Aws::IoTSiteWise
|
|
1169
1179
|
# resp = client.create_asset({
|
1170
1180
|
# asset_name: "Name", # required
|
1171
1181
|
# asset_model_id: "CustomID", # required
|
1182
|
+
# asset_id: "ID",
|
1183
|
+
# asset_external_id: "ExternalId",
|
1172
1184
|
# client_token: "ClientToken",
|
1173
1185
|
# tags: {
|
1174
1186
|
# "TagKey" => "TagValue",
|
1175
1187
|
# },
|
1176
1188
|
# asset_description: "Description",
|
1177
|
-
# asset_id: "ID",
|
1178
|
-
# asset_external_id: "ExternalId",
|
1179
1189
|
# })
|
1180
1190
|
#
|
1181
1191
|
# @example Response structure
|
@@ -1745,9 +1755,17 @@ module Aws::IoTSiteWise
|
|
1745
1755
|
# tier or IoT SiteWise cold tier. For more information about how to
|
1746
1756
|
# configure storage settings, see [PutStorageConfiguration][2].
|
1747
1757
|
#
|
1748
|
-
# Bulk import is designed to store historical data to IoT SiteWise.
|
1749
|
-
#
|
1750
|
-
#
|
1758
|
+
# Bulk import is designed to store historical data to IoT SiteWise.
|
1759
|
+
#
|
1760
|
+
# * Newly ingested data in the hot tier triggers notifications and
|
1761
|
+
# computations.
|
1762
|
+
#
|
1763
|
+
# * After data moves from the hot tier to the warm or cold tier based on
|
1764
|
+
# retention settings, it does not trigger computations or
|
1765
|
+
# notifications.
|
1766
|
+
#
|
1767
|
+
# * Data older than 7 days does not trigger computations or
|
1768
|
+
# notifications.
|
1751
1769
|
#
|
1752
1770
|
#
|
1753
1771
|
#
|
@@ -1833,6 +1851,97 @@ module Aws::IoTSiteWise
|
|
1833
1851
|
req.send_request(options)
|
1834
1852
|
end
|
1835
1853
|
|
1854
|
+
# Create a computation model with a configuration and data binding.
|
1855
|
+
#
|
1856
|
+
# @option params [required, String] :computation_model_name
|
1857
|
+
# The name of the computation model.
|
1858
|
+
#
|
1859
|
+
# @option params [String] :computation_model_description
|
1860
|
+
# The description of the computation model.
|
1861
|
+
#
|
1862
|
+
# @option params [required, Types::ComputationModelConfiguration] :computation_model_configuration
|
1863
|
+
# The configuration for the computation model.
|
1864
|
+
#
|
1865
|
+
# @option params [required, Hash<String,Types::ComputationModelDataBindingValue>] :computation_model_data_binding
|
1866
|
+
# The data binding for the computation model. Key is a variable name
|
1867
|
+
# defined in configuration. Value is a
|
1868
|
+
# `ComputationModelDataBindingValue` referenced by the variable.
|
1869
|
+
#
|
1870
|
+
# @option params [String] :client_token
|
1871
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
1872
|
+
# idempotency of the request. Don't reuse this client token if a new
|
1873
|
+
# idempotent request is required.
|
1874
|
+
#
|
1875
|
+
# **A suitable default value is auto-generated.** You should normally
|
1876
|
+
# not need to pass this option.**
|
1877
|
+
#
|
1878
|
+
# @option params [Hash<String,String>] :tags
|
1879
|
+
# A list of key-value pairs that contain metadata for the asset. For
|
1880
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
1881
|
+
# *IoT SiteWise User Guide*.
|
1882
|
+
#
|
1883
|
+
#
|
1884
|
+
#
|
1885
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
|
1886
|
+
#
|
1887
|
+
# @return [Types::CreateComputationModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1888
|
+
#
|
1889
|
+
# * {Types::CreateComputationModelResponse#computation_model_id #computation_model_id} => String
|
1890
|
+
# * {Types::CreateComputationModelResponse#computation_model_arn #computation_model_arn} => String
|
1891
|
+
# * {Types::CreateComputationModelResponse#computation_model_status #computation_model_status} => Types::ComputationModelStatus
|
1892
|
+
#
|
1893
|
+
# @example Request syntax with placeholder values
|
1894
|
+
#
|
1895
|
+
# resp = client.create_computation_model({
|
1896
|
+
# computation_model_name: "RestrictedName", # required
|
1897
|
+
# computation_model_description: "RestrictedDescription",
|
1898
|
+
# computation_model_configuration: { # required
|
1899
|
+
# anomaly_detection: {
|
1900
|
+
# input_properties: "InputProperties", # required
|
1901
|
+
# result_property: "ResultProperty", # required
|
1902
|
+
# },
|
1903
|
+
# },
|
1904
|
+
# computation_model_data_binding: { # required
|
1905
|
+
# "ComputationModelDataBindingVariable" => {
|
1906
|
+
# asset_model_property: {
|
1907
|
+
# asset_model_id: "ID", # required
|
1908
|
+
# property_id: "ID", # required
|
1909
|
+
# },
|
1910
|
+
# asset_property: {
|
1911
|
+
# asset_id: "ID", # required
|
1912
|
+
# property_id: "ID", # required
|
1913
|
+
# },
|
1914
|
+
# list: [
|
1915
|
+
# {
|
1916
|
+
# # recursive ComputationModelDataBindingValue
|
1917
|
+
# },
|
1918
|
+
# ],
|
1919
|
+
# },
|
1920
|
+
# },
|
1921
|
+
# client_token: "ClientToken",
|
1922
|
+
# tags: {
|
1923
|
+
# "TagKey" => "TagValue",
|
1924
|
+
# },
|
1925
|
+
# })
|
1926
|
+
#
|
1927
|
+
# @example Response structure
|
1928
|
+
#
|
1929
|
+
# resp.computation_model_id #=> String
|
1930
|
+
# resp.computation_model_arn #=> String
|
1931
|
+
# resp.computation_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
1932
|
+
# resp.computation_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
1933
|
+
# resp.computation_model_status.error.message #=> String
|
1934
|
+
# resp.computation_model_status.error.details #=> Array
|
1935
|
+
# resp.computation_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
1936
|
+
# resp.computation_model_status.error.details[0].message #=> String
|
1937
|
+
#
|
1938
|
+
# @overload create_computation_model(params = {})
|
1939
|
+
# @param [Hash] params ({})
|
1940
|
+
def create_computation_model(params = {}, options = {})
|
1941
|
+
req = build_request(:create_computation_model, params)
|
1942
|
+
req.send_request(options)
|
1943
|
+
end
|
1944
|
+
|
1836
1945
|
# Creates a dashboard in an IoT SiteWise Monitor project.
|
1837
1946
|
#
|
1838
1947
|
# @option params [required, String] :project_id
|
@@ -2000,18 +2109,24 @@ module Aws::IoTSiteWise
|
|
2000
2109
|
#
|
2001
2110
|
# @option params [String] :gateway_version
|
2002
2111
|
# The version of the gateway to create. Specify `3` to create an
|
2003
|
-
# MQTT-enabled, V3 gateway and `2`
|
2004
|
-
# gateway. If the
|
2005
|
-
# gateway
|
2112
|
+
# MQTT-enabled, V3 gateway and `2` to create a Classic streams, V2
|
2113
|
+
# gateway. If not specified, the default is `2` (Classic streams, V2
|
2114
|
+
# gateway).
|
2115
|
+
#
|
2116
|
+
# <note markdown="1"> When creating a V3 gateway (`gatewayVersion=3`) with the
|
2117
|
+
# `GreengrassV2` platform, you must also specify the
|
2118
|
+
# `coreDeviceOperatingSystem` parameter.
|
2006
2119
|
#
|
2007
|
-
#
|
2008
|
-
#
|
2009
|
-
#
|
2010
|
-
#
|
2120
|
+
# </note>
|
2121
|
+
#
|
2122
|
+
# We recommend creating an MQTT-enabled gateway for self-hosted gateways
|
2123
|
+
# and Siemens Industrial Edge gateways. For more information on gateway
|
2124
|
+
# versions, see [Use Amazon Web Services IoT SiteWise Edge Edge
|
2125
|
+
# gateways][1].
|
2011
2126
|
#
|
2012
2127
|
#
|
2013
2128
|
#
|
2014
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/
|
2129
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html
|
2015
2130
|
#
|
2016
2131
|
# @option params [Hash<String,String>] :tags
|
2017
2132
|
# A list of key-value pairs that contain metadata for the gateway. For
|
@@ -2532,6 +2647,46 @@ module Aws::IoTSiteWise
|
|
2532
2647
|
req.send_request(options)
|
2533
2648
|
end
|
2534
2649
|
|
2650
|
+
# Deletes a computation model. This action can't be undone.
|
2651
|
+
#
|
2652
|
+
# @option params [required, String] :computation_model_id
|
2653
|
+
# The ID of the computation model.
|
2654
|
+
#
|
2655
|
+
# @option params [String] :client_token
|
2656
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
2657
|
+
# idempotency of the request. Don't reuse this client token if a new
|
2658
|
+
# idempotent request is required.
|
2659
|
+
#
|
2660
|
+
# **A suitable default value is auto-generated.** You should normally
|
2661
|
+
# not need to pass this option.**
|
2662
|
+
#
|
2663
|
+
# @return [Types::DeleteComputationModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2664
|
+
#
|
2665
|
+
# * {Types::DeleteComputationModelResponse#computation_model_status #computation_model_status} => Types::ComputationModelStatus
|
2666
|
+
#
|
2667
|
+
# @example Request syntax with placeholder values
|
2668
|
+
#
|
2669
|
+
# resp = client.delete_computation_model({
|
2670
|
+
# computation_model_id: "ID", # required
|
2671
|
+
# client_token: "ClientToken",
|
2672
|
+
# })
|
2673
|
+
#
|
2674
|
+
# @example Response structure
|
2675
|
+
#
|
2676
|
+
# resp.computation_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
2677
|
+
# resp.computation_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
2678
|
+
# resp.computation_model_status.error.message #=> String
|
2679
|
+
# resp.computation_model_status.error.details #=> Array
|
2680
|
+
# resp.computation_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
2681
|
+
# resp.computation_model_status.error.details[0].message #=> String
|
2682
|
+
#
|
2683
|
+
# @overload delete_computation_model(params = {})
|
2684
|
+
# @param [Hash] params ({})
|
2685
|
+
def delete_computation_model(params = {}, options = {})
|
2686
|
+
req = build_request(:delete_computation_model, params)
|
2687
|
+
req.send_request(options)
|
2688
|
+
end
|
2689
|
+
|
2535
2690
|
# Deletes a dashboard from IoT SiteWise Monitor.
|
2536
2691
|
#
|
2537
2692
|
# @option params [required, String] :dashboard_id
|
@@ -2581,7 +2736,7 @@ module Aws::IoTSiteWise
|
|
2581
2736
|
# @example Request syntax with placeholder values
|
2582
2737
|
#
|
2583
2738
|
# resp = client.delete_dataset({
|
2584
|
-
# dataset_id: "
|
2739
|
+
# dataset_id: "ID", # required
|
2585
2740
|
# client_token: "ClientToken",
|
2586
2741
|
# })
|
2587
2742
|
#
|
@@ -2810,6 +2965,7 @@ module Aws::IoTSiteWise
|
|
2810
2965
|
# * {Types::DescribeActionResponse#action_definition_id #action_definition_id} => String
|
2811
2966
|
# * {Types::DescribeActionResponse#action_payload #action_payload} => Types::ActionPayload
|
2812
2967
|
# * {Types::DescribeActionResponse#execution_time #execution_time} => Time
|
2968
|
+
# * {Types::DescribeActionResponse#resolve_to #resolve_to} => Types::ResolveTo
|
2813
2969
|
#
|
2814
2970
|
# @example Request syntax with placeholder values
|
2815
2971
|
#
|
@@ -2821,9 +2977,11 @@ module Aws::IoTSiteWise
|
|
2821
2977
|
#
|
2822
2978
|
# resp.action_id #=> String
|
2823
2979
|
# resp.target_resource.asset_id #=> String
|
2980
|
+
# resp.target_resource.computation_model_id #=> String
|
2824
2981
|
# resp.action_definition_id #=> String
|
2825
2982
|
# resp.action_payload.string_value #=> String
|
2826
2983
|
# resp.execution_time #=> Time
|
2984
|
+
# resp.resolve_to.asset_id #=> String
|
2827
2985
|
#
|
2828
2986
|
# @overload describe_action(params = {})
|
2829
2987
|
# @param [Hash] params ({})
|
@@ -2850,6 +3008,7 @@ module Aws::IoTSiteWise
|
|
2850
3008
|
# @return [Types::DescribeAssetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2851
3009
|
#
|
2852
3010
|
# * {Types::DescribeAssetResponse#asset_id #asset_id} => String
|
3011
|
+
# * {Types::DescribeAssetResponse#asset_external_id #asset_external_id} => String
|
2853
3012
|
# * {Types::DescribeAssetResponse#asset_arn #asset_arn} => String
|
2854
3013
|
# * {Types::DescribeAssetResponse#asset_name #asset_name} => String
|
2855
3014
|
# * {Types::DescribeAssetResponse#asset_model_id #asset_model_id} => String
|
@@ -2861,7 +3020,6 @@ module Aws::IoTSiteWise
|
|
2861
3020
|
# * {Types::DescribeAssetResponse#asset_status #asset_status} => Types::AssetStatus
|
2862
3021
|
# * {Types::DescribeAssetResponse#asset_description #asset_description} => String
|
2863
3022
|
# * {Types::DescribeAssetResponse#asset_composite_model_summaries #asset_composite_model_summaries} => Array<Types::AssetCompositeModelSummary>
|
2864
|
-
# * {Types::DescribeAssetResponse#asset_external_id #asset_external_id} => String
|
2865
3023
|
#
|
2866
3024
|
# @example Request syntax with placeholder values
|
2867
3025
|
#
|
@@ -2873,11 +3031,13 @@ module Aws::IoTSiteWise
|
|
2873
3031
|
# @example Response structure
|
2874
3032
|
#
|
2875
3033
|
# resp.asset_id #=> String
|
3034
|
+
# resp.asset_external_id #=> String
|
2876
3035
|
# resp.asset_arn #=> String
|
2877
3036
|
# resp.asset_name #=> String
|
2878
3037
|
# resp.asset_model_id #=> String
|
2879
3038
|
# resp.asset_properties #=> Array
|
2880
3039
|
# resp.asset_properties[0].id #=> String
|
3040
|
+
# resp.asset_properties[0].external_id #=> String
|
2881
3041
|
# resp.asset_properties[0].name #=> String
|
2882
3042
|
# resp.asset_properties[0].alias #=> String
|
2883
3043
|
# resp.asset_properties[0].notification.topic #=> String
|
@@ -2888,17 +3048,17 @@ module Aws::IoTSiteWise
|
|
2888
3048
|
# resp.asset_properties[0].path #=> Array
|
2889
3049
|
# resp.asset_properties[0].path[0].id #=> String
|
2890
3050
|
# resp.asset_properties[0].path[0].name #=> String
|
2891
|
-
# resp.asset_properties[0].external_id #=> String
|
2892
3051
|
# resp.asset_hierarchies #=> Array
|
2893
3052
|
# resp.asset_hierarchies[0].id #=> String
|
2894
|
-
# resp.asset_hierarchies[0].name #=> String
|
2895
3053
|
# resp.asset_hierarchies[0].external_id #=> String
|
3054
|
+
# resp.asset_hierarchies[0].name #=> String
|
2896
3055
|
# resp.asset_composite_models #=> Array
|
2897
3056
|
# resp.asset_composite_models[0].name #=> String
|
2898
3057
|
# resp.asset_composite_models[0].description #=> String
|
2899
3058
|
# resp.asset_composite_models[0].type #=> String
|
2900
3059
|
# resp.asset_composite_models[0].properties #=> Array
|
2901
3060
|
# resp.asset_composite_models[0].properties[0].id #=> String
|
3061
|
+
# resp.asset_composite_models[0].properties[0].external_id #=> String
|
2902
3062
|
# resp.asset_composite_models[0].properties[0].name #=> String
|
2903
3063
|
# resp.asset_composite_models[0].properties[0].alias #=> String
|
2904
3064
|
# resp.asset_composite_models[0].properties[0].notification.topic #=> String
|
@@ -2909,7 +3069,6 @@ module Aws::IoTSiteWise
|
|
2909
3069
|
# resp.asset_composite_models[0].properties[0].path #=> Array
|
2910
3070
|
# resp.asset_composite_models[0].properties[0].path[0].id #=> String
|
2911
3071
|
# resp.asset_composite_models[0].properties[0].path[0].name #=> String
|
2912
|
-
# resp.asset_composite_models[0].properties[0].external_id #=> String
|
2913
3072
|
# resp.asset_composite_models[0].id #=> String
|
2914
3073
|
# resp.asset_composite_models[0].external_id #=> String
|
2915
3074
|
# resp.asset_creation_date #=> Time
|
@@ -2930,7 +3089,6 @@ module Aws::IoTSiteWise
|
|
2930
3089
|
# resp.asset_composite_model_summaries[0].path #=> Array
|
2931
3090
|
# resp.asset_composite_model_summaries[0].path[0].id #=> String
|
2932
3091
|
# resp.asset_composite_model_summaries[0].path[0].name #=> String
|
2933
|
-
# resp.asset_external_id #=> String
|
2934
3092
|
#
|
2935
3093
|
#
|
2936
3094
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -3007,6 +3165,7 @@ module Aws::IoTSiteWise
|
|
3007
3165
|
# resp.asset_composite_model_type #=> String
|
3008
3166
|
# resp.asset_composite_model_properties #=> Array
|
3009
3167
|
# resp.asset_composite_model_properties[0].id #=> String
|
3168
|
+
# resp.asset_composite_model_properties[0].external_id #=> String
|
3010
3169
|
# resp.asset_composite_model_properties[0].name #=> String
|
3011
3170
|
# resp.asset_composite_model_properties[0].alias #=> String
|
3012
3171
|
# resp.asset_composite_model_properties[0].notification.topic #=> String
|
@@ -3017,7 +3176,6 @@ module Aws::IoTSiteWise
|
|
3017
3176
|
# resp.asset_composite_model_properties[0].path #=> Array
|
3018
3177
|
# resp.asset_composite_model_properties[0].path[0].id #=> String
|
3019
3178
|
# resp.asset_composite_model_properties[0].path[0].name #=> String
|
3020
|
-
# resp.asset_composite_model_properties[0].external_id #=> String
|
3021
3179
|
# resp.asset_composite_model_summaries #=> Array
|
3022
3180
|
# resp.asset_composite_model_summaries[0].id #=> String
|
3023
3181
|
# resp.asset_composite_model_summaries[0].external_id #=> String
|
@@ -3374,11 +3532,11 @@ module Aws::IoTSiteWise
|
|
3374
3532
|
# @return [Types::DescribeAssetPropertyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3375
3533
|
#
|
3376
3534
|
# * {Types::DescribeAssetPropertyResponse#asset_id #asset_id} => String
|
3535
|
+
# * {Types::DescribeAssetPropertyResponse#asset_external_id #asset_external_id} => String
|
3377
3536
|
# * {Types::DescribeAssetPropertyResponse#asset_name #asset_name} => String
|
3378
3537
|
# * {Types::DescribeAssetPropertyResponse#asset_model_id #asset_model_id} => String
|
3379
3538
|
# * {Types::DescribeAssetPropertyResponse#asset_property #asset_property} => Types::Property
|
3380
3539
|
# * {Types::DescribeAssetPropertyResponse#composite_model #composite_model} => Types::CompositeModelProperty
|
3381
|
-
# * {Types::DescribeAssetPropertyResponse#asset_external_id #asset_external_id} => String
|
3382
3540
|
#
|
3383
3541
|
# @example Request syntax with placeholder values
|
3384
3542
|
#
|
@@ -3390,9 +3548,11 @@ module Aws::IoTSiteWise
|
|
3390
3548
|
# @example Response structure
|
3391
3549
|
#
|
3392
3550
|
# resp.asset_id #=> String
|
3551
|
+
# resp.asset_external_id #=> String
|
3393
3552
|
# resp.asset_name #=> String
|
3394
3553
|
# resp.asset_model_id #=> String
|
3395
3554
|
# resp.asset_property.id #=> String
|
3555
|
+
# resp.asset_property.external_id #=> String
|
3396
3556
|
# resp.asset_property.name #=> String
|
3397
3557
|
# resp.asset_property.alias #=> String
|
3398
3558
|
# resp.asset_property.notification.topic #=> String
|
@@ -3425,10 +3585,10 @@ module Aws::IoTSiteWise
|
|
3425
3585
|
# resp.asset_property.path #=> Array
|
3426
3586
|
# resp.asset_property.path[0].id #=> String
|
3427
3587
|
# resp.asset_property.path[0].name #=> String
|
3428
|
-
# resp.asset_property.external_id #=> String
|
3429
3588
|
# resp.composite_model.name #=> String
|
3430
3589
|
# resp.composite_model.type #=> String
|
3431
3590
|
# resp.composite_model.asset_property.id #=> String
|
3591
|
+
# resp.composite_model.asset_property.external_id #=> String
|
3432
3592
|
# resp.composite_model.asset_property.name #=> String
|
3433
3593
|
# resp.composite_model.asset_property.alias #=> String
|
3434
3594
|
# resp.composite_model.asset_property.notification.topic #=> String
|
@@ -3461,10 +3621,8 @@ module Aws::IoTSiteWise
|
|
3461
3621
|
# resp.composite_model.asset_property.path #=> Array
|
3462
3622
|
# resp.composite_model.asset_property.path[0].id #=> String
|
3463
3623
|
# resp.composite_model.asset_property.path[0].name #=> String
|
3464
|
-
# resp.composite_model.asset_property.external_id #=> String
|
3465
3624
|
# resp.composite_model.id #=> String
|
3466
3625
|
# resp.composite_model.external_id #=> String
|
3467
|
-
# resp.asset_external_id #=> String
|
3468
3626
|
#
|
3469
3627
|
# @overload describe_asset_property(params = {})
|
3470
3628
|
# @param [Hash] params ({})
|
@@ -3530,6 +3688,107 @@ module Aws::IoTSiteWise
|
|
3530
3688
|
req.send_request(options)
|
3531
3689
|
end
|
3532
3690
|
|
3691
|
+
# Retrieves information about a computation model.
|
3692
|
+
#
|
3693
|
+
# @option params [required, String] :computation_model_id
|
3694
|
+
# The ID of the computation model.
|
3695
|
+
#
|
3696
|
+
# @return [Types::DescribeComputationModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3697
|
+
#
|
3698
|
+
# * {Types::DescribeComputationModelResponse#computation_model_id #computation_model_id} => String
|
3699
|
+
# * {Types::DescribeComputationModelResponse#computation_model_arn #computation_model_arn} => String
|
3700
|
+
# * {Types::DescribeComputationModelResponse#computation_model_name #computation_model_name} => String
|
3701
|
+
# * {Types::DescribeComputationModelResponse#computation_model_description #computation_model_description} => String
|
3702
|
+
# * {Types::DescribeComputationModelResponse#computation_model_configuration #computation_model_configuration} => Types::ComputationModelConfiguration
|
3703
|
+
# * {Types::DescribeComputationModelResponse#computation_model_data_binding #computation_model_data_binding} => Hash<String,Types::ComputationModelDataBindingValue>
|
3704
|
+
# * {Types::DescribeComputationModelResponse#computation_model_creation_date #computation_model_creation_date} => Time
|
3705
|
+
# * {Types::DescribeComputationModelResponse#computation_model_last_update_date #computation_model_last_update_date} => Time
|
3706
|
+
# * {Types::DescribeComputationModelResponse#computation_model_status #computation_model_status} => Types::ComputationModelStatus
|
3707
|
+
# * {Types::DescribeComputationModelResponse#computation_model_version #computation_model_version} => String
|
3708
|
+
# * {Types::DescribeComputationModelResponse#action_definitions #action_definitions} => Array<Types::ActionDefinition>
|
3709
|
+
#
|
3710
|
+
# @example Request syntax with placeholder values
|
3711
|
+
#
|
3712
|
+
# resp = client.describe_computation_model({
|
3713
|
+
# computation_model_id: "ID", # required
|
3714
|
+
# })
|
3715
|
+
#
|
3716
|
+
# @example Response structure
|
3717
|
+
#
|
3718
|
+
# resp.computation_model_id #=> String
|
3719
|
+
# resp.computation_model_arn #=> String
|
3720
|
+
# resp.computation_model_name #=> String
|
3721
|
+
# resp.computation_model_description #=> String
|
3722
|
+
# resp.computation_model_configuration.anomaly_detection.input_properties #=> String
|
3723
|
+
# resp.computation_model_configuration.anomaly_detection.result_property #=> String
|
3724
|
+
# resp.computation_model_data_binding #=> Hash
|
3725
|
+
# resp.computation_model_data_binding["ComputationModelDataBindingVariable"].asset_model_property.asset_model_id #=> String
|
3726
|
+
# resp.computation_model_data_binding["ComputationModelDataBindingVariable"].asset_model_property.property_id #=> String
|
3727
|
+
# resp.computation_model_data_binding["ComputationModelDataBindingVariable"].asset_property.asset_id #=> String
|
3728
|
+
# resp.computation_model_data_binding["ComputationModelDataBindingVariable"].asset_property.property_id #=> String
|
3729
|
+
# resp.computation_model_data_binding["ComputationModelDataBindingVariable"].list #=> Array
|
3730
|
+
# resp.computation_model_data_binding["ComputationModelDataBindingVariable"].list[0] #=> Types::ComputationModelDataBindingValue
|
3731
|
+
# resp.computation_model_creation_date #=> Time
|
3732
|
+
# resp.computation_model_last_update_date #=> Time
|
3733
|
+
# resp.computation_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
3734
|
+
# resp.computation_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
3735
|
+
# resp.computation_model_status.error.message #=> String
|
3736
|
+
# resp.computation_model_status.error.details #=> Array
|
3737
|
+
# resp.computation_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
3738
|
+
# resp.computation_model_status.error.details[0].message #=> String
|
3739
|
+
# resp.computation_model_version #=> String
|
3740
|
+
# resp.action_definitions #=> Array
|
3741
|
+
# resp.action_definitions[0].action_definition_id #=> String
|
3742
|
+
# resp.action_definitions[0].action_name #=> String
|
3743
|
+
# resp.action_definitions[0].action_type #=> String
|
3744
|
+
#
|
3745
|
+
# @overload describe_computation_model(params = {})
|
3746
|
+
# @param [Hash] params ({})
|
3747
|
+
def describe_computation_model(params = {}, options = {})
|
3748
|
+
req = build_request(:describe_computation_model, params)
|
3749
|
+
req.send_request(options)
|
3750
|
+
end
|
3751
|
+
|
3752
|
+
# Retrieves information about the execution summary of a computation
|
3753
|
+
# model.
|
3754
|
+
#
|
3755
|
+
# @option params [required, String] :computation_model_id
|
3756
|
+
# The ID of the computation model.
|
3757
|
+
#
|
3758
|
+
# @option params [String] :resolve_to_resource_type
|
3759
|
+
# The type of the resolved resource.
|
3760
|
+
#
|
3761
|
+
# @option params [String] :resolve_to_resource_id
|
3762
|
+
# The ID of the resolved resource.
|
3763
|
+
#
|
3764
|
+
# @return [Types::DescribeComputationModelExecutionSummaryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3765
|
+
#
|
3766
|
+
# * {Types::DescribeComputationModelExecutionSummaryResponse#computation_model_id #computation_model_id} => String
|
3767
|
+
# * {Types::DescribeComputationModelExecutionSummaryResponse#resolve_to #resolve_to} => Types::ResolveTo
|
3768
|
+
# * {Types::DescribeComputationModelExecutionSummaryResponse#computation_model_execution_summary #computation_model_execution_summary} => Hash<String,String>
|
3769
|
+
#
|
3770
|
+
# @example Request syntax with placeholder values
|
3771
|
+
#
|
3772
|
+
# resp = client.describe_computation_model_execution_summary({
|
3773
|
+
# computation_model_id: "ID", # required
|
3774
|
+
# resolve_to_resource_type: "ASSET", # accepts ASSET
|
3775
|
+
# resolve_to_resource_id: "ID",
|
3776
|
+
# })
|
3777
|
+
#
|
3778
|
+
# @example Response structure
|
3779
|
+
#
|
3780
|
+
# resp.computation_model_id #=> String
|
3781
|
+
# resp.resolve_to.asset_id #=> String
|
3782
|
+
# resp.computation_model_execution_summary #=> Hash
|
3783
|
+
# resp.computation_model_execution_summary["ComputationModelExecutionSummaryKey"] #=> String
|
3784
|
+
#
|
3785
|
+
# @overload describe_computation_model_execution_summary(params = {})
|
3786
|
+
# @param [Hash] params ({})
|
3787
|
+
def describe_computation_model_execution_summary(params = {}, options = {})
|
3788
|
+
req = build_request(:describe_computation_model_execution_summary, params)
|
3789
|
+
req.send_request(options)
|
3790
|
+
end
|
3791
|
+
|
3533
3792
|
# Retrieves information about a dashboard.
|
3534
3793
|
#
|
3535
3794
|
# @option params [required, String] :dashboard_id
|
@@ -3590,7 +3849,7 @@ module Aws::IoTSiteWise
|
|
3590
3849
|
# @example Request syntax with placeholder values
|
3591
3850
|
#
|
3592
3851
|
# resp = client.describe_dataset({
|
3593
|
-
# dataset_id: "
|
3852
|
+
# dataset_id: "ID", # required
|
3594
3853
|
# })
|
3595
3854
|
#
|
3596
3855
|
# @example Response structure
|
@@ -3650,6 +3909,55 @@ module Aws::IoTSiteWise
|
|
3650
3909
|
req.send_request(options)
|
3651
3910
|
end
|
3652
3911
|
|
3912
|
+
# Retrieves information about the execution.
|
3913
|
+
#
|
3914
|
+
# @option params [required, String] :execution_id
|
3915
|
+
# The ID of the execution.
|
3916
|
+
#
|
3917
|
+
# @return [Types::DescribeExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3918
|
+
#
|
3919
|
+
# * {Types::DescribeExecutionResponse#execution_id #execution_id} => String
|
3920
|
+
# * {Types::DescribeExecutionResponse#action_type #action_type} => String
|
3921
|
+
# * {Types::DescribeExecutionResponse#target_resource #target_resource} => Types::TargetResource
|
3922
|
+
# * {Types::DescribeExecutionResponse#target_resource_version #target_resource_version} => String
|
3923
|
+
# * {Types::DescribeExecutionResponse#resolve_to #resolve_to} => Types::ResolveTo
|
3924
|
+
# * {Types::DescribeExecutionResponse#execution_start_time #execution_start_time} => Time
|
3925
|
+
# * {Types::DescribeExecutionResponse#execution_end_time #execution_end_time} => Time
|
3926
|
+
# * {Types::DescribeExecutionResponse#execution_status #execution_status} => Types::ExecutionStatus
|
3927
|
+
# * {Types::DescribeExecutionResponse#execution_result #execution_result} => Hash<String,String>
|
3928
|
+
# * {Types::DescribeExecutionResponse#execution_details #execution_details} => Hash<String,String>
|
3929
|
+
# * {Types::DescribeExecutionResponse#execution_entity_version #execution_entity_version} => String
|
3930
|
+
#
|
3931
|
+
# @example Request syntax with placeholder values
|
3932
|
+
#
|
3933
|
+
# resp = client.describe_execution({
|
3934
|
+
# execution_id: "ID", # required
|
3935
|
+
# })
|
3936
|
+
#
|
3937
|
+
# @example Response structure
|
3938
|
+
#
|
3939
|
+
# resp.execution_id #=> String
|
3940
|
+
# resp.action_type #=> String
|
3941
|
+
# resp.target_resource.asset_id #=> String
|
3942
|
+
# resp.target_resource.computation_model_id #=> String
|
3943
|
+
# resp.target_resource_version #=> String
|
3944
|
+
# resp.resolve_to.asset_id #=> String
|
3945
|
+
# resp.execution_start_time #=> Time
|
3946
|
+
# resp.execution_end_time #=> Time
|
3947
|
+
# resp.execution_status.state #=> String, one of "RUNNING", "COMPLETED", "FAILED"
|
3948
|
+
# resp.execution_result #=> Hash
|
3949
|
+
# resp.execution_result["ExecutionResultKey"] #=> String
|
3950
|
+
# resp.execution_details #=> Hash
|
3951
|
+
# resp.execution_details["ExecutionDetailsKey"] #=> String
|
3952
|
+
# resp.execution_entity_version #=> String
|
3953
|
+
#
|
3954
|
+
# @overload describe_execution(params = {})
|
3955
|
+
# @param [Hash] params ({})
|
3956
|
+
def describe_execution(params = {}, options = {})
|
3957
|
+
req = build_request(:describe_execution, params)
|
3958
|
+
req.send_request(options)
|
3959
|
+
end
|
3960
|
+
|
3653
3961
|
# Retrieves information about a gateway.
|
3654
3962
|
#
|
3655
3963
|
# @option params [required, String] :gateway_id
|
@@ -3695,27 +4003,38 @@ module Aws::IoTSiteWise
|
|
3695
4003
|
req.send_request(options)
|
3696
4004
|
end
|
3697
4005
|
|
3698
|
-
#
|
3699
|
-
#
|
3700
|
-
#
|
3701
|
-
#
|
3702
|
-
#
|
3703
|
-
#
|
3704
|
-
#
|
4006
|
+
# Each gateway capability defines data sources for a gateway. This is
|
4007
|
+
# the namespace of the gateway capability.
|
4008
|
+
#
|
4009
|
+
# . The namespace follows the format `service:capability:version`,
|
4010
|
+
# where:
|
4011
|
+
#
|
4012
|
+
# * `service` - The service providing the capability, or `iotsitewise`.
|
3705
4013
|
#
|
4014
|
+
# * `capability` - The specific capability type. Options include:
|
4015
|
+
# `opcuacollector` for the OPC UA data source collector, or
|
4016
|
+
# `publisher` for data publisher capability.
|
3706
4017
|
#
|
4018
|
+
# * `version` - The version number of the capability. Option include `2`
|
4019
|
+
# for Classic streams, V2 gateways, and `3` for MQTT-enabled, V3
|
4020
|
+
# gateways.
|
3707
4021
|
#
|
3708
|
-
#
|
4022
|
+
# After updating a capability configuration, the sync status becomes
|
4023
|
+
# `OUT_OF_SYNC` until the gateway processes the configuration.Use
|
4024
|
+
# `DescribeGatewayCapabilityConfiguration` to check the sync status and
|
4025
|
+
# verify the configuration was applied.
|
4026
|
+
#
|
4027
|
+
# A gateway can have multiple capability configurations with different
|
4028
|
+
# namespaces.
|
3709
4029
|
#
|
3710
4030
|
# @option params [required, String] :gateway_id
|
3711
4031
|
# The ID of the gateway that defines the capability configuration.
|
3712
4032
|
#
|
3713
4033
|
# @option params [required, String] :capability_namespace
|
3714
4034
|
# The namespace of the capability configuration. For example, if you
|
3715
|
-
# configure OPC
|
4035
|
+
# configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA
|
3716
4036
|
# capability configuration has the namespace
|
3717
|
-
# `iotsitewise:opcuacollector:
|
3718
|
-
# as `1`.
|
4037
|
+
# `iotsitewise:opcuacollector:3`.
|
3719
4038
|
#
|
3720
4039
|
# @return [Types::DescribeGatewayCapabilityConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3721
4040
|
#
|
@@ -4119,6 +4438,9 @@ module Aws::IoTSiteWise
|
|
4119
4438
|
# idempotency of the request. Don't reuse this client token if a new
|
4120
4439
|
# idempotent request is required.
|
4121
4440
|
#
|
4441
|
+
# @option params [Types::ResolveTo] :resolve_to
|
4442
|
+
# The detailed resource this action resolves to.
|
4443
|
+
#
|
4122
4444
|
# @return [Types::ExecuteActionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4123
4445
|
#
|
4124
4446
|
# * {Types::ExecuteActionResponse#action_id #action_id} => String
|
@@ -4127,13 +4449,17 @@ module Aws::IoTSiteWise
|
|
4127
4449
|
#
|
4128
4450
|
# resp = client.execute_action({
|
4129
4451
|
# target_resource: { # required
|
4130
|
-
# asset_id: "
|
4452
|
+
# asset_id: "ID",
|
4453
|
+
# computation_model_id: "ID",
|
4131
4454
|
# },
|
4132
4455
|
# action_definition_id: "ID", # required
|
4133
4456
|
# action_payload: { # required
|
4134
4457
|
# string_value: "ActionPayloadString", # required
|
4135
4458
|
# },
|
4136
4459
|
# client_token: "ClientToken",
|
4460
|
+
# resolve_to: {
|
4461
|
+
# asset_id: "ID", # required
|
4462
|
+
# },
|
4137
4463
|
# })
|
4138
4464
|
#
|
4139
4465
|
# @example Response structure
|
@@ -4157,8 +4483,13 @@ module Aws::IoTSiteWise
|
|
4157
4483
|
# The string that specifies the next page of results.
|
4158
4484
|
#
|
4159
4485
|
# @option params [Integer] :max_results
|
4160
|
-
# The maximum number of results to return at one time.
|
4161
|
-
#
|
4486
|
+
# The maximum number of results to return at one time.
|
4487
|
+
#
|
4488
|
+
# * Minimum is 1
|
4489
|
+
#
|
4490
|
+
# * Maximum is 20000
|
4491
|
+
#
|
4492
|
+
# * Default is 250
|
4162
4493
|
#
|
4163
4494
|
# @option params [String] :client_token
|
4164
4495
|
# A unique case-sensitive identifier that you can provide to ensure the
|
@@ -5001,6 +5332,12 @@ module Aws::IoTSiteWise
|
|
5001
5332
|
# @option params [Integer] :max_results
|
5002
5333
|
# The maximum number of results to return for each paginated request.
|
5003
5334
|
#
|
5335
|
+
# @option params [String] :resolve_to_resource_type
|
5336
|
+
# The type of the resolved resource.
|
5337
|
+
#
|
5338
|
+
# @option params [String] :resolve_to_resource_id
|
5339
|
+
# The ID of the resolved resource.
|
5340
|
+
#
|
5004
5341
|
# @return [Types::ListActionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5005
5342
|
#
|
5006
5343
|
# * {Types::ListActionsResponse#action_summaries #action_summaries} => Array<Types::ActionSummary>
|
@@ -5011,10 +5348,12 @@ module Aws::IoTSiteWise
|
|
5011
5348
|
# @example Request syntax with placeholder values
|
5012
5349
|
#
|
5013
5350
|
# resp = client.list_actions({
|
5014
|
-
# target_resource_type: "ASSET", # required, accepts ASSET
|
5015
|
-
# target_resource_id: "
|
5351
|
+
# target_resource_type: "ASSET", # required, accepts ASSET, COMPUTATION_MODEL
|
5352
|
+
# target_resource_id: "ID", # required
|
5016
5353
|
# next_token: "NextToken",
|
5017
5354
|
# max_results: 1,
|
5355
|
+
# resolve_to_resource_type: "ASSET", # accepts ASSET
|
5356
|
+
# resolve_to_resource_id: "ID",
|
5018
5357
|
# })
|
5019
5358
|
#
|
5020
5359
|
# @example Response structure
|
@@ -5023,6 +5362,8 @@ module Aws::IoTSiteWise
|
|
5023
5362
|
# resp.action_summaries[0].action_id #=> String
|
5024
5363
|
# resp.action_summaries[0].action_definition_id #=> String
|
5025
5364
|
# resp.action_summaries[0].target_resource.asset_id #=> String
|
5365
|
+
# resp.action_summaries[0].target_resource.computation_model_id #=> String
|
5366
|
+
# resp.action_summaries[0].resolve_to.asset_id #=> String
|
5026
5367
|
# resp.next_token #=> String
|
5027
5368
|
#
|
5028
5369
|
# @overload list_actions(params = {})
|
@@ -5331,6 +5672,7 @@ module Aws::IoTSiteWise
|
|
5331
5672
|
#
|
5332
5673
|
# resp.asset_property_summaries #=> Array
|
5333
5674
|
# resp.asset_property_summaries[0].id #=> String
|
5675
|
+
# resp.asset_property_summaries[0].external_id #=> String
|
5334
5676
|
# resp.asset_property_summaries[0].alias #=> String
|
5335
5677
|
# resp.asset_property_summaries[0].unit #=> String
|
5336
5678
|
# resp.asset_property_summaries[0].notification.topic #=> String
|
@@ -5339,7 +5681,6 @@ module Aws::IoTSiteWise
|
|
5339
5681
|
# resp.asset_property_summaries[0].path #=> Array
|
5340
5682
|
# resp.asset_property_summaries[0].path[0].id #=> String
|
5341
5683
|
# resp.asset_property_summaries[0].path[0].name #=> String
|
5342
|
-
# resp.asset_property_summaries[0].external_id #=> String
|
5343
5684
|
# resp.next_token #=> String
|
5344
5685
|
#
|
5345
5686
|
# @overload list_asset_properties(params = {})
|
@@ -5479,6 +5820,7 @@ module Aws::IoTSiteWise
|
|
5479
5820
|
#
|
5480
5821
|
# resp.asset_summaries #=> Array
|
5481
5822
|
# resp.asset_summaries[0].id #=> String
|
5823
|
+
# resp.asset_summaries[0].external_id #=> String
|
5482
5824
|
# resp.asset_summaries[0].arn #=> String
|
5483
5825
|
# resp.asset_summaries[0].name #=> String
|
5484
5826
|
# resp.asset_summaries[0].asset_model_id #=> String
|
@@ -5492,10 +5834,9 @@ module Aws::IoTSiteWise
|
|
5492
5834
|
# resp.asset_summaries[0].status.error.details[0].message #=> String
|
5493
5835
|
# resp.asset_summaries[0].hierarchies #=> Array
|
5494
5836
|
# resp.asset_summaries[0].hierarchies[0].id #=> String
|
5495
|
-
# resp.asset_summaries[0].hierarchies[0].name #=> String
|
5496
5837
|
# resp.asset_summaries[0].hierarchies[0].external_id #=> String
|
5838
|
+
# resp.asset_summaries[0].hierarchies[0].name #=> String
|
5497
5839
|
# resp.asset_summaries[0].description #=> String
|
5498
|
-
# resp.asset_summaries[0].external_id #=> String
|
5499
5840
|
# resp.next_token #=> String
|
5500
5841
|
#
|
5501
5842
|
# @overload list_assets(params = {})
|
@@ -5581,6 +5922,7 @@ module Aws::IoTSiteWise
|
|
5581
5922
|
#
|
5582
5923
|
# resp.asset_summaries #=> Array
|
5583
5924
|
# resp.asset_summaries[0].id #=> String
|
5925
|
+
# resp.asset_summaries[0].external_id #=> String
|
5584
5926
|
# resp.asset_summaries[0].arn #=> String
|
5585
5927
|
# resp.asset_summaries[0].name #=> String
|
5586
5928
|
# resp.asset_summaries[0].asset_model_id #=> String
|
@@ -5594,10 +5936,9 @@ module Aws::IoTSiteWise
|
|
5594
5936
|
# resp.asset_summaries[0].status.error.details[0].message #=> String
|
5595
5937
|
# resp.asset_summaries[0].hierarchies #=> Array
|
5596
5938
|
# resp.asset_summaries[0].hierarchies[0].id #=> String
|
5597
|
-
# resp.asset_summaries[0].hierarchies[0].name #=> String
|
5598
5939
|
# resp.asset_summaries[0].hierarchies[0].external_id #=> String
|
5940
|
+
# resp.asset_summaries[0].hierarchies[0].name #=> String
|
5599
5941
|
# resp.asset_summaries[0].description #=> String
|
5600
|
-
# resp.asset_summaries[0].external_id #=> String
|
5601
5942
|
# resp.next_token #=> String
|
5602
5943
|
#
|
5603
5944
|
# @overload list_associated_assets(params = {})
|
@@ -5706,6 +6047,164 @@ module Aws::IoTSiteWise
|
|
5706
6047
|
req.send_request(options)
|
5707
6048
|
end
|
5708
6049
|
|
6050
|
+
# Lists all data binding usages for computation models. This allows to
|
6051
|
+
# identify where specific data bindings are being utilized across the
|
6052
|
+
# computation models. This track dependencies between data sources and
|
6053
|
+
# computation models.
|
6054
|
+
#
|
6055
|
+
# @option params [required, Types::DataBindingValueFilter] :data_binding_value_filter
|
6056
|
+
# A filter used to limit the returned data binding usages based on
|
6057
|
+
# specific data binding values. You can filter by asset, asset model,
|
6058
|
+
# asset property, or asset model property to find all computation models
|
6059
|
+
# using these specific data sources.
|
6060
|
+
#
|
6061
|
+
# @option params [String] :next_token
|
6062
|
+
# The token used for the next set of paginated results.
|
6063
|
+
#
|
6064
|
+
# @option params [Integer] :max_results
|
6065
|
+
# The maximum number of results returned for each paginated request.
|
6066
|
+
#
|
6067
|
+
# @return [Types::ListComputationModelDataBindingUsagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6068
|
+
#
|
6069
|
+
# * {Types::ListComputationModelDataBindingUsagesResponse#data_binding_usage_summaries #data_binding_usage_summaries} => Array<Types::ComputationModelDataBindingUsageSummary>
|
6070
|
+
# * {Types::ListComputationModelDataBindingUsagesResponse#next_token #next_token} => String
|
6071
|
+
#
|
6072
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6073
|
+
#
|
6074
|
+
# @example Request syntax with placeholder values
|
6075
|
+
#
|
6076
|
+
# resp = client.list_computation_model_data_binding_usages({
|
6077
|
+
# data_binding_value_filter: { # required
|
6078
|
+
# asset: {
|
6079
|
+
# asset_id: "ID", # required
|
6080
|
+
# },
|
6081
|
+
# asset_model: {
|
6082
|
+
# asset_model_id: "ID", # required
|
6083
|
+
# },
|
6084
|
+
# asset_property: {
|
6085
|
+
# asset_id: "ID", # required
|
6086
|
+
# property_id: "ID", # required
|
6087
|
+
# },
|
6088
|
+
# asset_model_property: {
|
6089
|
+
# asset_model_id: "ID", # required
|
6090
|
+
# property_id: "ID", # required
|
6091
|
+
# },
|
6092
|
+
# },
|
6093
|
+
# next_token: "NextToken",
|
6094
|
+
# max_results: 1,
|
6095
|
+
# })
|
6096
|
+
#
|
6097
|
+
# @example Response structure
|
6098
|
+
#
|
6099
|
+
# resp.data_binding_usage_summaries #=> Array
|
6100
|
+
# resp.data_binding_usage_summaries[0].computation_model_ids #=> Array
|
6101
|
+
# resp.data_binding_usage_summaries[0].computation_model_ids[0] #=> String
|
6102
|
+
# resp.data_binding_usage_summaries[0].matched_data_binding.value.asset_model_property.asset_model_id #=> String
|
6103
|
+
# resp.data_binding_usage_summaries[0].matched_data_binding.value.asset_model_property.property_id #=> String
|
6104
|
+
# resp.data_binding_usage_summaries[0].matched_data_binding.value.asset_property.asset_id #=> String
|
6105
|
+
# resp.data_binding_usage_summaries[0].matched_data_binding.value.asset_property.property_id #=> String
|
6106
|
+
# resp.next_token #=> String
|
6107
|
+
#
|
6108
|
+
# @overload list_computation_model_data_binding_usages(params = {})
|
6109
|
+
# @param [Hash] params ({})
|
6110
|
+
def list_computation_model_data_binding_usages(params = {}, options = {})
|
6111
|
+
req = build_request(:list_computation_model_data_binding_usages, params)
|
6112
|
+
req.send_request(options)
|
6113
|
+
end
|
6114
|
+
|
6115
|
+
# Lists all distinct resources that are resolved from the executed
|
6116
|
+
# actions of the computation model.
|
6117
|
+
#
|
6118
|
+
# @option params [required, String] :computation_model_id
|
6119
|
+
# The ID of the computation model for which to list resolved resources.
|
6120
|
+
#
|
6121
|
+
# @option params [String] :next_token
|
6122
|
+
# The token used for the next set of paginated results.
|
6123
|
+
#
|
6124
|
+
# @option params [Integer] :max_results
|
6125
|
+
# The maximum number of results returned for each paginated request.
|
6126
|
+
#
|
6127
|
+
# @return [Types::ListComputationModelResolveToResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6128
|
+
#
|
6129
|
+
# * {Types::ListComputationModelResolveToResourcesResponse#computation_model_resolve_to_resource_summaries #computation_model_resolve_to_resource_summaries} => Array<Types::ComputationModelResolveToResourceSummary>
|
6130
|
+
# * {Types::ListComputationModelResolveToResourcesResponse#next_token #next_token} => String
|
6131
|
+
#
|
6132
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6133
|
+
#
|
6134
|
+
# @example Request syntax with placeholder values
|
6135
|
+
#
|
6136
|
+
# resp = client.list_computation_model_resolve_to_resources({
|
6137
|
+
# computation_model_id: "ID", # required
|
6138
|
+
# next_token: "NextToken",
|
6139
|
+
# max_results: 1,
|
6140
|
+
# })
|
6141
|
+
#
|
6142
|
+
# @example Response structure
|
6143
|
+
#
|
6144
|
+
# resp.computation_model_resolve_to_resource_summaries #=> Array
|
6145
|
+
# resp.computation_model_resolve_to_resource_summaries[0].resolve_to.asset_id #=> String
|
6146
|
+
# resp.next_token #=> String
|
6147
|
+
#
|
6148
|
+
# @overload list_computation_model_resolve_to_resources(params = {})
|
6149
|
+
# @param [Hash] params ({})
|
6150
|
+
def list_computation_model_resolve_to_resources(params = {}, options = {})
|
6151
|
+
req = build_request(:list_computation_model_resolve_to_resources, params)
|
6152
|
+
req.send_request(options)
|
6153
|
+
end
|
6154
|
+
|
6155
|
+
# Retrieves a paginated list of summaries of all computation models.
|
6156
|
+
#
|
6157
|
+
# @option params [String] :computation_model_type
|
6158
|
+
# The type of computation model. If a `computationModelType` is not
|
6159
|
+
# provided, all types of computation models are returned.
|
6160
|
+
#
|
6161
|
+
# @option params [String] :next_token
|
6162
|
+
# The token to be used for the next set of paginated results.
|
6163
|
+
#
|
6164
|
+
# @option params [Integer] :max_results
|
6165
|
+
# The maximum number of results to return for each paginated request.
|
6166
|
+
#
|
6167
|
+
# @return [Types::ListComputationModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6168
|
+
#
|
6169
|
+
# * {Types::ListComputationModelsResponse#computation_model_summaries #computation_model_summaries} => Array<Types::ComputationModelSummary>
|
6170
|
+
# * {Types::ListComputationModelsResponse#next_token #next_token} => String
|
6171
|
+
#
|
6172
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6173
|
+
#
|
6174
|
+
# @example Request syntax with placeholder values
|
6175
|
+
#
|
6176
|
+
# resp = client.list_computation_models({
|
6177
|
+
# computation_model_type: "ANOMALY_DETECTION", # accepts ANOMALY_DETECTION
|
6178
|
+
# next_token: "NextToken",
|
6179
|
+
# max_results: 1,
|
6180
|
+
# })
|
6181
|
+
#
|
6182
|
+
# @example Response structure
|
6183
|
+
#
|
6184
|
+
# resp.computation_model_summaries #=> Array
|
6185
|
+
# resp.computation_model_summaries[0].id #=> String
|
6186
|
+
# resp.computation_model_summaries[0].arn #=> String
|
6187
|
+
# resp.computation_model_summaries[0].name #=> String
|
6188
|
+
# resp.computation_model_summaries[0].description #=> String
|
6189
|
+
# resp.computation_model_summaries[0].type #=> String, one of "ANOMALY_DETECTION"
|
6190
|
+
# resp.computation_model_summaries[0].creation_date #=> Time
|
6191
|
+
# resp.computation_model_summaries[0].last_update_date #=> Time
|
6192
|
+
# resp.computation_model_summaries[0].status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
6193
|
+
# resp.computation_model_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
6194
|
+
# resp.computation_model_summaries[0].status.error.message #=> String
|
6195
|
+
# resp.computation_model_summaries[0].status.error.details #=> Array
|
6196
|
+
# resp.computation_model_summaries[0].status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
6197
|
+
# resp.computation_model_summaries[0].status.error.details[0].message #=> String
|
6198
|
+
# resp.computation_model_summaries[0].version #=> String
|
6199
|
+
# resp.next_token #=> String
|
6200
|
+
#
|
6201
|
+
# @overload list_computation_models(params = {})
|
6202
|
+
# @param [Hash] params ({})
|
6203
|
+
def list_computation_models(params = {}, options = {})
|
6204
|
+
req = build_request(:list_computation_models, params)
|
6205
|
+
req.send_request(options)
|
6206
|
+
end
|
6207
|
+
|
5709
6208
|
# Retrieves a paginated list of dashboards for an IoT SiteWise Monitor
|
5710
6209
|
# project.
|
5711
6210
|
#
|
@@ -5803,6 +6302,70 @@ module Aws::IoTSiteWise
|
|
5803
6302
|
req.send_request(options)
|
5804
6303
|
end
|
5805
6304
|
|
6305
|
+
# Retrieves a paginated list of summaries of all executions.
|
6306
|
+
#
|
6307
|
+
# @option params [required, String] :target_resource_type
|
6308
|
+
# The type of the target resource.
|
6309
|
+
#
|
6310
|
+
# @option params [required, String] :target_resource_id
|
6311
|
+
# The ID of the target resource.
|
6312
|
+
#
|
6313
|
+
# @option params [String] :resolve_to_resource_type
|
6314
|
+
# The type of the resolved resource.
|
6315
|
+
#
|
6316
|
+
# @option params [String] :resolve_to_resource_id
|
6317
|
+
# The ID of the resolved resource.
|
6318
|
+
#
|
6319
|
+
# @option params [String] :next_token
|
6320
|
+
# The token used for the next set of paginated results.
|
6321
|
+
#
|
6322
|
+
# @option params [Integer] :max_results
|
6323
|
+
# The maximum number of results returned for each paginated request.
|
6324
|
+
#
|
6325
|
+
# @option params [String] :action_type
|
6326
|
+
# The type of action exectued.
|
6327
|
+
#
|
6328
|
+
# @return [Types::ListExecutionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6329
|
+
#
|
6330
|
+
# * {Types::ListExecutionsResponse#execution_summaries #execution_summaries} => Array<Types::ExecutionSummary>
|
6331
|
+
# * {Types::ListExecutionsResponse#next_token #next_token} => String
|
6332
|
+
#
|
6333
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6334
|
+
#
|
6335
|
+
# @example Request syntax with placeholder values
|
6336
|
+
#
|
6337
|
+
# resp = client.list_executions({
|
6338
|
+
# target_resource_type: "ASSET", # required, accepts ASSET, COMPUTATION_MODEL
|
6339
|
+
# target_resource_id: "ID", # required
|
6340
|
+
# resolve_to_resource_type: "ASSET", # accepts ASSET
|
6341
|
+
# resolve_to_resource_id: "ID",
|
6342
|
+
# next_token: "NextToken",
|
6343
|
+
# max_results: 1,
|
6344
|
+
# action_type: "Name",
|
6345
|
+
# })
|
6346
|
+
#
|
6347
|
+
# @example Response structure
|
6348
|
+
#
|
6349
|
+
# resp.execution_summaries #=> Array
|
6350
|
+
# resp.execution_summaries[0].execution_id #=> String
|
6351
|
+
# resp.execution_summaries[0].action_type #=> String
|
6352
|
+
# resp.execution_summaries[0].target_resource.asset_id #=> String
|
6353
|
+
# resp.execution_summaries[0].target_resource.computation_model_id #=> String
|
6354
|
+
# resp.execution_summaries[0].target_resource_version #=> String
|
6355
|
+
# resp.execution_summaries[0].resolve_to.asset_id #=> String
|
6356
|
+
# resp.execution_summaries[0].execution_start_time #=> Time
|
6357
|
+
# resp.execution_summaries[0].execution_end_time #=> Time
|
6358
|
+
# resp.execution_summaries[0].execution_status.state #=> String, one of "RUNNING", "COMPLETED", "FAILED"
|
6359
|
+
# resp.execution_summaries[0].execution_entity_version #=> String
|
6360
|
+
# resp.next_token #=> String
|
6361
|
+
#
|
6362
|
+
# @overload list_executions(params = {})
|
6363
|
+
# @param [Hash] params ({})
|
6364
|
+
def list_executions(params = {}, options = {})
|
6365
|
+
req = build_request(:list_executions, params)
|
6366
|
+
req.send_request(options)
|
6367
|
+
end
|
6368
|
+
|
5806
6369
|
# Retrieves a paginated list of gateways.
|
5807
6370
|
#
|
5808
6371
|
# @option params [String] :next_token
|
@@ -6413,6 +6976,16 @@ module Aws::IoTSiteWise
|
|
6413
6976
|
#
|
6414
6977
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
6415
6978
|
#
|
6979
|
+
# @option params [String] :asset_external_id
|
6980
|
+
# An external ID to assign to the asset. The asset must not already have
|
6981
|
+
# an external ID. The external ID must be unique within your Amazon Web
|
6982
|
+
# Services account. For more information, see [Using external IDs][1] in
|
6983
|
+
# the *IoT SiteWise User Guide*.
|
6984
|
+
#
|
6985
|
+
#
|
6986
|
+
#
|
6987
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
6988
|
+
#
|
6416
6989
|
# @option params [required, String] :asset_name
|
6417
6990
|
# A friendly name for the asset.
|
6418
6991
|
#
|
@@ -6427,16 +7000,6 @@ module Aws::IoTSiteWise
|
|
6427
7000
|
# @option params [String] :asset_description
|
6428
7001
|
# A description for the asset.
|
6429
7002
|
#
|
6430
|
-
# @option params [String] :asset_external_id
|
6431
|
-
# An external ID to assign to the asset. The asset must not already have
|
6432
|
-
# an external ID. The external ID must be unique within your Amazon Web
|
6433
|
-
# Services account. For more information, see [Using external IDs][1] in
|
6434
|
-
# the *IoT SiteWise User Guide*.
|
6435
|
-
#
|
6436
|
-
#
|
6437
|
-
#
|
6438
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
6439
|
-
#
|
6440
7003
|
# @return [Types::UpdateAssetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6441
7004
|
#
|
6442
7005
|
# * {Types::UpdateAssetResponse#asset_status #asset_status} => Types::AssetStatus
|
@@ -6445,10 +7008,10 @@ module Aws::IoTSiteWise
|
|
6445
7008
|
#
|
6446
7009
|
# resp = client.update_asset({
|
6447
7010
|
# asset_id: "CustomID", # required
|
7011
|
+
# asset_external_id: "ExternalId",
|
6448
7012
|
# asset_name: "Name", # required
|
6449
7013
|
# client_token: "ClientToken",
|
6450
7014
|
# asset_description: "Description",
|
6451
|
-
# asset_external_id: "ExternalId",
|
6452
7015
|
# })
|
6453
7016
|
#
|
6454
7017
|
# @example Response structure
|
@@ -7095,6 +7658,85 @@ module Aws::IoTSiteWise
|
|
7095
7658
|
req.send_request(options)
|
7096
7659
|
end
|
7097
7660
|
|
7661
|
+
# Updates the computation model.
|
7662
|
+
#
|
7663
|
+
# @option params [required, String] :computation_model_id
|
7664
|
+
# The ID of the computation model.
|
7665
|
+
#
|
7666
|
+
# @option params [required, String] :computation_model_name
|
7667
|
+
# The name of the computation model.
|
7668
|
+
#
|
7669
|
+
# @option params [String] :computation_model_description
|
7670
|
+
# The description of the computation model.
|
7671
|
+
#
|
7672
|
+
# @option params [required, Types::ComputationModelConfiguration] :computation_model_configuration
|
7673
|
+
# The configuration for the computation model.
|
7674
|
+
#
|
7675
|
+
# @option params [required, Hash<String,Types::ComputationModelDataBindingValue>] :computation_model_data_binding
|
7676
|
+
# The data binding for the computation model. Key is a variable name
|
7677
|
+
# defined in configuration. Value is a
|
7678
|
+
# `ComputationModelDataBindingValue` referenced by the variable.
|
7679
|
+
#
|
7680
|
+
# @option params [String] :client_token
|
7681
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
7682
|
+
# idempotency of the request. Don't reuse this client token if a new
|
7683
|
+
# idempotent request is required.
|
7684
|
+
#
|
7685
|
+
# **A suitable default value is auto-generated.** You should normally
|
7686
|
+
# not need to pass this option.**
|
7687
|
+
#
|
7688
|
+
# @return [Types::UpdateComputationModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7689
|
+
#
|
7690
|
+
# * {Types::UpdateComputationModelResponse#computation_model_status #computation_model_status} => Types::ComputationModelStatus
|
7691
|
+
#
|
7692
|
+
# @example Request syntax with placeholder values
|
7693
|
+
#
|
7694
|
+
# resp = client.update_computation_model({
|
7695
|
+
# computation_model_id: "ID", # required
|
7696
|
+
# computation_model_name: "RestrictedName", # required
|
7697
|
+
# computation_model_description: "RestrictedDescription",
|
7698
|
+
# computation_model_configuration: { # required
|
7699
|
+
# anomaly_detection: {
|
7700
|
+
# input_properties: "InputProperties", # required
|
7701
|
+
# result_property: "ResultProperty", # required
|
7702
|
+
# },
|
7703
|
+
# },
|
7704
|
+
# computation_model_data_binding: { # required
|
7705
|
+
# "ComputationModelDataBindingVariable" => {
|
7706
|
+
# asset_model_property: {
|
7707
|
+
# asset_model_id: "ID", # required
|
7708
|
+
# property_id: "ID", # required
|
7709
|
+
# },
|
7710
|
+
# asset_property: {
|
7711
|
+
# asset_id: "ID", # required
|
7712
|
+
# property_id: "ID", # required
|
7713
|
+
# },
|
7714
|
+
# list: [
|
7715
|
+
# {
|
7716
|
+
# # recursive ComputationModelDataBindingValue
|
7717
|
+
# },
|
7718
|
+
# ],
|
7719
|
+
# },
|
7720
|
+
# },
|
7721
|
+
# client_token: "ClientToken",
|
7722
|
+
# })
|
7723
|
+
#
|
7724
|
+
# @example Response structure
|
7725
|
+
#
|
7726
|
+
# resp.computation_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
7727
|
+
# resp.computation_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
7728
|
+
# resp.computation_model_status.error.message #=> String
|
7729
|
+
# resp.computation_model_status.error.details #=> Array
|
7730
|
+
# resp.computation_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
7731
|
+
# resp.computation_model_status.error.details[0].message #=> String
|
7732
|
+
#
|
7733
|
+
# @overload update_computation_model(params = {})
|
7734
|
+
# @param [Hash] params ({})
|
7735
|
+
def update_computation_model(params = {}, options = {})
|
7736
|
+
req = build_request(:update_computation_model, params)
|
7737
|
+
req.send_request(options)
|
7738
|
+
end
|
7739
|
+
|
7098
7740
|
# Updates an IoT SiteWise Monitor dashboard.
|
7099
7741
|
#
|
7100
7742
|
# @option params [required, String] :dashboard_id
|
@@ -7178,7 +7820,7 @@ module Aws::IoTSiteWise
|
|
7178
7820
|
# @example Request syntax with placeholder values
|
7179
7821
|
#
|
7180
7822
|
# resp = client.update_dataset({
|
7181
|
-
# dataset_id: "
|
7823
|
+
# dataset_id: "ID", # required
|
7182
7824
|
# dataset_name: "RestrictedName", # required
|
7183
7825
|
# dataset_description: "RestrictedDescription",
|
7184
7826
|
# dataset_source: { # required
|
@@ -7238,25 +7880,42 @@ module Aws::IoTSiteWise
|
|
7238
7880
|
|
7239
7881
|
# Updates a gateway capability configuration or defines a new capability
|
7240
7882
|
# configuration. Each gateway capability defines data sources for a
|
7241
|
-
# gateway.
|
7242
|
-
#
|
7243
|
-
#
|
7244
|
-
#
|
7245
|
-
# gateway
|
7883
|
+
# gateway.
|
7884
|
+
#
|
7885
|
+
# Important workflow notes:
|
7886
|
+
#
|
7887
|
+
# Each gateway capability defines data sources for a gateway. This is
|
7888
|
+
# the namespace of the gateway capability.
|
7889
|
+
#
|
7890
|
+
# . The namespace follows the format `service:capability:version`,
|
7891
|
+
# where:
|
7892
|
+
#
|
7893
|
+
# * `service` - The service providing the capability, or `iotsitewise`.
|
7894
|
+
#
|
7895
|
+
# * `capability` - The specific capability type. Options include:
|
7896
|
+
# `opcuacollector` for the OPC UA data source collector, or
|
7897
|
+
# `publisher` for data publisher capability.
|
7246
7898
|
#
|
7899
|
+
# * `version` - The version number of the capability. Option include `2`
|
7900
|
+
# for Classic streams, V2 gateways, and `3` for MQTT-enabled, V3
|
7901
|
+
# gateways.
|
7247
7902
|
#
|
7903
|
+
# After updating a capability configuration, the sync status becomes
|
7904
|
+
# `OUT_OF_SYNC` until the gateway processes the configuration.Use
|
7905
|
+
# `DescribeGatewayCapabilityConfiguration` to check the sync status and
|
7906
|
+
# verify the configuration was applied.
|
7248
7907
|
#
|
7249
|
-
#
|
7908
|
+
# A gateway can have multiple capability configurations with different
|
7909
|
+
# namespaces.
|
7250
7910
|
#
|
7251
7911
|
# @option params [required, String] :gateway_id
|
7252
7912
|
# The ID of the gateway to be updated.
|
7253
7913
|
#
|
7254
7914
|
# @option params [required, String] :capability_namespace
|
7255
7915
|
# The namespace of the gateway capability configuration to be updated.
|
7256
|
-
# For example, if you configure OPC
|
7257
|
-
#
|
7258
|
-
# `iotsitewise:opcuacollector:
|
7259
|
-
# as `1`.
|
7916
|
+
# For example, if you configure OPC UA sources for an MQTT-enabled
|
7917
|
+
# gateway, your OPC-UA capability configuration has the namespace
|
7918
|
+
# `iotsitewise:opcuacollector:3`.
|
7260
7919
|
#
|
7261
7920
|
# @option params [required, String] :capability_configuration
|
7262
7921
|
# The JSON document that defines the configuration for the gateway
|
@@ -7458,7 +8117,7 @@ module Aws::IoTSiteWise
|
|
7458
8117
|
tracer: tracer
|
7459
8118
|
)
|
7460
8119
|
context[:gem_name] = 'aws-sdk-iotsitewise'
|
7461
|
-
context[:gem_version] = '1.
|
8120
|
+
context[:gem_version] = '1.89.0'
|
7462
8121
|
Seahorse::Client::Request.new(handlers, context)
|
7463
8122
|
end
|
7464
8123
|
|