property_value_histories
Creates, updates, deletes, gets or lists a property_value_histories resource.
Overview
| Name | property_value_histories |
| Type | Resource |
| Id | aws.iottwinmaker.property_value_histories |
Fields
The following fields are returned by SELECT queries:
- get_property_value_history
| Name | Datatype | Description |
|---|---|---|
next_token | string | The string that specifies the next page of results. (pattern: <code>.*</code>) |
property_values | array | An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_property_value_history | select | workspace_id, region | Retrieves information about the history of a time series property value for a component, component type, entity, or workspace. You must specify a value for workspaceId. For entity-specific queries, specify values for componentName and entityId. For cross-entity quries, specify a value for componentTypeId. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
workspace_id | string | The ID of the workspace. |
SELECT examples
- get_property_value_history
Retrieves information about the history of a time series property value for a component, component type, entity, or workspace. You must specify a value for workspaceId. For entity-specific queries, specify values for componentName and entityId. For cross-entity quries, specify a value for componentTypeId.
SELECT
next_token,
property_values
FROM aws.iottwinmaker.property_value_histories
WHERE workspace_id = '{{ workspace_id }}' -- required
AND region = '{{ region }}' -- required
;