Module types

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.

AssetBindingValueFilter

A filter used to match data bindings based on a specific asset. This filter identifies all computation models referencing a particular asset in their data bindings.

AssetCompositeModel

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

AssetCompositeModelPathSegment

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

AssetCompositeModelSummary

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

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.

AssetModelBindingValueFilter

A filter used to match data bindings based on a specific asset model. This filter identifies all computation models referencing a particular asset model in their data bindings.

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.

AssetModelCompositeModelPathSegment

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

AssetModelCompositeModelSummary

Contains a summary of the composite 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.

AssetModelPropertyBindingValue

Contains information about an assetModelProperty binding value.

AssetModelPropertyBindingValueFilter

A filter used to match data bindings based on a specific asset model property. This filter identifies all computation models that reference a particular property of an asset model in their data bindings.

AssetModelPropertyDefinition

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

AssetModelPropertyPathSegment

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

AssetModelPropertySummary

Contains a summary of a property associated with a model. This includes information about which interfaces the property belongs to, if any.

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.

AssetPropertyBindingValue

Represents a data binding value referencing a specific asset property. It's used to bind computation model variables to actual asset property values for processing.

AssetPropertyBindingValueFilter

A filter used to match data bindings based on a specific asset property. This filter helps identify all computation models referencing a particular property of an asset in their data bindings.

AssetPropertyPathSegment

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

AssetPropertySummary

Contains a summary of a property associated with an asset.

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.

AssociatedAssetsSummary

Contains a summary of an associated asset.

Attribute

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

BatchGetAssetPropertyAggregatesEntry

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

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.

BatchGetAssetPropertyAggregatesErrorEntry

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

BatchGetAssetPropertyAggregatesErrorInfo

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

BatchGetAssetPropertyAggregatesSkippedEntry

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

BatchGetAssetPropertyAggregatesSuccessEntry

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

BatchGetAssetPropertyValueEntry

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

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.

BatchGetAssetPropertyValueErrorEntry

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

BatchGetAssetPropertyValueErrorInfo

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

BatchGetAssetPropertyValueHistoryEntry

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

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.

BatchGetAssetPropertyValueHistoryErrorEntry

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

BatchGetAssetPropertyValueHistoryErrorInfo

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

BatchGetAssetPropertyValueHistorySkippedEntry

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

BatchGetAssetPropertyValueHistorySuccessEntry

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

BatchGetAssetPropertyValueSkippedEntry

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

BatchGetAssetPropertyValueSuccessEntry

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

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.

Citation

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

ColumnInfo

A description of the column in the query results.

ColumnType

The data type of the column.

CompositeModelProperty

Contains information about a composite model property on an asset.

CompositionDetails

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

CompositionRelationshipItem

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

CompositionRelationshipSummary

Contains a summary of the components of the composite model.

ComputationModelAnomalyDetectionConfiguration

Contains the configuration of the type of anomaly detection computation model.

ComputationModelConfiguration

The configuration for the computation model.

ComputationModelDataBindingUsageSummary

A summary of how a specific data binding is used across computation models. This tracks dependencies between data sources and computation models, allowing you to understand the impact of changes to data sources.

ComputationModelDataBindingValue

Contains computation model data binding value information, which can be one of assetModelProperty, list.

ComputationModelResolveToResourceSummary

A summary of the resource that a computation model resolves to.

ComputationModelStatus

Contains current status information for a computation model.

ComputationModelSummary

Contains a summary of a computation model.

ConfigurationErrorDetails

Contains the details of an IoT SiteWise configuration error.

ConfigurationStatus

Contains current status information for the configuration.

Content

Contains the cited text from the data source.

Csv

A .CSV file.

CustomerManagedS3Storage

Contains information about a customer managed Amazon S3 bucket.

DashboardSummary

Contains a dashboard summary.

DataBindingValue

Represents a value used in a data binding. It can be an asset property or an asset model property.

DataBindingValueFilter

A filter used to match specific data binding values based on criteria. This filter allows searching for data bindings by asset, asset model, asset property, or asset model property.

DataSetReference

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

DatasetSource

The data source for the dataset.

DatasetStatus

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

DatasetSummary

The summary details for the dataset.

Datum

Represents a single data point in a query result.

DetailedError

Contains detailed error information.

ErrorDetails

Contains the details of an IoT SiteWise error.

ErrorReportLocation

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

ExecutionStatus

The status of the execution.

ExecutionSummary

Contains the execution summary of the computation model.

ExpressionVariable

Contains expression variable information.

File

The file in Amazon S3 where your data is saved.

FileFormat

The file format of the data in S3.

ForwardingConfig

The forwarding configuration for a given property.

GatewayCapabilitySummary

Contains a summary of a gateway capability configuration.

GatewayPlatform

The gateway's platform configuration. You can only specify one platform type in a gateway.

(Legacy only) For Greengrass V1 gateways, specify the greengrass parameter with a valid Greengrass group ARN.

For Greengrass V2 gateways, specify the greengrassV2 parameter with a valid core device thing name. If creating a V3 gateway (gatewayVersion=3), you must also specify the coreDeviceOperatingSystem.

For Siemens Industrial Edge gateways, specify the siemensIE parameter with a valid IoT Core thing name.

GatewaySummary

Contains a summary of a gateway.

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.

HierarchyMapping

Maps a hierarchy from an interface asset model to a hierarchy in the asset model where the interface is applied.

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.

Currently, you can't use Amazon Web Services API operations to retrieve IAM Identity Center identity IDs. You can find the IAM Identity Center identity IDs in the URL of user and group pages in the IAM Identity Center console.

Image

Contains an image that is one of the following:

An image file. Choose this option to upload a new image.
The ID of an existing image. Choose this option to keep an existing image.

ImageFile

Contains an image file.

ImageLocation

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

InterfaceRelationship

Contains information about the relationship between an asset model and an interface asset model that is applied to it.

InterfaceRelationshipSummary

Contains summary information about an interface relationship, which defines how an interface is applied to an asset model. This summary provides the essential identifiers needed to retrieve detailed information about the relationship.

InterfaceSummary

Contains summary information about an interface that a property belongs to.

InterpolatedAssetPropertyValue

Contains information about an interpolated asset property value.

InvocationOutput

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

JobConfiguration

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

JobSummary

Contains the job summary information.

KendraSourceDetail

The source details for the Kendra dataset source.

Location

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

LoggingOptions

Contains logging options.

MatchedDataBinding

Represents a data binding that matches the specified filter criteria.

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

The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a root metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE.

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

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.

Parquet

A parquet file.

PortalResource

Identifies an IoT SiteWise Monitor portal.

PortalStatus

Contains information about the current status of a portal.

PortalSummary

Contains a portal summary.

PortalTypeEntry

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

ProjectResource

Identifies a specific IoT SiteWise Monitor project.

ProjectSummary

Contains project summary information.

Property

Contains asset property information.

PropertyMapping

Maps a property from an interface asset model to a property in the asset model where the interface is applied.

PropertyMappingConfiguration

Contains configuration options for mapping properties from an interface asset model to an asset model where the interface is applied.

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.

PropertyValueNullValue

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

PutAssetPropertyValueEntry

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

Reference

Contains the reference information.

ResolveTo

The detailed resource this execution summary resolves to.

Resource

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

RetentionPeriod

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

Row

Represents a single row in the query results.

SiemensIe

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

Source

The data source for the dataset.

SourceDetail

The details of the dataset source associated with the dataset.

TargetResource

The resource the action will be taken on. This can include asset-based resources and computation model resources.

TimeInNanos

Contains a timestamp with optional nanosecond granularity.

TimeSeriesSummary

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

Trace

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

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.

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

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.

You can use m, h, d, and w when you specify an interval or offset. Note that m represents minutes, h represents hours, d represents days, and w represents weeks. You can also use s to represent seconds in offset.

The interval and offset parameters support the ISO 8601 format. For example, PT5S represents 5 seconds, PT5M represents 5 minutes, and PT5H represents 5 hours.

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

WarmTierRetentionPeriod

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.

Enums§

AggregateType: When writing a match expression against AggregateType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AssetErrorCode: When writing a match expression against AssetErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AssetModelState: When writing a match expression against AssetModelState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AssetModelType: When writing a match expression against AssetModelType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AssetModelVersionType: When writing a match expression against AssetModelVersionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AssetRelationshipType: When writing a match expression against AssetRelationshipType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AssetState: When writing a match expression against AssetState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AuthMode: When writing a match expression against AuthMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
BatchEntryCompletionStatus: When writing a match expression against BatchEntryCompletionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
BatchGetAssetPropertyAggregatesErrorCode: When writing a match expression against BatchGetAssetPropertyAggregatesErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
BatchGetAssetPropertyValueErrorCode: When writing a match expression against BatchGetAssetPropertyValueErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
BatchGetAssetPropertyValueHistoryErrorCode: When writing a match expression against BatchGetAssetPropertyValueHistoryErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
BatchPutAssetPropertyValueErrorCode: When writing a match expression against BatchPutAssetPropertyValueErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CapabilitySyncStatus: When writing a match expression against CapabilitySyncStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ColumnName: When writing a match expression against ColumnName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ComputationModelState: When writing a match expression against ComputationModelState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ComputationModelType: When writing a match expression against ComputationModelType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ComputeLocation: When writing a match expression against ComputeLocation, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ConfigurationState: When writing a match expression against ConfigurationState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CoreDeviceOperatingSystem: When writing a match expression against CoreDeviceOperatingSystem, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DatasetSourceFormat: When writing a match expression against DatasetSourceFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DatasetSourceType: When writing a match expression against DatasetSourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DatasetState: When writing a match expression against DatasetState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DetailedErrorCode: When writing a match expression against DetailedErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DisassociatedDataStorageState: When writing a match expression against DisassociatedDataStorageState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EncryptionType: When writing a match expression against EncryptionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ErrorCode: When writing a match expression against ErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ExecutionState: When writing a match expression against ExecutionState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ForwardingConfigState: When writing a match expression against ForwardingConfigState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
IdentityType: When writing a match expression against IdentityType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ImageFileType: When writing a match expression against ImageFileType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
JobStatus: When writing a match expression against JobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ListAssetModelPropertiesFilter: When writing a match expression against ListAssetModelPropertiesFilter, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ListAssetPropertiesFilter: When writing a match expression against ListAssetPropertiesFilter, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ListAssetsFilter: When writing a match expression against ListAssetsFilter, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ListBulkImportJobsFilter: When writing a match expression against ListBulkImportJobsFilter, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ListTimeSeriesType: When writing a match expression against ListTimeSeriesType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
LoggingLevel: When writing a match expression against LoggingLevel, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
MonitorErrorCode: When writing a match expression against MonitorErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
Permission: When writing a match expression against Permission, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PortalState: When writing a match expression against PortalState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PortalType: When writing a match expression against PortalType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PropertyDataType: When writing a match expression against PropertyDataType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PropertyNotificationState: When writing a match expression against PropertyNotificationState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
Quality: When writing a match expression against Quality, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RawValueType: When writing a match expression against RawValueType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ResolveToResourceType: When writing a match expression against ResolveToResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ResourceType: When writing a match expression against ResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ResponseStream: Contains the response, citation, and trace from the SiteWise Assistant.
ScalarType: When writing a match expression against ScalarType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
StorageType: When writing a match expression against StorageType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TargetResourceType: When writing a match expression against TargetResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TimeOrdering: When writing a match expression against TimeOrdering, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TraversalDirection: When writing a match expression against TraversalDirection, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TraversalType: When writing a match expression against TraversalType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
WarmTierState: When writing a match expression against WarmTierState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Module types

Module types Copy item path

Modules§

Structs§

Enums§

Module types