aws-sdk-iotsitewise 1.35.0 → 1.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 391bb213817954ffbf1b4c6e8f3c970450c8d7b1fdc911ea6a794887057a55f4
-  data.tar.gz: 9a631f419ca4d3a4f0a4e0bccc2caed17f6a52293a2f047afe8cb296bac801a6
+  metadata.gz: 56a09a019ded1c99680322c2094dba46d7ba9f4433fb9a3378d5178196b55f8e
+  data.tar.gz: '09d6b35c24d701c39ccb11d2e907c2d74aebcf13192c29363fb4850e2741d522'
 SHA512:
-  metadata.gz: ebbc4cc1e2c498642a8d38364c2cab1e55f413ba99b9a6b53ccb0e4f09bbca4f81405bcfd094967d041a72dd3986a2e4225c859436c93414762221536dc802b6
-  data.tar.gz: 167fda50a943d520651c82038abef954ca9c3fc840661846344a862a704b99c696de04bef4a54f310c5a5f6db3a08374be7e0d0eb548fe2513ba000baed2d258
+  metadata.gz: ddd95a3277bed53de14de33c8ba48a3535dc8ed76dd768f75c946a7d81b0037a745ee47bf313d79dcd622b248d9cdd914f33546aa9fa20a52adfc96a20a9718b
+  data.tar.gz: '0179e2a3ac7b7a249ff908871861cf42a687ac69440fcbc7ad0465877bd466320d1db8030439f5d2d6ca190535950ab6aa0d6158b8c13d56d25efcc26dfd3900'

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.36.0 (2021-11-29)
+------------------
+
+* Feature - AWS IoT SiteWise now supports retention configuration for the hot tier storage.
+
 1.35.0 (2021-11-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.35.0
+1.36.0

data/lib/aws-sdk-iotsitewise/client.rb

@@ -1172,8 +1172,7 @@ module Aws::IoTSiteWise
     #     China Regions.
     #
     #   * `IAM` – The portal uses Identity and Access Management to
-    #     authenticate users and manage user permissions. This option is only
-    #     available in the China Regions.
+    #     authenticate users and manage user permissions.
     #
     #   You can't change this value after you create a portal.
     #
@@ -2228,6 +2227,7 @@ module Aws::IoTSiteWise
     #   * {Types::DescribeStorageConfigurationResponse#storage_type #storage_type} => String
     #   * {Types::DescribeStorageConfigurationResponse#multi_layer_storage #multi_layer_storage} => Types::MultiLayerStorage
     #   * {Types::DescribeStorageConfigurationResponse#disassociated_data_storage #disassociated_data_storage} => String
+    #   * {Types::DescribeStorageConfigurationResponse#retention_period #retention_period} => Types::RetentionPeriod
     #   * {Types::DescribeStorageConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
     #   * {Types::DescribeStorageConfigurationResponse#last_update_date #last_update_date} => Time
     #
@@ -2237,6 +2237,8 @@ module Aws::IoTSiteWise
     #   resp.multi_layer_storage.customer_managed_s3_storage.s3_resource_arn #=> String
     #   resp.multi_layer_storage.customer_managed_s3_storage.role_arn #=> String
     #   resp.disassociated_data_storage #=> String, one of "ENABLED", "DISABLED"
+    #   resp.retention_period.number_of_days #=> Integer
+    #   resp.retention_period.unlimited #=> Boolean
     #   resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
     #   resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
     #   resp.configuration_status.error.message #=> String
@@ -3568,15 +3570,15 @@ module Aws::IoTSiteWise
     # Configures storage settings for IoT SiteWise.
     #
     # @option params [required, String] :storage_type
-    #   The type of storage that you specified for your data. The storage type
-    #   can be one of the following values:
+    #   The storage tier that you specified for your data. The `storageType`
+    #   parameter can be one of the following values:
     #
-    #   * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise replicates your data into
-    #     a service managed database.
+    #   * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise saves your data into the
+    #     hot tier. The hot tier is a service-managed database.
     #
-    #   * `MULTI_LAYER_STORAGE` – IoT SiteWise replicates your data into a
-    #     service managed database and saves a copy of your raw data and
-    #     metadata in an Amazon S3 object that you specified.
+    #   * `MULTI_LAYER_STORAGE` – IoT SiteWise saves your data in both the
+    #     cold tier and the cold tier. The cold tier is a customer-managed
+    #     Amazon S3 bucket.
     #
     # @option params [Types::MultiLayerStorage] :multi_layer_storage
     #   Identifies a storage destination. If you specified
@@ -3604,11 +3606,16 @@ module Aws::IoTSiteWise
     #
     #   [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html
     #
+    # @option params [Types::RetentionPeriod] :retention_period
+    #   How many days your data is kept in the hot tier. By default, your data
+    #   is kept indefinitely in the hot tier.
+    #
     # @return [Types::PutStorageConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::PutStorageConfigurationResponse#storage_type #storage_type} => String
     #   * {Types::PutStorageConfigurationResponse#multi_layer_storage #multi_layer_storage} => Types::MultiLayerStorage
     #   * {Types::PutStorageConfigurationResponse#disassociated_data_storage #disassociated_data_storage} => String
+    #   * {Types::PutStorageConfigurationResponse#retention_period #retention_period} => Types::RetentionPeriod
     #   * {Types::PutStorageConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
     #
     # @example Request syntax with placeholder values
@@ -3622,6 +3629,10 @@ module Aws::IoTSiteWise
     #       },
     #     },
     #     disassociated_data_storage: "ENABLED", # accepts ENABLED, DISABLED
+    #     retention_period: {
+    #       number_of_days: 1,
+    #       unlimited: false,
+    #     },
     #   })
     #
     # @example Response structure
@@ -3630,6 +3641,8 @@ module Aws::IoTSiteWise
     #   resp.multi_layer_storage.customer_managed_s3_storage.s3_resource_arn #=> String
     #   resp.multi_layer_storage.customer_managed_s3_storage.role_arn #=> String
     #   resp.disassociated_data_storage #=> String, one of "ENABLED", "DISABLED"
+    #   resp.retention_period.number_of_days #=> Integer
+    #   resp.retention_period.unlimited #=> Boolean
     #   resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
     #   resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
     #   resp.configuration_status.error.message #=> String
@@ -4401,7 +4414,7 @@ module Aws::IoTSiteWise
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-iotsitewise'
-      context[:gem_version] = '1.35.0'
+      context[:gem_version] = '1.36.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-iotsitewise/client_api.rb

@@ -251,6 +251,7 @@ module Aws::IoTSiteWise
     MultiLayerStorage = Shapes::StructureShape.new(name: 'MultiLayerStorage')
     Name = Shapes::StringShape.new(name: 'Name')
     NextToken = Shapes::StringShape.new(name: 'NextToken')
+    NumberOfDays = Shapes::IntegerShape.new(name: 'NumberOfDays')
     Offset = Shapes::StringShape.new(name: 'Offset')
     OffsetInNanos = Shapes::IntegerShape.new(name: 'OffsetInNanos')
     Permission = Shapes::StringShape.new(name: 'Permission')
@@ -292,6 +293,7 @@ module Aws::IoTSiteWise
     ResourceId = Shapes::StringShape.new(name: 'ResourceId')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     ResourceType = Shapes::StringShape.new(name: 'ResourceType')
+    RetentionPeriod = Shapes::StructureShape.new(name: 'RetentionPeriod')
     SSOApplicationId = Shapes::StringShape.new(name: 'SSOApplicationId')
     ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
     StorageType = Shapes::StringShape.new(name: 'StorageType')
@@ -317,6 +319,7 @@ module Aws::IoTSiteWise
     TraversalType = Shapes::StringShape.new(name: 'TraversalType')
     TumblingWindow = Shapes::StructureShape.new(name: 'TumblingWindow')
     UnauthorizedException = Shapes::StructureShape.new(name: 'UnauthorizedException')
+    Unlimited = Shapes::BooleanShape.new(name: 'Unlimited')
     UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
     UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
     UpdateAccessPolicyRequest = Shapes::StructureShape.new(name: 'UpdateAccessPolicyRequest')
@@ -871,6 +874,7 @@ module Aws::IoTSiteWise
     DescribeStorageConfigurationResponse.add_member(:storage_type, Shapes::ShapeRef.new(shape: StorageType, required: true, location_name: "storageType"))
     DescribeStorageConfigurationResponse.add_member(:multi_layer_storage, Shapes::ShapeRef.new(shape: MultiLayerStorage, location_name: "multiLayerStorage"))
     DescribeStorageConfigurationResponse.add_member(:disassociated_data_storage, Shapes::ShapeRef.new(shape: DisassociatedDataStorageState, location_name: "disassociatedDataStorage"))
+    DescribeStorageConfigurationResponse.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
     DescribeStorageConfigurationResponse.add_member(:configuration_status, Shapes::ShapeRef.new(shape: ConfigurationStatus, required: true, location_name: "configurationStatus"))
     DescribeStorageConfigurationResponse.add_member(:last_update_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateDate"))
     DescribeStorageConfigurationResponse.struct_class = Types::DescribeStorageConfigurationResponse
@@ -1267,11 +1271,13 @@ module Aws::IoTSiteWise
     PutStorageConfigurationRequest.add_member(:storage_type, Shapes::ShapeRef.new(shape: StorageType, required: true, location_name: "storageType"))
     PutStorageConfigurationRequest.add_member(:multi_layer_storage, Shapes::ShapeRef.new(shape: MultiLayerStorage, location_name: "multiLayerStorage"))
     PutStorageConfigurationRequest.add_member(:disassociated_data_storage, Shapes::ShapeRef.new(shape: DisassociatedDataStorageState, location_name: "disassociatedDataStorage"))
+    PutStorageConfigurationRequest.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
     PutStorageConfigurationRequest.struct_class = Types::PutStorageConfigurationRequest
 
     PutStorageConfigurationResponse.add_member(:storage_type, Shapes::ShapeRef.new(shape: StorageType, required: true, location_name: "storageType"))
     PutStorageConfigurationResponse.add_member(:multi_layer_storage, Shapes::ShapeRef.new(shape: MultiLayerStorage, location_name: "multiLayerStorage"))
     PutStorageConfigurationResponse.add_member(:disassociated_data_storage, Shapes::ShapeRef.new(shape: DisassociatedDataStorageState, location_name: "disassociatedDataStorage"))
+    PutStorageConfigurationResponse.add_member(:retention_period, Shapes::ShapeRef.new(shape: RetentionPeriod, location_name: "retentionPeriod"))
     PutStorageConfigurationResponse.add_member(:configuration_status, Shapes::ShapeRef.new(shape: ConfigurationStatus, required: true, location_name: "configurationStatus"))
     PutStorageConfigurationResponse.struct_class = Types::PutStorageConfigurationResponse
 
@@ -1289,6 +1295,10 @@ module Aws::IoTSiteWise
     ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "message"))
     ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
 
+    RetentionPeriod.add_member(:number_of_days, Shapes::ShapeRef.new(shape: NumberOfDays, location_name: "numberOfDays"))
+    RetentionPeriod.add_member(:unlimited, Shapes::ShapeRef.new(shape: Unlimited, location_name: "unlimited"))
+    RetentionPeriod.struct_class = Types::RetentionPeriod
+
     ServiceUnavailableException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "message"))
     ServiceUnavailableException.struct_class = Types::ServiceUnavailableException
 

data/lib/aws-sdk-iotsitewise/types.rb

@@ -2090,8 +2090,7 @@ module Aws::IoTSiteWise
     #     the China Regions.
     #
     #   * `IAM` – The portal uses Identity and Access Management to
-    #     authenticate users and manage user permissions. This option is
-    #     only available in the China Regions.
+    #     authenticate users and manage user permissions.
     #
     #   You can't change this value after you create a portal.
     #
@@ -3322,15 +3321,15 @@ module Aws::IoTSiteWise
     class DescribeStorageConfigurationRequest < Aws::EmptyStructure; end
 
     # @!attribute [rw] storage_type
-    #   The type of storage that you specified for your data. The storage
-    #   type can be one of the following values:
+    #   The storage tier that you specified for your data. The `storageType`
+    #   parameter can be one of the following values:
     #
-    #   * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise replicates your data
-    #     into a service managed database.
+    #   * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise saves your data into the
+    #     hot tier. The hot tier is a service-managed database.
     #
-    #   * `MULTI_LAYER_STORAGE` – IoT SiteWise replicates your data into a
-    #     service managed database and saves a copy of your raw data and
-    #     metadata in an Amazon S3 object that you specified.
+    #   * `MULTI_LAYER_STORAGE` – IoT SiteWise saves your data in both the
+    #     cold tier and the cold tier. The cold tier is a customer-managed
+    #     Amazon S3 bucket.
     #   @return [String]
     #
     # @!attribute [rw] multi_layer_storage
@@ -3359,6 +3358,11 @@ module Aws::IoTSiteWise
     #   [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html
     #   @return [String]
     #
+    # @!attribute [rw] retention_period
+    #   How many days your data is kept in the hot tier. By default, your
+    #   data is kept indefinitely in the hot tier.
+    #   @return [Types::RetentionPeriod]
+    #
     # @!attribute [rw] configuration_status
     #   Contains current status information for the configuration.
     #   @return [Types::ConfigurationStatus]
@@ -3372,6 +3376,7 @@ module Aws::IoTSiteWise
       :storage_type,
       :multi_layer_storage,
       :disassociated_data_storage,
+      :retention_period,
       :configuration_status,
       :last_update_date)
       SENSITIVE = []
@@ -5865,18 +5870,22 @@ module Aws::IoTSiteWise
     #           },
     #         },
     #         disassociated_data_storage: "ENABLED", # accepts ENABLED, DISABLED
+    #         retention_period: {
+    #           number_of_days: 1,
+    #           unlimited: false,
+    #         },
     #       }
     #
     # @!attribute [rw] storage_type
-    #   The type of storage that you specified for your data. The storage
-    #   type can be one of the following values:
+    #   The storage tier that you specified for your data. The `storageType`
+    #   parameter can be one of the following values:
     #
-    #   * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise replicates your data
-    #     into a service managed database.
+    #   * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise saves your data into the
+    #     hot tier. The hot tier is a service-managed database.
     #
-    #   * `MULTI_LAYER_STORAGE` – IoT SiteWise replicates your data into a
-    #     service managed database and saves a copy of your raw data and
-    #     metadata in an Amazon S3 object that you specified.
+    #   * `MULTI_LAYER_STORAGE` – IoT SiteWise saves your data in both the
+    #     cold tier and the cold tier. The cold tier is a customer-managed
+    #     Amazon S3 bucket.
     #   @return [String]
     #
     # @!attribute [rw] multi_layer_storage
@@ -5907,24 +5916,30 @@ module Aws::IoTSiteWise
     #   [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html
     #   @return [String]
     #
+    # @!attribute [rw] retention_period
+    #   How many days your data is kept in the hot tier. By default, your
+    #   data is kept indefinitely in the hot tier.
+    #   @return [Types::RetentionPeriod]
+    #
     class PutStorageConfigurationRequest < Struct.new(
       :storage_type,
       :multi_layer_storage,
-      :disassociated_data_storage)
+      :disassociated_data_storage,
+      :retention_period)
       SENSITIVE = []
       include Aws::Structure
     end
 
     # @!attribute [rw] storage_type
-    #   The type of storage that you specified for your data. The storage
-    #   type can be one of the following values:
+    #   The storage tier that you specified for your data. The `storageType`
+    #   parameter can be one of the following values:
     #
-    #   * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise replicates your data
-    #     into a service managed database.
+    #   * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise saves your data into the
+    #     hot tier. The hot tier is a service-managed database.
     #
-    #   * `MULTI_LAYER_STORAGE` – IoT SiteWise replicates your data into a
-    #     service managed database and saves a copy of your raw data and
-    #     metadata in an Amazon S3 object that you specified.
+    #   * `MULTI_LAYER_STORAGE` – IoT SiteWise saves your data in both the
+    #     cold tier and the cold tier. The cold tier is a customer-managed
+    #     Amazon S3 bucket.
     #   @return [String]
     #
     # @!attribute [rw] multi_layer_storage
@@ -5953,6 +5968,11 @@ module Aws::IoTSiteWise
     #   [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html
     #   @return [String]
     #
+    # @!attribute [rw] retention_period
+    #   How many days your data is kept in the hot tier. By default, your
+    #   data is kept indefinitely in the hot tier.
+    #   @return [Types::RetentionPeriod]
+    #
     # @!attribute [rw] configuration_status
     #   Contains current status information for the configuration.
     #   @return [Types::ConfigurationStatus]
@@ -5961,6 +5981,7 @@ module Aws::IoTSiteWise
       :storage_type,
       :multi_layer_storage,
       :disassociated_data_storage,
+      :retention_period,
       :configuration_status)
       SENSITIVE = []
       include Aws::Structure
@@ -6027,6 +6048,42 @@ module Aws::IoTSiteWise
       include Aws::Structure
     end
 
+    # How many days your data is kept in the hot tier. By default, your data
+    # is kept indefinitely in the hot tier.
+    #
+    # @note When making an API call, you may pass RetentionPeriod
+    #   data as a hash:
+    #
+    #       {
+    #         number_of_days: 1,
+    #         unlimited: false,
+    #       }
+    #
+    # @!attribute [rw] number_of_days
+    #   The number of days that your data is kept.
+    #
+    #   <note markdown="1"> If you specified a value for this parameter, the `unlimited`
+    #   parameter must be `false`.
+    #
+    #    </note>
+    #   @return [Integer]
+    #
+    # @!attribute [rw] unlimited
+    #   If true, your data is kept indefinitely.
+    #
+    #   <note markdown="1"> If configured to `true`, you must not specify a value for the
+    #   `numberOfDays` parameter.
+    #
+    #    </note>
+    #   @return [Boolean]
+    #
+    class RetentionPeriod < Struct.new(
+      :number_of_days,
+      :unlimited)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The requested service is unavailable.
     #
     # @!attribute [rw] message

data/lib/aws-sdk-iotsitewise.rb

@@ -49,6 +49,6 @@ require_relative 'aws-sdk-iotsitewise/customizations'
 # @!group service
 module Aws::IoTSiteWise
 
-  GEM_VERSION = '1.35.0'
+  GEM_VERSION = '1.36.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-iotsitewise
 version: !ruby/object:Gem::Version
-  version: 1.35.0
+  version: 1.36.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-24 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core