Amazon Web Services Properties API

openapi: 3.2.0
info:
  title: Amazon Web Services iotsitewise Properties API
  description: Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things (IIoT) devices to the power of the Amazon Web Services Cloud. For more information, see the IoT SiteWise User Guide. For information about IoT SiteWise quotas, see Quotas in the IoT SiteWise User Guide.
tags:
- name: Properties
paths:
  /properties/batch/aggregates:
    POST:
      summary: Amazon Web Services Batchgetassetpropertyaggregates
      description: Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see Querying aggregates in the IoT SiteWise User Guide.
      operationId: amazonWebServicesBatchGetAssetPropertyAggregates
      tags:
      - Properties
  /properties/batch/latest:
    POST:
      summary: Amazon Web Services Batchgetassetpropertyvalue
      description: Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.
      operationId: amazonWebServicesBatchGetAssetPropertyValue
      tags:
      - Properties
  /properties/batch/history:
    POST:
      summary: Amazon Web Services Batchgetassetpropertyvaluehistory
      description: Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.
      operationId: amazonWebServicesBatchGetAssetPropertyValueHistory
      tags:
      - Properties
  /properties:
    POST:
      summary: Amazon Web Services Batchputassetpropertyvalue
      description: '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 in the IoT SiteWise User Guide. 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. With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error. For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV. IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide.'
      operationId: amazonWebServicesBatchPutAssetPropertyValue
      tags:
      - Properties
  /properties/aggregates:
    GET:
      summary: Amazon Web Services Getassetpropertyaggregates
      description: 'Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide. 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.'
      operationId: amazonWebServicesGetAssetPropertyAggregates
      tags:
      - Properties
  /properties/latest:
    GET:
      summary: Amazon Web Services Getassetpropertyvalue
      description: 'Gets an asset property''s current value. For more information, see Querying current values in the IoT SiteWise User Guide. 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.'
      operationId: amazonWebServicesGetAssetPropertyValue
      tags:
      - Properties
  /properties/history:
    GET:
      summary: Amazon Web Services Getassetpropertyvaluehistory
      description: 'Gets the history of an asset property''s values. For more information, see Querying historical values in the IoT SiteWise User Guide. 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.'
      operationId: amazonWebServicesGetAssetPropertyValueHistory
      tags:
      - Properties
  /properties/interpolated:
    GET:
      summary: Amazon Web Services Getinterpolatedassetpropertyvalues
      description: 'Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data. For example, you can use 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.'
      operationId: amazonWebServicesGetInterpolatedAssetPropertyValues
      tags:
      - Properties