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.Namespace: Amazon.IoTSiteWise
Assembly: AWSSDK.IoTSiteWise.dll
Version: 3.x.y.z
public interface IAmazonIoTSiteWise IAmazonService, IDisposable
The IAmazonIoTSiteWise type exposes the following members
Name | Type | Description | |
---|---|---|---|
![]() |
Paginators | Amazon.IoTSiteWise.Model.IIoTSiteWisePaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
![]() |
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. |
![]() |
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. |
![]() |
AssociateTimeSeriesToAssetProperty(AssociateTimeSeriesToAssetPropertyRequest) |
Associates a time series (data stream) with an asset property. |
![]() |
AssociateTimeSeriesToAssetPropertyAsync(AssociateTimeSeriesToAssetPropertyRequest, CancellationToken) |
Associates a time series (data stream) with an asset property. |
![]() |
BatchAssociateProjectAssets(BatchAssociateProjectAssetsRequest) |
Associates a group (batch) of assets with an IoT SiteWise Monitor project. |
![]() |
BatchAssociateProjectAssetsAsync(BatchAssociateProjectAssetsRequest, CancellationToken) |
Associates a group (batch) of assets with an IoT SiteWise Monitor project. |
![]() |
BatchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest) |
Disassociates a group (batch) of assets from an IoT SiteWise Monitor project. |
![]() |
BatchDisassociateProjectAssetsAsync(BatchDisassociateProjectAssetsRequest, CancellationToken) |
Disassociates a group (batch) of assets from an IoT SiteWise Monitor project. |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
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:
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
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
IoT SiteWise authorizes access to each |
![]() |
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:
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
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
IoT SiteWise authorizes access to each |
![]() |
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.
|
![]() |
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.
|
![]() |
CreateAsset(CreateAssetRequest) |
Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide. |
![]() |
CreateAssetAsync(CreateAssetRequest, CancellationToken) |
Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide. |
![]() |
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,
|
![]() |
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,
|
![]() |
CreateAssetModelCompositeModel(CreateAssetModelCompositeModelRequest) |
Creates a custom composite model from specified property and hierarchy definitions.
There are two types of custom composite models, 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
To create an inline model, specify the |
![]() |
CreateAssetModelCompositeModelAsync(CreateAssetModelCompositeModelRequest, CancellationToken) |
Creates a custom composite model from specified property and hierarchy definitions.
There are two types of custom composite models, 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
To create an inline model, specify the |
![]() |
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.
|
![]() |
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.
|
![]() |
CreateComputationModel(CreateComputationModelRequest) |
Create a computation model with a configuration and data binding. |
![]() |
CreateComputationModelAsync(CreateComputationModelRequest, CancellationToken) |
Create a computation model with a configuration and data binding. |
![]() |
CreateDashboard(CreateDashboardRequest) |
Creates a dashboard in an IoT SiteWise Monitor project. |
![]() |
CreateDashboardAsync(CreateDashboardRequest, CancellationToken) |
Creates a dashboard in an IoT SiteWise Monitor project. |
![]() |
CreateDataset(CreateDatasetRequest) |
Creates a dataset to connect an external datasource. |
![]() |
CreateDatasetAsync(CreateDatasetRequest, CancellationToken) |
Creates a dataset to connect an external datasource. |
![]() |
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. |
![]() |
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. |
![]() |
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.
|
![]() |
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.
|
![]() |
CreateProject(CreateProjectRequest) |
Creates a project in the specified portal.
Make sure that the project name and description don't contain confidential information.
|
![]() |
CreateProjectAsync(CreateProjectRequest, CancellationToken) |
Creates a project in the specified portal.
Make sure that the project name and description don't contain confidential information.
|
![]() |
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. |
![]() |
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. |
![]() |
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.
|
![]() |
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.
|
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
DeleteAssetModelInterfaceRelationship(DeleteAssetModelInterfaceRelationshipRequest) |
Deletes an interface relationship between an asset model and an interface asset model. |
![]() |
DeleteAssetModelInterfaceRelationshipAsync(DeleteAssetModelInterfaceRelationshipRequest, CancellationToken) |
Deletes an interface relationship between an asset model and an interface asset model. |
![]() |
DeleteComputationModel(DeleteComputationModelRequest) |
Deletes a computation model. This action can't be undone. |
![]() |
DeleteComputationModelAsync(DeleteComputationModelRequest, CancellationToken) |
Deletes a computation model. This action can't be undone. |
![]() |
DeleteDashboard(DeleteDashboardRequest) |
Deletes a dashboard from IoT SiteWise Monitor. |
![]() |
DeleteDashboardAsync(DeleteDashboardRequest, CancellationToken) |
Deletes a dashboard from IoT SiteWise Monitor. |
![]() |
DeleteDataset(DeleteDatasetRequest) |
Deletes a dataset. This cannot be undone. |
![]() |
DeleteDatasetAsync(DeleteDatasetRequest, CancellationToken) |
Deletes a dataset. This cannot be undone. |
![]() |
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. |
![]() |
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. |
![]() |
DeletePortal(DeletePortalRequest) |
Deletes a portal from IoT SiteWise Monitor. |
![]() |
DeletePortalAsync(DeletePortalRequest, CancellationToken) |
Deletes a portal from IoT SiteWise Monitor. |
![]() |
DeleteProject(DeleteProjectRequest) |
Deletes a project from IoT SiteWise Monitor. |
![]() |
DeleteProjectAsync(DeleteProjectRequest, CancellationToken) |
Deletes a project from IoT SiteWise Monitor. |
![]() |
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:
|
![]() |
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:
|
![]() |
DescribeAccessPolicy(DescribeAccessPolicyRequest) |
Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project. |
![]() |
DescribeAccessPolicyAsync(DescribeAccessPolicyRequest, CancellationToken) |
Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project. |
![]() |
DescribeAction(DescribeActionRequest) |
Retrieves information about an action. |
![]() |
DescribeActionAsync(DescribeActionRequest, CancellationToken) |
Retrieves information about an action. |
![]() |
DescribeAsset(DescribeAssetRequest) |
Retrieves information about an asset. |
![]() |
DescribeAssetAsync(DescribeAssetRequest, CancellationToken) |
Retrieves information about an asset. |
![]() |
DescribeAssetCompositeModel(DescribeAssetCompositeModelRequest) |
Retrieves information about an asset composite model (also known as an asset component).
An |
![]() |
DescribeAssetCompositeModelAsync(DescribeAssetCompositeModelRequest, CancellationToken) |
Retrieves information about an asset composite model (also known as an asset component).
An |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
DescribeAssetModelInterfaceRelationship(DescribeAssetModelInterfaceRelationshipRequest) |
Retrieves information about an interface relationship between an asset model and an interface asset model. |
![]() |
DescribeAssetModelInterfaceRelationshipAsync(DescribeAssetModelInterfaceRelationshipRequest, CancellationToken) |
Retrieves information about an interface relationship between an asset model and an interface asset model. |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
DescribeComputationModel(DescribeComputationModelRequest) |
Retrieves information about a computation model. |
![]() |
DescribeComputationModelAsync(DescribeComputationModelRequest, CancellationToken) |
Retrieves information about a computation model. |
![]() |
DescribeComputationModelExecutionSummary(DescribeComputationModelExecutionSummaryRequest) |
Retrieves information about the execution summary of a computation model. |
![]() |
DescribeComputationModelExecutionSummaryAsync(DescribeComputationModelExecutionSummaryRequest, CancellationToken) |
Retrieves information about the execution summary of a computation model. |
![]() |
DescribeDashboard(DescribeDashboardRequest) |
Retrieves information about a dashboard. |
![]() |
DescribeDashboardAsync(DescribeDashboardRequest, CancellationToken) |
Retrieves information about a dashboard. |
![]() |
DescribeDataset(DescribeDatasetRequest) |
Retrieves information about a dataset. |
![]() |
DescribeDatasetAsync(DescribeDatasetRequest, CancellationToken) |
Retrieves information about a dataset. |
![]() |
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. |
![]() |
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. |
![]() |
DescribeExecution(DescribeExecutionRequest) |
Retrieves information about the execution. |
![]() |
DescribeExecutionAsync(DescribeExecutionRequest, CancellationToken) |
Retrieves information about the execution. |
![]() |
DescribeGateway(DescribeGatewayRequest) |
Retrieves information about a gateway. |
![]() |
DescribeGatewayAsync(DescribeGatewayRequest, CancellationToken) |
Retrieves information about a gateway. |
![]() |
DescribeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest) |
Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.
. The namespace follows the format
After updating a capability configuration, the sync status becomes A gateway can have multiple capability configurations with different namespaces. |
![]() |
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
After updating a capability configuration, the sync status becomes A gateway can have multiple capability configurations with different namespaces. |
![]() |
DescribeLoggingOptions(DescribeLoggingOptionsRequest) |
Retrieves the current IoT SiteWise logging options. |
![]() |
DescribeLoggingOptionsAsync(DescribeLoggingOptionsRequest, CancellationToken) |
Retrieves the current IoT SiteWise logging options. |
![]() |
DescribePortal(DescribePortalRequest) |
Retrieves information about a portal. |
![]() |
DescribePortalAsync(DescribePortalRequest, CancellationToken) |
Retrieves information about a portal. |
![]() |
DescribeProject(DescribeProjectRequest) |
Retrieves information about a project. |
![]() |
DescribeProjectAsync(DescribeProjectRequest, CancellationToken) |
Retrieves information about a project. |
![]() |
DescribeStorageConfiguration(DescribeStorageConfigurationRequest) |
Retrieves information about the storage configuration for IoT SiteWise. |
![]() |
DescribeStorageConfigurationAsync(DescribeStorageConfigurationRequest, CancellationToken) |
Retrieves information about the storage configuration for IoT SiteWise. |
![]() |
DescribeTimeSeries(DescribeTimeSeriesRequest) |
Retrieves information about a time series (data stream). To identify a time series, do one of the following:
|
![]() |
DescribeTimeSeriesAsync(DescribeTimeSeriesRequest, CancellationToken) |
Retrieves information about a time series (data stream). To identify a time series, do one of the following:
|
![]() |
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
![]() |
DisassociateAssets(DisassociateAssetsRequest) |
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model. |
![]() |
DisassociateAssetsAsync(DisassociateAssetsRequest, CancellationToken) |
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model. |
![]() |
DisassociateTimeSeriesFromAssetProperty(DisassociateTimeSeriesFromAssetPropertyRequest) |
Disassociates a time series (data stream) from an asset property. |
![]() |
DisassociateTimeSeriesFromAssetPropertyAsync(DisassociateTimeSeriesFromAssetPropertyRequest, CancellationToken) |
Disassociates a time series (data stream) from an asset property. |
![]() |
ExecuteAction(ExecuteActionRequest) |
Executes an action on a target resource. |
![]() |
ExecuteActionAsync(ExecuteActionRequest, CancellationToken) |
Executes an action on a target resource. |
![]() |
ExecuteQuery(ExecuteQueryRequest) |
Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates. |
![]() |
ExecuteQueryAsync(ExecuteQueryRequest, CancellationToken) |
Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates. |
![]() |
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:
|
![]() |
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:
|
![]() |
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:
|
![]() |
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:
|
![]() |
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:
|
![]() |
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:
|
![]() |
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:
|
![]() |
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:
|
![]() |
InvokeAssistant(InvokeAssistantRequest) |
Invokes SiteWise Assistant to start or continue a conversation. |
![]() |
InvokeAssistantAsync(InvokeAssistantRequest, CancellationToken) |
Invokes SiteWise Assistant to start or continue a conversation. |
![]() |
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). |
![]() |
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). |
![]() |
ListActions(ListActionsRequest) |
Retrieves a paginated list of actions for a specific target resource. |
![]() |
ListActionsAsync(ListActionsRequest, CancellationToken) |
Retrieves a paginated list of actions for a specific target resource. |
![]() |
ListAssetModelCompositeModels(ListAssetModelCompositeModelsRequest) |
Retrieves a paginated list of composite models associated with the asset model |
![]() |
ListAssetModelCompositeModelsAsync(ListAssetModelCompositeModelsRequest, CancellationToken) |
Retrieves a paginated list of composite models associated with the asset model |
![]() |
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. |
![]() |
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. |
![]() |
ListAssetModels(ListAssetModelsRequest) |
Retrieves a paginated list of summaries of all asset models. |
![]() |
ListAssetModelsAsync(ListAssetModelsRequest, CancellationToken) |
Retrieves a paginated list of summaries of all asset models. |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
ListAssets(ListAssetsRequest) |
Retrieves a paginated list of asset summaries. You can use this operation to do the following:
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. |
![]() |
ListAssetsAsync(ListAssetsRequest, CancellationToken) |
Retrieves a paginated list of asset summaries. You can use this operation to do the following:
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. |
![]() |
ListAssociatedAssets(ListAssociatedAssetsRequest) |
Retrieves a paginated list of associated assets. You can use this operation to do the following:
|
![]() |
ListAssociatedAssetsAsync(ListAssociatedAssetsRequest, CancellationToken) |
Retrieves a paginated list of associated assets. You can use this operation to do the following:
|
![]() |
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. |
![]() |
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. |
![]() |
ListCompositionRelationships(ListCompositionRelationshipsRequest) |
Retrieves a paginated list of composition relationships for an asset model of type
|
![]() |
ListCompositionRelationshipsAsync(ListCompositionRelationshipsRequest, CancellationToken) |
Retrieves a paginated list of composition relationships for an asset model of type
|
![]() |
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. |
![]() |
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. |
![]() |
ListComputationModelResolveToResources(ListComputationModelResolveToResourcesRequest) |
Lists all distinct resources that are resolved from the executed actions of the computation model. |
![]() |
ListComputationModelResolveToResourcesAsync(ListComputationModelResolveToResourcesRequest, CancellationToken) |
Lists all distinct resources that are resolved from the executed actions of the computation model. |
![]() |
ListComputationModels(ListComputationModelsRequest) |
Retrieves a paginated list of summaries of all computation models. |
![]() |
ListComputationModelsAsync(ListComputationModelsRequest, CancellationToken) |
Retrieves a paginated list of summaries of all computation models. |
![]() |
ListDashboards(ListDashboardsRequest) |
Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project. |
![]() |
ListDashboardsAsync(ListDashboardsRequest, CancellationToken) |
Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project. |
![]() |
ListDatasets(ListDatasetsRequest) |
Retrieves a paginated list of datasets for a specific target resource. |
![]() |
ListDatasetsAsync(ListDatasetsRequest, CancellationToken) |
Retrieves a paginated list of datasets for a specific target resource. |
![]() |
ListExecutions(ListExecutionsRequest) |
Retrieves a paginated list of summaries of all executions. |
![]() |
ListExecutionsAsync(ListExecutionsRequest, CancellationToken) |
Retrieves a paginated list of summaries of all executions. |
![]() |
ListGateways(ListGatewaysRequest) |
Retrieves a paginated list of gateways. |
![]() |
ListGatewaysAsync(ListGatewaysRequest, CancellationToken) |
Retrieves a paginated list of gateways. |
![]() |
ListInterfaceRelationships(ListInterfaceRelationshipsRequest) |
Retrieves a paginated list of asset models that have a specific interface asset model applied to them. |
![]() |
ListInterfaceRelationshipsAsync(ListInterfaceRelationshipsRequest, CancellationToken) |
Retrieves a paginated list of asset models that have a specific interface asset model applied to them. |
![]() |
ListPortals(ListPortalsRequest) |
Retrieves a paginated list of IoT SiteWise Monitor portals. |
![]() |
ListPortalsAsync(ListPortalsRequest, CancellationToken) |
Retrieves a paginated list of IoT SiteWise Monitor portals. |
![]() |
ListProjectAssets(ListProjectAssetsRequest) |
Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project. |
![]() |
ListProjectAssetsAsync(ListProjectAssetsRequest, CancellationToken) |
Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project. |
![]() |
ListProjects(ListProjectsRequest) |
Retrieves a paginated list of projects for an IoT SiteWise Monitor portal. |
![]() |
ListProjectsAsync(ListProjectsRequest, CancellationToken) |
Retrieves a paginated list of projects for an IoT SiteWise Monitor portal. |
![]() |
ListTagsForResource(ListTagsForResourceRequest) |
Retrieves the list of tags for an IoT SiteWise resource. |
![]() |
ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) |
Retrieves the list of tags for an IoT SiteWise resource. |
![]() |
ListTimeSeries(ListTimeSeriesRequest) |
Retrieves a paginated list of time series (data streams). |
![]() |
ListTimeSeriesAsync(ListTimeSeriesRequest, CancellationToken) |
Retrieves a paginated list of time series (data streams). |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
PutLoggingOptions(PutLoggingOptionsRequest) |
Sets logging options for IoT SiteWise. |
![]() |
PutLoggingOptionsAsync(PutLoggingOptionsRequest, CancellationToken) |
Sets logging options for IoT SiteWise. |
![]() |
PutStorageConfiguration(PutStorageConfigurationRequest) |
Configures storage settings for IoT SiteWise. |
![]() |
PutStorageConfigurationAsync(PutStorageConfigurationRequest, CancellationToken) |
Configures storage settings for IoT SiteWise. |
![]() |
TagResource(TagResourceRequest) |
Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value. |
![]() |
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. |
![]() |
UntagResource(UntagResourceRequest) |
Removes a tag from an IoT SiteWise resource. |
![]() |
UntagResourceAsync(UntagResourceRequest, CancellationToken) |
Removes a tag from an IoT SiteWise resource. |
![]() |
UpdateAccessPolicy(UpdateAccessPolicyRequest) |
Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource. |
![]() |
UpdateAccessPolicyAsync(UpdateAccessPolicyRequest, CancellationToken) |
Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource. |
![]() |
UpdateAsset(UpdateAssetRequest) |
Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide. |
![]() |
UpdateAssetAsync(UpdateAssetRequest, CancellationToken) |
Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide. |
![]() |
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
Submit an
Submit a second |
![]() |
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
Submit an
Submit a second |
![]() |
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
Submit an
Submit a second |
![]() |
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
Submit an
Submit a second |
![]() |
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.
|
![]() |
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.
|
![]() |
UpdateComputationModel(UpdateComputationModelRequest) |
Updates the computation model. |
![]() |
UpdateComputationModelAsync(UpdateComputationModelRequest, CancellationToken) |
Updates the computation model. |
![]() |
UpdateDashboard(UpdateDashboardRequest) |
Updates an IoT SiteWise Monitor dashboard. |
![]() |
UpdateDashboardAsync(UpdateDashboardRequest, CancellationToken) |
Updates an IoT SiteWise Monitor dashboard. |
![]() |
UpdateDataset(UpdateDatasetRequest) |
Updates a dataset. |
![]() |
UpdateDatasetAsync(UpdateDatasetRequest, CancellationToken) |
Updates a dataset. |
![]() |
UpdateGateway(UpdateGatewayRequest) |
Updates a gateway's name. |
![]() |
UpdateGatewayAsync(UpdateGatewayRequest, CancellationToken) |
Updates a gateway's name. |
![]() |
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
After updating a capability configuration, the sync status becomes A gateway can have multiple capability configurations with different namespaces. |
![]() |
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
After updating a capability configuration, the sync status becomes A gateway can have multiple capability configurations with different namespaces. |
![]() |
UpdatePortal(UpdatePortalRequest) |
Updates an IoT SiteWise Monitor portal. |
![]() |
UpdatePortalAsync(UpdatePortalRequest, CancellationToken) |
Updates an IoT SiteWise Monitor portal. |
![]() |
UpdateProject(UpdateProjectRequest) |
Updates an IoT SiteWise Monitor project. |
![]() |
UpdateProjectAsync(UpdateProjectRequest, CancellationToken) |
Updates an IoT SiteWise Monitor project. |
.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