aws-sdk-iotsitewise 1.34.0 → 1.35.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +297 -20
- data/lib/aws-sdk-iotsitewise/client_api.rb +155 -0
- data/lib/aws-sdk-iotsitewise/types.rb +435 -41
- data/lib/aws-sdk-iotsitewise.rb +1 -1
- metadata +2 -2
@@ -1042,6 +1042,46 @@ module Aws::IoTSiteWise
|
|
1042
1042
|
include Aws::Structure
|
1043
1043
|
end
|
1044
1044
|
|
1045
|
+
# @note When making an API call, you may pass AssociateTimeSeriesToAssetPropertyRequest
|
1046
|
+
# data as a hash:
|
1047
|
+
#
|
1048
|
+
# {
|
1049
|
+
# alias: "PropertyAlias", # required
|
1050
|
+
# asset_id: "ID", # required
|
1051
|
+
# property_id: "ID", # required
|
1052
|
+
# client_token: "ClientToken",
|
1053
|
+
# }
|
1054
|
+
#
|
1055
|
+
# @!attribute [rw] alias
|
1056
|
+
# The alias that identifies the time series.
|
1057
|
+
# @return [String]
|
1058
|
+
#
|
1059
|
+
# @!attribute [rw] asset_id
|
1060
|
+
# The ID of the asset in which the asset property was created.
|
1061
|
+
# @return [String]
|
1062
|
+
#
|
1063
|
+
# @!attribute [rw] property_id
|
1064
|
+
# The ID of the asset property.
|
1065
|
+
# @return [String]
|
1066
|
+
#
|
1067
|
+
# @!attribute [rw] client_token
|
1068
|
+
# A unique case-sensitive identifier that you can provide to ensure
|
1069
|
+
# the idempotency of the request. Don't reuse this client token if a
|
1070
|
+
# new idempotent request is required.
|
1071
|
+
#
|
1072
|
+
# **A suitable default value is auto-generated.** You should normally
|
1073
|
+
# not need to pass this option.
|
1074
|
+
# @return [String]
|
1075
|
+
#
|
1076
|
+
class AssociateTimeSeriesToAssetPropertyRequest < Struct.new(
|
1077
|
+
:alias,
|
1078
|
+
:asset_id,
|
1079
|
+
:property_id,
|
1080
|
+
:client_token)
|
1081
|
+
SENSITIVE = []
|
1082
|
+
include Aws::Structure
|
1083
|
+
end
|
1084
|
+
|
1045
1085
|
# Contains a summary of an associated asset.
|
1046
1086
|
#
|
1047
1087
|
# @!attribute [rw] id
|
@@ -2511,6 +2551,46 @@ module Aws::IoTSiteWise
|
|
2511
2551
|
|
2512
2552
|
class DeleteProjectResponse < Aws::EmptyStructure; end
|
2513
2553
|
|
2554
|
+
# @note When making an API call, you may pass DeleteTimeSeriesRequest
|
2555
|
+
# data as a hash:
|
2556
|
+
#
|
2557
|
+
# {
|
2558
|
+
# alias: "PropertyAlias",
|
2559
|
+
# asset_id: "ID",
|
2560
|
+
# property_id: "ID",
|
2561
|
+
# client_token: "ClientToken",
|
2562
|
+
# }
|
2563
|
+
#
|
2564
|
+
# @!attribute [rw] alias
|
2565
|
+
# The alias that identifies the time series.
|
2566
|
+
# @return [String]
|
2567
|
+
#
|
2568
|
+
# @!attribute [rw] asset_id
|
2569
|
+
# The ID of the asset in which the asset property was created.
|
2570
|
+
# @return [String]
|
2571
|
+
#
|
2572
|
+
# @!attribute [rw] property_id
|
2573
|
+
# The ID of the asset property.
|
2574
|
+
# @return [String]
|
2575
|
+
#
|
2576
|
+
# @!attribute [rw] client_token
|
2577
|
+
# A unique case-sensitive identifier that you can provide to ensure
|
2578
|
+
# the idempotency of the request. Don't reuse this client token if a
|
2579
|
+
# new idempotent request is required.
|
2580
|
+
#
|
2581
|
+
# **A suitable default value is auto-generated.** You should normally
|
2582
|
+
# not need to pass this option.
|
2583
|
+
# @return [String]
|
2584
|
+
#
|
2585
|
+
class DeleteTimeSeriesRequest < Struct.new(
|
2586
|
+
:alias,
|
2587
|
+
:asset_id,
|
2588
|
+
:property_id,
|
2589
|
+
:client_token)
|
2590
|
+
SENSITIVE = []
|
2591
|
+
include Aws::Structure
|
2592
|
+
end
|
2593
|
+
|
2514
2594
|
# @note When making an API call, you may pass DescribeAccessPolicyRequest
|
2515
2595
|
# data as a hash:
|
2516
2596
|
#
|
@@ -2887,8 +2967,8 @@ module Aws::IoTSiteWise
|
|
2887
2967
|
# @return [String]
|
2888
2968
|
#
|
2889
2969
|
# @!attribute [rw] kms_key_arn
|
2890
|
-
# The key ARN of the customer managed
|
2891
|
-
#
|
2970
|
+
# The key ARN of the customer managed key used for KMS encryption if
|
2971
|
+
# you use `KMS_BASED_ENCRYPTION`.
|
2892
2972
|
# @return [String]
|
2893
2973
|
#
|
2894
2974
|
# @!attribute [rw] configuration_status
|
@@ -3257,6 +3337,28 @@ module Aws::IoTSiteWise
|
|
3257
3337
|
# Contains information about the storage destination.
|
3258
3338
|
# @return [Types::MultiLayerStorage]
|
3259
3339
|
#
|
3340
|
+
# @!attribute [rw] disassociated_data_storage
|
3341
|
+
# Contains the storage configuration for time series (data streams)
|
3342
|
+
# that aren't associated with asset properties. The
|
3343
|
+
# `disassociatedDataStorage` can be one of the following values:
|
3344
|
+
#
|
3345
|
+
# * `ENABLED` – IoT SiteWise accepts time series that aren't
|
3346
|
+
# associated with asset properties.
|
3347
|
+
#
|
3348
|
+
# After the `disassociatedDataStorage` is enabled, you can't
|
3349
|
+
# disable it.
|
3350
|
+
#
|
3351
|
+
# * `DISABLED` – IoT SiteWise doesn't accept time series (data
|
3352
|
+
# streams) that aren't associated with asset properties.
|
3353
|
+
#
|
3354
|
+
# For more information, see [Data streams][1] in the *IoT SiteWise
|
3355
|
+
# User Guide*.
|
3356
|
+
#
|
3357
|
+
#
|
3358
|
+
#
|
3359
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html
|
3360
|
+
# @return [String]
|
3361
|
+
#
|
3260
3362
|
# @!attribute [rw] configuration_status
|
3261
3363
|
# Contains current status information for the configuration.
|
3262
3364
|
# @return [Types::ConfigurationStatus]
|
@@ -3269,12 +3371,96 @@ module Aws::IoTSiteWise
|
|
3269
3371
|
class DescribeStorageConfigurationResponse < Struct.new(
|
3270
3372
|
:storage_type,
|
3271
3373
|
:multi_layer_storage,
|
3374
|
+
:disassociated_data_storage,
|
3272
3375
|
:configuration_status,
|
3273
3376
|
:last_update_date)
|
3274
3377
|
SENSITIVE = []
|
3275
3378
|
include Aws::Structure
|
3276
3379
|
end
|
3277
3380
|
|
3381
|
+
# @note When making an API call, you may pass DescribeTimeSeriesRequest
|
3382
|
+
# data as a hash:
|
3383
|
+
#
|
3384
|
+
# {
|
3385
|
+
# alias: "PropertyAlias",
|
3386
|
+
# asset_id: "ID",
|
3387
|
+
# property_id: "ID",
|
3388
|
+
# }
|
3389
|
+
#
|
3390
|
+
# @!attribute [rw] alias
|
3391
|
+
# The alias that identifies the time series.
|
3392
|
+
# @return [String]
|
3393
|
+
#
|
3394
|
+
# @!attribute [rw] asset_id
|
3395
|
+
# The ID of the asset in which the asset property was created.
|
3396
|
+
# @return [String]
|
3397
|
+
#
|
3398
|
+
# @!attribute [rw] property_id
|
3399
|
+
# The ID of the asset property.
|
3400
|
+
# @return [String]
|
3401
|
+
#
|
3402
|
+
class DescribeTimeSeriesRequest < Struct.new(
|
3403
|
+
:alias,
|
3404
|
+
:asset_id,
|
3405
|
+
:property_id)
|
3406
|
+
SENSITIVE = []
|
3407
|
+
include Aws::Structure
|
3408
|
+
end
|
3409
|
+
|
3410
|
+
# @!attribute [rw] asset_id
|
3411
|
+
# The ID of the asset in which the asset property was created.
|
3412
|
+
# @return [String]
|
3413
|
+
#
|
3414
|
+
# @!attribute [rw] property_id
|
3415
|
+
# The ID of the asset property.
|
3416
|
+
# @return [String]
|
3417
|
+
#
|
3418
|
+
# @!attribute [rw] alias
|
3419
|
+
# The alias that identifies the time series.
|
3420
|
+
# @return [String]
|
3421
|
+
#
|
3422
|
+
# @!attribute [rw] time_series_id
|
3423
|
+
# The ID of the time series.
|
3424
|
+
# @return [String]
|
3425
|
+
#
|
3426
|
+
# @!attribute [rw] data_type
|
3427
|
+
# The data type of the time series.
|
3428
|
+
#
|
3429
|
+
# If you specify `STRUCT`, you must also specify `dataTypeSpec` to
|
3430
|
+
# identify the type of the structure for this time series.
|
3431
|
+
# @return [String]
|
3432
|
+
#
|
3433
|
+
# @!attribute [rw] data_type_spec
|
3434
|
+
# The data type of the structure for this time series. This parameter
|
3435
|
+
# is required for time series that have the `STRUCT` data type.
|
3436
|
+
#
|
3437
|
+
# The options for this parameter depend on the type of the composite
|
3438
|
+
# model in which you created the asset property that is associated
|
3439
|
+
# with your time series. Use `AWS/ALARM_STATE` for alarm state in
|
3440
|
+
# alarm composite models.
|
3441
|
+
# @return [String]
|
3442
|
+
#
|
3443
|
+
# @!attribute [rw] time_series_creation_date
|
3444
|
+
# The date that the time series was created, in Unix epoch time.
|
3445
|
+
# @return [Time]
|
3446
|
+
#
|
3447
|
+
# @!attribute [rw] time_series_last_update_date
|
3448
|
+
# The date that the time series was last updated, in Unix epoch time.
|
3449
|
+
# @return [Time]
|
3450
|
+
#
|
3451
|
+
class DescribeTimeSeriesResponse < Struct.new(
|
3452
|
+
:asset_id,
|
3453
|
+
:property_id,
|
3454
|
+
:alias,
|
3455
|
+
:time_series_id,
|
3456
|
+
:data_type,
|
3457
|
+
:data_type_spec,
|
3458
|
+
:time_series_creation_date,
|
3459
|
+
:time_series_last_update_date)
|
3460
|
+
SENSITIVE = []
|
3461
|
+
include Aws::Structure
|
3462
|
+
end
|
3463
|
+
|
3278
3464
|
# Contains detailed error information.
|
3279
3465
|
#
|
3280
3466
|
# @!attribute [rw] code
|
@@ -3341,6 +3527,46 @@ module Aws::IoTSiteWise
|
|
3341
3527
|
include Aws::Structure
|
3342
3528
|
end
|
3343
3529
|
|
3530
|
+
# @note When making an API call, you may pass DisassociateTimeSeriesFromAssetPropertyRequest
|
3531
|
+
# data as a hash:
|
3532
|
+
#
|
3533
|
+
# {
|
3534
|
+
# alias: "PropertyAlias", # required
|
3535
|
+
# asset_id: "ID", # required
|
3536
|
+
# property_id: "ID", # required
|
3537
|
+
# client_token: "ClientToken",
|
3538
|
+
# }
|
3539
|
+
#
|
3540
|
+
# @!attribute [rw] alias
|
3541
|
+
# The alias that identifies the time series.
|
3542
|
+
# @return [String]
|
3543
|
+
#
|
3544
|
+
# @!attribute [rw] asset_id
|
3545
|
+
# The ID of the asset in which the asset property was created.
|
3546
|
+
# @return [String]
|
3547
|
+
#
|
3548
|
+
# @!attribute [rw] property_id
|
3549
|
+
# The ID of the asset property.
|
3550
|
+
# @return [String]
|
3551
|
+
#
|
3552
|
+
# @!attribute [rw] client_token
|
3553
|
+
# A unique case-sensitive identifier that you can provide to ensure
|
3554
|
+
# the idempotency of the request. Don't reuse this client token if a
|
3555
|
+
# new idempotent request is required.
|
3556
|
+
#
|
3557
|
+
# **A suitable default value is auto-generated.** You should normally
|
3558
|
+
# not need to pass this option.
|
3559
|
+
# @return [String]
|
3560
|
+
#
|
3561
|
+
class DisassociateTimeSeriesFromAssetPropertyRequest < Struct.new(
|
3562
|
+
:alias,
|
3563
|
+
:asset_id,
|
3564
|
+
:property_id,
|
3565
|
+
:client_token)
|
3566
|
+
SENSITIVE = []
|
3567
|
+
include Aws::Structure
|
3568
|
+
end
|
3569
|
+
|
3344
3570
|
# Contains the details of an IoT SiteWise error.
|
3345
3571
|
#
|
3346
3572
|
# @!attribute [rw] code
|
@@ -3849,10 +4075,10 @@ module Aws::IoTSiteWise
|
|
3849
4075
|
#
|
3850
4076
|
# For example, you can use this operation to return the interpolated
|
3851
4077
|
# temperature values for a wind turbine every 24 hours over a
|
3852
|
-
# duration of 7 days. If the interpolation starts
|
3853
|
-
#
|
3854
|
-
#
|
3855
|
-
#
|
4078
|
+
# duration of 7 days. If the interpolation starts July 1, 2021, at 9
|
4079
|
+
# AM, IoT SiteWise returns the first interpolated value on July 2,
|
4080
|
+
# 2021, at 9 AM, the second interpolated value on July 3, 2021, at 9
|
4081
|
+
# AM, and so on.
|
3856
4082
|
#
|
3857
4083
|
# * `LOCF_INTERPOLATION` – Estimates missing data using last
|
3858
4084
|
# observation carried forward interpolation
|
@@ -3862,12 +4088,12 @@ module Aws::IoTSiteWise
|
|
3862
4088
|
# forward this interpolated value until a new data point is found.
|
3863
4089
|
#
|
3864
4090
|
# For example, you can get the state of an on-off valve every 24
|
3865
|
-
# hours over a duration of 7 days. If the interpolation starts
|
3866
|
-
#
|
4091
|
+
# hours over a duration of 7 days. If the interpolation starts July
|
4092
|
+
# 1, 2021, at 9 AM, IoT SiteWise returns the last observed data
|
3867
4093
|
# point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as
|
3868
|
-
# the first interpolated value. If
|
3869
|
-
# on July 2, 2021, IoT SiteWise uses the same interpolated value
|
3870
|
-
# the rest of the days.
|
4094
|
+
# the first interpolated value. If a data point isn't found after 9
|
4095
|
+
# AM on July 2, 2021, IoT SiteWise uses the same interpolated value
|
4096
|
+
# for the rest of the days.
|
3871
4097
|
#
|
3872
4098
|
#
|
3873
4099
|
#
|
@@ -3875,17 +4101,18 @@ module Aws::IoTSiteWise
|
|
3875
4101
|
# @return [String]
|
3876
4102
|
#
|
3877
4103
|
# @!attribute [rw] interval_window_in_seconds
|
3878
|
-
# The query interval for the window in seconds. IoT SiteWise computes
|
4104
|
+
# The query interval for the window, in seconds. IoT SiteWise computes
|
3879
4105
|
# each interpolated value by using data points from the timestamp of
|
3880
|
-
# each interval minus the window to the timestamp of each interval
|
3881
|
-
# plus the window. If not specified, the window
|
3882
|
-
# time minus the interval and the end time plus the interval.
|
4106
|
+
# each interval, minus the window to the timestamp of each interval
|
4107
|
+
# plus the window. If not specified, the window ranges between the
|
4108
|
+
# start time minus the interval and the end time plus the interval.
|
3883
4109
|
#
|
3884
4110
|
# <note markdown="1"> * If you specify a value for the `intervalWindowInSeconds`
|
3885
|
-
# parameter, the `type` parameter must be
|
4111
|
+
# parameter, the value for the `type` parameter must be
|
4112
|
+
# `LINEAR_INTERPOLATION`.
|
3886
4113
|
#
|
3887
|
-
# * If
|
3888
|
-
# SiteWise won't return an interpolated value for the interval.
|
4114
|
+
# * If a data point isn't found during the specified query window,
|
4115
|
+
# IoT SiteWise won't return an interpolated value for the interval.
|
3889
4116
|
# This indicates that there's a gap in the ingested data points.
|
3890
4117
|
#
|
3891
4118
|
# </note>
|
@@ -3893,11 +4120,11 @@ module Aws::IoTSiteWise
|
|
3893
4120
|
# For example, you can get the interpolated temperature values for a
|
3894
4121
|
# wind turbine every 24 hours over a duration of 7 days. If the
|
3895
4122
|
# interpolation starts on July 1, 2021, at 9 AM with a window of 2
|
3896
|
-
# hours, IoT SiteWise uses the data points from 7 AM (9 AM
|
3897
|
-
# to 11 AM (9 AM
|
3898
|
-
# interpolated value, uses the data points
|
3899
|
-
#
|
3900
|
-
# interpolated value, and so on.
|
4123
|
+
# hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2
|
4124
|
+
# hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute the
|
4125
|
+
# first interpolated value. Next, IoT SiteWise uses the data points
|
4126
|
+
# from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July
|
4127
|
+
# 3, 2021 to compute the second interpolated value, and so on.
|
3901
4128
|
# @return [Integer]
|
3902
4129
|
#
|
3903
4130
|
class GetInterpolatedAssetPropertyValuesRequest < Struct.new(
|
@@ -4860,6 +5087,70 @@ module Aws::IoTSiteWise
|
|
4860
5087
|
include Aws::Structure
|
4861
5088
|
end
|
4862
5089
|
|
5090
|
+
# @note When making an API call, you may pass ListTimeSeriesRequest
|
5091
|
+
# data as a hash:
|
5092
|
+
#
|
5093
|
+
# {
|
5094
|
+
# next_token: "NextToken",
|
5095
|
+
# max_results: 1,
|
5096
|
+
# asset_id: "ID",
|
5097
|
+
# alias_prefix: "PropertyAlias",
|
5098
|
+
# time_series_type: "ASSOCIATED", # accepts ASSOCIATED, DISASSOCIATED
|
5099
|
+
# }
|
5100
|
+
#
|
5101
|
+
# @!attribute [rw] next_token
|
5102
|
+
# The token to be used for the next set of paginated results.
|
5103
|
+
# @return [String]
|
5104
|
+
#
|
5105
|
+
# @!attribute [rw] max_results
|
5106
|
+
# The maximum number of results to return for each paginated request.
|
5107
|
+
# @return [Integer]
|
5108
|
+
#
|
5109
|
+
# @!attribute [rw] asset_id
|
5110
|
+
# The ID of the asset in which the asset property was created.
|
5111
|
+
# @return [String]
|
5112
|
+
#
|
5113
|
+
# @!attribute [rw] alias_prefix
|
5114
|
+
# The alias prefix of the time series.
|
5115
|
+
# @return [String]
|
5116
|
+
#
|
5117
|
+
# @!attribute [rw] time_series_type
|
5118
|
+
# The type of the time series. The time series type can be one of the
|
5119
|
+
# following values:
|
5120
|
+
#
|
5121
|
+
# * `ASSOCIATED` – The time series is associated with an asset
|
5122
|
+
# property.
|
5123
|
+
#
|
5124
|
+
# * `DISASSOCIATED` – The time series isn't associated with any asset
|
5125
|
+
# property.
|
5126
|
+
# @return [String]
|
5127
|
+
#
|
5128
|
+
class ListTimeSeriesRequest < Struct.new(
|
5129
|
+
:next_token,
|
5130
|
+
:max_results,
|
5131
|
+
:asset_id,
|
5132
|
+
:alias_prefix,
|
5133
|
+
:time_series_type)
|
5134
|
+
SENSITIVE = []
|
5135
|
+
include Aws::Structure
|
5136
|
+
end
|
5137
|
+
|
5138
|
+
# @!attribute [rw] time_series_summaries
|
5139
|
+
# One or more time series summaries to list.
|
5140
|
+
# @return [Array<Types::TimeSeriesSummary>]
|
5141
|
+
#
|
5142
|
+
# @!attribute [rw] next_token
|
5143
|
+
# The token for the next set of results, or null if there are no
|
5144
|
+
# additional results.
|
5145
|
+
# @return [String]
|
5146
|
+
#
|
5147
|
+
class ListTimeSeriesResponse < Struct.new(
|
5148
|
+
:time_series_summaries,
|
5149
|
+
:next_token)
|
5150
|
+
SENSITIVE = []
|
5151
|
+
include Aws::Structure
|
5152
|
+
end
|
5153
|
+
|
4863
5154
|
# Contains logging options.
|
4864
5155
|
#
|
4865
5156
|
# @note When making an API call, you may pass LoggingOptions
|
@@ -5507,9 +5798,8 @@ module Aws::IoTSiteWise
|
|
5507
5798
|
# @return [String]
|
5508
5799
|
#
|
5509
5800
|
# @!attribute [rw] kms_key_id
|
5510
|
-
# The Key ID of the customer managed
|
5511
|
-
#
|
5512
|
-
# `KMS_BASED_ENCRYPTION`.
|
5801
|
+
# The Key ID of the customer managed key used for KMS encryption. This
|
5802
|
+
# is required if you use `KMS_BASED_ENCRYPTION`.
|
5513
5803
|
# @return [String]
|
5514
5804
|
#
|
5515
5805
|
class PutDefaultEncryptionConfigurationRequest < Struct.new(
|
@@ -5524,7 +5814,7 @@ module Aws::IoTSiteWise
|
|
5524
5814
|
# @return [String]
|
5525
5815
|
#
|
5526
5816
|
# @!attribute [rw] kms_key_arn
|
5527
|
-
# The Key ARN of the KMS
|
5817
|
+
# The Key ARN of the KMS key used for KMS encryption if you use
|
5528
5818
|
# `KMS_BASED_ENCRYPTION`.
|
5529
5819
|
# @return [String]
|
5530
5820
|
#
|
@@ -5574,6 +5864,7 @@ module Aws::IoTSiteWise
|
|
5574
5864
|
# role_arn: "ARN", # required
|
5575
5865
|
# },
|
5576
5866
|
# },
|
5867
|
+
# disassociated_data_storage: "ENABLED", # accepts ENABLED, DISABLED
|
5577
5868
|
# }
|
5578
5869
|
#
|
5579
5870
|
# @!attribute [rw] storage_type
|
@@ -5594,9 +5885,32 @@ module Aws::IoTSiteWise
|
|
5594
5885
|
# `MultiLayerStorage` object.
|
5595
5886
|
# @return [Types::MultiLayerStorage]
|
5596
5887
|
#
|
5888
|
+
# @!attribute [rw] disassociated_data_storage
|
5889
|
+
# Contains the storage configuration for time series (data streams)
|
5890
|
+
# that aren't associated with asset properties. The
|
5891
|
+
# `disassociatedDataStorage` can be one of the following values:
|
5892
|
+
#
|
5893
|
+
# * `ENABLED` – IoT SiteWise accepts time series that aren't
|
5894
|
+
# associated with asset properties.
|
5895
|
+
#
|
5896
|
+
# After the `disassociatedDataStorage` is enabled, you can't
|
5897
|
+
# disable it.
|
5898
|
+
#
|
5899
|
+
# * `DISABLED` – IoT SiteWise doesn't accept time series (data
|
5900
|
+
# streams) that aren't associated with asset properties.
|
5901
|
+
#
|
5902
|
+
# For more information, see [Data streams][1] in the *IoT SiteWise
|
5903
|
+
# User Guide*.
|
5904
|
+
#
|
5905
|
+
#
|
5906
|
+
#
|
5907
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html
|
5908
|
+
# @return [String]
|
5909
|
+
#
|
5597
5910
|
class PutStorageConfigurationRequest < Struct.new(
|
5598
5911
|
:storage_type,
|
5599
|
-
:multi_layer_storage
|
5912
|
+
:multi_layer_storage,
|
5913
|
+
:disassociated_data_storage)
|
5600
5914
|
SENSITIVE = []
|
5601
5915
|
include Aws::Structure
|
5602
5916
|
end
|
@@ -5617,6 +5931,28 @@ module Aws::IoTSiteWise
|
|
5617
5931
|
# Contains information about the storage destination.
|
5618
5932
|
# @return [Types::MultiLayerStorage]
|
5619
5933
|
#
|
5934
|
+
# @!attribute [rw] disassociated_data_storage
|
5935
|
+
# Contains the storage configuration for time series (data streams)
|
5936
|
+
# that aren't associated with asset properties. The
|
5937
|
+
# `disassociatedDataStorage` can be one of the following values:
|
5938
|
+
#
|
5939
|
+
# * `ENABLED` – IoT SiteWise accepts time series that aren't
|
5940
|
+
# associated with asset properties.
|
5941
|
+
#
|
5942
|
+
# After the `disassociatedDataStorage` is enabled, you can't
|
5943
|
+
# disable it.
|
5944
|
+
#
|
5945
|
+
# * `DISABLED` – IoT SiteWise doesn't accept time series (data
|
5946
|
+
# streams) that aren't associated with asset properties.
|
5947
|
+
#
|
5948
|
+
# For more information, see [Data streams][1] in the *IoT SiteWise
|
5949
|
+
# User Guide*.
|
5950
|
+
#
|
5951
|
+
#
|
5952
|
+
#
|
5953
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html
|
5954
|
+
# @return [String]
|
5955
|
+
#
|
5620
5956
|
# @!attribute [rw] configuration_status
|
5621
5957
|
# Contains current status information for the configuration.
|
5622
5958
|
# @return [Types::ConfigurationStatus]
|
@@ -5624,6 +5960,7 @@ module Aws::IoTSiteWise
|
|
5624
5960
|
class PutStorageConfigurationResponse < Struct.new(
|
5625
5961
|
:storage_type,
|
5626
5962
|
:multi_layer_storage,
|
5963
|
+
:disassociated_data_storage,
|
5627
5964
|
:configuration_status)
|
5628
5965
|
SENSITIVE = []
|
5629
5966
|
include Aws::Structure
|
@@ -5784,6 +6121,62 @@ module Aws::IoTSiteWise
|
|
5784
6121
|
include Aws::Structure
|
5785
6122
|
end
|
5786
6123
|
|
6124
|
+
# Contains a summary of a time series (data stream).
|
6125
|
+
#
|
6126
|
+
# @!attribute [rw] asset_id
|
6127
|
+
# The ID of the asset in which the asset property was created.
|
6128
|
+
# @return [String]
|
6129
|
+
#
|
6130
|
+
# @!attribute [rw] property_id
|
6131
|
+
# The ID of the asset property.
|
6132
|
+
# @return [String]
|
6133
|
+
#
|
6134
|
+
# @!attribute [rw] alias
|
6135
|
+
# The alias that identifies the time series.
|
6136
|
+
# @return [String]
|
6137
|
+
#
|
6138
|
+
# @!attribute [rw] time_series_id
|
6139
|
+
# The ID of the time series.
|
6140
|
+
# @return [String]
|
6141
|
+
#
|
6142
|
+
# @!attribute [rw] data_type
|
6143
|
+
# The data type of the time series.
|
6144
|
+
#
|
6145
|
+
# If you specify `STRUCT`, you must also specify `dataTypeSpec` to
|
6146
|
+
# identify the type of the structure for this time series.
|
6147
|
+
# @return [String]
|
6148
|
+
#
|
6149
|
+
# @!attribute [rw] data_type_spec
|
6150
|
+
# The data type of the structure for this time series. This parameter
|
6151
|
+
# is required for time series that have the `STRUCT` data type.
|
6152
|
+
#
|
6153
|
+
# The options for this parameter depend on the type of the composite
|
6154
|
+
# model in which you created the asset property that is associated
|
6155
|
+
# with your time series. Use `AWS/ALARM_STATE` for alarm state in
|
6156
|
+
# alarm composite models.
|
6157
|
+
# @return [String]
|
6158
|
+
#
|
6159
|
+
# @!attribute [rw] time_series_creation_date
|
6160
|
+
# The date that the time series was created, in Unix epoch time.
|
6161
|
+
# @return [Time]
|
6162
|
+
#
|
6163
|
+
# @!attribute [rw] time_series_last_update_date
|
6164
|
+
# The date that the time series was last updated, in Unix epoch time.
|
6165
|
+
# @return [Time]
|
6166
|
+
#
|
6167
|
+
class TimeSeriesSummary < Struct.new(
|
6168
|
+
:asset_id,
|
6169
|
+
:property_id,
|
6170
|
+
:alias,
|
6171
|
+
:time_series_id,
|
6172
|
+
:data_type,
|
6173
|
+
:data_type_spec,
|
6174
|
+
:time_series_creation_date,
|
6175
|
+
:time_series_last_update_date)
|
6176
|
+
SENSITIVE = []
|
6177
|
+
include Aws::Structure
|
6178
|
+
end
|
6179
|
+
|
5787
6180
|
# You've reached the limit for the number of tags allowed for a
|
5788
6181
|
# resource. For more information, see [Tag naming limits and
|
5789
6182
|
# requirements][1] in the *Amazon Web Services General Reference*.
|
@@ -5906,16 +6299,17 @@ module Aws::IoTSiteWise
|
|
5906
6299
|
end
|
5907
6300
|
|
5908
6301
|
# Contains a tumbling window, which is a repeating fixed-sized,
|
5909
|
-
# non-overlapping, and contiguous time window. You use this window
|
5910
|
-
# metrics to aggregate data from properties and other assets.
|
6302
|
+
# non-overlapping, and contiguous time window. You can use this window
|
6303
|
+
# in metrics to aggregate data from properties and other assets.
|
5911
6304
|
#
|
5912
6305
|
# You can use `m`, `h`, `d`, and `w` when you specify an interval or
|
5913
|
-
# offset. Note that `m` represents minutes,
|
5914
|
-
# You can also use `s` to
|
6306
|
+
# offset. Note that `m` represents minutes, `h` represents hours, `d`
|
6307
|
+
# represents days, and `w` represents weeks. You can also use `s` to
|
6308
|
+
# represent seconds in `offset`.
|
5915
6309
|
#
|
5916
6310
|
# The `interval` and `offset` parameters support the [ISO 8601
|
5917
|
-
# format][1]. For example, `PT5S` represents
|
5918
|
-
# represents
|
6311
|
+
# format][1]. For example, `PT5S` represents 5 seconds, `PT5M`
|
6312
|
+
# represents 5 minutes, and `PT5H` represents 5 hours.
|
5919
6313
|
#
|
5920
6314
|
#
|
5921
6315
|
#
|
@@ -5954,11 +6348,11 @@ module Aws::IoTSiteWise
|
|
5954
6348
|
# `interval`, IoT SiteWise aggregates data in one of the following
|
5955
6349
|
# ways:
|
5956
6350
|
#
|
5957
|
-
# * If you create the metric before or at 6
|
6351
|
+
# * If you create the metric before or at 6 PM (UTC), you get the
|
5958
6352
|
# first aggregation result at 6 PM (UTC) on the day when you
|
5959
6353
|
# create the metric.
|
5960
6354
|
#
|
5961
|
-
# * If you create the metric after 6
|
6355
|
+
# * If you create the metric after 6 PM (UTC), you get the first
|
5962
6356
|
# aggregation result at 6 PM (UTC) the next day.
|
5963
6357
|
#
|
5964
6358
|
# * The ISO 8601 format.
|
@@ -5967,16 +6361,16 @@ module Aws::IoTSiteWise
|
|
5967
6361
|
# `interval`, IoT SiteWise aggregates data in one of the following
|
5968
6362
|
# ways:
|
5969
6363
|
#
|
5970
|
-
# * If you create the metric before or at 6
|
6364
|
+
# * If you create the metric before or at 6 PM (UTC), you get the
|
5971
6365
|
# first aggregation result at 6 PM (UTC) on the day when you
|
5972
6366
|
# create the metric.
|
5973
6367
|
#
|
5974
|
-
# * If you create the metric after 6
|
6368
|
+
# * If you create the metric after 6 PM (UTC), you get the first
|
5975
6369
|
# aggregation result at 6 PM (UTC) the next day.
|
5976
6370
|
#
|
5977
6371
|
# * The 24-hour clock.
|
5978
6372
|
#
|
5979
|
-
# For example, if you specify `00:03:00` for `offset
|
6373
|
+
# For example, if you specify `00:03:00` for `offset`, `5m` for
|
5980
6374
|
# `interval`, and you create the metric at 2 PM (UTC), you get the
|
5981
6375
|
# first aggregation result at 2:03 PM (UTC). You get the second
|
5982
6376
|
# aggregation result at 2:08 PM (UTC).
|
@@ -5987,11 +6381,11 @@ module Aws::IoTSiteWise
|
|
5987
6381
|
# `1d` for `interval`, IoT SiteWise aggregates data in one of the
|
5988
6382
|
# following ways:
|
5989
6383
|
#
|
5990
|
-
# * If you create the metric before or at 6
|
6384
|
+
# * If you create the metric before or at 6 PM (PST), you get the
|
5991
6385
|
# first aggregation result at 6 PM (PST) on the day when you
|
5992
6386
|
# create the metric.
|
5993
6387
|
#
|
5994
|
-
# * If you create the metric after 6
|
6388
|
+
# * If you create the metric after 6 PM (PST), you get the first
|
5995
6389
|
# aggregation result at 6 PM (PST) the next day.
|
5996
6390
|
# @return [String]
|
5997
6391
|
#
|
data/lib/aws-sdk-iotsitewise.rb
CHANGED
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.35.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-11-
|
11
|
+
date: 2021-11-24 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|