aws-sdk-iotsitewise 1.32.0 → 1.36.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 +328 -29
- 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: 56a09a019ded1c99680322c2094dba46d7ba9f4433fb9a3378d5178196b55f8e
|
4
|
+
data.tar.gz: '09d6b35c24d701c39ccb11d2e907c2d74aebcf13192c29363fb4850e2741d522'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ddd95a3277bed53de14de33c8ba48a3535dc8ed76dd768f75c946a7d81b0037a745ee47bf313d79dcd622b248d9cdd914f33546aa9fa20a52adfc96a20a9718b
|
7
|
+
data.tar.gz: '0179e2a3ac7b7a249ff908871861cf42a687ac69440fcbc7ad0465877bd466320d1db8030439f5d2d6ca190535950ab6aa0d6158b8c13d56d25efcc26dfd3900'
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.36.0 (2021-11-29)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - AWS IoT SiteWise now supports retention configuration for the hot tier storage.
|
8
|
+
|
9
|
+
1.35.0 (2021-11-24)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* 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.
|
13
|
+
|
14
|
+
1.34.0 (2021-11-04)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.33.0 (2021-10-18)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.32.0 (2021-09-01)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.36.0
|
@@ -275,6 +275,15 @@ module Aws::IoTSiteWise
|
|
275
275
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
276
|
# requests are made, and retries are disabled.
|
277
277
|
#
|
278
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
279
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
280
|
+
# will be used if available.
|
281
|
+
#
|
282
|
+
# @option options [Boolean] :use_fips_endpoint
|
283
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
284
|
+
# When a `fips` region is used, the region is normalized and this config
|
285
|
+
# is set to `true`.
|
286
|
+
#
|
278
287
|
# @option options [Boolean] :validate_params (true)
|
279
288
|
# When `true`, request parameters are validated before
|
280
289
|
# sending the request.
|
@@ -377,6 +386,43 @@ module Aws::IoTSiteWise
|
|
377
386
|
req.send_request(options)
|
378
387
|
end
|
379
388
|
|
389
|
+
# Associates a time series (data stream) with an asset property.
|
390
|
+
#
|
391
|
+
# @option params [required, String] :alias
|
392
|
+
# The alias that identifies the time series.
|
393
|
+
#
|
394
|
+
# @option params [required, String] :asset_id
|
395
|
+
# The ID of the asset in which the asset property was created.
|
396
|
+
#
|
397
|
+
# @option params [required, String] :property_id
|
398
|
+
# The ID of the asset property.
|
399
|
+
#
|
400
|
+
# @option params [String] :client_token
|
401
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
402
|
+
# idempotency of the request. Don't reuse this client token if a new
|
403
|
+
# idempotent request is required.
|
404
|
+
#
|
405
|
+
# **A suitable default value is auto-generated.** You should normally
|
406
|
+
# not need to pass this option.**
|
407
|
+
#
|
408
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
409
|
+
#
|
410
|
+
# @example Request syntax with placeholder values
|
411
|
+
#
|
412
|
+
# resp = client.associate_time_series_to_asset_property({
|
413
|
+
# alias: "PropertyAlias", # required
|
414
|
+
# asset_id: "ID", # required
|
415
|
+
# property_id: "ID", # required
|
416
|
+
# client_token: "ClientToken",
|
417
|
+
# })
|
418
|
+
#
|
419
|
+
# @overload associate_time_series_to_asset_property(params = {})
|
420
|
+
# @param [Hash] params ({})
|
421
|
+
def associate_time_series_to_asset_property(params = {}, options = {})
|
422
|
+
req = build_request(:associate_time_series_to_asset_property, params)
|
423
|
+
req.send_request(options)
|
424
|
+
end
|
425
|
+
|
380
426
|
# Associates a group (batch) of assets with an IoT SiteWise Monitor
|
381
427
|
# project.
|
382
428
|
#
|
@@ -1126,8 +1172,7 @@ module Aws::IoTSiteWise
|
|
1126
1172
|
# China Regions.
|
1127
1173
|
#
|
1128
1174
|
# * `IAM` – The portal uses Identity and Access Management to
|
1129
|
-
# authenticate users and manage user permissions.
|
1130
|
-
# available in the China Regions.
|
1175
|
+
# authenticate users and manage user permissions.
|
1131
1176
|
#
|
1132
1177
|
# You can't change this value after you create a portal.
|
1133
1178
|
#
|
@@ -1209,6 +1254,11 @@ module Aws::IoTSiteWise
|
|
1209
1254
|
|
1210
1255
|
# Creates a project in the specified portal.
|
1211
1256
|
#
|
1257
|
+
# <note markdown="1"> Make sure that the project name and description don't contain
|
1258
|
+
# confidential information.
|
1259
|
+
#
|
1260
|
+
# </note>
|
1261
|
+
#
|
1212
1262
|
# @option params [required, String] :portal_id
|
1213
1263
|
# The ID of the portal in which to create the project.
|
1214
1264
|
#
|
@@ -1511,6 +1561,58 @@ module Aws::IoTSiteWise
|
|
1511
1561
|
req.send_request(options)
|
1512
1562
|
end
|
1513
1563
|
|
1564
|
+
# Deletes a time series (data stream). If you delete a time series
|
1565
|
+
# that's associated with an asset property, the asset property still
|
1566
|
+
# exists, but the time series will no longer be associated with this
|
1567
|
+
# asset property.
|
1568
|
+
#
|
1569
|
+
# To identify a time series, do one of the following:
|
1570
|
+
#
|
1571
|
+
# * If the time series isn't associated with an asset property, specify
|
1572
|
+
# the `alias` of the time series.
|
1573
|
+
#
|
1574
|
+
# * If the time series is associated with an asset property, specify one
|
1575
|
+
# of the following:
|
1576
|
+
#
|
1577
|
+
# * The `alias` of the time series.
|
1578
|
+
#
|
1579
|
+
# * The `assetId` and `propertyId` that identifies the asset property.
|
1580
|
+
#
|
1581
|
+
# @option params [String] :alias
|
1582
|
+
# The alias that identifies the time series.
|
1583
|
+
#
|
1584
|
+
# @option params [String] :asset_id
|
1585
|
+
# The ID of the asset in which the asset property was created.
|
1586
|
+
#
|
1587
|
+
# @option params [String] :property_id
|
1588
|
+
# The ID of the asset property.
|
1589
|
+
#
|
1590
|
+
# @option params [String] :client_token
|
1591
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
1592
|
+
# idempotency of the request. Don't reuse this client token if a new
|
1593
|
+
# idempotent request is required.
|
1594
|
+
#
|
1595
|
+
# **A suitable default value is auto-generated.** You should normally
|
1596
|
+
# not need to pass this option.**
|
1597
|
+
#
|
1598
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1599
|
+
#
|
1600
|
+
# @example Request syntax with placeholder values
|
1601
|
+
#
|
1602
|
+
# resp = client.delete_time_series({
|
1603
|
+
# alias: "PropertyAlias",
|
1604
|
+
# asset_id: "ID",
|
1605
|
+
# property_id: "ID",
|
1606
|
+
# client_token: "ClientToken",
|
1607
|
+
# })
|
1608
|
+
#
|
1609
|
+
# @overload delete_time_series(params = {})
|
1610
|
+
# @param [Hash] params ({})
|
1611
|
+
def delete_time_series(params = {}, options = {})
|
1612
|
+
req = build_request(:delete_time_series, params)
|
1613
|
+
req.send_request(options)
|
1614
|
+
end
|
1615
|
+
|
1514
1616
|
# Describes an access policy, which specifies an identity's access to
|
1515
1617
|
# an IoT SiteWise Monitor portal or project.
|
1516
1618
|
#
|
@@ -2124,6 +2226,8 @@ module Aws::IoTSiteWise
|
|
2124
2226
|
#
|
2125
2227
|
# * {Types::DescribeStorageConfigurationResponse#storage_type #storage_type} => String
|
2126
2228
|
# * {Types::DescribeStorageConfigurationResponse#multi_layer_storage #multi_layer_storage} => Types::MultiLayerStorage
|
2229
|
+
# * {Types::DescribeStorageConfigurationResponse#disassociated_data_storage #disassociated_data_storage} => String
|
2230
|
+
# * {Types::DescribeStorageConfigurationResponse#retention_period #retention_period} => Types::RetentionPeriod
|
2127
2231
|
# * {Types::DescribeStorageConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
|
2128
2232
|
# * {Types::DescribeStorageConfigurationResponse#last_update_date #last_update_date} => Time
|
2129
2233
|
#
|
@@ -2132,6 +2236,9 @@ module Aws::IoTSiteWise
|
|
2132
2236
|
# resp.storage_type #=> String, one of "SITEWISE_DEFAULT_STORAGE", "MULTI_LAYER_STORAGE"
|
2133
2237
|
# resp.multi_layer_storage.customer_managed_s3_storage.s3_resource_arn #=> String
|
2134
2238
|
# resp.multi_layer_storage.customer_managed_s3_storage.role_arn #=> String
|
2239
|
+
# resp.disassociated_data_storage #=> String, one of "ENABLED", "DISABLED"
|
2240
|
+
# resp.retention_period.number_of_days #=> Integer
|
2241
|
+
# resp.retention_period.unlimited #=> Boolean
|
2135
2242
|
# resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
2136
2243
|
# resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
2137
2244
|
# resp.configuration_status.error.message #=> String
|
@@ -2144,6 +2251,66 @@ module Aws::IoTSiteWise
|
|
2144
2251
|
req.send_request(options)
|
2145
2252
|
end
|
2146
2253
|
|
2254
|
+
# Retrieves information about a time series (data stream).
|
2255
|
+
#
|
2256
|
+
# To identify a time series, do one of the following:
|
2257
|
+
#
|
2258
|
+
# * If the time series isn't associated with an asset property, specify
|
2259
|
+
# the `alias` of the time series.
|
2260
|
+
#
|
2261
|
+
# * If the time series is associated with an asset property, specify one
|
2262
|
+
# of the following:
|
2263
|
+
#
|
2264
|
+
# * The `alias` of the time series.
|
2265
|
+
#
|
2266
|
+
# * The `assetId` and `propertyId` that identifies the asset property.
|
2267
|
+
#
|
2268
|
+
# @option params [String] :alias
|
2269
|
+
# The alias that identifies the time series.
|
2270
|
+
#
|
2271
|
+
# @option params [String] :asset_id
|
2272
|
+
# The ID of the asset in which the asset property was created.
|
2273
|
+
#
|
2274
|
+
# @option params [String] :property_id
|
2275
|
+
# The ID of the asset property.
|
2276
|
+
#
|
2277
|
+
# @return [Types::DescribeTimeSeriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2278
|
+
#
|
2279
|
+
# * {Types::DescribeTimeSeriesResponse#asset_id #asset_id} => String
|
2280
|
+
# * {Types::DescribeTimeSeriesResponse#property_id #property_id} => String
|
2281
|
+
# * {Types::DescribeTimeSeriesResponse#alias #alias} => String
|
2282
|
+
# * {Types::DescribeTimeSeriesResponse#time_series_id #time_series_id} => String
|
2283
|
+
# * {Types::DescribeTimeSeriesResponse#data_type #data_type} => String
|
2284
|
+
# * {Types::DescribeTimeSeriesResponse#data_type_spec #data_type_spec} => String
|
2285
|
+
# * {Types::DescribeTimeSeriesResponse#time_series_creation_date #time_series_creation_date} => Time
|
2286
|
+
# * {Types::DescribeTimeSeriesResponse#time_series_last_update_date #time_series_last_update_date} => Time
|
2287
|
+
#
|
2288
|
+
# @example Request syntax with placeholder values
|
2289
|
+
#
|
2290
|
+
# resp = client.describe_time_series({
|
2291
|
+
# alias: "PropertyAlias",
|
2292
|
+
# asset_id: "ID",
|
2293
|
+
# property_id: "ID",
|
2294
|
+
# })
|
2295
|
+
#
|
2296
|
+
# @example Response structure
|
2297
|
+
#
|
2298
|
+
# resp.asset_id #=> String
|
2299
|
+
# resp.property_id #=> String
|
2300
|
+
# resp.alias #=> String
|
2301
|
+
# resp.time_series_id #=> String
|
2302
|
+
# resp.data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
2303
|
+
# resp.data_type_spec #=> String
|
2304
|
+
# resp.time_series_creation_date #=> Time
|
2305
|
+
# resp.time_series_last_update_date #=> Time
|
2306
|
+
#
|
2307
|
+
# @overload describe_time_series(params = {})
|
2308
|
+
# @param [Hash] params ({})
|
2309
|
+
def describe_time_series(params = {}, options = {})
|
2310
|
+
req = build_request(:describe_time_series, params)
|
2311
|
+
req.send_request(options)
|
2312
|
+
end
|
2313
|
+
|
2147
2314
|
# Disassociates a child asset from the given parent asset through a
|
2148
2315
|
# hierarchy defined in the parent asset's model.
|
2149
2316
|
#
|
@@ -2190,6 +2357,43 @@ module Aws::IoTSiteWise
|
|
2190
2357
|
req.send_request(options)
|
2191
2358
|
end
|
2192
2359
|
|
2360
|
+
# Disassociates a time series (data stream) from an asset property.
|
2361
|
+
#
|
2362
|
+
# @option params [required, String] :alias
|
2363
|
+
# The alias that identifies the time series.
|
2364
|
+
#
|
2365
|
+
# @option params [required, String] :asset_id
|
2366
|
+
# The ID of the asset in which the asset property was created.
|
2367
|
+
#
|
2368
|
+
# @option params [required, String] :property_id
|
2369
|
+
# The ID of the asset property.
|
2370
|
+
#
|
2371
|
+
# @option params [String] :client_token
|
2372
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
2373
|
+
# idempotency of the request. Don't reuse this client token if a new
|
2374
|
+
# idempotent request is required.
|
2375
|
+
#
|
2376
|
+
# **A suitable default value is auto-generated.** You should normally
|
2377
|
+
# not need to pass this option.**
|
2378
|
+
#
|
2379
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2380
|
+
#
|
2381
|
+
# @example Request syntax with placeholder values
|
2382
|
+
#
|
2383
|
+
# resp = client.disassociate_time_series_from_asset_property({
|
2384
|
+
# alias: "PropertyAlias", # required
|
2385
|
+
# asset_id: "ID", # required
|
2386
|
+
# property_id: "ID", # required
|
2387
|
+
# client_token: "ClientToken",
|
2388
|
+
# })
|
2389
|
+
#
|
2390
|
+
# @overload disassociate_time_series_from_asset_property(params = {})
|
2391
|
+
# @param [Hash] params ({})
|
2392
|
+
def disassociate_time_series_from_asset_property(params = {}, options = {})
|
2393
|
+
req = build_request(:disassociate_time_series_from_asset_property, params)
|
2394
|
+
req.send_request(options)
|
2395
|
+
end
|
2396
|
+
|
2193
2397
|
# Gets aggregated values for an asset property. For more information,
|
2194
2398
|
# see [Querying aggregates][1] in the *IoT SiteWise User Guide*.
|
2195
2399
|
#
|
@@ -2533,7 +2737,7 @@ module Aws::IoTSiteWise
|
|
2533
2737
|
#
|
2534
2738
|
# For example, you can use this operation to return the interpolated
|
2535
2739
|
# temperature values for a wind turbine every 24 hours over a duration
|
2536
|
-
# of 7 days. If the interpolation starts
|
2740
|
+
# of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT
|
2537
2741
|
# SiteWise returns the first interpolated value on July 2, 2021, at 9
|
2538
2742
|
# AM, the second interpolated value on July 3, 2021, at 9 AM, and so
|
2539
2743
|
# on.
|
@@ -2546,28 +2750,28 @@ module Aws::IoTSiteWise
|
|
2546
2750
|
# forward this interpolated value until a new data point is found.
|
2547
2751
|
#
|
2548
2752
|
# For example, you can get the state of an on-off valve every 24 hours
|
2549
|
-
# over a duration of 7 days. If the interpolation starts
|
2550
|
-
#
|
2551
|
-
#
|
2552
|
-
# interpolated value. If
|
2553
|
-
# 2021, IoT SiteWise uses the same interpolated value for the rest
|
2554
|
-
# the days.
|
2753
|
+
# over a duration of 7 days. If the interpolation starts July 1, 2021,
|
2754
|
+
# at 9 AM, IoT SiteWise returns the last observed data point between
|
2755
|
+
# July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first
|
2756
|
+
# interpolated value. If a data point isn't found after 9 AM on July
|
2757
|
+
# 2, 2021, IoT SiteWise uses the same interpolated value for the rest
|
2758
|
+
# of the days.
|
2555
2759
|
#
|
2556
2760
|
#
|
2557
2761
|
#
|
2558
2762
|
# [1]: https://en.wikipedia.org/wiki/Linear_interpolation
|
2559
2763
|
#
|
2560
2764
|
# @option params [Integer] :interval_window_in_seconds
|
2561
|
-
# The query interval for the window in seconds. IoT SiteWise computes
|
2765
|
+
# The query interval for the window, in seconds. IoT SiteWise computes
|
2562
2766
|
# each interpolated value by using data points from the timestamp of
|
2563
|
-
# each interval minus the window to the timestamp of each interval plus
|
2564
|
-
# the window. If not specified, the window
|
2767
|
+
# each interval, minus the window to the timestamp of each interval plus
|
2768
|
+
# the window. If not specified, the window ranges between the start time
|
2565
2769
|
# minus the interval and the end time plus the interval.
|
2566
2770
|
#
|
2567
2771
|
# <note markdown="1"> * If you specify a value for the `intervalWindowInSeconds` parameter,
|
2568
|
-
# the `type` parameter must be `LINEAR_INTERPOLATION`.
|
2772
|
+
# the value for the `type` parameter must be `LINEAR_INTERPOLATION`.
|
2569
2773
|
#
|
2570
|
-
# * If
|
2774
|
+
# * If a data point isn't found during the specified query window, IoT
|
2571
2775
|
# SiteWise won't return an interpolated value for the interval. This
|
2572
2776
|
# indicates that there's a gap in the ingested data points.
|
2573
2777
|
#
|
@@ -2576,11 +2780,11 @@ module Aws::IoTSiteWise
|
|
2576
2780
|
# For example, you can get the interpolated temperature values for a
|
2577
2781
|
# wind turbine every 24 hours over a duration of 7 days. If the
|
2578
2782
|
# interpolation starts on July 1, 2021, at 9 AM with a window of 2
|
2579
|
-
# hours, IoT SiteWise uses the data points from 7 AM (9 AM
|
2580
|
-
# 11 AM (9 AM
|
2581
|
-
# interpolated value, uses the data points from
|
2582
|
-
# 11 AM (9 AM
|
2583
|
-
# interpolated value, and so on.
|
2783
|
+
# hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2
|
2784
|
+
# hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute the
|
2785
|
+
# first interpolated value. Next, IoT SiteWise uses the data points from
|
2786
|
+
# 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021
|
2787
|
+
# to compute the second interpolated value, and so on.
|
2584
2788
|
#
|
2585
2789
|
# @return [Types::GetInterpolatedAssetPropertyValuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2586
2790
|
#
|
@@ -3238,6 +3442,66 @@ module Aws::IoTSiteWise
|
|
3238
3442
|
req.send_request(options)
|
3239
3443
|
end
|
3240
3444
|
|
3445
|
+
# Retrieves a paginated list of time series (data streams).
|
3446
|
+
#
|
3447
|
+
# @option params [String] :next_token
|
3448
|
+
# The token to be used for the next set of paginated results.
|
3449
|
+
#
|
3450
|
+
# @option params [Integer] :max_results
|
3451
|
+
# The maximum number of results to return for each paginated request.
|
3452
|
+
#
|
3453
|
+
# @option params [String] :asset_id
|
3454
|
+
# The ID of the asset in which the asset property was created.
|
3455
|
+
#
|
3456
|
+
# @option params [String] :alias_prefix
|
3457
|
+
# The alias prefix of the time series.
|
3458
|
+
#
|
3459
|
+
# @option params [String] :time_series_type
|
3460
|
+
# The type of the time series. The time series type can be one of the
|
3461
|
+
# following values:
|
3462
|
+
#
|
3463
|
+
# * `ASSOCIATED` – The time series is associated with an asset property.
|
3464
|
+
#
|
3465
|
+
# * `DISASSOCIATED` – The time series isn't associated with any asset
|
3466
|
+
# property.
|
3467
|
+
#
|
3468
|
+
# @return [Types::ListTimeSeriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3469
|
+
#
|
3470
|
+
# * {Types::ListTimeSeriesResponse#time_series_summaries #time_series_summaries} => Array<Types::TimeSeriesSummary>
|
3471
|
+
# * {Types::ListTimeSeriesResponse#next_token #next_token} => String
|
3472
|
+
#
|
3473
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3474
|
+
#
|
3475
|
+
# @example Request syntax with placeholder values
|
3476
|
+
#
|
3477
|
+
# resp = client.list_time_series({
|
3478
|
+
# next_token: "NextToken",
|
3479
|
+
# max_results: 1,
|
3480
|
+
# asset_id: "ID",
|
3481
|
+
# alias_prefix: "PropertyAlias",
|
3482
|
+
# time_series_type: "ASSOCIATED", # accepts ASSOCIATED, DISASSOCIATED
|
3483
|
+
# })
|
3484
|
+
#
|
3485
|
+
# @example Response structure
|
3486
|
+
#
|
3487
|
+
# resp.time_series_summaries #=> Array
|
3488
|
+
# resp.time_series_summaries[0].asset_id #=> String
|
3489
|
+
# resp.time_series_summaries[0].property_id #=> String
|
3490
|
+
# resp.time_series_summaries[0].alias #=> String
|
3491
|
+
# resp.time_series_summaries[0].time_series_id #=> String
|
3492
|
+
# resp.time_series_summaries[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
3493
|
+
# resp.time_series_summaries[0].data_type_spec #=> String
|
3494
|
+
# resp.time_series_summaries[0].time_series_creation_date #=> Time
|
3495
|
+
# resp.time_series_summaries[0].time_series_last_update_date #=> Time
|
3496
|
+
# resp.next_token #=> String
|
3497
|
+
#
|
3498
|
+
# @overload list_time_series(params = {})
|
3499
|
+
# @param [Hash] params ({})
|
3500
|
+
def list_time_series(params = {}, options = {})
|
3501
|
+
req = build_request(:list_time_series, params)
|
3502
|
+
req.send_request(options)
|
3503
|
+
end
|
3504
|
+
|
3241
3505
|
# Sets the default encryption configuration for the Amazon Web Services
|
3242
3506
|
# account. For more information, see [Key management][1] in the *IoT
|
3243
3507
|
# SiteWise User Guide*.
|
@@ -3250,8 +3514,8 @@ module Aws::IoTSiteWise
|
|
3250
3514
|
# The type of encryption used for the encryption configuration.
|
3251
3515
|
#
|
3252
3516
|
# @option params [String] :kms_key_id
|
3253
|
-
# The Key ID of the customer managed
|
3254
|
-
#
|
3517
|
+
# The Key ID of the customer managed key used for KMS encryption. This
|
3518
|
+
# is required if you use `KMS_BASED_ENCRYPTION`.
|
3255
3519
|
#
|
3256
3520
|
# @return [Types::PutDefaultEncryptionConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3257
3521
|
#
|
@@ -3306,25 +3570,52 @@ module Aws::IoTSiteWise
|
|
3306
3570
|
# Configures storage settings for IoT SiteWise.
|
3307
3571
|
#
|
3308
3572
|
# @option params [required, String] :storage_type
|
3309
|
-
# The
|
3310
|
-
# can be one of the following values:
|
3573
|
+
# The storage tier that you specified for your data. The `storageType`
|
3574
|
+
# parameter can be one of the following values:
|
3311
3575
|
#
|
3312
|
-
# * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise
|
3313
|
-
# a service
|
3576
|
+
# * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise saves your data into the
|
3577
|
+
# hot tier. The hot tier is a service-managed database.
|
3314
3578
|
#
|
3315
|
-
# * `MULTI_LAYER_STORAGE` – IoT SiteWise
|
3316
|
-
#
|
3317
|
-
#
|
3579
|
+
# * `MULTI_LAYER_STORAGE` – IoT SiteWise saves your data in both the
|
3580
|
+
# cold tier and the cold tier. The cold tier is a customer-managed
|
3581
|
+
# Amazon S3 bucket.
|
3318
3582
|
#
|
3319
3583
|
# @option params [Types::MultiLayerStorage] :multi_layer_storage
|
3320
3584
|
# Identifies a storage destination. If you specified
|
3321
3585
|
# `MULTI_LAYER_STORAGE` for the storage type, you must specify a
|
3322
3586
|
# `MultiLayerStorage` object.
|
3323
3587
|
#
|
3588
|
+
# @option params [String] :disassociated_data_storage
|
3589
|
+
# Contains the storage configuration for time series (data streams) that
|
3590
|
+
# aren't associated with asset properties. The
|
3591
|
+
# `disassociatedDataStorage` can be one of the following values:
|
3592
|
+
#
|
3593
|
+
# * `ENABLED` – IoT SiteWise accepts time series that aren't associated
|
3594
|
+
# with asset properties.
|
3595
|
+
#
|
3596
|
+
# After the `disassociatedDataStorage` is enabled, you can't disable
|
3597
|
+
# it.
|
3598
|
+
#
|
3599
|
+
# * `DISABLED` – IoT SiteWise doesn't accept time series (data streams)
|
3600
|
+
# that aren't associated with asset properties.
|
3601
|
+
#
|
3602
|
+
# For more information, see [Data streams][1] in the *IoT SiteWise User
|
3603
|
+
# Guide*.
|
3604
|
+
#
|
3605
|
+
#
|
3606
|
+
#
|
3607
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html
|
3608
|
+
#
|
3609
|
+
# @option params [Types::RetentionPeriod] :retention_period
|
3610
|
+
# How many days your data is kept in the hot tier. By default, your data
|
3611
|
+
# is kept indefinitely in the hot tier.
|
3612
|
+
#
|
3324
3613
|
# @return [Types::PutStorageConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3325
3614
|
#
|
3326
3615
|
# * {Types::PutStorageConfigurationResponse#storage_type #storage_type} => String
|
3327
3616
|
# * {Types::PutStorageConfigurationResponse#multi_layer_storage #multi_layer_storage} => Types::MultiLayerStorage
|
3617
|
+
# * {Types::PutStorageConfigurationResponse#disassociated_data_storage #disassociated_data_storage} => String
|
3618
|
+
# * {Types::PutStorageConfigurationResponse#retention_period #retention_period} => Types::RetentionPeriod
|
3328
3619
|
# * {Types::PutStorageConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
|
3329
3620
|
#
|
3330
3621
|
# @example Request syntax with placeholder values
|
@@ -3337,6 +3628,11 @@ module Aws::IoTSiteWise
|
|
3337
3628
|
# role_arn: "ARN", # required
|
3338
3629
|
# },
|
3339
3630
|
# },
|
3631
|
+
# disassociated_data_storage: "ENABLED", # accepts ENABLED, DISABLED
|
3632
|
+
# retention_period: {
|
3633
|
+
# number_of_days: 1,
|
3634
|
+
# unlimited: false,
|
3635
|
+
# },
|
3340
3636
|
# })
|
3341
3637
|
#
|
3342
3638
|
# @example Response structure
|
@@ -3344,6 +3640,9 @@ module Aws::IoTSiteWise
|
|
3344
3640
|
# resp.storage_type #=> String, one of "SITEWISE_DEFAULT_STORAGE", "MULTI_LAYER_STORAGE"
|
3345
3641
|
# resp.multi_layer_storage.customer_managed_s3_storage.s3_resource_arn #=> String
|
3346
3642
|
# resp.multi_layer_storage.customer_managed_s3_storage.role_arn #=> String
|
3643
|
+
# resp.disassociated_data_storage #=> String, one of "ENABLED", "DISABLED"
|
3644
|
+
# resp.retention_period.number_of_days #=> Integer
|
3645
|
+
# resp.retention_period.unlimited #=> Boolean
|
3347
3646
|
# resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
3348
3647
|
# resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
3349
3648
|
# resp.configuration_status.error.message #=> String
|
@@ -4115,7 +4414,7 @@ module Aws::IoTSiteWise
|
|
4115
4414
|
params: params,
|
4116
4415
|
config: config)
|
4117
4416
|
context[:gem_name] = 'aws-sdk-iotsitewise'
|
4118
|
-
context[:gem_version] = '1.
|
4417
|
+
context[:gem_version] = '1.36.0'
|
4119
4418
|
Seahorse::Client::Request.new(handlers, context)
|
4120
4419
|
end
|
4121
4420
|
|