View Source aws_iotsitewise (aws v1.0.4)
Welcome to the IoT SiteWise API Reference.
IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things (IIoT): https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications devices to the power of the Amazon Web Services Cloud. For more information, see the IoT SiteWise User Guide: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/. For information about IoT SiteWise quotas, see Quotas: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html in the IoT SiteWise User Guide.Summary
Functions
Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model.
Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties.
Gets the current value for one or more asset properties.
Gets the historical values for one or more asset properties.
Sends a list of asset property values to IoT SiteWise.
Creates an asset from an existing asset model.
Creates an asset model from specified property and hierarchy definitions.
Creates a custom composite model from specified property and hierarchy definitions.
Defines a job to ingest data to IoT SiteWise from Amazon S3.
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise.
Creates a portal, which can contain projects and dashboards.
Creates a project in the specified portal.
Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource.
Deletes an asset.
Deletes an asset model.
Deletes a composite model.
Deletes a gateway from IoT SiteWise.
Deletes a time series (data stream).
Retrieves information about an asset composite model (also known as an asset component).
Retrieves information about an asset model composite model (also known as an asset model component).
Retrieves information about an asset property.
Retrieves information about a bulk import job request.
Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region.
Retrieves information about a gateway capability configuration.
Retrieves information about a time series (data stream).
Gets aggregated values for an asset property.
Gets an asset property's current value.
Gets the history of an asset property's values.
Get interpolated values for an asset property for a specified time interval, during a period of time.
Retrieves a paginated list of properties associated with an asset model.
Retrieves a paginated list of properties associated with an asset.
Retrieves a paginated list of asset relationships for an asset.
Retrieves a paginated list of asset summaries.
Retrieves a paginated list of associated assets.
Retrieves a paginated list of bulk import job requests.
COMPONENT_MODEL
.Sets the default encryption configuration for the Amazon Web Services account.
Adds tags to an IoT SiteWise resource.
Updates an asset's name.
Updates an asset model and all of the assets that were created from the model.
Updates a composite 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.
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: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html in the IoT SiteWise User Guide.batch_associate_project_assets(Client, ProjectId, Input0, Options0)
View Sourcebatch_disassociate_project_assets(Client, ProjectId, Input0, Options0)
View SourceGets aggregated values (for example, average, minimum, and maximum) for one or more asset properties.
For more information, see Querying aggregates: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates in the IoT SiteWise User Guide.Gets the current value for one or more asset properties.
For more information, see Querying current values: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values in the IoT SiteWise User Guide.Gets the historical values for one or more asset properties.
For more information, see Querying historical values: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values in the IoT SiteWise User Guide.Sends a list of asset property values to IoT SiteWise.
Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The
assetId
andpropertyId
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: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html.
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.
BatchPutAssetPropertyValue
entry individually. For more information, see BatchPutAssetPropertyValue authorization: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-batchputassetpropertyvalue-action in the IoT SiteWise User Guide.
Creates an asset from an existing asset model.
For more information, see Creating assets: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html in the IoT SiteWise User Guide.Creates an asset model from specified property and hierarchy definitions.
You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html in the IoT SiteWise User Guide.
You can create two types of asset models, ASSET_MODEL
or COMPONENT_MODEL
.
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.
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): https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html 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
.
assetModelCompositeModelProperties
and don't include an composedAssetModelId
.
create_asset_model_composite_model(Client, AssetModelId, Input0, Options0)
View SourceDefines a job to ingest data to IoT SiteWise from Amazon S3.
For more information, see Create a bulk import job (CLI): https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html 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: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html.
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.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: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html in the IoT SiteWise User Guide.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: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins in the IoT SiteWise User Guide.Creates a project in the specified portal.
Make sure that the project name and description don't contain confidential information.Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource.
You can use this operation to revoke access to an IoT SiteWise Monitor resource.Deletes an asset.
This action can't be undone. For more information, see Deleting assets and models: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html in the IoT SiteWise User Guide.
You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DisassociateAssets.html.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: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html in the IoT SiteWise User Guide.delete_asset_model_composite_model(Client, AssetModelCompositeModelId, AssetModelId, Input)
View SourceDeletes 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: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html in the IoT SiteWise User Guide.delete_asset_model_composite_model(Client, AssetModelCompositeModelId, AssetModelId, Input0, Options0)
View SourceDeletes a gateway from IoT SiteWise.
When you delete a gateway, some of the gateway's files remain in your gateway's file system.Deletes a 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
andpropertyId
that identifies the asset property.
describe_access_policy(Client, AccessPolicyId, QueryMap, HeadersMap)
View Sourcedescribe_access_policy(Client, AccessPolicyId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_asset_composite_model(Client, AssetCompositeModelId, AssetId)
View SourceRetrieves information about an asset composite model (also known as an asset component).
AnAssetCompositeModel
is an instance of an AssetModelCompositeModel
. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModelCompositeModel.html.
describe_asset_composite_model(Client, AssetCompositeModelId, AssetId, QueryMap, HeadersMap)
View Sourcedescribe_asset_composite_model(Client, AssetCompositeModelId, AssetId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_asset_model(Client, AssetModelId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_asset_model_composite_model(Client, AssetModelCompositeModelId, AssetModelId)
View SourceRetrieves information about an asset model composite model (also known as an asset model component).
For more information, see Custom composite models (Components): https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html in the IoT SiteWise User Guide.describe_asset_model_composite_model(Client, AssetModelCompositeModelId, AssetModelId, QueryMap, HeadersMap)
View Sourcedescribe_asset_model_composite_model(Client, AssetModelCompositeModelId, 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: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_GetAssetPropertyValue.html.describe_asset_property(Client, AssetId, PropertyId, QueryMap, HeadersMap)
View Sourcedescribe_asset_property(Client, AssetId, PropertyId, QueryMap, HeadersMap, Options0)
View SourceRetrieves information about a bulk import job request.
For more information, see Describe a bulk import job (CLI): https://docs.aws.amazon.com/iot-sitewise/latest/userguide/DescribeBulkImportJob.html in the Amazon Simple Storage Service User Guide.describe_bulk_import_job(Client, JobId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_dashboard(Client, DashboardId, QueryMap, HeadersMap, Options0)
View SourceRetrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region.
For more information, see Key management: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html in the 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 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: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html.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 Sourcedescribe_storage_configuration(Client, QueryMap, HeadersMap, Options0)
View SourceRetrieves 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
andpropertyId
that identifies the asset property.
disassociate_time_series_from_asset_property(Client, Input0, 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: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The
assetId
andpropertyId
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: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html.
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: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The
assetId
andpropertyId
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: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html.
Gets the history of an asset property's values.
For more information, see Querying historical values: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The
assetId
andpropertyId
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: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html.
get_asset_property_value_history(Client, QueryMap, HeadersMap, Options0)
View Sourceget_interpolated_asset_property_values(Client, EndTimeInSeconds, IntervalInSeconds, Quality, StartTimeInSeconds, Type)
View SourceGet 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
andpropertyId
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: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html.
get_interpolated_asset_property_values(Client, EndTimeInSeconds, IntervalInSeconds, Quality, StartTimeInSeconds, Type, QueryMap, HeadersMap)
View Sourceget_interpolated_asset_property_values(Client, EndTimeInSeconds, IntervalInSeconds, Quality, StartTimeInSeconds, Type, QueryMap, HeadersMap, Options0)
View Sourcelist_actions(Client, TargetResourceId, TargetResourceType, QueryMap, HeadersMap)
View Sourcelist_actions(Client, TargetResourceId, TargetResourceType, QueryMap, HeadersMap, Options0)
View Sourcelist_asset_model_composite_models(Client, AssetModelId, QueryMap, HeadersMap)
View Sourcelist_asset_model_composite_models(Client, AssetModelId, QueryMap, HeadersMap, Options0)
View SourceRetrieves 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.list_asset_model_properties(Client, AssetModelId, QueryMap, HeadersMap)
View Sourcelist_asset_model_properties(Client, AssetModelId, QueryMap, HeadersMap, Options0)
View SourceRetrieves 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.list_asset_properties(Client, AssetId, 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 SourceRetrieves a paginated list of bulk import job requests.
For more information, see List bulk import jobs (CLI): https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ListBulkImportJobs.html in the IoT SiteWise User Guide.COMPONENT_MODEL
.
list_composition_relationships(Client, AssetModelId, QueryMap, HeadersMap)
View Sourcelist_composition_relationships(Client, AssetModelId, 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 Amazon Web Services account.
For more information, see Key management: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html in the IoT SiteWise User Guide.Adds tags to an 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: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html in the IoT SiteWise User Guide.Updates an asset model and all of the assets that were created from the model.
Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html in the 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: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html.
If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.update_asset_model_composite_model(Client, AssetModelCompositeModelId, AssetModelId, Input)
View SourceUpdates 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: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html in the IoT SiteWise User Guide.
If you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.
To replace an existing composite asset model property with a new one with the same name
, do the following:
Submit an UpdateAssetModelCompositeModel
request with the entire existing property removed.
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
.
update_asset_model_composite_model(Client, AssetModelCompositeModelId, AssetModelId, Input0, Options0)
View SourceUpdates 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: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetProperty.html.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 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: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html.