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.

Associates a time series (data stream) with an asset property.

Associates a batch of data segments with a curated dataset.

Data segments are time-bounded slices of time series data selected from source session datasets. Data segments that belong to the same time series can't overlap in time, regardless of which dataset they belong to.

The 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, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

Associates a group (batch) of assets with an IoT SiteWise Monitor project.

Deletes 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.

Disassociates a batch of data segments from a curated dataset.

Disassociating a data segment doesn't delete the underlying data in the source session dataset.

Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.

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.

Gets the current value for one or more asset properties.

For more information, see Querying current values in the IoT SiteWise User Guide.

Gets the historical values for one or more asset properties.

For more information, see Querying historical values in the IoT SiteWise User Guide.

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.

Cancels 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 status.

behavior

Behavior

• Jobs in PENDING or RUNNING status transition to CANCELLED

• Jobs in RUNNING state may not be cancellable once they have progressed to certain processing stages

• Jobs already in terminal states (COMPLETED, FAILED, TIMED_OUT) cannot be cancelled; the operation returns a ConflictingOperationException

• Cancelling an already-CANCELLED job is a no-op and returns the current status (idempotent behavior)

• The API responds immediately after recording the cancellation

• Cleanup of job resources happens asynchronously in the background

when-to-cancel

When to Cancel

Cancel a job when:

• The job is taking longer than expected

• The job was created with incorrect parameters

• You no longer need the results

idempotency

Idempotency

You can safely retry cancellation requests. Calling CancelEnrichmentJob multiple times for the same job returns the current status without error as long as the job is not in a terminal state other than CANCELLED.

Cancels 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 CANCELLING and asynchronously to CANCELLED. This operation is idempotent: calling it on an execution that is already CANCELLING or CANCELLED returns success with the current state. Calling it on a terminal execution (SUCCEEDED or FAILED) returns a conflict error. You can optionally provide a reason; it is returned in the stateDetails field when you describe the execution.

Cancels a running query.

The 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, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

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.

Support for access policies that use an SSO Group as the identity is not supported at this time.

Creates a new application for the workspace and IdC application provided

Creates an asset from an existing asset model.

For more information, see Creating assets in the IoT SiteWise User Guide.

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 three types of asset models, ASSET_MODEL, COMPONENT_MODEL, or an INTERFACE.

*

ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

*

COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

*

INTERFACE – An interface is a type of model that defines a standard structure that can be applied to different asset models.

Creates a custom composite model from specified property and hierarchy definitions.

There are two types of custom composite models, inline and component-model-based.

Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provides its associated properties to any created assets. For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.

Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are included and can't be used to create multiple assets.

To create a component-model-based model, specify the composedAssetModelId of an existing asset model with assetModelType of COMPONENT_MODEL.

To create an inline model, specify the assetModelCompositeModelProperties and don't include an composedAssetModelId.

Defines 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 User Guide.

Before you create a bulk import job that ingests data into time series outside of a workspace, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration. This requirement doesn't apply to bulk import jobs that ingest data into a session dataset in a workspace (jobs that specify a workspaceName and datasetId). Those jobs don't use IoT SiteWise warm or cold tier storage.

Bulk import is designed to store historical data to IoT SiteWise.

Newly ingested data in the hot tier triggers notifications and computations.

After data moves from the hot tier to the warm or cold tier based on retention settings, it does not trigger computations or notifications.

Data older than 7 days does not trigger computations or notifications.

Create a computation model with a configuration and data binding.

The 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, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

Creates a dashboard in an IoT SiteWise Monitor project.

Creates a dataset.

Session and curated datasets are created in a workspace. A session dataset contains data segments of time series data, and a curated dataset curates data segments selected from source session datasets. A dataset that connects to an external datasource is created outside of a workspace.

Starts an asynchronous job that exports dataset and time-series data from a workspace to Amazon S3.

The operation returns a jobId immediately; poll DescribeDatasetExportJob to track progress and ListDatasetExportJobs to enumerate a workspace's jobs.

Creates an asynchronous enrichment job to analyze time-series sensor data.

The operation returns immediately with job details while processing continues in the background.

idempotency

Idempotency

Include a clientToken to make the operation idempotent. If you submit the same request with the same token within the idempotency window, you receive the original job details without creating a duplicate.

prerequisites

Prerequisites

Before creating a job, ensure:

• The workspace is in ACTIVE state (not being deleted)

• You have IAM permissions for the workspace, dataset, and time-series resources

• You have KMS Decrypt permission on the workspace's customer-managed encryption key

• No duplicate job (same workspace, dataset, property, and job type) is currently running

workflow

Workflow

1. Submit the job with configuration specifying which video data to analyze and the time range

2. Capture the jobId from the response

3. Use DescribeEnrichmentJob to monitor progress and check job status

4. When status reaches a terminal state (COMPLETED, FAILED, TIMED_OUT, CANCELLED), check results

5. For COMPLETED jobs, query IoT SiteWise for semantic search on video events

error-handling

Error Handling

• ConflictingOperationException: A duplicate job is already running for the same configuration

• InvalidRequestException: Invalid parameters (e.g., both timeSeriesId and propertyAlias specified)

• AccessDeniedException: Insufficient IAM or KMS permissions

• LimitExceededException: Too many concurrent jobs or requests

Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise.

For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.

Creates 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 can declare dependencies on other nodes. Cyclic dependencies are not allowed. Nodes without dependencies run in parallel, while nodes with dependencies wait for all upstream nodes to complete successfully before starting.

You can set environment variables at the pipeline level that are shared across all compute nodes, and override them at the individual compute node level.

The 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, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions.

Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide.

The 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, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

Creates a project in the specified portal.

Make sure that the project name and description don't contain confidential information.

Creates 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 nodes.

Specify a containerTaskConfiguration for custom container workloads with configurable ECR image, processing type, processing unit, and environment variables.

Creates a workspace in IoT SiteWise.

A workspace isolates its resources, such as datasets, time series, pipelines, and tasks, and their data from other workspaces, and has its own quotas and throttling limits. You must specify an encryption configuration when you create a workspace. The operation returns immediately with the workspace in the CREATING state. Provisioning completes asynchronously, after which the workspace state is ACTIVE, or FAILED if provisioning doesn't complete.

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.

Deletes an application by ID

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.

Deletes 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 delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

Deletes 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 can't delete a composite model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

Deletes an interface relationship between an asset model and an interface asset model.

Deletes a computation model.

This action can't be undone.

Deletes a dashboard from IoT SiteWise Monitor.

Deletes 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 dataset while a curated dataset references its data segments. First delete the curated dataset or disassociate the data segments. Deleting a curated dataset doesn't delete the underlying data in the source session datasets.

Deletes a gateway from IoT SiteWise.

When you delete a gateway, some of the gateway's files remain in your gateway's file system.

Deletes a pipeline from the specified workspace.

A pipeline cannot be deleted if it has any active executions. Wait for all executions to complete before attempting to delete the pipeline, or use CancelPipelineExecution to stop a running execution.

Deletes a portal from IoT SiteWise Monitor.

Deletes a project from IoT SiteWise Monitor.

Deletes 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 pipelines before attempting to delete it.

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. You can't delete a time series until all of its data segments have been deleted from session datasets.

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.

Deletes a workspace.

Before you delete a workspace, you must delete all resources contained in or associated with the workspace, such as datasets, time series, pipelines, and tasks.

Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.

Retrieves information about an action.

Retrieves Application details based on the ID

Retrieves information about an asset.

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.

Retrieves information about an asset model.

This includes details about the asset model's properties, hierarchies, composite models, and any interface relationships if the asset model implements interfaces.

Retrieves information about an asset model composite model (also known as an asset model component).

For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.

Retrieves information about an interface relationship between an asset model and an interface asset model.

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.

Retrieves information about a bulk import job request.

For more information, see Describe a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.

Retrieves information about a computation model.

Retrieves information about the execution summary of a computation model.

Retrieves information about a dashboard.

Retrieves information about a dataset.

Retrieves information about a dataset export job.

Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region.

For more information, see Key management in the IoT SiteWise User Guide.

Retrieves detailed information about a specific enrichment job, including its current status, configuration, and timestamps.

use-cases

Use Cases

• Monitor job progress by checking status updates with DescribeEnrichmentJob

• Retrieve the complete job configuration submitted during creation

• Debug failed jobs by examining the failureMessage field

• Track job lifecycle with creation, update, completion, and cancellation timestamps

status-monitoring

Status Monitoring

Jobs progress through statuses: PENDING → RUNNING → terminal state

Terminal states:

• COMPLETED: Job finished successfully; query IoT SiteWise for semantic search results

• FAILED: Job encountered an error; check failureMessage for details

• TIMED_OUT: Job exceeded maximum processing time

• CANCELLED: Job was cancelled via CancelEnrichmentJob

response-fields

Response Fields

The response includes:

• Current job status and type

• Full job configuration as originally submitted

• Lifecycle timestamps (created, updated, completed, cancelled)

• Failure details if status is FAILED

Retrieves information about the execution.

Retrieves information about a gateway.

Each gateway capability defines data sources for a gateway.

This is the namespace of the gateway capability.

. The namespace follows the format service:capability:version, where:

*

service - The service providing the capability, or iotsitewise.

*

capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability.

*

version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways.

After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied.

A gateway can have multiple capability configurations with different namespaces.

Retrieves the current IoT SiteWise logging options.

Retrieves detailed information about a specific pipeline in a workspace.

Retrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node.

Use this operation to monitor execution progress and inspect per-node results, environment variables, and error details.

Retrieves information about a portal.

Retrieves information about a project.

Retrieves information about a query, including its status.

Returns 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.

Use this to poll a search started with StartSearch until it reaches a terminal status (SUCCEEDED or FAILED).

Retrieves information about the storage configuration for IoT SiteWise.

Retrieves detailed information about a specific task in a workspace.

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.

Retrieves information about a workspace.

Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.

Disassociates a time series (data stream) from an asset property.

Executes an action on a target resource.

Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and 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.

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.

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.

Retrieves video data for a specific time range.

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.

Retrieves the paginated results of a query.

Returns empty rows if the query is not yet complete.

Retrieves the ranked results of a search, ordered by descending relevance score.

Results are available only after the search has reached the SUCCEEDED status. Calling this on a search that exists but has not yet completed returns InvalidRequestException, while calling it on a search that does not exist returns ResourceNotFoundException. The response is paginated: when nextToken is present, pass it on a subsequent call to retrieve the next page.

Invokes SiteWise Assistant to start or continue a conversation.

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).

Retrieves a paginated list of actions for a specific target resource.

Retrieves a paginated list of existing applications

Retrieves a paginated list of composite models associated with the asset model

Retrieves a paginated list of properties associated with an asset model.

If you update properties associated with the model before you finish listing all the properties, you need to start all over again.

Retrieves a paginated list of summaries of all asset models.

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.

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.

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.

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.

Retrieves a paginated list of bulk import job requests.

For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.

Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.

Lists all data binding usages for computation models.

This allows to identify where specific data bindings are being utilized across the computation models. This track dependencies between data sources and computation models.

Lists all distinct resources that are resolved from the executed actions of the computation model.

Retrieves a paginated list of summaries of all computation models.

Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.

Retrieves a paginated list of data segment relationships for a session dataset.

Use this operation to find the curated datasets that reference data segments of the specified session dataset. Use the nextToken parameter to retrieve additional results.

Retrieves a paginated list of data segments associated with a dataset.

Use the nextToken parameter to retrieve additional results.

Retrieves a paginated list of dataset export jobs for a workspace.

Retrieves a paginated list of datasets for a specific target resource.

Lists enrichment jobs within a workspace with optional filtering and pagination.

Results are ordered by createdAt timestamp descending (newest first).

filtering

Filtering

Combine filters to narrow results:

• datasetId: Filter by dataset

• propertyAlias OR timeSeriesId: Filter by time series (specify one, not both)

• status: Filter by job status (e.g., RUNNING to find active jobs)

• jobType: Filter by enrichment type (currently only EVENT_DETECTION)

• startDate and endDate: Filter by job creation time range

important-constraints

Important Constraints

• You must specify either propertyAlias OR timeSeriesId, but not both

• Attempting to specify both results in an InvalidRequestException

• Date filters use ISO 8601 format

• startDate is exclusive, endDate is inclusive

pagination

Pagination

The operation returns up to maxResults jobs per page (default 50). If more results exist, the response includes a nextToken. Submit this token in a subsequent request to retrieve the next page.

common-use-cases

Common Use Cases

• Find all running jobs: Filter by status=RUNNING

• List recent jobs for a dataset: Filter by datasetId with optional date range

• Monitor jobs for a specific sensor: Filter by propertyAlias or timeSeriesId

• Track all event detection jobs: Filter by jobType=EVENT_DETECTION

performance

Performance

Performance is optimal when filtering by supported fields (datasetId, propertyAlias, timeSeriesId, status, jobType).

Retrieves a paginated list of summaries of all executions.

Retrieves a paginated list of gateways.

Retrieves a paginated list of asset models that have a specific interface asset model applied to them.

Lists pipeline executions for a specific pipeline in a workspace.

Supports filtering by state and time range. State can be combined with either startTime or endTime filters. Time range filters are grouped: use startTime filters (startTimeAfter, startTimeBefore) or endTime filters (endTimeAfter, endTimeBefore), but not both. Combining startTime and endTime filters returns an InvalidRequestException. Note: endTime filters only return executions in terminal states, as in-progress executions have no endTime.

Lists pipelines in a workspace.

To get complete details about a pipeline, use DescribePipeline.

Retrieves a paginated list of IoT SiteWise Monitor portals.

Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.

Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.

Retrieves a paginated list of queries for a workspace.

Lists the searches in a workspace, most recently started first.

Results can be narrowed with optional filters (status, search type, group, and started-at time range) and are paginated: when nextToken is present, pass it on a subsequent call to retrieve the next page.

Retrieves the list of tags for an IoT SiteWise resource.

Lists tasks in a workspace.

To get complete details about a task, use DescribeTask.

Retrieves a paginated list of time series (data streams).

Retrieves a paginated list of workspaces.

Use the nextToken parameter to retrieve additional results.

Creates or updates an interface relationship between an asset model and an interface asset model.

This operation applies an interface to an asset model.

Sets the default encryption configuration for the Amazon Web Services account.

For more information, see Key management in the IoT SiteWise User Guide.

Sets logging options for IoT SiteWise.

Configures storage settings for IoT SiteWise.

Starts execution of a pipeline in the specified workspace.

Each compute node runs according to the DAG dependency order defined in the pipeline. Nodes without dependencies start immediately, while dependent nodes wait for all upstream nodes to complete successfully.

You can provide runtime environment variable overrides that take the highest priority in the environment variable hierarchy, without modifying the pipeline definition.

Starts an asynchronous SQL query against workspace telemetry, annotations, data segment, and dataset data.

Starts 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 status of QUEUED. Use DescribeSearch to poll for completion and GetSearchResults to retrieve the results once the search reaches SUCCEEDED. The request is idempotent on clientToken: repeating a call with the same token returns the original search instead of starting a new one.

Adds tags to an IoT SiteWise resource.

If a tag already exists for the resource, this operation updates the tag's value.

Removes a tag from an IoT SiteWise resource.

The 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, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.

Updates an asset's name.

For more information, see Updating assets and models in the IoT SiteWise User Guide.

Updates 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 and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.

If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.

To replace an existing asset model property with a new one with the same name, do the following:

Submit an UpdateAssetModel request with the entire existing property removed.

Submit a second UpdateAssetModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.

Updates 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 property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.

If you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.

To replace an existing composite asset model property with a new one with the same name, do the following:

Submit an UpdateAssetModelCompositeModel request with the entire existing property removed.

Submit a second UpdateAssetModelCompositeModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.

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.

Updates the computation model.

The 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, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

Updates an IoT SiteWise Monitor dashboard.

Updates a dataset.

Updates a gateway's name.

Updates a gateway capability configuration or defines a new capability configuration.

Each gateway capability defines data sources for a gateway.

Important workflow notes:

Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.

. The namespace follows the format service:capability:version, where:

*

service - The service providing the capability, or iotsitewise.

*

capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability.

*

version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways.

After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied.

A gateway can have multiple capability configurations with different namespaces.

Updates an existing pipeline in the specified workspace.

Only the fields provided in the request are updated; fields not included in the request are preserved unchanged. You can update the pipeline description, environment variables, and the list of compute nodes independently.

The 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, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

Updates an IoT SiteWise Monitor portal.

The 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, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

Updates an IoT SiteWise Monitor project.

Updates an existing task in the specified workspace.

Only the fields provided in the request are updated; fields not included in the request are preserved unchanged.

Updates 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 workspace in the FAILED state, call this operation and supply its encryption configuration again.