View Source aws_iotsitewise (aws v0.3.1)
Welcome to the AWS IoT SiteWise API Reference.
AWS IoT SiteWise is an AWS service that connects Industrial Internet of Things (IIoT) devices to the power of the AWS Cloud. For more information, see the AWS IoT SiteWise User Guide. For information about AWS IoT SiteWise quotas, see Quotas in the AWS IoT SiteWise User Guide.Link to this section Summary
Functions
Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model.
Sends a list of asset property values to AWS IoT SiteWise.
Creates an asset from an existing asset model.
Creates an asset model from specified property and hierarchy definitions.
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise.
Creates a portal, which can contain projects and dashboards.
Deletes an access policy that grants the specified identity access to the specified AWS IoT SiteWise Monitor resource.
Deletes an asset.
Deletes an asset model.
Deletes a gateway from AWS IoT SiteWise.
Retrieves information about an asset property.
Retrieves information about the default encryption configuration for the AWS account in the default or specified region.
Retrieves information about a gateway capability configuration.
Gets aggregated values for an asset property.
Gets an asset property's current value.
Gets the history of an asset property's values.
Retrieves a paginated list of asset relationships for an asset.
Retrieves a paginated list of asset summaries.
Retrieves a paginated list of associated assets.
Sets the default encryption configuration for the AWS account.
Adds tags to an AWS IoT SiteWise resource.
Updates an asset's name.
Updates an asset model and all of the assets that were created from the model.
Updates an asset property's alias and notification state.
Updates a gateway capability configuration or defines a new capability configuration.
Link to this section Functions
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 AWS IoT SiteWise User Guide.batch_associate_project_assets(Client, ProjectId, Input0, Options0)
View Sourcebatch_disassociate_project_assets(Client, ProjectId, Input0, Options0)
View SourceSends a list of asset property values to AWS IoT SiteWise.
Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The
assetIdandpropertyIdof 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, AWS IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 5 minutes in the future. AWS IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +5 minutes] and returns a TimestampOutOfRangeException error.
For each asset property, AWS 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.
BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the AWS IoT SiteWise User Guide.
Creates an asset from an existing asset model.
For more information, see Creating assets in the AWS IoT SiteWise User Guide.Creates an asset model from specified property and hierarchy definitions.
You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the AWS IoT SiteWise User Guide.Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise.
For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide.Creates a portal, which can contain projects and dashboards.
AWS IoT SiteWise Monitor uses AWS SSO 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 AWS IoT SiteWise User Guide.Deletes an access policy that grants the specified identity access to the specified AWS IoT SiteWise Monitor resource.
You can use this operation to revoke access to an AWS IoT SiteWise Monitor resource.Deletes an asset.
This action can't be undone. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide.
You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.Deletes an asset model.
This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide.Deletes a gateway from AWS IoT SiteWise.
When you delete a gateway, some of the gateway's files remain in your gateway's file system.describe_access_policy(Client, AccessPolicyId, QueryMap, HeadersMap)
View Sourcedescribe_access_policy(Client, AccessPolicyId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_asset_model(Client, AssetModelId, QueryMap, HeadersMap, Options0)
View SourceRetrieves 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.describe_asset_property(Client, AssetId, PropertyId, QueryMap, HeadersMap)
View Sourcedescribe_asset_property(Client, AssetId, PropertyId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_dashboard(Client, DashboardId, QueryMap, HeadersMap, Options0)
View SourceRetrieves information about the default encryption configuration for the AWS account in the default or specified region.
For more information, see Key management in the AWS IoT SiteWise User Guide.describe_default_encryption_configuration(Client, QueryMap, HeadersMap)
View Sourcedescribe_default_encryption_configuration(Client, QueryMap, HeadersMap, Options0)
View Sourcedescribe_gateway(Client, GatewayId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_gateway_capability_configuration(Client, CapabilityNamespace, GatewayId)
View SourceRetrieves 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 AWS 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.describe_gateway_capability_configuration(Client, CapabilityNamespace, GatewayId, QueryMap, HeadersMap)
View Sourcedescribe_gateway_capability_configuration(Client, CapabilityNamespace, GatewayId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_project(Client, ProjectId, QueryMap, HeadersMap, Options0)
View Sourceget_asset_property_aggregates(Client, AggregateTypes, EndDate, Resolution, StartDate)
View SourceGets aggregated values for an asset property.
For more information, see Querying aggregates in the AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The
assetIdandpropertyIdof 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.
get_asset_property_aggregates(Client, AggregateTypes, EndDate, Resolution, StartDate, QueryMap, HeadersMap)
View Sourceget_asset_property_aggregates(Client, AggregateTypes, EndDate, Resolution, StartDate, QueryMap, HeadersMap, Options0)
View SourceGets an asset property's current value.
For more information, see Querying current values in the AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The
assetIdandpropertyIdof an asset property.A
propertyAlias, which is a data stream alias (for example,/company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
Gets the history of an asset property's values.
For more information, see Querying historical values in the AWS IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The
assetIdandpropertyIdof 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.
get_asset_property_value_history(Client, QueryMap, HeadersMap, Options0)
View SourceRetrieves 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.list_asset_relationships(Client, AssetId, TraversalType, QueryMap, HeadersMap)
View Sourcelist_asset_relationships(Client, AssetId, TraversalType, QueryMap, HeadersMap, Options0)
View SourceRetrieves 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.
Retrieves a paginated list of associated assets.
You can use this operation to do the following:
List child assets associated to a parent asset by a hierarchy that you specify.
List an asset's parent asset.
list_associated_assets(Client, AssetId, QueryMap, HeadersMap, Options0)
View Sourcelist_dashboards(Client, ProjectId, QueryMap, HeadersMap, Options0)
View Sourcelist_project_assets(Client, ProjectId, QueryMap, HeadersMap, Options0)
View Sourcelist_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View SourceSets the default encryption configuration for the AWS account.
For more information, see Key management in the AWS IoT SiteWise User Guide.Adds tags to an AWS IoT SiteWise resource.
If a tag already exists for the resource, this operation updates the tag's value.Updates an asset's name.
For more information, see Updating assets and models in the AWS IoT SiteWise User Guide.Updates an asset model and all of the assets that were created from the model.
Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the AWS IoT SiteWise User Guide.
This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel.
If you remove a property from an asset model, AWS IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, AWS IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.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.update_asset_property(Client, AssetId, PropertyId, Input0, Options0)
View SourceUpdates 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 AWS 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.