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