IotSiteWiseClient
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.
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.
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. 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.
Gets 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.
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.
Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and component-model-based.
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.
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. 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.
Creates a project in the specified portal.
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 in the IoT SiteWise User Guide.
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.
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.
Deletes a dashboard from IoT SiteWise Monitor.
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.
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). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.
Retrieves information about an asset model.
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.
Retrieves information about an asset property.
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 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.
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.
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. For more information, see Querying aggregates in the IoT SiteWise User Guide.
Gets an asset property's current value. For more information, see Querying current values in the IoT SiteWise User Guide.
Gets the history of an asset property's values. For more information, see Querying historical values in the IoT SiteWise User Guide.
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.
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. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.
Retrieves a paginated list of summaries of all asset models.
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.
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.
Retrieves a paginated list of asset summaries.
Retrieves a paginated list of associated assets.
Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.
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 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. 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.
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. 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.
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.
Updates an asset property's alias and notification state.
Updates an IoT SiteWise Monitor dashboard.
Updates a gateway's name.
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.
Updates an IoT SiteWise Monitor portal.
Updates an IoT SiteWise Monitor project.
Inherited 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.
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. For more information, see Querying aggregates in the IoT SiteWise User Guide.
Paginate over BatchGetAssetPropertyAggregatesResponse results.
Gets the current value for one or more asset properties. For more information, see Querying 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 in the IoT SiteWise User Guide.
Paginate over BatchGetAssetPropertyValueHistoryResponse results.
Paginate over BatchGetAssetPropertyValueResponse results.
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.
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.
Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and component-model-based.
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.
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. 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.
Creates a project in the specified portal.
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 in the IoT SiteWise User Guide.
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.
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.
Deletes a dashboard from IoT SiteWise Monitor.
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.
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). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.
Retrieves information about an asset model.
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.
Retrieves information about an asset property.
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 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.
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.
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.
Paginate over ExecuteQueryResponse results.
Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide.
Paginate over GetAssetPropertyAggregatesResponse results.
Gets an asset property's current value. For more information, see Querying current values in the IoT SiteWise User Guide.
Gets the history of an asset property's values. For more information, see Querying historical values in the IoT SiteWise User Guide.
Paginate over GetAssetPropertyValueHistoryResponse results.
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.
Paginate over GetInterpolatedAssetPropertyValuesResponse results.
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).
Paginate over ListAccessPoliciesResponse results.
Retrieves a paginated list of actions for a specific target resource.
Retrieves a paginated list of composite models associated with the asset model
Paginate over ListAssetModelCompositeModelsResponse results.
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.
Paginate over ListAssetModelPropertiesResponse results.
Retrieves a paginated list of summaries of all asset models.
Paginate over ListAssetModelsResponse results.
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.
Paginate over ListAssetPropertiesResponse results.
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.
Paginate over ListAssetRelationshipsResponse results.
Retrieves a paginated list of asset summaries.
Paginate over ListAssetsResponse results.
Retrieves a paginated list of associated assets.
Paginate over ListAssociatedAssetsResponse results.
Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.
Paginate over ListBulkImportJobsResponse results.
Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.
Paginate over ListCompositionRelationshipsResponse results.
Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
Paginate over ListDashboardsResponse results.
Retrieves a paginated list of gateways.
Paginate over ListGatewaysResponse results.
Retrieves a paginated list of IoT SiteWise Monitor portals.
Paginate over ListPortalsResponse results.
Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
Paginate over ListProjectAssetsResponse results.
Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
Paginate over ListProjectsResponse results.
Retrieves the list of tags for an IoT SiteWise resource.
Retrieves a paginated list of time series (data streams).
Paginate over ListTimeSeriesResponse results.
Sets 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.
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. 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.
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.
Updates an asset property's alias and notification state.
Updates an IoT SiteWise Monitor dashboard.
Updates a gateway's name.
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.
Updates an IoT SiteWise Monitor portal.
Updates an IoT SiteWise Monitor project.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.