Amazon Web Services, Inc.

AWS IoT SiteWise

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…

IoT & devices#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 .

Endpoints 149

  • POSTAssociate assets/assets/:assetId/associateAssociates 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…
  • POSTAssociate time series to asset property/timeseries/associate?alias=string&assetId=string&propertyId=stringAssociates a time series (data stream) with an asset property.
  • POSTBatch associate data segments to dataset/datasets/:datasetId/data-segments/associateAssociates a batch of data segments with a curated dataset. Data segments are time-bounded slices of time series data selected from source session datasets.…
  • POSTBatch associate project assets/projects/:projectId/assets/associateThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature,…
  • POSTBatch delete dataset data segments/datasets/:datasetId/data-segments/batch-deleteDeletes a batch of data segments from a session dataset. Deleting a data segment deletes the underlying time series data for the segment's time range.
  • POSTBatch disassociate data segments from dataset/datasets/:datasetId/data-segments/disassociateDisassociates a batch of data segments from a curated dataset. Disassociating a data segment doesn't delete the underlying data in the source session dataset.
  • POSTBatch disassociate project assets/projects/:projectId/assets/disassociateDisassociates a group (batch) of assets from an IoT SiteWise Monitor project.
  • POSTBatch get asset property aggregates/properties/batch/aggregatesGets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see Querying aggregates in the IoT…
  • POSTBatch get asset property value/properties/batch/latestGets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide .
  • POSTBatch get asset property value history/properties/batch/historyGets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide .
  • POSTBatch put asset property value/propertiesSends 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…
  • POSTCancel enrichment job/workspaces/:workspaceName/enrichment-jobs/:jobId/cancelCancels a running or pending enrichment job. This is an idempotent operation—calling it multiple times with the same jobId is safe and returns the current…
  • POSTCancel pipeline execution/workspaces/:workspaceName/pipelines/:pipelineName/executions/:pipelineExecutionId/cancelCancels a pipeline execution in the specified workspace. If the execution is not in a terminal state (such as NOT_STARTED or RUNNING), it transitions to…
  • POSTCancel query/workspaces/:workspaceName/queries/:queryId/cancelCancels a running query.
  • GETList access policies/access-policies?identityType=string&identityId=string&resourceType=string&resourceId=string&iamArn=string&nextToken=string&maxResults=0Retrieves 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…
  • POSTCreate access policy/access-policiesThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature,…
  • GETList applications/applications?maxResults=0&nextToken=stringRetrieves a paginated list of existing applications
  • POSTCreate application/applicationsCreates a new application for the workspace and IdC application provided
  • GETList assets/assets?nextToken=string&maxResults=0&assetModelId=string&filter=stringRetrieves 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…
  • POSTCreate asset/assetsCreates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide .
  • GETList asset models/asset-models?assetModelTypes=&nextToken=string&maxResults=0&assetModelVersion=stringRetrieves a paginated list of summaries of all asset models.
  • POSTCreate asset model/asset-modelsCreates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets…
  • GETList asset model composite models/asset-models/:assetModelId/composite-models?nextToken=string&maxResults=0&assetModelVersion=stringRetrieves a paginated list of composite models associated with the asset model
  • POSTCreate asset model composite model/asset-models/:assetModelId/composite-modelsCreates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and…
  • GETList bulk import jobs/jobs?nextToken=string&maxResults=0&filter=string&workspaceName=stringRetrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide .
  • POSTCreate bulk import job/jobsDefines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service…
  • GETList computation models/computation-models?computationModelType=string&nextToken=string&maxResults=0Retrieves a paginated list of summaries of all computation models.
  • POSTCreate computation model/computation-modelsCreate a computation model with a configuration and data binding.
  • GETList dashboards/dashboards?projectId=string&nextToken=string&maxResults=0Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
  • POSTCreate dashboard/dashboardsThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature,…
  • GETList datasets/datasets?sourceType=string&workspaceName=string&datasetType=string&nextToken=string&maxResults=0Retrieves a paginated list of datasets for a specific target resource.
  • POSTCreate dataset/datasetsCreates a dataset. Session and curated datasets are created in a workspace. A session dataset contains data segments of time series data, and a curated…
  • GETList dataset export jobs/workspaces/:workspaceName/dataset-export-jobs?filter=string&maxResults=0&nextToken=stringRetrieves a paginated list of dataset export jobs for a workspace.
  • POSTCreate dataset export job/workspaces/:workspaceName/dataset-export-jobsStarts an asynchronous job that exports dataset and time-series data from a workspace to Amazon S3. The operation returns a jobId immediately; poll…
  • GETList enrichment jobs/workspaces/:workspaceName/enrichment-jobs?datasetId=string&propertyAlias=string&timeSeriesId=string&status=string&jobType=string&startDate=string&endDate=string&maxResults=0&nextToken=stringLists enrichment jobs within a workspace with optional filtering and pagination. Results are ordered by createdAt timestamp descending (newest first).…
  • POSTCreate enrichment job/workspaces/:workspaceName/enrichment-jobsCreates an asynchronous enrichment job to analyze time-series sensor data. The operation returns immediately with job details while processing continues in…
  • GETList gateways/20200301/gateways?nextToken=string&maxResults=0Retrieves a paginated list of gateways.
  • POSTCreate gateway/20200301/gatewaysCreates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see…
  • GETList pipelines/workspaces/:workspaceName/pipelines?nextToken=string&maxResults=0Lists pipelines in a workspace. To get complete details about a pipeline, use DescribePipeline .
  • POSTCreate pipeline/workspaces/:workspaceName/pipelinesCreates a new pipeline in the specified workspace. A pipeline defines a directed acyclic graph (DAG) of compute nodes, where each node references a task and…
  • GETList portals/portals?nextToken=string&maxResults=0Retrieves a paginated list of IoT SiteWise Monitor portals.
  • POSTCreate portal/portalsThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature,…
  • GETList projects/projects?portalId=string&nextToken=string&maxResults=0Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
  • POSTCreate project/projectsThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature,…
  • GETList tasks/workspaces/:workspaceName/tasks?nextToken=string&maxResults=0Lists tasks in a workspace. To get complete details about a task, use DescribeTask .
  • POSTCreate task/workspaces/:workspaceName/tasksCreates a new task in the specified workspace. A task defines a reusable containerized compute workload that can be referenced by one or more pipeline compute…
  • GETList workspaces/workspaces?nextToken=string&maxResults=0Retrieves a paginated list of workspaces. Use the nextToken parameter to retrieve additional results.
  • POSTCreate workspace/workspacesCreates a workspace in IoT SiteWise. A workspace isolates its resources, such as datasets, time series, pipelines, and tasks, and their data from other…
  • GETDescribe access policy/access-policies/:accessPolicyIdDescribes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
  • PUTUpdate access policy/access-policies/:accessPolicyIdThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature,…
  • DELETEDelete access policy/access-policies/:accessPolicyId?clientToken=stringDeletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access…
  • GETDescribe application/workspaces/:workspaceName/applications/:idRetrieves Application details based on the ID
  • DELETEDelete application/workspaces/:workspaceName/applications/:idDeletes an application by ID
  • GETDescribe asset/assets/:assetId?excludeProperties=trueRetrieves information about an asset.
  • PUTUpdate asset/assets/:assetIdUpdates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide .
  • DELETEDelete asset/assets/:assetId?clientToken=stringDeletes 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…
  • GETDescribe asset model/asset-models/:assetModelId?excludeProperties=true&assetModelVersion=stringRetrieves information about an asset model. This includes details about the asset model's properties, hierarchies, composite models, and any interface…
  • PUTUpdate asset model/asset-models/:assetModelIdUpdates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property…
  • DELETEDelete asset model/asset-models/:assetModelId?clientToken=stringDeletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't…
  • GETDescribe asset model composite model/asset-models/:assetModelId/composite-models/:assetModelCompositeModelId?assetModelVersion=stringRetrieves information about an asset model composite model (also known as an asset model component). For more information, see Custom composite models…
  • PUTUpdate asset model composite model/asset-models/:assetModelId/composite-models/:assetModelCompositeModelIdUpdates a composite model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's…
  • DELETEDelete asset model composite model/asset-models/:assetModelId/composite-models/:assetModelCompositeModelId?clientToken=stringDeletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you…
  • GETDescribe asset model interface relationship/asset-models/:assetModelId/interface/:interfaceAssetModelId/asset-model-interface-relationshipRetrieves information about an interface relationship between an asset model and an interface asset model.
  • PUTPut asset model interface relationship/asset-models/:assetModelId/interface/:interfaceAssetModelId/asset-model-interface-relationshipCreates or updates an interface relationship between an asset model and an interface asset model. This operation applies an interface to an asset model.
  • DELETEDelete asset model interface relationship/asset-models/:assetModelId/interface/:interfaceAssetModelId/asset-model-interface-relationship?clientToken=stringDeletes an interface relationship between an asset model and an interface asset model.
  • GETDescribe computation model/computation-models/:computationModelId?computationModelVersion=stringRetrieves information about a computation model.
  • POSTUpdate computation model/computation-models/:computationModelIdUpdates the computation model.
  • DELETEDelete computation model/computation-models/:computationModelId?clientToken=stringDeletes a computation model. This action can't be undone.
  • GETDescribe dashboard/dashboards/:dashboardIdRetrieves information about a dashboard.
  • PUTUpdate dashboard/dashboards/:dashboardIdThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature,…
  • DELETEDelete dashboard/dashboards/:dashboardId?clientToken=stringDeletes a dashboard from IoT SiteWise Monitor.
  • GETDescribe dataset/datasets/:datasetId?workspaceName=string&datasetVersion=stringRetrieves information about a dataset.
  • PUTUpdate dataset/datasets/:datasetIdUpdates a dataset.
  • DELETEDelete dataset/datasets/:datasetId?workspaceName=string&clientToken=stringDeletes a dataset. This can't be undone. Deleting a session dataset also deletes the underlying time series data in the session. You can't delete a session…
  • GETDescribe gateway/20200301/gateways/:gatewayIdRetrieves information about a gateway.
  • PUTUpdate gateway/20200301/gateways/:gatewayIdUpdates a gateway's name.
  • DELETEDelete gateway/20200301/gateways/:gatewayIdDeletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.
  • GETDescribe pipeline/workspaces/:workspaceName/pipelines/:pipelineName?version=stringRetrieves detailed information about a specific pipeline in a workspace.
  • PUTUpdate pipeline/workspaces/:workspaceName/pipelines/:pipelineNameUpdates an existing pipeline in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved…
  • DELETEDelete pipeline/workspaces/:workspaceName/pipelines/:pipelineNameDeletes a pipeline from the specified workspace. A pipeline cannot be deleted if it has any active executions. Wait for all executions to complete before…
  • GETDescribe portal/portals/:portalIdRetrieves information about a portal.
  • PUTUpdate portal/portals/:portalIdThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature,…
  • DELETEDelete portal/portals/:portalId?clientToken=stringDeletes a portal from IoT SiteWise Monitor.
  • GETDescribe project/projects/:projectIdRetrieves information about a project.
  • PUTUpdate project/projects/:projectIdThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature,…
  • DELETEDelete project/projects/:projectId?clientToken=stringDeletes a project from IoT SiteWise Monitor.
  • GETDescribe task/workspaces/:workspaceName/tasks/:taskName?version=stringRetrieves detailed information about a specific task in a workspace.
  • PUTUpdate task/workspaces/:workspaceName/tasks/:taskNameUpdates an existing task in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved…
  • DELETEDelete task/workspaces/:workspaceName/tasks/:taskNameDeletes a task from the specified workspace. A task cannot be deleted if it is currently referenced by any existing pipeline. Remove the task from all…
  • POSTDelete time series/timeseries/delete?alias=string&assetId=string&propertyId=string&workspaceName=stringDeletes 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…
  • GETDescribe workspace/workspaces/:workspaceNameRetrieves information about a workspace.
  • PUTUpdate workspace/workspaces/:workspaceNameUpdates a workspace. You can update only workspaces in the ACTIVE or FAILED state. Fields that you omit from the request are left unchanged. To recover a…
  • DELETEDelete workspace/workspaces/:workspaceName?clientToken=stringDeletes a workspace. Before you delete a workspace, you must delete all resources contained in or associated with the workspace, such as datasets, time…
  • GETDescribe action/actions/:actionIdRetrieves information about an action.
  • GETDescribe asset composite model/assets/:assetId/composite-models/:assetCompositeModelIdRetrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel…
  • GETDescribe asset property/assets/:assetId/properties/:propertyIdRetrieves information about an asset property. When you call this operation for an attribute property, this response includes the default attribute value that…
  • PUTUpdate asset property/assets/:assetId/properties/:propertyIdUpdates an asset property's alias and notification state. This operation overwrites the property's existing alias and notification state. To keep your…
  • GETDescribe bulk import job/jobs/:jobId?workspaceName=stringRetrieves information about a bulk import job request. For more information, see Describe a bulk import job (CLI) in the Amazon Simple Storage Service User…
  • GETDescribe computation model execution summary/computation-models/:computationModelId/execution-summary?resolveToResourceType=string&resolveToResourceId=stringRetrieves information about the execution summary of a computation model.
  • GETDescribe dataset export job/workspaces/:workspaceName/dataset-export-jobs/:jobIdRetrieves information about a dataset export job.
  • GETDescribe default encryption configuration/configuration/account/encryptionRetrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information,…
  • POSTPut default encryption configuration/configuration/account/encryptionSets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide .
  • GETDescribe enrichment job/workspaces/:workspaceName/enrichment-jobs/:jobIdRetrieves detailed information about a specific enrichment job, including its current status, configuration, and timestamps. Use Cases Monitor job progress by…
  • GETDescribe execution/executions/:executionIdRetrieves information about the execution.
  • GETDescribe gateway capability configuration/20200301/gateways/:gatewayId/capability/:capabilityNamespaceEach gateway capability defines data sources for a gateway. This is the namespace of the gateway capability. . The namespace follows the format…
  • GETDescribe logging options/logging?workspaceName=stringRetrieves the current IoT SiteWise logging options.
  • PUTPut logging options/loggingSets logging options for IoT SiteWise.
  • GETDescribe pipeline execution/workspaces/:workspaceName/pipelines/:pipelineName/executions/:pipelineExecutionId?nextToken=string&maxResults=0Retrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node. Use…
  • GETDescribe query/workspaces/:workspaceName/queries/:queryIdRetrieves information about a query, including its status.
  • GETDescribe search/workspaces/:workspaceName/searches/:searchIdReturns the current status and metadata of a single search, including the query that was submitted, the search type, and — when the search has failed — the…
  • GETDescribe storage configuration/configuration/account/storageRetrieves information about the storage configuration for IoT SiteWise.
  • POSTPut storage configuration/configuration/account/storageConfigures storage settings for IoT SiteWise.
  • GETDescribe time series/timeseries/describe?alias=string&assetId=string&propertyId=string&workspaceName=stringRetrieves 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…
  • POSTDisassociate assets/assets/:assetId/disassociateDisassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
  • POSTDisassociate time series from asset property/timeseries/disassociate?alias=string&assetId=string&propertyId=stringDisassociates a time series (data stream) from an asset property.
  • GETList actions/actions?targetResourceType=string&targetResourceId=string&nextToken=string&maxResults=0&resolveToResourceType=string&resolveToResourceId=stringRetrieves a paginated list of actions for a specific target resource.
  • POSTExecute action/actionsExecutes an action on a target resource.
  • POSTExecute query/queries/executionRun SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.
  • GETGet asset property aggregates/properties/aggregates?assetId=string&propertyId=string&propertyAlias=string&aggregateTypes=&resolution=string&qualities=&startDate=string&endDate=string&timeOrdering=string&nextToken=string&maxResults=0Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide . To identify an asset property,…
  • GETGet asset property value/properties/latest?assetId=string&propertyId=string&propertyAlias=stringGets 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…
  • GETGet asset property value history/properties/history?assetId=string&propertyId=string&propertyAlias=string&startDate=string&endDate=string&qualities=&timeOrdering=string&nextToken=string&maxResults=0Gets 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…
  • POSTGet capture data/workspaces/:workspaceName/get-capture-dataRetrieves video data for a specific time range.
  • GETGet interpolated asset property values/properties/interpolated?assetId=string&propertyId=string&propertyAlias=string&startTimeInSeconds=0&startTimeOffsetInNanos=0&endTimeInSeconds=0&endTimeOffsetInNanos=0&quality=string&intervalInSeconds=0&nextToken=string&maxResults=0&type=string&intervalWindowInSeconds=0Get 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…
  • GETGet query results/workspaces/:workspaceName/queries/:queryId/results?maxResults=0&nextToken=stringRetrieves the paginated results of a query. Returns empty rows if the query is not yet complete.
  • GETGet search results/workspaces/:workspaceName/searches/:searchId/results?maxResults=0&nextToken=stringRetrieves the ranked results of a search, ordered by descending relevance score. Results are available only after the search has reached the SUCCEEDED status.…
  • POSTInvoke assistant/assistant/invocationInvokes SiteWise Assistant to start or continue a conversation.
  • GETList asset model properties/asset-models/:assetModelId/properties?nextToken=string&maxResults=0&filter=string&assetModelVersion=stringRetrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the…
  • GETList asset properties/assets/:assetId/properties?nextToken=string&maxResults=0&filter=stringRetrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the…
  • GETList asset relationships/assets/:assetId/assetRelationships?traversalType=string&nextToken=string&maxResults=0Retrieves 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…
  • GETList associated assets/assets/:assetId/hierarchies?hierarchyId=string&traversalDirection=string&nextToken=string&maxResults=0Retrieves 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…
  • GETList composition relationships/asset-models/:assetModelId/composition-relationships?nextToken=string&maxResults=0Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL .
  • POSTList computation model data binding usages/computation-models/data-binding-usagesLists all data binding usages for computation models. This allows to identify where specific data bindings are being utilized across the computation models.…
  • GETList computation model resolve to resources/computation-models/:computationModelId/resolve-to-resources?nextToken=string&maxResults=0Lists all distinct resources that are resolved from the executed actions of the computation model.
  • GETList dataset data segment relationships/datasets/:datasetId/data-segment-relationships?workspaceName=string&maxResults=0&nextToken=stringRetrieves a paginated list of data segment relationships for a session dataset. Use this operation to find the curated datasets that reference data segments…
  • GETList dataset data segments/datasets/:datasetId/data-segments?workspaceName=string&datasetVersion=string&maxResults=0&nextToken=stringRetrieves a paginated list of data segments associated with a dataset. Use the nextToken parameter to retrieve additional results.
  • GETList executions/executions?targetResourceType=string&targetResourceId=string&resolveToResourceType=string&resolveToResourceId=string&nextToken=string&maxResults=0&actionType=stringRetrieves a paginated list of summaries of all executions.
  • GETList interface relationships/interface/:interfaceAssetModelId/asset-models?nextToken=string&maxResults=0Retrieves a paginated list of asset models that have a specific interface asset model applied to them.
  • GETList pipeline executions/workspaces/:workspaceName/pipelines/:pipelineName/executions?nextToken=string&maxResults=0&state=string&startTimeAfter=string&startTimeBefore=string&endTimeAfter=string&endTimeBefore=stringLists pipeline executions for a specific pipeline in a workspace. Supports filtering by state and time range. State can be combined with either startTime or…
  • POSTStart pipeline execution/workspaces/:workspaceName/pipelines/:pipelineName/executionsStarts execution of a pipeline in the specified workspace. Each compute node runs according to the DAG dependency order defined in the pipeline. Nodes without…
  • GETList project assets/projects/:projectId/assets?nextToken=string&maxResults=0Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
  • GETList queries/workspaces/:workspaceName/queries?filter=string&maxResults=0&nextToken=stringRetrieves a paginated list of queries for a workspace.
  • POSTStart query/workspaces/:workspaceName/queriesStarts an asynchronous SQL query against workspace telemetry, annotations, data segment, and dataset data.
  • POSTList searches/workspaces/:workspaceName/searches/listLists the searches in a workspace, most recently started first. Results can be narrowed with optional filters (status, search type, group, and started-at time…
  • GETList tags for resource/tags?resourceArn=stringRetrieves the list of tags for an IoT SiteWise resource.
  • POSTTag resource/tags?resourceArn=stringAdds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
  • DELETEUntag resource/tags?resourceArn=string&tagKeys=Removes a tag from an IoT SiteWise resource.
  • GETList time series/timeseries?nextToken=string&maxResults=0&assetId=string&aliasPrefix=string&timeSeriesType=string&workspaceName=stringRetrieves a paginated list of time series (data streams).
  • POSTStart search/workspaces/:workspaceName/searchesStarts an asynchronous search over the data in a workspace. The search runs in the background; the response returns immediately with a searchId and an initial…
  • POSTUpdate gateway capability configuration/20200301/gateways/:gatewayId/capabilityUpdates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. Important…

API details

Base URL
https://iotsitewise.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
149 operations on 94 pathsGET 70POST 48DELETE 16PUT 15
Description format
AWS Smithy model, API version 2019-12-02

How to test the AWS IoT SiteWise in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS IoT SiteWise collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate assets” (POST /assets/:assetId/associate), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS IoT SiteWise?

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… It is listed under IoT & devices and has 149 endpoints.

Who publishes the AWS IoT SiteWise?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS IoT SiteWise?

Requests go to https://iotsitewise.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS IoT SiteWise?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS IoT SiteWise have?

149 operations on 94 paths (70 GET, 48 POST, 16 DELETE, 15 PUT).

Is forking the AWS IoT SiteWise free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.