View Source AWS.IoTSiteWise (aws-elixir 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) 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.
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.
Associates a time series (data stream) with an asset property.
Associates a group (batch) of assets with an IoT SiteWise Monitor project.
Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
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 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.
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 dashboard in an IoT SiteWise Monitor project.
Creates a dataset to connect an external datasource.
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 dashboard from IoT SiteWise Monitor.
Deletes a dataset.
Deletes a gateway from IoT SiteWise.
Deletes a portal from IoT SiteWise Monitor.
Deletes a project from IoT SiteWise Monitor.
Deletes a time series (data stream).
Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
Retrieves information about an action.
Retrieves information about an asset.
Retrieves information about an asset composite model (also known as an asset component).
Retrieves information about an asset model.
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 a dashboard.
Retrieves information about a dataset.
Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region.
Retrieves information about a gateway.
Retrieves information about a gateway capability configuration.
Retrieves the current IoT SiteWise logging options.
Retrieves information about a portal.
Retrieves information about a project.
Retrieves information about the storage configuration for IoT SiteWise.
Retrieves information about a time series (data stream).
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
Disassociates a time series (data stream) from an asset property.
Executes an action on a target resource.
Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.
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.
Invokes SiteWise Assistant to start or continue a conversation.
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).
Retrieves a paginated list of actions for a specific target resource.
Retrieves a paginated list of composite models associated with the asset model
Retrieves a paginated list of properties associated with an asset model.
Retrieves a paginated list of summaries of all asset models.
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.
Retrieves a paginated list of composition relationships for an asset model of
type
COMPONENT_MODEL.
Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
Retrieves a paginated list of datasets for a specific target resource.
Retrieves a paginated list of gateways.
Retrieves a paginated list of IoT SiteWise Monitor portals.
Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
Retrieves the list of tags for an IoT SiteWise resource.
Retrieves a paginated list of time series (data streams).
Sets the default encryption configuration for the Amazon Web Services account.
Sets logging options for IoT SiteWise.
Configures storage settings for IoT SiteWise.
Adds tags to an IoT SiteWise resource.
Removes a tag from an IoT SiteWise resource.
Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project 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 an IoT SiteWise Monitor dashboard.
Updates a dataset.
Updates a gateway's name.
Updates a gateway capability configuration or defines a new capability configuration.
Updates an IoT SiteWise Monitor portal.
Updates an IoT SiteWise Monitor project.
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 IoT SiteWise User Guide.
associate_time_series_to_asset_property(client, input, options \\ [])
View SourceAssociates a time series (data stream) with an asset property.
batch_associate_project_assets(client, project_id, input, options \\ [])
View SourceAssociates a group (batch) of assets with an IoT SiteWise Monitor project.
batch_disassociate_project_assets(client, project_id, input, options \\ [])
View SourceDisassociates a group (batch) of assets from an IoT SiteWise Monitor project.
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.
Gets the current value for one or more asset properties.
For more information, see Querying current values in the IoT SiteWise User Guide.
batch_get_asset_property_value_history(client, input, options \\ [])
View SourceGets the historical values for one or more asset properties.
For more information, see Querying 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 in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
*
The assetId and propertyId of an asset property.
*
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's
alias, see
UpdateAssetProperty.
With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a
timestamp of no more
than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise
rejects timestamps
outside of the inclusive range of [-7 days, +10 minutes] and returns a
TimestampOutOfRangeException error.
For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps
unless the newer
TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1},
then storing {T1, GOOD, V2} replaces the existing TQV.
IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry
individually.
For more information, see BatchPutAssetPropertyValue authorization
in the
IoT SiteWise User Guide.
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.
Creates an asset from an existing asset model.
For more information, see Creating assets 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 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.
create_asset_model_composite_model(client, asset_model_id, input, options \\ [])
View SourceCreates 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.
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.
Creates a dashboard in an IoT SiteWise Monitor project.
Creates a dataset to connect an external datasource.
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.
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.
Creates a project in the specified portal.
Make sure that the project name and description don't contain confidential information.
delete_access_policy(client, access_policy_id, input, options \\ [])
View SourceDeletes 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 in the 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 IoT SiteWise User Guide.
delete_asset_model_composite_model(client, asset_model_composite_model_id, asset_model_id, input, options \\ [])
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 in the IoT SiteWise User Guide.
Deletes a dashboard from IoT SiteWise Monitor.
Deletes a dataset.
This cannot be undone.
Deletes 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 portal from IoT SiteWise Monitor.
Deletes a project from IoT SiteWise Monitor.
Deletes a time series (data stream).
If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.
To identify a time series, do one of the following:
*
If the time series isn't associated with an asset property,
specify the alias of the time series.
* If the time series is associated with an asset property, specify one of the following:
*The alias of the time series.
*The assetId and propertyId that identifies the asset property.
Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
Retrieves information about an action.
describe_asset(client, asset_id, exclude_properties \\ nil, options \\ [])
View SourceRetrieves information about an asset.
describe_asset_composite_model(client, asset_composite_model_id, asset_id, options \\ [])
View SourceRetrieves 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.
describe_asset_model(client, asset_model_id, asset_model_version \\ nil, exclude_properties \\ nil, options \\ [])
View SourceRetrieves information about an asset model.
describe_asset_model_composite_model(client, asset_model_composite_model_id, asset_model_id, asset_model_version \\ nil, options \\ [])
View SourceRetrieves 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.
describe_asset_property(client, asset_id, property_id, options \\ [])
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.
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.
Retrieves information about a dashboard.
Retrieves information about a dataset.
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.
Retrieves information about a gateway.
describe_gateway_capability_configuration(client, capability_namespace, gateway_id, options \\ [])
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.
Retrieves the current IoT SiteWise logging options.
Retrieves information about a portal.
Retrieves information about a project.
Retrieves information about the storage configuration for IoT SiteWise.
describe_time_series(client, alias \\ nil, asset_id \\ nil, property_id \\ nil, options \\ [])
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 and propertyId that identifies the asset property.
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
disassociate_time_series_from_asset_property(client, input, options \\ [])
View SourceDisassociates a time series (data stream) from an asset property.
Executes an action on a target resource.
Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.
get_asset_property_aggregates(client, aggregate_types, asset_id \\ nil, end_date, max_results \\ nil, next_token \\ nil, property_alias \\ nil, property_id \\ nil, qualities \\ nil, resolution, start_date, time_ordering \\ nil, options \\ [])
View SourceGets aggregated values for an asset property.
For more information, see Querying aggregates in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
*
The assetId and propertyId of an asset property.
*
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's
alias, see
UpdateAssetProperty.
get_asset_property_value(client, asset_id \\ nil, property_alias \\ nil, property_id \\ nil, options \\ [])
View SourceGets an asset property's current value.
For more information, see Querying current values in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
*
The assetId and propertyId of an asset property.
*
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's
alias, see
UpdateAssetProperty.
get_asset_property_value_history(client, asset_id \\ nil, end_date \\ nil, max_results \\ nil, next_token \\ nil, property_alias \\ nil, property_id \\ nil, qualities \\ nil, start_date \\ nil, time_ordering \\ nil, options \\ [])
View SourceGets the history of an asset property's values.
For more information, see Querying historical values in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
*
The assetId and propertyId of an asset property.
*
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's
alias, see
UpdateAssetProperty.
get_interpolated_asset_property_values(client, asset_id \\ nil, end_time_in_seconds, end_time_offset_in_nanos \\ nil, interval_in_seconds, interval_window_in_seconds \\ nil, max_results \\ nil, next_token \\ nil, property_alias \\ nil, property_id \\ nil, quality, start_time_in_seconds, start_time_offset_in_nanos \\ nil, type, options \\ [])
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 and propertyId of an asset property.
*
A propertyAlias, which is a data stream alias (for example,
/company/windfarm/3/turbine/7/temperature). To define an asset property's
alias, see
UpdateAssetProperty.
Invokes SiteWise Assistant to start or continue a conversation.
list_access_policies(client, iam_arn \\ nil, identity_id \\ nil, identity_type \\ nil, max_results \\ nil, next_token \\ nil, resource_id \\ nil, resource_type \\ nil, options \\ [])
View SourceRetrieves 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).
list_actions(client, max_results \\ nil, next_token \\ nil, target_resource_id, target_resource_type, options \\ [])
View SourceRetrieves a paginated list of actions for a specific target resource.
list_asset_model_composite_models(client, asset_model_id, asset_model_version \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves a paginated list of composite models associated with the asset model
list_asset_model_properties(client, asset_model_id, asset_model_version \\ nil, filter \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
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_models(client, asset_model_types \\ nil, asset_model_version \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves a paginated list of summaries of all asset models.
list_asset_properties(client, asset_id, filter \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
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_relationships(client, asset_id, max_results \\ nil, next_token \\ nil, traversal_type, options \\ [])
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_assets(client, asset_model_id \\ nil, filter \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
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.
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.
list_associated_assets(client, asset_id, hierarchy_id \\ nil, max_results \\ nil, next_token \\ nil, traversal_direction \\ nil, options \\ [])
View SourceRetrieves a paginated list of associated assets.
You can use this operation to do the following:
*
CHILD - List all child assets associated to the asset.
*
PARENT - List the asset's parent asset.
list_bulk_import_jobs(client, filter \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves a paginated list of bulk import job requests.
For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.
list_composition_relationships(client, asset_model_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves a paginated list of composition relationships for an asset model of
type
COMPONENT_MODEL.
list_dashboards(client, max_results \\ nil, next_token \\ nil, project_id, options \\ [])
View SourceRetrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
list_datasets(client, max_results \\ nil, next_token \\ nil, source_type, options \\ [])
View SourceRetrieves a paginated list of datasets for a specific target resource.
list_gateways(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves a paginated list of gateways.
list_portals(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves a paginated list of IoT SiteWise Monitor portals.
list_project_assets(client, project_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
list_projects(client, max_results \\ nil, next_token \\ nil, portal_id, options \\ [])
View SourceRetrieves a paginated list of projects for an IoT SiteWise Monitor portal.
Retrieves the list of tags for an IoT SiteWise resource.
list_time_series(client, alias_prefix \\ nil, asset_id \\ nil, max_results \\ nil, next_token \\ nil, time_series_type \\ nil, options \\ [])
View SourceRetrieves a paginated list of time series (data streams).
put_default_encryption_configuration(client, input, options \\ [])
View SourceSets the default encryption configuration for the Amazon Web Services account.
For more information, see Key management in the IoT SiteWise User Guide.
Sets logging options for IoT SiteWise.
Configures storage settings for IoT SiteWise.
Adds tags to an IoT SiteWise resource.
If a tag already exists for the resource, this operation updates the tag's value.
Removes a tag from an IoT SiteWise resource.
update_access_policy(client, access_policy_id, input, options \\ [])
View SourceUpdates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
Updates an asset's name.
For more information, see Updating assets and models 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 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:
Submit an UpdateAssetModel request with the entire existing property
removed.
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.
update_asset_model_composite_model(client, asset_model_composite_model_id, asset_model_id, input, options \\ [])
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 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.
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.
update_asset_property(client, asset_id, property_id, input, options \\ [])
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.
Updates an IoT SiteWise Monitor dashboard.
Updates a dataset.
Updates a gateway's name.
update_gateway_capability_configuration(client, gateway_id, input, options \\ [])
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.
Updates an IoT SiteWise Monitor portal.
Updates an IoT SiteWise Monitor project.