Module Awso_iotsitewise.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule ARN : sig ... end
Sourcemodule ErrorMessage : sig ... end
Sourcemodule AccessDeniedException : sig ... end

Access is denied.

Sourcemodule Timestamp : sig ... end
Sourcemodule ID : sig ... end
Sourcemodule ProjectResource : sig ... end

Identifies a specific IoT SiteWise Monitor project.

Sourcemodule PortalResource : sig ... end

Identifies an IoT SiteWise Monitor portal.

Sourcemodule Resource : sig ... end

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

Sourcemodule Permission : sig ... end
Sourcemodule IdentityId : sig ... end
Sourcemodule UserIdentity : sig ... end

Contains information for a user identity in an access policy.

Sourcemodule IamArn : sig ... end
Sourcemodule IAMUserIdentity : sig ... end

Contains information about an Identity and Access Management user.

Sourcemodule IAMRoleIdentity : sig ... end

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

Sourcemodule GroupIdentity : sig ... end

Contains information for a group identity in an access policy.

Sourcemodule Identity : sig ... end

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.

Sourcemodule AccessPolicySummary : sig ... end

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

Sourcemodule AccessPolicySummaries : sig ... end
Sourcemodule Name : sig ... end
Sourcemodule ActionDefinition : sig ... end

Contains a definition for an action.

Sourcemodule ActionDefinitions : sig ... end
Sourcemodule ActionPayloadString : sig ... end
Sourcemodule ActionPayload : sig ... end

The JSON payload of the action.

Sourcemodule TargetResource : sig ... end

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

Sourcemodule ResolveTo : sig ... end

The detailed resource this execution summary resolves to.

Sourcemodule ActionSummary : sig ... end

Contains the summary of the actions, including information about where the action resolves to.

Sourcemodule ActionSummaries : sig ... end
Sourcemodule AdaptiveIngestion : sig ... end
Sourcemodule AggregateType : sig ... end
Sourcemodule AggregateTypes : sig ... end
Sourcemodule AggregatedDoubleValue : sig ... end
Sourcemodule Quality : sig ... end
Sourcemodule Aggregates : sig ... end

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

Sourcemodule AggregatedValue : sig ... end

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

Sourcemodule AggregatedValues : sig ... end
Sourcemodule Alarms : sig ... end

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.

Sourcemodule AmazonResourceName : sig ... end
Sourcemodule AssetBindingValueFilter : sig ... end

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.

Sourcemodule ExternalId : sig ... end
Sourcemodule Description : sig ... end
Sourcemodule PropertyUnit : sig ... end
Sourcemodule PropertyNotificationTopic : sig ... end
Sourcemodule PropertyNotificationState : sig ... end
Sourcemodule PropertyNotification : sig ... end

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.

Sourcemodule PropertyDataType : sig ... end
Sourcemodule PropertyAlias : sig ... end
Sourcemodule AssetPropertyPathSegment : sig ... end

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

Sourcemodule AssetPropertyPath : sig ... end
Sourcemodule AssetProperty : sig ... end

Contains asset property information.

Sourcemodule AssetProperties : sig ... end
Sourcemodule AssetCompositeModel : sig ... end

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

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

Sourcemodule AssetCompositeModelPath : sig ... end

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

Sourcemodule AssetCompositeModels : sig ... end
Sourcemodule AssetErrorCode : sig ... end
Sourcemodule AssetErrorMessage : sig ... end
Sourcemodule AssetErrorDetails : sig ... end

Contains error details for the requested associate project asset action.

Sourcemodule AssetHierarchy : sig ... end

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

Sourcemodule AssetHierarchies : sig ... end
Sourcemodule AssetHierarchyInfo : sig ... end

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

Sourcemodule AssetIDs : sig ... end

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.

Sourcemodule CustomID : sig ... end
Sourcemodule ForwardingConfigState : sig ... end
Sourcemodule ForwardingConfig : sig ... end

The forwarding configuration for a given property.

Sourcemodule ComputeLocation : sig ... end
Sourcemodule TransformProcessingConfig : sig ... end

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.

Sourcemodule Macro : sig ... end

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

Sourcemodule AssetModelPropertyPath : sig ... end
Sourcemodule VariableValue : sig ... end

Identifies a property value used in an expression.

Sourcemodule VariableName : sig ... end
Sourcemodule ExpressionVariable : sig ... end

Contains expression variable information.

Sourcemodule ExpressionVariables : sig ... end
Sourcemodule Expression : sig ... end
Sourcemodule Transform : sig ... end

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.

Sourcemodule Offset : sig ... end
Sourcemodule Interval : sig ... end
Sourcemodule TumblingWindow : sig ... end

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.

Sourcemodule MetricWindow : sig ... end

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

Sourcemodule MetricProcessingConfig : sig ... end

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.

Sourcemodule Metric : sig ... end

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.

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.

Sourcemodule Measurement : sig ... end

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

Sourcemodule DefaultValue : sig ... end
Sourcemodule Attribute : sig ... end

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

Sourcemodule PropertyType : sig ... end

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

Sourcemodule AssetModelProperty : sig ... end

Contains information about an asset model property.

Sourcemodule AssetModelProperties : sig ... end
Sourcemodule AssetModelCompositeModel : sig ... end

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

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

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

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

Contains a summary of the composite model.

Sourcemodule AssetModelCompositeModels : sig ... end
Sourcemodule AssetModelHierarchy : sig ... end

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.

Sourcemodule AssetModelHierarchies : sig ... end

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.

Contains information about an assetModelProperty binding value.

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.

Sourcemodule InterfaceSummary : sig ... end

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

Sourcemodule InterfaceSummaries : sig ... end
Sourcemodule AssetModelPropertySummary : sig ... end

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

Sourcemodule AssetModelState : sig ... end
Sourcemodule ErrorCode : sig ... end
Sourcemodule DetailedErrorMessage : sig ... end
Sourcemodule DetailedErrorCode : sig ... end
Sourcemodule DetailedError : sig ... end

Contains detailed error information.

Sourcemodule DetailedErrors : sig ... end
Sourcemodule ErrorDetails : sig ... end

Contains the details of an IoT SiteWise error.

Sourcemodule AssetModelStatus : sig ... end

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

Sourcemodule Version : sig ... end
Sourcemodule AssetModelType : sig ... end
Sourcemodule AssetModelSummary : sig ... end

Contains a summary of an asset model.

Sourcemodule AssetModelSummaries : sig ... end
Sourcemodule AssetModelVersionFilter : sig ... end
Sourcemodule AssetModelVersionType : sig ... end
Sourcemodule AssetPropertyAlias : sig ... end
Sourcemodule AssetPropertyBindingValue : sig ... end

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.

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.

Sourcemodule AssetPropertySummary : sig ... end

Contains a summary of a property associated with an asset.

Sourcemodule AssetPropertySummaries : sig ... end
Sourcemodule PropertyValueStringValue : sig ... end
Sourcemodule RawValueType : sig ... end
Sourcemodule PropertyValueNullValue : sig ... end

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

Sourcemodule PropertyValueIntegerValue : sig ... end
Sourcemodule PropertyValueDoubleValue : sig ... end
Sourcemodule PropertyValueBooleanValue : sig ... end
Sourcemodule Variant : sig ... end

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

Sourcemodule TimeInSeconds : sig ... end
Sourcemodule OffsetInNanos : sig ... end
Sourcemodule TimeInNanos : sig ... end

Contains a timestamp with optional nanosecond granularity.

Sourcemodule AssetPropertyValue : sig ... end

Contains asset property value information.

Sourcemodule AssetPropertyValueHistory : sig ... end
Sourcemodule AssetPropertyValues : sig ... end
Sourcemodule AssetRelationshipType : sig ... end
Sourcemodule AssetRelationshipSummary : sig ... end

Contains information about assets that are related to one another.

Sourcemodule AssetState : sig ... end
Sourcemodule AssetStatus : sig ... end

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

Sourcemodule AssetSummary : sig ... end

Contains a summary of an asset.

Sourcemodule AssetSummaries : sig ... end
Sourcemodule ClientToken : sig ... end
Sourcemodule AssociateAssetsRequest : sig ... end

Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide.

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

Sourcemodule AssociatedAssetsSummary : sig ... end

Contains a summary of an associated asset.

Sourcemodule AssociatedAssetsSummaries : sig ... end
Sourcemodule AuthMode : sig ... end
Sourcemodule IDs : sig ... end

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

Sourcemodule ThrottlingException : sig ... end

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. For more information, see Quotas in the IoT SiteWise User Guide.

Sourcemodule ResourceNotFoundException : sig ... end

The requested resource can't be found.

Sourcemodule LimitExceededException : sig ... end

You've reached the quota 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. For more information, see Quotas in the IoT SiteWise User Guide.

Sourcemodule InvalidRequestException : sig ... end

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

Sourcemodule InternalFailureException : sig ... end

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

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

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

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

Sourcemodule TimeOrdering : sig ... end
Sourcemodule Resolution : sig ... end
Sourcemodule Qualities : sig ... end
Sourcemodule EntryId : sig ... end

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.

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

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

Sourcemodule NextToken : sig ... end

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.

The requested service is unavailable.

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

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

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.

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.

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

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

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.

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.

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

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

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

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

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

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

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

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

Sourcemodule Timestamps : sig ... end

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

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

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

Sourcemodule BooleanValue : sig ... end

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.

Sourcemodule ResourceId : sig ... end
Sourcemodule ResourceArn : sig ... end

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.

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.

module BindingValueList : sig ... end

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

Sourcemodule Bucket : sig ... end
Sourcemodule CapabilityConfiguration : sig ... end
Sourcemodule CapabilityNamespace : sig ... end
Sourcemodule CapabilitySyncStatus : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule Location : sig ... end

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

Sourcemodule Source : sig ... end

The data source for the dataset.

Sourcemodule DataSetReference : sig ... end

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

Sourcemodule Reference : sig ... end

Contains the reference information.

Sourcemodule Content : sig ... end

Contains the cited text from the data source.

Sourcemodule Citation : sig ... end

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

Sourcemodule Citations : sig ... end
Sourcemodule ScalarType : sig ... end
Sourcemodule ColumnType : sig ... end

The data type of the column.

Sourcemodule ColumnInfo : sig ... end

A description of the column in the query results.

Sourcemodule ColumnName : sig ... end
Sourcemodule ColumnNames : sig ... end
Sourcemodule ColumnsList : sig ... end
Sourcemodule Property : sig ... end

Contains asset property information.

Sourcemodule CompositeModelProperty : sig ... end

Contains information about a composite model property on an asset.

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

Sourcemodule CompositionRelationship : sig ... end
Sourcemodule CompositionDetails : sig ... end

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

Contains a summary of the components of the composite model.

Sourcemodule ResultProperty : sig ... end
Sourcemodule InputProperties : sig ... end

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

The configuration for the computation model.

Sourcemodule DataBindingValue : sig ... end

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

Sourcemodule MatchedDataBinding : sig ... end

Represents a data binding that matches the specified filter criteria.

Sourcemodule ComputationModelIdList : sig ... end

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.

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

Sourcemodule ComputationModelState : sig ... end
Sourcemodule ComputationModelStatus : sig ... end

Contains current status information for a computation model.

Sourcemodule RestrictedName : sig ... end
Sourcemodule RestrictedDescription : sig ... end
Sourcemodule ComputationModelType : sig ... end
Sourcemodule ComputationModelSummary : sig ... end

Contains a summary of a computation model.

Sourcemodule ComputationModelSummaries : sig ... end
Sourcemodule ConfigurationErrorDetails : sig ... end

Contains the details of an IoT SiteWise configuration error.

Sourcemodule ConfigurationState : sig ... end
Sourcemodule ConfigurationStatus : sig ... end

Contains current status information for the configuration.

Sourcemodule ConversationId : sig ... end
Sourcemodule CoreDeviceOperatingSystem : sig ... end
Sourcemodule CoreDeviceThingName : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule TagMap : sig ... end
Sourcemodule CreateAccessPolicyRequest : sig ... end

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. Support for access policies that use an SSO Group as the identity is not supported at this time.

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. Support for access policies that use an SSO Group as the identity is not supported at this time.

Sourcemodule SelectAll : sig ... end
Sourcemodule ETag : sig ... end

Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and component-model-based. Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provides its associated properties to any created assets. For more information, see Custom composite models (Components) in the IoT SiteWise User Guide. Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are included and can't be used to create multiple assets. To create a component-model-based model, specify the composedAssetModelId of an existing asset model with assetModelType of COMPONENT_MODEL. To create an inline model, specify the assetModelCompositeModelProperties and don't include an composedAssetModelId.

The resource already exists.

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

Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and component-model-based. Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provides its associated properties to any created assets. For more information, see Custom composite models (Components) in the IoT SiteWise User Guide. Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are included and can't be used to create multiple assets. To create a component-model-based model, specify the composedAssetModelId of an existing asset model with assetModelType of COMPONENT_MODEL. To create an inline model, specify the assetModelCompositeModelProperties and don't include an composedAssetModelId.

Sourcemodule CreateAssetModelRequest : sig ... end

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. You can create three types of asset models, ASSET_MODEL, COMPONENT_MODEL, or an INTERFACE. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model. INTERFACE – An interface is a type of model that defines a standard structure that can be applied to different asset models.

Sourcemodule CreateAssetModelResponse : sig ... end

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. You can create three types of asset models, ASSET_MODEL, COMPONENT_MODEL, or an INTERFACE. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model. INTERFACE – An interface is a type of model that defines a standard structure that can be applied to different asset models.

Sourcemodule CreateAssetRequest : sig ... end

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

Sourcemodule CreateAssetResponse : sig ... end

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

Sourcemodule Parquet : sig ... end

A parquet file.

Sourcemodule Csv : sig ... end

A .CSV file.

Sourcemodule FileFormat : sig ... end

The file format of the data in S3.

Sourcemodule JobConfiguration : sig ... end

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

Sourcemodule File : sig ... end

The file in Amazon S3 where your data is saved.

Sourcemodule Files : sig ... end
Sourcemodule ErrorReportLocation : sig ... end

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

Sourcemodule DeleteFilesAfterImport : sig ... end

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. Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration. Bulk import is designed to store historical data to IoT SiteWise. Newly ingested data in the hot tier triggers notifications and computations. After data moves from the hot tier to the warm or cold tier based on retention settings, it does not trigger computations or notifications. Data older than 7 days does not trigger computations or notifications.

Sourcemodule JobStatus : sig ... end

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. Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration. Bulk import is designed to store historical data to IoT SiteWise. Newly ingested data in the hot tier triggers notifications and computations. After data moves from the hot tier to the warm or cold tier based on retention settings, it does not trigger computations or notifications. Data older than 7 days does not trigger computations or notifications.

Create a computation model with a configuration and data binding.

Create a computation model with a configuration and data binding.

Sourcemodule DashboardDefinition : sig ... end
Sourcemodule CreateDashboardRequest : sig ... end

Creates a dashboard in an IoT SiteWise Monitor project.

Sourcemodule CreateDashboardResponse : sig ... end

Creates a dashboard in an IoT SiteWise Monitor project.

Sourcemodule KendraSourceDetail : sig ... end

The source details for the Kendra dataset source.

Sourcemodule SourceDetail : sig ... end

The details of the dataset source associated with the dataset.

Sourcemodule DatasetSourceType : sig ... end
Sourcemodule DatasetSourceFormat : sig ... end
Sourcemodule DatasetSource : sig ... end

The data source for the dataset.

Sourcemodule CreateDatasetRequest : sig ... end

Creates a dataset to connect an external datasource.

Sourcemodule DatasetState : sig ... end
Sourcemodule DatasetStatus : sig ... end

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

Sourcemodule CreateDatasetResponse : sig ... end

Creates a dataset to connect an external datasource.

Sourcemodule GatewayVersion : sig ... end

The version of the gateway. Options include: 2 - Classic streams, V2 gateway. 3 - MQTT-enabled, V3 gateway.

Sourcemodule IotCoreThingName : sig ... end
Sourcemodule SiemensIE : sig ... end

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

Sourcemodule GreengrassV2 : sig ... end

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.

Sourcemodule Greengrass : sig ... end

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.

Sourcemodule GatewayPlatform : sig ... end

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.

Sourcemodule GatewayName : sig ... end
Sourcemodule CreateGatewayRequest : sig ... end

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.

Sourcemodule CreateGatewayResponse : sig ... end

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.

Sourcemodule CreateMissingProperty : sig ... end
Sourcemodule PortalTypeKey : sig ... end
Sourcemodule PortalTools : sig ... end
Sourcemodule PortalTypeEntry : sig ... end

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

Sourcemodule PortalTypeConfiguration : sig ... end
Sourcemodule PortalType : sig ... end
Sourcemodule ImageFileType : sig ... end
Sourcemodule ImageFileData : sig ... end
Sourcemodule ImageFile : sig ... end

Contains an image file.

Sourcemodule Email : sig ... end
Sourcemodule CreatePortalRequest : sig ... end

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.

Sourcemodule Url : sig ... end
Sourcemodule SSOApplicationId : sig ... end
Sourcemodule PortalState : sig ... end
Sourcemodule MonitorErrorMessage : sig ... end
Sourcemodule MonitorErrorCode : sig ... end
Sourcemodule MonitorErrorDetails : sig ... end

Contains IoT SiteWise Monitor error details.

Sourcemodule PortalStatus : sig ... end

Contains information about the current status of a portal.

Sourcemodule CreatePortalResponse : sig ... end

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.

Sourcemodule CreateProjectRequest : sig ... end

Creates a project in the specified portal. Make sure that the project name and description don't contain confidential information.

Sourcemodule CreateProjectResponse : sig ... end

Creates a project in the specified portal. Make sure that the project name and description don't contain confidential information.

Sourcemodule CustomerManagedS3Storage : sig ... end

Contains information about a customer managed Amazon S3 bucket.

Sourcemodule DashboardSummary : sig ... end

Contains a dashboard summary.

Sourcemodule DashboardSummaries : sig ... end
Sourcemodule DataBindingValueFilter : sig ... end

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.

Sourcemodule DatasetSummary : sig ... end

The summary details for the dataset.

Sourcemodule DatasetSummaries : sig ... end
Sourcemodule ScalarValue : sig ... end
Sourcemodule NullableBoolean : sig ... end
module Datum : sig ... end

Represents a single data point in a query result.

module DatumList : sig ... end
module Row : sig ... end

Represents a single row in the query results.

Sourcemodule DeleteAccessPolicyRequest : sig ... end

Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor resource.

Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor resource.

Deletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can't delete a composite model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

Deletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can't delete a composite model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

Deletes an interface relationship between an asset model and an interface asset model.

Deletes an interface relationship between an asset model and an interface asset model.

Sourcemodule DeleteAssetModelRequest : sig ... end

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.

Sourcemodule DeleteAssetModelResponse : sig ... end

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.

Sourcemodule DeleteAssetRequest : sig ... end

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.

Sourcemodule DeleteAssetResponse : sig ... end

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.

Deletes a computation model. This action can't be undone.

Deletes a computation model. This action can't be undone.

Sourcemodule DeleteDashboardRequest : sig ... end

Deletes a dashboard from IoT SiteWise Monitor.

Sourcemodule DeleteDashboardResponse : sig ... end

Deletes a dashboard from IoT SiteWise Monitor.

Sourcemodule DeleteDatasetRequest : sig ... end

Deletes a dataset. This cannot be undone.

Sourcemodule DeleteDatasetResponse : sig ... end

Deletes a dataset. This cannot be undone.

Sourcemodule DeleteGatewayRequest : sig ... end

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

Sourcemodule DeletePortalRequest : sig ... end

Deletes a portal from IoT SiteWise Monitor.

Sourcemodule DeletePortalResponse : sig ... end

Deletes a portal from IoT SiteWise Monitor.

Sourcemodule DeleteProjectRequest : sig ... end

Deletes a project from IoT SiteWise Monitor.

Sourcemodule DeleteProjectResponse : sig ... end

Deletes a project from IoT SiteWise Monitor.

Sourcemodule DeleteTimeSeriesRequest : sig ... end

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.

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

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

Sourcemodule DescribeActionRequest : sig ... end

Retrieves information about an action.

Sourcemodule DescribeActionResponse : sig ... end

Retrieves information about an action.

Retrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.

Retrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.

Retrieves information about an asset model composite model (also known as an asset model component). For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.

Retrieves information about an asset model composite model (also known as an asset model component). For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.

Retrieves information about an interface relationship between an asset model and an interface asset model.

Sourcemodule PropertyMapping : sig ... end

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

Sourcemodule PropertyMappings : sig ... end
Sourcemodule HierarchyMapping : sig ... end

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

Sourcemodule HierarchyMappings : sig ... end

Retrieves information about an interface relationship between an asset model and an interface asset model.

Sourcemodule ExcludeProperties : sig ... end
Sourcemodule DescribeAssetModelRequest : sig ... end

Retrieves information about an asset model. This includes details about the asset model's properties, hierarchies, composite models, and any interface relationships if the asset model implements interfaces.

Sourcemodule InterfaceRelationship : sig ... end

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

Sourcemodule InterfaceDetails : sig ... end

Retrieves information about an asset model. This includes details about the asset model's properties, hierarchies, composite models, and any interface relationships if the asset model implements interfaces.

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.

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.

Sourcemodule DescribeAssetRequest : sig ... end

Retrieves information about an asset.

Sourcemodule DescribeAssetResponse : sig ... end

Retrieves information about an asset.

Retrieves information about a bulk import job request. For more information, see Describe a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.

Retrieves information about a bulk import job request. For more information, see Describe a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.

Sourcemodule ResolveToResourceType : sig ... end

Retrieves information about the execution summary of a computation model.

Retrieves information about the execution summary of a computation model.

Retrieves information about a computation model.

Retrieves information about a computation model.

Sourcemodule DescribeDashboardRequest : sig ... end

Retrieves information about a dashboard.

Sourcemodule DescribeDashboardResponse : sig ... end

Retrieves information about a dashboard.

Sourcemodule DescribeDatasetRequest : sig ... end

Retrieves information about a dataset.

Sourcemodule DescribeDatasetResponse : sig ... end

Retrieves information about a dataset.

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.

Sourcemodule EncryptionType : sig ... end

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.

Sourcemodule DescribeExecutionRequest : sig ... end

Retrieves information about the execution.

Sourcemodule ExecutionState : sig ... end
Sourcemodule ExecutionStatus : sig ... end

The status of the execution.

Sourcemodule ExecutionResultValue : sig ... end
Sourcemodule ExecutionResultKey : sig ... end
Sourcemodule ExecutionResult : sig ... end
Sourcemodule ExecutionDetailsValue : sig ... end
Sourcemodule ExecutionDetailsKey : sig ... end
Sourcemodule ExecutionDetails : sig ... end
Sourcemodule DescribeExecutionResponse : sig ... end

Retrieves information about the execution.

Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability. . The namespace follows the format service:capability:version, where: service - The service providing the capability, or iotsitewise. capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability. version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways. After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied. A gateway can have multiple capability configurations with different namespaces.

Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability. . The namespace follows the format service:capability:version, where: service - The service providing the capability, or iotsitewise. capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability. version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways. After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied. A gateway can have multiple capability configurations with different namespaces.

Sourcemodule DescribeGatewayRequest : sig ... end

Retrieves information about a gateway.

Sourcemodule GatewayCapabilitySummary : sig ... end

Contains a summary of a gateway capability configuration.

Sourcemodule DescribeGatewayResponse : sig ... end

Retrieves information about a gateway.

Retrieves the current IoT SiteWise logging options.

Sourcemodule LoggingLevel : sig ... end
Sourcemodule LoggingOptions : sig ... end

Contains logging options.

Retrieves the current IoT SiteWise logging options.

Sourcemodule DescribePortalRequest : sig ... end

Retrieves information about a portal.

Sourcemodule PortalClientId : sig ... end
Sourcemodule ImageLocation : sig ... end

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

Sourcemodule DescribePortalResponse : sig ... end

Retrieves information about a portal.

Sourcemodule DescribeProjectRequest : sig ... end

Retrieves information about a project.

Sourcemodule DescribeProjectResponse : sig ... end

Retrieves information about a project.

Retrieves information about the storage configuration for IoT SiteWise.

Sourcemodule WarmTierState : sig ... end
Sourcemodule Unlimited : sig ... end
Sourcemodule NumberOfDays : sig ... end
Sourcemodule WarmTierRetentionPeriod : sig ... end

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.

Sourcemodule StorageType : sig ... end
Sourcemodule RetentionPeriod : sig ... end

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

Sourcemodule MultiLayerStorage : sig ... end

Contains information about the storage destination.

Sourcemodule DisallowIngestNullNaN : sig ... end

Retrieves information about the storage configuration for IoT SiteWise.

Sourcemodule DescribeTimeSeriesRequest : sig ... end

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.

Sourcemodule TimeSeriesId : sig ... end

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.

Sourcemodule DisassociateAssetsRequest : sig ... end

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

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

Sourcemodule ExceptionMessage : sig ... end
Sourcemodule ExecuteActionRequest : sig ... end

Executes an action on a target resource.

Sourcemodule ExecuteActionResponse : sig ... end

Executes an action on a target resource.

Sourcemodule ExecuteQueryMaxResults : sig ... end
Sourcemodule ExecuteQueryNextToken : sig ... end
Sourcemodule QueryStatement : sig ... end
Sourcemodule ExecuteQueryRequest : sig ... end

Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.

Sourcemodule ValidationException : sig ... end

The validation failed for this query.

Sourcemodule Rows : sig ... end
Sourcemodule QueryTimeoutException : sig ... end

The query timed out.

Sourcemodule ExecuteQueryResponse : sig ... end

Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.

Sourcemodule ExecutionSummary : sig ... end

Contains the execution summary of the computation model.

Sourcemodule ExecutionSummaries : sig ... end
Sourcemodule GatewaySummary : sig ... end

Contains a summary of a gateway.

Sourcemodule GatewaySummaries : sig ... end

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.

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.

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.

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.

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.

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.

Sourcemodule MaxInterpolatedResults : sig ... end
Sourcemodule IntervalWindowInSeconds : sig ... end
Sourcemodule IntervalInSeconds : sig ... end
Sourcemodule InterpolationType : sig ... end

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.

Contains information about an interpolated asset property value.

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.

Sourcemodule IdentityType : sig ... end
Sourcemodule Image : sig ... end

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.

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.

Sourcemodule InvocationOutput : sig ... end

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

Sourcemodule PrimitiveBoolean : sig ... end
Sourcemodule MessageInput : sig ... end
Sourcemodule InvokeAssistantRequest : sig ... end

Invokes SiteWise Assistant to start or continue a conversation.

Sourcemodule Trace : sig ... end

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

Sourcemodule ResponseStream : sig ... end

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

Sourcemodule InvokeAssistantResponse : sig ... end

Invokes SiteWise Assistant to start or continue a conversation.

Sourcemodule JobSummary : sig ... end

Contains the job summary information.

Sourcemodule JobSummaries : sig ... end
Sourcemodule KmsKeyId : sig ... end
Sourcemodule ResourceType : sig ... end
Sourcemodule MaxResults : sig ... end
Sourcemodule ListAccessPoliciesRequest : sig ... end

Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).

Retrieves a paginated list of 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).

Sourcemodule TargetResourceType : sig ... end
Sourcemodule ListActionsRequest : sig ... end

Retrieves a paginated list of actions for a specific target resource.

Sourcemodule ListActionsResponse : sig ... end

Retrieves a paginated list of actions for a specific target resource.

Retrieves a paginated list of composite models associated with the asset model

Retrieves a paginated list of composite models associated with the asset model

Retrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.

Retrieves a paginated list of 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.

Sourcemodule ListAssetModelsTypeFilter : sig ... end
Sourcemodule ListAssetModelsRequest : sig ... end

Retrieves a paginated list of summaries of all asset models.

Sourcemodule ListAssetModelsResponse : sig ... end

Retrieves a paginated list of summaries of all asset models.

Sourcemodule ListAssetPropertiesFilter : sig ... end

Retrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.

Retrieves a paginated list of 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.

Sourcemodule TraversalType : sig ... end

Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.

Retrieves a paginated list of asset 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.

Sourcemodule ListAssetsFilter : sig ... end
Sourcemodule ListAssetsRequest : sig ... end

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.

Sourcemodule ListAssetsResponse : sig ... end

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.

Sourcemodule TraversalDirection : sig ... end

Retrieves a paginated list of associated assets. You can use this operation to do the following: CHILD - List all child assets associated to the asset. PARENT - List the asset's parent asset.

Retrieves a paginated list of associated assets. You can use this operation to do the following: CHILD - List all child assets associated to the asset. PARENT - List the asset's parent asset.

Sourcemodule ListBulkImportJobsFilter : sig ... end
Sourcemodule ListBulkImportJobsRequest : sig ... end

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

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

Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.

Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.

Lists all data binding usages for computation models. This allows to identify where specific data bindings are being utilized across the computation models. This track dependencies between data sources and computation models.

Lists all data binding usages for computation models. This allows to identify where specific data bindings are being utilized across the computation models. This track dependencies between data sources and computation models.

Lists all distinct resources that are resolved from the executed actions of the computation model.

Lists all distinct resources that are resolved from the executed actions of the computation model.

Retrieves a paginated list of summaries of all computation models.

Retrieves a paginated list of summaries of all computation models.

Sourcemodule ListDashboardsRequest : sig ... end

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

Sourcemodule ListDashboardsResponse : sig ... end

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

Sourcemodule ListDatasetsRequest : sig ... end

Retrieves a paginated list of datasets for a specific target resource.

Sourcemodule ListDatasetsResponse : sig ... end

Retrieves a paginated list of datasets for a specific target resource.

Sourcemodule ListExecutionsRequest : sig ... end

Retrieves a paginated list of summaries of all executions.

Sourcemodule ListExecutionsResponse : sig ... end

Retrieves a paginated list of summaries of all executions.

Sourcemodule ListGatewaysRequest : sig ... end

Retrieves a paginated list of gateways.

Sourcemodule ListGatewaysResponse : sig ... end

Retrieves a paginated list of gateways.

Retrieves a paginated list of asset models that have a specific interface asset model applied to them.

Retrieves a paginated list of asset models that have a specific interface asset model applied to them.

Sourcemodule ListPortalsRequest : sig ... end

Retrieves a paginated list of IoT SiteWise Monitor portals.

Sourcemodule PortalSummary : sig ... end

Contains a portal summary.

Sourcemodule PortalSummaries : sig ... end
Sourcemodule ListPortalsResponse : sig ... end

Retrieves a paginated list of IoT SiteWise Monitor portals.

Sourcemodule ListProjectAssetsRequest : sig ... end

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

Sourcemodule ListProjectAssetsResponse : sig ... end

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

Sourcemodule ListProjectsRequest : sig ... end

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

Sourcemodule ProjectSummary : sig ... end

Contains project summary information.

Sourcemodule ProjectSummaries : sig ... end
Sourcemodule ListProjectsResponse : sig ... end

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

Retrieves the list of tags for an IoT SiteWise resource.

Sourcemodule UnauthorizedException : sig ... end

You are not authorized.

Retrieves the list of tags for an IoT SiteWise resource.

Sourcemodule ListTimeSeriesType : sig ... end
Sourcemodule ListTimeSeriesRequest : sig ... end

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

Sourcemodule TimeSeriesSummary : sig ... end

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

Sourcemodule TimeSeriesSummaries : sig ... end
Sourcemodule ListTimeSeriesResponse : sig ... end

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

Sourcemodule MatchByPropertyName : sig ... end

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

Creates or updates an interface relationship between an asset model and an interface asset model. This operation applies an interface to an asset model.

Creates or updates an interface relationship between an asset model and an interface asset model. This operation applies an interface to an asset model.

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

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

Sourcemodule PutLoggingOptionsRequest : sig ... end

Sets logging options for IoT SiteWise.

Sourcemodule PutLoggingOptionsResponse : sig ... end

Sets logging options for IoT SiteWise.

Configures storage settings for IoT SiteWise.

Configures storage settings for IoT SiteWise.

Sourcemodule TagKeyList : sig ... end
Sourcemodule TagResourceRequest : sig ... end

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

Sourcemodule TooManyTagsException : sig ... end

You've reached the quota 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.

Sourcemodule TagResourceResponse : sig ... end

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

Sourcemodule UntagResourceRequest : sig ... end

Removes a tag from an IoT SiteWise resource.

Sourcemodule UntagResourceResponse : sig ... end

Removes a tag from an IoT SiteWise resource.

Sourcemodule UpdateAccessPolicyRequest : sig ... end

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

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

Updates a composite model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide. If you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property. To replace an existing composite asset model property with a new one with the same name, do the following: Submit an UpdateAssetModelCompositeModel request with the entire existing property removed. Submit a second UpdateAssetModelCompositeModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.

Updates a composite model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide. If you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property. To replace an existing composite asset model property with a new one with the same name, do the following: Submit an UpdateAssetModelCompositeModel request with the entire existing property removed. Submit a second UpdateAssetModelCompositeModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.

Sourcemodule UpdateAssetModelRequest : sig ... end

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. If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property. To replace an existing asset model property with a new one with the same name, do the following: Submit an UpdateAssetModel request with the entire existing property removed. Submit a second UpdateAssetModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.

Sourcemodule UpdateAssetModelResponse : sig ... end

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. If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property. To replace an existing asset model property with a new one with the same name, do the following: Submit an UpdateAssetModel request with the entire existing property removed. Submit a second UpdateAssetModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.

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.

Sourcemodule UpdateAssetRequest : sig ... end

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

Sourcemodule UpdateAssetResponse : sig ... end

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

Updates the computation model.

Updates the computation model.

Sourcemodule UpdateDashboardRequest : sig ... end

Updates an IoT SiteWise Monitor dashboard.

Sourcemodule UpdateDashboardResponse : sig ... end

Updates an IoT SiteWise Monitor dashboard.

Sourcemodule UpdateDatasetRequest : sig ... end

Updates a dataset.

Sourcemodule UpdateDatasetResponse : sig ... end

Updates a dataset.

Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. Important workflow notes: Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability. . The namespace follows the format service:capability:version, where: service - The service providing the capability, or iotsitewise. capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability. version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways. After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied. A gateway can have multiple capability configurations with different namespaces.

Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. Important workflow notes: Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability. . The namespace follows the format service:capability:version, where: service - The service providing the capability, or iotsitewise. capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability. version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways. After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied. A gateway can have multiple capability configurations with different namespaces.

Sourcemodule UpdateGatewayRequest : sig ... end

Updates a gateway's name.

Sourcemodule UpdatePortalRequest : sig ... end

Updates an IoT SiteWise Monitor portal.

Sourcemodule UpdatePortalResponse : sig ... end

Updates an IoT SiteWise Monitor portal.

Sourcemodule UpdateProjectRequest : sig ... end

Updates an IoT SiteWise Monitor project.

Sourcemodule UpdateProjectResponse : sig ... end

Updates an IoT SiteWise Monitor project.