aws-sdk-iotsitewise 1.33.0 → 1.37.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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
@@ -2050,8 +2090,7 @@ module Aws::IoTSiteWise
2050
2090
  # the China Regions.
2051
2091
  #
2052
2092
  # * `IAM` – The portal uses Identity and Access Management to
2053
- # authenticate users and manage user permissions. This option is
2054
- # only available in the China Regions.
2093
+ # authenticate users and manage user permissions.
2055
2094
  #
2056
2095
  # You can't change this value after you create a portal.
2057
2096
  #
@@ -2511,6 +2550,46 @@ module Aws::IoTSiteWise
2511
2550
 
2512
2551
  class DeleteProjectResponse < Aws::EmptyStructure; end
2513
2552
 
2553
+ # @note When making an API call, you may pass DeleteTimeSeriesRequest
2554
+ # data as a hash:
2555
+ #
2556
+ # {
2557
+ # alias: "PropertyAlias",
2558
+ # asset_id: "ID",
2559
+ # property_id: "ID",
2560
+ # client_token: "ClientToken",
2561
+ # }
2562
+ #
2563
+ # @!attribute [rw] alias
2564
+ # The alias that identifies the time series.
2565
+ # @return [String]
2566
+ #
2567
+ # @!attribute [rw] asset_id
2568
+ # The ID of the asset in which the asset property was created.
2569
+ # @return [String]
2570
+ #
2571
+ # @!attribute [rw] property_id
2572
+ # The ID of the asset property.
2573
+ # @return [String]
2574
+ #
2575
+ # @!attribute [rw] client_token
2576
+ # A unique case-sensitive identifier that you can provide to ensure
2577
+ # the idempotency of the request. Don't reuse this client token if a
2578
+ # new idempotent request is required.
2579
+ #
2580
+ # **A suitable default value is auto-generated.** You should normally
2581
+ # not need to pass this option.
2582
+ # @return [String]
2583
+ #
2584
+ class DeleteTimeSeriesRequest < Struct.new(
2585
+ :alias,
2586
+ :asset_id,
2587
+ :property_id,
2588
+ :client_token)
2589
+ SENSITIVE = []
2590
+ include Aws::Structure
2591
+ end
2592
+
2514
2593
  # @note When making an API call, you may pass DescribeAccessPolicyRequest
2515
2594
  # data as a hash:
2516
2595
  #
@@ -2887,8 +2966,8 @@ module Aws::IoTSiteWise
2887
2966
  # @return [String]
2888
2967
  #
2889
2968
  # @!attribute [rw] kms_key_arn
2890
- # The key ARN of the customer managed customer master key (CMK) used
2891
- # for KMS encryption if you use `KMS_BASED_ENCRYPTION`.
2969
+ # The key ARN of the customer managed key used for KMS encryption if
2970
+ # you use `KMS_BASED_ENCRYPTION`.
2892
2971
  # @return [String]
2893
2972
  #
2894
2973
  # @!attribute [rw] configuration_status
@@ -3242,21 +3321,48 @@ module Aws::IoTSiteWise
3242
3321
  class DescribeStorageConfigurationRequest < Aws::EmptyStructure; end
3243
3322
 
3244
3323
  # @!attribute [rw] storage_type
3245
- # The type of storage that you specified for your data. The storage
3246
- # type can be one of the following values:
3324
+ # The storage tier that you specified for your data. The `storageType`
3325
+ # parameter can be one of the following values:
3247
3326
  #
3248
- # * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise replicates your data
3249
- # into a service managed database.
3327
+ # * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise saves your data into the
3328
+ # hot tier. The hot tier is a service-managed database.
3250
3329
  #
3251
- # * `MULTI_LAYER_STORAGE` – IoT SiteWise replicates your data into a
3252
- # service managed database and saves a copy of your raw data and
3253
- # metadata in an Amazon S3 object that you specified.
3330
+ # * `MULTI_LAYER_STORAGE` – IoT SiteWise saves your data in both the
3331
+ # cold tier and the cold tier. The cold tier is a customer-managed
3332
+ # Amazon S3 bucket.
3254
3333
  # @return [String]
3255
3334
  #
3256
3335
  # @!attribute [rw] multi_layer_storage
3257
3336
  # Contains information about the storage destination.
3258
3337
  # @return [Types::MultiLayerStorage]
3259
3338
  #
3339
+ # @!attribute [rw] disassociated_data_storage
3340
+ # Contains the storage configuration for time series (data streams)
3341
+ # that aren't associated with asset properties. The
3342
+ # `disassociatedDataStorage` can be one of the following values:
3343
+ #
3344
+ # * `ENABLED` – IoT SiteWise accepts time series that aren't
3345
+ # associated with asset properties.
3346
+ #
3347
+ # After the `disassociatedDataStorage` is enabled, you can't
3348
+ # disable it.
3349
+ #
3350
+ # * `DISABLED` – IoT SiteWise doesn't accept time series (data
3351
+ # streams) that aren't associated with asset properties.
3352
+ #
3353
+ # For more information, see [Data streams][1] in the *IoT SiteWise
3354
+ # User Guide*.
3355
+ #
3356
+ #
3357
+ #
3358
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html
3359
+ # @return [String]
3360
+ #
3361
+ # @!attribute [rw] retention_period
3362
+ # How many days your data is kept in the hot tier. By default, your
3363
+ # data is kept indefinitely in the hot tier.
3364
+ # @return [Types::RetentionPeriod]
3365
+ #
3260
3366
  # @!attribute [rw] configuration_status
3261
3367
  # Contains current status information for the configuration.
3262
3368
  # @return [Types::ConfigurationStatus]
@@ -3269,12 +3375,97 @@ module Aws::IoTSiteWise
3269
3375
  class DescribeStorageConfigurationResponse < Struct.new(
3270
3376
  :storage_type,
3271
3377
  :multi_layer_storage,
3378
+ :disassociated_data_storage,
3379
+ :retention_period,
3272
3380
  :configuration_status,
3273
3381
  :last_update_date)
3274
3382
  SENSITIVE = []
3275
3383
  include Aws::Structure
3276
3384
  end
3277
3385
 
3386
+ # @note When making an API call, you may pass DescribeTimeSeriesRequest
3387
+ # data as a hash:
3388
+ #
3389
+ # {
3390
+ # alias: "PropertyAlias",
3391
+ # asset_id: "ID",
3392
+ # property_id: "ID",
3393
+ # }
3394
+ #
3395
+ # @!attribute [rw] alias
3396
+ # The alias that identifies the time series.
3397
+ # @return [String]
3398
+ #
3399
+ # @!attribute [rw] asset_id
3400
+ # The ID of the asset in which the asset property was created.
3401
+ # @return [String]
3402
+ #
3403
+ # @!attribute [rw] property_id
3404
+ # The ID of the asset property.
3405
+ # @return [String]
3406
+ #
3407
+ class DescribeTimeSeriesRequest < Struct.new(
3408
+ :alias,
3409
+ :asset_id,
3410
+ :property_id)
3411
+ SENSITIVE = []
3412
+ include Aws::Structure
3413
+ end
3414
+
3415
+ # @!attribute [rw] asset_id
3416
+ # The ID of the asset in which the asset property was created.
3417
+ # @return [String]
3418
+ #
3419
+ # @!attribute [rw] property_id
3420
+ # The ID of the asset property.
3421
+ # @return [String]
3422
+ #
3423
+ # @!attribute [rw] alias
3424
+ # The alias that identifies the time series.
3425
+ # @return [String]
3426
+ #
3427
+ # @!attribute [rw] time_series_id
3428
+ # The ID of the time series.
3429
+ # @return [String]
3430
+ #
3431
+ # @!attribute [rw] data_type
3432
+ # The data type of the time series.
3433
+ #
3434
+ # If you specify `STRUCT`, you must also specify `dataTypeSpec` to
3435
+ # identify the type of the structure for this time series.
3436
+ # @return [String]
3437
+ #
3438
+ # @!attribute [rw] data_type_spec
3439
+ # The data type of the structure for this time series. This parameter
3440
+ # is required for time series that have the `STRUCT` data type.
3441
+ #
3442
+ # The options for this parameter depend on the type of the composite
3443
+ # model in which you created the asset property that is associated
3444
+ # with your time series. Use `AWS/ALARM_STATE` for alarm state in
3445
+ # alarm composite models.
3446
+ # @return [String]
3447
+ #
3448
+ # @!attribute [rw] time_series_creation_date
3449
+ # The date that the time series was created, in Unix epoch time.
3450
+ # @return [Time]
3451
+ #
3452
+ # @!attribute [rw] time_series_last_update_date
3453
+ # The date that the time series was last updated, in Unix epoch time.
3454
+ # @return [Time]
3455
+ #
3456
+ class DescribeTimeSeriesResponse < Struct.new(
3457
+ :asset_id,
3458
+ :property_id,
3459
+ :alias,
3460
+ :time_series_id,
3461
+ :data_type,
3462
+ :data_type_spec,
3463
+ :time_series_creation_date,
3464
+ :time_series_last_update_date)
3465
+ SENSITIVE = []
3466
+ include Aws::Structure
3467
+ end
3468
+
3278
3469
  # Contains detailed error information.
3279
3470
  #
3280
3471
  # @!attribute [rw] code
@@ -3341,6 +3532,46 @@ module Aws::IoTSiteWise
3341
3532
  include Aws::Structure
3342
3533
  end
3343
3534
 
3535
+ # @note When making an API call, you may pass DisassociateTimeSeriesFromAssetPropertyRequest
3536
+ # data as a hash:
3537
+ #
3538
+ # {
3539
+ # alias: "PropertyAlias", # required
3540
+ # asset_id: "ID", # required
3541
+ # property_id: "ID", # required
3542
+ # client_token: "ClientToken",
3543
+ # }
3544
+ #
3545
+ # @!attribute [rw] alias
3546
+ # The alias that identifies the time series.
3547
+ # @return [String]
3548
+ #
3549
+ # @!attribute [rw] asset_id
3550
+ # The ID of the asset in which the asset property was created.
3551
+ # @return [String]
3552
+ #
3553
+ # @!attribute [rw] property_id
3554
+ # The ID of the asset property.
3555
+ # @return [String]
3556
+ #
3557
+ # @!attribute [rw] client_token
3558
+ # A unique case-sensitive identifier that you can provide to ensure
3559
+ # the idempotency of the request. Don't reuse this client token if a
3560
+ # new idempotent request is required.
3561
+ #
3562
+ # **A suitable default value is auto-generated.** You should normally
3563
+ # not need to pass this option.
3564
+ # @return [String]
3565
+ #
3566
+ class DisassociateTimeSeriesFromAssetPropertyRequest < Struct.new(
3567
+ :alias,
3568
+ :asset_id,
3569
+ :property_id,
3570
+ :client_token)
3571
+ SENSITIVE = []
3572
+ include Aws::Structure
3573
+ end
3574
+
3344
3575
  # Contains the details of an IoT SiteWise error.
3345
3576
  #
3346
3577
  # @!attribute [rw] code
@@ -3849,10 +4080,10 @@ module Aws::IoTSiteWise
3849
4080
  #
3850
4081
  # For example, you can use this operation to return the interpolated
3851
4082
  # temperature values for a wind turbine every 24 hours over a
3852
- # duration of 7 days. If the interpolation starts on July 1, 2021,
3853
- # at 9 AM, IoT SiteWise returns the first interpolated value on July
3854
- # 2, 2021, at 9 AM, the second interpolated value on July 3, 2021,
3855
- # at 9 AM, and so on.
4083
+ # duration of 7 days. If the interpolation starts July 1, 2021, at 9
4084
+ # AM, IoT SiteWise returns the first interpolated value on July 2,
4085
+ # 2021, at 9 AM, the second interpolated value on July 3, 2021, at 9
4086
+ # AM, and so on.
3856
4087
  #
3857
4088
  # * `LOCF_INTERPOLATION` – Estimates missing data using last
3858
4089
  # observation carried forward interpolation
@@ -3862,12 +4093,12 @@ module Aws::IoTSiteWise
3862
4093
  # forward this interpolated value until a new data point is found.
3863
4094
  #
3864
4095
  # 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 on
3866
- # July 1, 2021, at 9 AM, IoT SiteWise returns the last observed data
4096
+ # hours over a duration of 7 days. If the interpolation starts July
4097
+ # 1, 2021, at 9 AM, IoT SiteWise returns the last observed data
3867
4098
  # point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as
3868
- # the first interpolated value. If no data point is found after 9 AM
3869
- # on July 2, 2021, IoT SiteWise uses the same interpolated value for
3870
- # the rest of the days.
4099
+ # the first interpolated value. If a data point isn't found after 9
4100
+ # AM on July 2, 2021, IoT SiteWise uses the same interpolated value
4101
+ # for the rest of the days.
3871
4102
  #
3872
4103
  #
3873
4104
  #
@@ -3875,17 +4106,18 @@ module Aws::IoTSiteWise
3875
4106
  # @return [String]
3876
4107
  #
3877
4108
  # @!attribute [rw] interval_window_in_seconds
3878
- # The query interval for the window in seconds. IoT SiteWise computes
4109
+ # The query interval for the window, in seconds. IoT SiteWise computes
3879
4110
  # 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 is between the start
3882
- # time minus the interval and the end time plus the interval.
4111
+ # each interval, minus the window to the timestamp of each interval
4112
+ # plus the window. If not specified, the window ranges between the
4113
+ # start time minus the interval and the end time plus the interval.
3883
4114
  #
3884
4115
  # <note markdown="1"> * If you specify a value for the `intervalWindowInSeconds`
3885
- # parameter, the `type` parameter must be `LINEAR_INTERPOLATION`.
4116
+ # parameter, the value for the `type` parameter must be
4117
+ # `LINEAR_INTERPOLATION`.
3886
4118
  #
3887
- # * If no data point is found during the specified query window, IoT
3888
- # SiteWise won't return an interpolated value for the interval.
4119
+ # * If a data point isn't found during the specified query window,
4120
+ # IoT SiteWise won't return an interpolated value for the interval.
3889
4121
  # This indicates that there's a gap in the ingested data points.
3890
4122
  #
3891
4123
  # </note>
@@ -3893,11 +4125,11 @@ module Aws::IoTSiteWise
3893
4125
  # For example, you can get the interpolated temperature values for a
3894
4126
  # wind turbine every 24 hours over a duration of 7 days. If the
3895
4127
  # 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 - 2 hours)
3897
- # to 11 AM (9 AM + 2 hours) on July 2, 2021 to compute the first
3898
- # interpolated value, uses the data points from 7 AM (9 AM - 2 hours)
3899
- # to 11 AM (9 AM + 2 hours) on July 3, 2021 to compute the second
3900
- # interpolated value, and so on.
4128
+ # hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2
4129
+ # hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute the
4130
+ # first interpolated value. Next, IoT SiteWise uses the data points
4131
+ # from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July
4132
+ # 3, 2021 to compute the second interpolated value, and so on.
3901
4133
  # @return [Integer]
3902
4134
  #
3903
4135
  class GetInterpolatedAssetPropertyValuesRequest < Struct.new(
@@ -4860,6 +5092,70 @@ module Aws::IoTSiteWise
4860
5092
  include Aws::Structure
4861
5093
  end
4862
5094
 
5095
+ # @note When making an API call, you may pass ListTimeSeriesRequest
5096
+ # data as a hash:
5097
+ #
5098
+ # {
5099
+ # next_token: "NextToken",
5100
+ # max_results: 1,
5101
+ # asset_id: "ID",
5102
+ # alias_prefix: "PropertyAlias",
5103
+ # time_series_type: "ASSOCIATED", # accepts ASSOCIATED, DISASSOCIATED
5104
+ # }
5105
+ #
5106
+ # @!attribute [rw] next_token
5107
+ # The token to be used for the next set of paginated results.
5108
+ # @return [String]
5109
+ #
5110
+ # @!attribute [rw] max_results
5111
+ # The maximum number of results to return for each paginated request.
5112
+ # @return [Integer]
5113
+ #
5114
+ # @!attribute [rw] asset_id
5115
+ # The ID of the asset in which the asset property was created.
5116
+ # @return [String]
5117
+ #
5118
+ # @!attribute [rw] alias_prefix
5119
+ # The alias prefix of the time series.
5120
+ # @return [String]
5121
+ #
5122
+ # @!attribute [rw] time_series_type
5123
+ # The type of the time series. The time series type can be one of the
5124
+ # following values:
5125
+ #
5126
+ # * `ASSOCIATED` – The time series is associated with an asset
5127
+ # property.
5128
+ #
5129
+ # * `DISASSOCIATED` – The time series isn't associated with any asset
5130
+ # property.
5131
+ # @return [String]
5132
+ #
5133
+ class ListTimeSeriesRequest < Struct.new(
5134
+ :next_token,
5135
+ :max_results,
5136
+ :asset_id,
5137
+ :alias_prefix,
5138
+ :time_series_type)
5139
+ SENSITIVE = []
5140
+ include Aws::Structure
5141
+ end
5142
+
5143
+ # @!attribute [rw] time_series_summaries
5144
+ # One or more time series summaries to list.
5145
+ # @return [Array<Types::TimeSeriesSummary>]
5146
+ #
5147
+ # @!attribute [rw] next_token
5148
+ # The token for the next set of results, or null if there are no
5149
+ # additional results.
5150
+ # @return [String]
5151
+ #
5152
+ class ListTimeSeriesResponse < Struct.new(
5153
+ :time_series_summaries,
5154
+ :next_token)
5155
+ SENSITIVE = []
5156
+ include Aws::Structure
5157
+ end
5158
+
4863
5159
  # Contains logging options.
4864
5160
  #
4865
5161
  # @note When making an API call, you may pass LoggingOptions
@@ -5507,9 +5803,8 @@ module Aws::IoTSiteWise
5507
5803
  # @return [String]
5508
5804
  #
5509
5805
  # @!attribute [rw] kms_key_id
5510
- # The Key ID of the customer managed customer master key (CMK) used
5511
- # for KMS encryption. This is required if you use
5512
- # `KMS_BASED_ENCRYPTION`.
5806
+ # The Key ID of the customer managed key used for KMS encryption. This
5807
+ # is required if you use `KMS_BASED_ENCRYPTION`.
5513
5808
  # @return [String]
5514
5809
  #
5515
5810
  class PutDefaultEncryptionConfigurationRequest < Struct.new(
@@ -5524,7 +5819,7 @@ module Aws::IoTSiteWise
5524
5819
  # @return [String]
5525
5820
  #
5526
5821
  # @!attribute [rw] kms_key_arn
5527
- # The Key ARN of the KMS CMK used for KMS encryption if you use
5822
+ # The Key ARN of the KMS key used for KMS encryption if you use
5528
5823
  # `KMS_BASED_ENCRYPTION`.
5529
5824
  # @return [String]
5530
5825
  #
@@ -5574,18 +5869,23 @@ module Aws::IoTSiteWise
5574
5869
  # role_arn: "ARN", # required
5575
5870
  # },
5576
5871
  # },
5872
+ # disassociated_data_storage: "ENABLED", # accepts ENABLED, DISABLED
5873
+ # retention_period: {
5874
+ # number_of_days: 1,
5875
+ # unlimited: false,
5876
+ # },
5577
5877
  # }
5578
5878
  #
5579
5879
  # @!attribute [rw] storage_type
5580
- # The type of storage that you specified for your data. The storage
5581
- # type can be one of the following values:
5880
+ # The storage tier that you specified for your data. The `storageType`
5881
+ # parameter can be one of the following values:
5582
5882
  #
5583
- # * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise replicates your data
5584
- # into a service managed database.
5883
+ # * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise saves your data into the
5884
+ # hot tier. The hot tier is a service-managed database.
5585
5885
  #
5586
- # * `MULTI_LAYER_STORAGE` – IoT SiteWise replicates your data into a
5587
- # service managed database and saves a copy of your raw data and
5588
- # metadata in an Amazon S3 object that you specified.
5886
+ # * `MULTI_LAYER_STORAGE` – IoT SiteWise saves your data in both the
5887
+ # cold tier and the cold tier. The cold tier is a customer-managed
5888
+ # Amazon S3 bucket.
5589
5889
  # @return [String]
5590
5890
  #
5591
5891
  # @!attribute [rw] multi_layer_storage
@@ -5594,29 +5894,85 @@ module Aws::IoTSiteWise
5594
5894
  # `MultiLayerStorage` object.
5595
5895
  # @return [Types::MultiLayerStorage]
5596
5896
  #
5897
+ # @!attribute [rw] disassociated_data_storage
5898
+ # Contains the storage configuration for time series (data streams)
5899
+ # that aren't associated with asset properties. The
5900
+ # `disassociatedDataStorage` can be one of the following values:
5901
+ #
5902
+ # * `ENABLED` – IoT SiteWise accepts time series that aren't
5903
+ # associated with asset properties.
5904
+ #
5905
+ # After the `disassociatedDataStorage` is enabled, you can't
5906
+ # disable it.
5907
+ #
5908
+ # * `DISABLED` – IoT SiteWise doesn't accept time series (data
5909
+ # streams) that aren't associated with asset properties.
5910
+ #
5911
+ # For more information, see [Data streams][1] in the *IoT SiteWise
5912
+ # User Guide*.
5913
+ #
5914
+ #
5915
+ #
5916
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html
5917
+ # @return [String]
5918
+ #
5919
+ # @!attribute [rw] retention_period
5920
+ # How many days your data is kept in the hot tier. By default, your
5921
+ # data is kept indefinitely in the hot tier.
5922
+ # @return [Types::RetentionPeriod]
5923
+ #
5597
5924
  class PutStorageConfigurationRequest < Struct.new(
5598
5925
  :storage_type,
5599
- :multi_layer_storage)
5926
+ :multi_layer_storage,
5927
+ :disassociated_data_storage,
5928
+ :retention_period)
5600
5929
  SENSITIVE = []
5601
5930
  include Aws::Structure
5602
5931
  end
5603
5932
 
5604
5933
  # @!attribute [rw] storage_type
5605
- # The type of storage that you specified for your data. The storage
5606
- # type can be one of the following values:
5934
+ # The storage tier that you specified for your data. The `storageType`
5935
+ # parameter can be one of the following values:
5607
5936
  #
5608
- # * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise replicates your data
5609
- # into a service managed database.
5937
+ # * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise saves your data into the
5938
+ # hot tier. The hot tier is a service-managed database.
5610
5939
  #
5611
- # * `MULTI_LAYER_STORAGE` – IoT SiteWise replicates your data into a
5612
- # service managed database and saves a copy of your raw data and
5613
- # metadata in an Amazon S3 object that you specified.
5940
+ # * `MULTI_LAYER_STORAGE` – IoT SiteWise saves your data in both the
5941
+ # cold tier and the cold tier. The cold tier is a customer-managed
5942
+ # Amazon S3 bucket.
5614
5943
  # @return [String]
5615
5944
  #
5616
5945
  # @!attribute [rw] multi_layer_storage
5617
5946
  # Contains information about the storage destination.
5618
5947
  # @return [Types::MultiLayerStorage]
5619
5948
  #
5949
+ # @!attribute [rw] disassociated_data_storage
5950
+ # Contains the storage configuration for time series (data streams)
5951
+ # that aren't associated with asset properties. The
5952
+ # `disassociatedDataStorage` can be one of the following values:
5953
+ #
5954
+ # * `ENABLED` – IoT SiteWise accepts time series that aren't
5955
+ # associated with asset properties.
5956
+ #
5957
+ # After the `disassociatedDataStorage` is enabled, you can't
5958
+ # disable it.
5959
+ #
5960
+ # * `DISABLED` – IoT SiteWise doesn't accept time series (data
5961
+ # streams) that aren't associated with asset properties.
5962
+ #
5963
+ # For more information, see [Data streams][1] in the *IoT SiteWise
5964
+ # User Guide*.
5965
+ #
5966
+ #
5967
+ #
5968
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html
5969
+ # @return [String]
5970
+ #
5971
+ # @!attribute [rw] retention_period
5972
+ # How many days your data is kept in the hot tier. By default, your
5973
+ # data is kept indefinitely in the hot tier.
5974
+ # @return [Types::RetentionPeriod]
5975
+ #
5620
5976
  # @!attribute [rw] configuration_status
5621
5977
  # Contains current status information for the configuration.
5622
5978
  # @return [Types::ConfigurationStatus]
@@ -5624,6 +5980,8 @@ module Aws::IoTSiteWise
5624
5980
  class PutStorageConfigurationResponse < Struct.new(
5625
5981
  :storage_type,
5626
5982
  :multi_layer_storage,
5983
+ :disassociated_data_storage,
5984
+ :retention_period,
5627
5985
  :configuration_status)
5628
5986
  SENSITIVE = []
5629
5987
  include Aws::Structure
@@ -5690,6 +6048,42 @@ module Aws::IoTSiteWise
5690
6048
  include Aws::Structure
5691
6049
  end
5692
6050
 
6051
+ # How many days your data is kept in the hot tier. By default, your data
6052
+ # is kept indefinitely in the hot tier.
6053
+ #
6054
+ # @note When making an API call, you may pass RetentionPeriod
6055
+ # data as a hash:
6056
+ #
6057
+ # {
6058
+ # number_of_days: 1,
6059
+ # unlimited: false,
6060
+ # }
6061
+ #
6062
+ # @!attribute [rw] number_of_days
6063
+ # The number of days that your data is kept.
6064
+ #
6065
+ # <note markdown="1"> If you specified a value for this parameter, the `unlimited`
6066
+ # parameter must be `false`.
6067
+ #
6068
+ # </note>
6069
+ # @return [Integer]
6070
+ #
6071
+ # @!attribute [rw] unlimited
6072
+ # If true, your data is kept indefinitely.
6073
+ #
6074
+ # <note markdown="1"> If configured to `true`, you must not specify a value for the
6075
+ # `numberOfDays` parameter.
6076
+ #
6077
+ # </note>
6078
+ # @return [Boolean]
6079
+ #
6080
+ class RetentionPeriod < Struct.new(
6081
+ :number_of_days,
6082
+ :unlimited)
6083
+ SENSITIVE = []
6084
+ include Aws::Structure
6085
+ end
6086
+
5693
6087
  # The requested service is unavailable.
5694
6088
  #
5695
6089
  # @!attribute [rw] message
@@ -5784,6 +6178,62 @@ module Aws::IoTSiteWise
5784
6178
  include Aws::Structure
5785
6179
  end
5786
6180
 
6181
+ # Contains a summary of a time series (data stream).
6182
+ #
6183
+ # @!attribute [rw] asset_id
6184
+ # The ID of the asset in which the asset property was created.
6185
+ # @return [String]
6186
+ #
6187
+ # @!attribute [rw] property_id
6188
+ # The ID of the asset property.
6189
+ # @return [String]
6190
+ #
6191
+ # @!attribute [rw] alias
6192
+ # The alias that identifies the time series.
6193
+ # @return [String]
6194
+ #
6195
+ # @!attribute [rw] time_series_id
6196
+ # The ID of the time series.
6197
+ # @return [String]
6198
+ #
6199
+ # @!attribute [rw] data_type
6200
+ # The data type of the time series.
6201
+ #
6202
+ # If you specify `STRUCT`, you must also specify `dataTypeSpec` to
6203
+ # identify the type of the structure for this time series.
6204
+ # @return [String]
6205
+ #
6206
+ # @!attribute [rw] data_type_spec
6207
+ # The data type of the structure for this time series. This parameter
6208
+ # is required for time series that have the `STRUCT` data type.
6209
+ #
6210
+ # The options for this parameter depend on the type of the composite
6211
+ # model in which you created the asset property that is associated
6212
+ # with your time series. Use `AWS/ALARM_STATE` for alarm state in
6213
+ # alarm composite models.
6214
+ # @return [String]
6215
+ #
6216
+ # @!attribute [rw] time_series_creation_date
6217
+ # The date that the time series was created, in Unix epoch time.
6218
+ # @return [Time]
6219
+ #
6220
+ # @!attribute [rw] time_series_last_update_date
6221
+ # The date that the time series was last updated, in Unix epoch time.
6222
+ # @return [Time]
6223
+ #
6224
+ class TimeSeriesSummary < Struct.new(
6225
+ :asset_id,
6226
+ :property_id,
6227
+ :alias,
6228
+ :time_series_id,
6229
+ :data_type,
6230
+ :data_type_spec,
6231
+ :time_series_creation_date,
6232
+ :time_series_last_update_date)
6233
+ SENSITIVE = []
6234
+ include Aws::Structure
6235
+ end
6236
+
5787
6237
  # You've reached the limit for the number of tags allowed for a
5788
6238
  # resource. For more information, see [Tag naming limits and
5789
6239
  # requirements][1] in the *Amazon Web Services General Reference*.
@@ -5906,16 +6356,17 @@ module Aws::IoTSiteWise
5906
6356
  end
5907
6357
 
5908
6358
  # Contains a tumbling window, which is a repeating fixed-sized,
5909
- # non-overlapping, and contiguous time window. You use this window in
5910
- # metrics to aggregate data from properties and other assets.
6359
+ # non-overlapping, and contiguous time window. You can use this window
6360
+ # in metrics to aggregate data from properties and other assets.
5911
6361
  #
5912
6362
  # You can use `m`, `h`, `d`, and `w` when you specify an interval or
5913
- # offset. Note that `m` represents minutes, and `w` represents weeks.
5914
- # You can also use `s` to represent seconds in `offset`.
6363
+ # offset. Note that `m` represents minutes, `h` represents hours, `d`
6364
+ # represents days, and `w` represents weeks. You can also use `s` to
6365
+ # represent seconds in `offset`.
5915
6366
  #
5916
6367
  # The `interval` and `offset` parameters support the [ISO 8601
5917
- # format][1]. For example, `PT5S` represents five seconds, `PT5M`
5918
- # represents five minutes, and `PT5H` represents five hours.
6368
+ # format][1]. For example, `PT5S` represents 5 seconds, `PT5M`
6369
+ # represents 5 minutes, and `PT5H` represents 5 hours.
5919
6370
  #
5920
6371
  #
5921
6372
  #
@@ -5954,11 +6405,11 @@ module Aws::IoTSiteWise
5954
6405
  # `interval`, IoT SiteWise aggregates data in one of the following
5955
6406
  # ways:
5956
6407
  #
5957
- # * If you create the metric before or at 6:00 PM (UTC), you get the
6408
+ # * If you create the metric before or at 6 PM (UTC), you get the
5958
6409
  # first aggregation result at 6 PM (UTC) on the day when you
5959
6410
  # create the metric.
5960
6411
  #
5961
- # * If you create the metric after 6:00 PM (UTC), you get the first
6412
+ # * If you create the metric after 6 PM (UTC), you get the first
5962
6413
  # aggregation result at 6 PM (UTC) the next day.
5963
6414
  #
5964
6415
  # * The ISO 8601 format.
@@ -5967,16 +6418,16 @@ module Aws::IoTSiteWise
5967
6418
  # `interval`, IoT SiteWise aggregates data in one of the following
5968
6419
  # ways:
5969
6420
  #
5970
- # * If you create the metric before or at 6:00 PM (UTC), you get the
6421
+ # * If you create the metric before or at 6 PM (UTC), you get the
5971
6422
  # first aggregation result at 6 PM (UTC) on the day when you
5972
6423
  # create the metric.
5973
6424
  #
5974
- # * If you create the metric after 6:00 PM (UTC), you get the first
6425
+ # * If you create the metric after 6 PM (UTC), you get the first
5975
6426
  # aggregation result at 6 PM (UTC) the next day.
5976
6427
  #
5977
6428
  # * The 24-hour clock.
5978
6429
  #
5979
- # For example, if you specify `00:03:00` for `offset` and `5m` for
6430
+ # For example, if you specify `00:03:00` for `offset`, `5m` for
5980
6431
  # `interval`, and you create the metric at 2 PM (UTC), you get the
5981
6432
  # first aggregation result at 2:03 PM (UTC). You get the second
5982
6433
  # aggregation result at 2:08 PM (UTC).
@@ -5987,11 +6438,11 @@ module Aws::IoTSiteWise
5987
6438
  # `1d` for `interval`, IoT SiteWise aggregates data in one of the
5988
6439
  # following ways:
5989
6440
  #
5990
- # * If you create the metric before or at 6:00 PM (PST), you get the
6441
+ # * If you create the metric before or at 6 PM (PST), you get the
5991
6442
  # first aggregation result at 6 PM (PST) on the day when you
5992
6443
  # create the metric.
5993
6444
  #
5994
- # * If you create the metric after 6:00 PM (PST), you get the first
6445
+ # * If you create the metric after 6 PM (PST), you get the first
5995
6446
  # aggregation result at 6 PM (PST) the next day.
5996
6447
  # @return [String]
5997
6448
  #