AWS.IoTSiteWise (aws-elixir v0.8.0) View Source

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 group (batch) of assets with an IoT SiteWise Monitor project.

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

Sends a list of asset property values to IoT SiteWise.

Creates an access policy that grants the specified identity (Amazon Web Services SSO user, Amazon Web Services SSO 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 dashboard in an IoT SiteWise Monitor project.

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 a dashboard from IoT SiteWise Monitor.

Deletes a gateway from IoT SiteWise.

Deletes a portal from IoT SiteWise Monitor.

Deletes a project from IoT SiteWise Monitor.

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

Retrieves information about an asset.

Retrieves information about an asset model.

Retrieves information about an asset property.

Retrieves information about a dashboard.

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.

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

Retrieves a paginated list of access policies for an identity (an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).

Retrieves a paginated list of summaries of all asset models.

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

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.

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

Link to this function

associate_assets(client, asset_id, input, options \\ [])

View Source

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.

Link to this function

batch_associate_project_assets(client, project_id, input, options \\ [])

View Source

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

Link to this function

batch_disassociate_project_assets(client, project_id, input, options \\ [])

View Source

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

Link to this function

batch_put_asset_property_value(client, input, options \\ [])

View Source

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.

Link to this function

create_access_policy(client, input, options \\ [])

View Source

Creates an access policy that grants the specified identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.

Link to this function

create_asset(client, input, options \\ [])

View Source

Creates an asset from an existing asset model.

For more information, see Creating assets in the IoT SiteWise User Guide.

Link to this function

create_asset_model(client, input, options \\ [])

View Source

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.

Link to this function

create_dashboard(client, input, options \\ [])

View Source

Creates a dashboard in an IoT SiteWise Monitor project.

Link to this function

create_gateway(client, input, options \\ [])

View Source

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.

Link to this function

create_portal(client, input, options \\ [])

View Source

Creates a portal, which can contain projects and dashboards.

IoT SiteWise Monitor uses Amazon Web Services 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 IoT SiteWise User Guide.

Link to this function

create_project(client, input, options \\ [])

View Source

Creates a project in the specified portal.

Link to this function

delete_access_policy(client, access_policy_id, input, options \\ [])

View Source

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.

Link to this function

delete_asset(client, asset_id, input, options \\ [])

View Source

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.

Link to this function

delete_asset_model(client, asset_model_id, input, options \\ [])

View Source

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.

Link to this function

delete_dashboard(client, dashboard_id, input, options \\ [])

View Source

Deletes a dashboard from IoT SiteWise Monitor.

Link to this function

delete_gateway(client, gateway_id, input, options \\ [])

View Source

Deletes a gateway from IoT SiteWise.

When you delete a gateway, some of the gateway's files remain in your gateway's file system.

Link to this function

delete_portal(client, portal_id, input, options \\ [])

View Source

Deletes a portal from IoT SiteWise Monitor.

Link to this function

delete_project(client, project_id, input, options \\ [])

View Source

Deletes a project from IoT SiteWise Monitor.

Link to this function

describe_access_policy(client, access_policy_id, options \\ [])

View Source

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

Link to this function

describe_asset(client, asset_id, options \\ [])

View Source

Retrieves information about an asset.

Link to this function

describe_asset_model(client, asset_model_id, options \\ [])

View Source

Retrieves information about an asset model.

Link to this function

describe_asset_property(client, asset_id, property_id, options \\ [])

View Source

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.

Link to this function

describe_dashboard(client, dashboard_id, options \\ [])

View Source

Retrieves information about a dashboard.

Link to this function

describe_default_encryption_configuration(client, options \\ [])

View Source

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.

Link to this function

describe_gateway(client, gateway_id, options \\ [])

View Source

Retrieves information about a gateway.

Link to this function

describe_gateway_capability_configuration(client, capability_namespace, gateway_id, options \\ [])

View Source

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.

Link to this function

describe_logging_options(client, options \\ [])

View Source

Retrieves the current IoT SiteWise logging options.

Link to this function

describe_portal(client, portal_id, options \\ [])

View Source

Retrieves information about a portal.

Link to this function

describe_project(client, project_id, options \\ [])

View Source

Retrieves information about a project.

Link to this function

describe_storage_configuration(client, options \\ [])

View Source

Retrieves information about the storage configuration for IoT SiteWise.

Link to this function

disassociate_assets(client, asset_id, input, options \\ [])

View Source

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

Link to this function

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 Source

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:

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

Link to this function

get_asset_property_value(client, asset_id \\ nil, property_alias \\ nil, property_id \\ nil, options \\ [])

View Source

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:

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

Link to this function

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 Source

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:

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

Link to this function

get_interpolated_asset_property_values(client, asset_id \\ nil, end_time_in_seconds, end_time_offset_in_nanos \\ nil, interval_in_seconds, 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 Source

Get interpolated values for an asset property for a specified time interval, during a period of time.

For example, you can use the 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.

Link to this function

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 Source

Retrieves a paginated list of access policies for an identity (an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).

Link to this function

list_asset_models(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a paginated list of summaries of all asset models.

Link to this function

list_asset_relationships(client, asset_id, max_results \\ nil, next_token \\ nil, traversal_type, options \\ [])

View Source

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.

Link to this function

list_assets(client, asset_model_id \\ nil, filter \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_associated_assets(client, asset_id, hierarchy_id \\ nil, max_results \\ nil, next_token \\ nil, traversal_direction \\ nil, options \\ [])

View Source

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.

Link to this function

list_dashboards(client, max_results \\ nil, next_token \\ nil, project_id, options \\ [])

View Source

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

Link to this function

list_gateways(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a paginated list of gateways.

Link to this function

list_portals(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a paginated list of IoT SiteWise Monitor portals.

Link to this function

list_project_assets(client, project_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_projects(client, max_results \\ nil, next_token \\ nil, portal_id, options \\ [])

View Source

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

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Retrieves the list of tags for an IoT SiteWise resource.

Link to this function

put_default_encryption_configuration(client, input, options \\ [])

View Source

Sets the default encryption configuration for the Amazon Web Services account.

For more information, see Key management in the IoT SiteWise User Guide.

Link to this function

put_logging_options(client, input, options \\ [])

View Source

Sets logging options for IoT SiteWise.

Link to this function

put_storage_configuration(client, input, options \\ [])

View Source

Configures storage settings for IoT SiteWise.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Adds tags to an IoT SiteWise resource.

If a tag already exists for the resource, this operation updates the tag's value.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes a tag from an IoT SiteWise resource.

Link to this function

update_access_policy(client, access_policy_id, input, options \\ [])

View Source

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

Link to this function

update_asset(client, asset_id, input, options \\ [])

View Source

Updates an asset's name.

For more information, see Updating assets and models in the IoT SiteWise User Guide.

Link to this function

update_asset_model(client, asset_model_id, input, options \\ [])

View Source

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.

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

Link to this function

update_asset_property(client, asset_id, property_id, input, options \\ [])

View Source

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.

Link to this function

update_dashboard(client, dashboard_id, input, options \\ [])

View Source

Updates an IoT SiteWise Monitor dashboard.

Link to this function

update_gateway(client, gateway_id, input, options \\ [])

View Source

Updates a gateway's name.

Link to this function

update_gateway_capability_configuration(client, gateway_id, input, options \\ [])

View Source

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.

Link to this function

update_portal(client, portal_id, input, options \\ [])

View Source

Updates an IoT SiteWise Monitor portal.

Link to this function

update_project(client, project_id, input, options \\ [])

View Source

Updates an IoT SiteWise Monitor project.