aws-sdk-iotsitewise 1.0.0 → 1.5.1
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/lib/aws-sdk-iotsitewise.rb +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +85 -39
- data/lib/aws-sdk-iotsitewise/client_api.rb +12 -6
- data/lib/aws-sdk-iotsitewise/types.rb +122 -73
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 26351f30dddac45286f01fd7caacfcacea724d92906dd8b552c4bea15a32c761
|
4
|
+
data.tar.gz: 243f4e182869ebdcc4d9b871be285bf75e056e943b34324af7b4cc6f7a074374
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 44d390c8357e1f2381721fb8965fbb09c9716ac2764991f2c07add810a6194d1e6bf600ba2b636e44110989883626975c8679810c03d84e3c7a0e5000997f89a
|
7
|
+
data.tar.gz: 773dd0686961f8bf11398e7f6239d34206e2df4c463678b76c74000ea9e61b9fdb7f8075261d763a39e596b832cdf8e46f073a9e91b8369cf5831ce95b028edc
|
data/lib/aws-sdk-iotsitewise.rb
CHANGED
@@ -24,6 +24,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
24
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
25
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
26
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
27
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
28
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
29
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
29
30
|
|
@@ -69,6 +70,7 @@ module Aws::IoTSiteWise
|
|
69
70
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
70
71
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
71
72
|
add_plugin(Aws::Plugins::TransferEncoding)
|
73
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
72
74
|
add_plugin(Aws::Plugins::SignatureV4)
|
73
75
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
74
76
|
|
@@ -105,7 +107,7 @@ module Aws::IoTSiteWise
|
|
105
107
|
# @option options [required, String] :region
|
106
108
|
# The AWS region to connect to. The configured `:region` is
|
107
109
|
# used to determine the service `:endpoint`. When not passed,
|
108
|
-
# a default `:region` is
|
110
|
+
# a default `:region` is searched for in the following locations:
|
109
111
|
#
|
110
112
|
# * `Aws.config[:region]`
|
111
113
|
# * `ENV['AWS_REGION']`
|
@@ -161,7 +163,7 @@ module Aws::IoTSiteWise
|
|
161
163
|
# @option options [String] :endpoint
|
162
164
|
# The client endpoint is normally constructed from the `:region`
|
163
165
|
# option. You should only configure an `:endpoint` when connecting
|
164
|
-
# to test endpoints. This should be
|
166
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
165
167
|
#
|
166
168
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
167
169
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -176,7 +178,7 @@ module Aws::IoTSiteWise
|
|
176
178
|
# requests fetching endpoints information. Defaults to 60 sec.
|
177
179
|
#
|
178
180
|
# @option options [Boolean] :endpoint_discovery (false)
|
179
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
181
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
180
182
|
#
|
181
183
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
182
184
|
# The log formatter.
|
@@ -475,12 +477,7 @@ module Aws::IoTSiteWise
|
|
475
477
|
#
|
476
478
|
# @option params [required, Array<Types::PutAssetPropertyValueEntry>] :entries
|
477
479
|
# The list of asset property value entries for the batch put request.
|
478
|
-
# You can specify up to 10 entries per request.
|
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
|
480
|
+
# You can specify up to 10 entries per request.
|
484
481
|
#
|
485
482
|
# @return [Types::BatchPutAssetPropertyValueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
486
483
|
#
|
@@ -1009,8 +1006,8 @@ module Aws::IoTSiteWise
|
|
1009
1006
|
# portal_contact_email: "Email", # required
|
1010
1007
|
# client_token: "ClientToken",
|
1011
1008
|
# portal_logo_image_file: {
|
1012
|
-
#
|
1013
|
-
#
|
1009
|
+
# data: "data", # required
|
1010
|
+
# type: "PNG", # required, accepts PNG
|
1014
1011
|
# },
|
1015
1012
|
# role_arn: "ARN", # required
|
1016
1013
|
# tags: {
|
@@ -1094,7 +1091,7 @@ module Aws::IoTSiteWise
|
|
1094
1091
|
|
1095
1092
|
# Deletes an access policy that grants the specified AWS Single Sign-On
|
1096
1093
|
# identity access to the specified AWS IoT SiteWise Monitor resource.
|
1097
|
-
# You can use this
|
1094
|
+
# You can use this operation to revoke access to an AWS IoT SiteWise
|
1098
1095
|
# Monitor resource.
|
1099
1096
|
#
|
1100
1097
|
# @option params [required, String] :access_policy_id
|
@@ -1728,7 +1725,7 @@ module Aws::IoTSiteWise
|
|
1728
1725
|
# * {Types::DescribePortalResponse#portal_status #portal_status} => Types::PortalStatus
|
1729
1726
|
# * {Types::DescribePortalResponse#portal_creation_date #portal_creation_date} => Time
|
1730
1727
|
# * {Types::DescribePortalResponse#portal_last_update_date #portal_last_update_date} => Time
|
1731
|
-
# * {Types::DescribePortalResponse#
|
1728
|
+
# * {Types::DescribePortalResponse#portal_logo_image_location #portal_logo_image_location} => Types::ImageLocation
|
1732
1729
|
# * {Types::DescribePortalResponse#role_arn #role_arn} => String
|
1733
1730
|
#
|
1734
1731
|
# @example Request syntax with placeholder values
|
@@ -1751,8 +1748,8 @@ module Aws::IoTSiteWise
|
|
1751
1748
|
# resp.portal_status.error.message #=> String
|
1752
1749
|
# resp.portal_creation_date #=> Time
|
1753
1750
|
# resp.portal_last_update_date #=> Time
|
1754
|
-
# resp.
|
1755
|
-
# resp.
|
1751
|
+
# resp.portal_logo_image_location.id #=> String
|
1752
|
+
# resp.portal_logo_image_location.url #=> String
|
1756
1753
|
# resp.role_arn #=> String
|
1757
1754
|
#
|
1758
1755
|
#
|
@@ -1925,7 +1922,7 @@ module Aws::IoTSiteWise
|
|
1925
1922
|
# asset_id: "ID",
|
1926
1923
|
# property_id: "ID",
|
1927
1924
|
# property_alias: "AssetPropertyAlias",
|
1928
|
-
# aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM
|
1925
|
+
# aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
|
1929
1926
|
# resolution: "Resolution", # required
|
1930
1927
|
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
1931
1928
|
# start_date: Time.now, # required
|
@@ -1945,6 +1942,7 @@ module Aws::IoTSiteWise
|
|
1945
1942
|
# resp.aggregated_values[0].value.maximum #=> Float
|
1946
1943
|
# resp.aggregated_values[0].value.minimum #=> Float
|
1947
1944
|
# resp.aggregated_values[0].value.sum #=> Float
|
1945
|
+
# resp.aggregated_values[0].value.standard_deviation #=> Float
|
1948
1946
|
# resp.next_token #=> String
|
1949
1947
|
#
|
1950
1948
|
# @overload get_asset_property_aggregates(params = {})
|
@@ -2116,16 +2114,20 @@ module Aws::IoTSiteWise
|
|
2116
2114
|
# project).
|
2117
2115
|
#
|
2118
2116
|
# @option params [String] :identity_type
|
2119
|
-
# The type of identity (user or group).
|
2117
|
+
# The type of identity (user or group). This parameter is required if
|
2118
|
+
# you specify `identityId`.
|
2120
2119
|
#
|
2121
2120
|
# @option params [String] :identity_id
|
2122
|
-
# The ID of the identity.
|
2121
|
+
# The ID of the identity. This parameter is required if you specify
|
2122
|
+
# `identityType`.
|
2123
2123
|
#
|
2124
2124
|
# @option params [String] :resource_type
|
2125
|
-
# The type of resource (portal or project).
|
2125
|
+
# The type of resource (portal or project). This parameter is required
|
2126
|
+
# if you specify `resourceId`.
|
2126
2127
|
#
|
2127
2128
|
# @option params [String] :resource_id
|
2128
|
-
# The ID of the resource.
|
2129
|
+
# The ID of the resource. This parameter is required if you specify
|
2130
|
+
# `resourceType`.
|
2129
2131
|
#
|
2130
2132
|
# @option params [String] :next_token
|
2131
2133
|
# The token to be used for the next set of paginated results.
|
@@ -2216,6 +2218,21 @@ module Aws::IoTSiteWise
|
|
2216
2218
|
|
2217
2219
|
# Retrieves a paginated list of asset summaries.
|
2218
2220
|
#
|
2221
|
+
# You can use this operation to do the following:
|
2222
|
+
#
|
2223
|
+
# * List assets based on a specific asset model.
|
2224
|
+
#
|
2225
|
+
# * List top-level assets.
|
2226
|
+
#
|
2227
|
+
# You can't use this operation to list all assets. To retrieve
|
2228
|
+
# summaries for all of your assets, use [ListAssetModels][1] to get all
|
2229
|
+
# of your asset model IDs. Then, use ListAssets to get all assets for
|
2230
|
+
# each asset model.
|
2231
|
+
#
|
2232
|
+
#
|
2233
|
+
#
|
2234
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssetModels.html
|
2235
|
+
#
|
2219
2236
|
# @option params [String] :next_token
|
2220
2237
|
# The token to be used for the next set of paginated results.
|
2221
2238
|
#
|
@@ -2223,11 +2240,18 @@ module Aws::IoTSiteWise
|
|
2223
2240
|
# The maximum number of results to be returned per paginated request.
|
2224
2241
|
#
|
2225
2242
|
# @option params [String] :asset_model_id
|
2226
|
-
# The ID of the asset model by which to filter the list of assets.
|
2227
|
-
#
|
2243
|
+
# The ID of the asset model by which to filter the list of assets. This
|
2244
|
+
# parameter is required if you choose `ALL` for `filter`.
|
2228
2245
|
#
|
2229
2246
|
# @option params [String] :filter
|
2230
|
-
# The
|
2247
|
+
# The filter for the requested list of assets. Choose one of the
|
2248
|
+
# following options. Defaults to `ALL`.
|
2249
|
+
#
|
2250
|
+
# * `ALL` – The list includes all assets for a given asset model ID. The
|
2251
|
+
# `assetModelId` parameter is required if you filter by `ALL`.
|
2252
|
+
#
|
2253
|
+
# * `TOP_LEVEL` – The list includes only top-level assets in the asset
|
2254
|
+
# hierarchy tree.
|
2231
2255
|
#
|
2232
2256
|
# @return [Types::ListAssetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2233
2257
|
#
|
@@ -2775,10 +2799,10 @@ module Aws::IoTSiteWise
|
|
2775
2799
|
# information, see [Updating Assets and Models][1] in the *AWS IoT
|
2776
2800
|
# SiteWise User Guide*.
|
2777
2801
|
#
|
2778
|
-
# This
|
2779
|
-
# avoid deleting your asset model's properties or hierarchies, you
|
2780
|
-
# include their definitions in the updated asset model
|
2781
|
-
# information, see [DescribeAssetModel][2].
|
2802
|
+
# This operation overwrites the existing model with the provided model.
|
2803
|
+
# To avoid deleting your asset model's properties or hierarchies, you
|
2804
|
+
# must include their IDs and definitions in the updated asset model
|
2805
|
+
# payload. For more information, see [DescribeAssetModel][2].
|
2782
2806
|
#
|
2783
2807
|
# If you remove a property from an asset model or update a property's
|
2784
2808
|
# formula expression, AWS IoT SiteWise deletes all previous data for
|
@@ -2915,6 +2939,16 @@ module Aws::IoTSiteWise
|
|
2915
2939
|
|
2916
2940
|
# Updates an asset property's alias and notification state.
|
2917
2941
|
#
|
2942
|
+
# This operation overwrites the property's existing alias and
|
2943
|
+
# notification state. To keep your existing property's alias or
|
2944
|
+
# notification state, you must include the existing values in the
|
2945
|
+
# UpdateAssetProperty request. For more information, see
|
2946
|
+
# [DescribeAssetProperty][1].
|
2947
|
+
#
|
2948
|
+
#
|
2949
|
+
#
|
2950
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetProperty.html
|
2951
|
+
#
|
2918
2952
|
# @option params [required, String] :asset_id
|
2919
2953
|
# The ID of the asset to be updated.
|
2920
2954
|
#
|
@@ -2928,16 +2962,21 @@ module Aws::IoTSiteWise
|
|
2928
2962
|
# see [Mapping Industrial Data Streams to Asset Properties][1] in the
|
2929
2963
|
# *AWS IoT SiteWise User Guide*.
|
2930
2964
|
#
|
2965
|
+
# If you omit this parameter, the alias is removed from the property.
|
2966
|
+
#
|
2931
2967
|
#
|
2932
2968
|
#
|
2933
2969
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
|
2934
2970
|
#
|
2935
2971
|
# @option params [String] :property_notification_state
|
2936
|
-
# The
|
2937
|
-
#
|
2938
|
-
#
|
2939
|
-
#
|
2940
|
-
#
|
2972
|
+
# The MQTT notification state (enabled or disabled) for this asset
|
2973
|
+
# property. When the notification state is enabled, AWS IoT SiteWise
|
2974
|
+
# publishes property value updates to a unique MQTT topic. For more
|
2975
|
+
# information, see [Interacting with Other Services][1] in the *AWS IoT
|
2976
|
+
# SiteWise User Guide*.
|
2977
|
+
#
|
2978
|
+
# If you omit this parameter, the notification state is set to
|
2979
|
+
# `DISABLED`.
|
2941
2980
|
#
|
2942
2981
|
#
|
2943
2982
|
#
|
@@ -3111,9 +3150,13 @@ module Aws::IoTSiteWise
|
|
3111
3150
|
# @option params [required, String] :portal_contact_email
|
3112
3151
|
# The AWS administrator's contact email address.
|
3113
3152
|
#
|
3114
|
-
# @option params [Types::
|
3115
|
-
#
|
3116
|
-
#
|
3153
|
+
# @option params [Types::Image] :portal_logo_image
|
3154
|
+
# Contains an image that is one of the following:
|
3155
|
+
#
|
3156
|
+
# * An image file. Choose this option to upload a new image.
|
3157
|
+
#
|
3158
|
+
# * The ID of an existing image. Choose this option to keep an existing
|
3159
|
+
# image.
|
3117
3160
|
#
|
3118
3161
|
# @option params [required, String] :role_arn
|
3119
3162
|
# The [ARN][1] of a service role that allows the portal's users to
|
@@ -3145,9 +3188,12 @@ module Aws::IoTSiteWise
|
|
3145
3188
|
# portal_name: "Name", # required
|
3146
3189
|
# portal_description: "Description",
|
3147
3190
|
# portal_contact_email: "Email", # required
|
3148
|
-
#
|
3149
|
-
#
|
3150
|
-
#
|
3191
|
+
# portal_logo_image: {
|
3192
|
+
# id: "ID",
|
3193
|
+
# file: {
|
3194
|
+
# data: "data", # required
|
3195
|
+
# type: "PNG", # required, accepts PNG
|
3196
|
+
# },
|
3151
3197
|
# },
|
3152
3198
|
# role_arn: "ARN", # required
|
3153
3199
|
# client_token: "ClientToken",
|
@@ -3216,7 +3262,7 @@ module Aws::IoTSiteWise
|
|
3216
3262
|
params: params,
|
3217
3263
|
config: config)
|
3218
3264
|
context[:gem_name] = 'aws-sdk-iotsitewise'
|
3219
|
-
context[:gem_version] = '1.
|
3265
|
+
context[:gem_version] = '1.5.1'
|
3220
3266
|
Seahorse::Client::Request.new(handlers, context)
|
3221
3267
|
end
|
3222
3268
|
|
@@ -155,6 +155,7 @@ module Aws::IoTSiteWise
|
|
155
155
|
ImageFile = Shapes::StructureShape.new(name: 'ImageFile')
|
156
156
|
ImageFileData = Shapes::BlobShape.new(name: 'ImageFileData')
|
157
157
|
ImageFileType = Shapes::StringShape.new(name: 'ImageFileType')
|
158
|
+
ImageLocation = Shapes::StructureShape.new(name: 'ImageLocation')
|
158
159
|
InternalFailureException = Shapes::StructureShape.new(name: 'InternalFailureException')
|
159
160
|
Interval = Shapes::StringShape.new(name: 'Interval')
|
160
161
|
InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
|
@@ -293,6 +294,7 @@ module Aws::IoTSiteWise
|
|
293
294
|
Aggregates.add_member(:maximum, Shapes::ShapeRef.new(shape: AggregatedDoubleValue, location_name: "maximum"))
|
294
295
|
Aggregates.add_member(:minimum, Shapes::ShapeRef.new(shape: AggregatedDoubleValue, location_name: "minimum"))
|
295
296
|
Aggregates.add_member(:sum, Shapes::ShapeRef.new(shape: AggregatedDoubleValue, location_name: "sum"))
|
297
|
+
Aggregates.add_member(:standard_deviation, Shapes::ShapeRef.new(shape: AggregatedDoubleValue, location_name: "standardDeviation"))
|
296
298
|
Aggregates.struct_class = Types::Aggregates
|
297
299
|
|
298
300
|
AssetErrorDetails.add_member(:asset_id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "assetId"))
|
@@ -690,7 +692,7 @@ module Aws::IoTSiteWise
|
|
690
692
|
DescribePortalResponse.add_member(:portal_status, Shapes::ShapeRef.new(shape: PortalStatus, required: true, location_name: "portalStatus"))
|
691
693
|
DescribePortalResponse.add_member(:portal_creation_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "portalCreationDate"))
|
692
694
|
DescribePortalResponse.add_member(:portal_last_update_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "portalLastUpdateDate"))
|
693
|
-
DescribePortalResponse.add_member(:
|
695
|
+
DescribePortalResponse.add_member(:portal_logo_image_location, Shapes::ShapeRef.new(shape: ImageLocation, location_name: "portalLogoImageLocation"))
|
694
696
|
DescribePortalResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "roleArn"))
|
695
697
|
DescribePortalResponse.struct_class = Types::DescribePortalResponse
|
696
698
|
|
@@ -792,14 +794,18 @@ module Aws::IoTSiteWise
|
|
792
794
|
Identity.add_member(:group, Shapes::ShapeRef.new(shape: GroupIdentity, location_name: "group"))
|
793
795
|
Identity.struct_class = Types::Identity
|
794
796
|
|
795
|
-
Image.add_member(:
|
796
|
-
Image.add_member(:
|
797
|
+
Image.add_member(:id, Shapes::ShapeRef.new(shape: ID, location_name: "id"))
|
798
|
+
Image.add_member(:file, Shapes::ShapeRef.new(shape: ImageFile, location_name: "file"))
|
797
799
|
Image.struct_class = Types::Image
|
798
800
|
|
799
|
-
ImageFile.add_member(:
|
800
|
-
ImageFile.add_member(:
|
801
|
+
ImageFile.add_member(:data, Shapes::ShapeRef.new(shape: ImageFileData, required: true, location_name: "data"))
|
802
|
+
ImageFile.add_member(:type, Shapes::ShapeRef.new(shape: ImageFileType, required: true, location_name: "type"))
|
801
803
|
ImageFile.struct_class = Types::ImageFile
|
802
804
|
|
805
|
+
ImageLocation.add_member(:id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "id"))
|
806
|
+
ImageLocation.add_member(:url, Shapes::ShapeRef.new(shape: Url, required: true, location_name: "url"))
|
807
|
+
ImageLocation.struct_class = Types::ImageLocation
|
808
|
+
|
803
809
|
InternalFailureException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "message"))
|
804
810
|
InternalFailureException.struct_class = Types::InternalFailureException
|
805
811
|
|
@@ -1093,7 +1099,7 @@ module Aws::IoTSiteWise
|
|
1093
1099
|
UpdatePortalRequest.add_member(:portal_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "portalName"))
|
1094
1100
|
UpdatePortalRequest.add_member(:portal_description, Shapes::ShapeRef.new(shape: Description, location_name: "portalDescription"))
|
1095
1101
|
UpdatePortalRequest.add_member(:portal_contact_email, Shapes::ShapeRef.new(shape: Email, required: true, location_name: "portalContactEmail"))
|
1096
|
-
UpdatePortalRequest.add_member(:
|
1102
|
+
UpdatePortalRequest.add_member(:portal_logo_image, Shapes::ShapeRef.new(shape: Image, location_name: "portalLogoImage"))
|
1097
1103
|
UpdatePortalRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "roleArn"))
|
1098
1104
|
UpdatePortalRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
|
1099
1105
|
UpdatePortalRequest.struct_class = Types::UpdatePortalRequest
|
@@ -71,27 +71,30 @@ module Aws::IoTSiteWise
|
|
71
71
|
# Contains the (pre-calculated) aggregate values for an asset property.
|
72
72
|
#
|
73
73
|
# @!attribute [rw] average
|
74
|
-
# The average (mean) value of the time series
|
75
|
-
#
|
74
|
+
# The average (mean) value of the time series over a time interval
|
75
|
+
# window.
|
76
76
|
# @return [Float]
|
77
77
|
#
|
78
78
|
# @!attribute [rw] count
|
79
|
-
# The count of data points in the time series
|
80
|
-
#
|
79
|
+
# The count of data points in the time series over a time interval
|
80
|
+
# window.
|
81
81
|
# @return [Float]
|
82
82
|
#
|
83
83
|
# @!attribute [rw] maximum
|
84
|
-
# The maximum value of the time series
|
85
|
-
# window.
|
84
|
+
# The maximum value of the time series over a time interval window.
|
86
85
|
# @return [Float]
|
87
86
|
#
|
88
87
|
# @!attribute [rw] minimum
|
89
|
-
# The minimum value of the time series
|
90
|
-
# window.
|
88
|
+
# The minimum value of the time series over a time interval window.
|
91
89
|
# @return [Float]
|
92
90
|
#
|
93
91
|
# @!attribute [rw] sum
|
94
|
-
# The sum of the time series
|
92
|
+
# The sum of the time series over a time interval window.
|
93
|
+
# @return [Float]
|
94
|
+
#
|
95
|
+
# @!attribute [rw] standard_deviation
|
96
|
+
# The standard deviation of the time series over a time interval
|
97
|
+
# window.
|
95
98
|
# @return [Float]
|
96
99
|
#
|
97
100
|
class Aggregates < Struct.new(
|
@@ -99,7 +102,8 @@ module Aws::IoTSiteWise
|
|
99
102
|
:count,
|
100
103
|
:maximum,
|
101
104
|
:minimum,
|
102
|
-
:sum
|
105
|
+
:sum,
|
106
|
+
:standard_deviation)
|
103
107
|
include Aws::Structure
|
104
108
|
end
|
105
109
|
|
@@ -887,12 +891,7 @@ module Aws::IoTSiteWise
|
|
887
891
|
#
|
888
892
|
# @!attribute [rw] entries
|
889
893
|
# The list of asset property value entries for the batch put request.
|
890
|
-
# You can specify up to 10 entries per request.
|
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
|
894
|
+
# You can specify up to 10 entries per request.
|
896
895
|
# @return [Array<Types::PutAssetPropertyValueEntry>]
|
897
896
|
#
|
898
897
|
class BatchPutAssetPropertyValueRequest < Struct.new(
|
@@ -1165,7 +1164,7 @@ module Aws::IoTSiteWise
|
|
1165
1164
|
#
|
1166
1165
|
# @!attribute [rw] asset_model_status
|
1167
1166
|
# The status of the asset model, which contains a state (`CREATING`
|
1168
|
-
# after successfully calling this
|
1167
|
+
# after successfully calling this operation) and any error message.
|
1169
1168
|
# @return [Types::AssetModelStatus]
|
1170
1169
|
#
|
1171
1170
|
class CreateAssetModelResponse < Struct.new(
|
@@ -1239,7 +1238,7 @@ module Aws::IoTSiteWise
|
|
1239
1238
|
#
|
1240
1239
|
# @!attribute [rw] asset_status
|
1241
1240
|
# The status of the asset, which contains a state (`CREATING` after
|
1242
|
-
# successfully calling this
|
1241
|
+
# successfully calling this operation) and any error message.
|
1243
1242
|
# @return [Types::AssetStatus]
|
1244
1243
|
#
|
1245
1244
|
class CreateAssetResponse < Struct.new(
|
@@ -1405,8 +1404,8 @@ module Aws::IoTSiteWise
|
|
1405
1404
|
# portal_contact_email: "Email", # required
|
1406
1405
|
# client_token: "ClientToken",
|
1407
1406
|
# portal_logo_image_file: {
|
1408
|
-
#
|
1409
|
-
#
|
1407
|
+
# data: "data", # required
|
1408
|
+
# type: "PNG", # required, accepts PNG
|
1410
1409
|
# },
|
1411
1410
|
# role_arn: "ARN", # required
|
1412
1411
|
# tags: {
|
@@ -1493,7 +1492,7 @@ module Aws::IoTSiteWise
|
|
1493
1492
|
#
|
1494
1493
|
# @!attribute [rw] portal_status
|
1495
1494
|
# The status of the portal, which contains a state (`CREATING` after
|
1496
|
-
# successfully calling this
|
1495
|
+
# successfully calling this operation) and any error message.
|
1497
1496
|
# @return [Types::PortalStatus]
|
1498
1497
|
#
|
1499
1498
|
# @!attribute [rw] sso_application_id
|
@@ -1671,7 +1670,7 @@ module Aws::IoTSiteWise
|
|
1671
1670
|
|
1672
1671
|
# @!attribute [rw] asset_model_status
|
1673
1672
|
# The status of the asset model, which contains a state (`DELETING`
|
1674
|
-
# after successfully calling this
|
1673
|
+
# after successfully calling this operation) and any error message.
|
1675
1674
|
# @return [Types::AssetModelStatus]
|
1676
1675
|
#
|
1677
1676
|
class DeleteAssetModelResponse < Struct.new(
|
@@ -1708,7 +1707,7 @@ module Aws::IoTSiteWise
|
|
1708
1707
|
|
1709
1708
|
# @!attribute [rw] asset_status
|
1710
1709
|
# The status of the asset, which contains a state (`DELETING` after
|
1711
|
-
# successfully calling this
|
1710
|
+
# successfully calling this operation) and any error message.
|
1712
1711
|
# @return [Types::AssetStatus]
|
1713
1712
|
#
|
1714
1713
|
class DeleteAssetResponse < Struct.new(
|
@@ -1790,7 +1789,7 @@ module Aws::IoTSiteWise
|
|
1790
1789
|
|
1791
1790
|
# @!attribute [rw] portal_status
|
1792
1791
|
# The status of the portal, which contains a state (`DELETING` after
|
1793
|
-
# successfully calling this
|
1792
|
+
# successfully calling this operation) and any error message.
|
1794
1793
|
# @return [Types::PortalStatus]
|
1795
1794
|
#
|
1796
1795
|
class DeletePortalResponse < Struct.new(
|
@@ -2367,9 +2366,9 @@ module Aws::IoTSiteWise
|
|
2367
2366
|
# The date the portal was last updated, in Unix epoch time.
|
2368
2367
|
# @return [Time]
|
2369
2368
|
#
|
2370
|
-
# @!attribute [rw]
|
2371
|
-
# The portal's logo image.
|
2372
|
-
# @return [Types::
|
2369
|
+
# @!attribute [rw] portal_logo_image_location
|
2370
|
+
# The portal's logo image, which is available at a URL.
|
2371
|
+
# @return [Types::ImageLocation]
|
2373
2372
|
#
|
2374
2373
|
# @!attribute [rw] role_arn
|
2375
2374
|
# The [ARN][1] of the service role that allows the portal's users to
|
@@ -2394,7 +2393,7 @@ module Aws::IoTSiteWise
|
|
2394
2393
|
:portal_status,
|
2395
2394
|
:portal_creation_date,
|
2396
2395
|
:portal_last_update_date,
|
2397
|
-
:
|
2396
|
+
:portal_logo_image_location,
|
2398
2397
|
:role_arn)
|
2399
2398
|
include Aws::Structure
|
2400
2399
|
end
|
@@ -2645,7 +2644,7 @@ module Aws::IoTSiteWise
|
|
2645
2644
|
# asset_id: "ID",
|
2646
2645
|
# property_id: "ID",
|
2647
2646
|
# property_alias: "AssetPropertyAlias",
|
2648
|
-
# aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM
|
2647
|
+
# aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
|
2649
2648
|
# resolution: "Resolution", # required
|
2650
2649
|
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
2651
2650
|
# start_date: Time.now, # required
|
@@ -2964,20 +2963,36 @@ module Aws::IoTSiteWise
|
|
2964
2963
|
include Aws::Structure
|
2965
2964
|
end
|
2966
2965
|
|
2967
|
-
# Contains an image that is
|
2966
|
+
# Contains an image that is one of the following:
|
2967
|
+
#
|
2968
|
+
# * An image file. Choose this option to upload a new image.
|
2968
2969
|
#
|
2969
|
-
#
|
2970
|
-
#
|
2971
|
-
#
|
2970
|
+
# * The ID of an existing image. Choose this option to keep an existing
|
2971
|
+
# image.
|
2972
|
+
#
|
2973
|
+
# @note When making an API call, you may pass Image
|
2974
|
+
# data as a hash:
|
2975
|
+
#
|
2976
|
+
# {
|
2977
|
+
# id: "ID",
|
2978
|
+
# file: {
|
2979
|
+
# data: "data", # required
|
2980
|
+
# type: "PNG", # required, accepts PNG
|
2981
|
+
# },
|
2982
|
+
# }
|
2983
|
+
#
|
2984
|
+
# @!attribute [rw] id
|
2985
|
+
# The ID of an existing image. Specify this parameter to keep an
|
2986
|
+
# existing image.
|
2972
2987
|
# @return [String]
|
2973
2988
|
#
|
2974
|
-
# @!attribute [rw]
|
2975
|
-
#
|
2976
|
-
# @return [
|
2989
|
+
# @!attribute [rw] file
|
2990
|
+
# Contains an image file.
|
2991
|
+
# @return [Types::ImageFile]
|
2977
2992
|
#
|
2978
2993
|
class Image < Struct.new(
|
2979
|
-
:
|
2980
|
-
:
|
2994
|
+
:id,
|
2995
|
+
:file)
|
2981
2996
|
include Aws::Structure
|
2982
2997
|
end
|
2983
2998
|
|
@@ -2987,22 +3002,40 @@ module Aws::IoTSiteWise
|
|
2987
3002
|
# data as a hash:
|
2988
3003
|
#
|
2989
3004
|
# {
|
2990
|
-
#
|
2991
|
-
#
|
3005
|
+
# data: "data", # required
|
3006
|
+
# type: "PNG", # required, accepts PNG
|
2992
3007
|
# }
|
2993
3008
|
#
|
2994
|
-
# @!attribute [rw]
|
3009
|
+
# @!attribute [rw] data
|
2995
3010
|
# The image file contents, represented as a base64-encoded string. The
|
2996
3011
|
# file size must be less than 1 MB.
|
2997
3012
|
# @return [String]
|
2998
3013
|
#
|
2999
|
-
# @!attribute [rw]
|
3014
|
+
# @!attribute [rw] type
|
3000
3015
|
# The file type of the image.
|
3001
3016
|
# @return [String]
|
3002
3017
|
#
|
3003
3018
|
class ImageFile < Struct.new(
|
3004
|
-
:
|
3005
|
-
:
|
3019
|
+
:data,
|
3020
|
+
:type)
|
3021
|
+
include Aws::Structure
|
3022
|
+
end
|
3023
|
+
|
3024
|
+
# Contains an image that is uploaded to AWS IoT SiteWise and available
|
3025
|
+
# at a URL.
|
3026
|
+
#
|
3027
|
+
# @!attribute [rw] id
|
3028
|
+
# The ID of the image.
|
3029
|
+
# @return [String]
|
3030
|
+
#
|
3031
|
+
# @!attribute [rw] url
|
3032
|
+
# The URL where the image is available. The URL is valid for 15
|
3033
|
+
# minutes so that you can view and download the image
|
3034
|
+
# @return [String]
|
3035
|
+
#
|
3036
|
+
class ImageLocation < Struct.new(
|
3037
|
+
:id,
|
3038
|
+
:url)
|
3006
3039
|
include Aws::Structure
|
3007
3040
|
end
|
3008
3041
|
|
@@ -3062,19 +3095,23 @@ module Aws::IoTSiteWise
|
|
3062
3095
|
# }
|
3063
3096
|
#
|
3064
3097
|
# @!attribute [rw] identity_type
|
3065
|
-
# The type of identity (user or group).
|
3098
|
+
# The type of identity (user or group). This parameter is required if
|
3099
|
+
# you specify `identityId`.
|
3066
3100
|
# @return [String]
|
3067
3101
|
#
|
3068
3102
|
# @!attribute [rw] identity_id
|
3069
|
-
# The ID of the identity.
|
3103
|
+
# The ID of the identity. This parameter is required if you specify
|
3104
|
+
# `identityType`.
|
3070
3105
|
# @return [String]
|
3071
3106
|
#
|
3072
3107
|
# @!attribute [rw] resource_type
|
3073
|
-
# The type of resource (portal or project).
|
3108
|
+
# The type of resource (portal or project). This parameter is required
|
3109
|
+
# if you specify `resourceId`.
|
3074
3110
|
# @return [String]
|
3075
3111
|
#
|
3076
3112
|
# @!attribute [rw] resource_id
|
3077
|
-
# The ID of the resource.
|
3113
|
+
# The ID of the resource. This parameter is required if you specify
|
3114
|
+
# `resourceType`.
|
3078
3115
|
# @return [String]
|
3079
3116
|
#
|
3080
3117
|
# @!attribute [rw] next_token
|
@@ -3167,11 +3204,18 @@ module Aws::IoTSiteWise
|
|
3167
3204
|
#
|
3168
3205
|
# @!attribute [rw] asset_model_id
|
3169
3206
|
# The ID of the asset model by which to filter the list of assets.
|
3170
|
-
#
|
3207
|
+
# This parameter is required if you choose `ALL` for `filter`.
|
3171
3208
|
# @return [String]
|
3172
3209
|
#
|
3173
3210
|
# @!attribute [rw] filter
|
3174
|
-
# The
|
3211
|
+
# The filter for the requested list of assets. Choose one of the
|
3212
|
+
# following options. Defaults to `ALL`.
|
3213
|
+
#
|
3214
|
+
# * `ALL` – The list includes all assets for a given asset model ID.
|
3215
|
+
# The `assetModelId` parameter is required if you filter by `ALL`.
|
3216
|
+
#
|
3217
|
+
# * `TOP_LEVEL` – The list includes only top-level assets in the asset
|
3218
|
+
# hierarchy tree.
|
3175
3219
|
# @return [String]
|
3176
3220
|
#
|
3177
3221
|
class ListAssetsRequest < Struct.new(
|
@@ -3986,13 +4030,6 @@ module Aws::IoTSiteWise
|
|
3986
4030
|
# @!attribute [rw] property_values
|
3987
4031
|
# The list of property values to upload. You can specify up to 10
|
3988
4032
|
# `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
4033
|
# @return [Array<Types::AssetPropertyValue>]
|
3997
4034
|
#
|
3998
4035
|
class PutAssetPropertyValueEntry < Struct.new(
|
@@ -4493,7 +4530,7 @@ module Aws::IoTSiteWise
|
|
4493
4530
|
|
4494
4531
|
# @!attribute [rw] asset_model_status
|
4495
4532
|
# The status of the asset model, which contains a state (`UPDATING`
|
4496
|
-
# after successfully calling this
|
4533
|
+
# after successfully calling this operation) and any error message.
|
4497
4534
|
# @return [Types::AssetModelStatus]
|
4498
4535
|
#
|
4499
4536
|
class UpdateAssetModelResponse < Struct.new(
|
@@ -4527,17 +4564,22 @@ module Aws::IoTSiteWise
|
|
4527
4564
|
# see [Mapping Industrial Data Streams to Asset Properties][1] in the
|
4528
4565
|
# *AWS IoT SiteWise User Guide*.
|
4529
4566
|
#
|
4567
|
+
# If you omit this parameter, the alias is removed from the property.
|
4568
|
+
#
|
4530
4569
|
#
|
4531
4570
|
#
|
4532
4571
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
|
4533
4572
|
# @return [String]
|
4534
4573
|
#
|
4535
4574
|
# @!attribute [rw] property_notification_state
|
4536
|
-
# The
|
4537
|
-
#
|
4538
|
-
#
|
4539
|
-
#
|
4540
|
-
#
|
4575
|
+
# The MQTT notification state (enabled or disabled) for this asset
|
4576
|
+
# property. When the notification state is enabled, AWS IoT SiteWise
|
4577
|
+
# publishes property value updates to a unique MQTT topic. For more
|
4578
|
+
# information, see [Interacting with Other Services][1] in the *AWS
|
4579
|
+
# IoT SiteWise User Guide*.
|
4580
|
+
#
|
4581
|
+
# If you omit this parameter, the notification state is set to
|
4582
|
+
# `DISABLED`.
|
4541
4583
|
#
|
4542
4584
|
#
|
4543
4585
|
#
|
@@ -4597,7 +4639,7 @@ module Aws::IoTSiteWise
|
|
4597
4639
|
|
4598
4640
|
# @!attribute [rw] asset_status
|
4599
4641
|
# The status of the asset, which contains a state (`UPDATING` after
|
4600
|
-
# successfully calling this
|
4642
|
+
# successfully calling this operation) and any error message.
|
4601
4643
|
# @return [Types::AssetStatus]
|
4602
4644
|
#
|
4603
4645
|
class UpdateAssetResponse < Struct.new(
|
@@ -4752,9 +4794,12 @@ module Aws::IoTSiteWise
|
|
4752
4794
|
# portal_name: "Name", # required
|
4753
4795
|
# portal_description: "Description",
|
4754
4796
|
# portal_contact_email: "Email", # required
|
4755
|
-
#
|
4756
|
-
#
|
4757
|
-
#
|
4797
|
+
# portal_logo_image: {
|
4798
|
+
# id: "ID",
|
4799
|
+
# file: {
|
4800
|
+
# data: "data", # required
|
4801
|
+
# type: "PNG", # required, accepts PNG
|
4802
|
+
# },
|
4758
4803
|
# },
|
4759
4804
|
# role_arn: "ARN", # required
|
4760
4805
|
# client_token: "ClientToken",
|
@@ -4776,10 +4821,14 @@ module Aws::IoTSiteWise
|
|
4776
4821
|
# The AWS administrator's contact email address.
|
4777
4822
|
# @return [String]
|
4778
4823
|
#
|
4779
|
-
# @!attribute [rw]
|
4780
|
-
#
|
4781
|
-
#
|
4782
|
-
#
|
4824
|
+
# @!attribute [rw] portal_logo_image
|
4825
|
+
# Contains an image that is one of the following:
|
4826
|
+
#
|
4827
|
+
# * An image file. Choose this option to upload a new image.
|
4828
|
+
#
|
4829
|
+
# * The ID of an existing image. Choose this option to keep an
|
4830
|
+
# existing image.
|
4831
|
+
# @return [Types::Image]
|
4783
4832
|
#
|
4784
4833
|
# @!attribute [rw] role_arn
|
4785
4834
|
# The [ARN][1] of a service role that allows the portal's users to
|
@@ -4807,7 +4856,7 @@ module Aws::IoTSiteWise
|
|
4807
4856
|
:portal_name,
|
4808
4857
|
:portal_description,
|
4809
4858
|
:portal_contact_email,
|
4810
|
-
:
|
4859
|
+
:portal_logo_image,
|
4811
4860
|
:role_arn,
|
4812
4861
|
:client_token)
|
4813
4862
|
include Aws::Structure
|
@@ -4815,7 +4864,7 @@ module Aws::IoTSiteWise
|
|
4815
4864
|
|
4816
4865
|
# @!attribute [rw] portal_status
|
4817
4866
|
# The status of the portal, which contains a state (`UPDATING` after
|
4818
|
-
# successfully calling this
|
4867
|
+
# successfully calling this operation) and any error message.
|
4819
4868
|
# @return [Types::PortalStatus]
|
4820
4869
|
#
|
4821
4870
|
class UpdatePortalResponse < Struct.new(
|
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.
|
4
|
+
version: 1.5.1
|
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-
|
11
|
+
date: 2020-06-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.99.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.99.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|