AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing IoTSiteWise

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.

Inheritance Hierarchy

Amazon.IoTSiteWise.IAmazonIoTSiteWise

Namespace: Amazon.IoTSiteWise
Assembly: AWSSDK.IoTSiteWise.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonIoTSiteWise
         IAmazonService, IDisposable

The IAmazonIoTSiteWise type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.IoTSiteWise.Model.IIoTSiteWisePaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AssociateAssets(AssociateAssetsRequest)

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.

Public Method AssociateAssetsAsync(AssociateAssetsRequest, CancellationToken)

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.

Public Method AssociateTimeSeriesToAssetProperty(AssociateTimeSeriesToAssetPropertyRequest)

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

Public Method AssociateTimeSeriesToAssetPropertyAsync(AssociateTimeSeriesToAssetPropertyRequest, CancellationToken)

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

Public Method BatchAssociateProjectAssets(BatchAssociateProjectAssetsRequest)

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

Public Method BatchAssociateProjectAssetsAsync(BatchAssociateProjectAssetsRequest, CancellationToken)

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

Public Method BatchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest)

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

Public Method BatchDisassociateProjectAssetsAsync(BatchDisassociateProjectAssetsRequest, CancellationToken)

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

Public Method BatchGetAssetPropertyAggregates(BatchGetAssetPropertyAggregatesRequest)

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.

Public Method BatchGetAssetPropertyAggregatesAsync(BatchGetAssetPropertyAggregatesRequest, CancellationToken)

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.

Public Method BatchGetAssetPropertyValue(BatchGetAssetPropertyValueRequest)

Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.

Public Method BatchGetAssetPropertyValueAsync(BatchGetAssetPropertyValueRequest, CancellationToken)

Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.

Public Method BatchGetAssetPropertyValueHistory(BatchGetAssetPropertyValueHistoryRequest)

Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.

Public Method BatchGetAssetPropertyValueHistoryAsync(BatchGetAssetPropertyValueHistoryRequest, CancellationToken)

Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.

Public Method BatchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest)

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.

Public Method BatchPutAssetPropertyValueAsync(BatchPutAssetPropertyValueRequest, CancellationToken)

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.

Public Method CreateAccessPolicy(CreateAccessPolicyRequest)

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.

Public Method CreateAccessPolicyAsync(CreateAccessPolicyRequest, CancellationToken)

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.

Public Method CreateAsset(CreateAssetRequest)

Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.

Public Method CreateAssetAsync(CreateAssetRequest, CancellationToken)

Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.

Public Method CreateAssetModel(CreateAssetModelRequest)

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.

Public Method CreateAssetModelAsync(CreateAssetModelRequest, CancellationToken)

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.

Public Method CreateAssetModelCompositeModel(CreateAssetModelCompositeModelRequest)

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.

Public Method CreateAssetModelCompositeModelAsync(CreateAssetModelCompositeModelRequest, CancellationToken)

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.

Public Method CreateBulkImportJob(CreateBulkImportJobRequest)

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, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration.

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.

Public Method CreateBulkImportJobAsync(CreateBulkImportJobRequest, CancellationToken)

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, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration.

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.

Public Method CreateComputationModel(CreateComputationModelRequest)

Create a computation model with a configuration and data binding.

Public Method CreateComputationModelAsync(CreateComputationModelRequest, CancellationToken)

Create a computation model with a configuration and data binding.

Public Method CreateDashboard(CreateDashboardRequest)

Creates a dashboard in an IoT SiteWise Monitor project.

Public Method CreateDashboardAsync(CreateDashboardRequest, CancellationToken)

Creates a dashboard in an IoT SiteWise Monitor project.

Public Method CreateDataset(CreateDatasetRequest)

Creates a dataset to connect an external datasource.

Public Method CreateDatasetAsync(CreateDatasetRequest, CancellationToken)

Creates a dataset to connect an external datasource.

Public Method CreateGateway(CreateGatewayRequest)

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.

Public Method CreateGatewayAsync(CreateGatewayRequest, CancellationToken)

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.

Public Method CreatePortal(CreatePortalRequest)

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.

Public Method CreatePortalAsync(CreatePortalRequest, CancellationToken)

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.

Public Method CreateProject(CreateProjectRequest)

Creates a project in the specified portal.

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

Public Method CreateProjectAsync(CreateProjectRequest, CancellationToken)

Creates a project in the specified portal.

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

Public Method DeleteAccessPolicy(DeleteAccessPolicyRequest)

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.

Public Method DeleteAccessPolicyAsync(DeleteAccessPolicyRequest, CancellationToken)

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.

Public Method DeleteAsset(DeleteAssetRequest)

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.

Public Method DeleteAssetAsync(DeleteAssetRequest, CancellationToken)

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.

Public Method DeleteAssetModel(DeleteAssetModelRequest)

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.

Public Method DeleteAssetModelAsync(DeleteAssetModelRequest, CancellationToken)

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.

Public Method DeleteAssetModelCompositeModel(DeleteAssetModelCompositeModelRequest)

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.

Public Method DeleteAssetModelCompositeModelAsync(DeleteAssetModelCompositeModelRequest, CancellationToken)

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.

Public Method DeleteAssetModelInterfaceRelationship(DeleteAssetModelInterfaceRelationshipRequest)

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

Public Method DeleteAssetModelInterfaceRelationshipAsync(DeleteAssetModelInterfaceRelationshipRequest, CancellationToken)

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

Public Method DeleteComputationModel(DeleteComputationModelRequest)

Deletes a computation model. This action can't be undone.

Public Method DeleteComputationModelAsync(DeleteComputationModelRequest, CancellationToken)

Deletes a computation model. This action can't be undone.

Public Method DeleteDashboard(DeleteDashboardRequest)

Deletes a dashboard from IoT SiteWise Monitor.

Public Method DeleteDashboardAsync(DeleteDashboardRequest, CancellationToken)

Deletes a dashboard from IoT SiteWise Monitor.

Public Method DeleteDataset(DeleteDatasetRequest)

Deletes a dataset. This cannot be undone.

Public Method DeleteDatasetAsync(DeleteDatasetRequest, CancellationToken)

Deletes a dataset. This cannot be undone.

Public Method DeleteGateway(DeleteGatewayRequest)

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

Public Method DeleteGatewayAsync(DeleteGatewayRequest, CancellationToken)

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

Public Method DeletePortal(DeletePortalRequest)

Deletes a portal from IoT SiteWise Monitor.

Public Method DeletePortalAsync(DeletePortalRequest, CancellationToken)

Deletes a portal from IoT SiteWise Monitor.

Public Method DeleteProject(DeleteProjectRequest)

Deletes a project from IoT SiteWise Monitor.

Public Method DeleteProjectAsync(DeleteProjectRequest, CancellationToken)

Deletes a project from IoT SiteWise Monitor.

Public Method DeleteTimeSeries(DeleteTimeSeriesRequest)

Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.

To identify a time series, do one of the following:

  • If the time series isn't associated with an asset property, specify the alias of the time series.

  • If the time series is associated with an asset property, specify one of the following:

    • The alias of the time series.

    • The assetId and propertyId that identifies the asset property.

Public Method DeleteTimeSeriesAsync(DeleteTimeSeriesRequest, CancellationToken)

Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.

To identify a time series, do one of the following:

  • If the time series isn't associated with an asset property, specify the alias of the time series.

  • If the time series is associated with an asset property, specify one of the following:

    • The alias of the time series.

    • The assetId and propertyId that identifies the asset property.

Public Method DescribeAccessPolicy(DescribeAccessPolicyRequest)

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

Public Method DescribeAccessPolicyAsync(DescribeAccessPolicyRequest, CancellationToken)

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

Public Method DescribeAction(DescribeActionRequest)

Retrieves information about an action.

Public Method DescribeActionAsync(DescribeActionRequest, CancellationToken)

Retrieves information about an action.

Public Method DescribeAsset(DescribeAssetRequest)

Retrieves information about an asset.

Public Method DescribeAssetAsync(DescribeAssetRequest, CancellationToken)

Retrieves information about an asset.

Public Method DescribeAssetCompositeModel(DescribeAssetCompositeModelRequest)

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.

Public Method DescribeAssetCompositeModelAsync(DescribeAssetCompositeModelRequest, CancellationToken)

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.

Public Method DescribeAssetModel(DescribeAssetModelRequest)

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.

Public Method DescribeAssetModelAsync(DescribeAssetModelRequest, CancellationToken)

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.

Public Method DescribeAssetModelCompositeModel(DescribeAssetModelCompositeModelRequest)

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.

Public Method DescribeAssetModelCompositeModelAsync(DescribeAssetModelCompositeModelRequest, CancellationToken)

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.

Public Method DescribeAssetModelInterfaceRelationship(DescribeAssetModelInterfaceRelationshipRequest)

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

Public Method DescribeAssetModelInterfaceRelationshipAsync(DescribeAssetModelInterfaceRelationshipRequest, CancellationToken)

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

Public Method DescribeAssetProperty(DescribeAssetPropertyRequest)

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.

Public Method DescribeAssetPropertyAsync(DescribeAssetPropertyRequest, CancellationToken)

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.

Public Method DescribeBulkImportJob(DescribeBulkImportJobRequest)

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.

Public Method DescribeBulkImportJobAsync(DescribeBulkImportJobRequest, CancellationToken)

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.

Public Method DescribeComputationModel(DescribeComputationModelRequest)

Retrieves information about a computation model.

Public Method DescribeComputationModelAsync(DescribeComputationModelRequest, CancellationToken)

Retrieves information about a computation model.

Public Method DescribeComputationModelExecutionSummary(DescribeComputationModelExecutionSummaryRequest)

Retrieves information about the execution summary of a computation model.

Public Method DescribeComputationModelExecutionSummaryAsync(DescribeComputationModelExecutionSummaryRequest, CancellationToken)

Retrieves information about the execution summary of a computation model.

Public Method DescribeDashboard(DescribeDashboardRequest)

Retrieves information about a dashboard.

Public Method DescribeDashboardAsync(DescribeDashboardRequest, CancellationToken)

Retrieves information about a dashboard.

Public Method DescribeDataset(DescribeDatasetRequest)

Retrieves information about a dataset.

Public Method DescribeDatasetAsync(DescribeDatasetRequest, CancellationToken)

Retrieves information about a dataset.

Public Method DescribeDefaultEncryptionConfiguration(DescribeDefaultEncryptionConfigurationRequest)

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.

Public Method DescribeDefaultEncryptionConfigurationAsync(DescribeDefaultEncryptionConfigurationRequest, CancellationToken)

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.

Public Method DescribeExecution(DescribeExecutionRequest)

Retrieves information about the execution.

Public Method DescribeExecutionAsync(DescribeExecutionRequest, CancellationToken)

Retrieves information about the execution.

Public Method DescribeGateway(DescribeGatewayRequest)

Retrieves information about a gateway.

Public Method DescribeGatewayAsync(DescribeGatewayRequest, CancellationToken)

Retrieves information about a gateway.

Public Method DescribeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest)

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.

Public Method DescribeGatewayCapabilityConfigurationAsync(DescribeGatewayCapabilityConfigurationRequest, CancellationToken)

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.

Public Method DescribeLoggingOptions(DescribeLoggingOptionsRequest)

Retrieves the current IoT SiteWise logging options.

Public Method DescribeLoggingOptionsAsync(DescribeLoggingOptionsRequest, CancellationToken)

Retrieves the current IoT SiteWise logging options.

Public Method DescribePortal(DescribePortalRequest)

Retrieves information about a portal.

Public Method DescribePortalAsync(DescribePortalRequest, CancellationToken)

Retrieves information about a portal.

Public Method DescribeProject(DescribeProjectRequest)

Retrieves information about a project.

Public Method DescribeProjectAsync(DescribeProjectRequest, CancellationToken)

Retrieves information about a project.

Public Method DescribeStorageConfiguration(DescribeStorageConfigurationRequest)

Retrieves information about the storage configuration for IoT SiteWise.

Public Method DescribeStorageConfigurationAsync(DescribeStorageConfigurationRequest, CancellationToken)

Retrieves information about the storage configuration for IoT SiteWise.

Public Method DescribeTimeSeries(DescribeTimeSeriesRequest)

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.

Public Method DescribeTimeSeriesAsync(DescribeTimeSeriesRequest, CancellationToken)

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.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method DisassociateAssets(DisassociateAssetsRequest)

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

Public Method DisassociateAssetsAsync(DisassociateAssetsRequest, CancellationToken)

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

Public Method DisassociateTimeSeriesFromAssetProperty(DisassociateTimeSeriesFromAssetPropertyRequest)

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

Public Method DisassociateTimeSeriesFromAssetPropertyAsync(DisassociateTimeSeriesFromAssetPropertyRequest, CancellationToken)

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

Public Method ExecuteAction(ExecuteActionRequest)

Executes an action on a target resource.

Public Method ExecuteActionAsync(ExecuteActionRequest, CancellationToken)

Executes an action on a target resource.

Public Method ExecuteQuery(ExecuteQueryRequest)

Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.

Public Method ExecuteQueryAsync(ExecuteQueryRequest, CancellationToken)

Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.

Public Method GetAssetPropertyAggregates(GetAssetPropertyAggregatesRequest)

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.

Public Method GetAssetPropertyAggregatesAsync(GetAssetPropertyAggregatesRequest, CancellationToken)

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.

Public Method GetAssetPropertyValue(GetAssetPropertyValueRequest)

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.

Public Method GetAssetPropertyValueAsync(GetAssetPropertyValueRequest, CancellationToken)

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.

Public Method GetAssetPropertyValueHistory(GetAssetPropertyValueHistoryRequest)

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.

Public Method GetAssetPropertyValueHistoryAsync(GetAssetPropertyValueHistoryRequest, CancellationToken)

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.

Public Method GetInterpolatedAssetPropertyValues(GetInterpolatedAssetPropertyValuesRequest)

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.

Public Method GetInterpolatedAssetPropertyValuesAsync(GetInterpolatedAssetPropertyValuesRequest, CancellationToken)

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.

Public Method InvokeAssistant(InvokeAssistantRequest)

Invokes SiteWise Assistant to start or continue a conversation.

Public Method InvokeAssistantAsync(InvokeAssistantRequest, CancellationToken)

Invokes SiteWise Assistant to start or continue a conversation.

Public Method ListAccessPolicies(ListAccessPoliciesRequest)

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

Public Method ListAccessPoliciesAsync(ListAccessPoliciesRequest, CancellationToken)

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

Public Method ListActions(ListActionsRequest)

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

Public Method ListActionsAsync(ListActionsRequest, CancellationToken)

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

Public Method ListAssetModelCompositeModels(ListAssetModelCompositeModelsRequest)

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

Public Method ListAssetModelCompositeModelsAsync(ListAssetModelCompositeModelsRequest, CancellationToken)

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

Public Method ListAssetModelProperties(ListAssetModelPropertiesRequest)

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.

Public Method ListAssetModelPropertiesAsync(ListAssetModelPropertiesRequest, CancellationToken)

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.

Public Method ListAssetModels(ListAssetModelsRequest)

Retrieves a paginated list of summaries of all asset models.

Public Method ListAssetModelsAsync(ListAssetModelsRequest, CancellationToken)

Retrieves a paginated list of summaries of all asset models.

Public Method ListAssetProperties(ListAssetPropertiesRequest)

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.

Public Method ListAssetPropertiesAsync(ListAssetPropertiesRequest, CancellationToken)

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.

Public Method ListAssetRelationships(ListAssetRelationshipsRequest)

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.

Public Method ListAssetRelationshipsAsync(ListAssetRelationshipsRequest, CancellationToken)

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.

Public Method ListAssets(ListAssetsRequest)

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.

Public Method ListAssetsAsync(ListAssetsRequest, CancellationToken)

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.

Public Method ListAssociatedAssets(ListAssociatedAssetsRequest)

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.

Public Method ListAssociatedAssetsAsync(ListAssociatedAssetsRequest, CancellationToken)

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.

Public Method ListBulkImportJobs(ListBulkImportJobsRequest)

Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.

Public Method ListBulkImportJobsAsync(ListBulkImportJobsRequest, CancellationToken)

Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.

Public Method ListCompositionRelationships(ListCompositionRelationshipsRequest)

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

Public Method ListCompositionRelationshipsAsync(ListCompositionRelationshipsRequest, CancellationToken)

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

Public Method ListComputationModelDataBindingUsages(ListComputationModelDataBindingUsagesRequest)

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.

Public Method ListComputationModelDataBindingUsagesAsync(ListComputationModelDataBindingUsagesRequest, CancellationToken)

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.

Public Method ListComputationModelResolveToResources(ListComputationModelResolveToResourcesRequest)

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

Public Method ListComputationModelResolveToResourcesAsync(ListComputationModelResolveToResourcesRequest, CancellationToken)

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

Public Method ListComputationModels(ListComputationModelsRequest)

Retrieves a paginated list of summaries of all computation models.

Public Method ListComputationModelsAsync(ListComputationModelsRequest, CancellationToken)

Retrieves a paginated list of summaries of all computation models.

Public Method ListDashboards(ListDashboardsRequest)

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

Public Method ListDashboardsAsync(ListDashboardsRequest, CancellationToken)

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

Public Method ListDatasets(ListDatasetsRequest)

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

Public Method ListDatasetsAsync(ListDatasetsRequest, CancellationToken)

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

Public Method ListExecutions(ListExecutionsRequest)

Retrieves a paginated list of summaries of all executions.

Public Method ListExecutionsAsync(ListExecutionsRequest, CancellationToken)

Retrieves a paginated list of summaries of all executions.

Public Method ListGateways(ListGatewaysRequest)

Retrieves a paginated list of gateways.

Public Method ListGatewaysAsync(ListGatewaysRequest, CancellationToken)

Retrieves a paginated list of gateways.

Public Method ListInterfaceRelationships(ListInterfaceRelationshipsRequest)

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

Public Method ListInterfaceRelationshipsAsync(ListInterfaceRelationshipsRequest, CancellationToken)

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

Public Method ListPortals(ListPortalsRequest)

Retrieves a paginated list of IoT SiteWise Monitor portals.

Public Method ListPortalsAsync(ListPortalsRequest, CancellationToken)

Retrieves a paginated list of IoT SiteWise Monitor portals.

Public Method ListProjectAssets(ListProjectAssetsRequest)

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

Public Method ListProjectAssetsAsync(ListProjectAssetsRequest, CancellationToken)

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

Public Method ListProjects(ListProjectsRequest)

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

Public Method ListProjectsAsync(ListProjectsRequest, CancellationToken)

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

Public Method ListTagsForResource(ListTagsForResourceRequest)

Retrieves the list of tags for an IoT SiteWise resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Retrieves the list of tags for an IoT SiteWise resource.

Public Method ListTimeSeries(ListTimeSeriesRequest)

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

Public Method ListTimeSeriesAsync(ListTimeSeriesRequest, CancellationToken)

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

Public Method PutAssetModelInterfaceRelationship(PutAssetModelInterfaceRelationshipRequest)

Creates or updates an interface relationship between an asset model and an interface asset model. This operation applies an interface to an asset model.

Public Method PutAssetModelInterfaceRelationshipAsync(PutAssetModelInterfaceRelationshipRequest, CancellationToken)

Creates or updates an interface relationship between an asset model and an interface asset model. This operation applies an interface to an asset model.

Public Method PutDefaultEncryptionConfiguration(PutDefaultEncryptionConfigurationRequest)

Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.

Public Method PutDefaultEncryptionConfigurationAsync(PutDefaultEncryptionConfigurationRequest, CancellationToken)

Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.

Public Method PutLoggingOptions(PutLoggingOptionsRequest)

Sets logging options for IoT SiteWise.

Public Method PutLoggingOptionsAsync(PutLoggingOptionsRequest, CancellationToken)

Sets logging options for IoT SiteWise.

Public Method PutStorageConfiguration(PutStorageConfigurationRequest)

Configures storage settings for IoT SiteWise.

Public Method PutStorageConfigurationAsync(PutStorageConfigurationRequest, CancellationToken)

Configures storage settings for IoT SiteWise.

Public Method TagResource(TagResourceRequest)

Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.

Public Method UntagResource(UntagResourceRequest)

Removes a tag from an IoT SiteWise resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes a tag from an IoT SiteWise resource.

Public Method UpdateAccessPolicy(UpdateAccessPolicyRequest)

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

Public Method UpdateAccessPolicyAsync(UpdateAccessPolicyRequest, CancellationToken)

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

Public Method UpdateAsset(UpdateAssetRequest)

Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.

Public Method UpdateAssetAsync(UpdateAssetRequest, CancellationToken)

Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.

Public Method UpdateAssetModel(UpdateAssetModelRequest)

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:

  1. Submit an UpdateAssetModel request with the entire existing property removed.

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

Public Method UpdateAssetModelAsync(UpdateAssetModelRequest, CancellationToken)

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:

  1. Submit an UpdateAssetModel request with the entire existing property removed.

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

Public Method UpdateAssetModelCompositeModel(UpdateAssetModelCompositeModelRequest)

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:

  1. Submit an UpdateAssetModelCompositeModel request with the entire existing property removed.

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

Public Method UpdateAssetModelCompositeModelAsync(UpdateAssetModelCompositeModelRequest, CancellationToken)

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:

  1. Submit an UpdateAssetModelCompositeModel request with the entire existing property removed.

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

Public Method UpdateAssetProperty(UpdateAssetPropertyRequest)

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.

Public Method UpdateAssetPropertyAsync(UpdateAssetPropertyRequest, CancellationToken)

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.

Public Method UpdateComputationModel(UpdateComputationModelRequest)

Updates the computation model.

Public Method UpdateComputationModelAsync(UpdateComputationModelRequest, CancellationToken)

Updates the computation model.

Public Method UpdateDashboard(UpdateDashboardRequest)

Updates an IoT SiteWise Monitor dashboard.

Public Method UpdateDashboardAsync(UpdateDashboardRequest, CancellationToken)

Updates an IoT SiteWise Monitor dashboard.

Public Method UpdateDataset(UpdateDatasetRequest)

Updates a dataset.

Public Method UpdateDatasetAsync(UpdateDatasetRequest, CancellationToken)

Updates a dataset.

Public Method UpdateGateway(UpdateGatewayRequest)

Updates a gateway's name.

Public Method UpdateGatewayAsync(UpdateGatewayRequest, CancellationToken)

Updates a gateway's name.

Public Method UpdateGatewayCapabilityConfiguration(UpdateGatewayCapabilityConfigurationRequest)

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.

Public Method UpdateGatewayCapabilityConfigurationAsync(UpdateGatewayCapabilityConfigurationRequest, CancellationToken)

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.

Public Method UpdatePortal(UpdatePortalRequest)

Updates an IoT SiteWise Monitor portal.

Public Method UpdatePortalAsync(UpdatePortalRequest, CancellationToken)

Updates an IoT SiteWise Monitor portal.

Public Method UpdateProject(UpdateProjectRequest)

Updates an IoT SiteWise Monitor project.

Public Method UpdateProjectAsync(UpdateProjectRequest, CancellationToken)

Updates an IoT SiteWise Monitor project.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5