aws-sdk-iotsitewise 1.39.0 → 1.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0509cbae7f8fc1c1ef918963ad4cdb469d102b5757f7bc13800126047af70e6
-  data.tar.gz: eca0e14f63c5cf3dc740b8eb66eabcdce5363033c74b3a35d33d54a0b64a1ddf
+  metadata.gz: dc6f321fc58dc7c7b588153e70f2fdc4affdfcb50a88e6eac867bf72709b5659
+  data.tar.gz: 173217fc5a4c697447880d846225d364f2eec5085f400268affdec4f7a506a53
 SHA512:
-  metadata.gz: 32384441898c3e3eeea2d4f5c1b29b4b28ca888652490a8d36da2b65b209ee01fd99c1d2946951673ee69328972af0c80427617a804f5cc39c99e9c2dce0a8d4
-  data.tar.gz: cee7a9f1267f863f0b0e2465a1b2d658b0c5e0876819ec92c5f1c1bd537037db152aa1b27213f52e1d7e5c19b5a211b1cdd3345230dfa97694127d7bfeb53901
+  metadata.gz: c549a99fecd705492070571f5e1d28d088f46ff7c5d44133e61fa9b8b1c9cb67eed88e0c032f6f59c38f3b14b14d068e80d397addbd090afa499561680a05fc1
+  data.tar.gz: 63043ea4371ab954ba203c9474413fadeaf1269ebff6fd02ff77b36c857443bcf5a7224fca7de4a69c4b7b1b0f09e32c9ad7ef835d355dc1fa96cce574ce4a26

data/CHANGELOG.md

@@ -1,6 +1,21 @@
 Unreleased Changes
 ------------------
 
+1.42.0 (2022-05-31)
+------------------
+
+* Feature - This release adds the following new optional field to the IoT SiteWise asset resource: assetDescription.
+
+1.41.0 (2022-04-21)
+------------------
+
+* Feature - This release adds 3 new batch data query APIs : BatchGetAssetPropertyValue, BatchGetAssetPropertyValueHistory and BatchGetAssetPropertyAggregates
+
+1.40.0 (2022-02-24)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
 1.39.0 (2022-02-03)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.39.0
+1.42.0

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

@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
 require 'aws-sdk-core/plugins/http_checksum.rb'
+require 'aws-sdk-core/plugins/checksum_algorithm.rb'
 require 'aws-sdk-core/plugins/defaults_mode.rb'
 require 'aws-sdk-core/plugins/recursion_detection.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
@@ -75,6 +76,7 @@ module Aws::IoTSiteWise
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
     add_plugin(Aws::Plugins::HttpChecksum)
+    add_plugin(Aws::Plugins::ChecksumAlgorithm)
     add_plugin(Aws::Plugins::DefaultsMode)
     add_plugin(Aws::Plugins::RecursionDetection)
     add_plugin(Aws::Plugins::SignatureV4)
@@ -522,6 +524,240 @@ module Aws::IoTSiteWise
       req.send_request(options)
     end
 
+    # Gets aggregated values (for example, average, minimum, and maximum)
+    # for one or more asset properties. For more information, see [Querying
+    # aggregates][1] in the *IoT SiteWise User Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates
+    #
+    # @option params [required, Array<Types::BatchGetAssetPropertyAggregatesEntry>] :entries
+    #   The list of asset property aggregate entries for the batch get
+    #   request. You can specify up to 16 entries per request.
+    #
+    # @option params [String] :next_token
+    #   The token to be used for the next set of paginated results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return for each paginated request. A
+    #   result set is returned in the two cases, whichever occurs first.
+    #
+    #   * The size of the result set is less than 1 MB.
+    #
+    #   * The number of data points in the result set is less than the value
+    #     of `maxResults`. The maximum value of `maxResults` is 4000.
+    #
+    # @return [Types::BatchGetAssetPropertyAggregatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::BatchGetAssetPropertyAggregatesResponse#error_entries #error_entries} => Array&lt;Types::BatchGetAssetPropertyAggregatesErrorEntry&gt;
+    #   * {Types::BatchGetAssetPropertyAggregatesResponse#success_entries #success_entries} => Array&lt;Types::BatchGetAssetPropertyAggregatesSuccessEntry&gt;
+    #   * {Types::BatchGetAssetPropertyAggregatesResponse#skipped_entries #skipped_entries} => Array&lt;Types::BatchGetAssetPropertyAggregatesSkippedEntry&gt;
+    #   * {Types::BatchGetAssetPropertyAggregatesResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.batch_get_asset_property_aggregates({
+    #     entries: [ # required
+    #       {
+    #         entry_id: "EntryId", # required
+    #         asset_id: "ID",
+    #         property_id: "ID",
+    #         property_alias: "AssetPropertyAlias",
+    #         aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
+    #         resolution: "Resolution", # required
+    #         start_date: Time.now, # required
+    #         end_date: Time.now, # required
+    #         qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
+    #         time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
+    #       },
+    #     ],
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.error_entries #=> Array
+    #   resp.error_entries[0].error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
+    #   resp.error_entries[0].error_message #=> String
+    #   resp.error_entries[0].entry_id #=> String
+    #   resp.success_entries #=> Array
+    #   resp.success_entries[0].entry_id #=> String
+    #   resp.success_entries[0].aggregated_values #=> Array
+    #   resp.success_entries[0].aggregated_values[0].timestamp #=> Time
+    #   resp.success_entries[0].aggregated_values[0].quality #=> String, one of "GOOD", "BAD", "UNCERTAIN"
+    #   resp.success_entries[0].aggregated_values[0].value.average #=> Float
+    #   resp.success_entries[0].aggregated_values[0].value.count #=> Float
+    #   resp.success_entries[0].aggregated_values[0].value.maximum #=> Float
+    #   resp.success_entries[0].aggregated_values[0].value.minimum #=> Float
+    #   resp.success_entries[0].aggregated_values[0].value.sum #=> Float
+    #   resp.success_entries[0].aggregated_values[0].value.standard_deviation #=> Float
+    #   resp.skipped_entries #=> Array
+    #   resp.skipped_entries[0].entry_id #=> String
+    #   resp.skipped_entries[0].completion_status #=> String, one of "SUCCESS", "ERROR"
+    #   resp.skipped_entries[0].error_info.error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
+    #   resp.skipped_entries[0].error_info.error_timestamp #=> Time
+    #   resp.next_token #=> String
+    #
+    # @overload batch_get_asset_property_aggregates(params = {})
+    # @param [Hash] params ({})
+    def batch_get_asset_property_aggregates(params = {}, options = {})
+      req = build_request(:batch_get_asset_property_aggregates, params)
+      req.send_request(options)
+    end
+
+    # Gets the current value for one or more asset properties. For more
+    # information, see [Querying current values][1] in the *IoT SiteWise
+    # User Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values
+    #
+    # @option params [required, Array<Types::BatchGetAssetPropertyValueEntry>] :entries
+    #   The list of asset property value entries for the batch get request.
+    #   You can specify up to 16 entries per request.
+    #
+    # @option params [String] :next_token
+    #   The token to be used for the next set of paginated results.
+    #
+    # @return [Types::BatchGetAssetPropertyValueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::BatchGetAssetPropertyValueResponse#error_entries #error_entries} => Array&lt;Types::BatchGetAssetPropertyValueErrorEntry&gt;
+    #   * {Types::BatchGetAssetPropertyValueResponse#success_entries #success_entries} => Array&lt;Types::BatchGetAssetPropertyValueSuccessEntry&gt;
+    #   * {Types::BatchGetAssetPropertyValueResponse#skipped_entries #skipped_entries} => Array&lt;Types::BatchGetAssetPropertyValueSkippedEntry&gt;
+    #   * {Types::BatchGetAssetPropertyValueResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.batch_get_asset_property_value({
+    #     entries: [ # required
+    #       {
+    #         entry_id: "EntryId", # required
+    #         asset_id: "ID",
+    #         property_id: "ID",
+    #         property_alias: "AssetPropertyAlias",
+    #       },
+    #     ],
+    #     next_token: "NextToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.error_entries #=> Array
+    #   resp.error_entries[0].error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
+    #   resp.error_entries[0].error_message #=> String
+    #   resp.error_entries[0].entry_id #=> String
+    #   resp.success_entries #=> Array
+    #   resp.success_entries[0].entry_id #=> String
+    #   resp.success_entries[0].asset_property_value.value.string_value #=> String
+    #   resp.success_entries[0].asset_property_value.value.integer_value #=> Integer
+    #   resp.success_entries[0].asset_property_value.value.double_value #=> Float
+    #   resp.success_entries[0].asset_property_value.value.boolean_value #=> Boolean
+    #   resp.success_entries[0].asset_property_value.timestamp.time_in_seconds #=> Integer
+    #   resp.success_entries[0].asset_property_value.timestamp.offset_in_nanos #=> Integer
+    #   resp.success_entries[0].asset_property_value.quality #=> String, one of "GOOD", "BAD", "UNCERTAIN"
+    #   resp.skipped_entries #=> Array
+    #   resp.skipped_entries[0].entry_id #=> String
+    #   resp.skipped_entries[0].completion_status #=> String, one of "SUCCESS", "ERROR"
+    #   resp.skipped_entries[0].error_info.error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
+    #   resp.skipped_entries[0].error_info.error_timestamp #=> Time
+    #   resp.next_token #=> String
+    #
+    # @overload batch_get_asset_property_value(params = {})
+    # @param [Hash] params ({})
+    def batch_get_asset_property_value(params = {}, options = {})
+      req = build_request(:batch_get_asset_property_value, params)
+      req.send_request(options)
+    end
+
+    # Gets the historical values for one or more asset properties. For more
+    # information, see [Querying historical values][1] in the *IoT SiteWise
+    # User Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values
+    #
+    # @option params [required, Array<Types::BatchGetAssetPropertyValueHistoryEntry>] :entries
+    #   The list of asset property historical value entries for the batch get
+    #   request. You can specify up to 16 entries per request.
+    #
+    # @option params [String] :next_token
+    #   The token to be used for the next set of paginated results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return for each paginated request. A
+    #   result set is returned in the two cases, whichever occurs first.
+    #
+    #   * The size of the result set is less than 1 MB.
+    #
+    #   * The number of data points in the result set is less than the value
+    #     of `maxResults`. The maximum value of `maxResults` is 4000.
+    #
+    # @return [Types::BatchGetAssetPropertyValueHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::BatchGetAssetPropertyValueHistoryResponse#error_entries #error_entries} => Array&lt;Types::BatchGetAssetPropertyValueHistoryErrorEntry&gt;
+    #   * {Types::BatchGetAssetPropertyValueHistoryResponse#success_entries #success_entries} => Array&lt;Types::BatchGetAssetPropertyValueHistorySuccessEntry&gt;
+    #   * {Types::BatchGetAssetPropertyValueHistoryResponse#skipped_entries #skipped_entries} => Array&lt;Types::BatchGetAssetPropertyValueHistorySkippedEntry&gt;
+    #   * {Types::BatchGetAssetPropertyValueHistoryResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.batch_get_asset_property_value_history({
+    #     entries: [ # required
+    #       {
+    #         entry_id: "EntryId", # required
+    #         asset_id: "ID",
+    #         property_id: "ID",
+    #         property_alias: "AssetPropertyAlias",
+    #         start_date: Time.now,
+    #         end_date: Time.now,
+    #         qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
+    #         time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
+    #       },
+    #     ],
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.error_entries #=> Array
+    #   resp.error_entries[0].error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
+    #   resp.error_entries[0].error_message #=> String
+    #   resp.error_entries[0].entry_id #=> String
+    #   resp.success_entries #=> Array
+    #   resp.success_entries[0].entry_id #=> String
+    #   resp.success_entries[0].asset_property_value_history #=> Array
+    #   resp.success_entries[0].asset_property_value_history[0].value.string_value #=> String
+    #   resp.success_entries[0].asset_property_value_history[0].value.integer_value #=> Integer
+    #   resp.success_entries[0].asset_property_value_history[0].value.double_value #=> Float
+    #   resp.success_entries[0].asset_property_value_history[0].value.boolean_value #=> Boolean
+    #   resp.success_entries[0].asset_property_value_history[0].timestamp.time_in_seconds #=> Integer
+    #   resp.success_entries[0].asset_property_value_history[0].timestamp.offset_in_nanos #=> Integer
+    #   resp.success_entries[0].asset_property_value_history[0].quality #=> String, one of "GOOD", "BAD", "UNCERTAIN"
+    #   resp.skipped_entries #=> Array
+    #   resp.skipped_entries[0].entry_id #=> String
+    #   resp.skipped_entries[0].completion_status #=> String, one of "SUCCESS", "ERROR"
+    #   resp.skipped_entries[0].error_info.error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
+    #   resp.skipped_entries[0].error_info.error_timestamp #=> Time
+    #   resp.next_token #=> String
+    #
+    # @overload batch_get_asset_property_value_history(params = {})
+    # @param [Hash] params ({})
+    def batch_get_asset_property_value_history(params = {}, options = {})
+      req = build_request(:batch_get_asset_property_value_history, params)
+      req.send_request(options)
+    end
+
     # Sends a list of asset property values to IoT SiteWise. Each value is a
     # timestamp-quality-value (TQV) data point. For more information, see
     # [Ingesting data using the API][1] in the *IoT SiteWise User Guide*.
@@ -723,6 +959,9 @@ module Aws::IoTSiteWise
     #
     #   [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
     #
+    # @option params [String] :asset_description
+    #   A description for the asset.
+    #
     # @return [Types::CreateAssetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateAssetResponse#asset_id #asset_id} => String
@@ -738,6 +977,7 @@ module Aws::IoTSiteWise
     #     tags: {
     #       "TagKey" => "TagValue",
     #     },
+    #     asset_description: "Description",
     #   })
     #
     # @example Response structure
@@ -1686,6 +1926,7 @@ module Aws::IoTSiteWise
     #   * {Types::DescribeAssetResponse#asset_creation_date #asset_creation_date} => Time
     #   * {Types::DescribeAssetResponse#asset_last_update_date #asset_last_update_date} => Time
     #   * {Types::DescribeAssetResponse#asset_status #asset_status} => Types::AssetStatus
+    #   * {Types::DescribeAssetResponse#asset_description #asset_description} => String
     #
     # @example Request syntax with placeholder values
     #
@@ -1732,6 +1973,7 @@ module Aws::IoTSiteWise
     #   resp.asset_status.error.details #=> Array
     #   resp.asset_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
     #   resp.asset_status.error.details[0].message #=> String
+    #   resp.asset_description #=> String
     #
     #
     # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
@@ -3099,6 +3341,7 @@ module Aws::IoTSiteWise
     #   resp.asset_summaries[0].hierarchies #=> Array
     #   resp.asset_summaries[0].hierarchies[0].id #=> String
     #   resp.asset_summaries[0].hierarchies[0].name #=> String
+    #   resp.asset_summaries[0].description #=> String
     #   resp.next_token #=> String
     #
     # @overload list_assets(params = {})
@@ -3190,6 +3433,7 @@ module Aws::IoTSiteWise
     #   resp.asset_summaries[0].hierarchies #=> Array
     #   resp.asset_summaries[0].hierarchies[0].id #=> String
     #   resp.asset_summaries[0].hierarchies[0].name #=> String
+    #   resp.asset_summaries[0].description #=> String
     #   resp.next_token #=> String
     #
     # @overload list_associated_assets(params = {})
@@ -3590,7 +3834,7 @@ module Aws::IoTSiteWise
     #     hot tier. The hot tier is a service-managed database.
     #
     #   * `MULTI_LAYER_STORAGE` – IoT SiteWise saves your data in both the
-    #     cold tier and the cold tier. The cold tier is a customer-managed
+    #     cold tier and the hot tier. The cold tier is a customer-managed
     #     Amazon S3 bucket.
     #
     # @option params [Types::MultiLayerStorage] :multi_layer_storage
@@ -3818,6 +4062,9 @@ module Aws::IoTSiteWise
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.**
     #
+    # @option params [String] :asset_description
+    #   A description for the asset.
+    #
     # @return [Types::UpdateAssetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::UpdateAssetResponse#asset_status #asset_status} => Types::AssetStatus
@@ -3828,6 +4075,7 @@ module Aws::IoTSiteWise
     #     asset_id: "ID", # required
     #     asset_name: "Name", # required
     #     client_token: "ClientToken",
+    #     asset_description: "Description",
     #   })
     #
     # @example Response structure
@@ -4427,7 +4675,7 @@ module Aws::IoTSiteWise
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-iotsitewise'
-      context[:gem_version] = '1.39.0'
+      context[:gem_version] = '1.42.0'
       Seahorse::Client::Request.new(handlers, context)
     end