aws-iot-sitewise — quality + safety report

---
name: aws-iot-sitewise
description: "AWS IoT SiteWise API skill. Use when working with AWS IoT SiteWise for assets, timeseries, projects. Covers 84 endpoints."
version: 1.0.0
generator: lapsh
---

# AWS IoT SiteWise
API version: 2019-12-02

## Auth
AWS SigV4

## Base URL
Not specified.

## Setup
1. Configure auth: AWS SigV4
2. GET /configuration/account/encryption -- verify access
3. POST /assets/{assetId}/associate -- create first associate

## Endpoints

84 endpoints across 15 groups. See references/api-spec.lap for full details.

### assets
| Method | Path | Description |
|--------|------|-------------|
| POST | /assets/{assetId}/associate | Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide. |
| POST | /assets | Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide. |
| DELETE | /assets/{assetId} | Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide.  You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets. |
| GET | /assets/{assetId} | Retrieves information about an asset. |
| GET | /assets/{assetId}/composite-models/{assetCompositeModelId} | Retrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel. |
| GET | /assets/{assetId}/properties/{propertyId} | Retrieves information about an asset property.  When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.  This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue. |
| POST | /assets/{assetId}/disassociate | Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model. |
| GET | /assets/{assetId}/properties | Retrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again. |
| GET | /assets/{assetId}/assetRelationships | Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root. |
| GET | /assets | Retrieves a paginated list of asset summaries. You can use this operation to do the following:   List assets based on a specific asset model.   List top-level assets.   You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model. |
| GET | /assets/{assetId}/hierarchies | Retrieves a paginated list of associated assets. You can use this operation to do the following:    CHILD - List all child assets associated to the asset.    PARENT - List the asset's parent asset. |
| PUT | /assets/{assetId} | Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide. |
| PUT | /assets/{assetId}/properties/{propertyId} | Updates an asset property's alias and notification state.  This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty. |

### timeseries
| Method | Path | Description |
|--------|------|-------------|
| POST | /timeseries/associate/ | Associates a time series (data stream) with an asset property. |
| POST | /timeseries/delete/ | Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property. To identify a time series, do one of the following:   If the time series isn't associated with an asset property, specify the alias of the time series.   If the time series is associated with an asset property, specify one of the following:    The alias of the time series.   The assetId and propertyId that identifies the asset property. |
| GET | /timeseries/describe/ | Retrieves information about a time series (data stream). To identify a time series, do one of the following:   If the time series isn't associated with an asset property, specify the alias of the time series.   If the time series is associated with an asset property, specify one of the following:    The alias of the time series.   The assetId and propertyId that identifies the asset property. |
| POST | /timeseries/disassociate/ | Disassociates a time series (data stream) from an asset property. |
| GET | /timeseries/ | Retrieves a paginated list of time series (data streams). |

### projects
| Method | Path | Description |
|--------|------|-------------|
| POST | /projects/{projectId}/assets/associate | Associates a group (batch) of assets with an IoT SiteWise Monitor project. |
| POST | /projects/{projectId}/assets/disassociate | Disassociates a group (batch) of assets from an IoT SiteWise Monitor project. |
| POST | /projects | Creates a project in the specified portal.  Make sure that the project name and description don't contain confidential information. |
| DELETE | /projects/{projectId} | Deletes a project from IoT SiteWise Monitor. |
| GET | /projects/{projectId} | Retrieves information about a project. |
| GET | /projects/{projectId}/assets | Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project. |
| GET | /projects | Retrieves a paginated list of projects for an IoT SiteWise Monitor portal. |
| PUT | /projects/{projectId} | Updates an IoT SiteWise Monitor project. |

### properties
| Method | Path | Description |
|--------|------|-------------|
| POST | /properties/batch/aggregates | 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. |
| POST | /properties/batch/latest | Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide. |
| POST | /properties/batch/history | Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide. |
| POST | /properties | 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. |
| GET | /properties/aggregates | 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. |
| GET | /properties/latest | 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. |
| GET | /properties/history | 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. |
| GET | /properties/interpolated | 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. |

### access-policies
| Method | Path | Description |
|--------|------|-------------|
| POST | /access-policies | Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource. |
| DELETE | /access-policies/{accessPolicyId} | Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor resource. |
| GET | /access-policies/{accessPolicyId} | Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project. |
| GET | /access-policies | Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project). |
| PUT | /access-policies/{accessPolicyId} | Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource. |

### asset-models
| Method | Path | Description |
|--------|------|-------------|
| POST | /asset-models | Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide. You can create two types of asset models, ASSET_MODEL or COMPONENT_MODEL.    ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a comp

… (truncated)