aws-sdk-iotsitewise 1.34.0 → 1.38.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +332 -31
- data/lib/aws-sdk-iotsitewise/client_api.rb +165 -0
- data/lib/aws-sdk-iotsitewise/types.rb +515 -64
- data/lib/aws-sdk-iotsitewise.rb +1 -1
- 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: 5cd91087e4b617d884ca980bddfc5d2b8a2da3ce38cfd7a5895cf88f658afb21
|
4
|
+
data.tar.gz: ad05e6f7ea9d0920c2ec79e45f447b32a700556ecfe7a979f4c52384f16b9954
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4cc2b5c95f1f42918e18b8119b46b9eeed8f11fe7ab66a96848701c1d80a7dafe804f1d3581e7ce19d571e05766b0cc6954ba09332231d4a72c923f8d272e195
|
7
|
+
data.tar.gz: 2d816578fd257adfd4334f14397494032fc3db4c6094347bf0ffc893eec4dbad2bda68b944ef99f7b9cbfa8c4891c2c387f3e4603e068f66767099b6dfe74f3b
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.38.0 (2021-12-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.37.0 (2021-11-30)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.36.0 (2021-11-29)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - AWS IoT SiteWise now supports retention configuration for the hot tier storage.
|
18
|
+
|
19
|
+
1.35.0 (2021-11-24)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - AWS IoT SiteWise now accepts data streams that aren't associated with any asset properties. You can organize data by updating data stream associations.
|
23
|
+
|
4
24
|
1.34.0 (2021-11-04)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.38.0
|
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
30
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
32
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
33
|
|
@@ -73,6 +74,7 @@ module Aws::IoTSiteWise
|
|
73
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
76
|
add_plugin(Aws::Plugins::HttpChecksum)
|
77
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
76
78
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
79
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
78
80
|
|
@@ -119,7 +121,9 @@ module Aws::IoTSiteWise
|
|
119
121
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
122
|
# are very aggressive. Construct and pass an instance of
|
121
123
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
124
|
+
# enable retries and extended timeouts. Instance profile credential
|
125
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
126
|
+
# to true.
|
123
127
|
#
|
124
128
|
# @option options [required, String] :region
|
125
129
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +177,10 @@ module Aws::IoTSiteWise
|
|
173
177
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
178
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
179
|
#
|
180
|
+
# @option options [String] :defaults_mode ("legacy")
|
181
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
182
|
+
# accepted modes and the configuration defaults that are included.
|
183
|
+
#
|
176
184
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
185
|
# Set to true to disable SDK automatically adding host prefix
|
178
186
|
# to default service endpoint when available.
|
@@ -295,7 +303,7 @@ module Aws::IoTSiteWise
|
|
295
303
|
# seconds to wait when opening a HTTP session before raising a
|
296
304
|
# `Timeout::Error`.
|
297
305
|
#
|
298
|
-
# @option options [
|
306
|
+
# @option options [Float] :http_read_timeout (60) The default
|
299
307
|
# number of seconds to wait for response data. This value can
|
300
308
|
# safely be set per-request on the session.
|
301
309
|
#
|
@@ -311,6 +319,9 @@ module Aws::IoTSiteWise
|
|
311
319
|
# disables this behaviour. This value can safely be set per
|
312
320
|
# request on the session.
|
313
321
|
#
|
322
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
323
|
+
# in seconds.
|
324
|
+
#
|
314
325
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
315
326
|
# HTTP debug output will be sent to the `:logger`.
|
316
327
|
#
|
@@ -386,6 +397,43 @@ module Aws::IoTSiteWise
|
|
386
397
|
req.send_request(options)
|
387
398
|
end
|
388
399
|
|
400
|
+
# Associates a time series (data stream) with an asset property.
|
401
|
+
#
|
402
|
+
# @option params [required, String] :alias
|
403
|
+
# The alias that identifies the time series.
|
404
|
+
#
|
405
|
+
# @option params [required, String] :asset_id
|
406
|
+
# The ID of the asset in which the asset property was created.
|
407
|
+
#
|
408
|
+
# @option params [required, String] :property_id
|
409
|
+
# The ID of the asset property.
|
410
|
+
#
|
411
|
+
# @option params [String] :client_token
|
412
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
413
|
+
# idempotency of the request. Don't reuse this client token if a new
|
414
|
+
# idempotent request is required.
|
415
|
+
#
|
416
|
+
# **A suitable default value is auto-generated.** You should normally
|
417
|
+
# not need to pass this option.**
|
418
|
+
#
|
419
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
420
|
+
#
|
421
|
+
# @example Request syntax with placeholder values
|
422
|
+
#
|
423
|
+
# resp = client.associate_time_series_to_asset_property({
|
424
|
+
# alias: "PropertyAlias", # required
|
425
|
+
# asset_id: "ID", # required
|
426
|
+
# property_id: "ID", # required
|
427
|
+
# client_token: "ClientToken",
|
428
|
+
# })
|
429
|
+
#
|
430
|
+
# @overload associate_time_series_to_asset_property(params = {})
|
431
|
+
# @param [Hash] params ({})
|
432
|
+
def associate_time_series_to_asset_property(params = {}, options = {})
|
433
|
+
req = build_request(:associate_time_series_to_asset_property, params)
|
434
|
+
req.send_request(options)
|
435
|
+
end
|
436
|
+
|
389
437
|
# Associates a group (batch) of assets with an IoT SiteWise Monitor
|
390
438
|
# project.
|
391
439
|
#
|
@@ -1135,8 +1183,7 @@ module Aws::IoTSiteWise
|
|
1135
1183
|
# China Regions.
|
1136
1184
|
#
|
1137
1185
|
# * `IAM` – The portal uses Identity and Access Management to
|
1138
|
-
# authenticate users and manage user permissions.
|
1139
|
-
# available in the China Regions.
|
1186
|
+
# authenticate users and manage user permissions.
|
1140
1187
|
#
|
1141
1188
|
# You can't change this value after you create a portal.
|
1142
1189
|
#
|
@@ -1218,6 +1265,11 @@ module Aws::IoTSiteWise
|
|
1218
1265
|
|
1219
1266
|
# Creates a project in the specified portal.
|
1220
1267
|
#
|
1268
|
+
# <note markdown="1"> Make sure that the project name and description don't contain
|
1269
|
+
# confidential information.
|
1270
|
+
#
|
1271
|
+
# </note>
|
1272
|
+
#
|
1221
1273
|
# @option params [required, String] :portal_id
|
1222
1274
|
# The ID of the portal in which to create the project.
|
1223
1275
|
#
|
@@ -1520,6 +1572,58 @@ module Aws::IoTSiteWise
|
|
1520
1572
|
req.send_request(options)
|
1521
1573
|
end
|
1522
1574
|
|
1575
|
+
# Deletes a time series (data stream). If you delete a time series
|
1576
|
+
# that's associated with an asset property, the asset property still
|
1577
|
+
# exists, but the time series will no longer be associated with this
|
1578
|
+
# asset property.
|
1579
|
+
#
|
1580
|
+
# To identify a time series, do one of the following:
|
1581
|
+
#
|
1582
|
+
# * If the time series isn't associated with an asset property, specify
|
1583
|
+
# the `alias` of the time series.
|
1584
|
+
#
|
1585
|
+
# * If the time series is associated with an asset property, specify one
|
1586
|
+
# of the following:
|
1587
|
+
#
|
1588
|
+
# * The `alias` of the time series.
|
1589
|
+
#
|
1590
|
+
# * The `assetId` and `propertyId` that identifies the asset property.
|
1591
|
+
#
|
1592
|
+
# @option params [String] :alias
|
1593
|
+
# The alias that identifies the time series.
|
1594
|
+
#
|
1595
|
+
# @option params [String] :asset_id
|
1596
|
+
# The ID of the asset in which the asset property was created.
|
1597
|
+
#
|
1598
|
+
# @option params [String] :property_id
|
1599
|
+
# The ID of the asset property.
|
1600
|
+
#
|
1601
|
+
# @option params [String] :client_token
|
1602
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
1603
|
+
# idempotency of the request. Don't reuse this client token if a new
|
1604
|
+
# idempotent request is required.
|
1605
|
+
#
|
1606
|
+
# **A suitable default value is auto-generated.** You should normally
|
1607
|
+
# not need to pass this option.**
|
1608
|
+
#
|
1609
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1610
|
+
#
|
1611
|
+
# @example Request syntax with placeholder values
|
1612
|
+
#
|
1613
|
+
# resp = client.delete_time_series({
|
1614
|
+
# alias: "PropertyAlias",
|
1615
|
+
# asset_id: "ID",
|
1616
|
+
# property_id: "ID",
|
1617
|
+
# client_token: "ClientToken",
|
1618
|
+
# })
|
1619
|
+
#
|
1620
|
+
# @overload delete_time_series(params = {})
|
1621
|
+
# @param [Hash] params ({})
|
1622
|
+
def delete_time_series(params = {}, options = {})
|
1623
|
+
req = build_request(:delete_time_series, params)
|
1624
|
+
req.send_request(options)
|
1625
|
+
end
|
1626
|
+
|
1523
1627
|
# Describes an access policy, which specifies an identity's access to
|
1524
1628
|
# an IoT SiteWise Monitor portal or project.
|
1525
1629
|
#
|
@@ -2133,6 +2237,8 @@ module Aws::IoTSiteWise
|
|
2133
2237
|
#
|
2134
2238
|
# * {Types::DescribeStorageConfigurationResponse#storage_type #storage_type} => String
|
2135
2239
|
# * {Types::DescribeStorageConfigurationResponse#multi_layer_storage #multi_layer_storage} => Types::MultiLayerStorage
|
2240
|
+
# * {Types::DescribeStorageConfigurationResponse#disassociated_data_storage #disassociated_data_storage} => String
|
2241
|
+
# * {Types::DescribeStorageConfigurationResponse#retention_period #retention_period} => Types::RetentionPeriod
|
2136
2242
|
# * {Types::DescribeStorageConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
|
2137
2243
|
# * {Types::DescribeStorageConfigurationResponse#last_update_date #last_update_date} => Time
|
2138
2244
|
#
|
@@ -2141,6 +2247,9 @@ module Aws::IoTSiteWise
|
|
2141
2247
|
# resp.storage_type #=> String, one of "SITEWISE_DEFAULT_STORAGE", "MULTI_LAYER_STORAGE"
|
2142
2248
|
# resp.multi_layer_storage.customer_managed_s3_storage.s3_resource_arn #=> String
|
2143
2249
|
# resp.multi_layer_storage.customer_managed_s3_storage.role_arn #=> String
|
2250
|
+
# resp.disassociated_data_storage #=> String, one of "ENABLED", "DISABLED"
|
2251
|
+
# resp.retention_period.number_of_days #=> Integer
|
2252
|
+
# resp.retention_period.unlimited #=> Boolean
|
2144
2253
|
# resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
2145
2254
|
# resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
2146
2255
|
# resp.configuration_status.error.message #=> String
|
@@ -2153,6 +2262,66 @@ module Aws::IoTSiteWise
|
|
2153
2262
|
req.send_request(options)
|
2154
2263
|
end
|
2155
2264
|
|
2265
|
+
# Retrieves information about a time series (data stream).
|
2266
|
+
#
|
2267
|
+
# To identify a time series, do one of the following:
|
2268
|
+
#
|
2269
|
+
# * If the time series isn't associated with an asset property, specify
|
2270
|
+
# the `alias` of the time series.
|
2271
|
+
#
|
2272
|
+
# * If the time series is associated with an asset property, specify one
|
2273
|
+
# of the following:
|
2274
|
+
#
|
2275
|
+
# * The `alias` of the time series.
|
2276
|
+
#
|
2277
|
+
# * The `assetId` and `propertyId` that identifies the asset property.
|
2278
|
+
#
|
2279
|
+
# @option params [String] :alias
|
2280
|
+
# The alias that identifies the time series.
|
2281
|
+
#
|
2282
|
+
# @option params [String] :asset_id
|
2283
|
+
# The ID of the asset in which the asset property was created.
|
2284
|
+
#
|
2285
|
+
# @option params [String] :property_id
|
2286
|
+
# The ID of the asset property.
|
2287
|
+
#
|
2288
|
+
# @return [Types::DescribeTimeSeriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2289
|
+
#
|
2290
|
+
# * {Types::DescribeTimeSeriesResponse#asset_id #asset_id} => String
|
2291
|
+
# * {Types::DescribeTimeSeriesResponse#property_id #property_id} => String
|
2292
|
+
# * {Types::DescribeTimeSeriesResponse#alias #alias} => String
|
2293
|
+
# * {Types::DescribeTimeSeriesResponse#time_series_id #time_series_id} => String
|
2294
|
+
# * {Types::DescribeTimeSeriesResponse#data_type #data_type} => String
|
2295
|
+
# * {Types::DescribeTimeSeriesResponse#data_type_spec #data_type_spec} => String
|
2296
|
+
# * {Types::DescribeTimeSeriesResponse#time_series_creation_date #time_series_creation_date} => Time
|
2297
|
+
# * {Types::DescribeTimeSeriesResponse#time_series_last_update_date #time_series_last_update_date} => Time
|
2298
|
+
#
|
2299
|
+
# @example Request syntax with placeholder values
|
2300
|
+
#
|
2301
|
+
# resp = client.describe_time_series({
|
2302
|
+
# alias: "PropertyAlias",
|
2303
|
+
# asset_id: "ID",
|
2304
|
+
# property_id: "ID",
|
2305
|
+
# })
|
2306
|
+
#
|
2307
|
+
# @example Response structure
|
2308
|
+
#
|
2309
|
+
# resp.asset_id #=> String
|
2310
|
+
# resp.property_id #=> String
|
2311
|
+
# resp.alias #=> String
|
2312
|
+
# resp.time_series_id #=> String
|
2313
|
+
# resp.data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
2314
|
+
# resp.data_type_spec #=> String
|
2315
|
+
# resp.time_series_creation_date #=> Time
|
2316
|
+
# resp.time_series_last_update_date #=> Time
|
2317
|
+
#
|
2318
|
+
# @overload describe_time_series(params = {})
|
2319
|
+
# @param [Hash] params ({})
|
2320
|
+
def describe_time_series(params = {}, options = {})
|
2321
|
+
req = build_request(:describe_time_series, params)
|
2322
|
+
req.send_request(options)
|
2323
|
+
end
|
2324
|
+
|
2156
2325
|
# Disassociates a child asset from the given parent asset through a
|
2157
2326
|
# hierarchy defined in the parent asset's model.
|
2158
2327
|
#
|
@@ -2199,6 +2368,43 @@ module Aws::IoTSiteWise
|
|
2199
2368
|
req.send_request(options)
|
2200
2369
|
end
|
2201
2370
|
|
2371
|
+
# Disassociates a time series (data stream) from an asset property.
|
2372
|
+
#
|
2373
|
+
# @option params [required, String] :alias
|
2374
|
+
# The alias that identifies the time series.
|
2375
|
+
#
|
2376
|
+
# @option params [required, String] :asset_id
|
2377
|
+
# The ID of the asset in which the asset property was created.
|
2378
|
+
#
|
2379
|
+
# @option params [required, String] :property_id
|
2380
|
+
# The ID of the asset property.
|
2381
|
+
#
|
2382
|
+
# @option params [String] :client_token
|
2383
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
2384
|
+
# idempotency of the request. Don't reuse this client token if a new
|
2385
|
+
# idempotent request is required.
|
2386
|
+
#
|
2387
|
+
# **A suitable default value is auto-generated.** You should normally
|
2388
|
+
# not need to pass this option.**
|
2389
|
+
#
|
2390
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2391
|
+
#
|
2392
|
+
# @example Request syntax with placeholder values
|
2393
|
+
#
|
2394
|
+
# resp = client.disassociate_time_series_from_asset_property({
|
2395
|
+
# alias: "PropertyAlias", # required
|
2396
|
+
# asset_id: "ID", # required
|
2397
|
+
# property_id: "ID", # required
|
2398
|
+
# client_token: "ClientToken",
|
2399
|
+
# })
|
2400
|
+
#
|
2401
|
+
# @overload disassociate_time_series_from_asset_property(params = {})
|
2402
|
+
# @param [Hash] params ({})
|
2403
|
+
def disassociate_time_series_from_asset_property(params = {}, options = {})
|
2404
|
+
req = build_request(:disassociate_time_series_from_asset_property, params)
|
2405
|
+
req.send_request(options)
|
2406
|
+
end
|
2407
|
+
|
2202
2408
|
# Gets aggregated values for an asset property. For more information,
|
2203
2409
|
# see [Querying aggregates][1] in the *IoT SiteWise User Guide*.
|
2204
2410
|
#
|
@@ -2542,7 +2748,7 @@ module Aws::IoTSiteWise
|
|
2542
2748
|
#
|
2543
2749
|
# For example, you can use this operation to return the interpolated
|
2544
2750
|
# temperature values for a wind turbine every 24 hours over a duration
|
2545
|
-
# of 7 days. If the interpolation starts
|
2751
|
+
# of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT
|
2546
2752
|
# SiteWise returns the first interpolated value on July 2, 2021, at 9
|
2547
2753
|
# AM, the second interpolated value on July 3, 2021, at 9 AM, and so
|
2548
2754
|
# on.
|
@@ -2555,28 +2761,28 @@ module Aws::IoTSiteWise
|
|
2555
2761
|
# forward this interpolated value until a new data point is found.
|
2556
2762
|
#
|
2557
2763
|
# For example, you can get the state of an on-off valve every 24 hours
|
2558
|
-
# over a duration of 7 days. If the interpolation starts
|
2559
|
-
#
|
2560
|
-
#
|
2561
|
-
# interpolated value. If
|
2562
|
-
# 2021, IoT SiteWise uses the same interpolated value for the rest
|
2563
|
-
# the days.
|
2764
|
+
# over a duration of 7 days. If the interpolation starts July 1, 2021,
|
2765
|
+
# at 9 AM, IoT SiteWise returns the last observed data point between
|
2766
|
+
# July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first
|
2767
|
+
# interpolated value. If a data point isn't found after 9 AM on July
|
2768
|
+
# 2, 2021, IoT SiteWise uses the same interpolated value for the rest
|
2769
|
+
# of the days.
|
2564
2770
|
#
|
2565
2771
|
#
|
2566
2772
|
#
|
2567
2773
|
# [1]: https://en.wikipedia.org/wiki/Linear_interpolation
|
2568
2774
|
#
|
2569
2775
|
# @option params [Integer] :interval_window_in_seconds
|
2570
|
-
# The query interval for the window in seconds. IoT SiteWise computes
|
2776
|
+
# The query interval for the window, in seconds. IoT SiteWise computes
|
2571
2777
|
# each interpolated value by using data points from the timestamp of
|
2572
|
-
# each interval minus the window to the timestamp of each interval plus
|
2573
|
-
# the window. If not specified, the window
|
2778
|
+
# each interval, minus the window to the timestamp of each interval plus
|
2779
|
+
# the window. If not specified, the window ranges between the start time
|
2574
2780
|
# minus the interval and the end time plus the interval.
|
2575
2781
|
#
|
2576
2782
|
# <note markdown="1"> * If you specify a value for the `intervalWindowInSeconds` parameter,
|
2577
|
-
# the `type` parameter must be `LINEAR_INTERPOLATION`.
|
2783
|
+
# the value for the `type` parameter must be `LINEAR_INTERPOLATION`.
|
2578
2784
|
#
|
2579
|
-
# * If
|
2785
|
+
# * If a data point isn't found during the specified query window, IoT
|
2580
2786
|
# SiteWise won't return an interpolated value for the interval. This
|
2581
2787
|
# indicates that there's a gap in the ingested data points.
|
2582
2788
|
#
|
@@ -2585,11 +2791,11 @@ module Aws::IoTSiteWise
|
|
2585
2791
|
# For example, you can get the interpolated temperature values for a
|
2586
2792
|
# wind turbine every 24 hours over a duration of 7 days. If the
|
2587
2793
|
# interpolation starts on July 1, 2021, at 9 AM with a window of 2
|
2588
|
-
# hours, IoT SiteWise uses the data points from 7 AM (9 AM
|
2589
|
-
# 11 AM (9 AM
|
2590
|
-
# interpolated value, uses the data points from
|
2591
|
-
# 11 AM (9 AM
|
2592
|
-
# interpolated value, and so on.
|
2794
|
+
# hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2
|
2795
|
+
# hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute the
|
2796
|
+
# first interpolated value. Next, IoT SiteWise uses the data points from
|
2797
|
+
# 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021
|
2798
|
+
# to compute the second interpolated value, and so on.
|
2593
2799
|
#
|
2594
2800
|
# @return [Types::GetInterpolatedAssetPropertyValuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2595
2801
|
#
|
@@ -3247,6 +3453,66 @@ module Aws::IoTSiteWise
|
|
3247
3453
|
req.send_request(options)
|
3248
3454
|
end
|
3249
3455
|
|
3456
|
+
# Retrieves a paginated list of time series (data streams).
|
3457
|
+
#
|
3458
|
+
# @option params [String] :next_token
|
3459
|
+
# The token to be used for the next set of paginated results.
|
3460
|
+
#
|
3461
|
+
# @option params [Integer] :max_results
|
3462
|
+
# The maximum number of results to return for each paginated request.
|
3463
|
+
#
|
3464
|
+
# @option params [String] :asset_id
|
3465
|
+
# The ID of the asset in which the asset property was created.
|
3466
|
+
#
|
3467
|
+
# @option params [String] :alias_prefix
|
3468
|
+
# The alias prefix of the time series.
|
3469
|
+
#
|
3470
|
+
# @option params [String] :time_series_type
|
3471
|
+
# The type of the time series. The time series type can be one of the
|
3472
|
+
# following values:
|
3473
|
+
#
|
3474
|
+
# * `ASSOCIATED` – The time series is associated with an asset property.
|
3475
|
+
#
|
3476
|
+
# * `DISASSOCIATED` – The time series isn't associated with any asset
|
3477
|
+
# property.
|
3478
|
+
#
|
3479
|
+
# @return [Types::ListTimeSeriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3480
|
+
#
|
3481
|
+
# * {Types::ListTimeSeriesResponse#time_series_summaries #time_series_summaries} => Array<Types::TimeSeriesSummary>
|
3482
|
+
# * {Types::ListTimeSeriesResponse#next_token #next_token} => String
|
3483
|
+
#
|
3484
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3485
|
+
#
|
3486
|
+
# @example Request syntax with placeholder values
|
3487
|
+
#
|
3488
|
+
# resp = client.list_time_series({
|
3489
|
+
# next_token: "NextToken",
|
3490
|
+
# max_results: 1,
|
3491
|
+
# asset_id: "ID",
|
3492
|
+
# alias_prefix: "PropertyAlias",
|
3493
|
+
# time_series_type: "ASSOCIATED", # accepts ASSOCIATED, DISASSOCIATED
|
3494
|
+
# })
|
3495
|
+
#
|
3496
|
+
# @example Response structure
|
3497
|
+
#
|
3498
|
+
# resp.time_series_summaries #=> Array
|
3499
|
+
# resp.time_series_summaries[0].asset_id #=> String
|
3500
|
+
# resp.time_series_summaries[0].property_id #=> String
|
3501
|
+
# resp.time_series_summaries[0].alias #=> String
|
3502
|
+
# resp.time_series_summaries[0].time_series_id #=> String
|
3503
|
+
# resp.time_series_summaries[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
3504
|
+
# resp.time_series_summaries[0].data_type_spec #=> String
|
3505
|
+
# resp.time_series_summaries[0].time_series_creation_date #=> Time
|
3506
|
+
# resp.time_series_summaries[0].time_series_last_update_date #=> Time
|
3507
|
+
# resp.next_token #=> String
|
3508
|
+
#
|
3509
|
+
# @overload list_time_series(params = {})
|
3510
|
+
# @param [Hash] params ({})
|
3511
|
+
def list_time_series(params = {}, options = {})
|
3512
|
+
req = build_request(:list_time_series, params)
|
3513
|
+
req.send_request(options)
|
3514
|
+
end
|
3515
|
+
|
3250
3516
|
# Sets the default encryption configuration for the Amazon Web Services
|
3251
3517
|
# account. For more information, see [Key management][1] in the *IoT
|
3252
3518
|
# SiteWise User Guide*.
|
@@ -3259,8 +3525,8 @@ module Aws::IoTSiteWise
|
|
3259
3525
|
# The type of encryption used for the encryption configuration.
|
3260
3526
|
#
|
3261
3527
|
# @option params [String] :kms_key_id
|
3262
|
-
# The Key ID of the customer managed
|
3263
|
-
#
|
3528
|
+
# The Key ID of the customer managed key used for KMS encryption. This
|
3529
|
+
# is required if you use `KMS_BASED_ENCRYPTION`.
|
3264
3530
|
#
|
3265
3531
|
# @return [Types::PutDefaultEncryptionConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3266
3532
|
#
|
@@ -3315,25 +3581,52 @@ module Aws::IoTSiteWise
|
|
3315
3581
|
# Configures storage settings for IoT SiteWise.
|
3316
3582
|
#
|
3317
3583
|
# @option params [required, String] :storage_type
|
3318
|
-
# The
|
3319
|
-
# can be one of the following values:
|
3584
|
+
# The storage tier that you specified for your data. The `storageType`
|
3585
|
+
# parameter can be one of the following values:
|
3320
3586
|
#
|
3321
|
-
# * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise
|
3322
|
-
# a service
|
3587
|
+
# * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise saves your data into the
|
3588
|
+
# hot tier. The hot tier is a service-managed database.
|
3323
3589
|
#
|
3324
|
-
# * `MULTI_LAYER_STORAGE` – IoT SiteWise
|
3325
|
-
#
|
3326
|
-
#
|
3590
|
+
# * `MULTI_LAYER_STORAGE` – IoT SiteWise saves your data in both the
|
3591
|
+
# cold tier and the cold tier. The cold tier is a customer-managed
|
3592
|
+
# Amazon S3 bucket.
|
3327
3593
|
#
|
3328
3594
|
# @option params [Types::MultiLayerStorage] :multi_layer_storage
|
3329
3595
|
# Identifies a storage destination. If you specified
|
3330
3596
|
# `MULTI_LAYER_STORAGE` for the storage type, you must specify a
|
3331
3597
|
# `MultiLayerStorage` object.
|
3332
3598
|
#
|
3599
|
+
# @option params [String] :disassociated_data_storage
|
3600
|
+
# Contains the storage configuration for time series (data streams) that
|
3601
|
+
# aren't associated with asset properties. The
|
3602
|
+
# `disassociatedDataStorage` can be one of the following values:
|
3603
|
+
#
|
3604
|
+
# * `ENABLED` – IoT SiteWise accepts time series that aren't associated
|
3605
|
+
# with asset properties.
|
3606
|
+
#
|
3607
|
+
# After the `disassociatedDataStorage` is enabled, you can't disable
|
3608
|
+
# it.
|
3609
|
+
#
|
3610
|
+
# * `DISABLED` – IoT SiteWise doesn't accept time series (data streams)
|
3611
|
+
# that aren't associated with asset properties.
|
3612
|
+
#
|
3613
|
+
# For more information, see [Data streams][1] in the *IoT SiteWise User
|
3614
|
+
# Guide*.
|
3615
|
+
#
|
3616
|
+
#
|
3617
|
+
#
|
3618
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html
|
3619
|
+
#
|
3620
|
+
# @option params [Types::RetentionPeriod] :retention_period
|
3621
|
+
# How many days your data is kept in the hot tier. By default, your data
|
3622
|
+
# is kept indefinitely in the hot tier.
|
3623
|
+
#
|
3333
3624
|
# @return [Types::PutStorageConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3334
3625
|
#
|
3335
3626
|
# * {Types::PutStorageConfigurationResponse#storage_type #storage_type} => String
|
3336
3627
|
# * {Types::PutStorageConfigurationResponse#multi_layer_storage #multi_layer_storage} => Types::MultiLayerStorage
|
3628
|
+
# * {Types::PutStorageConfigurationResponse#disassociated_data_storage #disassociated_data_storage} => String
|
3629
|
+
# * {Types::PutStorageConfigurationResponse#retention_period #retention_period} => Types::RetentionPeriod
|
3337
3630
|
# * {Types::PutStorageConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
|
3338
3631
|
#
|
3339
3632
|
# @example Request syntax with placeholder values
|
@@ -3346,6 +3639,11 @@ module Aws::IoTSiteWise
|
|
3346
3639
|
# role_arn: "ARN", # required
|
3347
3640
|
# },
|
3348
3641
|
# },
|
3642
|
+
# disassociated_data_storage: "ENABLED", # accepts ENABLED, DISABLED
|
3643
|
+
# retention_period: {
|
3644
|
+
# number_of_days: 1,
|
3645
|
+
# unlimited: false,
|
3646
|
+
# },
|
3349
3647
|
# })
|
3350
3648
|
#
|
3351
3649
|
# @example Response structure
|
@@ -3353,6 +3651,9 @@ module Aws::IoTSiteWise
|
|
3353
3651
|
# resp.storage_type #=> String, one of "SITEWISE_DEFAULT_STORAGE", "MULTI_LAYER_STORAGE"
|
3354
3652
|
# resp.multi_layer_storage.customer_managed_s3_storage.s3_resource_arn #=> String
|
3355
3653
|
# resp.multi_layer_storage.customer_managed_s3_storage.role_arn #=> String
|
3654
|
+
# resp.disassociated_data_storage #=> String, one of "ENABLED", "DISABLED"
|
3655
|
+
# resp.retention_period.number_of_days #=> Integer
|
3656
|
+
# resp.retention_period.unlimited #=> Boolean
|
3356
3657
|
# resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
3357
3658
|
# resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
3358
3659
|
# resp.configuration_status.error.message #=> String
|
@@ -4124,7 +4425,7 @@ module Aws::IoTSiteWise
|
|
4124
4425
|
params: params,
|
4125
4426
|
config: config)
|
4126
4427
|
context[:gem_name] = 'aws-sdk-iotsitewise'
|
4127
|
-
context[:gem_version] = '1.
|
4428
|
+
context[:gem_version] = '1.38.0'
|
4128
4429
|
Seahorse::Client::Request.new(handlers, context)
|
4129
4430
|
end
|
4130
4431
|
|