Package-level declarations
Types
Access is denied.
Contains an access policy that defines an identity's access to an IoT SiteWise Monitor resource.
Contains a definition for an action.
The JSON payload of the action.
Contains the summary of the actions, including information about where the action resolves to.
Contains aggregated asset property values (for example, average, minimum, and maximum).
Contains the (pre-calculated) aggregate values for an asset property.
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.
The annotation format configuration for bulk import files.
Current status of the application
Summary of an application for list operations
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.
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.
Contains a summary of the composite model for a specific asset.
Contains error details for the requested associate project asset action.
Describes an asset hierarchy that contains a hierarchy's name and ID.
Contains information about a parent asset and a child asset that are related through an asset hierarchy.
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.
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 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.
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.
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 asset model property.
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.
Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
Represents one level between a property and the root of the asset model.
Contains a summary of a property associated with a model. This includes information about which interfaces the property belongs to, if any.
Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.
Contains a summary of an asset model.
Contains asset property information.
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.
Represents one level between a property and the root of the asset.
Contains a summary of a property associated with an asset.
Contains asset property value information.
Contains information about assets that are related to one another.
Contains information about the current status of an asset. For more information, see Asset and model states in the IoT SiteWise User Guide.
Contains a summary of an asset.
Contains a summary of an associated asset.
Contains information about a data segment entry to associate with a dataset.
Contains an asset attribute property. For more information, see Attributes in the IoT SiteWise User Guide.
Contains information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
Contains error information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
Contains the error code and the timestamp for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyAggregates request.
Contains success information for an entry that is associated with the BatchGetAssetPropertyAggregates API.
Contains information for an asset property value entry that is associated with the BatchGetAssetPropertyValue API.
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.
A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.
The error information, such as the error code and the timestamp.
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValueHistory request.
Contains success information for an entry that is associated with the BatchGetAssetPropertyValueHistory API.
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValue request.
Contains success information for an entry that is associated with the BatchGetAssetPropertyValue API.
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.
Request structure for CancelPipelineExecution operation.
Response structure for CancelPipelineExecution operation.
Contains the response for the CancelQuery operation.
A description of the column in the query results.
Contains metadata about a column in the query results.
The data type of the column.
Contains information about a composite model property on an asset.
Represents a composite model that composed an asset model of type COMPONENT_MODEL.
Contains a summary of the components of the composite model.
Contains the configuration of the type of anomaly detection computation model.
The configuration for the computation model.
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.
Contains computation model data binding value information, which can be one of assetModelProperty, list.
A summary of the resource that a computation model resolves to.
Contains current status information for a computation model.
Contains a summary of a computation model.
A single compute node in a pipeline DAG. Each compute node references a task and can declare dependencies on other nodes.
Classification of a compute node execution failure.
Contains detailed execution information for a compute node within a pipeline execution.
The state of an individual compute node execution.
Additional information about a compute node that has failed.
Current execution status of a compute node within a pipeline execution.
Contains the details of an IoT SiteWise configuration error.
Contains current status information for the configuration.
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.
Configuration for a container task, including the container image, IAM role, and compute settings.
Request to create a dataset export job.
Response for create dataset export job request.
Request structure for CreatePipeline operation.
Response structure for CreatePipeline operation.
Request structure for CreateTask operation.
Response structure for CreateTask operation.
Contains information about a customer managed Amazon S3 bucket.
Contains a dashboard summary.
Represents a value used in a data binding. It can be an asset property or an asset model property.
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.
Contains enrichment status information for a data segment.
Contains summary information about a data segment relationship between a source session dataset that contains the data and a curated dataset that references it, including the time series and timestamp range.
Contains summary information about a data segment, including its source dataset, time series, timestamp range, and enrichment status.
Contains the configuration for a dataset.
Contains the enrichment status information for a dataset across data types.
Contains enrichment status information for a specific data type in a dataset.
Filter for ListDatasetExportJobs. ALL returns jobs in any status; otherwise returns jobs in the specified status.
The status of a dataset export job.
A dataset to process.
Contains information about the dataset use and it's source.
The data source for the dataset.
The status of the dataset. This contains the state and any error messages. The state is ACTIVE when ready to use.
The summary details for the dataset.
Contains information about a data segment entry to delete.
Request structure for DeletePipeline operation.
Response structure for DeletePipeline operation.
Request structure for DeleteTask operation.
Response structure for DeleteTask operation.
Request to describe a dataset export job.
Response for describe dataset export job request.
Request structure for DescribePipelineExecution operation.
Response structure for DescribePipelineExecution operation.
Request structure for DescribePipeline operation.
Response structure for DescribePipeline operation.
Contains the response for the DescribeQuery operation.
Input for the DescribeSearch operation.
Output of the DescribeSearch operation.
Request structure for DescribeTask operation.
Response structure for DescribeTask operation.
Contains detailed error information.
Contains a detailed error entry for granular troubleshooting of pipeline failures.
The error code for a detailed pipeline error entry.
Contains information about a data segment entry to disassociate from a dataset.
Configuration for the enrichment job defining which analysis type to perform on video time-series data. Currently supports event detection enrichment. Exactly one member must be specified.
Status of an enrichment job throughout its lifecycle.
Summary information for an enrichment job returned by ListEnrichmentJobs. This lightweight representation includes identifiers, status, and key metadata without the full job configuration.
Time range settings for extracting a specific window of video time-series data to process.
Contains the details of an IoT SiteWise error.
The Amazon S3 destination where errors associated with the job creation request are saved.
Configuration for event detection enrichment on video time-series data.
Environment variables provided as input for a pipeline execution.
The status of the execution.
Contains the execution summary of the computation model.
Data types that can be exported from a dataset.
Contains the location where error reports will be written on failure.
Contains summary information about a dataset export job.
Contains expression variable information.
Contains error information for a data segment association that failed.
Contains error information for a data segment deletion that failed.
Contains error information for a data segment disassociation that failed.
The file format of the data in S3.
Contains the output format configuration for video processing.
The forwarding configuration for a given property.
Contains a summary of a gateway capability configuration.
The gateway's platform configuration. You can only specify one platform type in a gateway.
Contains a summary of a gateway.
Request to retrieve video data for a specific time range. Exactly one of timeSeriesId or propertyAlias must be provided.
Response containing the video data.
Contains the response for the GetQueryResults operation.
Input for the GetSearchResults operation.
Output of the GetSearchResults operation.
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.
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.
Contains information for a group identity in an access policy.
Maps a hierarchy from an interface asset model to a hierarchy in the asset model where the interface is applied.
Contains information about an Identity and Access Management role. For more information, see IAM roles in the IAM User Guide.
Contains information about an Identity and Access Management user.
Contains an image that is uploaded to IoT SiteWise and available at a URL.
Contains information about the relationship between an asset model and an interface asset model that is applied to it.
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.
Contains summary information about an interface that a property belongs to.
IoT SiteWise can't process your request right now. Try again later.
Contains information about an interpolated asset property value.
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
This contains the SiteWise Assistant's response and the corresponding citation.
Base class for all service related exceptions thrown by the IotSiteWise client
Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
Contains the job summary information.
The source details for the Kendra dataset source.
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.
Request to list dataset export jobs for a workspace.
Response for list dataset export jobs request.
Request structure for ListPipelineExecutions operation.
Response structure for ListPipelineExecutions operation.
Request structure for ListPipelines operation.
Response structure for ListPipelines operation.
Contains the response for the ListQueries operation.
Optional filters for ListSearches. When multiple filters are set, a search must match all of them.
Input for the ListSearches operation.
Output of the ListSearches operation.
Request structure for ListTasks operation.
Response structure for ListTasks operation.
Contains logging options.
Represents a data binding that matches the specified filter criteria.
Contains an asset measurement property. For more information, see Measurements 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.
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.
Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).
Contains IoT SiteWise Monitor error details.
Contains information about the storage destination.
Classification of a pipeline execution failure.
The state of a pipeline execution.
Additional information about the current execution status. Populated when the execution has terminated.
Current execution status of a pipeline.
Contains summary information about a pipeline execution.
Contains summary information about a pipeline.
Identifies an IoT SiteWise Monitor portal.
Contains information about the current status of a portal.
Contains a portal summary.
The configuration entry associated with the specific portal type. The portalTypeConfiguration is a map of the portalTypeKey to the PortalTypeEntry.
The precondition in one or more of the request-header fields evaluated to FALSE.
Input source for processing. Specify exactly one option.
The processing type for compute resources. Determines whether the task runs on standard CPU or GPU-accelerated hardware.
The processing unit allocation that determines the vCPU, memory, and GPU resources assigned to a task. Available units depend on the processing type.
Identifies a specific IoT SiteWise Monitor project.
Contains project summary information.
Maps a property from an interface asset model to a property in the asset model where the interface is applied.
Contains configuration options for mapping properties from an interface asset model to an asset model where the interface is applied.
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.
Contains a property type, which can be one of attribute, measurement, metric, or transform.
The value type of null asset property data with BAD and UNCERTAIN qualities.
Contains a list of value updates for an asset property in the list of asset entries consumed by the BatchPutAssetPropertyValue API operation.
Contains statistics about a completed query execution.
The status of a query execution.
Contains summary information about a query.
The query timed out.
The resource already exists.
Contains the details of a resource error.
The error code.
The requested resource can't be found.
The lifecycle state of a resource.
Contains information about the current status of a resource.
Contains the response, citation, and trace from the SiteWise Assistant.
The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
Optional filters that restrict a search to a subset of the workspace's data.
A single matching segment of time-series data returned by a search.
The lifecycle status of a search.
A summary of a single search as returned by ListSearches.
The search strategy, which trades off latency against recall. DEEP runs the full semantic and structured search for the highest-quality matches; QUICK returns faster, lower-recall results. When searchType is omitted on a request, the search defaults to QUICK.
The requested service is unavailable.
Contains the session configuration for a session-type dataset.
The details of the dataset source associated with the dataset.
Request structure for StartPipelineExecution operation.
Response structure for StartPipelineExecution operation.
Contains the response for the StartQuery operation.
Input for the StartSearch operation.
Output of the StartSearch operation.
The resource the action will be taken on. This can include asset-based resources and computation model resources.
The task execution configuration. Specify a containerTaskConfiguration for a custom container workload.
Contains summary information about a task.
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.
Contains a timestamp with optional nanosecond granularity.
Contains a time interval with a start time and an end time. Use a time interval to restrict an operation, such as a search, to a specific time range.
A single timeseries item to process. Exactly one of timeSeriesId or propertyAlias must be provided.
Contains a summary of a time series (data stream).
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.
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.
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.
Contains settings for trimming content to a specific time range.
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 are not authorized.
Request structure for UpdatePipeline operation.
Response structure for UpdatePipeline operation.
Request structure for UpdateTask operation.
Response structure for UpdateTask operation.
Contains information for a user identity in an access policy.
The validation failed for this query.
Identifies a property value used in an expression.
The allowed video data types.
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.
Contains the encryption configuration for a workspace.
Contains the encryption configuration information for a workspace.
Contains the details of an error associated with a workspace.
The current state of a workspace. The state changes as the workspace is created, updated, or deleted.
Contains information about the current status of a workspace.
Contains summary information about a workspace, including its name, ARN, status, and creation and update timestamps.