# AWS IoT SiteWise API

> AWS IoT SiteWise API on Apizie: 73 endpoints (Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's…, Associates a time series (data stream) with an asset property., Associates a group (batch) of assets with an IoT SiteWise Monitor project., Disassociates a group (batch) of assets from an IoT SiteWise Monitor project., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-iotsitewise`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-iotsitewise
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-iotsitewise/openapi.json

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,…

## Endpoints

### Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/associate-assets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetId | string | yes | The ID of the parent asset. |
| body | object | yes | JSON request body |

### Associates a time series (data stream) with an asset property.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/associate-time-series-to-asset-property` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| alias | string | yes | The alias that identifies the time series. |
| assetId | string | yes | The ID of the asset in which the asset property was created. |
| propertyId | string | yes | The ID of the asset property. |
| body | object | yes | JSON request body |

### Associates a group (batch) of assets with an IoT SiteWise Monitor project.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/batch-associate-project-assets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| projectId | string | yes | The ID of the project to which to associate the assets. |
| body | object | yes | JSON request body |

### Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/batch-disassociate-project-assets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| projectId | string | yes | The ID of the project from which to disassociate the assets. |
| body | object | yes | JSON request body |

### Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/batch-get-asset-property-aggregates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Gets the current value for one or more asset properties. For more information, see Querying current values…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/batch-get-asset-property-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Gets the historical values for one or more asset properties. For more information, see Querying historical…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/batch-get-asset-property-value-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/batch-put-asset-property-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/list-access-policies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| identityType | string | no | The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required if you specify… |
| identityId | string | no | The ID of the identity. This parameter is required if you specify USER or GROUP for identityType . |
| resourceType | string | no | The type of resource (portal or project). This parameter is required if you specify resourceId . |
| resourceId | string | no | The ID of the resource. This parameter is required if you specify resourceType . |
| iamArn | string | no | The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide . This parameter is required if you specify IAM for… |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| maxResults | integer | no | The maximum number of results to return for each paginated request. Default: 50 |

### Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/create-access-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves a paginated list of asset summaries. You can use this operation to do the following: List assets…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/list-assets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| maxResults | integer | no | The maximum number of results to return for each paginated request. Default: 50 |
| assetModelId | string | no | The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter . |
| filter | string | no | The filter for the requested list of assets. Choose one of the following options: ALL – The list includes all assets for a given asset… |

### Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/create-asset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves a paginated list of summaries of all asset models.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/list-asset-models` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| maxResults | integer | no | The maximum number of results to return for each paginated request. Default: 50 |

### Creates an asset model from specified property and hierarchy definitions. You create assets from asset…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/create-asset-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/list-bulk-import-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| maxResults | integer | no | The maximum number of results to return for each paginated request. |
| filter | string | no | You can use a filter to select the bulk import jobs that you want to retrieve. |

### Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/create-bulk-import-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Creates a dashboard in an IoT SiteWise Monitor project.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/create-dashboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves a paginated list of gateways.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/list-gateways` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| maxResults | integer | no | The maximum number of results to return for each paginated request. Default: 50 |

### Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/create-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves a paginated list of IoT SiteWise Monitor portals.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/list-portals` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| maxResults | integer | no | The maximum number of results to return for each paginated request. Default: 50 |

### Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/create-portal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Creates a project in the specified portal. Make sure that the project name and description don't contain…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/create-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/describe-access-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| accessPolicyId | string | yes | The ID of the access policy. |

### Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/update-access-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| accessPolicyId | string | yes | The ID of the access policy. |
| body | object | yes | JSON request body |

### Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/delete-access-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| accessPolicyId | string | yes | The ID of the access policy to be deleted. |
| clientToken | string | no | A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new… |

### Retrieves information about an asset.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/describe-asset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetId | string | yes | The ID of the asset. |
| excludeProperties | boolean | no | Whether or not to exclude asset properties from the response. |

### Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide .
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/update-asset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetId | string | yes | The ID of the asset to update. |
| body | object | yes | JSON request body |

### Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/delete-asset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetId | string | yes | The ID of the asset to delete. |
| clientToken | string | no | A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new… |

### Retrieves information about an asset model.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/describe-asset-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetModelId | string | yes | The ID of the asset model. |
| excludeProperties | boolean | no | Whether or not to exclude asset model properties from the response. |

### Updates an asset model and all of the assets that were created from the model. Each asset created from the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/update-asset-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetModelId | string | yes | The ID of the asset model to update. |
| body | object | yes | JSON request body |

### Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/delete-asset-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetModelId | string | yes | The ID of the asset model to delete. |
| clientToken | string | no | A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new… |

### Retrieves information about a dashboard.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/describe-dashboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| dashboardId | string | yes | The ID of the dashboard. |

### Updates an IoT SiteWise Monitor dashboard.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/update-dashboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| dashboardId | string | yes | The ID of the dashboard to update. |
| body | object | yes | JSON request body |

### Deletes a dashboard from IoT SiteWise Monitor.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/delete-dashboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| dashboardId | string | yes | The ID of the dashboard to delete. |
| clientToken | string | no | A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new… |

### Retrieves information about a gateway.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/describe-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| gatewayId | string | yes | The ID of the gateway device. |

### Updates a gateway's name.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/update-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| gatewayId | string | yes | The ID of the gateway to update. |
| body | object | yes | JSON request body |

### Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/delete-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| gatewayId | string | yes | The ID of the gateway to delete. |

### Retrieves information about a portal.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/describe-portal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| portalId | string | yes | The ID of the portal. |

### Updates an IoT SiteWise Monitor portal.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/update-portal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| portalId | string | yes | The ID of the portal to update. |
| body | object | yes | JSON request body |

### Deletes a portal from IoT SiteWise Monitor.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/delete-portal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| portalId | string | yes | The ID of the portal to delete. |
| clientToken | string | no | A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new… |

### Retrieves information about a project.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/describe-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| projectId | string | yes | The ID of the project. |

### Updates an IoT SiteWise Monitor project.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/update-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| projectId | string | yes | The ID of the project to update. |
| body | object | yes | JSON request body |

### Deletes a project from IoT SiteWise Monitor.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/delete-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| projectId | string | yes | The ID of the project. |
| clientToken | string | no | A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new… |

### Deletes a time series (data stream). If you delete a time series that's associated with an asset property,…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/delete-time-series` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| alias | string | no | The alias that identifies the time series. |
| assetId | string | no | The ID of the asset in which the asset property was created. |
| propertyId | string | no | The ID of the asset property. |
| body | object | yes | JSON request body |

### Retrieves information about an asset property. When you call this operation for an attribute property, this…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/describe-asset-property` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetId | string | yes | The ID of the asset. |
| propertyId | string | yes | The ID of the asset property. |

### Updates an asset property's alias and notification state. This operation overwrites the property's existing…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/update-asset-property` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetId | string | yes | The ID of the asset to be updated. |
| propertyId | string | yes | The ID of the asset property to be updated. |
| body | object | yes | JSON request body |

### Retrieves information about a bulk import job request. For more information, see Describe a bulk import job…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/describe-bulk-import-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| jobId | string | yes | The ID of the job. |

### Retrieves information about the default encryption configuration for the Amazon Web Services account in the…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/describe-default-encryption-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |

### Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/put-default-encryption-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves information about a gateway capability configuration. Each gateway capability defines data sources…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/describe-gateway-capability-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| gatewayId | string | yes | The ID of the gateway that defines the capability configuration. |
| capabilityNamespace | string | yes | The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA… |

### Retrieves the current IoT SiteWise logging options.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/describe-logging-options` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |

### Sets logging options for IoT SiteWise.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/put-logging-options` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves information about the storage configuration for IoT SiteWise.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/describe-storage-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |

### Configures storage settings for IoT SiteWise.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/put-storage-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves information about a time series (data stream). To identify a time series, do one of the following:…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/describe-time-series` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| alias | string | no | The alias that identifies the time series. |
| assetId | string | no | The ID of the asset in which the asset property was created. |
| propertyId | string | no | The ID of the asset property. |

### Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/disassociate-assets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetId | string | yes | The ID of the parent asset from which to disassociate the child asset. |
| body | object | yes | JSON request body |

### Disassociates a time series (data stream) from an asset property.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/disassociate-time-series-from-asset-property` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| alias | string | yes | The alias that identifies the time series. |
| assetId | string | yes | The ID of the asset in which the asset property was created. |
| propertyId | string | yes | The ID of the asset property. |
| body | object | yes | JSON request body |

### Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/get-asset-property-aggregates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetId | string | no | The ID of the asset. |
| propertyId | string | no | The ID of the asset property. |
| propertyAlias | string | no | The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature… |
| aggregateTypes | array | yes | The data aggregating function. |
| resolution | string | yes | The time interval over which to aggregate data. |
| qualities | array | no | The quality by which to filter asset data. |
| startDate | string | yes | The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time. |
| endDate | string | yes | The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time. |
| timeOrdering | string | no | The chronological sorting order of the requested information. Default: ASCENDING |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| maxResults | integer | no | The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first. The… |

### Gets an asset property's current value. For more information, see Querying current values in the IoT…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/get-asset-property-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetId | string | no | The ID of the asset. |
| propertyId | string | no | The ID of the asset property. |
| propertyAlias | string | no | The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature… |

### Gets the history of an asset property's values. For more information, see Querying historical values in the…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/get-asset-property-value-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetId | string | no | The ID of the asset. |
| propertyId | string | no | The ID of the asset property. |
| propertyAlias | string | no | The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature… |
| startDate | string | no | The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time. |
| endDate | string | no | The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time. |
| qualities | array | no | The quality by which to filter asset data. |
| timeOrdering | string | no | The chronological sorting order of the requested information. Default: ASCENDING |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| maxResults | integer | no | The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first. The… |

### Get interpolated values for an asset property for a specified time interval, during a period of time. If…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/get-interpolated-asset-property-values` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetId | string | no | The ID of the asset. |
| propertyId | string | no | The ID of the asset property. |
| propertyAlias | string | no | The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature… |
| startTimeInSeconds | integer | yes | The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time. |
| startTimeOffsetInNanos | integer | no | The nanosecond offset converted from startTimeInSeconds . |
| endTimeInSeconds | integer | yes | The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time. |
| endTimeOffsetInNanos | integer | no | The nanosecond offset converted from endTimeInSeconds . |
| quality | string | yes | 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… |
| intervalInSeconds | integer | yes | The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends. |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| maxResults | integer | no | The maximum number of results to return for each paginated request. If not specified, the default value is 10. |
| type | string | yes | The interpolation type. Valid values: LINEAR_INTERPOLATION / LOCF_INTERPOLATION LINEAR_INTERPOLATION – Estimates missing data using linear… |
| intervalWindowInSeconds | integer | no | The query interval for the window, in seconds. IoT SiteWise computes each interpolated value by using data points from the timestamp of… |

### Retrieves a paginated list of properties associated with an asset model. If you update properties associated…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/list-asset-model-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetModelId | string | yes | The ID of the asset model. |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| maxResults | integer | no | The maximum number of results to return for each paginated request. If not specified, the default value is 50. |
| filter | string | no | Filters the requested list of asset model properties. You can choose one of the following options: ALL – The list includes all asset model… |

### Retrieves a paginated list of properties associated with an asset. If you update properties associated with…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/list-asset-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetId | string | yes | The ID of the asset. |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| maxResults | integer | no | The maximum number of results to return for each paginated request. If not specified, the default value is 50. |
| filter | string | no | Filters the requested list of asset properties. You can choose one of the following options: ALL – The list includes all asset properties… |

### Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/list-asset-relationships` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetId | string | yes | The ID of the asset. |
| traversalType | string | yes | The type of traversal to use to identify asset relationships. Choose the following option: PATH_TO_ROOT – Identify the asset's parent… |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| maxResults | integer | no | The maximum number of results to return for each paginated request. |

### Retrieves a paginated list of associated assets. You can use this operation to do the following: List child…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/list-associated-assets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| assetId | string | yes | The ID of the asset to query. |
| hierarchyId | string | no | The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or… |
| traversalDirection | string | no | The direction to list associated assets. Choose one of the following options: CHILD – The list includes all child assets associated to the… |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| maxResults | integer | no | The maximum number of results to return for each paginated request. Default: 50 |

### Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/list-dashboards` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| projectId | string | yes | The ID of the project. |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| maxResults | integer | no | The maximum number of results to return for each paginated request. Default: 50 |

### Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/list-project-assets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| projectId | string | yes | The ID of the project. |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| maxResults | integer | no | The maximum number of results to return for each paginated request. Default: 50 |

### Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/list-projects` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| portalId | string | yes | The ID of the portal. |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| maxResults | integer | no | The maximum number of results to return for each paginated request. Default: 50 |

### Retrieves the list of tags for an IoT SiteWise resource.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The ARN of the resource. |

### Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The ARN of the resource to tag. |
| body | object | yes | JSON request body |

### Retrieves a paginated list of time series (data streams).
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/list-time-series` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | The token to be used for the next set of paginated results. |
| maxResults | integer | no | The maximum number of results to return for each paginated request. |
| assetId | string | no | The ID of the asset in which the asset property was created. |
| aliasPrefix | string | no | The alias prefix of the time series. |
| timeSeriesType | string | no | The type of the time series. The time series type can be one of the following values: ASSOCIATED – The time series is associated with an… |

### Removes a tag from an IoT SiteWise resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The ARN of the resource to untag. |
| tagKeys | array | yes | A list of keys for tags to remove from the resource. |

### Updates a gateway capability configuration or defines a new capability configuration. Each gateway…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/update-gateway-capability-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| gatewayId | string | yes | The ID of the gateway to be updated. |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/associate-assets" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the AWS IoT SiteWise API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:amazonaws-iotsitewise/associate-assets with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the AWS IoT SiteWise API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. AWS IoT SiteWise itself also needs your own key from amazonaws.com.

### Can AI agents use the AWS IoT SiteWise API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-iotsitewise.

### What is the status of the AWS IoT SiteWise API?
Needs your own provider key (bring your own key)