amazonaws.com – iotsitewise

Tools (75)

Extracted live via the executor SDK.

• 20200301.createGateway

  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.

• 20200301.deleteGateway

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

• 20200301.describeGateway

  Retrieves information about a gateway.

• 20200301.describeGatewayCapabilityConfiguration

  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.

• 20200301.listGateways

  Retrieves a paginated list of gateways.

• 20200301.updateGateway

  Updates a gateway's name.

• 20200301.updateGatewayCapabilityConfiguration

  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.

• accessPolicies.createAccessPolicy

  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.

• accessPolicies.deleteAccessPolicy

  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.

• accessPolicies.describeAccessPolicy

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

• accessPolicies.listAccessPolicies

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

• accessPolicies.updateAccessPolicy

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

• assetModels.createAssetModel

  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.

• assetModels.deleteAssetModel

  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.

• assetModels.describeAssetModel

  Retrieves information about an asset model.

• assetModels.listAssetModelProperties

  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.

• assetModels.listAssetModels

  Retrieves a paginated list of summaries of all asset models.

• assetModels.updateAssetModel

  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.

• assets.associateAssets

  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.

• assets.createAsset

  Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.

• assets.deleteAsset

  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.

• assets.describeAsset

  Retrieves information about an asset.

• assets.describeAssetProperty

  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.

• assets.disassociateAssets

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

• assets.listAssetProperties

  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.

• assets.listAssetRelationships

  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.

• assets.listAssets

  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.

• assets.listAssociatedAssets

  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.

• assets.updateAsset

  Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.

• assets.updateAssetProperty

  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.

• configuration.describeDefaultEncryptionConfiguration

  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.

• configuration.describeStorageConfiguration

  Retrieves information about the storage configuration for IoT SiteWise.

• configuration.putDefaultEncryptionConfiguration

  Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.

• configuration.putStorageConfiguration

  Configures storage settings for IoT SiteWise.

• dashboards.createDashboard

  Creates a dashboard in an IoT SiteWise Monitor project.

• dashboards.deleteDashboard

  Deletes a dashboard from IoT SiteWise Monitor.

• dashboards.describeDashboard

  Retrieves information about a dashboard.

• dashboards.updateDashboard

  Updates an IoT SiteWise Monitor dashboard.

• dashboardsProjectId.listDashboards

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

• jobs.createBulkImportJob

  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.

  You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For more information about how to configure storage settings, see PutStorageConfiguration.

• jobs.describeBulkImportJob

  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.

• jobs.listBulkImportJobs

  Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.

• logging.describeLoggingOptions

  Retrieves the current IoT SiteWise logging options.

• logging.putLoggingOptions

  Sets logging options for IoT SiteWise.

• portals.createPortal

  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.

• portals.deletePortal

  Deletes a portal from IoT SiteWise Monitor.

• portals.describePortal

  Retrieves information about a portal.

• portals.listPortals

  Retrieves a paginated list of IoT SiteWise Monitor portals.

• portals.updatePortal

  Updates an IoT SiteWise Monitor portal.

• projects.batchAssociateProjectAssets

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

• projects.batchDisassociateProjectAssets

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

• projects.createProject

  Creates a project in the specified portal.

  Make sure that the project name and description don't contain confidential information.

• projects.deleteProject

  Deletes a project from IoT SiteWise Monitor.

• projects.describeProject

  Retrieves information about a project.

• projects.listProjectAssets

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

• projects.updateProject

  Updates an IoT SiteWise Monitor project.

• projectsPortalId.listProjects

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

• properties.batchGetAssetPropertyAggregates

  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.

• properties.batchGetAssetPropertyValue

  Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.

• properties.batchGetAssetPropertyValueHistory

  Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.

• properties.batchPutAssetPropertyValue

  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.

• properties.getAssetPropertyAggregates

  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.

• properties.getAssetPropertyValue

  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.

• properties.getAssetPropertyValueHistory

  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.

• properties.getInterpolatedAssetPropertyValues

  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.

  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.

• tagsResourceArn.listTagsForResource

  Retrieves the list of tags for an IoT SiteWise resource.

• tagsResourceArn.tagResource

  Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.

• tagsResourceArnTagKeys.untagResource

  Removes a tag from an IoT SiteWise resource.

• timeseries.associateTimeSeriesToAssetProperty

  Associates a time series (data stream) with an asset property.

• timeseries.deleteTimeSeries

  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.

• timeseries.describeTimeSeries

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

• timeseries.disassociateTimeSeriesFromAssetProperty

  Disassociates a time series (data stream) from an asset property.

• timeseries.listTimeSeries

  Retrieves a paginated list of time series (data streams).

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools