aws-sdk-iotsitewise 1.88.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +734 -85
- 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 +220 -11
- data/sig/types.rbs +295 -12
- metadata +1 -1
@@ -1132,6 +1132,22 @@ module Aws::IoTSiteWise
|
|
1132
1132
|
#
|
1133
1133
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
1134
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
|
+
#
|
1135
1151
|
# @option params [String] :client_token
|
1136
1152
|
# A unique case-sensitive identifier that you can provide to ensure the
|
1137
1153
|
# idempotency of the request. Don't reuse this client token if a new
|
@@ -1152,22 +1168,6 @@ module Aws::IoTSiteWise
|
|
1152
1168
|
# @option params [String] :asset_description
|
1153
1169
|
# A description for the asset.
|
1154
1170
|
#
|
1155
|
-
# @option params [String] :asset_id
|
1156
|
-
# The ID to assign to the asset, if desired. IoT SiteWise automatically
|
1157
|
-
# generates a unique ID for you, so this parameter is never required.
|
1158
|
-
# However, if you prefer to supply your own ID instead, you can specify
|
1159
|
-
# it here in UUID format. If you specify your own ID, it must be
|
1160
|
-
# globally unique.
|
1161
|
-
#
|
1162
|
-
# @option params [String] :asset_external_id
|
1163
|
-
# An external ID to assign to the asset. The external ID must be unique
|
1164
|
-
# within your Amazon Web Services account. For more information, see
|
1165
|
-
# [Using external IDs][1] in the *IoT SiteWise User Guide*.
|
1166
|
-
#
|
1167
|
-
#
|
1168
|
-
#
|
1169
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
1170
|
-
#
|
1171
1171
|
# @return [Types::CreateAssetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1172
1172
|
#
|
1173
1173
|
# * {Types::CreateAssetResponse#asset_id #asset_id} => String
|
@@ -1179,13 +1179,13 @@ module Aws::IoTSiteWise
|
|
1179
1179
|
# resp = client.create_asset({
|
1180
1180
|
# asset_name: "Name", # required
|
1181
1181
|
# asset_model_id: "CustomID", # required
|
1182
|
+
# asset_id: "ID",
|
1183
|
+
# asset_external_id: "ExternalId",
|
1182
1184
|
# client_token: "ClientToken",
|
1183
1185
|
# tags: {
|
1184
1186
|
# "TagKey" => "TagValue",
|
1185
1187
|
# },
|
1186
1188
|
# asset_description: "Description",
|
1187
|
-
# asset_id: "ID",
|
1188
|
-
# asset_external_id: "ExternalId",
|
1189
1189
|
# })
|
1190
1190
|
#
|
1191
1191
|
# @example Response structure
|
@@ -1755,9 +1755,17 @@ module Aws::IoTSiteWise
|
|
1755
1755
|
# tier or IoT SiteWise cold tier. For more information about how to
|
1756
1756
|
# configure storage settings, see [PutStorageConfiguration][2].
|
1757
1757
|
#
|
1758
|
-
# Bulk import is designed to store historical data to IoT SiteWise.
|
1759
|
-
#
|
1760
|
-
#
|
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.
|
1761
1769
|
#
|
1762
1770
|
#
|
1763
1771
|
#
|
@@ -1843,6 +1851,97 @@ module Aws::IoTSiteWise
|
|
1843
1851
|
req.send_request(options)
|
1844
1852
|
end
|
1845
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
|
+
|
1846
1945
|
# Creates a dashboard in an IoT SiteWise Monitor project.
|
1847
1946
|
#
|
1848
1947
|
# @option params [required, String] :project_id
|
@@ -2010,18 +2109,24 @@ module Aws::IoTSiteWise
|
|
2010
2109
|
#
|
2011
2110
|
# @option params [String] :gateway_version
|
2012
2111
|
# The version of the gateway to create. Specify `3` to create an
|
2013
|
-
# MQTT-enabled, V3 gateway and `2`
|
2014
|
-
# gateway. If the
|
2015
|
-
# 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.
|
2119
|
+
#
|
2120
|
+
# </note>
|
2016
2121
|
#
|
2017
|
-
# We recommend creating an MQTT-enabled
|
2018
|
-
#
|
2019
|
-
#
|
2020
|
-
#
|
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].
|
2021
2126
|
#
|
2022
2127
|
#
|
2023
2128
|
#
|
2024
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/
|
2129
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html
|
2025
2130
|
#
|
2026
2131
|
# @option params [Hash<String,String>] :tags
|
2027
2132
|
# A list of key-value pairs that contain metadata for the gateway. For
|
@@ -2542,6 +2647,46 @@ module Aws::IoTSiteWise
|
|
2542
2647
|
req.send_request(options)
|
2543
2648
|
end
|
2544
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
|
+
|
2545
2690
|
# Deletes a dashboard from IoT SiteWise Monitor.
|
2546
2691
|
#
|
2547
2692
|
# @option params [required, String] :dashboard_id
|
@@ -2591,7 +2736,7 @@ module Aws::IoTSiteWise
|
|
2591
2736
|
# @example Request syntax with placeholder values
|
2592
2737
|
#
|
2593
2738
|
# resp = client.delete_dataset({
|
2594
|
-
# dataset_id: "
|
2739
|
+
# dataset_id: "ID", # required
|
2595
2740
|
# client_token: "ClientToken",
|
2596
2741
|
# })
|
2597
2742
|
#
|
@@ -2820,6 +2965,7 @@ module Aws::IoTSiteWise
|
|
2820
2965
|
# * {Types::DescribeActionResponse#action_definition_id #action_definition_id} => String
|
2821
2966
|
# * {Types::DescribeActionResponse#action_payload #action_payload} => Types::ActionPayload
|
2822
2967
|
# * {Types::DescribeActionResponse#execution_time #execution_time} => Time
|
2968
|
+
# * {Types::DescribeActionResponse#resolve_to #resolve_to} => Types::ResolveTo
|
2823
2969
|
#
|
2824
2970
|
# @example Request syntax with placeholder values
|
2825
2971
|
#
|
@@ -2831,9 +2977,11 @@ module Aws::IoTSiteWise
|
|
2831
2977
|
#
|
2832
2978
|
# resp.action_id #=> String
|
2833
2979
|
# resp.target_resource.asset_id #=> String
|
2980
|
+
# resp.target_resource.computation_model_id #=> String
|
2834
2981
|
# resp.action_definition_id #=> String
|
2835
2982
|
# resp.action_payload.string_value #=> String
|
2836
2983
|
# resp.execution_time #=> Time
|
2984
|
+
# resp.resolve_to.asset_id #=> String
|
2837
2985
|
#
|
2838
2986
|
# @overload describe_action(params = {})
|
2839
2987
|
# @param [Hash] params ({})
|
@@ -2860,6 +3008,7 @@ module Aws::IoTSiteWise
|
|
2860
3008
|
# @return [Types::DescribeAssetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2861
3009
|
#
|
2862
3010
|
# * {Types::DescribeAssetResponse#asset_id #asset_id} => String
|
3011
|
+
# * {Types::DescribeAssetResponse#asset_external_id #asset_external_id} => String
|
2863
3012
|
# * {Types::DescribeAssetResponse#asset_arn #asset_arn} => String
|
2864
3013
|
# * {Types::DescribeAssetResponse#asset_name #asset_name} => String
|
2865
3014
|
# * {Types::DescribeAssetResponse#asset_model_id #asset_model_id} => String
|
@@ -2871,7 +3020,6 @@ module Aws::IoTSiteWise
|
|
2871
3020
|
# * {Types::DescribeAssetResponse#asset_status #asset_status} => Types::AssetStatus
|
2872
3021
|
# * {Types::DescribeAssetResponse#asset_description #asset_description} => String
|
2873
3022
|
# * {Types::DescribeAssetResponse#asset_composite_model_summaries #asset_composite_model_summaries} => Array<Types::AssetCompositeModelSummary>
|
2874
|
-
# * {Types::DescribeAssetResponse#asset_external_id #asset_external_id} => String
|
2875
3023
|
#
|
2876
3024
|
# @example Request syntax with placeholder values
|
2877
3025
|
#
|
@@ -2883,11 +3031,13 @@ module Aws::IoTSiteWise
|
|
2883
3031
|
# @example Response structure
|
2884
3032
|
#
|
2885
3033
|
# resp.asset_id #=> String
|
3034
|
+
# resp.asset_external_id #=> String
|
2886
3035
|
# resp.asset_arn #=> String
|
2887
3036
|
# resp.asset_name #=> String
|
2888
3037
|
# resp.asset_model_id #=> String
|
2889
3038
|
# resp.asset_properties #=> Array
|
2890
3039
|
# resp.asset_properties[0].id #=> String
|
3040
|
+
# resp.asset_properties[0].external_id #=> String
|
2891
3041
|
# resp.asset_properties[0].name #=> String
|
2892
3042
|
# resp.asset_properties[0].alias #=> String
|
2893
3043
|
# resp.asset_properties[0].notification.topic #=> String
|
@@ -2898,17 +3048,17 @@ module Aws::IoTSiteWise
|
|
2898
3048
|
# resp.asset_properties[0].path #=> Array
|
2899
3049
|
# resp.asset_properties[0].path[0].id #=> String
|
2900
3050
|
# resp.asset_properties[0].path[0].name #=> String
|
2901
|
-
# resp.asset_properties[0].external_id #=> String
|
2902
3051
|
# resp.asset_hierarchies #=> Array
|
2903
3052
|
# resp.asset_hierarchies[0].id #=> String
|
2904
|
-
# resp.asset_hierarchies[0].name #=> String
|
2905
3053
|
# resp.asset_hierarchies[0].external_id #=> String
|
3054
|
+
# resp.asset_hierarchies[0].name #=> String
|
2906
3055
|
# resp.asset_composite_models #=> Array
|
2907
3056
|
# resp.asset_composite_models[0].name #=> String
|
2908
3057
|
# resp.asset_composite_models[0].description #=> String
|
2909
3058
|
# resp.asset_composite_models[0].type #=> String
|
2910
3059
|
# resp.asset_composite_models[0].properties #=> Array
|
2911
3060
|
# resp.asset_composite_models[0].properties[0].id #=> String
|
3061
|
+
# resp.asset_composite_models[0].properties[0].external_id #=> String
|
2912
3062
|
# resp.asset_composite_models[0].properties[0].name #=> String
|
2913
3063
|
# resp.asset_composite_models[0].properties[0].alias #=> String
|
2914
3064
|
# resp.asset_composite_models[0].properties[0].notification.topic #=> String
|
@@ -2919,7 +3069,6 @@ module Aws::IoTSiteWise
|
|
2919
3069
|
# resp.asset_composite_models[0].properties[0].path #=> Array
|
2920
3070
|
# resp.asset_composite_models[0].properties[0].path[0].id #=> String
|
2921
3071
|
# resp.asset_composite_models[0].properties[0].path[0].name #=> String
|
2922
|
-
# resp.asset_composite_models[0].properties[0].external_id #=> String
|
2923
3072
|
# resp.asset_composite_models[0].id #=> String
|
2924
3073
|
# resp.asset_composite_models[0].external_id #=> String
|
2925
3074
|
# resp.asset_creation_date #=> Time
|
@@ -2940,7 +3089,6 @@ module Aws::IoTSiteWise
|
|
2940
3089
|
# resp.asset_composite_model_summaries[0].path #=> Array
|
2941
3090
|
# resp.asset_composite_model_summaries[0].path[0].id #=> String
|
2942
3091
|
# resp.asset_composite_model_summaries[0].path[0].name #=> String
|
2943
|
-
# resp.asset_external_id #=> String
|
2944
3092
|
#
|
2945
3093
|
#
|
2946
3094
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -3017,6 +3165,7 @@ module Aws::IoTSiteWise
|
|
3017
3165
|
# resp.asset_composite_model_type #=> String
|
3018
3166
|
# resp.asset_composite_model_properties #=> Array
|
3019
3167
|
# resp.asset_composite_model_properties[0].id #=> String
|
3168
|
+
# resp.asset_composite_model_properties[0].external_id #=> String
|
3020
3169
|
# resp.asset_composite_model_properties[0].name #=> String
|
3021
3170
|
# resp.asset_composite_model_properties[0].alias #=> String
|
3022
3171
|
# resp.asset_composite_model_properties[0].notification.topic #=> String
|
@@ -3027,7 +3176,6 @@ module Aws::IoTSiteWise
|
|
3027
3176
|
# resp.asset_composite_model_properties[0].path #=> Array
|
3028
3177
|
# resp.asset_composite_model_properties[0].path[0].id #=> String
|
3029
3178
|
# resp.asset_composite_model_properties[0].path[0].name #=> String
|
3030
|
-
# resp.asset_composite_model_properties[0].external_id #=> String
|
3031
3179
|
# resp.asset_composite_model_summaries #=> Array
|
3032
3180
|
# resp.asset_composite_model_summaries[0].id #=> String
|
3033
3181
|
# resp.asset_composite_model_summaries[0].external_id #=> String
|
@@ -3384,11 +3532,11 @@ module Aws::IoTSiteWise
|
|
3384
3532
|
# @return [Types::DescribeAssetPropertyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3385
3533
|
#
|
3386
3534
|
# * {Types::DescribeAssetPropertyResponse#asset_id #asset_id} => String
|
3535
|
+
# * {Types::DescribeAssetPropertyResponse#asset_external_id #asset_external_id} => String
|
3387
3536
|
# * {Types::DescribeAssetPropertyResponse#asset_name #asset_name} => String
|
3388
3537
|
# * {Types::DescribeAssetPropertyResponse#asset_model_id #asset_model_id} => String
|
3389
3538
|
# * {Types::DescribeAssetPropertyResponse#asset_property #asset_property} => Types::Property
|
3390
3539
|
# * {Types::DescribeAssetPropertyResponse#composite_model #composite_model} => Types::CompositeModelProperty
|
3391
|
-
# * {Types::DescribeAssetPropertyResponse#asset_external_id #asset_external_id} => String
|
3392
3540
|
#
|
3393
3541
|
# @example Request syntax with placeholder values
|
3394
3542
|
#
|
@@ -3400,9 +3548,11 @@ module Aws::IoTSiteWise
|
|
3400
3548
|
# @example Response structure
|
3401
3549
|
#
|
3402
3550
|
# resp.asset_id #=> String
|
3551
|
+
# resp.asset_external_id #=> String
|
3403
3552
|
# resp.asset_name #=> String
|
3404
3553
|
# resp.asset_model_id #=> String
|
3405
3554
|
# resp.asset_property.id #=> String
|
3555
|
+
# resp.asset_property.external_id #=> String
|
3406
3556
|
# resp.asset_property.name #=> String
|
3407
3557
|
# resp.asset_property.alias #=> String
|
3408
3558
|
# resp.asset_property.notification.topic #=> String
|
@@ -3435,10 +3585,10 @@ module Aws::IoTSiteWise
|
|
3435
3585
|
# resp.asset_property.path #=> Array
|
3436
3586
|
# resp.asset_property.path[0].id #=> String
|
3437
3587
|
# resp.asset_property.path[0].name #=> String
|
3438
|
-
# resp.asset_property.external_id #=> String
|
3439
3588
|
# resp.composite_model.name #=> String
|
3440
3589
|
# resp.composite_model.type #=> String
|
3441
3590
|
# resp.composite_model.asset_property.id #=> String
|
3591
|
+
# resp.composite_model.asset_property.external_id #=> String
|
3442
3592
|
# resp.composite_model.asset_property.name #=> String
|
3443
3593
|
# resp.composite_model.asset_property.alias #=> String
|
3444
3594
|
# resp.composite_model.asset_property.notification.topic #=> String
|
@@ -3471,10 +3621,8 @@ module Aws::IoTSiteWise
|
|
3471
3621
|
# resp.composite_model.asset_property.path #=> Array
|
3472
3622
|
# resp.composite_model.asset_property.path[0].id #=> String
|
3473
3623
|
# resp.composite_model.asset_property.path[0].name #=> String
|
3474
|
-
# resp.composite_model.asset_property.external_id #=> String
|
3475
3624
|
# resp.composite_model.id #=> String
|
3476
3625
|
# resp.composite_model.external_id #=> String
|
3477
|
-
# resp.asset_external_id #=> String
|
3478
3626
|
#
|
3479
3627
|
# @overload describe_asset_property(params = {})
|
3480
3628
|
# @param [Hash] params ({})
|
@@ -3540,6 +3688,107 @@ module Aws::IoTSiteWise
|
|
3540
3688
|
req.send_request(options)
|
3541
3689
|
end
|
3542
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
|
+
|
3543
3792
|
# Retrieves information about a dashboard.
|
3544
3793
|
#
|
3545
3794
|
# @option params [required, String] :dashboard_id
|
@@ -3600,7 +3849,7 @@ module Aws::IoTSiteWise
|
|
3600
3849
|
# @example Request syntax with placeholder values
|
3601
3850
|
#
|
3602
3851
|
# resp = client.describe_dataset({
|
3603
|
-
# dataset_id: "
|
3852
|
+
# dataset_id: "ID", # required
|
3604
3853
|
# })
|
3605
3854
|
#
|
3606
3855
|
# @example Response structure
|
@@ -3660,6 +3909,55 @@ module Aws::IoTSiteWise
|
|
3660
3909
|
req.send_request(options)
|
3661
3910
|
end
|
3662
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
|
+
|
3663
3961
|
# Retrieves information about a gateway.
|
3664
3962
|
#
|
3665
3963
|
# @option params [required, String] :gateway_id
|
@@ -3705,27 +4003,38 @@ module Aws::IoTSiteWise
|
|
3705
4003
|
req.send_request(options)
|
3706
4004
|
end
|
3707
4005
|
|
3708
|
-
#
|
3709
|
-
#
|
3710
|
-
# configuration can contain multiple data source configurations. If you
|
3711
|
-
# define OPC-UA sources for a gateway in the IoT SiteWise console, all
|
3712
|
-
# of your OPC-UA sources are stored in one capability configuration. To
|
3713
|
-
# list all capability configurations for a gateway, use
|
3714
|
-
# [DescribeGateway][1].
|
4006
|
+
# Each gateway capability defines data sources for a gateway. This is
|
4007
|
+
# the namespace of the gateway capability.
|
3715
4008
|
#
|
4009
|
+
# . The namespace follows the format `service:capability:version`,
|
4010
|
+
# where:
|
3716
4011
|
#
|
4012
|
+
# * `service` - The service providing the capability, or `iotsitewise`.
|
3717
4013
|
#
|
3718
|
-
#
|
4014
|
+
# * `capability` - The specific capability type. Options include:
|
4015
|
+
# `opcuacollector` for the OPC UA data source collector, or
|
4016
|
+
# `publisher` for data publisher capability.
|
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.
|
4021
|
+
#
|
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.
|
3719
4029
|
#
|
3720
4030
|
# @option params [required, String] :gateway_id
|
3721
4031
|
# The ID of the gateway that defines the capability configuration.
|
3722
4032
|
#
|
3723
4033
|
# @option params [required, String] :capability_namespace
|
3724
4034
|
# The namespace of the capability configuration. For example, if you
|
3725
|
-
# configure OPC
|
4035
|
+
# configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA
|
3726
4036
|
# capability configuration has the namespace
|
3727
|
-
# `iotsitewise:opcuacollector:
|
3728
|
-
# as `1`.
|
4037
|
+
# `iotsitewise:opcuacollector:3`.
|
3729
4038
|
#
|
3730
4039
|
# @return [Types::DescribeGatewayCapabilityConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3731
4040
|
#
|
@@ -4129,6 +4438,9 @@ module Aws::IoTSiteWise
|
|
4129
4438
|
# idempotency of the request. Don't reuse this client token if a new
|
4130
4439
|
# idempotent request is required.
|
4131
4440
|
#
|
4441
|
+
# @option params [Types::ResolveTo] :resolve_to
|
4442
|
+
# The detailed resource this action resolves to.
|
4443
|
+
#
|
4132
4444
|
# @return [Types::ExecuteActionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4133
4445
|
#
|
4134
4446
|
# * {Types::ExecuteActionResponse#action_id #action_id} => String
|
@@ -4137,13 +4449,17 @@ module Aws::IoTSiteWise
|
|
4137
4449
|
#
|
4138
4450
|
# resp = client.execute_action({
|
4139
4451
|
# target_resource: { # required
|
4140
|
-
# asset_id: "
|
4452
|
+
# asset_id: "ID",
|
4453
|
+
# computation_model_id: "ID",
|
4141
4454
|
# },
|
4142
4455
|
# action_definition_id: "ID", # required
|
4143
4456
|
# action_payload: { # required
|
4144
4457
|
# string_value: "ActionPayloadString", # required
|
4145
4458
|
# },
|
4146
4459
|
# client_token: "ClientToken",
|
4460
|
+
# resolve_to: {
|
4461
|
+
# asset_id: "ID", # required
|
4462
|
+
# },
|
4147
4463
|
# })
|
4148
4464
|
#
|
4149
4465
|
# @example Response structure
|
@@ -4167,8 +4483,13 @@ module Aws::IoTSiteWise
|
|
4167
4483
|
# The string that specifies the next page of results.
|
4168
4484
|
#
|
4169
4485
|
# @option params [Integer] :max_results
|
4170
|
-
# The maximum number of results to return at one time.
|
4171
|
-
#
|
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
|
4172
4493
|
#
|
4173
4494
|
# @option params [String] :client_token
|
4174
4495
|
# A unique case-sensitive identifier that you can provide to ensure the
|
@@ -5011,6 +5332,12 @@ module Aws::IoTSiteWise
|
|
5011
5332
|
# @option params [Integer] :max_results
|
5012
5333
|
# The maximum number of results to return for each paginated request.
|
5013
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
|
+
#
|
5014
5341
|
# @return [Types::ListActionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5015
5342
|
#
|
5016
5343
|
# * {Types::ListActionsResponse#action_summaries #action_summaries} => Array<Types::ActionSummary>
|
@@ -5021,10 +5348,12 @@ module Aws::IoTSiteWise
|
|
5021
5348
|
# @example Request syntax with placeholder values
|
5022
5349
|
#
|
5023
5350
|
# resp = client.list_actions({
|
5024
|
-
# target_resource_type: "ASSET", # required, accepts ASSET
|
5025
|
-
# target_resource_id: "
|
5351
|
+
# target_resource_type: "ASSET", # required, accepts ASSET, COMPUTATION_MODEL
|
5352
|
+
# target_resource_id: "ID", # required
|
5026
5353
|
# next_token: "NextToken",
|
5027
5354
|
# max_results: 1,
|
5355
|
+
# resolve_to_resource_type: "ASSET", # accepts ASSET
|
5356
|
+
# resolve_to_resource_id: "ID",
|
5028
5357
|
# })
|
5029
5358
|
#
|
5030
5359
|
# @example Response structure
|
@@ -5033,6 +5362,8 @@ module Aws::IoTSiteWise
|
|
5033
5362
|
# resp.action_summaries[0].action_id #=> String
|
5034
5363
|
# resp.action_summaries[0].action_definition_id #=> String
|
5035
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
|
5036
5367
|
# resp.next_token #=> String
|
5037
5368
|
#
|
5038
5369
|
# @overload list_actions(params = {})
|
@@ -5341,6 +5672,7 @@ module Aws::IoTSiteWise
|
|
5341
5672
|
#
|
5342
5673
|
# resp.asset_property_summaries #=> Array
|
5343
5674
|
# resp.asset_property_summaries[0].id #=> String
|
5675
|
+
# resp.asset_property_summaries[0].external_id #=> String
|
5344
5676
|
# resp.asset_property_summaries[0].alias #=> String
|
5345
5677
|
# resp.asset_property_summaries[0].unit #=> String
|
5346
5678
|
# resp.asset_property_summaries[0].notification.topic #=> String
|
@@ -5349,7 +5681,6 @@ module Aws::IoTSiteWise
|
|
5349
5681
|
# resp.asset_property_summaries[0].path #=> Array
|
5350
5682
|
# resp.asset_property_summaries[0].path[0].id #=> String
|
5351
5683
|
# resp.asset_property_summaries[0].path[0].name #=> String
|
5352
|
-
# resp.asset_property_summaries[0].external_id #=> String
|
5353
5684
|
# resp.next_token #=> String
|
5354
5685
|
#
|
5355
5686
|
# @overload list_asset_properties(params = {})
|
@@ -5489,6 +5820,7 @@ module Aws::IoTSiteWise
|
|
5489
5820
|
#
|
5490
5821
|
# resp.asset_summaries #=> Array
|
5491
5822
|
# resp.asset_summaries[0].id #=> String
|
5823
|
+
# resp.asset_summaries[0].external_id #=> String
|
5492
5824
|
# resp.asset_summaries[0].arn #=> String
|
5493
5825
|
# resp.asset_summaries[0].name #=> String
|
5494
5826
|
# resp.asset_summaries[0].asset_model_id #=> String
|
@@ -5502,10 +5834,9 @@ module Aws::IoTSiteWise
|
|
5502
5834
|
# resp.asset_summaries[0].status.error.details[0].message #=> String
|
5503
5835
|
# resp.asset_summaries[0].hierarchies #=> Array
|
5504
5836
|
# resp.asset_summaries[0].hierarchies[0].id #=> String
|
5505
|
-
# resp.asset_summaries[0].hierarchies[0].name #=> String
|
5506
5837
|
# resp.asset_summaries[0].hierarchies[0].external_id #=> String
|
5838
|
+
# resp.asset_summaries[0].hierarchies[0].name #=> String
|
5507
5839
|
# resp.asset_summaries[0].description #=> String
|
5508
|
-
# resp.asset_summaries[0].external_id #=> String
|
5509
5840
|
# resp.next_token #=> String
|
5510
5841
|
#
|
5511
5842
|
# @overload list_assets(params = {})
|
@@ -5591,6 +5922,7 @@ module Aws::IoTSiteWise
|
|
5591
5922
|
#
|
5592
5923
|
# resp.asset_summaries #=> Array
|
5593
5924
|
# resp.asset_summaries[0].id #=> String
|
5925
|
+
# resp.asset_summaries[0].external_id #=> String
|
5594
5926
|
# resp.asset_summaries[0].arn #=> String
|
5595
5927
|
# resp.asset_summaries[0].name #=> String
|
5596
5928
|
# resp.asset_summaries[0].asset_model_id #=> String
|
@@ -5604,10 +5936,9 @@ module Aws::IoTSiteWise
|
|
5604
5936
|
# resp.asset_summaries[0].status.error.details[0].message #=> String
|
5605
5937
|
# resp.asset_summaries[0].hierarchies #=> Array
|
5606
5938
|
# resp.asset_summaries[0].hierarchies[0].id #=> String
|
5607
|
-
# resp.asset_summaries[0].hierarchies[0].name #=> String
|
5608
5939
|
# resp.asset_summaries[0].hierarchies[0].external_id #=> String
|
5940
|
+
# resp.asset_summaries[0].hierarchies[0].name #=> String
|
5609
5941
|
# resp.asset_summaries[0].description #=> String
|
5610
|
-
# resp.asset_summaries[0].external_id #=> String
|
5611
5942
|
# resp.next_token #=> String
|
5612
5943
|
#
|
5613
5944
|
# @overload list_associated_assets(params = {})
|
@@ -5716,6 +6047,164 @@ module Aws::IoTSiteWise
|
|
5716
6047
|
req.send_request(options)
|
5717
6048
|
end
|
5718
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
|
+
|
5719
6208
|
# Retrieves a paginated list of dashboards for an IoT SiteWise Monitor
|
5720
6209
|
# project.
|
5721
6210
|
#
|
@@ -5813,6 +6302,70 @@ module Aws::IoTSiteWise
|
|
5813
6302
|
req.send_request(options)
|
5814
6303
|
end
|
5815
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
|
+
|
5816
6369
|
# Retrieves a paginated list of gateways.
|
5817
6370
|
#
|
5818
6371
|
# @option params [String] :next_token
|
@@ -6423,6 +6976,16 @@ module Aws::IoTSiteWise
|
|
6423
6976
|
#
|
6424
6977
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
|
6425
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
|
+
#
|
6426
6989
|
# @option params [required, String] :asset_name
|
6427
6990
|
# A friendly name for the asset.
|
6428
6991
|
#
|
@@ -6437,16 +7000,6 @@ module Aws::IoTSiteWise
|
|
6437
7000
|
# @option params [String] :asset_description
|
6438
7001
|
# A description for the asset.
|
6439
7002
|
#
|
6440
|
-
# @option params [String] :asset_external_id
|
6441
|
-
# An external ID to assign to the asset. The asset must not already have
|
6442
|
-
# an external ID. The external ID must be unique within your Amazon Web
|
6443
|
-
# Services account. For more information, see [Using external IDs][1] in
|
6444
|
-
# the *IoT SiteWise User Guide*.
|
6445
|
-
#
|
6446
|
-
#
|
6447
|
-
#
|
6448
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
|
6449
|
-
#
|
6450
7003
|
# @return [Types::UpdateAssetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6451
7004
|
#
|
6452
7005
|
# * {Types::UpdateAssetResponse#asset_status #asset_status} => Types::AssetStatus
|
@@ -6455,10 +7008,10 @@ module Aws::IoTSiteWise
|
|
6455
7008
|
#
|
6456
7009
|
# resp = client.update_asset({
|
6457
7010
|
# asset_id: "CustomID", # required
|
7011
|
+
# asset_external_id: "ExternalId",
|
6458
7012
|
# asset_name: "Name", # required
|
6459
7013
|
# client_token: "ClientToken",
|
6460
7014
|
# asset_description: "Description",
|
6461
|
-
# asset_external_id: "ExternalId",
|
6462
7015
|
# })
|
6463
7016
|
#
|
6464
7017
|
# @example Response structure
|
@@ -7105,6 +7658,85 @@ module Aws::IoTSiteWise
|
|
7105
7658
|
req.send_request(options)
|
7106
7659
|
end
|
7107
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
|
+
|
7108
7740
|
# Updates an IoT SiteWise Monitor dashboard.
|
7109
7741
|
#
|
7110
7742
|
# @option params [required, String] :dashboard_id
|
@@ -7188,7 +7820,7 @@ module Aws::IoTSiteWise
|
|
7188
7820
|
# @example Request syntax with placeholder values
|
7189
7821
|
#
|
7190
7822
|
# resp = client.update_dataset({
|
7191
|
-
# dataset_id: "
|
7823
|
+
# dataset_id: "ID", # required
|
7192
7824
|
# dataset_name: "RestrictedName", # required
|
7193
7825
|
# dataset_description: "RestrictedDescription",
|
7194
7826
|
# dataset_source: { # required
|
@@ -7248,25 +7880,42 @@ module Aws::IoTSiteWise
|
|
7248
7880
|
|
7249
7881
|
# Updates a gateway capability configuration or defines a new capability
|
7250
7882
|
# configuration. Each gateway capability defines data sources for a
|
7251
|
-
# gateway.
|
7252
|
-
#
|
7253
|
-
#
|
7254
|
-
#
|
7255
|
-
# 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.
|
7256
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.
|
7257
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.
|
7258
7907
|
#
|
7259
|
-
#
|
7908
|
+
# A gateway can have multiple capability configurations with different
|
7909
|
+
# namespaces.
|
7260
7910
|
#
|
7261
7911
|
# @option params [required, String] :gateway_id
|
7262
7912
|
# The ID of the gateway to be updated.
|
7263
7913
|
#
|
7264
7914
|
# @option params [required, String] :capability_namespace
|
7265
7915
|
# The namespace of the gateway capability configuration to be updated.
|
7266
|
-
# For example, if you configure OPC
|
7267
|
-
#
|
7268
|
-
# `iotsitewise:opcuacollector:
|
7269
|
-
# 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`.
|
7270
7919
|
#
|
7271
7920
|
# @option params [required, String] :capability_configuration
|
7272
7921
|
# The JSON document that defines the configuration for the gateway
|
@@ -7468,7 +8117,7 @@ module Aws::IoTSiteWise
|
|
7468
8117
|
tracer: tracer
|
7469
8118
|
)
|
7470
8119
|
context[:gem_name] = 'aws-sdk-iotsitewise'
|
7471
|
-
context[:gem_version] = '1.
|
8120
|
+
context[:gem_version] = '1.89.0'
|
7472
8121
|
Seahorse::Client::Request.new(handlers, context)
|
7473
8122
|
end
|
7474
8123
|
|