aws iotsitewise
Welcome to the IoT SiteWise API Reference. AWS CLI reference
149 commands Its page in the AWS CLI reference
Commands
associate-assetsAssociates a child asset with the given parent asset through a hierarchy defined in the parent asset's model.associate-time-series-to-asset-propertyAssociates a time series (data stream) with an asset property.batch-associate-data-segments-to-datasetAssociates a batch of data segments with a curated dataset.batch-associate-project-assetsThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.batch-delete-dataset-data-segmentsDeletes a batch of data segments from a session dataset.batch-disassociate-data-segments-from-datasetDisassociates a batch of data segments from a curated dataset.batch-disassociate-project-assetsDisassociates a group (batch) of assets from an IoT SiteWise Monitor project.batch-get-asset-property-aggregatesGets aggregated values (for example, average, minimum, and maximum) for one or more asset properties.batch-get-asset-property-valueGets the current value for one or more asset properties.batch-get-asset-property-value-historyGets the historical values for one or more asset properties.batch-put-asset-property-valueSends a list of asset property values to IoT SiteWise.cancel-enrichment-jobCancels a running or pending enrichment job.cancel-pipeline-executionCancels a pipeline execution in the specified workspace.cancel-queryCancels a running query.create-access-policyThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.create-applicationCreates a new application for the workspace and IdC application providedcreate-assetCreates an asset from an existing asset model.create-asset-modelCreates an asset model from specified property and hierarchy definitions.create-asset-model-composite-modelCreates a custom composite model from specified property and hierarchy definitions.create-bulk-import-jobDefines a job to ingest data to IoT SiteWise from Amazon S3.create-computation-modelCreate a computation model with a configuration and data binding.create-dashboardThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.create-datasetCreates a dataset.create-dataset-export-jobStarts an asynchronous job that exports dataset and time-series data from a workspace to Amazon S3.create-enrichment-jobCreates an asynchronous enrichment job to analyze time-series sensor data.create-gatewayCreates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise.create-pipelineCreates a new pipeline in the specified workspace.create-portalThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.create-projectThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.create-taskCreates a new task in the specified workspace.create-workspaceCreates a workspace in IoT SiteWise.delete-access-policyDeletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource.delete-applicationDeletes an application by IDdelete-assetDeletes an asset.delete-asset-modelDeletes an asset model.delete-asset-model-composite-modelDeletes a composite model.delete-asset-model-interface-relationshipDeletes an interface relationship between an asset model and an interface asset model.delete-computation-modelDeletes a computation model.delete-dashboardDeletes a dashboard from IoT SiteWise Monitor.delete-datasetDeletes a dataset.delete-gatewayDeletes a gateway from IoT SiteWise.delete-pipelineDeletes a pipeline from the specified workspace.delete-portalDeletes a portal from IoT SiteWise Monitor.delete-projectDeletes a project from IoT SiteWise Monitor.delete-taskDeletes a task from the specified workspace.delete-time-seriesDeletes a time series (data stream).delete-workspaceDeletes a workspace.describe-access-policyDescribes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.describe-actionRetrieves information about an action.describe-applicationRetrieves Application details based on the IDdescribe-assetRetrieves information about an asset.describe-asset-composite-modelRetrieves information about an asset composite model (also known as an asset component).describe-asset-modelRetrieves information about an asset model.describe-asset-model-composite-modelRetrieves information about an asset model composite model (also known as an asset model component).describe-asset-model-interface-relationshipRetrieves information about an interface relationship between an asset model and an interface asset model.describe-asset-propertyRetrieves information about an asset property.describe-bulk-import-jobRetrieves information about a bulk import job request.describe-computation-modelRetrieves information about a computation model.describe-computation-model-execution-summaryRetrieves information about the execution summary of a computation model.describe-dashboardRetrieves information about a dashboard.describe-datasetRetrieves information about a dataset.describe-dataset-export-jobRetrieves information about a dataset export job.describe-default-encryption-configurationRetrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region.describe-enrichment-jobRetrieves detailed information about a specific enrichment job, including its current status, configuration, and timestamps.describe-executionRetrieves information about the execution.describe-gatewayRetrieves information about a gateway.describe-gateway-capability-configurationEach gateway capability defines data sources for a gateway.describe-logging-optionsRetrieves the current IoT SiteWise logging options.describe-pipelineRetrieves detailed information about a specific pipeline in a workspace.describe-pipeline-executionRetrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node.describe-portalRetrieves information about a portal.describe-projectRetrieves information about a project.describe-queryRetrieves information about a query, including its status.describe-searchReturns 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 reason.describe-storage-configurationRetrieves information about the storage configuration for IoT SiteWise.describe-taskRetrieves detailed information about a specific task in a workspace.describe-time-seriesRetrieves information about a time series (data stream).describe-workspaceRetrieves information about a workspace.disassociate-assetsDisassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.disassociate-time-series-from-asset-propertyDisassociates a time series (data stream) from an asset property.execute-actionExecutes an action on a target resource.execute-queryRun SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.get-asset-property-aggregatesGets aggregated values for an asset property.get-asset-property-valueGets an asset property's current value.get-asset-property-value-historyGets the history of an asset property's values.get-capture-dataRetrieves video data for a specific time range.get-interpolated-asset-property-valuesGet interpolated values for an asset property for a specified time interval, during a period of time.get-query-resultsRetrieves the paginated results of a query.get-search-resultsRetrieves the ranked results of a search, ordered by descending relevance score.invoke-assistantInvokes SiteWise Assistant to start or continue a conversation.list-access-policiesRetrieves 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).list-actionsRetrieves a paginated list of actions for a specific target resource.list-applicationsRetrieves a paginated list of existing applicationslist-asset-model-composite-modelsRetrieves a paginated list of composite models associated with the asset modellist-asset-model-propertiesRetrieves a paginated list of properties associated with an asset model.list-asset-modelsRetrieves a paginated list of summaries of all asset models.list-asset-propertiesRetrieves a paginated list of properties associated with an asset.list-asset-relationshipsRetrieves a paginated list of asset relationships for an asset.list-assetsRetrieves a paginated list of asset summaries.list-associated-assetsRetrieves a paginated list of associated assets.list-bulk-import-jobsRetrieves a paginated list of bulk import job requests.list-composition-relationshipsRetrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.list-computation-model-data-binding-usagesLists all data binding usages for computation models.list-computation-model-resolve-to-resourcesLists all distinct resources that are resolved from the executed actions of the computation model.list-computation-modelsRetrieves a paginated list of summaries of all computation models.list-dashboardsRetrieves a paginated list of dashboards for an IoT SiteWise Monitor project.list-dataset-data-segment-relationshipsRetrieves a paginated list of data segment relationships for a session dataset.list-dataset-data-segmentsRetrieves a paginated list of data segments associated with a dataset.list-dataset-export-jobsRetrieves a paginated list of dataset export jobs for a workspace.list-datasetsRetrieves a paginated list of datasets for a specific target resource.list-enrichment-jobsLists enrichment jobs within a workspace with optional filtering and pagination.list-executionsRetrieves a paginated list of summaries of all executions.list-gatewaysRetrieves a paginated list of gateways.list-interface-relationshipsRetrieves a paginated list of asset models that have a specific interface asset model applied to them.list-pipeline-executionsLists pipeline executions for a specific pipeline in a workspace.list-pipelinesLists pipelines in a workspace.list-portalsRetrieves a paginated list of IoT SiteWise Monitor portals.list-project-assetsRetrieves a paginated list of assets associated with an IoT SiteWise Monitor project.list-projectsRetrieves a paginated list of projects for an IoT SiteWise Monitor portal.list-queriesRetrieves a paginated list of queries for a workspace.list-searchesLists the searches in a workspace, most recently started first.list-tags-for-resourceRetrieves the list of tags for an IoT SiteWise resource.list-tasksLists tasks in a workspace.list-time-seriesRetrieves a paginated list of time series (data streams).list-workspacesRetrieves a paginated list of workspaces.put-asset-model-interface-relationshipCreates or updates an interface relationship between an asset model and an interface asset model.put-default-encryption-configurationSets the default encryption configuration for the Amazon Web Services account.put-logging-optionsSets logging options for IoT SiteWise.put-storage-configurationConfigures storage settings for IoT SiteWise.start-pipeline-executionStarts execution of a pipeline in the specified workspace.start-queryStarts an asynchronous SQL query against workspace telemetry, annotations, data segment, and dataset data.start-searchStarts an asynchronous search over the data in a workspace.tag-resourceAdds tags to an IoT SiteWise resource.untag-resourceRemoves a tag from an IoT SiteWise resource.update-access-policyThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.update-assetUpdates an asset's name.update-asset-modelUpdates an asset model and all of the assets that were created from the model.update-asset-model-composite-modelUpdates a composite model and all of the assets that were created from the model.update-asset-propertyUpdates an asset property's alias and notification state.update-computation-modelUpdates the computation model.update-dashboardThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.update-datasetUpdates a dataset.update-gatewayUpdates a gateway's name.update-gateway-capability-configurationUpdates a gateway capability configuration or defines a new capability configuration.update-pipelineUpdates an existing pipeline in the specified workspace.update-portalThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.update-projectThe IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025.update-taskUpdates an existing task in the specified workspace.update-workspaceUpdates a workspace.