aws-sdk-iotsitewise 1.1.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6b71fb297dca1f5c27b4fa03e819a10d32513f61607be90c069bf0847a6f9883
4
- data.tar.gz: 36d52e90e0d649458ac48e41e03ff5e96945afe9976db1e73edde66b2e8c9320
3
+ metadata.gz: a7f1282ff64d79f66469f819e3986300bb9669bd64a2f012807e0b3c60eedd10
4
+ data.tar.gz: 2ca7198cb2c521305da1deeb8b096d26de26cb3c6a3c5d4ebec08fcf7b23f5bc
5
5
  SHA512:
6
- metadata.gz: bd598a1ec1ba2f94c7608a7b7bf0e150a1ef9a3cc9d88656378fa8d315b9d53546a8a0156326bf2ae1faae3d4ce798afd0cb31140c8bb9c5a50d166a19d672b2
7
- data.tar.gz: 8d8d98ddcb1d58922698c47f4868bec090f5c052a291a540e377d1502334734678f985bf926144ddef283958d283ad80bf46fed86e6ba549e97051f40861fa8d
6
+ metadata.gz: 34bd2911b7bcbd69b65b11a673482a64facd6acebbf006d99a7f9ad485fb82ec6861a68565cc1dcacf1ee338b0941df295e6ff5585dfe0d0bb72f71057ae6334
7
+ data.tar.gz: 145b4d77c14a506468e0467eeca241e329099d9319d069d94436804920e802a22cf73765b9a05efa7ecadc80758643ed401f0085df01759d587bf2a2b91da154
@@ -46,6 +46,6 @@ require_relative 'aws-sdk-iotsitewise/customizations'
46
46
  # @service
47
47
  module Aws::IoTSiteWise
48
48
 
49
- GEM_VERSION = '1.1.0'
49
+ GEM_VERSION = '1.2.0'
50
50
 
51
51
  end
@@ -475,12 +475,7 @@ module Aws::IoTSiteWise
475
475
  #
476
476
  # @option params [required, Array<Types::PutAssetPropertyValueEntry>] :entries
477
477
  # The list of asset property value entries for the batch put request.
478
- # You can specify up to 10 entries per request. For more information,
479
- # see [Quotas][1] in the *AWS IoT SiteWise User Guide*.
480
- #
481
- #
482
- #
483
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
478
+ # You can specify up to 10 entries per request.
484
479
  #
485
480
  # @return [Types::BatchPutAssetPropertyValueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
486
481
  #
@@ -2216,6 +2211,21 @@ module Aws::IoTSiteWise
2216
2211
 
2217
2212
  # Retrieves a paginated list of asset summaries.
2218
2213
  #
2214
+ # You can use this operation to do the following:
2215
+ #
2216
+ # * List assets based on a specific asset model.
2217
+ #
2218
+ # * List top-level assets.
2219
+ #
2220
+ # You can't use this operation to list all assets. To retrieve
2221
+ # summaries for all of your assets, use [ListAssetModels][1] to get all
2222
+ # of your asset model IDs. Then, use ListAssets to get all assets for
2223
+ # each asset model.
2224
+ #
2225
+ #
2226
+ #
2227
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssetModels.html
2228
+ #
2219
2229
  # @option params [String] :next_token
2220
2230
  # The token to be used for the next set of paginated results.
2221
2231
  #
@@ -2223,11 +2233,18 @@ module Aws::IoTSiteWise
2223
2233
  # The maximum number of results to be returned per paginated request.
2224
2234
  #
2225
2235
  # @option params [String] :asset_model_id
2226
- # The ID of the asset model by which to filter the list of assets. Omit
2227
- # the `assetModelId` to list all assets (of all models).
2236
+ # The ID of the asset model by which to filter the list of assets. This
2237
+ # parameter is required if you choose `ALL` for `filter`.
2228
2238
  #
2229
2239
  # @option params [String] :filter
2230
- # The hierarchy level by which to filter the requested list of assets.
2240
+ # The filter for the requested list of assets. Choose one of the
2241
+ # following options. Defaults to `ALL`.
2242
+ #
2243
+ # * `ALL` – The list includes all assets for a given asset model ID. The
2244
+ # `assetModelId` parameter is required if you filter by `ALL`.
2245
+ #
2246
+ # * `TOP_LEVEL` – The list includes only top-level assets in the asset
2247
+ # hierarchy tree.
2231
2248
  #
2232
2249
  # @return [Types::ListAssetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2233
2250
  #
@@ -2777,8 +2794,8 @@ module Aws::IoTSiteWise
2777
2794
  #
2778
2795
  # This action overwrites the existing model with the provided model. To
2779
2796
  # avoid deleting your asset model's properties or hierarchies, you must
2780
- # include their definitions in the updated asset model payload. For more
2781
- # information, see [DescribeAssetModel][2].
2797
+ # include their IDs and definitions in the updated asset model payload.
2798
+ # For more information, see [DescribeAssetModel][2].
2782
2799
  #
2783
2800
  # If you remove a property from an asset model or update a property's
2784
2801
  # formula expression, AWS IoT SiteWise deletes all previous data for
@@ -2915,6 +2932,16 @@ module Aws::IoTSiteWise
2915
2932
 
2916
2933
  # Updates an asset property's alias and notification state.
2917
2934
  #
2935
+ # This operation overwrites the property's existing alias and
2936
+ # notification state. To keep your existing property's alias or
2937
+ # notification state, you must include the existing values in the
2938
+ # UpdateAssetProperty request. For more information, see
2939
+ # [DescribeAssetProperty][1].
2940
+ #
2941
+ #
2942
+ #
2943
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetProperty.html
2944
+ #
2918
2945
  # @option params [required, String] :asset_id
2919
2946
  # The ID of the asset to be updated.
2920
2947
  #
@@ -2928,16 +2955,21 @@ module Aws::IoTSiteWise
2928
2955
  # see [Mapping Industrial Data Streams to Asset Properties][1] in the
2929
2956
  # *AWS IoT SiteWise User Guide*.
2930
2957
  #
2958
+ # If you omit this parameter, the alias is removed from the property.
2959
+ #
2931
2960
  #
2932
2961
  #
2933
2962
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
2934
2963
  #
2935
2964
  # @option params [String] :property_notification_state
2936
- # The updated MQTT notification state (enabled or disabled) for this
2937
- # asset property. When the notification state is enabled, AWS IoT
2938
- # SiteWise publishes property value updates to a unique MQTT topic. For
2939
- # more information, see [Interacting with Other Services][1] in the *AWS
2940
- # IoT SiteWise User Guide*.
2965
+ # The MQTT notification state (enabled or disabled) for this asset
2966
+ # property. When the notification state is enabled, AWS IoT SiteWise
2967
+ # publishes property value updates to a unique MQTT topic. For more
2968
+ # information, see [Interacting with Other Services][1] in the *AWS IoT
2969
+ # SiteWise User Guide*.
2970
+ #
2971
+ # If you omit this parameter, the notification state is set to
2972
+ # `DISABLED`.
2941
2973
  #
2942
2974
  #
2943
2975
  #
@@ -3216,7 +3248,7 @@ module Aws::IoTSiteWise
3216
3248
  params: params,
3217
3249
  config: config)
3218
3250
  context[:gem_name] = 'aws-sdk-iotsitewise'
3219
- context[:gem_version] = '1.1.0'
3251
+ context[:gem_version] = '1.2.0'
3220
3252
  Seahorse::Client::Request.new(handlers, context)
3221
3253
  end
3222
3254
 
@@ -887,12 +887,7 @@ module Aws::IoTSiteWise
887
887
  #
888
888
  # @!attribute [rw] entries
889
889
  # The list of asset property value entries for the batch put request.
890
- # You can specify up to 10 entries per request. For more information,
891
- # see [Quotas][1] in the *AWS IoT SiteWise User Guide*.
892
- #
893
- #
894
- #
895
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
890
+ # You can specify up to 10 entries per request.
896
891
  # @return [Array<Types::PutAssetPropertyValueEntry>]
897
892
  #
898
893
  class BatchPutAssetPropertyValueRequest < Struct.new(
@@ -3167,11 +3162,18 @@ module Aws::IoTSiteWise
3167
3162
  #
3168
3163
  # @!attribute [rw] asset_model_id
3169
3164
  # The ID of the asset model by which to filter the list of assets.
3170
- # Omit the `assetModelId` to list all assets (of all models).
3165
+ # This parameter is required if you choose `ALL` for `filter`.
3171
3166
  # @return [String]
3172
3167
  #
3173
3168
  # @!attribute [rw] filter
3174
- # The hierarchy level by which to filter the requested list of assets.
3169
+ # The filter for the requested list of assets. Choose one of the
3170
+ # following options. Defaults to `ALL`.
3171
+ #
3172
+ # * `ALL` – The list includes all assets for a given asset model ID.
3173
+ # The `assetModelId` parameter is required if you filter by `ALL`.
3174
+ #
3175
+ # * `TOP_LEVEL` – The list includes only top-level assets in the asset
3176
+ # hierarchy tree.
3175
3177
  # @return [String]
3176
3178
  #
3177
3179
  class ListAssetsRequest < Struct.new(
@@ -3986,13 +3988,6 @@ module Aws::IoTSiteWise
3986
3988
  # @!attribute [rw] property_values
3987
3989
  # The list of property values to upload. You can specify up to 10
3988
3990
  # `propertyValues` array elements.
3989
- #
3990
- # For more information, see [Quotas][1] in the *AWS IoT SiteWise User
3991
- # Guide*.
3992
- #
3993
- #
3994
- #
3995
- # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
3996
3991
  # @return [Array<Types::AssetPropertyValue>]
3997
3992
  #
3998
3993
  class PutAssetPropertyValueEntry < Struct.new(
@@ -4527,17 +4522,22 @@ module Aws::IoTSiteWise
4527
4522
  # see [Mapping Industrial Data Streams to Asset Properties][1] in the
4528
4523
  # *AWS IoT SiteWise User Guide*.
4529
4524
  #
4525
+ # If you omit this parameter, the alias is removed from the property.
4526
+ #
4530
4527
  #
4531
4528
  #
4532
4529
  # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
4533
4530
  # @return [String]
4534
4531
  #
4535
4532
  # @!attribute [rw] property_notification_state
4536
- # The updated MQTT notification state (enabled or disabled) for this
4537
- # asset property. When the notification state is enabled, AWS IoT
4538
- # SiteWise publishes property value updates to a unique MQTT topic.
4539
- # For more information, see [Interacting with Other Services][1] in
4540
- # the *AWS IoT SiteWise User Guide*.
4533
+ # The MQTT notification state (enabled or disabled) for this asset
4534
+ # property. When the notification state is enabled, AWS IoT SiteWise
4535
+ # publishes property value updates to a unique MQTT topic. For more
4536
+ # information, see [Interacting with Other Services][1] in the *AWS
4537
+ # IoT SiteWise User Guide*.
4538
+ #
4539
+ # If you omit this parameter, the notification state is set to
4540
+ # `DISABLED`.
4541
4541
  #
4542
4542
  #
4543
4543
  #
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-iotsitewise
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.0
4
+ version: 1.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-05-07 00:00:00.000000000 Z
11
+ date: 2020-05-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core