AWS.IoTSiteWise — AWS SDK for JavaScript (original) (raw)

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

associateAssets(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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

batchAssociateProjectAssets(params = {}, callback) ⇒ AWS.Request

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

batchDisassociateProjectAssets(params = {}, callback) ⇒ AWS.Request

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

batchGetAssetPropertyAggregates(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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

batchGetAssetPropertyValueHistory(params = {}, callback) ⇒ AWS.Request

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

batchPutAssetPropertyValue(params = {}, callback) ⇒ AWS.Request

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

createAccessPolicy(params = {}, callback) ⇒ AWS.Request

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.

createAsset(params = {}, callback) ⇒ AWS.Request

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

createAssetModel(params = {}, callback) ⇒ AWS.Request

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

createAssetModelCompositeModel(params = {}, callback) ⇒ AWS.Request

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.

createBulkImportJob(params = {}, callback) ⇒ AWS.Request

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. It does not trigger computations or notifications on IoT SiteWise warm or cold tier storage.

createDashboard(params = {}, callback) ⇒ AWS.Request

Creates a dashboard in an IoT SiteWise Monitor project.

createGateway(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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.

Note: 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(params = {}, callback) ⇒ AWS.Request

Creates a project in the specified portal.

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

deleteAccessPolicy(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

Note: You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.

deleteAssetModel(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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.

deleteDashboard(params = {}, callback) ⇒ AWS.Request

Deletes a dashboard from IoT SiteWise Monitor.

deleteGateway(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

Deletes a portal from IoT SiteWise Monitor.

deleteProject(params = {}, callback) ⇒ AWS.Request

Deletes a project from IoT SiteWise Monitor.

deleteTimeSeries(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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

describeAction(params = {}, callback) ⇒ AWS.Request

Retrieves information about an action.

describeAsset(params = {}, callback) ⇒ AWS.Request

Retrieves information about an asset.

describeAssetCompositeModel(params = {}, callback) ⇒ AWS.Request

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.

describeAssetModel(params = {}, callback) ⇒ AWS.Request

Retrieves information about an asset model.

describeAssetModelCompositeModel(params = {}, callback) ⇒ AWS.Request

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.

describeAssetProperty(params = {}, callback) ⇒ AWS.Request

Retrieves information about an asset property.

Note: 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(params = {}, callback) ⇒ AWS.Request

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.

describeDashboard(params = {}, callback) ⇒ AWS.Request

Retrieves information about a dashboard.

describeDefaultEncryptionConfiguration(params = {}, callback) ⇒ AWS.Request

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.

describeGateway(params = {}, callback) ⇒ AWS.Request

Retrieves information about a gateway.

describeGatewayCapabilityConfiguration(params = {}, callback) ⇒ AWS.Request

Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.

describeLoggingOptions(params = {}, callback) ⇒ AWS.Request

Retrieves the current IoT SiteWise logging options.

describePortal(params = {}, callback) ⇒ AWS.Request

Retrieves information about a portal.

describeProject(params = {}, callback) ⇒ AWS.Request

Retrieves information about a project.

describeStorageConfiguration(params = {}, callback) ⇒ AWS.Request

Retrieves information about the storage configuration for IoT SiteWise.

describeTimeSeries(params = {}, callback) ⇒ AWS.Request

Retrieves information about a time series (data stream).

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

disassociateAssets(params = {}, callback) ⇒ AWS.Request

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

disassociateTimeSeriesFromAssetProperty(params = {}, callback) ⇒ AWS.Request

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

executeAction(params = {}, callback) ⇒ AWS.Request

Executes an action on a target resource.

executeQuery(params = {}, callback) ⇒ AWS.Request

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

getAssetPropertyAggregates(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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:

listAccessPolicies(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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

listAssetModelCompositeModels(params = {}, callback) ⇒ AWS.Request

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

listAssetModelProperties(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

Retrieves a paginated list of summaries of all asset models.

listAssetProperties(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

Retrieves a paginated list of associated assets.

You can use this operation to do the following:

listBulkImportJobs(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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

listDashboards(params = {}, callback) ⇒ AWS.Request

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

listGateways(params = {}, callback) ⇒ AWS.Request

Retrieves a paginated list of gateways.

listPortals(params = {}, callback) ⇒ AWS.Request

Retrieves a paginated list of IoT SiteWise Monitor portals.

listProjectAssets(params = {}, callback) ⇒ AWS.Request

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

listProjects(params = {}, callback) ⇒ AWS.Request

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Retrieves the list of tags for an IoT SiteWise resource.

listTimeSeries(params = {}, callback) ⇒ AWS.Request

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

putDefaultEncryptionConfiguration(params = {}, callback) ⇒ AWS.Request

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

putLoggingOptions(params = {}, callback) ⇒ AWS.Request

Sets logging options for IoT SiteWise.

putStorageConfiguration(params = {}, callback) ⇒ AWS.Request

Configures storage settings for IoT SiteWise.

tagResource(params = {}, callback) ⇒ AWS.Request

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

untagResource(params = {}, callback) ⇒ AWS.Request

Removes a tag from an IoT SiteWise resource.

updateAccessPolicy(params = {}, callback) ⇒ AWS.Request

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

updateAssetModel(params = {}, callback) ⇒ AWS.Request

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.

updateAssetModelCompositeModel(params = {}, callback) ⇒ AWS.Request

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.

updateAssetProperty(params = {}, callback) ⇒ AWS.Request

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.

updateDashboard(params = {}, callback) ⇒ AWS.Request

Updates an IoT SiteWise Monitor dashboard.

updateGateway(params = {}, callback) ⇒ AWS.Request

Updates a gateway's name.

updateGatewayCapabilityConfiguration(params = {}, callback) ⇒ AWS.Request

Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.

updatePortal(params = {}, callback) ⇒ AWS.Request

Updates an IoT SiteWise Monitor portal.

updateProject(params = {}, callback) ⇒ AWS.Request

Updates an IoT SiteWise Monitor project.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given IoTSiteWise resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.