Package-level declarations

Types

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

Contains a definition for an action.

Link copied to clipboard

The JSON payload of the action.

Link copied to clipboard

Contains the summary of the actions.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
sealed class AggregateType
Link copied to clipboard
class 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.

Link copied to clipboard

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

Link copied to clipboard

Represents one level between a composite model and the root of the asset.

Link copied to clipboard

Contains a summary of the composite model for a specific asset.

Link copied to clipboard
sealed class AssetErrorCode
Link copied to clipboard

Contains error details for the requested associate project asset action.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Represents one level between a composite model and the root of the asset model.

Link copied to clipboard

Contains a summary of the composite model.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Contains information about an asset model property.

Link copied to clipboard

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

Link copied to clipboard

Represents one level between a property and the root of the asset model.

Link copied to clipboard

Contains a summary of a property associated with a model.

Link copied to clipboard
sealed class AssetModelState
Link copied to clipboard

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

Link copied to clipboard

Contains a summary of an asset model.

Link copied to clipboard
sealed class AssetModelType
Link copied to clipboard
Link copied to clipboard

Contains asset property information.

Link copied to clipboard

Represents one level between a property and the root of the asset.

Link copied to clipboard

Contains a summary of a property associated with an asset.

Link copied to clipboard

Contains asset property value information.

Link copied to clipboard

Contains information about assets that are related to one another.

Link copied to clipboard
Link copied to clipboard
sealed class AssetState
Link copied to clipboard

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

Link copied to clipboard

Contains a summary of an asset.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Contains a summary of an associated asset.

Link copied to clipboard
class Attribute

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

Link copied to clipboard
sealed class AuthMode
Link copied to clipboard
Link copied to clipboard

Contains information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.

Contains error information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.

Link copied to clipboard

Contains the error code and the timestamp for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.

Contains information for an entry that has been processed by the previous BatchGetAssetPropertyAggregates request.

Contains success information for an entry that is associated with the BatchGetAssetPropertyAggregates API.

Link copied to clipboard

Contains information for an asset property value entry that is associated with the BatchGetAssetPropertyValue API.

Link copied to clipboard

Contains error information for an asset property value entry that is associated with the BatchGetAssetPropertyValue API.

Link copied to clipboard

The error information, such as the error code and the timestamp.

Link copied to clipboard

Contains information for an asset property historical value entry that is associated with the BatchGetAssetPropertyValueHistory API.

A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.

The error information, such as the error code and the timestamp.

Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValueHistory request.

Contains success information for an entry that is associated with the BatchGetAssetPropertyValueHistory API.

Link copied to clipboard

Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValue request.

Link copied to clipboard

Contains success information for an entry that is associated with the BatchGetAssetPropertyValue API.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
class Citation

Contains text content to which the SiteWise Assistant refers to, and generate the final response. It also contains information about the source.

Link copied to clipboard

A description of the column in the query results.

Link copied to clipboard
sealed class ColumnName
Link copied to clipboard

The data type of the column.

Link copied to clipboard

Contains information about a composite model property on an asset.

Link copied to clipboard

Metadata for the composition relationship established by using composedAssetModelId in CreateAssetModelCompositeModel.

Link copied to clipboard

Represents a composite model that composed an asset model of type COMPONENT_MODEL.

Link copied to clipboard

Contains a summary of the components of the composite model.

Link copied to clipboard
sealed class ComputeLocation
Link copied to clipboard

Contains the details of an IoT SiteWise configuration error.

Link copied to clipboard
sealed class ConfigurationState
Link copied to clipboard

Contains current status information for the configuration.

Link copied to clipboard

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

Link copied to clipboard
class Content

Contains the cited text from the data source.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Csv

A .CSV file.

Link copied to clipboard

Contains information about a customer managed Amazon S3 bucket.

Link copied to clipboard

Contains a dashboard summary.

Link copied to clipboard

Contains information about the dataset use and it's source.

Link copied to clipboard

The data source for the dataset.

Link copied to clipboard
sealed class DatasetSourceFormat
Link copied to clipboard
sealed class DatasetSourceType
Link copied to clipboard
sealed class DatasetState
Link copied to clipboard

The status of the dataset. This contains the state and any error messages. The state is ACTIVE when ready to use.

Link copied to clipboard

The summary details for the dataset.

Link copied to clipboard
class Datum

Represents a single data point in a query result.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Contains detailed error information.

Link copied to clipboard
sealed class DetailedErrorCode
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class EncryptionType
Link copied to clipboard
sealed class ErrorCode
Link copied to clipboard

Contains the details of an IoT SiteWise error.

Link copied to clipboard

The Amazon S3 destination where errors associated with the job creation request are saved.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Contains expression variable information.

Link copied to clipboard
class File

The file in Amazon S3 where your data is saved.

Link copied to clipboard

The file format of the data in S3.

Link copied to clipboard

The forwarding configuration for a given property.

Link copied to clipboard
Link copied to clipboard

Contains a summary of a gateway capability configuration.

Link copied to clipboard

Contains a gateway's platform information.

Link copied to clipboard

Contains a summary of a gateway.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Contains information for a group identity in an access policy.

Link copied to clipboard

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

Link copied to clipboard

Contains information about an Identity and Access Management user.

Link copied to clipboard
class Identity

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

Link copied to clipboard
sealed class IdentityType
Link copied to clipboard
class Image

Contains an image that is one of the following:

Link copied to clipboard
class ImageFile

Contains an image file.

Link copied to clipboard
sealed class ImageFileType
Link copied to clipboard

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

Link copied to clipboard

IoT SiteWise can't process your request right now. Try again later.

Link copied to clipboard

Contains information about an interpolated asset property value.

Link copied to clipboard

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

Link copied to clipboard

This contains the SiteWise Assistant's response and the corresponding citation.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Base class for all service related exceptions thrown by the IotSiteWise client

Link copied to clipboard

Contains the configuration information of a job, such as the file format used to save data in Amazon S3.

Link copied to clipboard
sealed class JobStatus
Link copied to clipboard

Contains the job summary information.

Link copied to clipboard

The source details for the Kendra dataset source.

Link copied to clipboard

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class ListAssetsFilter
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class ListTimeSeriesType
Link copied to clipboard
class Location

Contains location information about the cited text and where it's stored.

Link copied to clipboard
sealed class LoggingLevel
Link copied to clipboard

Contains logging options.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
class 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).

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
sealed class MonitorErrorCode
Link copied to clipboard

Contains IoT SiteWise Monitor error details.

Link copied to clipboard

Contains information about the storage destination.

Link copied to clipboard
class Parquet

A parquet file.

Link copied to clipboard
sealed class Permission
Link copied to clipboard

Identifies an IoT SiteWise Monitor portal.

Link copied to clipboard
sealed class PortalState
Link copied to clipboard

Contains information about the current status of a portal.

Link copied to clipboard

Contains a portal summary.

Link copied to clipboard
sealed class PortalType
Link copied to clipboard

The configuration entry associated with the specific portal type. The portalTypeConfiguration is a map of the portalTypeKey to the PortalTypeEntry.

Link copied to clipboard

The precondition in one or more of the request-header fields evaluated to FALSE.

Link copied to clipboard

Identifies a specific IoT SiteWise Monitor project.

Link copied to clipboard

Contains project summary information.

Link copied to clipboard
class Property

Contains asset property information.

Link copied to clipboard
sealed class PropertyDataType
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

The value type of null asset property data with BAD and UNCERTAIN qualities.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class Quality
Link copied to clipboard

The query timed out.

Link copied to clipboard
sealed class RawValueType
Link copied to clipboard
class Reference

Contains the reference information.

Link copied to clipboard
class Resource

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

Link copied to clipboard

The resource already exists.

Link copied to clipboard

The requested resource can't be found.

Link copied to clipboard
sealed class ResourceType
Link copied to clipboard
sealed class ResponseStream

Contains the response, citation, and trace from the SiteWise Assistant.

Link copied to clipboard

The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.

Link copied to clipboard
class Row

Represents a single row in the query results.

Link copied to clipboard
sealed class ScalarType
Link copied to clipboard

The requested service is unavailable.

Link copied to clipboard
class SiemensIe

Contains details for a SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.

Link copied to clipboard
class Source

The data source for the dataset.

Link copied to clipboard

The details of the dataset source associated with the dataset.

Link copied to clipboard
sealed class StorageType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The resource the action will be taken on.

Link copied to clipboard
sealed class TargetResourceType
Link copied to clipboard

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

Link copied to clipboard

Contains a timestamp with optional nanosecond granularity.

Link copied to clipboard
sealed class TimeOrdering
Link copied to clipboard

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

Link copied to clipboard

You've reached the limit for the number of tags allowed for a resource. For more information, see Tag naming limits and requirements in the Amazon Web Services General Reference.

Link copied to clipboard
class Trace

Contains tracing information of the SiteWise Assistant's reasoning and data access.

Link copied to clipboard
class 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.

Link copied to clipboard

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.

Link copied to clipboard
sealed class TraversalDirection
Link copied to clipboard
sealed class TraversalType
Link copied to clipboard

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.

Link copied to clipboard

You are not authorized.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Contains information for a user identity in an access policy.

Link copied to clipboard

The validation failed for this query.

Link copied to clipboard

Identifies a property value used in an expression.

Link copied to clipboard
class Variant

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

Link copied to clipboard

Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.

Link copied to clipboard
sealed class WarmTierState