Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.3/services/iotsitewise.ts?docs=full";

§Classes

IoTSiteWise

§Interfaces

AccessPolicySummary

Contains an access policy that defines an identity's access to an IoT SiteWise Monitor resource.

AggregatedValue

Contains aggregated asset property values (for example, average, minimum, and maximum).

Aggregates

Contains the (pre-calculated) aggregate values for an asset property.

Alarms

Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.

AssetCompositeModel

Contains information about a composite model in an asset. This object contains the asset's properties that you define in the composite model.

AssetErrorDetails

Contains error details for the requested associate project asset action.

AssetHierarchy

Describes an asset hierarchy that contains a hierarchy's name and ID.

AssetHierarchyInfo

Contains information about a parent asset and a child asset that are related through an asset hierarchy.

AssetModelCompositeModel

Contains information about a composite model in an asset model. This object contains the asset property definitions that you define in the composite model.

AssetModelCompositeModelDefinition

Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.

AssetModelHierarchy

Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.

AssetModelHierarchyDefinition

Contains an asset model hierarchy used in asset model creation. An asset model hierarchy determines the kind (or type) of asset that can belong to a hierarchy.

AssetModelProperty

Contains information about an asset model property.

AssetModelPropertyDefinition

Contains an asset model property definition. This property definition is applied to all assets created from the asset model.

AssetModelStatus

Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.

AssetModelSummary

Contains a summary of an asset model.

AssetProperty

Contains asset property information.

AssetPropertyValue

Contains asset property value information.

AssetRelationshipSummary

Contains information about assets that are related to one another.

AssetStatus

Contains information about the current status of an asset. For more information, see Asset and model states in the IoT SiteWise User Guide.

AssetSummary

Contains a summary of an asset.

AssociateAssetsRequest
AssociatedAssetsSummary

Contains a summary of an associated asset.

AssociateTimeSeriesToAssetPropertyRequest
Attribute

Contains an asset attribute property. For more information, see Attributes in the IoT SiteWise User Guide.

BatchAssociateProjectAssetsRequest
BatchAssociateProjectAssetsResponse
BatchDisassociateProjectAssetsRequest
BatchDisassociateProjectAssetsResponse
BatchPutAssetPropertyError

Contains error information from updating a batch of asset property values.

BatchPutAssetPropertyErrorEntry

Contains error information for asset property value entries that are associated with the BatchPutAssetPropertyValue API.

BatchPutAssetPropertyValueRequest
BatchPutAssetPropertyValueResponse
CompositeModelProperty

Contains information about a composite model property on an asset.

ConfigurationErrorDetails

Contains the details of an IoT SiteWise configuration error.

ConfigurationStatus

Contains current status information for the configuration.

CreateAccessPolicyRequest
CreateAccessPolicyResponse
CreateAssetModelRequest
CreateAssetModelResponse
CreateAssetRequest
CreateAssetResponse
CreateDashboardRequest
CreateDashboardResponse
CreateGatewayRequest
CreateGatewayResponse
CreatePortalRequest
CreatePortalResponse
CreateProjectRequest
CreateProjectResponse
CustomerManagedS3Storage

Contains information about a customer managed Amazon S3 bucket.

DashboardSummary

Contains a dashboard summary.

DeleteAccessPolicyRequest
DeleteAssetModelRequest
DeleteAssetModelResponse
DeleteAssetRequest
DeleteAssetResponse
DeleteDashboardRequest
DeleteGatewayRequest
DeletePortalRequest
DeletePortalResponse
DeleteProjectRequest
DeleteTimeSeriesRequest
DescribeAccessPolicyRequest
DescribeAccessPolicyResponse
DescribeAssetModelRequest
DescribeAssetModelResponse
DescribeAssetPropertyRequest
DescribeAssetPropertyResponse
DescribeAssetRequest
DescribeAssetResponse
DescribeDashboardRequest
DescribeDashboardResponse
DescribeDefaultEncryptionConfigurationResponse
DescribeGatewayCapabilityConfigurationRequest
DescribeGatewayCapabilityConfigurationResponse
DescribeGatewayRequest
DescribeGatewayResponse
DescribeLoggingOptionsResponse
DescribePortalRequest
DescribePortalResponse
DescribeProjectRequest
DescribeProjectResponse
DescribeStorageConfigurationResponse
DescribeTimeSeriesRequest
DescribeTimeSeriesResponse
DetailedError

Contains detailed error information.

DisassociateAssetsRequest
DisassociateTimeSeriesFromAssetPropertyRequest
ErrorDetails

Contains the details of an IoT SiteWise error.

ExpressionVariable

Contains expression variable information.

ForwardingConfig

The forwarding configuration for a given property.

GatewayCapabilitySummary

Contains a summary of a gateway capability configuration.

GatewayPlatform

Contains a gateway's platform information.

GatewaySummary

Contains a summary of a gateway.

GetAssetPropertyAggregatesRequest
GetAssetPropertyAggregatesResponse
GetAssetPropertyValueHistoryRequest
GetAssetPropertyValueHistoryResponse
GetAssetPropertyValueRequest
GetAssetPropertyValueResponse
GetInterpolatedAssetPropertyValuesRequest
GetInterpolatedAssetPropertyValuesResponse
Greengrass

Contains details for a gateway that runs on IoT Greengrass. To create a gateway that runs on IoT Greengrass, you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass group must also have permissions to upload data to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.

GreengrassV2

Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass V2, you must deploy the IoT SiteWise Edge component to your gateway device. Your Greengrass device role must use the AWSIoTSiteWiseEdgeAccess policy. For more information, see Using IoT SiteWise at the edge in the IoT SiteWise User Guide.

GroupIdentity

Contains information for a group identity in an access policy.

IAMRoleIdentity

Contains information about an Identity and Access Management role. For more information, see IAM roles in the IAM User Guide.

IAMUserIdentity

Contains information about an Identity and Access Management user.

Identity

Contains an identity that can access an IoT SiteWise Monitor resource.

Image

Contains an image that is one of the following:

ImageFile

Contains an image file.

ImageLocation

Contains an image that is uploaded to IoT SiteWise and available at a URL.

InterpolatedAssetPropertyValue

Contains information about an interpolated asset property value.

ListAccessPoliciesRequest
ListAccessPoliciesResponse
ListAssetModelsRequest
ListAssetModelsResponse
ListAssetRelationshipsRequest
ListAssetRelationshipsResponse
ListAssetsRequest
ListAssetsResponse
ListAssociatedAssetsRequest
ListAssociatedAssetsResponse
ListDashboardsRequest
ListDashboardsResponse
ListGatewaysRequest
ListGatewaysResponse
ListPortalsRequest
ListPortalsResponse
ListProjectAssetsRequest
ListProjectAssetsResponse
ListProjectsRequest
ListProjectsResponse
ListTagsForResourceRequest
ListTagsForResourceResponse
ListTimeSeriesRequest
ListTimeSeriesResponse
LoggingOptions

Contains logging options.

Measurement

Contains an asset measurement property. For more information, see Measurements in the IoT SiteWise User Guide.

MeasurementProcessingConfig

The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.

Metric

Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum).

MetricProcessingConfig

The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.

MetricWindow

Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).

MonitorErrorDetails

Contains IoT SiteWise Monitor error details.

MultiLayerStorage

Contains information about the storage destination.

PortalResource

Identifies an IoT SiteWise Monitor portal.

PortalStatus

Contains information about the current status of a portal.

PortalSummary

Contains a portal summary.

ProjectResource

Identifies a specific IoT SiteWise Monitor project.

ProjectSummary

Contains project summary information.

Property

Contains asset property information.

PropertyNotification

Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide.

PropertyType

Contains a property type, which can be one of attribute, measurement, metric, or transform.

PutAssetPropertyValueEntry

Contains a list of value updates for an asset property in the list of asset entries consumed by the BatchPutAssetPropertyValue API operation.

PutDefaultEncryptionConfigurationRequest
PutDefaultEncryptionConfigurationResponse
PutLoggingOptionsRequest
PutStorageConfigurationRequest
PutStorageConfigurationResponse
Resource

Contains an IoT SiteWise Monitor resource ID for a portal or project.

RetentionPeriod

How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.

TagResourceRequest
TimeInNanos

Contains a timestamp with optional nanosecond granularity.

TimeSeriesSummary

Contains a summary of a time series (data stream).

Transform

Contains an asset transform property. A transform is a one-to-one mapping of a property's data points from one form to another. For example, you can use a transform to convert a Celsius data stream to Fahrenheit by applying the transformation expression to each data point of the Celsius stream. A transform can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE.

TransformProcessingConfig

The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.

TumblingWindow

Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time window. You can use this window in metrics to aggregate data from properties and other assets.

UntagResourceRequest
UpdateAccessPolicyRequest
UpdateAssetModelRequest
UpdateAssetModelResponse
UpdateAssetPropertyRequest
UpdateAssetRequest
UpdateAssetResponse
UpdateDashboardRequest
UpdateGatewayCapabilityConfigurationRequest
UpdateGatewayCapabilityConfigurationResponse
UpdateGatewayRequest
UpdatePortalRequest
UpdatePortalResponse
UpdateProjectRequest
UserIdentity

Contains information for a user identity in an access policy.

VariableValue

Identifies a property value used in an expression.

Variant

Contains an asset property value (of a single type only).

§Type Aliases

AggregateType
AssetErrorCode
AssetModelState
AssetRelationshipType
AssetState
AuthMode
BatchPutAssetPropertyValueErrorCode
CapabilitySyncStatus
ComputeLocation
ConfigurationState
DetailedErrorCode
DisassociatedDataStorageState
EncryptionType
ErrorCode
ForwardingConfigState
IdentityType
ImageFileType
ListAssetsFilter
ListTimeSeriesType
LoggingLevel
MonitorErrorCode
Permission
PortalState
PropertyDataType
PropertyNotificationState
Quality
ResourceType
StorageType
TimeOrdering
TraversalDirection
TraversalType