aws-sdk-iotsitewise 1.20.0 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13009361c45d7e330614a973b39a0383f9ad019668865a0fef6724281e954ef4
-  data.tar.gz: 1b616702b3cddd23488527717567f618e650a5d369237be493a75ef46525227d
+  metadata.gz: 7c789475f03b89d05d057235f39f636a2d8c27a90e6b738487cc818a1f00afa9
+  data.tar.gz: b4fa70938975588276e959ed51a34ea23dd60e60cf9231b94b09412976a0c3dc
 SHA512:
-  metadata.gz: 0ed37dd23f87c55a9b9860d0305dec40fa296ae4802a3e7f745c87de14096f3978e052abd646ace207b6c8912935bb21103971b7c6f4b4ec5d21affdb1aef15c
-  data.tar.gz: 392780877cf6b4158466571310c6034c2d13e08e136a1446ab45b8e0c5810b1bcd824b8cfb9ce2c0f78debc5f4e166e44d757a49df749c76312e1b2fb063f245
+  metadata.gz: 8c54299f95b473647d1a71e79294147053c33eb20beebc1170daac936c79a4c1378b83a7910368a542806084840ba260909e485c19286e41a00dc6bd15876a7d
+  data.tar.gz: 8137218471e20566afeea65fd599988eef7028a0316f7cd18c74629158927d78f5c2026f08cf456776ac5ad8e679f8193066eb9c9dc3d012c9f931b3b02dc567

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.21.0 (2021-04-28)
+------------------
+
+* Feature - AWS IoT SiteWise interpolation API will get interpolated values for an asset property per specified time interval during a period of time.
+
 1.20.0 (2021-03-10)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.20.0
+1.21.0

data/lib/aws-sdk-iotsitewise.rb

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

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

@@ -2325,6 +2325,117 @@ module Aws::IoTSiteWise
       req.send_request(options)
     end
 
+    # Get interpolated values for an asset property for a specified time
+    # interval, during a period of time. For example, you can use the this
+    # operation to return the interpolated temperature values for a wind
+    # turbine every 24 hours over a duration of 7 days.
+    #
+    # To identify an asset property, you must specify one of the following:
+    #
+    # * The `assetId` and `propertyId` of an asset property.
+    #
+    # * A `propertyAlias`, which is a data stream alias (for example,
+    #   `/company/windfarm/3/turbine/7/temperature`). To define an asset
+    #   property's alias, see [UpdateAssetProperty][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
+    #
+    # @option params [String] :asset_id
+    #   The ID of the asset.
+    #
+    # @option params [String] :property_id
+    #   The ID of the asset property.
+    #
+    # @option params [String] :property_alias
+    #   The property alias that identifies the property, such as an OPC-UA
+    #   server data stream path (for example,
+    #   `/company/windfarm/3/turbine/7/temperature`). For more information,
+    #   see [Mapping industrial data streams to asset properties][1] in the
+    #   *AWS IoT SiteWise User Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
+    #
+    # @option params [required, Integer] :start_time_in_seconds
+    #   The exclusive start of the range from which to interpolate data,
+    #   expressed in seconds in Unix epoch time.
+    #
+    # @option params [Integer] :start_time_offset_in_nanos
+    #   The nanosecond offset converted from `startTimeInSeconds`.
+    #
+    # @option params [required, Integer] :end_time_in_seconds
+    #   The inclusive end of the range from which to interpolate data,
+    #   expressed in seconds in Unix epoch time.
+    #
+    # @option params [Integer] :end_time_offset_in_nanos
+    #   The nanosecond offset converted from `endTimeInSeconds`.
+    #
+    # @option params [required, String] :quality
+    #   The quality of the asset property value. You can use this parameter as
+    #   a filter to choose only the asset property values that have a specific
+    #   quality.
+    #
+    # @option params [required, Integer] :interval_in_seconds
+    #   The time interval in seconds over which to interpolate data. Each
+    #   interval starts when the previous one ends.
+    #
+    # @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 be returned per paginated request. If
+    #   not specified, the default value is 10.
+    #
+    # @option params [required, String] :type
+    #   The interpolation type.
+    #
+    #   Valid values: `LINEAR_INTERPOLATION`
+    #
+    # @return [Types::GetInterpolatedAssetPropertyValuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetInterpolatedAssetPropertyValuesResponse#interpolated_asset_property_values #interpolated_asset_property_values} => Array<Types::InterpolatedAssetPropertyValue>
+    #   * {Types::GetInterpolatedAssetPropertyValuesResponse#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.get_interpolated_asset_property_values({
+    #     asset_id: "ID",
+    #     property_id: "ID",
+    #     property_alias: "AssetPropertyAlias",
+    #     start_time_in_seconds: 1, # required
+    #     start_time_offset_in_nanos: 1,
+    #     end_time_in_seconds: 1, # required
+    #     end_time_offset_in_nanos: 1,
+    #     quality: "GOOD", # required, accepts GOOD, BAD, UNCERTAIN
+    #     interval_in_seconds: 1, # required
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #     type: "InterpolationType", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.interpolated_asset_property_values #=> Array
+    #   resp.interpolated_asset_property_values[0].timestamp.time_in_seconds #=> Integer
+    #   resp.interpolated_asset_property_values[0].timestamp.offset_in_nanos #=> Integer
+    #   resp.interpolated_asset_property_values[0].value.string_value #=> String
+    #   resp.interpolated_asset_property_values[0].value.integer_value #=> Integer
+    #   resp.interpolated_asset_property_values[0].value.double_value #=> Float
+    #   resp.interpolated_asset_property_values[0].value.boolean_value #=> Boolean
+    #   resp.next_token #=> String
+    #
+    # @overload get_interpolated_asset_property_values(params = {})
+    # @param [Hash] params ({})
+    def get_interpolated_asset_property_values(params = {}, options = {})
+      req = build_request(:get_interpolated_asset_property_values, params)
+      req.send_request(options)
+    end
+
     # Retrieves a paginated list of access policies for an identity (an AWS
     # SSO user, an AWS SSO group, or an IAM user) or an AWS IoT SiteWise
     # Monitor resource (a portal or project).
@@ -3697,7 +3808,7 @@ module Aws::IoTSiteWise
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-iotsitewise'
-      context[:gem_version] = '1.20.0'
+      context[:gem_version] = '1.21.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -164,6 +164,8 @@ module Aws::IoTSiteWise
     GetAssetPropertyValueHistoryResponse = Shapes::StructureShape.new(name: 'GetAssetPropertyValueHistoryResponse')
     GetAssetPropertyValueRequest = Shapes::StructureShape.new(name: 'GetAssetPropertyValueRequest')
     GetAssetPropertyValueResponse = Shapes::StructureShape.new(name: 'GetAssetPropertyValueResponse')
+    GetInterpolatedAssetPropertyValuesRequest = Shapes::StructureShape.new(name: 'GetInterpolatedAssetPropertyValuesRequest')
+    GetInterpolatedAssetPropertyValuesResponse = Shapes::StructureShape.new(name: 'GetInterpolatedAssetPropertyValuesResponse')
     Greengrass = Shapes::StructureShape.new(name: 'Greengrass')
     GroupIdentity = Shapes::StructureShape.new(name: 'GroupIdentity')
     IAMRoleIdentity = Shapes::StructureShape.new(name: 'IAMRoleIdentity')
@@ -179,7 +181,11 @@ module Aws::IoTSiteWise
     ImageFileType = Shapes::StringShape.new(name: 'ImageFileType')
     ImageLocation = Shapes::StructureShape.new(name: 'ImageLocation')
     InternalFailureException = Shapes::StructureShape.new(name: 'InternalFailureException')
+    InterpolatedAssetPropertyValue = Shapes::StructureShape.new(name: 'InterpolatedAssetPropertyValue')
+    InterpolatedAssetPropertyValues = Shapes::ListShape.new(name: 'InterpolatedAssetPropertyValues')
+    InterpolationType = Shapes::StringShape.new(name: 'InterpolationType')
     Interval = Shapes::StringShape.new(name: 'Interval')
+    IntervalInSeconds = Shapes::IntegerShape.new(name: 'IntervalInSeconds')
     InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
     KmsKeyId = Shapes::StringShape.new(name: 'KmsKeyId')
     LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
@@ -209,6 +215,7 @@ module Aws::IoTSiteWise
     LoggingLevel = Shapes::StringShape.new(name: 'LoggingLevel')
     LoggingOptions = Shapes::StructureShape.new(name: 'LoggingOptions')
     Macro = Shapes::StringShape.new(name: 'Macro')
+    MaxInterpolatedResults = Shapes::IntegerShape.new(name: 'MaxInterpolatedResults')
     MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
     Measurement = Shapes::StructureShape.new(name: 'Measurement')
     Metric = Shapes::StructureShape.new(name: 'Metric')
@@ -875,6 +882,24 @@ module Aws::IoTSiteWise
     GetAssetPropertyValueResponse.add_member(:property_value, Shapes::ShapeRef.new(shape: AssetPropertyValue, location_name: "propertyValue"))
     GetAssetPropertyValueResponse.struct_class = Types::GetAssetPropertyValueResponse
 
+    GetInterpolatedAssetPropertyValuesRequest.add_member(:asset_id, Shapes::ShapeRef.new(shape: ID, location: "querystring", location_name: "assetId"))
+    GetInterpolatedAssetPropertyValuesRequest.add_member(:property_id, Shapes::ShapeRef.new(shape: ID, location: "querystring", location_name: "propertyId"))
+    GetInterpolatedAssetPropertyValuesRequest.add_member(:property_alias, Shapes::ShapeRef.new(shape: AssetPropertyAlias, location: "querystring", location_name: "propertyAlias"))
+    GetInterpolatedAssetPropertyValuesRequest.add_member(:start_time_in_seconds, Shapes::ShapeRef.new(shape: TimeInSeconds, required: true, location: "querystring", location_name: "startTimeInSeconds"))
+    GetInterpolatedAssetPropertyValuesRequest.add_member(:start_time_offset_in_nanos, Shapes::ShapeRef.new(shape: OffsetInNanos, location: "querystring", location_name: "startTimeOffsetInNanos"))
+    GetInterpolatedAssetPropertyValuesRequest.add_member(:end_time_in_seconds, Shapes::ShapeRef.new(shape: TimeInSeconds, required: true, location: "querystring", location_name: "endTimeInSeconds"))
+    GetInterpolatedAssetPropertyValuesRequest.add_member(:end_time_offset_in_nanos, Shapes::ShapeRef.new(shape: OffsetInNanos, location: "querystring", location_name: "endTimeOffsetInNanos"))
+    GetInterpolatedAssetPropertyValuesRequest.add_member(:quality, Shapes::ShapeRef.new(shape: Quality, required: true, location: "querystring", location_name: "quality"))
+    GetInterpolatedAssetPropertyValuesRequest.add_member(:interval_in_seconds, Shapes::ShapeRef.new(shape: IntervalInSeconds, required: true, location: "querystring", location_name: "intervalInSeconds"))
+    GetInterpolatedAssetPropertyValuesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
+    GetInterpolatedAssetPropertyValuesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxInterpolatedResults, location: "querystring", location_name: "maxResults"))
+    GetInterpolatedAssetPropertyValuesRequest.add_member(:type, Shapes::ShapeRef.new(shape: InterpolationType, required: true, location: "querystring", location_name: "type"))
+    GetInterpolatedAssetPropertyValuesRequest.struct_class = Types::GetInterpolatedAssetPropertyValuesRequest
+
+    GetInterpolatedAssetPropertyValuesResponse.add_member(:interpolated_asset_property_values, Shapes::ShapeRef.new(shape: InterpolatedAssetPropertyValues, required: true, location_name: "interpolatedAssetPropertyValues"))
+    GetInterpolatedAssetPropertyValuesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
+    GetInterpolatedAssetPropertyValuesResponse.struct_class = Types::GetInterpolatedAssetPropertyValuesResponse
+
     Greengrass.add_member(:group_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "groupArn"))
     Greengrass.struct_class = Types::Greengrass
 
@@ -910,6 +935,12 @@ module Aws::IoTSiteWise
     InternalFailureException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "message"))
     InternalFailureException.struct_class = Types::InternalFailureException
 
+    InterpolatedAssetPropertyValue.add_member(:timestamp, Shapes::ShapeRef.new(shape: TimeInNanos, required: true, location_name: "timestamp"))
+    InterpolatedAssetPropertyValue.add_member(:value, Shapes::ShapeRef.new(shape: Variant, required: true, location_name: "value"))
+    InterpolatedAssetPropertyValue.struct_class = Types::InterpolatedAssetPropertyValue
+
+    InterpolatedAssetPropertyValues.member = Shapes::ShapeRef.new(shape: InterpolatedAssetPropertyValue)
+
     InvalidRequestException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "message"))
     InvalidRequestException.struct_class = Types::InvalidRequestException
 
@@ -1800,6 +1831,28 @@ module Aws::IoTSiteWise
         )
       end)
 
+      api.add_operation(:get_interpolated_asset_property_values, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetInterpolatedAssetPropertyValues"
+        o.http_method = "GET"
+        o.http_request_uri = "/properties/interpolated"
+        o.endpoint_pattern = {
+          "hostPrefix" => "data.",
+        }
+        o.input = Shapes::ShapeRef.new(shape: GetInterpolatedAssetPropertyValuesRequest)
+        o.output = Shapes::ShapeRef.new(shape: GetInterpolatedAssetPropertyValuesResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:list_access_policies, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListAccessPolicies"
         o.http_method = "GET"

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

@@ -3448,6 +3448,121 @@ module Aws::IoTSiteWise
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass GetInterpolatedAssetPropertyValuesRequest
+    #   data as a hash:
+    #
+    #       {
+    #         asset_id: "ID",
+    #         property_id: "ID",
+    #         property_alias: "AssetPropertyAlias",
+    #         start_time_in_seconds: 1, # required
+    #         start_time_offset_in_nanos: 1,
+    #         end_time_in_seconds: 1, # required
+    #         end_time_offset_in_nanos: 1,
+    #         quality: "GOOD", # required, accepts GOOD, BAD, UNCERTAIN
+    #         interval_in_seconds: 1, # required
+    #         next_token: "NextToken",
+    #         max_results: 1,
+    #         type: "InterpolationType", # required
+    #       }
+    #
+    # @!attribute [rw] asset_id
+    #   The ID of the asset.
+    #   @return [String]
+    #
+    # @!attribute [rw] property_id
+    #   The ID of the asset property.
+    #   @return [String]
+    #
+    # @!attribute [rw] property_alias
+    #   The property alias that identifies the property, such as an OPC-UA
+    #   server data stream path (for example,
+    #   `/company/windfarm/3/turbine/7/temperature`). For more information,
+    #   see [Mapping industrial data streams to asset properties][1] in the
+    #   *AWS IoT SiteWise User Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
+    #   @return [String]
+    #
+    # @!attribute [rw] start_time_in_seconds
+    #   The exclusive start of the range from which to interpolate data,
+    #   expressed in seconds in Unix epoch time.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] start_time_offset_in_nanos
+    #   The nanosecond offset converted from `startTimeInSeconds`.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] end_time_in_seconds
+    #   The inclusive end of the range from which to interpolate data,
+    #   expressed in seconds in Unix epoch time.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] end_time_offset_in_nanos
+    #   The nanosecond offset converted from `endTimeInSeconds`.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] quality
+    #   The quality of the asset property value. You can use this parameter
+    #   as a filter to choose only the asset property values that have a
+    #   specific quality.
+    #   @return [String]
+    #
+    # @!attribute [rw] interval_in_seconds
+    #   The time interval in seconds over which to interpolate data. Each
+    #   interval starts when the previous one ends.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   The token to be used for the next set of paginated results.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to be returned per paginated request.
+    #   If not specified, the default value is 10.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] type
+    #   The interpolation type.
+    #
+    #   Valid values: `LINEAR_INTERPOLATION`
+    #   @return [String]
+    #
+    class GetInterpolatedAssetPropertyValuesRequest < Struct.new(
+      :asset_id,
+      :property_id,
+      :property_alias,
+      :start_time_in_seconds,
+      :start_time_offset_in_nanos,
+      :end_time_in_seconds,
+      :end_time_offset_in_nanos,
+      :quality,
+      :interval_in_seconds,
+      :next_token,
+      :max_results,
+      :type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] interpolated_asset_property_values
+    #   The requested interpolated values.
+    #   @return [Array<Types::InterpolatedAssetPropertyValue>]
+    #
+    # @!attribute [rw] next_token
+    #   The token for the next set of results, or null if there are no
+    #   additional results.
+    #   @return [String]
+    #
+    class GetInterpolatedAssetPropertyValuesResponse < Struct.new(
+      :interpolated_asset_property_values,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains details for a gateway that runs on AWS IoT Greengrass. To
     # create a gateway that runs on AWS IoT Greengrass, you must add the IoT
     # SiteWise connector to a Greengrass group and deploy it. Your
@@ -3524,7 +3639,7 @@ module Aws::IoTSiteWise
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.htmll#identifiers-arns
+    #   [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html
     #   @return [String]
     #
     class IAMRoleIdentity < Struct.new(
@@ -3711,6 +3826,23 @@ module Aws::IoTSiteWise
       include Aws::Structure
     end
 
+    # Contains information about an interpolated asset property value.
+    #
+    # @!attribute [rw] timestamp
+    #   Contains a timestamp with optional nanosecond granularity.
+    #   @return [Types::TimeInNanos]
+    #
+    # @!attribute [rw] value
+    #   Contains an asset property value (of a single type only).
+    #   @return [Types::Variant]
+    #
+    class InterpolatedAssetPropertyValue < Struct.new(
+      :timestamp,
+      :value)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The request isn't valid. This can occur if your request contains
     # malformed JSON or unsupported characters. Check your request and try
     # again.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-iotsitewise
 version: !ruby/object:Gem::Version
-  version: 1.20.0
+  version: 1.21.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -67,8 +67,8 @@ homepage: https://github.com/aws/aws-sdk-ruby
 licenses:
 - Apache-2.0
 metadata:
-  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-iotsitewise
-  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-iotsitewise/CHANGELOG.md
+  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-iotsitewise
+  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-iotsitewise/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -84,8 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - AWS IoT SiteWise